1 /*****************************************************************************
2 * luaplaylist.c : Lua playlist demux module
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea at videolan tod org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 #include <vlc_demux.h>
30 #include <vlc_strings.h>
31 #include <vlc_charset.h>
33 #include <errno.h> /* ENOMEM */
36 #ifdef HAVE_SYS_STAT_H
37 # include <sys/stat.h>
40 #include <lua.h> /* Low level lua C API */
41 #include <lauxlib.h> /* Higher level C API */
42 #include <lualib.h> /* Lua libs */
44 /*****************************************************************************
46 *****************************************************************************/
47 static int E_(Import_LuaPlaylist)( vlc_object_t *p_this );
48 static void E_(Close_LuaPlaylist)( vlc_object_t *p_this );
50 static int Demux( demux_t *p_demux );
51 static int Control( demux_t *p_demux, int i_query, va_list args );
53 /*****************************************************************************
55 *****************************************************************************/
57 add_shortcut( "lua" );
58 set_category( CAT_INPUT );
59 set_subcategory( SUBCAT_INPUT_DEMUX );
61 set_shortname( _("Lua Playlist") );
62 set_description( _("Lua Playlist Parser Interface") );
63 set_capability( "demux2", 9 );
64 set_callbacks( E_(Import_LuaPlaylist), E_(Close_LuaPlaylist) );
67 /*****************************************************************************
69 *****************************************************************************/
76 /*****************************************************************************
78 *****************************************************************************/
79 static demux_t *vlclua_get_demux( lua_State *p_state )
82 lua_getglobal( p_state, "vlc" );
83 lua_getfield( p_state, lua_gettop( p_state ), "private" );
84 p_demux = (demux_t*)lua_topointer( p_state, lua_gettop( p_state ) );
85 lua_pop( p_state, 2 );
89 static int vlclua_peek( lua_State *p_state )
91 demux_t *p_demux = vlclua_get_demux( p_state );
92 int i = lua_gettop( p_state );
97 n = lua_tonumber( p_state, 1 );
98 lua_pop( p_state, i );
99 i_peek = stream_Peek( p_demux->s, &p_peek, n );
100 lua_pushlstring( p_state, (const char *)p_peek, i_peek );
104 static int vlclua_read( lua_State *p_state )
106 demux_t *p_demux = vlclua_get_demux( p_state );
107 int i = lua_gettop( p_state );
112 n = lua_tonumber( p_state, 1 );
113 lua_pop( p_state, i );
114 i_read = stream_Read( p_demux->s, &p_read, n );
115 lua_pushlstring( p_state, (const char *)p_read, i_read );
119 static int vlclua_readline( lua_State *p_state )
121 demux_t *p_demux = vlclua_get_demux( p_state );
122 char *psz_line = stream_ReadLine( p_demux->s );
125 lua_pushstring( p_state, psz_line );
130 lua_pushnil( p_state );
135 static int vlclua_decode_uri( lua_State *p_state )
137 int i = lua_gettop( p_state );
139 const char *psz_cstring = lua_tostring( p_state, 1 );
140 if( !psz_cstring ) return 0;
141 char *psz_string = strdup( psz_cstring );
142 lua_pop( p_state, i );
143 decode_URI( psz_string );
144 lua_pushstring( p_state, psz_string );
149 static int vlclua_resolve_xml_special_chars( lua_State *p_state )
151 int i = lua_gettop( p_state );
153 const char *psz_cstring = lua_tostring( p_state, 1 );
154 if( !psz_cstring ) return 0;
155 char *psz_string = strdup( psz_cstring );
156 lua_pop( p_state, i );
157 resolve_xml_special_chars( psz_string );
158 lua_pushstring( p_state, psz_string );
163 static int vlclua_msg_dbg( lua_State *p_state )
165 demux_t *p_demux = vlclua_get_demux( p_state );
166 int i = lua_gettop( p_state );
168 const char *psz_cstring = lua_tostring( p_state, 1 );
169 if( !psz_cstring ) return 0;
170 msg_Dbg( p_demux, "%s: %s", p_demux->p_sys->psz_filename, psz_cstring );
173 static int vlclua_msg_warn( lua_State *p_state )
175 demux_t *p_demux = vlclua_get_demux( p_state );
176 int i = lua_gettop( p_state );
178 const char *psz_cstring = lua_tostring( p_state, 1 );
179 if( !psz_cstring ) return 0;
180 msg_Warn( p_demux, "%s: %s", p_demux->p_sys->psz_filename, psz_cstring );
183 static int vlclua_msg_err( lua_State *p_state )
185 demux_t *p_demux = vlclua_get_demux( p_state );
186 int i = lua_gettop( p_state );
188 const char *psz_cstring = lua_tostring( p_state, 1 );
189 if( !psz_cstring ) return 0;
190 msg_Err( p_demux, "%s: %s", p_demux->p_sys->psz_filename, psz_cstring );
193 static int vlclua_msg_info( lua_State *p_state )
195 demux_t *p_demux = vlclua_get_demux( p_state );
196 int i = lua_gettop( p_state );
198 const char *psz_cstring = lua_tostring( p_state, 1 );
199 if( !psz_cstring ) return 0;
200 msg_Info( p_demux, "%s: %s", p_demux->p_sys->psz_filename, psz_cstring );
204 /* Functions to register */
205 static luaL_Reg p_reg[] =
207 { "peek", vlclua_peek },
208 { "decode_uri", vlclua_decode_uri },
209 { "resolve_xml_special_chars", vlclua_resolve_xml_special_chars },
210 { "msg_dbg", vlclua_msg_dbg },
211 { "msg_warn", vlclua_msg_warn },
212 { "msg_err", vlclua_msg_err },
213 { "msg_info", vlclua_msg_info },
217 /* Functions to register for parse() function call only */
218 static luaL_Reg p_reg_parse[] =
220 { "read", vlclua_read },
221 { "readline", vlclua_readline },
225 /*****************************************************************************
227 *****************************************************************************/
228 static int file_select( const char *file )
230 int i = strlen( file );
231 return i > 4 && !strcmp( file+i-4, ".lua" );
234 static int file_compare( const char **a, const char **b )
236 return strcmp( *a, *b );
239 /*****************************************************************************
240 * Import_LuaPlaylist: main import function
241 *****************************************************************************/
242 int E_(Import_LuaPlaylist)( vlc_object_t *p_this )
244 demux_t *p_demux = (demux_t *)p_this;
246 int i_ret = VLC_EGENERIC;
248 char *psz_filename = NULL;
251 char **ppsz_filelist = NULL;
252 char **ppsz_fileend = NULL;
255 char *ppsz_dir_list[] = { NULL, NULL, NULL };
258 p_demux->p_sys = (demux_sys_t*)malloc( sizeof( demux_sys_t ) );
259 if( !p_demux->p_sys )
264 p_demux->p_sys->psz_filename = NULL;
266 p_demux->pf_control = Control;
267 p_demux->pf_demux = Demux;
269 /* Initialise Lua state structure */
270 p_state = luaL_newstate();
273 msg_Err( p_demux, "Could not create new Lua State" );
274 free( p_demux->p_sys );
277 p_demux->p_sys->p_state = p_state;
279 /* Load Lua libraries */
280 luaL_openlibs( p_state ); /* FIXME: Don't open all the libs? */
282 luaL_register( p_state, "vlc", p_reg );
283 lua_pushlightuserdata( p_state, p_demux );
284 lua_setfield( p_state, lua_gettop( p_state ) - 1, "private" );
285 lua_pushstring( p_state, p_demux->psz_path );
286 lua_setfield( p_state, lua_gettop( p_state ) - 1, "path" );
287 lua_pushstring( p_state, p_demux->psz_access );
288 lua_setfield( p_state, lua_gettop( p_state ) - 1, "access" );
290 lua_pop( p_state, 1 );
292 ppsz_dir_list[0] = malloc( strlen( p_demux->p_libvlc->psz_homedir )
293 + strlen( "/"CONFIG_DIR"/luaplaylist" ) + 1 );
294 sprintf( ppsz_dir_list[0], "%s/"CONFIG_DIR"/luaplaylist",
295 p_demux->p_libvlc->psz_homedir );
297 # if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
299 char *psz_vlcpath = config_GetDataDir( p_demux );
300 ppsz_dir_list[1] = malloc( strlen( psz_vlcpath ) + strlen( "luaplaylist" ) + 1 );
301 if( !ppsz_dir_list[1] ) return VLC_ENOMEM;
302 sprintf( ppsz_dir_list[1], "%s/luaplaylist", psz_vlcpath );
306 # ifdef HAVE_SYS_STAT_H
307 struct stat stat_info;
308 if( ( utf8_stat( "share/luaplaylist", &stat_info ) == -1 )
309 || !S_ISDIR( stat_info.st_mode ) )
311 ppsz_dir_list[1] = strdup( DATA_PATH "/luaplaylist" );
316 ppsz_dir_list[1] = strdup( "share/luaplaylist" );
321 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
327 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
330 free( ppsz_filelist );
331 ppsz_filelist = NULL;
339 msg_Dbg( p_demux, "Trying Lua scripts in %s", *ppsz_dir );
340 dir = utf8_opendir( *ppsz_dir );
343 i_files = utf8_loaddir( dir, &ppsz_filelist, file_select, file_compare );
344 if( i_files < 1 ) continue;
345 ppsz_fileend = ppsz_filelist + i_files;
347 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
349 free( psz_filename ); psz_filename = NULL;
350 asprintf( &psz_filename, "%s/%s", *ppsz_dir, *ppsz_file );
351 msg_Dbg( p_demux, "Trying Lua playlist script %s", psz_filename );
352 p_demux->p_sys->psz_filename = psz_filename;
354 /* Ugly hack to delete previous versions of the probe() and parse()
356 lua_pushnil( p_state );
357 lua_pushnil( p_state );
358 lua_setglobal( p_state, "probe" );
359 lua_setglobal( p_state, "parse" );
361 /* Load and run the script(s) */
362 if( luaL_dofile( p_state, psz_filename ) )
364 msg_Warn( p_demux, "Error loading script %s: %s", psz_filename,
365 lua_tostring( p_state, lua_gettop( p_state ) ) );
366 lua_pop( p_state, 1 );
370 lua_getglobal( p_state, "probe" );
372 if( !lua_isfunction( p_state, lua_gettop( p_state ) ) )
374 msg_Warn( p_demux, "Error while runing script %s, "
375 "function probe() not found", psz_filename );
376 lua_pop( p_state, 1 );
380 if( lua_pcall( p_state, 0, 1, 0 ) )
382 msg_Warn( p_demux, "Error while runing script %s, "
383 "function probe(): %s", psz_filename,
384 lua_tostring( p_state, lua_gettop( p_state ) ) );
385 lua_pop( p_state, 1 );
389 if( lua_gettop( p_state ) )
391 if( lua_toboolean( p_state, 1 ) )
393 msg_Dbg( p_demux, "Lua playlist script %s's "
394 "probe() function was successful", psz_filename );
397 lua_pop( p_state, 1 );
399 if( i_ret == VLC_SUCCESS ) break;
402 if( i_ret == VLC_SUCCESS ) break;
407 for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
410 free( ppsz_filelist );
412 for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
415 if( dir ) closedir( dir );
416 if( i_ret != VLC_SUCCESS )
417 E_(Close_LuaPlaylist)( p_this );
421 /*****************************************************************************
422 * Deactivate: frees unused data
423 *****************************************************************************/
424 void E_(Close_LuaPlaylist)( vlc_object_t *p_this )
426 demux_t *p_demux = (demux_t *)p_this;
427 lua_close( p_demux->p_sys->p_state );
428 free( p_demux->p_sys->psz_filename );
429 free( p_demux->p_sys );
432 static inline void read_options( demux_t *p_demux, lua_State *p_state,
433 int o, int t, int *pi_options,
434 char ***pppsz_options )
436 lua_getfield( p_state, o, "options" );
437 if( lua_istable( p_state, t ) )
439 lua_pushnil( p_state );
440 while( lua_next( p_state, t ) )
442 if( lua_isstring( p_state, t+2 ) )
444 char *psz_option = strdup( lua_tostring( p_state, t+2 ) );
445 msg_Dbg( p_demux, "Option: %s", psz_option );
446 INSERT_ELEM( *pppsz_options, *pi_options, *pi_options,
451 msg_Warn( p_demux, "Option should be a string" );
453 lua_pop( p_state, 1 ); /* pop option */
456 lua_pop( p_state, 1 ); /* pop "options" */
459 static inline void read_meta_data( demux_t *p_demux,
460 lua_State *p_state, int o, int t,
461 input_item_t *p_input )
463 const char *psz_value;
464 #define TRY_META( a, b ) \
465 lua_getfield( p_state, o, a ); \
466 if( lua_isstring( p_state, t ) ) \
468 psz_value = lua_tostring( p_state, t ); \
469 msg_Dbg( p_demux, #b ": %s", psz_value ); \
470 input_item_Set ## b ( p_input, psz_value ); \
472 lua_pop( p_state, 1 ); /* pop a */
473 TRY_META( "title", Title );
474 TRY_META( "artist", Artist );
475 TRY_META( "genre", Genre );
476 TRY_META( "copyright", Copyright );
477 TRY_META( "album", Album );
478 TRY_META( "tracknum", TrackNum );
479 TRY_META( "description", Description );
480 TRY_META( "rating", Rating );
481 TRY_META( "date", Date );
482 TRY_META( "setting", Setting );
483 TRY_META( "url", URL );
484 TRY_META( "language", Language );
485 TRY_META( "nowplaying", NowPlaying );
486 TRY_META( "publisher", Publisher );
487 TRY_META( "encodedby", EncodedBy );
488 TRY_META( "arturl", ArtURL );
489 TRY_META( "trackid", TrackID );
492 static inline void read_custom_meta_data( demux_t *p_demux,
493 lua_State *p_state, int o, int t,
494 input_item_t *p_input )
496 lua_getfield( p_state, o, "meta" );
497 if( lua_istable( p_state, t ) )
499 lua_pushnil( p_state );
500 while( lua_next( p_state, t ) )
502 if( !lua_isstring( p_state, t+1 ) )
504 msg_Warn( p_demux, "Custom meta data category name must be "
507 else if( !lua_istable( p_state, t+2 ) )
509 msg_Warn( p_demux, "Custom meta data category contents "
514 const char *psz_meta_category = lua_tostring( p_state, t+1 );
515 msg_Dbg( p_demux, "Found custom meta data category: %s",
517 lua_pushnil( p_state );
518 while( lua_next( p_state, t+2 ) )
520 if( !lua_isstring( p_state, t+3 ) )
522 msg_Warn( p_demux, "Custom meta category item name "
523 "must be a string." );
525 else if( !lua_isstring( p_state, t+4 ) )
527 msg_Warn( p_demux, "Custom meta category item value "
528 "must be a string." );
532 const char *psz_meta_name =
533 lua_tostring( p_state, t+3 );
534 const char *psz_meta_value =
535 lua_tostring( p_state, t+4 );
536 msg_Dbg( p_demux, "Custom meta %s, %s: %s",
537 psz_meta_category, psz_meta_name,
539 input_ItemAddInfo( p_input, psz_meta_category,
540 psz_meta_name, psz_meta_value );
542 lua_pop( p_state, 1 ); /* pop item */
545 lua_pop( p_state, 1 ); /* pop category */
548 lua_pop( p_state, 1 ); /* pop "meta" */
551 static int Demux( demux_t *p_demux )
553 input_item_t *p_input;
554 lua_State *p_state = p_demux->p_sys->p_state;
555 char *psz_filename = p_demux->p_sys->psz_filename;
560 luaL_register( p_state, "vlc", p_reg_parse );
562 lua_getglobal( p_state, "parse" );
564 if( !lua_isfunction( p_state, lua_gettop( p_state ) ) )
566 msg_Warn( p_demux, "Error while runing script %s, "
567 "function parse() not found", psz_filename );
568 E_(Close_LuaPlaylist)( VLC_OBJECT( p_demux ) );
572 if( lua_pcall( p_state, 0, 1, 0 ) )
574 msg_Warn( p_demux, "Error while runing script %s, "
575 "function parse(): %s", psz_filename,
576 lua_tostring( p_state, lua_gettop( p_state ) ) );
577 E_(Close_LuaPlaylist)( VLC_OBJECT( p_demux ) );
581 /* Check that the Lua stack is big enough and grow it if needed.
582 * Should be ok since LUA_MINSTACK is 20 but we never know. */
583 lua_checkstack( p_state, 8 );
585 if( ( t = lua_gettop( p_state ) ) )
588 if( lua_istable( p_state, t ) )
590 lua_pushnil( p_state );
591 while( lua_next( p_state, t ) )
593 if( lua_istable( p_state, t+2 ) )
595 lua_getfield( p_state, t+2, "path" );
596 if( lua_isstring( p_state, t+3 ) )
598 const char *psz_path = NULL;
599 const char *psz_name = NULL;
600 char **ppsz_options = NULL;
602 mtime_t i_duration = -1;
604 /* Read path and name */
605 psz_path = lua_tostring( p_state, t+3 );
606 msg_Dbg( p_demux, "Path: %s", psz_path );
607 lua_getfield( p_state, t+2, "name" );
608 if( lua_isstring( p_state, t+4 ) )
610 psz_name = lua_tostring( p_state, t+4 );
611 msg_Dbg( p_demux, "Name: %s", psz_name );
619 lua_getfield( p_state, t+2, "duration" );
620 if( lua_isnumber( p_state, t+5 ) )
622 i_duration = (mtime_t)lua_tointeger( p_state, t+5 );
623 i_duration *= 1000000;
625 lua_pop( p_state, 1 ); /* pop "duration" */
628 read_options( p_demux, p_state, t+2, t+5,
629 &i_options, &ppsz_options );
631 /* Create input item */
632 p_input = input_ItemNewExt( p_playlist, psz_path,
634 (const char **)ppsz_options,
636 lua_pop( p_state, 1 ); /* pop "name" */
639 read_meta_data( p_demux, p_state, t+2, t+4, p_input );
641 /* Read custom meta data */
642 read_custom_meta_data( p_demux, p_state, t+2, t+4,
645 /* Append item to playlist */
646 playlist_BothAddInput(
649 PLAYLIST_APPEND | PLAYLIST_SPREPARSE,
650 PLAYLIST_END, NULL, NULL, VLC_FALSE );
652 while( i_options > 0 )
653 free( ppsz_options[--i_options] );
654 free( ppsz_options );
659 "Playlist item's path should be a string" );
661 lua_pop( p_state, 1 ); /* pop "path" */
665 msg_Warn( p_demux, "Playlist item should be a table" );
667 lua_pop( p_state, 1 ); /* pop the value, keep the key for
668 * the next lua_next() call */
673 msg_Warn( p_demux, "Script didn't return a table" );
678 msg_Err( p_demux, "Script went completely foobar" );
681 HANDLE_PLAY_AND_RELEASE;
683 return -1; /* Needed for correct operation of go back */
686 static int Control( demux_t *p_demux, int i_query, va_list args )