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( const char *luadirname, char **ppsz_dir_list )
111 char *datadir = config_GetUserDataDir();
112 if( datadir == NULL )
115 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
116 datadir, luadirname ) < 0 )
124 # if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
126 const char *psz_vlcpath = config_GetDataDir();
127 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
128 psz_vlcpath, luadirname ) < 0 )
131 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "share" DIR_SEP "lua" DIR_SEP "%s",
132 psz_vlcpath, luadirname ) < 0 )
138 if( asprintf( &ppsz_dir_list[i],
139 "share" DIR_SEP "lua" DIR_SEP "%s", luadirname ) < 0 )
142 # ifdef HAVE_SYS_STAT_H
144 struct stat stat_info;
145 if( ( utf8_stat( ppsz_dir_list[i], &stat_info ) == -1 )
146 || !S_ISDIR( stat_info.st_mode ) )
148 free(ppsz_dir_list[i]);
149 if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
150 config_GetDataDir (), luadirname ) < 0 )
160 /*****************************************************************************
161 * Will execute func on all scripts in luadirname, and stop if func returns
163 *****************************************************************************/
164 int vlclua_scripts_batch_execute( vlc_object_t *p_this,
165 const char * luadirname,
166 int (*func)(vlc_object_t *, const char *, lua_State *, void *),
170 int i_ret = VLC_EGENERIC;
172 char **ppsz_filelist = NULL;
173 char **ppsz_fileend = NULL;
176 char *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
179 i_ret = vlclua_dir_list( luadirname, ppsz_dir_list );
180 if( i_ret != VLC_SUCCESS )
182 i_ret = VLC_EGENERIC;
185 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
191 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
194 free( ppsz_filelist );
195 ppsz_filelist = NULL;
198 msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
199 i_files = utf8_scandir( *ppsz_dir, &ppsz_filelist, file_select,
201 if( i_files < 1 ) continue;
202 ppsz_fileend = ppsz_filelist + i_files;
204 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
207 if( asprintf( &psz_filename,
208 "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) < 0)
210 msg_Dbg( p_this, "Trying Lua playlist script %s", psz_filename );
212 i_ret = func( p_this, psz_filename, L, user_data );
214 free( psz_filename );
216 if( i_ret == VLC_SUCCESS ) break;
218 if( i_ret == VLC_SUCCESS ) break;
223 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
226 free( ppsz_filelist );
228 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
235 /*****************************************************************************
236 * Meta data setters utility.
237 * Playlist item table should be on top of the stack when these are called
238 *****************************************************************************/
239 void __vlclua_read_meta_data( vlc_object_t *p_this, lua_State *L,
240 input_item_t *p_input )
242 #define TRY_META( a, b ) \
243 lua_getfield( L, -1, a ); \
244 if( lua_isstring( L, -1 ) ) \
246 char *psz_value = strdup( lua_tostring( L, -1 ) ); \
247 EnsureUTF8( psz_value ); \
248 msg_Dbg( p_this, #b ": %s", psz_value ); \
249 input_item_Set ## b ( p_input, psz_value ); \
252 lua_pop( L, 1 ); /* pop a */
253 TRY_META( "title", Title );
254 TRY_META( "artist", Artist );
255 TRY_META( "genre", Genre );
256 TRY_META( "copyright", Copyright );
257 TRY_META( "album", Album );
258 TRY_META( "tracknum", TrackNum );
259 TRY_META( "description", Description );
260 TRY_META( "rating", Rating );
261 TRY_META( "date", Date );
262 TRY_META( "setting", Setting );
263 TRY_META( "url", URL );
264 TRY_META( "language", Language );
265 TRY_META( "nowplaying", NowPlaying );
266 TRY_META( "publisher", Publisher );
267 TRY_META( "encodedby", EncodedBy );
268 TRY_META( "arturl", ArtURL );
269 TRY_META( "trackid", TrackID );
272 void __vlclua_read_custom_meta_data( vlc_object_t *p_this, lua_State *L,
273 input_item_t *p_input )
276 lua_getfield( L, -1, "meta" );
278 if( lua_istable( L, -1 ) )
281 /* ... item meta nil */
282 while( lua_next( L, -2 ) )
284 /* ... item meta key value */
285 if( !lua_isstring( L, -2 ) )
287 msg_Warn( p_this, "Custom meta data category name must be "
290 else if( !lua_istable( L, -1 ) )
292 msg_Warn( p_this, "Custom meta data category contents "
297 const char *psz_meta_category = lua_tostring( L, -2 );
298 msg_Dbg( p_this, "Found custom meta data category: %s",
301 /* ... item meta key value nil */
302 while( lua_next( L, -2 ) )
304 /* ... item meta key value key2 value2 */
305 if( !lua_isstring( L, -2 ) )
307 msg_Warn( p_this, "Custom meta category item name "
308 "must be a string." );
310 else if( !lua_isstring( L, -1 ) )
312 msg_Warn( p_this, "Custom meta category item value "
313 "must be a string." );
317 const char *psz_meta_name =
318 lua_tostring( L, -2 );
319 const char *psz_meta_value =
320 lua_tostring( L, -1 );
321 msg_Dbg( p_this, "Custom meta %s, %s: %s",
322 psz_meta_category, psz_meta_name,
324 input_ItemAddInfo( p_input, psz_meta_category,
325 psz_meta_name, psz_meta_value );
327 lua_pop( L, 1 ); /* pop item */
328 /* ... item meta key value key2 */
330 /* ... item meta key value */
332 lua_pop( L, 1 ); /* pop category */
333 /* ... item meta key */
337 lua_pop( L, 1 ); /* pop "meta" */
338 /* ... item -> back to original stack */
341 /*****************************************************************************
343 ****************************************************************************/
345 * Playlist item table should be on top of the stack when this is called
347 void __vlclua_read_options( vlc_object_t *p_this, lua_State *L,
348 int *pi_options, char ***pppsz_options )
350 lua_getfield( L, -1, "options" );
351 if( lua_istable( L, -1 ) )
354 while( lua_next( L, -2 ) )
356 if( lua_isstring( L, -1 ) )
358 char *psz_option = strdup( lua_tostring( L, -1 ) );
359 msg_Dbg( p_this, "Option: %s", psz_option );
360 INSERT_ELEM( *pppsz_options, *pi_options, *pi_options,
365 msg_Warn( p_this, "Option should be a string" );
367 lua_pop( L, 1 ); /* pop option */
370 lua_pop( L, 1 ); /* pop "options" */
373 int __vlclua_playlist_add_internal( vlc_object_t *p_this, lua_State *L,
374 playlist_t *p_playlist,
375 input_item_t *p_parent, bool b_play )
379 assert( p_parent || p_playlist );
382 if( lua_istable( L, -1 ) )
386 while( lua_next( L, -2 ) )
388 /* playlist key item */
389 /* <Parse playlist item> */
390 if( lua_istable( L, -1 ) )
392 lua_getfield( L, -1, "path" );
393 /* playlist key item path */
394 if( lua_isstring( L, -1 ) )
396 const char *psz_path = NULL;
397 const char *psz_name = NULL;
398 char **ppsz_options = NULL;
400 mtime_t i_duration = -1;
401 input_item_t *p_input;
403 /* Read path and name */
404 psz_path = lua_tostring( L, -1 );
405 msg_Dbg( p_this, "Path: %s", psz_path );
406 lua_getfield( L, -2, "name" );
407 /* playlist key item path name */
408 if( lua_isstring( L, -1 ) )
410 psz_name = lua_tostring( L, -1 );
411 msg_Dbg( p_this, "Name: %s", psz_name );
415 if( !lua_isnil( L, -1 ) )
416 msg_Warn( p_this, "Playlist item name should be a string." );
421 lua_getfield( L, -3, "duration" );
422 /* playlist key item path name duration */
423 if( lua_isnumber( L, -1 ) )
425 i_duration = (mtime_t)(lua_tonumber( L, -1 )*1e6);
427 else if( !lua_isnil( L, -1 ) )
429 msg_Warn( p_this, "Playlist item duration should be a number (in seconds)." );
431 lua_pop( L, 1 ); /* pop "duration" */
433 /* playlist key item path name */
435 /* Read options: item must be on top of stack */
436 lua_pushvalue( L, -3 );
437 /* playlist key item path name item */
438 vlclua_read_options( p_this, L, &i_options, &ppsz_options );
440 /* Create input item */
441 p_input = input_ItemNewExt( p_playlist, psz_path,
443 (const char **)ppsz_options,
445 lua_pop( L, 3 ); /* pop "path name item" */
446 /* playlist key item */
448 /* Read meta data: item must be on top of stack */
449 vlclua_read_meta_data( p_this, L, p_input );
451 /* Read custom meta data: item must be on top of stack*/
452 vlclua_read_custom_meta_data( p_this, L, p_input );
454 /* Append item to playlist */
455 if( p_parent ) /* Add to node */
456 input_ItemAddSubItem( p_parent, p_input );
457 else /* Play or Enqueue (preparse) */
458 /* FIXME: playlist_AddInput() can fail */
459 playlist_AddInput( p_playlist, p_input,
461 ( b_play ? PLAYLIST_GO : PLAYLIST_PREPARSE ),
462 PLAYLIST_END, true, false );
463 i_count ++; /* increment counter */
464 vlc_gc_decref( p_input );
465 while( i_options > 0 )
466 free( ppsz_options[--i_options] );
467 free( ppsz_options );
471 lua_pop( L, 1 ); /* pop "path" */
473 "Playlist item's path should be a string" );
475 /* playlist key item */
479 msg_Warn( p_this, "Playlist item should be a table" );
481 /* <Parse playlist item> */
482 lua_pop( L, 1 ); /* pop the value, keep the key for
483 * the next lua_next() call */
490 msg_Warn( p_this, "Playlist should be a table." );