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_meta_fetcher.h>
  36 #include <vlc_url.h>
  37 #include <vlc_strings.h>
  38 #include <vlc_stream.h>
  39 #include <vlc_demux.h>
  40
  41 #define LUA_COMPAT_MODULE
  42 #include <lua.h>        /* Low level lua C API */
  43 #include <lauxlib.h>    /* Higher level C API */
  44 #include <lualib.h>     /* Lua libs */
  45
  46 #if LUA_VERSION_NUM >= 502
  47 # define lua_equal(L,idx1,idx2)    lua_compare(L,(idx1),(idx2),LUA_OPEQ)
  48 # define lua_objlen(L,idx)         lua_rawlen(L,idx)
  49 # define lua_strlen(L,idx)         lua_rawlen(L,idx)
  50 #endif
  51
  52 #if LUA_VERSION_NUM >= 503
  53 # undef luaL_register
  54 # define luaL_register(L, n, l) luaL_setfuncs(L, (l), 0)
  55 # define luaL_register_namespace(L, n, l) \
  56     lua_getglobal( L, n );      \
  57     if( lua_isnil( L, -1 ) )    \
  58     {                           \
  59         lua_pop( L, 1 );        \
  60         lua_newtable( L );      \
  61     }                           \
  62     luaL_setfuncs( L, (l), 0 ); \
  63     lua_pushvalue( L, -1 );     \
  64     lua_setglobal( L, n );
  65 #else
  66 # define luaL_register_namespace(L, n, l) luaL_register( L, n, (l) );
  67 #endif
  68
  69
  70 /*****************************************************************************
  71  * Module entry points
  72  *****************************************************************************/
  73 int ReadMeta( demux_meta_t * );
  74 int FetchMeta( meta_fetcher_t * );
  75 int FindArt( meta_fetcher_t * );
  76
  77 int Import_LuaPlaylist( vlc_object_t * );
  78 void Close_LuaPlaylist( vlc_object_t * );
  79
  80 #define TELNETPORT_DEFAULT 4212
  81 int Open_LuaIntf( vlc_object_t * );
  82 void Close_LuaIntf( vlc_object_t * );
  83 int Open_LuaHTTP( vlc_object_t * );
  84 int Open_LuaCLI( vlc_object_t * );
  85 int Open_LuaTelnet( vlc_object_t * );
  86
  87
  88 int Open_Extension( vlc_object_t * );
  89 void Close_Extension( vlc_object_t * );
  90
  91 int Open_LuaSD( vlc_object_t * );
  92 void Close_LuaSD( vlc_object_t * );
  93
  94 // Script probe
  95 int vlclua_probe_sd( vlc_object_t *, const char *name );
  96
  97 /*****************************************************************************
  98  * Lua debug
  99  *****************************************************************************/
 100 static inline void lua_Dbg( vlc_object_t * p_this, const char * ppz_fmt, ... )
 101 {
 102     va_list ap;
 103     va_start( ap, ppz_fmt );
 104     msg_GenericVa( p_this, VLC_MSG_DBG, ppz_fmt, ap );
 105     va_end( ap );
 106 }
 107
 108 /*****************************************************************************
 109  * Functions that should be in lua ... but aren't for some obscure reason
 110  *****************************************************************************/
 111 static inline bool luaL_checkboolean( lua_State *L, int narg )
 112 {
 113     luaL_checktype( L, narg, LUA_TBOOLEAN ); /* can raise an error */
 114     return lua_toboolean( L, narg );
 115 }
 116
 117 static inline int luaL_optboolean( lua_State *L, int narg, int def )
 118 {
 119     return luaL_opt( L, luaL_checkboolean, narg, def );
 120 }
 121
 122 static inline const char *luaL_nilorcheckstring( lua_State *L, int narg )
 123 {
 124     if( lua_isnil( L, narg ) )
 125         return NULL;
 126     return luaL_checkstring( L, narg );
 127 }
 128
 129 static inline char *luaL_strdupornull( lua_State *L, int narg )
 130 {
 131     if( lua_isstring( L, narg ) )
 132         return strdup( luaL_checkstring( L, narg ) );
 133     return NULL;
 134 }
 135
 136 void vlclua_set_this( lua_State *, vlc_object_t * );
 137 #define vlclua_set_this(a, b) vlclua_set_this(a, VLC_OBJECT(b))
 138 vlc_object_t * vlclua_get_this( lua_State * );
 139
 140 void vlclua_set_playlist_internal( lua_State *, playlist_t * );
 141 playlist_t * vlclua_get_playlist_internal( lua_State * );
 142
 143 /*****************************************************************************
 144  * Lua function bridge
 145  *****************************************************************************/
 146 #define vlclua_error( L ) luaL_error( L, "VLC lua error in file %s line %d (function %s)", __FILE__, __LINE__, __func__ )
 147 int vlclua_push_ret( lua_State *, int i_error );
 148
 149 /*****************************************************************************
 150  * Will execute func on all scripts in luadirname, and stop if func returns
 151  * success.
 152  *****************************************************************************/
 153 typedef struct luabatch_context_t luabatch_context_t;
 154 struct luabatch_context_t
 155 {
 156     input_item_t *p_item;
 157     meta_fetcher_scope_t e_scope;
 158     bool (*pf_validator)( const luabatch_context_t *, meta_fetcher_scope_t );
 159 };
 160
 161 int vlclua_scripts_batch_execute( vlc_object_t *p_this, const char * luadirname,
 162         int (*func)(vlc_object_t *, const char *, const luabatch_context_t *),
 163         void * user_data );
 164 int vlclua_dir_list( const char *luadirname, char ***pppsz_dir_list );
 165 void vlclua_dir_list_free( char **ppsz_dir_list );
 166 char *vlclua_find_file( const char *psz_luadirname, const char *psz_name );
 167
 168 /*****************************************************************************
 169  * Replace Lua file reader by VLC input. Allows loadings scripts in Zip pkg.
 170  *****************************************************************************/
 171 int vlclua_dofile( vlc_object_t *p_this, lua_State *L, const char *url );
 172
 173 /*****************************************************************************
 174  * Playlist and meta data internal utilities.
 175  *****************************************************************************/
 176 void vlclua_read_options( vlc_object_t *, lua_State *, int *, char *** );
 177 #define vlclua_read_options( a, b, c, d ) vlclua_read_options( VLC_OBJECT( a ), b, c, d )
 178 void vlclua_read_meta_data( vlc_object_t *, lua_State *, input_item_t * );
 179 #define vlclua_read_meta_data( a, b, c ) vlclua_read_meta_data( VLC_OBJECT( a ), b, c )
 180 void vlclua_read_custom_meta_data( vlc_object_t *, lua_State *,
 181                                    input_item_t *);
 182 #define vlclua_read_custom_meta_data( a, b, c ) vlclua_read_custom_meta_data( VLC_OBJECT( a ), b, c )
 183
 184 input_item_t *vlclua_read_input_item(vlc_object_t *, lua_State *);
 185
 186 int vlclua_add_modules_path( lua_State *, const char *psz_filename );
 187
 188 struct vlc_interrupt;
 189
 190 /**
 191  * File descriptors table
 192  */
 193 typedef struct
 194 {
 195     struct vlc_interrupt *interrupt;
 196     int *fdv;
 197     unsigned fdc;
 198 } vlclua_dtable_t;
 199
 200 int vlclua_fd_init( lua_State *, vlclua_dtable_t * );
 201 void vlclua_fd_interrupt( vlclua_dtable_t * );
 202 void vlclua_fd_cleanup( vlclua_dtable_t * );
 203 struct vlc_interrupt *vlclua_set_interrupt( lua_State *L );
 204
 205 #endif /* VLC_LUA_H */
 206