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