1 /*****************************************************************************
2 * media_list_player.c: libvlc new API media_list player functions
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Pierre d'Herbemont <pdherbemont # videolan.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 *****************************************************************************/
23 #include "libvlc_internal.h"
24 #include <vlc/libvlc.h>
25 #include "media_list_path.h"
31 /**************************************************************************
32 * get_next_index (private)
34 * Simple next item fetcher.
35 **************************************************************************/
36 static libvlc_media_list_path_t
37 get_next_path( libvlc_media_list_player_t * p_mlp )
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(
45 p_mlp->current_playing_item_path );
47 /* If item just gained a sublist just play it */
48 if( p_sublist_of_playing_item )
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 );
54 /* Try to catch next element */
55 p_parent_of_playing_item = libvlc_media_list_parentlist_at_path(
57 p_mlp->current_playing_item_path );
59 int deepness = libvlc_media_list_path_deepness( p_mlp->current_playing_item_path );
60 if( deepness < 1 || !p_parent_of_playing_item )
63 ret = libvlc_media_list_path_copy( p_mlp->current_playing_item_path );
65 while( ret[deepness-1] >= libvlc_media_list_count( p_parent_of_playing_item, NULL ) )
71 libvlc_media_list_release( p_parent_of_playing_item );
76 p_parent_of_playing_item = libvlc_media_list_parentlist_at_path(
80 libvlc_media_list_release( p_parent_of_playing_item );
84 /**************************************************************************
85 * media_instance_reached_end (private) (Event Callback)
86 **************************************************************************/
88 media_instance_reached_end( const libvlc_event_t * p_event,
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;
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(
99 p_mlp->current_playing_item_path );
100 if( p_md != p_current_md )
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 );
108 libvlc_media_descriptor_release( p_md );
109 libvlc_media_descriptor_release( p_current_md );
110 libvlc_media_list_player_next( p_mlp, NULL );
113 /**************************************************************************
114 * playlist_item_deleted (private) (Event Callback)
115 **************************************************************************/
117 mlist_item_deleted( const libvlc_event_t * p_event, void * p_user_data )
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(
125 p_mlp->current_playing_item_path );
127 if( p_event->u.media_list_item_deleted.item == p_current_md &&
128 p_emitting_mlist == p_mlp->p_mlist )
130 /* We are playing this item, we choose to stop */
131 libvlc_media_list_player_stop( p_mlp, NULL );
135 /**************************************************************************
136 * install_playlist_observer (private)
137 **************************************************************************/
139 install_playlist_observer( libvlc_media_list_player_t * p_mlp )
141 libvlc_event_attach( libvlc_media_list_event_manager( p_mlp->p_mlist, NULL ),
142 libvlc_MediaListItemDeleted, mlist_item_deleted, p_mlp, NULL );
145 /**************************************************************************
146 * uninstall_playlist_observer (private)
147 **************************************************************************/
149 uninstall_playlist_observer( libvlc_media_list_player_t * p_mlp )
151 libvlc_event_detach( libvlc_media_list_event_manager( p_mlp->p_mlist, NULL ),
152 libvlc_MediaListItemDeleted, mlist_item_deleted, p_mlp, NULL );
155 /**************************************************************************
156 * install_media_instance_observer (private)
157 **************************************************************************/
159 install_media_instance_observer( libvlc_media_list_player_t * p_mlp )
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 );
167 /**************************************************************************
168 * uninstall_media_instance_observer (private)
169 **************************************************************************/
171 uninstall_media_instance_observer( libvlc_media_list_player_t * p_mlp )
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 );
178 /**************************************************************************
179 * set_current_playing_item (private)
181 * Playlist lock should be held
182 **************************************************************************/
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 )
190 libvlc_media_descriptor_t * p_md;
192 p_md = libvlc_media_list_item_at_path( p_mlp->p_mlist, path );
193 vlc_mutex_lock( &p_mlp->object_lock );
195 free( p_mlp->current_playing_item_path );
196 p_mlp->current_playing_item_path = path;
200 vlc_mutex_unlock( &p_mlp->object_lock );
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 )
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 );
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 );
218 vlc_mutex_unlock( &p_mlp->object_lock );
220 libvlc_media_list_unlock( p_mlp->p_mlist );
222 libvlc_media_descriptor_release( p_md ); /* for libvlc_media_list_item_at_index */
226 * Public libvlc functions
229 /**************************************************************************
231 **************************************************************************/
232 libvlc_media_list_player_t *
233 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
234 libvlc_exception_t * 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;
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,
246 libvlc_event_manager_register_event_type( p_mlp->p_event_manager,
247 libvlc_MediaListPlayerNextItemSet, p_e );
252 /**************************************************************************
254 **************************************************************************/
255 void libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp )
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 )
270 vlc_mutex_lock( &p_mlp->object_lock );
274 uninstall_media_instance_observer( p_mlp );
275 libvlc_media_instance_release( p_mlp->p_mi );
277 libvlc_media_instance_retain( p_mi );
280 install_media_instance_observer( p_mlp );
282 vlc_mutex_unlock( &p_mlp->object_lock );
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 )
293 vlc_mutex_lock( &p_mlp->object_lock );
295 if( libvlc_media_list_player_is_playing( p_mlp, p_e ) )
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 );
304 uninstall_playlist_observer( p_mlp );
305 libvlc_media_list_release( p_mlp->p_mlist );
307 libvlc_media_list_retain( p_mlist );
308 p_mlp->p_mlist = p_mlist;
310 install_playlist_observer( p_mlp );
312 vlc_mutex_unlock( &p_mlp->object_lock );
315 /**************************************************************************
317 **************************************************************************/
318 void libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
319 libvlc_exception_t * p_e )
321 if( !p_mlp->current_playing_item_path )
323 libvlc_media_list_player_next( p_mlp, p_e );
324 return; /* Will set to play */
327 libvlc_media_instance_play( p_mlp->p_mi, p_e );
331 /**************************************************************************
333 **************************************************************************/
334 void libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
335 libvlc_exception_t * p_e )
339 libvlc_media_instance_pause( p_mlp->p_mi, p_e );
342 /**************************************************************************
343 * is_playing (Public)
344 **************************************************************************/
346 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
347 libvlc_exception_t * p_e )
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);
354 /**************************************************************************
356 **************************************************************************/
358 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
359 libvlc_exception_t * p_e )
362 return libvlc_Stopped;
363 return libvlc_media_instance_get_state( p_mlp->p_mi, p_e );
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,
372 libvlc_exception_t * p_e )
374 set_current_playing_item( p_mlp, libvlc_media_list_path_with_root_index(i_index), p_e );
376 if( libvlc_exception_raised( p_e ) )
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 );
384 libvlc_media_instance_play( p_mlp->p_mi, p_e );
387 /**************************************************************************
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 )
395 libvlc_media_list_path_t path = libvlc_media_list_path_of_item( p_mlp->p_mlist, p_md );
398 libvlc_exception_raise( p_e, "No such item in media list" );
401 set_current_playing_item( p_mlp, path, p_e );
403 if( libvlc_exception_raised( p_e ) )
406 libvlc_media_instance_play( p_mlp->p_mi, p_e );
409 /**************************************************************************
411 **************************************************************************/
412 void libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
413 libvlc_exception_t * p_e )
415 libvlc_media_instance_stop( p_mlp->p_mi, p_e );
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 );
423 /**************************************************************************
425 **************************************************************************/
426 void libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
427 libvlc_exception_t * p_e )
429 libvlc_media_list_path_t path;
431 libvlc_media_list_lock( p_mlp->p_mlist );
433 path = get_next_path( p_mlp );
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 );
443 set_current_playing_item( p_mlp, path, p_e );
445 libvlc_media_instance_play( p_mlp->p_mi, p_e );
447 libvlc_media_list_unlock( p_mlp->p_mlist );
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);