git.sesse.net Git - vlc/blob - modules/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
  39 #include <lua.h>        /* Low level lua C API */
  40 #include <lauxlib.h>    /* Higher level C API */
  41 #include <lualib.h>     /* Lua libs */
  42
  43 /*****************************************************************************
  44  * Module entry points
  45  *****************************************************************************/
  46 int ReadMeta( vlc_object_t * );
  47 int FetchMeta( vlc_object_t * );
  48 int FindArt( vlc_object_t * );
  49
  50 int Import_LuaPlaylist( vlc_object_t * );
  51 void Close_LuaPlaylist( vlc_object_t * );
  52
  53 #define TELNETPORT_DEFAULT 4212
  54 int Open_LuaIntf( vlc_object_t * );
  55 void Close_LuaIntf( vlc_object_t * );
  56 int Open_LuaHTTP( vlc_object_t * );
  57 int Open_LuaCLI( vlc_object_t * );
  58 int Open_LuaTelnet( vlc_object_t * );
  59
  60
  61 int Open_Extension( vlc_object_t * );
  62 void Close_Extension( vlc_object_t * );
  63
  64 int Open_LuaSD( vlc_object_t * );
  65 void Close_LuaSD( vlc_object_t * );
  66
  67 /*****************************************************************************
  68  * Lua debug
  69  *****************************************************************************/
  70 static inline void lua_Dbg( vlc_object_t * p_this, const char * ppz_fmt, ... )
  71 {
  72     va_list ap;
  73     va_start( ap, ppz_fmt );
  74     msg_GenericVa( p_this, VLC_MSG_DBG, MODULE_STRING, ppz_fmt, ap );
  75     va_end( ap );
  76 }
  77
  78 /*****************************************************************************
  79  * Functions that should be in lua ... but aren't for some obscure reason
  80  *****************************************************************************/
  81 static inline bool luaL_checkboolean( lua_State *L, int narg )
  82 {
  83     luaL_checktype( L, narg, LUA_TBOOLEAN ); /* can raise an error */
  84     return lua_toboolean( L, narg );
  85 }
  86
  87 static inline int luaL_optboolean( lua_State *L, int narg, int def )
  88 {
  89     return luaL_opt( L, luaL_checkboolean, narg, def );
  90 }
  91
  92 static inline const char *luaL_nilorcheckstring( lua_State *L, int narg )
  93 {
  94     if( lua_isnil( L, narg ) )
  95         return NULL;
  96     return luaL_checkstring( L, narg );
  97 }
  98
  99 static inline char *luaL_strdupornull( lua_State *L, int narg )
 100 {
 101     if( lua_isstring( L, narg ) )
 102         return strdup( luaL_checkstring( L, narg ) );
 103     return NULL;
 104 }
 105
 106 void vlclua_set_this( lua_State *, vlc_object_t * );
 107 #define vlclua_set_this(a, b) vlclua_set_this(a, VLC_OBJECT(b))
 108 vlc_object_t * vlclua_get_this( lua_State * );
 109
 110 struct intf_sys_t;
 111 void vlclua_set_intf( lua_State *, struct intf_sys_t * );
 112
 113 /*****************************************************************************
 114  * Lua function bridge
 115  *****************************************************************************/
 116 #define vlclua_error( L ) luaL_error( L, "VLC lua error in file %s line %d (function %s)", __FILE__, __LINE__, __func__ )
 117 int vlclua_push_ret( lua_State *, int i_error );
 118
 119 /*****************************************************************************
 120  * Will execute func on all scripts in luadirname, and stop if func returns
 121  * success.
 122  *****************************************************************************/
 123 int vlclua_scripts_batch_execute( vlc_object_t *p_this, const char * luadirname,
 124         int (*func)(vlc_object_t *, const char *, void *),
 125         void * user_data );
 126 int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname, char ***pppsz_dir_list );
 127 void vlclua_dir_list_free( char **ppsz_dir_list );
 128 char *vlclua_find_file( vlc_object_t *p_this, const char *psz_luadirname, const char *psz_name );
 129
 130 /*****************************************************************************
 131  * Replace Lua file reader by VLC input. Allows loadings scripts in Zip pkg.
 132  *****************************************************************************/
 133 int vlclua_dofile( vlc_object_t *p_this, lua_State *L, const char *url );
 134
 135 /*****************************************************************************
 136  * Playlist and meta data internal utilities.
 137  *****************************************************************************/
 138 void vlclua_read_options( vlc_object_t *, lua_State *, int *, char *** );
 139 #define vlclua_read_options( a, b, c, d ) vlclua_read_options( VLC_OBJECT( a ), b, c, d )
 140 void vlclua_read_meta_data( vlc_object_t *, lua_State *, input_item_t * );
 141 #define vlclua_read_meta_data( a, b, c ) vlclua_read_meta_data( VLC_OBJECT( a ), b, c )
 142 void vlclua_read_custom_meta_data( vlc_object_t *, lua_State *,
 143                                    input_item_t *);
 144 #define vlclua_read_custom_meta_data( a, b, c ) vlclua_read_custom_meta_data( VLC_OBJECT( a ), b, c )
 145 int vlclua_playlist_add_internal( vlc_object_t *, lua_State *, playlist_t *,
 146                                   input_item_t *, bool );
 147 #define vlclua_playlist_add_internal( a, b, c, d, e ) vlclua_playlist_add_internal( VLC_OBJECT( a ), b, c, d, e )
 148
 149 int vlclua_add_modules_path( vlc_object_t *, lua_State *, const char *psz_filename );
 150 #define vlclua_add_modules_path( a, b, c ) vlclua_add_modules_path( VLC_OBJECT( a ), b, c )
 151
 152 /**
 153  * Per-interface private state
 154  */
 155 struct intf_sys_t
 156 {
 157     char *psz_filename;
 158     lua_State *L;
 159
 160     vlc_thread_t thread;
 161     vlc_mutex_t lock;
 162     vlc_cond_t wait;
 163     bool exiting;
 164 };
 165
 166 #endif /* VLC_LUA_H */
 167