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 )
188 libvlc_media_descriptor_t * p_md;
190 p_md = libvlc_media_list_item_at_path( p_mlp->p_mlist, path );
191 vlc_mutex_lock( &p_mlp->object_lock );
193 free( p_mlp->current_playing_item_path );
194 p_mlp->current_playing_item_path = path;
198 vlc_mutex_unlock( &p_mlp->object_lock );
202 /* We are not interested in getting media_descriptor stop event now */
203 uninstall_media_instance_observer( p_mlp );
204 if( p_md->p_subitems && libvlc_media_list_count( p_md->p_subitems, NULL ) > 0 )
206 libvlc_media_descriptor_t * p_submd;
207 p_submd = libvlc_media_list_item_at_index( p_md->p_subitems, 0, NULL );
208 libvlc_media_instance_set_media_descriptor( p_mlp->p_mi, p_submd, NULL );
209 libvlc_media_descriptor_release( p_submd );
212 libvlc_media_instance_set_media_descriptor( p_mlp->p_mi, p_md, NULL );
213 // wait_playing_state(); /* If we want to be synchronous */
214 install_media_instance_observer( p_mlp );
216 vlc_mutex_unlock( &p_mlp->object_lock );
218 libvlc_media_list_unlock( p_mlp->p_mlist );
220 libvlc_media_descriptor_release( p_md ); /* for libvlc_media_list_item_at_index */
224 * Public libvlc functions
227 /**************************************************************************
229 **************************************************************************/
230 libvlc_media_list_player_t *
231 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
232 libvlc_exception_t * p_e )
235 libvlc_media_list_player_t * p_mlp;
236 p_mlp = malloc(sizeof(libvlc_media_list_player_t));
237 p_mlp->current_playing_item_path = NULL;
239 p_mlp->p_mlist = NULL;
240 vlc_mutex_init( p_instance->p_libvlc_int, &p_mlp->object_lock );
241 p_mlp->p_event_manager = libvlc_event_manager_new( p_mlp,
244 libvlc_event_manager_register_event_type( p_mlp->p_event_manager,
245 libvlc_MediaListPlayerNextItemSet, p_e );
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 )
268 vlc_mutex_lock( &p_mlp->object_lock );
272 uninstall_media_instance_observer( p_mlp );
273 libvlc_media_instance_release( p_mlp->p_mi );
275 libvlc_media_instance_retain( p_mi );
278 install_media_instance_observer( p_mlp );
280 vlc_mutex_unlock( &p_mlp->object_lock );
283 /**************************************************************************
284 * set_media_list (Public)
285 **************************************************************************/
286 void libvlc_media_list_player_set_media_list(
287 libvlc_media_list_player_t * p_mlp,
288 libvlc_media_list_t * p_mlist,
289 libvlc_exception_t * p_e )
291 vlc_mutex_lock( &p_mlp->object_lock );
293 if( libvlc_media_list_player_is_playing( p_mlp, p_e ) )
295 libvlc_media_instance_stop( p_mlp->p_mi, p_e );
296 /* Don't bother if there was an error. */
297 libvlc_exception_clear( p_e );
302 uninstall_playlist_observer( p_mlp );
303 libvlc_media_list_release( p_mlp->p_mlist );
305 libvlc_media_list_retain( p_mlist );
306 p_mlp->p_mlist = p_mlist;
308 install_playlist_observer( p_mlp );
310 vlc_mutex_unlock( &p_mlp->object_lock );
313 /**************************************************************************
315 **************************************************************************/
316 void libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
317 libvlc_exception_t * p_e )
319 if( !p_mlp->current_playing_item_path )
321 libvlc_media_list_player_next( p_mlp, p_e );
322 return; /* Will set to play */
325 libvlc_media_instance_play( p_mlp->p_mi, p_e );
329 /**************************************************************************
331 **************************************************************************/
332 void libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
333 libvlc_exception_t * p_e )
337 libvlc_media_instance_pause( p_mlp->p_mi, p_e );
340 /**************************************************************************
341 * is_playing (Public)
342 **************************************************************************/
343 int libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
344 libvlc_exception_t * p_e )
346 libvlc_state_t state = libvlc_media_instance_get_state( p_mlp->p_mi, p_e );
347 return (state == libvlc_Opening) || (state == libvlc_Buffering) ||
348 (state == libvlc_Playing);
351 /**************************************************************************
353 **************************************************************************/
355 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
356 libvlc_exception_t * p_e )
359 return libvlc_Stopped;
360 return libvlc_media_instance_get_state( p_mlp->p_mi, p_e );
363 /**************************************************************************
364 * Play item at index (Public)
365 **************************************************************************/
366 void libvlc_media_list_player_play_item_at_index(
367 libvlc_media_list_player_t * p_mlp,
369 libvlc_exception_t * p_e )
371 set_current_playing_item( p_mlp, libvlc_media_list_path_with_root_index(i_index), p_e );
373 if( libvlc_exception_raised( p_e ) )
376 /* Send the next item event */
377 libvlc_event_t event;
378 event.type = libvlc_MediaListPlayerNextItemSet;
379 libvlc_event_send( p_mlp->p_event_manager, &event );
381 libvlc_media_instance_play( p_mlp->p_mi, p_e );
384 /**************************************************************************
386 **************************************************************************/
387 void libvlc_media_list_player_play_item(
388 libvlc_media_list_player_t * p_mlp,
389 libvlc_media_descriptor_t * p_md,
390 libvlc_exception_t * p_e )
392 libvlc_media_list_path_t path = libvlc_media_list_path_of_item( p_mlp->p_mlist, p_md );
395 libvlc_exception_raise( p_e, "No such item in media list" );
398 set_current_playing_item( p_mlp, path, p_e );
400 if( libvlc_exception_raised( p_e ) )
403 libvlc_media_instance_play( p_mlp->p_mi, p_e );
406 /**************************************************************************
408 **************************************************************************/
409 void libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
410 libvlc_exception_t * p_e )
412 libvlc_media_instance_stop( p_mlp->p_mi, p_e );
414 vlc_mutex_lock( &p_mlp->object_lock );
415 free( p_mlp->current_playing_item_path );
416 p_mlp->current_playing_item_path = NULL;
417 vlc_mutex_unlock( &p_mlp->object_lock );
420 /**************************************************************************
422 **************************************************************************/
423 void libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
424 libvlc_exception_t * p_e )
426 libvlc_media_list_path_t path;
428 libvlc_media_list_lock( p_mlp->p_mlist );
430 path = get_next_path( p_mlp );
434 libvlc_media_list_unlock( p_mlp->p_mlist );
435 libvlc_exception_raise( p_e, "No more element to play" );
436 libvlc_media_list_player_stop( p_mlp, p_e );
440 set_current_playing_item( p_mlp, path, p_e );
442 libvlc_media_instance_play( p_mlp->p_mi, p_e );
444 libvlc_media_list_unlock( p_mlp->p_mlist );
446 /* Send the next item event */
447 libvlc_event_t event;
448 event.type = libvlc_MediaListPlayerNextItemSet;
449 libvlc_event_send( p_mlp->p_event_manager, &event);