1 /*****************************************************************************
2 * media_list_player.c: libvlc new API media_list player functions
3 *****************************************************************************
4 * Copyright (C) 2007 VLC authors and VideoLAN
7 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
28 #include <vlc/libvlc.h>
29 #include <vlc/libvlc_media.h>
30 #include <vlc/libvlc_media_list.h>
31 #include <vlc/libvlc_media_player.h>
32 #include <vlc/libvlc_media_list_player.h>
33 #include <vlc/libvlc_events.h>
36 #include "libvlc_internal.h"
38 #include "media_internal.h" // Abuse, could and should be removed
39 #include "media_list_path.h"
41 //#define DEBUG_MEDIA_LIST_PLAYER
43 /* This is a very dummy implementation of playlist on top of
44 * media_list and media_player.
46 * All this code is doing is simply computing the next item
47 * of a tree of media_list (see get_next_index()), and play
48 * the next item when the current is over. This is happening
49 * via the event callback media_player_reached_end().
51 * This is thread safe, and we use a two keys (locks) scheme
52 * to discriminate between callbacks and regular uses.
55 struct libvlc_media_list_player_t
57 libvlc_event_manager_t
* p_event_manager
;
58 libvlc_instance_t
* p_libvlc_instance
;
60 /* Protect access to this structure. */
61 vlc_mutex_t object_lock
;
62 /* Protect access to this structure and from callback execution. */
63 vlc_mutex_t mp_callback_lock
;
64 /* Indicate to media player callbacks that they are cancelled. */
65 bool are_mp_callback_cancelled
;
66 libvlc_media_list_path_t current_playing_item_path
;
67 libvlc_media_t
* p_current_playing_item
;
68 libvlc_media_list_t
* p_mlist
;
69 libvlc_media_player_t
* p_mi
;
70 libvlc_playback_mode_t e_playback_mode
;
73 /* This is not yet exported by libvlccore */
74 static inline void vlc_assert_locked(vlc_mutex_t
*mutex
)
84 int set_relative_playlist_position_and_play(libvlc_media_list_player_t
*p_mlp
,
85 int i_relative_position
);
86 static void stop(libvlc_media_list_player_t
* p_mlp
);
92 /**************************************************************************
94 **************************************************************************/
95 static inline void lock(libvlc_media_list_player_t
* p_mlp
)
97 // Obtain an access to this structure
98 vlc_mutex_lock(&p_mlp
->object_lock
);
100 // Make sure no callback will occurs at the same time
101 vlc_mutex_lock(&p_mlp
->mp_callback_lock
);
104 static inline void unlock(libvlc_media_list_player_t
* p_mlp
)
106 vlc_mutex_unlock(&p_mlp
->mp_callback_lock
);
107 vlc_mutex_unlock(&p_mlp
->object_lock
);
110 static inline void assert_locked(libvlc_media_list_player_t
* p_mlp
)
112 vlc_assert_locked(&p_mlp
->mp_callback_lock
);
115 static inline libvlc_event_manager_t
* mlist_em(libvlc_media_list_player_t
* p_mlp
)
117 assert_locked(p_mlp
);
118 return libvlc_media_list_event_manager(p_mlp
->p_mlist
);
121 static inline libvlc_event_manager_t
* mplayer_em(libvlc_media_list_player_t
* p_mlp
)
123 assert_locked(p_mlp
);
124 return libvlc_media_player_event_manager(p_mlp
->p_mi
);
127 /**************************************************************************
128 * get_next_path (private)
130 * Returns the path to the next item in the list.
131 * If looping is specified and the current item is the last list item in
132 * the list it will return the first item in the list.
133 **************************************************************************/
134 static libvlc_media_list_path_t
135 get_next_path(libvlc_media_list_player_t
* p_mlp
, bool b_loop
)
137 assert_locked(p_mlp
);
139 /* We are entered with libvlc_media_list_lock(p_mlp->p_list) */
140 libvlc_media_list_path_t ret
;
141 libvlc_media_list_t
* p_parent_of_playing_item
;
142 libvlc_media_list_t
* p_sublist_of_playing_item
;
144 if (!p_mlp
->current_playing_item_path
)
146 if (!libvlc_media_list_count(p_mlp
->p_mlist
))
148 return libvlc_media_list_path_with_root_index(0);
151 p_sublist_of_playing_item
= libvlc_media_list_sublist_at_path(
153 p_mlp
->current_playing_item_path
);
155 /* If item just gained a sublist just play it */
156 if (p_sublist_of_playing_item
)
158 libvlc_media_list_release(p_sublist_of_playing_item
);
159 return libvlc_media_list_path_copy_by_appending(p_mlp
->current_playing_item_path
, 0);
162 /* Try to catch parent element */
163 p_parent_of_playing_item
= libvlc_media_list_parentlist_at_path(p_mlp
->p_mlist
,
164 p_mlp
->current_playing_item_path
);
166 int depth
= libvlc_media_list_path_depth(p_mlp
->current_playing_item_path
);
167 if (depth
< 1 || !p_parent_of_playing_item
)
170 ret
= libvlc_media_list_path_copy(p_mlp
->current_playing_item_path
);
171 ret
[depth
- 1]++; /* set to next element */
173 /* If this goes beyond the end of the list */
174 while(ret
[depth
-1] >= libvlc_media_list_count(p_parent_of_playing_item
))
188 libvlc_media_list_release(p_parent_of_playing_item
);
194 p_parent_of_playing_item
= libvlc_media_list_parentlist_at_path(
199 libvlc_media_list_release(p_parent_of_playing_item
);
203 /**************************************************************************
204 * find_last_item (private)
206 * Returns the path of the last descendant of a given item path.
207 * Note: Due to the recursive nature of the function and the need to free
208 * media list paths, paths passed in may be freed if they are replaced.
209 Recommended usage is to set return value to the same path that was
210 passed to the function (i.e. item = find_last_item(list, item); )
211 **************************************************************************/
212 static libvlc_media_list_path_t
213 find_last_item( libvlc_media_list_t
* p_mlist
, libvlc_media_list_path_t current_item
)
215 libvlc_media_list_t
* p_sublist
= libvlc_media_list_sublist_at_path(p_mlist
, current_item
);
216 libvlc_media_list_path_t last_item_path
= current_item
;
220 int i_count
= libvlc_media_list_count(p_sublist
);
223 /* Add the last sublist item to the path. */
224 last_item_path
= libvlc_media_list_path_copy_by_appending(current_item
, i_count
- 1);
226 /* Check that sublist item for more descendants. */
227 last_item_path
= find_last_item(p_mlist
, last_item_path
);
230 libvlc_media_list_release(p_sublist
);
233 return last_item_path
;
236 /**************************************************************************
237 * get_previous_path (private)
239 * Returns the path to the preceding item in the list.
240 * If looping is specified and the current item is the first list item in
241 * the list it will return the last descendant of the last item in the list.
242 **************************************************************************/
243 static libvlc_media_list_path_t
244 get_previous_path(libvlc_media_list_player_t
* p_mlp
, bool b_loop
)
246 assert_locked(p_mlp
);
248 /* We are entered with libvlc_media_list_lock(p_mlp->p_list) */
249 libvlc_media_list_path_t ret
;
250 libvlc_media_list_t
* p_parent_of_playing_item
;
252 if (!p_mlp
->current_playing_item_path
)
254 if (!libvlc_media_list_count(p_mlp
->p_mlist
))
256 return libvlc_media_list_path_with_root_index(0);
259 /* Try to catch parent element */
260 p_parent_of_playing_item
= libvlc_media_list_parentlist_at_path(
262 p_mlp
->current_playing_item_path
);
264 int depth
= libvlc_media_list_path_depth(p_mlp
->current_playing_item_path
);
265 if (depth
< 1 || !p_parent_of_playing_item
)
268 /* Set the return path to the current path */
269 ret
= libvlc_media_list_path_copy(p_mlp
->current_playing_item_path
);
271 /* Change the return path to the previous list entry */
272 ret
[depth
- 1]--; /* set to previous element */
275 /* Is the return path is beyond the start of the current list? */
276 if(ret
[depth
- 1] < 0)
278 /* Move to parent of current item */
281 /* Are we at the root level of the tree? */
284 // Is looping enabled?
287 int i_count
= libvlc_media_list_count(p_parent_of_playing_item
);
289 /* Set current play item to the last element in the list */
290 ret
[0] = i_count
- 1;
293 /* Set the return path to the last descendant item of the current item */
294 ret
= find_last_item(p_mlp
->p_mlist
, ret
);
298 /* No looping so return empty path. */
305 /* This is the case of moving backward from the beginning of the
306 * subitem list to its parent item.
307 * This ensures that current path is properly terminated to
315 ret
= find_last_item(p_mlp
->p_mlist
, ret
);
318 libvlc_media_list_release(p_parent_of_playing_item
);
322 /**************************************************************************
323 * media_player_reached_end (private) (Event Callback)
324 **************************************************************************/
326 media_player_reached_end(const libvlc_event_t
* p_event
, void * p_user_data
)
329 libvlc_media_list_player_t
* p_mlp
= p_user_data
;
331 vlc_mutex_lock(&p_mlp
->mp_callback_lock
);
332 if (!p_mlp
->are_mp_callback_cancelled
)
333 set_relative_playlist_position_and_play(p_mlp
, 1);
334 vlc_mutex_unlock(&p_mlp
->mp_callback_lock
);
337 /**************************************************************************
338 * playlist_item_deleted (private) (Event Callback)
339 **************************************************************************/
341 mlist_item_deleted(const libvlc_event_t
* p_event
, void * p_user_data
)
343 // Nothing to do. For now.
344 (void)p_event
; (void)p_user_data
;
348 /**************************************************************************
349 * install_playlist_observer (private)
350 **************************************************************************/
352 install_playlist_observer(libvlc_media_list_player_t
* p_mlp
)
354 assert_locked(p_mlp
);
355 libvlc_event_attach(mlist_em(p_mlp
), libvlc_MediaListItemDeleted
, mlist_item_deleted
, p_mlp
);
358 /**************************************************************************
359 * uninstall_playlist_observer (private)
360 **************************************************************************/
362 uninstall_playlist_observer(libvlc_media_list_player_t
* p_mlp
)
364 assert_locked(p_mlp
);
365 if (!p_mlp
->p_mlist
) return;
366 libvlc_event_detach(mlist_em(p_mlp
), libvlc_MediaListItemDeleted
, mlist_item_deleted
, p_mlp
);
369 /**************************************************************************
370 * install_media_player_observer (private)
371 **************************************************************************/
373 install_media_player_observer(libvlc_media_list_player_t
* p_mlp
)
375 assert_locked(p_mlp
);
376 libvlc_event_attach_async(mplayer_em(p_mlp
), libvlc_MediaPlayerEndReached
, media_player_reached_end
, p_mlp
);
380 /**************************************************************************
381 * uninstall_media_player_observer (private)
382 **************************************************************************/
384 uninstall_media_player_observer(libvlc_media_list_player_t
* p_mlp
)
386 assert_locked(p_mlp
);
387 if (!p_mlp
->p_mi
) return;
389 // From now on, media_player callback won't be relevant.
390 p_mlp
->are_mp_callback_cancelled
= true;
392 // Allow callbacks to run, because detach() will wait until all callbacks are processed.
393 // This is safe because only callbacks are allowed, and there execution will be cancelled.
394 vlc_mutex_unlock(&p_mlp
->mp_callback_lock
);
395 libvlc_event_detach(mplayer_em(p_mlp
), libvlc_MediaPlayerEndReached
, media_player_reached_end
, p_mlp
);
397 // Now, lock back the callback lock. No more callback will be present from this point.
398 vlc_mutex_lock(&p_mlp
->mp_callback_lock
);
399 p_mlp
->are_mp_callback_cancelled
= false;
401 // What is here is safe, because we guarantee that we won't be able to anything concurrently,
402 // - except (cancelled) callbacks - thanks to the object_lock.
405 /**************************************************************************
406 * set_current_playing_item (private)
408 * Playlist lock should be held
409 **************************************************************************/
411 set_current_playing_item(libvlc_media_list_player_t
* p_mlp
, libvlc_media_list_path_t path
)
413 assert_locked(p_mlp
);
415 /* First, save the new path that we are going to play */
416 if (p_mlp
->current_playing_item_path
!= path
)
418 free(p_mlp
->current_playing_item_path
);
419 p_mlp
->current_playing_item_path
= path
;
425 libvlc_media_t
* p_md
;
426 p_md
= libvlc_media_list_item_at_path(p_mlp
->p_mlist
, path
);
430 /* Make sure media_player_reached_end() won't get called */
431 uninstall_media_player_observer(p_mlp
);
433 /* Create a new media_player if there is none */
435 p_mlp
->p_mi
= libvlc_media_player_new_from_media(p_md
);
437 libvlc_media_player_set_media(p_mlp
->p_mi
, p_md
);
439 install_media_player_observer(p_mlp
);
440 libvlc_media_release(p_md
); /* for libvlc_media_list_item_at_index */
444 * Public libvlc functions
447 /**************************************************************************
449 **************************************************************************/
450 libvlc_media_list_player_t
*
451 libvlc_media_list_player_new(libvlc_instance_t
* p_instance
)
453 libvlc_media_list_player_t
* p_mlp
;
454 p_mlp
= calloc( 1, sizeof(libvlc_media_list_player_t
) );
455 if (unlikely(p_mlp
== NULL
))
457 libvlc_printerr("Not enough memory");
461 p_mlp
->p_event_manager
= libvlc_event_manager_new(p_mlp
, p_instance
);
462 if (unlikely(p_mlp
->p_event_manager
== NULL
))
468 libvlc_retain(p_instance
);
469 p_mlp
->p_libvlc_instance
= p_instance
;
470 p_mlp
->i_refcount
= 1;
471 vlc_mutex_init(&p_mlp
->object_lock
);
472 vlc_mutex_init(&p_mlp
->mp_callback_lock
);
473 libvlc_event_manager_register_event_type( p_mlp
->p_event_manager
,
474 libvlc_MediaListPlayerNextItemSet
);
475 libvlc_event_manager_register_event_type( p_mlp
->p_event_manager
,
476 libvlc_MediaListPlayerStopped
);
477 p_mlp
->e_playback_mode
= libvlc_playback_mode_default
;
482 /**************************************************************************
484 **************************************************************************/
485 void libvlc_media_list_player_release(libvlc_media_list_player_t
* p_mlp
)
492 if (p_mlp
->i_refcount
> 0)
498 assert(p_mlp
->i_refcount
== 0);
500 /* Keep the lock(), because the uninstall functions
501 * check for it. That's convenient. */
505 uninstall_media_player_observer(p_mlp
);
506 libvlc_media_player_release(p_mlp
->p_mi
);
510 uninstall_playlist_observer(p_mlp
);
511 libvlc_media_list_release(p_mlp
->p_mlist
);
515 vlc_mutex_destroy(&p_mlp
->object_lock
);
516 vlc_mutex_destroy(&p_mlp
->mp_callback_lock
);
518 libvlc_event_manager_release(p_mlp
->p_event_manager
);
520 free(p_mlp
->current_playing_item_path
);
521 libvlc_release(p_mlp
->p_libvlc_instance
);
525 /**************************************************************************
527 **************************************************************************/
528 void libvlc_media_list_player_retain(libvlc_media_list_player_t
* p_mlp
)
538 /**************************************************************************
539 * event_manager (Public)
540 **************************************************************************/
541 libvlc_event_manager_t
*
542 libvlc_media_list_player_event_manager(libvlc_media_list_player_t
* p_mlp
)
544 return p_mlp
->p_event_manager
;
547 /**************************************************************************
548 * set_media_player (Public)
549 **************************************************************************/
550 void libvlc_media_list_player_set_media_player(libvlc_media_list_player_t
* p_mlp
, libvlc_media_player_t
* p_mi
)
556 uninstall_media_player_observer(p_mlp
);
557 libvlc_media_player_release(p_mlp
->p_mi
);
559 libvlc_media_player_retain(p_mi
);
562 install_media_player_observer(p_mlp
);
567 /**************************************************************************
568 * set_media_list (Public)
569 **************************************************************************/
570 void libvlc_media_list_player_set_media_list(libvlc_media_list_player_t
* p_mlp
, libvlc_media_list_t
* p_mlist
)
577 uninstall_playlist_observer(p_mlp
);
578 libvlc_media_list_release(p_mlp
->p_mlist
);
580 libvlc_media_list_retain(p_mlist
);
581 p_mlp
->p_mlist
= p_mlist
;
583 install_playlist_observer(p_mlp
);
588 /**************************************************************************
590 **************************************************************************/
591 void libvlc_media_list_player_play(libvlc_media_list_player_t
* p_mlp
)
594 if (!p_mlp
->current_playing_item_path
)
596 set_relative_playlist_position_and_play(p_mlp
, 1);
598 return; /* Will set to play */
600 libvlc_media_player_play(p_mlp
->p_mi
);
605 /**************************************************************************
607 **************************************************************************/
608 void libvlc_media_list_player_pause(libvlc_media_list_player_t
* p_mlp
)
616 libvlc_media_player_pause(p_mlp
->p_mi
);
620 /**************************************************************************
621 * is_playing (Public)
622 **************************************************************************/
624 libvlc_media_list_player_is_playing(libvlc_media_list_player_t
* p_mlp
)
628 return libvlc_NothingSpecial
;
630 libvlc_state_t state
= libvlc_media_player_get_state(p_mlp
->p_mi
);
631 return (state
== libvlc_Opening
) || (state
== libvlc_Buffering
) ||
632 (state
== libvlc_Playing
);
635 /**************************************************************************
637 **************************************************************************/
639 libvlc_media_list_player_get_state(libvlc_media_list_player_t
* p_mlp
)
643 return libvlc_media_player_get_state(p_mlp
->p_mi
);
646 /**************************************************************************
647 * Play item at index (Public)
648 **************************************************************************/
649 int libvlc_media_list_player_play_item_at_index(libvlc_media_list_player_t
* p_mlp
, int i_index
)
652 libvlc_media_list_path_t path
= libvlc_media_list_path_with_root_index(i_index
);
653 set_current_playing_item(p_mlp
, path
);
654 libvlc_media_player_play(p_mlp
->p_mi
);
657 /* Send the next item event */
658 libvlc_event_t event
;
659 event
.type
= libvlc_MediaListPlayerNextItemSet
;
660 libvlc_media_t
* p_md
= libvlc_media_list_item_at_path(p_mlp
->p_mlist
, path
);
661 event
.u
.media_list_player_next_item_set
.item
= p_md
;
662 libvlc_event_send(p_mlp
->p_event_manager
, &event
);
663 libvlc_media_release(p_md
);
667 /**************************************************************************
669 **************************************************************************/
670 int libvlc_media_list_player_play_item(libvlc_media_list_player_t
* p_mlp
, libvlc_media_t
* p_md
)
673 libvlc_media_list_path_t path
= libvlc_media_list_path_of_item(p_mlp
->p_mlist
, p_md
);
676 libvlc_printerr("Item not found in media list");
681 set_current_playing_item(p_mlp
, path
);
682 libvlc_media_player_play(p_mlp
->p_mi
);
687 /**************************************************************************
691 **************************************************************************/
692 static void stop(libvlc_media_list_player_t
* p_mlp
)
694 assert_locked(p_mlp
);
698 /* We are not interested in getting media stop event now */
699 uninstall_media_player_observer(p_mlp
);
700 libvlc_media_player_stop(p_mlp
->p_mi
);
701 install_media_player_observer(p_mlp
);
704 free(p_mlp
->current_playing_item_path
);
705 p_mlp
->current_playing_item_path
= NULL
;
708 libvlc_event_t event
;
709 event
.type
= libvlc_MediaListPlayerStopped
;
710 libvlc_event_send(p_mlp
->p_event_manager
, &event
);
713 /**************************************************************************
715 **************************************************************************/
716 void libvlc_media_list_player_stop(libvlc_media_list_player_t
* p_mlp
)
723 /**************************************************************************
724 * Set relative playlist position and play (Private)
726 * Sets the currently played item to the given relative play item position
727 * (based on the currently playing item) and then begins the new item playback.
729 **************************************************************************/
730 static int set_relative_playlist_position_and_play(
731 libvlc_media_list_player_t
* p_mlp
,
732 int i_relative_position
)
734 assert_locked(p_mlp
);
738 libvlc_printerr("No media list");
742 libvlc_media_list_lock(p_mlp
->p_mlist
);
744 libvlc_media_list_path_t path
= p_mlp
->current_playing_item_path
;
746 if(p_mlp
->e_playback_mode
!= libvlc_playback_mode_repeat
)
748 bool b_loop
= (p_mlp
->e_playback_mode
== libvlc_playback_mode_loop
);
750 if(i_relative_position
> 0)
754 path
= get_next_path(p_mlp
, b_loop
);
755 set_current_playing_item(p_mlp
, path
);
756 --i_relative_position
;
758 while(i_relative_position
> 0);
760 else if(i_relative_position
< 0)
764 path
= get_previous_path(p_mlp
, b_loop
);
765 set_current_playing_item(p_mlp
, path
);
766 ++i_relative_position
;
768 while (i_relative_position
< 0);
773 set_current_playing_item(p_mlp
, path
);
776 #ifdef DEBUG_MEDIA_LIST_PLAYER
778 libvlc_media_list_path_dump(path
);
783 libvlc_media_list_unlock(p_mlp
->p_mlist
);
787 libvlc_media_player_play(p_mlp
->p_mi
);
789 libvlc_media_list_unlock(p_mlp
->p_mlist
);
791 /* Send the next item event */
792 libvlc_event_t event
;
793 event
.type
= libvlc_MediaListPlayerNextItemSet
;
794 libvlc_media_t
* p_md
= libvlc_media_list_item_at_path(p_mlp
->p_mlist
, path
);
795 event
.u
.media_list_player_next_item_set
.item
= p_md
;
796 libvlc_event_send(p_mlp
->p_event_manager
, &event
);
797 libvlc_media_release(p_md
);
801 /**************************************************************************
803 **************************************************************************/
804 int libvlc_media_list_player_next(libvlc_media_list_player_t
* p_mlp
)
807 int failure
= set_relative_playlist_position_and_play(p_mlp
, 1);
812 /**************************************************************************
814 **************************************************************************/
815 int libvlc_media_list_player_previous(libvlc_media_list_player_t
* p_mlp
)
818 int failure
= set_relative_playlist_position_and_play(p_mlp
, -1);
823 /**************************************************************************
824 * Set Playback Mode (Public)
825 **************************************************************************/
826 void libvlc_media_list_player_set_playback_mode(
827 libvlc_media_list_player_t
* p_mlp
,
828 libvlc_playback_mode_t e_mode
)
831 p_mlp
->e_playback_mode
= e_mode
;