Renamed playlist "playlist-current" to "item-current".
[vlc.git] / modules / misc / lua / libs / playlist.c
1 /*****************************************************************************
2  * playlist.c
3  *****************************************************************************
4  * Copyright (C) 2007-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifndef  _GNU_SOURCE
28 #   define  _GNU_SOURCE
29 #endif
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <vlc_common.h>
36
37 #include <vlc_interface.h>
38 #include <vlc_playlist.h>
39
40 #include <lua.h>        /* Low level lua C API */
41 #include <lauxlib.h>    /* Higher level C API */
42
43 #include "../vlc.h"
44 #include "../libs.h"
45 #include "playlist.h"
46 #include "variables.h"
47
48 /*****************************************************************************
49  * Internal lua<->vlc utils
50  *****************************************************************************/
51 playlist_t *vlclua_get_playlist_internal( lua_State *L )
52 {
53     vlc_object_t *p_this = vlclua_get_this( L );
54     return pl_Hold( p_this );
55 }
56
57 void vlclua_release_playlist_internal( playlist_t *p_playlist )
58 {
59     vlc_object_release( p_playlist );
60 }
61
62 static int vlclua_playlist_prev( lua_State * L )
63 {
64     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
65     playlist_Prev( p_playlist );
66     vlclua_release_playlist_internal( p_playlist );
67     return 0;
68 }
69
70 static int vlclua_playlist_next( lua_State * L )
71 {
72     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
73     playlist_Next( p_playlist );
74     vlclua_release_playlist_internal( p_playlist );
75     return 0;
76 }
77
78 static int vlclua_playlist_skip( lua_State * L )
79 {
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 );
84     return 0;
85 }
86
87 static int vlclua_playlist_play( lua_State * L )
88 {
89     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
90     PL_LOCK;
91     playlist_Play( p_playlist );
92     PL_UNLOCK;
93     vlclua_release_playlist_internal( p_playlist );
94     return 0;
95 }
96
97 static int vlclua_playlist_pause( lua_State * L )
98 {
99     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
100     playlist_Pause( p_playlist );
101     vlclua_release_playlist_internal( p_playlist );
102     return 0;
103 }
104
105 static int vlclua_playlist_stop( lua_State * L )
106 {
107     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
108     playlist_Stop( p_playlist );
109     vlclua_release_playlist_internal( p_playlist );
110     return 0;
111 }
112
113 static int vlclua_playlist_clear( lua_State * L )
114 {
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 );
119     return 0;
120 }
121
122 static int vlclua_playlist_repeat( lua_State * L )
123 {
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 );
127     return i_ret;
128 }
129
130 static int vlclua_playlist_loop( lua_State * L )
131 {
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 );
135     return i_ret;
136 }
137
138 static int vlclua_playlist_random( lua_State * L )
139 {
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 );
143     return i_ret;
144 }
145
146 static int vlclua_playlist_goto( lua_State * L )
147 {
148     int i_id = luaL_checkint( L, 1 );
149     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
150     PL_LOCK;
151     int i_ret = playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
152                                   true, NULL,
153                                   playlist_ItemGetById( p_playlist, i_id ) );
154     PL_UNLOCK;
155     vlclua_release_playlist_internal( p_playlist );
156     return vlclua_push_ret( L, i_ret );
157 }
158
159 static int vlclua_playlist_add( lua_State *L )
160 {
161     int i_count;
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,
165                                             NULL, true );
166     vlclua_release_playlist_internal( p_playlist );
167     lua_pushinteger( L, i_count );
168     return 1;
169 }
170
171 static int vlclua_playlist_enqueue( lua_State *L )
172 {
173     int i_count;
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,
177                                             NULL, false );
178     vlclua_release_playlist_internal( p_playlist );
179     lua_pushinteger( L, i_count );
180     return 1;
181 }
182
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 )
185 {
186     input_item_t *p_input = p_item->p_input;
187     int i_flags = 0;
188     i_flags = p_item->i_flags;
189     lua_newtable( L );
190     lua_pushinteger( L, p_item->i_id );
191     lua_setfield( L, -2, "id" );
192     lua_newtable( L );
193 #define CHECK_AND_SET_FLAG( name, label ) \
194     if( i_flags & PLAYLIST_ ## name ## _FLAG ) \
195     { \
196         lua_pushboolean( L, 1 ); \
197         lua_setfield( L, -2, #label ); \
198     }
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" );
207     if( p_input )
208     {
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 );
215         else
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 */
221     }
222     if( p_item->i_children >= 0 )
223     {
224         int i;
225         lua_createtable( L, p_item->i_children, 0 );
226         for( i = 0; i < p_item->i_children; i++ )
227         {
228             push_playlist_item( L, p_item->pp_children[i] );
229             lua_rawseti( L, -2, i+1 );
230         }
231         lua_setfield( L, -2, "children" );
232     }
233 }
234
235 static int vlclua_playlist_get( lua_State *L )
236 {
237     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
238     PL_LOCK;
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;
241
242     if( lua_isnumber( L, 1 ) )
243     {
244         int i_id = lua_tointeger( L, 1 );
245         p_item = playlist_ItemGetById( p_playlist, i_id );
246         if( !p_item )
247         {
248             PL_UNLOCK;
249             vlclua_release_playlist_internal( p_playlist );
250             return 0; /* Should we return an error instead? */
251         }
252     }
253     else if( lua_isstring( L, 1 ) )
254     {
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;
267         else
268         {
269 #ifdef FIX_THAT_CODE_NOT_TO_MESS_WITH_PLAYLIST_INTERNALS
270             for( int i = 0; i < p_playlist->i_sds; i++ )
271             {
272                 if( !strcasecmp( psz_what,
273                                  p_playlist->pp_sds[i]->p_sd->psz_module ) )
274                 {
275                     p_item = b_category ? p_playlist->pp_sds[i]->p_cat
276                                         : p_playlist->pp_sds[i]->p_one;
277                     break;
278                 }
279             }
280 #else
281 # warning "Don't access playlist iternal, broken code here."
282             abort();
283 #endif
284             if( !p_item )
285             {
286                 PL_UNLOCK;
287                 vlclua_release_playlist_internal( p_playlist );
288                 return 0; /* Should we return an error instead? */
289             }
290         }
291     }
292     else
293     {
294         p_item = b_category ? p_playlist->p_root_category
295                             : p_playlist->p_root_onelevel;
296     }
297     push_playlist_item( L, p_item );
298     PL_UNLOCK;
299     vlclua_release_playlist_internal( p_playlist );
300     return 1;
301 }
302
303 static int vlclua_playlist_search( lua_State *L )
304 {
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;
310     PL_LOCK;
311     playlist_LiveSearchUpdate( p_playlist, p_item, psz_string );
312     PL_UNLOCK;
313     push_playlist_item( L, p_item );
314     vlclua_release_playlist_internal( p_playlist );
315     return 1;
316 }
317
318 static int vlclua_playlist_current( lua_State *L )
319 {
320     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
321     lua_pushinteger( L, var_GetInteger( p_playlist, "item-current" ) );
322     vlclua_release_playlist_internal( p_playlist );
323     return 1;
324 }
325
326 static int vlc_sort_key_from_string( const char *psz_name )
327 {
328     static const struct
329     {
330         const char *psz_name;
331         int i_key;
332     } pp_keys[] =
333         { { "id", SORT_ID },
334           { "title", SORT_TITLE },
335           { "title nodes first", SORT_TITLE_NODES_FIRST },
336           { "artist", SORT_ARTIST },
337           { "genre", SORT_GENRE },
338           { "random", SORT_RANDOM },
339           { "duration", SORT_DURATION },
340           { "title numeric", SORT_TITLE_NUMERIC },
341           { "album", SORT_ALBUM },
342           { NULL, -1 } };
343     int i;
344     for( i = 0; pp_keys[i].psz_name; i++ )
345     {
346         if( !strcmp( psz_name, pp_keys[i].psz_name ) )
347             return pp_keys[i].i_key;
348     }
349     return -1;
350 }
351
352 static int vlclua_playlist_sort( lua_State *L )
353 {
354     /* allow setting the different sort keys */
355     int i_mode = vlc_sort_key_from_string( luaL_checkstring( L, 1 ) );
356     if( i_mode == -1 )
357         return luaL_error( L, "Invalid search key." );
358     int i_type = luaL_optboolean( L, 2, 0 ) ? ORDER_REVERSE : ORDER_NORMAL;
359     int b_category = luaL_optboolean( L, 3, 1 ); /* default to category */
360     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
361     PL_LOCK;
362     playlist_item_t *p_root = b_category ? p_playlist->p_local_category
363                                          : p_playlist->p_local_onelevel;
364     int i_ret = playlist_RecursiveNodeSort( p_playlist, p_root, i_mode,
365                                             i_type );
366     PL_UNLOCK;
367     vlclua_release_playlist_internal( p_playlist );
368     return vlclua_push_ret( L, i_ret );
369 }
370
371 /* FIXME: split this in 3 different functions? */
372 static int vlclua_playlist_status( lua_State *L )
373 {
374     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
375     /*
376     int i_count = 0;
377     lua_settop( L, 0 );*/
378     input_thread_t * p_input = playlist_CurrentInput( p_playlist );
379     if( p_input )
380     {
381         /*char *psz_uri =
382             input_item_GetURI( input_GetItem( p_playlist->p_input ) );
383         lua_pushstring( L, psz_uri );
384         free( psz_uri );
385         lua_pushnumber( L, config_GetInt( p_intf, "volume" ) );*/
386         PL_LOCK;
387         switch( playlist_Status( p_playlist ) )
388         {
389             case PLAYLIST_STOPPED:
390                 lua_pushstring( L, "stopped" );
391                 break;
392             case PLAYLIST_RUNNING:
393                 lua_pushstring( L, "playing" );
394                 break;
395             case PLAYLIST_PAUSED:
396                 lua_pushstring( L, "paused" );
397                 break;
398             default:
399                 lua_pushstring( L, "unknown" );
400                 break;
401         }
402         PL_UNLOCK;
403         /*i_count += 3;*/
404         vlc_object_release( p_input );
405     }
406     else
407     {
408         lua_pushstring( L, "stopped" );
409     }
410     vlclua_release_playlist_internal( p_playlist );
411     return 1;
412 }
413
414 /*****************************************************************************
415  *
416  *****************************************************************************/
417 static const luaL_Reg vlclua_playlist_reg[] = {
418     { "prev", vlclua_playlist_prev },
419     { "next", vlclua_playlist_next },
420     { "skip", vlclua_playlist_skip },
421     { "play", vlclua_playlist_play },
422     { "pause", vlclua_playlist_pause },
423     { "stop", vlclua_playlist_stop },
424     { "clear", vlclua_playlist_clear },
425     { "repeat", vlclua_playlist_repeat },
426     { "loop", vlclua_playlist_loop },
427     { "random", vlclua_playlist_random },
428     { "goto", vlclua_playlist_goto },
429     { "add", vlclua_playlist_add },
430     { "enqueue", vlclua_playlist_enqueue },
431     { "get", vlclua_playlist_get },
432     { "search", vlclua_playlist_search },
433     { "current", vlclua_playlist_current },
434     { "sort", vlclua_playlist_sort },
435     { "status", vlclua_playlist_status },
436     { NULL, NULL }
437 };
438
439 void luaopen_playlist( lua_State *L )
440 {
441     lua_newtable( L );
442     luaL_register( L, NULL, vlclua_playlist_reg );
443     lua_setfield( L, -2, "playlist" );
444 }