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