1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2007-2008 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 *****************************************************************************/
35 #include <vlc_common.h>
37 #include <vlc_interface.h>
38 #include <vlc_playlist.h>
40 #include <lua.h> /* Low level lua C API */
41 #include <lauxlib.h> /* Higher level C API */
46 #include "variables.h"
48 /*****************************************************************************
49 * Internal lua<->vlc utils
50 *****************************************************************************/
51 playlist_t *vlclua_get_playlist_internal( lua_State *L )
53 vlc_object_t *p_this = vlclua_get_this( L );
54 return pl_Hold( p_this );
57 void vlclua_release_playlist_internal( playlist_t *p_playlist )
59 vlc_object_release( p_playlist );
62 static int vlclua_playlist_prev( lua_State * L )
64 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
65 playlist_Prev( p_playlist );
66 vlclua_release_playlist_internal( p_playlist );
70 static int vlclua_playlist_next( lua_State * L )
72 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
73 playlist_Next( p_playlist );
74 vlclua_release_playlist_internal( p_playlist );
78 static int vlclua_playlist_skip( lua_State * L )
80 int i_skip = luaL_checkint( L, 1 );
81 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
82 playlist_Skip( p_playlist, i_skip );
83 vlclua_release_playlist_internal( p_playlist );
87 static int vlclua_playlist_play( lua_State * L )
89 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
91 playlist_Play( p_playlist );
93 vlclua_release_playlist_internal( p_playlist );
97 static int vlclua_playlist_pause( lua_State * L )
99 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
100 playlist_Pause( p_playlist );
101 vlclua_release_playlist_internal( p_playlist );
105 static int vlclua_playlist_stop( lua_State * L )
107 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
108 playlist_Stop( p_playlist );
109 vlclua_release_playlist_internal( p_playlist );
113 static int vlclua_playlist_clear( lua_State * L )
115 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
116 playlist_Stop( p_playlist ); /* Isn't this already implied by Clear? */
117 playlist_Clear( p_playlist, pl_Unlocked );
118 vlclua_release_playlist_internal( p_playlist );
122 static int vlclua_playlist_repeat( lua_State * L )
124 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
125 int i_ret = vlclua_var_toggle_or_set( L, p_playlist, "repeat" );
126 vlclua_release_playlist_internal( p_playlist );
130 static int vlclua_playlist_loop( lua_State * L )
132 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
133 int i_ret = vlclua_var_toggle_or_set( L, p_playlist, "loop" );
134 vlclua_release_playlist_internal( p_playlist );
138 static int vlclua_playlist_random( lua_State * L )
140 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
141 int i_ret = vlclua_var_toggle_or_set( L, p_playlist, "random" );
142 vlclua_release_playlist_internal( p_playlist );
146 static int vlclua_playlist_goto( lua_State * L )
148 int i_id = luaL_checkint( L, 1 );
149 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
151 int i_ret = playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
153 playlist_ItemGetById( p_playlist, i_id ) );
155 vlclua_release_playlist_internal( p_playlist );
156 return vlclua_push_ret( L, i_ret );
159 static int vlclua_playlist_add( lua_State *L )
162 vlc_object_t *p_this = vlclua_get_this( L );
163 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
164 i_count = vlclua_playlist_add_internal( p_this, L, p_playlist,
166 vlclua_release_playlist_internal( p_playlist );
167 lua_pushinteger( L, i_count );
171 static int vlclua_playlist_enqueue( lua_State *L )
174 vlc_object_t *p_this = vlclua_get_this( L );
175 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
176 i_count = vlclua_playlist_add_internal( p_this, L, p_playlist,
178 vlclua_release_playlist_internal( p_playlist );
179 lua_pushinteger( L, i_count );
183 static void push_playlist_item( lua_State *L, playlist_item_t *p_item );
184 static void push_playlist_item( lua_State *L, playlist_item_t *p_item )
186 input_item_t *p_input = p_item->p_input;
188 i_flags = p_item->i_flags;
190 lua_pushinteger( L, p_item->i_id );
191 lua_setfield( L, -2, "id" );
193 #define CHECK_AND_SET_FLAG( name, label ) \
194 if( i_flags & PLAYLIST_ ## name ## _FLAG ) \
196 lua_pushboolean( L, 1 ); \
197 lua_setfield( L, -2, #label ); \
199 CHECK_AND_SET_FLAG( SAVE, save )
200 CHECK_AND_SET_FLAG( SKIP, skip )
201 CHECK_AND_SET_FLAG( DBL, disabled )
202 CHECK_AND_SET_FLAG( RO, ro )
203 CHECK_AND_SET_FLAG( REMOVE, remove )
204 CHECK_AND_SET_FLAG( EXPANDED, expanded )
205 #undef CHECK_AND_SET_FLAG
206 lua_setfield( L, -2, "flags" );
209 lua_pushstring( L, p_input->psz_name );
210 lua_setfield( L, -2, "name" );
211 lua_pushstring( L, p_input->psz_uri );
212 lua_setfield( L, -2, "path" );
213 if( p_input->i_duration < 0 )
214 lua_pushnumber( L, -1 );
216 lua_pushnumber( L, ((double)p_input->i_duration)*1e-6 );
217 lua_setfield( L, -2, "duration" );
218 lua_pushinteger( L, p_input->i_nb_played );
219 lua_setfield( L, -2, "nb_played" );
220 /* TODO: add (optional) info categories, meta, options, es */
222 if( p_item->i_children >= 0 )
225 lua_createtable( L, p_item->i_children, 0 );
226 for( i = 0; i < p_item->i_children; i++ )
228 push_playlist_item( L, p_item->pp_children[i] );
229 lua_rawseti( L, -2, i+1 );
231 lua_setfield( L, -2, "children" );
235 static int vlclua_playlist_get( lua_State *L )
237 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
239 int b_category = luaL_optboolean( L, 2, 1 ); /* Default to tree playlist (discared when 1st argument is a playlist_item's id) */
240 playlist_item_t *p_item = NULL;
242 if( lua_isnumber( L, 1 ) )
244 int i_id = lua_tointeger( L, 1 );
245 p_item = playlist_ItemGetById( p_playlist, i_id );
249 vlclua_release_playlist_internal( p_playlist );
250 return 0; /* Should we return an error instead? */
253 else if( lua_isstring( L, 1 ) )
255 const char *psz_what = lua_tostring( L, 1 );
256 if( !strcasecmp( psz_what, "normal" )
257 || !strcasecmp( psz_what, "playlist" ) )
258 p_item = b_category ? p_playlist->p_local_category
259 : p_playlist->p_local_onelevel;
260 else if( !strcasecmp( psz_what, "ml" )
261 || !strcasecmp( psz_what, "media library" ) )
262 p_item = b_category ? p_playlist->p_ml_category
263 : p_playlist->p_ml_onelevel;
264 else if( !strcasecmp( psz_what, "root" ) )
265 p_item = b_category ? p_playlist->p_root_category
266 : p_playlist->p_root_onelevel;
269 #ifdef FIX_THAT_CODE_NOT_TO_MESS_WITH_PLAYLIST_INTERNALS
270 for( int i = 0; i < p_playlist->i_sds; i++ )
272 if( !strcasecmp( psz_what,
273 p_playlist->pp_sds[i]->p_sd->psz_module ) )
275 p_item = b_category ? p_playlist->pp_sds[i]->p_cat
276 : p_playlist->pp_sds[i]->p_one;
281 # warning "Don't access playlist iternal, broken code here."
287 vlclua_release_playlist_internal( p_playlist );
288 return 0; /* Should we return an error instead? */
294 p_item = b_category ? p_playlist->p_root_category
295 : p_playlist->p_root_onelevel;
297 push_playlist_item( L, p_item );
299 vlclua_release_playlist_internal( p_playlist );
303 static int vlclua_playlist_search( lua_State *L )
305 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
306 const char *psz_string = luaL_optstring( L, 1, "" );
307 int b_category = luaL_optboolean( L, 2, 1 ); /* default to category */
308 playlist_item_t *p_item = b_category ? p_playlist->p_root_category
309 : p_playlist->p_root_onelevel;
311 playlist_LiveSearchUpdate( p_playlist, p_item, psz_string );
313 push_playlist_item( L, p_item );
314 vlclua_release_playlist_internal( p_playlist );
318 static int vlclua_playlist_current( lua_State *L )
320 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
321 input_thread_t *p_input = playlist_CurrentInput( p_playlist );
326 input_item_t *p_item = input_GetItem( p_input );
329 vlc_object_release( p_input );
332 #warning Indexing input items by ID is unsafe,
333 lua_pushinteger( L, id );
334 vlclua_release_playlist_internal( p_playlist );
338 static int vlc_sort_key_from_string( const char *psz_name )
342 const char *psz_name;
346 { "title", SORT_TITLE },
347 { "title nodes first", SORT_TITLE_NODES_FIRST },
348 { "artist", SORT_ARTIST },
349 { "genre", SORT_GENRE },
350 { "random", SORT_RANDOM },
351 { "duration", SORT_DURATION },
352 { "title numeric", SORT_TITLE_NUMERIC },
353 { "album", SORT_ALBUM },
356 for( i = 0; pp_keys[i].psz_name; i++ )
358 if( !strcmp( psz_name, pp_keys[i].psz_name ) )
359 return pp_keys[i].i_key;
364 static int vlclua_playlist_sort( lua_State *L )
366 /* allow setting the different sort keys */
367 int i_mode = vlc_sort_key_from_string( luaL_checkstring( L, 1 ) );
369 return luaL_error( L, "Invalid search key." );
370 int i_type = luaL_optboolean( L, 2, 0 ) ? ORDER_REVERSE : ORDER_NORMAL;
371 int b_category = luaL_optboolean( L, 3, 1 ); /* default to category */
372 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
374 playlist_item_t *p_root = b_category ? p_playlist->p_local_category
375 : p_playlist->p_local_onelevel;
376 int i_ret = playlist_RecursiveNodeSort( p_playlist, p_root, i_mode,
379 vlclua_release_playlist_internal( p_playlist );
380 return vlclua_push_ret( L, i_ret );
383 /* FIXME: split this in 3 different functions? */
384 static int vlclua_playlist_status( lua_State *L )
386 playlist_t *p_playlist = vlclua_get_playlist_internal( L );
389 lua_settop( L, 0 );*/
390 input_thread_t * p_input = playlist_CurrentInput( p_playlist );
394 input_item_GetURI( input_GetItem( p_playlist->p_input ) );
395 lua_pushstring( L, psz_uri );
397 lua_pushnumber( L, config_GetInt( p_intf, "volume" ) );*/
399 switch( playlist_Status( p_playlist ) )
401 case PLAYLIST_STOPPED:
402 lua_pushstring( L, "stopped" );
404 case PLAYLIST_RUNNING:
405 lua_pushstring( L, "playing" );
407 case PLAYLIST_PAUSED:
408 lua_pushstring( L, "paused" );
411 lua_pushstring( L, "unknown" );
416 vlc_object_release( p_input );
420 lua_pushstring( L, "stopped" );
422 vlclua_release_playlist_internal( p_playlist );
426 /*****************************************************************************
428 *****************************************************************************/
429 static const luaL_Reg vlclua_playlist_reg[] = {
430 { "prev", vlclua_playlist_prev },
431 { "next", vlclua_playlist_next },
432 { "skip", vlclua_playlist_skip },
433 { "play", vlclua_playlist_play },
434 { "pause", vlclua_playlist_pause },
435 { "stop", vlclua_playlist_stop },
436 { "clear", vlclua_playlist_clear },
437 { "repeat", vlclua_playlist_repeat },
438 { "loop", vlclua_playlist_loop },
439 { "random", vlclua_playlist_random },
440 { "goto", vlclua_playlist_goto },
441 { "add", vlclua_playlist_add },
442 { "enqueue", vlclua_playlist_enqueue },
443 { "get", vlclua_playlist_get },
444 { "search", vlclua_playlist_search },
445 { "current", vlclua_playlist_current },
446 { "sort", vlclua_playlist_sort },
447 { "status", vlclua_playlist_status },
451 void luaopen_playlist( lua_State *L )
454 luaL_register( L, NULL, vlclua_playlist_reg );
455 lua_setfield( L, -2, "playlist" );