control/: don't show warnings about unused exceptions
[vlc.git] / src / control / media_list_player.c
1 /*****************************************************************************
2  * media_list_player.c: libvlc new API media_list player functions
3  *****************************************************************************
4  * Copyright (C) 2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Pierre d'Herbemont <pdherbemont # videolan.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 #include "libvlc_internal.h"
24 #include <vlc/libvlc.h>
25 #include "media_list_path.h"
26
27 /*
28  * Private functions
29  */
30
31 /**************************************************************************
32  *       get_next_index (private)
33  *
34  * Simple next item fetcher.
35  **************************************************************************/
36 static libvlc_media_list_path_t
37 get_next_path( libvlc_media_list_player_t * p_mlp )
38 {
39     /* We are entered with libvlc_media_list_lock( p_mlp->p_list ) */
40     libvlc_media_list_path_t ret;
41     libvlc_media_list_t * p_parent_of_playing_item;
42     libvlc_media_list_t * p_sublist_of_playing_item;
43     p_sublist_of_playing_item = libvlc_media_list_sublist_at_path(
44                             p_mlp->p_mlist,
45                             p_mlp->current_playing_item_path );
46  
47     /* If item just gained a sublist just play it */
48     if( p_sublist_of_playing_item )
49     {
50         libvlc_media_list_release( p_sublist_of_playing_item );
51         return libvlc_media_list_path_copy_by_appending( p_mlp->current_playing_item_path, 0 );
52     }
53
54     /* Try to catch next element */
55     p_parent_of_playing_item = libvlc_media_list_parentlist_at_path(
56                             p_mlp->p_mlist,
57                             p_mlp->current_playing_item_path );
58
59     int deepness = libvlc_media_list_path_deepness( p_mlp->current_playing_item_path );
60     if( deepness < 1 || !p_parent_of_playing_item )
61         return NULL;
62
63     ret = libvlc_media_list_path_copy( p_mlp->current_playing_item_path );
64
65     while( ret[deepness-1] >= libvlc_media_list_count( p_parent_of_playing_item, NULL ) )
66     {
67         deepness--;
68         if( deepness <= 0 )
69         {
70             free( ret );
71             libvlc_media_list_release( p_parent_of_playing_item );
72             return NULL;
73         }
74         ret[deepness] = -1;
75         ret[deepness-1]++;
76         p_parent_of_playing_item  = libvlc_media_list_parentlist_at_path(
77                                         p_mlp->p_mlist,
78                                         ret );
79     }
80     libvlc_media_list_release( p_parent_of_playing_item );
81     return ret;
82 }
83
84 /**************************************************************************
85  *       media_instance_reached_end (private) (Event Callback)
86  **************************************************************************/
87 static void
88 media_instance_reached_end( const libvlc_event_t * p_event,
89                             void * p_user_data )
90 {
91     libvlc_media_list_player_t * p_mlp = p_user_data;
92     libvlc_media_instance_t * p_mi = p_event->p_obj;
93     libvlc_media_descriptor_t *p_md, * p_current_md;
94
95     p_md = libvlc_media_instance_get_media_descriptor( p_mi, NULL );
96     /* XXX: need if p_mlp->p_current_playing_index is beyond */
97     p_current_md = libvlc_media_list_item_at_path(
98                         p_mlp->p_mlist,
99                         p_mlp->current_playing_item_path );
100     if( p_md != p_current_md )
101     {
102         msg_Warn( p_mlp->p_libvlc_instance->p_libvlc_int,
103                   "We are not sync-ed with the media instance" );
104         libvlc_media_descriptor_release( p_md );
105         libvlc_media_descriptor_release( p_current_md );
106         return;
107     }
108     libvlc_media_descriptor_release( p_md );
109     libvlc_media_descriptor_release( p_current_md );
110     libvlc_media_list_player_next( p_mlp, NULL );
111 }
112
113 /**************************************************************************
114  *       playlist_item_deleted (private) (Event Callback)
115  **************************************************************************/
116 static void
117 mlist_item_deleted( const libvlc_event_t * p_event, void * p_user_data )
118 {
119     libvlc_media_descriptor_t * p_current_md;
120     libvlc_media_list_player_t * p_mlp = p_user_data;
121     libvlc_media_list_t * p_emitting_mlist = p_event->p_obj;
122     /* XXX: need if p_mlp->p_current_playing_index is beyond */
123     p_current_md = libvlc_media_list_item_at_path(
124                         p_mlp->p_mlist,
125                         p_mlp->current_playing_item_path );
126
127     if( p_event->u.media_list_item_deleted.item == p_current_md &&
128         p_emitting_mlist == p_mlp->p_mlist )
129     {
130         /* We are playing this item, we choose to stop */
131         libvlc_media_list_player_stop( p_mlp, NULL );
132     }
133 }
134
135 /**************************************************************************
136  *       install_playlist_observer (private)
137  **************************************************************************/
138 static void
139 install_playlist_observer( libvlc_media_list_player_t * p_mlp )
140 {
141     libvlc_event_attach( libvlc_media_list_event_manager( p_mlp->p_mlist, NULL ),
142             libvlc_MediaListItemDeleted, mlist_item_deleted, p_mlp, NULL );
143 }
144
145 /**************************************************************************
146  *       uninstall_playlist_observer (private)
147  **************************************************************************/
148 static void
149 uninstall_playlist_observer( libvlc_media_list_player_t * p_mlp )
150 {
151     libvlc_event_detach( libvlc_media_list_event_manager( p_mlp->p_mlist, NULL ),
152             libvlc_MediaListItemDeleted, mlist_item_deleted, p_mlp, NULL );
153 }
154
155 /**************************************************************************
156  *       install_media_instance_observer (private)
157  **************************************************************************/
158 static void
159 install_media_instance_observer( libvlc_media_list_player_t * p_mlp )
160 {
161     libvlc_event_attach( libvlc_media_instance_event_manager( p_mlp->p_mi, NULL ),
162                          libvlc_MediaInstanceReachedEnd,
163                           media_instance_reached_end, p_mlp, NULL );
164 }
165
166
167 /**************************************************************************
168  *       uninstall_media_instance_observer (private)
169  **************************************************************************/
170 static void
171 uninstall_media_instance_observer( libvlc_media_list_player_t * p_mlp )
172 {
173     libvlc_event_detach( libvlc_media_instance_event_manager( p_mlp->p_mi, NULL ),
174                          libvlc_MediaInstanceReachedEnd,
175                          media_instance_reached_end, p_mlp, NULL );
176 }
177
178 /**************************************************************************
179  *       set_current_playing_item (private)
180  *
181  * Playlist lock should be held
182  **************************************************************************/
183 static void
184 set_current_playing_item( libvlc_media_list_player_t * p_mlp,
185                           libvlc_media_list_path_t path,
186                           libvlc_exception_t * p_e )
187 {
188     VLC_UNUSED(p_e);
189
190     libvlc_media_descriptor_t * p_md;
191     
192     p_md = libvlc_media_list_item_at_path( p_mlp->p_mlist, path ); 
193     vlc_mutex_lock( &p_mlp->object_lock );
194     
195     free( p_mlp->current_playing_item_path );
196     p_mlp->current_playing_item_path = path;
197
198     if( !p_md )
199     {
200         vlc_mutex_unlock( &p_mlp->object_lock );
201         return;
202     }
203
204     /* We are not interested in getting media_descriptor stop event now */
205     uninstall_media_instance_observer( p_mlp );
206     if( p_md->p_subitems && libvlc_media_list_count( p_md->p_subitems, NULL ) > 0 )
207     {
208         libvlc_media_descriptor_t * p_submd;
209         p_submd = libvlc_media_list_item_at_index( p_md->p_subitems, 0, NULL );
210         libvlc_media_instance_set_media_descriptor( p_mlp->p_mi, p_submd, NULL );
211         libvlc_media_descriptor_release( p_submd );
212     }
213     else
214         libvlc_media_instance_set_media_descriptor( p_mlp->p_mi, p_md, NULL );
215 //    wait_playing_state(); /* If we want to be synchronous */
216     install_media_instance_observer( p_mlp );
217
218     vlc_mutex_unlock( &p_mlp->object_lock );
219
220     libvlc_media_list_unlock( p_mlp->p_mlist );        
221     
222     libvlc_media_descriptor_release( p_md ); /* for libvlc_media_list_item_at_index */
223 }
224
225 /*
226  * Public libvlc functions
227  */
228
229 /**************************************************************************
230  *         new (Public)
231  **************************************************************************/
232 libvlc_media_list_player_t *
233 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
234                               libvlc_exception_t * p_e )
235 {
236     (void)p_e;
237     libvlc_media_list_player_t * p_mlp;
238     p_mlp = malloc(sizeof(libvlc_media_list_player_t));
239     p_mlp->current_playing_item_path = NULL;
240     p_mlp->p_mi = NULL;
241     p_mlp->p_mlist = NULL;
242     vlc_mutex_init( p_instance->p_libvlc_int, &p_mlp->object_lock );
243     p_mlp->p_event_manager = libvlc_event_manager_new( p_mlp,
244                                                        p_instance,
245                                                        p_e );
246     libvlc_event_manager_register_event_type( p_mlp->p_event_manager,
247             libvlc_MediaListPlayerNextItemSet, p_e );
248
249     return p_mlp;
250 }
251
252 /**************************************************************************
253  *         release (Public)
254  **************************************************************************/
255 void libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp )
256 {
257     free(p_mlp);
258 }
259
260 /**************************************************************************
261  *        set_media_instance (Public)
262  **************************************************************************/
263 void libvlc_media_list_player_set_media_instance(
264                                      libvlc_media_list_player_t * p_mlp,
265                                      libvlc_media_instance_t * p_mi,
266                                      libvlc_exception_t * p_e )
267 {
268     VLC_UNUSED(p_e);
269
270     vlc_mutex_lock( &p_mlp->object_lock );
271
272     if( p_mlp->p_mi )
273     {
274         uninstall_media_instance_observer( p_mlp );
275         libvlc_media_instance_release( p_mlp->p_mi );
276     }
277     libvlc_media_instance_retain( p_mi );
278     p_mlp->p_mi = p_mi;
279
280     install_media_instance_observer( p_mlp );
281
282     vlc_mutex_unlock( &p_mlp->object_lock );
283 }
284
285 /**************************************************************************
286  *       set_media_list (Public)
287  **************************************************************************/
288 void libvlc_media_list_player_set_media_list(
289                                      libvlc_media_list_player_t * p_mlp,
290                                      libvlc_media_list_t * p_mlist,
291                                      libvlc_exception_t * p_e )
292 {
293     vlc_mutex_lock( &p_mlp->object_lock );
294  
295     if( libvlc_media_list_player_is_playing( p_mlp, p_e ) )
296     {
297         libvlc_media_instance_stop( p_mlp->p_mi, p_e );
298         /* Don't bother if there was an error. */
299         libvlc_exception_clear( p_e );
300     }
301
302     if( p_mlp->p_mlist )
303     {
304         uninstall_playlist_observer( p_mlp );
305         libvlc_media_list_release( p_mlp->p_mlist );
306     }
307     libvlc_media_list_retain( p_mlist );
308     p_mlp->p_mlist = p_mlist;
309  
310     install_playlist_observer( p_mlp );
311
312     vlc_mutex_unlock( &p_mlp->object_lock );
313 }
314
315 /**************************************************************************
316  *        Play (Public)
317  **************************************************************************/
318 void libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
319                                   libvlc_exception_t * p_e )
320 {
321     if( !p_mlp->current_playing_item_path )
322     {
323         libvlc_media_list_player_next( p_mlp, p_e );
324         return; /* Will set to play */
325     }
326
327     libvlc_media_instance_play( p_mlp->p_mi, p_e );
328 }
329
330
331 /**************************************************************************
332  *        Pause (Public)
333  **************************************************************************/
334 void libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
335                                      libvlc_exception_t * p_e )
336 {
337     if( !p_mlp->p_mi )
338         return;
339     libvlc_media_instance_pause( p_mlp->p_mi, p_e );
340 }
341
342 /**************************************************************************
343  *        is_playing (Public)
344  **************************************************************************/
345 vlc_bool_t
346 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
347                                      libvlc_exception_t * p_e )
348 {
349     libvlc_state_t state = libvlc_media_instance_get_state( p_mlp->p_mi, p_e );
350     return (state == libvlc_Opening) || (state == libvlc_Buffering) ||
351            (state == libvlc_Playing);
352 }
353
354 /**************************************************************************
355  *        State (Public)
356  **************************************************************************/
357 libvlc_state_t
358 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
359                                     libvlc_exception_t * p_e )
360 {
361     if( !p_mlp->p_mi )
362         return libvlc_Stopped;
363     return libvlc_media_instance_get_state( p_mlp->p_mi, p_e );
364 }
365
366 /**************************************************************************
367  *        Play item at index (Public)
368  **************************************************************************/
369 void libvlc_media_list_player_play_item_at_index(
370                         libvlc_media_list_player_t * p_mlp,
371                         int i_index,
372                         libvlc_exception_t * p_e )
373 {
374     set_current_playing_item( p_mlp, libvlc_media_list_path_with_root_index(i_index), p_e );
375
376     if( libvlc_exception_raised( p_e ) )
377         return;
378
379     /* Send the next item event */
380     libvlc_event_t event;
381     event.type = libvlc_MediaListPlayerNextItemSet;
382     libvlc_event_send( p_mlp->p_event_manager, &event );
383
384     libvlc_media_instance_play( p_mlp->p_mi, p_e );
385 }
386
387 /**************************************************************************
388  *        Play item (Public)
389  **************************************************************************/
390 void libvlc_media_list_player_play_item(
391                         libvlc_media_list_player_t * p_mlp,
392                         libvlc_media_descriptor_t * p_md,
393                         libvlc_exception_t * p_e )
394 {
395     libvlc_media_list_path_t path = libvlc_media_list_path_of_item( p_mlp->p_mlist, p_md );
396     if( !path )
397     {
398         libvlc_exception_raise( p_e, "No such item in media list" );
399         return;
400     }
401     set_current_playing_item( p_mlp, path, p_e );
402
403     if( libvlc_exception_raised( p_e ) )
404         return;
405
406     libvlc_media_instance_play( p_mlp->p_mi, p_e );
407 }
408
409 /**************************************************************************
410  *       Stop (Public)
411  **************************************************************************/
412 void libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
413                                     libvlc_exception_t * p_e )
414 {
415     libvlc_media_instance_stop( p_mlp->p_mi, p_e );
416
417     vlc_mutex_lock( &p_mlp->object_lock );
418     free( p_mlp->current_playing_item_path );
419     p_mlp->current_playing_item_path = NULL;
420     vlc_mutex_unlock( &p_mlp->object_lock );
421 }
422
423 /**************************************************************************
424  *       Next (Public)
425  **************************************************************************/
426 void libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
427                                     libvlc_exception_t * p_e )
428 {    
429     libvlc_media_list_path_t path;
430     
431     libvlc_media_list_lock( p_mlp->p_mlist );
432
433     path = get_next_path( p_mlp );
434
435     if( !path )
436     {
437         libvlc_media_list_unlock( p_mlp->p_mlist );
438         libvlc_exception_raise( p_e, "No more element to play" );
439         libvlc_media_list_player_stop( p_mlp, p_e );
440         return;
441     }
442
443     set_current_playing_item( p_mlp, path, p_e );
444     
445     libvlc_media_instance_play( p_mlp->p_mi, p_e );
446
447     libvlc_media_list_unlock( p_mlp->p_mlist );
448
449     /* Send the next item event */
450     libvlc_event_t event;
451     event.type = libvlc_MediaListPlayerNextItemSet;
452     libvlc_event_send( p_mlp->p_event_manager, &event);
453 }