git.sesse.net Git - vlc/blob - modules/misc/lua/vlc.h

   1 /*****************************************************************************
   2  * vlc.h: VLC specific lua library functions.
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
   8  *          Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VLC_LUA_H
  26 #define VLC_LUA_H
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30
  31 #include <vlc_common.h>
  32 #include <vlc_input.h>
  33 #include <vlc_playlist.h>
  34 #include <vlc_meta.h>
  35 #include <vlc_url.h>
  36 #include <vlc_strings.h>
  37 #include <vlc_stream.h>
  38 #include <vlc_charset.h>
  39
  40 #include <lua.h>        /* Low level lua C API */
  41 #include <lauxlib.h>    /* Higher level C API */
  42 #include <lualib.h>     /* Lua libs */
  43
  44 /*****************************************************************************
  45  * Module entry points
  46  *****************************************************************************/
  47 int ReadMeta( vlc_object_t * );
  48 int FetchMeta( vlc_object_t * );
  49 int FindArt( vlc_object_t * );
  50
  51 int Import_LuaPlaylist( vlc_object_t * );
  52 void Close_LuaPlaylist( vlc_object_t * );
  53
  54 int Open_LuaIntf( vlc_object_t * );
  55 void Close_LuaIntf( vlc_object_t * );
  56
  57 int Open_Extension( vlc_object_t * );
  58 void Close_Extension( vlc_object_t * );
  59
  60
  61 /*****************************************************************************
  62  * Lua debug
  63  *****************************************************************************/
  64 static inline void lua_Dbg( vlc_object_t * p_this, const char * ppz_fmt, ... )
  65 {
  66     va_list ap;
  67     va_start( ap, ppz_fmt );
  68     __msg_GenericVa( ( vlc_object_t *)p_this, VLC_MSG_DBG, MODULE_STRING,
  69                       ppz_fmt, ap );
  70     va_end( ap );
  71 }
  72
  73 /*****************************************************************************
  74  * Functions that should be in lua ... but aren't for some obscure reason
  75  *****************************************************************************/
  76 static inline int luaL_checkboolean( lua_State *L, int narg )
  77 {
  78     luaL_checktype( L, narg, LUA_TBOOLEAN ); /* can raise an error */
  79     return lua_toboolean( L, narg );
  80 }
  81
  82 static inline int luaL_optboolean( lua_State *L, int narg, int def )
  83 {
  84     return luaL_opt( L, luaL_checkboolean, narg, def );
  85 }
  86
  87 static inline const char *luaL_nilorcheckstring( lua_State *L, int narg )
  88 {
  89     if( lua_isnil( L, narg ) )
  90         return NULL;
  91     return luaL_checkstring( L, narg );
  92 }
  93
  94 vlc_object_t * vlclua_get_this( lua_State * );
  95
  96 /*****************************************************************************
  97  * Lua function bridge
  98  *****************************************************************************/
  99 #define vlclua_error( L ) luaL_error( L, "VLC lua error in file %s line %d (function %s)", __FILE__, __LINE__, __func__ )
 100 int vlclua_push_ret( lua_State *, int i_error );
 101
 102 /*****************************************************************************
 103  * Will execute func on all scripts in luadirname, and stop if func returns
 104  * success.
 105  *****************************************************************************/
 106 int vlclua_scripts_batch_execute( vlc_object_t *p_this, const char * luadirname,
 107         int (*func)(vlc_object_t *, const char *, lua_State *, void *),
 108         lua_State * L, void * user_data );
 109 int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname, char **ppsz_dir_list );
 110 void vlclua_dir_list_free( char **ppsz_dir_list );
 111
 112 /*****************************************************************************
 113  * Playlist and meta data internal utilities.
 114  *****************************************************************************/
 115 void __vlclua_read_options( vlc_object_t *, lua_State *, int *, char *** );
 116 #define vlclua_read_options(a,b,c,d) __vlclua_read_options(VLC_OBJECT(a),b,c,d)
 117 void __vlclua_read_meta_data( vlc_object_t *, lua_State *, input_item_t * );
 118 #define vlclua_read_meta_data(a,b,c) __vlclua_read_meta_data(VLC_OBJECT(a),b,c)
 119 void __vlclua_read_custom_meta_data( vlc_object_t *, lua_State *,
 120                                      input_item_t *);
 121 #define vlclua_read_custom_meta_data(a,b,c) __vlclua_read_custom_meta_data(VLC_OBJECT(a),b,c)
 122 int __vlclua_playlist_add_internal( vlc_object_t *, lua_State *, playlist_t *,
 123                                     input_item_t *, bool );
 124 #define vlclua_playlist_add_internal(a,b,c,d,e) __vlclua_playlist_add_internal(VLC_OBJECT(a),b,c,d,e)
 125
 126 /**
 127  * Per-interface private state
 128  */
 129 struct intf_sys_t
 130 {
 131     char *psz_filename;
 132     lua_State *L;
 133
 134     vlc_thread_t thread;
 135     vlc_mutex_t lock;
 136     vlc_cond_t wait;
 137     bool exiting;
 138 };
 139
 140 #endif /* VLC_LUA_H */
 141