1 /*****************************************************************************
2 * vlc.c: Generic lua interface functions
3 *****************************************************************************
4 * Copyright (C) 2007-2008 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea at videolan tod org>
8 * Pierre d'Herbemont <pdherbemont # videolan.org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
38 #include <vlc_common.h>
39 #include <vlc_plugin.h>
41 #include <vlc_charset.h>
44 #include <lua.h> /* Low level lua C API */
45 #include <lauxlib.h> /* Higher level C API */
46 #include <lualib.h> /* Lua libs */
50 /*****************************************************************************
52 *****************************************************************************/
54 #define INTF_TEXT N_("Lua interface")
55 #define INTF_LONGTEXT N_("Lua interface module to load")
57 #define CONFIG_TEXT N_("Lua interface configuration")
58 #define CONFIG_LONGTEXT N_("Lua interface configuration string. Format is: '[\"<interface module name>\"] = { <option> = <value>, ...}, ...'.")
61 set_shortname( N_( "Lua Art" ) )
62 set_description( N_("Fetch artwork using lua scripts") )
63 set_capability( "art finder", 10 )
64 set_callbacks( FindArt, NULL )
67 add_shortcut( "luaplaylist" )
68 set_category( CAT_INPUT )
69 set_subcategory( SUBCAT_INPUT_DEMUX )
70 set_shortname( N_("Lua Playlist") )
71 set_description( N_("Lua Playlist Parser Interface") )
72 set_capability( "demux", 2 )
73 set_callbacks( Import_LuaPlaylist, Close_LuaPlaylist )
76 add_shortcut( "luaintf" )
77 add_shortcut( "luarc" )
78 /* add_shortcut( "rc" ) */
79 add_shortcut( "luahotkeys" )
80 /* add_shortcut( "hotkeys" ) */
81 add_shortcut( "luatelnet" )
82 /* add_shortcut( "telnet" ) */
83 add_shortcut( "luahttp" )
84 /* add_shortcut( "http" ) */
85 set_description( N_("Lua Interface Module") )
86 set_capability( "interface", 0 )
87 add_string( "lua-intf", "dummy", NULL,
88 INTF_TEXT, INTF_LONGTEXT, false )
89 add_string( "lua-config", "", NULL,
90 CONFIG_TEXT, CONFIG_LONGTEXT, false )
91 set_callbacks( Open_LuaIntf, Close_LuaIntf )
94 /*****************************************************************************
96 *****************************************************************************/
97 static int file_select( const char *file )
99 int i = strlen( file );
100 return i > 4 && !strcmp( file+i-4, ".lua" );
103 static int file_compare( const char **a, const char **b )
105 return strcmp( *a, *b );
108 int vlclua_dir_list( vlc_object_t *p_this, const char *luadirname, char **ppsz_dir_list )
111 char *datadir = config_GetUserDir( VLC_DATA_DIR );
112 if( datadir == NULL )
115 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
116 datadir, luadirname ) < 0 )
124 char *psz_datapath = config_GetDataDir( p_this );
125 # if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
127 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
128 psz_datapath, luadirname ) < 0 )
131 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "share" DIR_SEP "lua" DIR_SEP "%s",
132 psz_datapath, luadirname ) < 0 )
138 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
139 psz_datapath, luadirname ) < 0 )
143 free( psz_datapath );
147 void vlclua_dir_list_free( char **ppsz_dir_list )
150 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
154 /*****************************************************************************
155 * Will execute func on all scripts in luadirname, and stop if func returns
157 *****************************************************************************/
158 int vlclua_scripts_batch_execute( vlc_object_t *p_this,
159 const char * luadirname,
160 int (*func)(vlc_object_t *, const char *, lua_State *, void *),
164 int i_ret = VLC_EGENERIC;
166 char **ppsz_filelist = NULL;
167 char **ppsz_fileend = NULL;
170 char *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
173 i_ret = vlclua_dir_list( p_this, luadirname, ppsz_dir_list );
174 if( i_ret != VLC_SUCCESS )
176 i_ret = VLC_EGENERIC;
179 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
185 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
188 free( ppsz_filelist );
189 ppsz_filelist = NULL;
192 msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
193 i_files = utf8_scandir( *ppsz_dir, &ppsz_filelist, file_select,
195 if( i_files < 1 ) continue;
196 ppsz_fileend = ppsz_filelist + i_files;
198 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
201 if( asprintf( &psz_filename,
202 "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) < 0)
204 vlclua_dir_list_free( ppsz_dir_list );
207 msg_Dbg( p_this, "Trying Lua playlist script %s", psz_filename );
209 i_ret = func( p_this, psz_filename, L, user_data );
211 free( psz_filename );
213 if( i_ret == VLC_SUCCESS ) break;
215 if( i_ret == VLC_SUCCESS ) break;
220 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
223 free( ppsz_filelist );
225 vlclua_dir_list_free( ppsz_dir_list );
231 /*****************************************************************************
232 * Meta data setters utility.
233 * Playlist item table should be on top of the stack when these are called
234 *****************************************************************************/
235 void __vlclua_read_meta_data( vlc_object_t *p_this, lua_State *L,
236 input_item_t *p_input )
238 #define TRY_META( a, b ) \
239 lua_getfield( L, -1, a ); \
240 if( lua_isstring( L, -1 ) ) \
242 char *psz_value = strdup( lua_tostring( L, -1 ) ); \
243 EnsureUTF8( psz_value ); \
244 msg_Dbg( p_this, #b ": %s", psz_value ); \
245 input_item_Set ## b ( p_input, psz_value ); \
248 lua_pop( L, 1 ); /* pop a */
249 TRY_META( "title", Title );
250 TRY_META( "artist", Artist );
251 TRY_META( "genre", Genre );
252 TRY_META( "copyright", Copyright );
253 TRY_META( "album", Album );
254 TRY_META( "tracknum", TrackNum );
255 TRY_META( "description", Description );
256 TRY_META( "rating", Rating );
257 TRY_META( "date", Date );
258 TRY_META( "setting", Setting );
259 TRY_META( "url", URL );
260 TRY_META( "language", Language );
261 TRY_META( "nowplaying", NowPlaying );
262 TRY_META( "publisher", Publisher );
263 TRY_META( "encodedby", EncodedBy );
264 TRY_META( "arturl", ArtURL );
265 TRY_META( "trackid", TrackID );
268 void __vlclua_read_custom_meta_data( vlc_object_t *p_this, lua_State *L,
269 input_item_t *p_input )
272 lua_getfield( L, -1, "meta" );
274 if( lua_istable( L, -1 ) )
277 /* ... item meta nil */
278 while( lua_next( L, -2 ) )
280 /* ... item meta key value */
281 if( !lua_isstring( L, -2 ) )
283 msg_Warn( p_this, "Custom meta data category name must be "
286 else if( !lua_istable( L, -1 ) )
288 msg_Warn( p_this, "Custom meta data category contents "
293 const char *psz_meta_category = lua_tostring( L, -2 );
294 msg_Dbg( p_this, "Found custom meta data category: %s",
297 /* ... item meta key value nil */
298 while( lua_next( L, -2 ) )
300 /* ... item meta key value key2 value2 */
301 if( !lua_isstring( L, -2 ) )
303 msg_Warn( p_this, "Custom meta category item name "
304 "must be a string." );
306 else if( !lua_isstring( L, -1 ) )
308 msg_Warn( p_this, "Custom meta category item value "
309 "must be a string." );
313 const char *psz_meta_name =
314 lua_tostring( L, -2 );
315 const char *psz_meta_value =
316 lua_tostring( L, -1 );
317 msg_Dbg( p_this, "Custom meta %s, %s: %s",
318 psz_meta_category, psz_meta_name,
320 input_item_AddInfo( p_input, psz_meta_category,
321 psz_meta_name, "%s", psz_meta_value );
323 lua_pop( L, 1 ); /* pop item */
324 /* ... item meta key value key2 */
326 /* ... item meta key value */
328 lua_pop( L, 1 ); /* pop category */
329 /* ... item meta key */
333 lua_pop( L, 1 ); /* pop "meta" */
334 /* ... item -> back to original stack */
337 /*****************************************************************************
339 ****************************************************************************/
341 * Playlist item table should be on top of the stack when this is called
343 void __vlclua_read_options( vlc_object_t *p_this, lua_State *L,
344 int *pi_options, char ***pppsz_options )
346 lua_getfield( L, -1, "options" );
347 if( lua_istable( L, -1 ) )
350 while( lua_next( L, -2 ) )
352 if( lua_isstring( L, -1 ) )
354 char *psz_option = strdup( lua_tostring( L, -1 ) );
355 msg_Dbg( p_this, "Option: %s", psz_option );
356 INSERT_ELEM( *pppsz_options, *pi_options, *pi_options,
361 msg_Warn( p_this, "Option should be a string" );
363 lua_pop( L, 1 ); /* pop option */
366 lua_pop( L, 1 ); /* pop "options" */
369 int __vlclua_playlist_add_internal( vlc_object_t *p_this, lua_State *L,
370 playlist_t *p_playlist,
371 input_item_t *p_parent, bool b_play )
375 assert( p_parent || p_playlist );
378 if( lua_istable( L, -1 ) )
382 while( lua_next( L, -2 ) )
384 /* playlist key item */
385 /* <Parse playlist item> */
386 if( lua_istable( L, -1 ) )
388 lua_getfield( L, -1, "path" );
389 /* playlist key item path */
390 if( lua_isstring( L, -1 ) )
392 const char *psz_path = NULL;
393 const char *psz_name = NULL;
394 char **ppsz_options = NULL;
396 mtime_t i_duration = -1;
397 input_item_t *p_input;
399 /* Read path and name */
400 psz_path = lua_tostring( L, -1 );
401 msg_Dbg( p_this, "Path: %s", psz_path );
402 lua_getfield( L, -2, "name" );
403 /* playlist key item path name */
404 if( lua_isstring( L, -1 ) )
406 psz_name = lua_tostring( L, -1 );
407 msg_Dbg( p_this, "Name: %s", psz_name );
411 if( !lua_isnil( L, -1 ) )
412 msg_Warn( p_this, "Playlist item name should be a string." );
417 lua_getfield( L, -3, "duration" );
418 /* playlist key item path name duration */
419 if( lua_isnumber( L, -1 ) )
421 i_duration = (mtime_t)(lua_tonumber( L, -1 )*1e6);
423 else if( !lua_isnil( L, -1 ) )
425 msg_Warn( p_this, "Playlist item duration should be a number (in seconds)." );
427 lua_pop( L, 1 ); /* pop "duration" */
429 /* playlist key item path name */
431 /* Read options: item must be on top of stack */
432 lua_pushvalue( L, -3 );
433 /* playlist key item path name item */
434 vlclua_read_options( p_this, L, &i_options, &ppsz_options );
436 /* Create input item */
437 p_input = input_item_NewExt( p_playlist, psz_path,
439 (const char **)ppsz_options,
440 VLC_INPUT_OPTION_TRUSTED,
442 lua_pop( L, 3 ); /* pop "path name item" */
443 /* playlist key item */
445 /* Read meta data: item must be on top of stack */
446 vlclua_read_meta_data( p_this, L, p_input );
448 /* Read custom meta data: item must be on top of stack*/
449 vlclua_read_custom_meta_data( p_this, L, p_input );
451 /* Append item to playlist */
452 if( p_parent ) /* Add to node */
453 input_item_AddSubItem( p_parent, p_input );
454 else /* Play or Enqueue (preparse) */
455 /* FIXME: playlist_AddInput() can fail */
456 playlist_AddInput( p_playlist, p_input,
458 ( b_play ? PLAYLIST_GO : PLAYLIST_PREPARSE ),
459 PLAYLIST_END, true, false );
460 i_count ++; /* increment counter */
461 vlc_gc_decref( p_input );
462 while( i_options > 0 )
463 free( ppsz_options[--i_options] );
464 free( ppsz_options );
468 lua_pop( L, 1 ); /* pop "path" */
470 "Playlist item's path should be a string" );
472 /* playlist key item */
476 msg_Warn( p_this, "Playlist item should be a table" );
478 /* <Parse playlist item> */
479 lua_pop( L, 1 ); /* pop the value, keep the key for
480 * the next lua_next() call */
487 msg_Warn( p_this, "Playlist should be a table." );