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