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         if( !libvlc_media_list_count( p_mlp->p_mlist, NULL ) )
  47             return NULL;
  48         return libvlc_media_list_path_with_root_index(0);
  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 depth = libvlc_media_list_path_depth( p_mlp->current_playing_item_path );
  68     if( depth < 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[depth-1] >= libvlc_media_list_count( p_parent_of_playing_item, NULL ) )
  74     {
  75         depth--;
  76         if( depth <= 0 )
  77         {
  78             free( ret );
  79             libvlc_media_list_release( p_parent_of_playing_item );
  80             return NULL;
  81         }
  82         ret[depth] = -1;
  83         ret[depth-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     if( p_mlp->current_playing_item_path != path )
 214     {
 215         free( p_mlp->current_playing_item_path );
 216         p_mlp->current_playing_item_path = path;
 217     }
 218
 219     if( !p_md )
 220     {
 221         vlc_mutex_unlock( &p_mlp->object_lock );
 222         return;
 223     }
 224
 225     /* We are not interested in getting media stop event now */
 226     uninstall_media_player_observer( p_mlp );
 227
 228     if ( !p_mlp->p_mi )
 229     {
 230         p_mlp->p_mi = libvlc_media_player_new_from_media(p_md, p_e);
 231     }
 232
 233     if( p_md->p_subitems && libvlc_media_list_count( p_md->p_subitems, NULL ) > 0 )
 234     {
 235         libvlc_media_t * p_submd;
 236         p_submd = libvlc_media_list_item_at_index( p_md->p_subitems, 0, NULL );
 237         libvlc_media_player_set_media( p_mlp->p_mi, p_submd, NULL );
 238         libvlc_media_release( p_submd );
 239     }
 240     else
 241         libvlc_media_player_set_media( p_mlp->p_mi, p_md, NULL );
 242 //    wait_playing_state(); /* If we want to be synchronous */
 243     install_media_player_observer( p_mlp );
 244
 245     vlc_mutex_unlock( &p_mlp->object_lock );
 246
 247     libvlc_media_release( p_md ); /* for libvlc_media_list_item_at_index */
 248 }
 249
 250 /*
 251  * Public libvlc functions
 252  */
 253
 254 /**************************************************************************
 255  *         new (Public)
 256  **************************************************************************/
 257 libvlc_media_list_player_t *
 258 libvlc_media_list_player_new( libvlc_instance_t * p_instance,
 259                               libvlc_exception_t * p_e )
 260 {
 261     (void)p_e;
 262     libvlc_media_list_player_t * p_mlp;
 263     p_mlp = malloc(sizeof(libvlc_media_list_player_t));
 264     if( !p_mlp )
 265         return NULL;
 266
 267     p_mlp->current_playing_item_path = NULL;
 268     p_mlp->p_mi = NULL;
 269     p_mlp->p_mlist = NULL;
 270     vlc_mutex_init( &p_mlp->object_lock );
 271     p_mlp->p_event_manager = libvlc_event_manager_new( p_mlp,
 272                                                        p_instance,
 273                                                        p_e );
 274     libvlc_event_manager_register_event_type( p_mlp->p_event_manager,
 275             libvlc_MediaListPlayerNextItemSet, p_e );
 276
 277     return p_mlp;
 278 }
 279
 280 /**************************************************************************
 281  *         release (Public)
 282  **************************************************************************/
 283 void libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp )
 284 {
 285     if( !p_mlp )
 286         return;
 287
 288     vlc_mutex_lock( &p_mlp->object_lock );
 289
 290     p_mlp->i_refcount--;
 291     if( p_mlp->i_refcount > 0 )
 292     {
 293         vlc_mutex_unlock( &p_mlp->object_lock );
 294         return;
 295     }
 296     vlc_mutex_unlock( &p_mlp->object_lock );
 297     vlc_mutex_destroy( &p_mlp->object_lock );
 298
 299     libvlc_event_manager_release( p_mlp->p_event_manager );
 300     libvlc_media_player_release( p_mlp->p_mi );
 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
 308     free( p_mlp->current_playing_item_path );
 309     free( p_mlp );
 310 }
 311
 312 /**************************************************************************
 313  *        set_media_player (Public)
 314  **************************************************************************/
 315 void libvlc_media_list_player_set_media_player(
 316                                      libvlc_media_list_player_t * p_mlp,
 317                                      libvlc_media_player_t * p_mi,
 318                                      libvlc_exception_t * p_e )
 319 {
 320     VLC_UNUSED(p_e);
 321
 322     vlc_mutex_lock( &p_mlp->object_lock );
 323
 324     if( p_mlp->p_mi )
 325     {
 326         uninstall_media_player_observer( p_mlp );
 327         libvlc_media_player_release( p_mlp->p_mi );
 328     }
 329     libvlc_media_player_retain( p_mi );
 330     p_mlp->p_mi = p_mi;
 331
 332     install_media_player_observer( p_mlp );
 333
 334     vlc_mutex_unlock( &p_mlp->object_lock );
 335 }
 336
 337 /**************************************************************************
 338  *       set_media_list (Public)
 339  **************************************************************************/
 340 void libvlc_media_list_player_set_media_list(
 341                                      libvlc_media_list_player_t * p_mlp,
 342                                      libvlc_media_list_t * p_mlist,
 343                                      libvlc_exception_t * p_e )
 344 {
 345     vlc_mutex_lock( &p_mlp->object_lock );
 346
 347     if( libvlc_media_list_player_is_playing( p_mlp, p_e ) )
 348     {
 349         libvlc_media_player_stop( p_mlp->p_mi, p_e );
 350         /* Don't bother if there was an error. */
 351         libvlc_exception_clear( p_e );
 352     }
 353
 354     if( p_mlp->p_mlist )
 355     {
 356         uninstall_playlist_observer( p_mlp );
 357         libvlc_media_list_release( p_mlp->p_mlist );
 358     }
 359     libvlc_media_list_retain( p_mlist );
 360     p_mlp->p_mlist = p_mlist;
 361
 362     install_playlist_observer( p_mlp );
 363
 364     vlc_mutex_unlock( &p_mlp->object_lock );
 365 }
 366
 367 /**************************************************************************
 368  *        Play (Public)
 369  **************************************************************************/
 370 void libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
 371                                   libvlc_exception_t * p_e )
 372 {
 373     if( !p_mlp->current_playing_item_path )
 374     {
 375         libvlc_media_list_player_next( p_mlp, p_e );
 376         return; /* Will set to play */
 377     }
 378
 379     libvlc_media_player_play( p_mlp->p_mi, p_e );
 380 }
 381
 382
 383 /**************************************************************************
 384  *        Pause (Public)
 385  **************************************************************************/
 386 void libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
 387                                      libvlc_exception_t * p_e )
 388 {
 389     if( !p_mlp->p_mi )
 390         return;
 391     libvlc_media_player_pause( p_mlp->p_mi, p_e );
 392 }
 393
 394 /**************************************************************************
 395  *        is_playing (Public)
 396  **************************************************************************/
 397 int
 398 libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
 399                                      libvlc_exception_t * p_e )
 400 {
 401     libvlc_state_t state = libvlc_media_player_get_state( p_mlp->p_mi, p_e );
 402     return (state == libvlc_Opening) || (state == libvlc_Buffering) ||
 403            (state == libvlc_Playing);
 404 }
 405
 406 /**************************************************************************
 407  *        State (Public)
 408  **************************************************************************/
 409 libvlc_state_t
 410 libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
 411                                     libvlc_exception_t * p_e )
 412 {
 413     if( !p_mlp->p_mi )
 414         return libvlc_Ended;
 415     return libvlc_media_player_get_state( p_mlp->p_mi, p_e );
 416 }
 417
 418 /**************************************************************************
 419  *        Play item at index (Public)
 420  **************************************************************************/
 421 void libvlc_media_list_player_play_item_at_index(
 422                         libvlc_media_list_player_t * p_mlp,
 423                         int i_index,
 424                         libvlc_exception_t * p_e )
 425 {
 426     set_current_playing_item( p_mlp, libvlc_media_list_path_with_root_index(i_index), p_e );
 427
 428     if( libvlc_exception_raised( p_e ) )
 429         return;
 430
 431     /* Send the next item event */
 432     libvlc_event_t event;
 433     event.type = libvlc_MediaListPlayerNextItemSet;
 434     libvlc_event_send( p_mlp->p_event_manager, &event );
 435
 436     libvlc_media_player_play( p_mlp->p_mi, p_e );
 437 }
 438
 439 /**************************************************************************
 440  *        Play item (Public)
 441  **************************************************************************/
 442 void libvlc_media_list_player_play_item(
 443                         libvlc_media_list_player_t * p_mlp,
 444                         libvlc_media_t * p_md,
 445                         libvlc_exception_t * p_e )
 446 {
 447     libvlc_media_list_path_t path = libvlc_media_list_path_of_item( p_mlp->p_mlist, p_md );
 448     if( !path )
 449     {
 450         libvlc_exception_raise( p_e, "No such item in media list" );
 451         return;
 452     }
 453     set_current_playing_item( p_mlp, path, p_e );
 454
 455     if( libvlc_exception_raised( p_e ) )
 456         return;
 457
 458     libvlc_media_player_play( p_mlp->p_mi, p_e );
 459 }
 460
 461 /**************************************************************************
 462  *       Stop (Public)
 463  **************************************************************************/
 464 void libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
 465                                     libvlc_exception_t * p_e )
 466 {
 467     if ( p_mlp->p_mi )
 468     {
 469         /* We are not interested in getting media stop event now */
 470         uninstall_media_player_observer( p_mlp );
 471         libvlc_media_player_stop( p_mlp->p_mi, p_e );
 472         install_media_player_observer( p_mlp );
 473     }
 474
 475     vlc_mutex_lock( &p_mlp->object_lock );
 476     free( p_mlp->current_playing_item_path );
 477     p_mlp->current_playing_item_path = NULL;
 478     vlc_mutex_unlock( &p_mlp->object_lock );
 479 }
 480
 481 /**************************************************************************
 482  *       Next (Public)
 483  **************************************************************************/
 484 void libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
 485                                     libvlc_exception_t * p_e )
 486 {
 487     libvlc_media_list_path_t path;
 488
 489     if (! p_mlp->p_mlist )
 490     {
 491         libvlc_exception_raise( p_e, "No more element to play" );
 492         return;
 493     }
 494
 495     libvlc_media_list_lock( p_mlp->p_mlist );
 496
 497     path = get_next_path( p_mlp );
 498
 499     if( !path )
 500     {
 501         libvlc_media_list_unlock( p_mlp->p_mlist );
 502         libvlc_exception_raise( p_e, "No more element to play" );
 503         libvlc_media_list_player_stop( p_mlp, p_e );
 504         return;
 505     }
 506
 507     set_current_playing_item( p_mlp, path, p_e );
 508
 509     libvlc_media_player_play( p_mlp->p_mi, p_e );
 510
 511     libvlc_media_list_unlock( p_mlp->p_mlist );
 512
 513     /* Send the next item event */
 514     libvlc_event_t event;
 515     event.type = libvlc_MediaListPlayerNextItemSet;
 516     libvlc_event_send( p_mlp->p_event_manager, &event);
 517 }