git.sesse.net Git - vlc/blob - src/playlist/control.c

   1 /*****************************************************************************
   2  * control.c : Handle control of the playlist & running through it
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_common.h>
  29 #include "vlc_playlist.h"
  30 #include "playlist_internal.h"
  31 #include <assert.h>
  32
  33 /*****************************************************************************
  34  * Local prototypes
  35  *****************************************************************************/
  36 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args );
  37
  38 static void PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
  39
  40 /*****************************************************************************
  41  * Playlist control
  42  *****************************************************************************/
  43
  44 playlist_t *__pl_Yield( vlc_object_t *p_this )
  45 {
  46     playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
  47     assert( pl != NULL );
  48     vlc_object_yield( pl );
  49     return pl;
  50 }
  51
  52 void __pl_Release( vlc_object_t *p_this )
  53 {
  54     playlist_t *pl = libvlc_priv (p_this->p_libvlc)->p_playlist;
  55     assert( pl != NULL );
  56     vlc_object_release( pl );
  57 }
  58
  59 int playlist_Control( playlist_t * p_playlist, int i_query,
  60                       bool b_locked, ... )
  61 {
  62     va_list args;
  63     int i_result;
  64     va_start( args, b_locked );
  65     if( !b_locked ) PL_LOCK;
  66     i_result = PlaylistVAControl( p_playlist, i_query, args );
  67     va_end( args );
  68     if( !b_locked ) PL_UNLOCK;
  69
  70     return i_result;
  71 }
  72
  73 static int PlaylistVAControl( playlist_t * p_playlist, int i_query, va_list args )
  74 {
  75     playlist_item_t *p_item, *p_node;
  76     vlc_value_t val;
  77
  78     if( playlist_IsEmpty( p_playlist ) )
  79         return VLC_EGENERIC;
  80
  81     switch( i_query )
  82     {
  83     case PLAYLIST_STOP:
  84         p_playlist->request.i_status = PLAYLIST_STOPPED;
  85         p_playlist->request.b_request = true;
  86         p_playlist->request.p_item = NULL;
  87         break;
  88
  89     // Node can be null, it will keep the same. Use with care ...
  90     // Item null = take the first child of node
  91     case PLAYLIST_VIEWPLAY:
  92         p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
  93         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
  94         if ( p_node == NULL )
  95         {
  96             p_node = p_playlist->status.p_node;
  97             assert( p_node );
  98         }
  99         p_playlist->request.i_status = PLAYLIST_RUNNING;
 100         p_playlist->request.i_skip = 0;
 101         p_playlist->request.b_request = true;
 102         p_playlist->request.p_node = p_node;
 103         p_playlist->request.p_item = p_item;
 104         if( p_item && var_GetBool( p_playlist, "random" ) )
 105             p_playlist->b_reset_currently_playing = true;
 106         break;
 107
 108     case PLAYLIST_PLAY:
 109         if( p_playlist->p_input )
 110         {
 111             val.i_int = PLAYING_S;
 112             var_Set( p_playlist->p_input, "state", val );
 113             break;
 114         }
 115         else
 116         {
 117             p_playlist->request.i_status = PLAYLIST_RUNNING;
 118             p_playlist->request.b_request = true;
 119             p_playlist->request.p_node = p_playlist->status.p_node;
 120             p_playlist->request.p_item = p_playlist->status.p_item;
 121             p_playlist->request.i_skip = 0;
 122         }
 123         break;
 124
 125     case PLAYLIST_PAUSE:
 126         val.i_int = 0;
 127         if( p_playlist->p_input )
 128             var_Get( p_playlist->p_input, "state", &val );
 129
 130         if( val.i_int == PAUSE_S )
 131         {
 132             p_playlist->status.i_status = PLAYLIST_RUNNING;
 133             if( p_playlist->p_input )
 134             {
 135                 val.i_int = PLAYING_S;
 136                 var_Set( p_playlist->p_input, "state", val );
 137             }
 138         }
 139         else
 140         {
 141             p_playlist->status.i_status = PLAYLIST_PAUSED;
 142             if( p_playlist->p_input )
 143             {
 144                 val.i_int = PAUSE_S;
 145                 var_Set( p_playlist->p_input, "state", val );
 146             }
 147         }
 148         break;
 149
 150     case PLAYLIST_SKIP:
 151         p_playlist->request.p_node = p_playlist->status.p_node;
 152         p_playlist->request.p_item = p_playlist->status.p_item;
 153         p_playlist->request.i_skip = (int) va_arg( args, int );
 154         /* if already running, keep running */
 155         if( p_playlist->status.i_status != PLAYLIST_STOPPED )
 156             p_playlist->request.i_status = p_playlist->status.i_status;
 157         p_playlist->request.b_request = true;
 158         break;
 159
 160     default:
 161         msg_Err( p_playlist, "unknown playlist query" );
 162         return VLC_EBADVAR;
 163         break;
 164     }
 165     vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
 166
 167     return VLC_SUCCESS;
 168 }
 169
 170 /*****************************************************************************
 171  * Preparse control
 172  *****************************************************************************/
 173 /** Enqueue an item for preparsing */
 174 int playlist_PreparseEnqueue( playlist_t *p_playlist,
 175                               input_item_t *p_item )
 176 {
 177     vlc_object_lock( p_playlist->p_preparse );
 178     vlc_gc_incref( p_item );
 179     INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 180                  p_playlist->p_preparse->i_waiting,
 181                  p_playlist->p_preparse->i_waiting,
 182                  p_item );
 183     vlc_object_signal_unlocked( p_playlist->p_preparse );
 184     vlc_object_unlock( p_playlist->p_preparse );
 185     return VLC_SUCCESS;
 186 }
 187
 188 /** Enqueue a playlist item or a node for peparsing.
 189  *  This function should be entered without playlist and preparser locks */
 190 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
 191                                   playlist_item_t *p_item )
 192 {
 193     vlc_object_lock( p_playlist );
 194     vlc_object_lock( p_playlist->p_preparse );
 195     PreparseEnqueueItemSub( p_playlist, p_item );
 196     vlc_object_unlock( p_playlist->p_preparse );
 197     vlc_object_unlock( p_playlist );
 198     return VLC_SUCCESS;
 199 }
 200
 201 int playlist_AskForArtEnqueue( playlist_t *p_playlist,
 202                                input_item_t *p_item )
 203 {
 204     int i;
 205
 206     vlc_object_lock( p_playlist->p_fetcher );
 207     for( i = 0; i < p_playlist->p_fetcher->i_waiting ; i++ );
 208     vlc_gc_incref( p_item );
 209     INSERT_ELEM( p_playlist->p_fetcher->pp_waiting,
 210                  p_playlist->p_fetcher->i_waiting,
 211                  i, p_item );
 212     vlc_object_signal_unlocked( p_playlist->p_fetcher );
 213     vlc_object_unlock( p_playlist->p_fetcher );
 214     return VLC_SUCCESS;
 215 }
 216
 217 static void PreparseEnqueueItemSub( playlist_t *p_playlist,
 218                                     playlist_item_t *p_item )
 219 {
 220     int i;
 221     if( p_item->i_children == -1 )
 222     {
 223         vlc_gc_incref( p_item );
 224         INSERT_ELEM( p_playlist->p_preparse->pp_waiting,
 225                      p_playlist->p_preparse->i_waiting,
 226                      p_playlist->p_preparse->i_waiting,
 227                      p_item->p_input );
 228     }
 229     else
 230     {
 231         for( i = 0; i < p_item->i_children; i++)
 232         {
 233             PreparseEnqueueItemSub( p_playlist, p_item->pp_children[i] );
 234         }
 235     }
 236 }
 237
 238 /*****************************************************************************
 239  * Playback logic
 240  *****************************************************************************/
 241
 242 /**
 243  * Synchronise the current index of the playlist
 244  * to match the index of the current item.
 245  *
 246  * \param p_playlist the playlist structure
 247  * \param p_cur the current playlist item
 248  * \return nothing
 249  */
 250 static void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur )
 251 {
 252      PL_DEBUG( "resyncing on %s", PLI_NAME( p_cur ) );
 253      /* Simply resync index */
 254      int i;
 255      p_playlist->i_current_index = -1;
 256      for( i = 0 ; i< p_playlist->current.i_size; i++ )
 257      {
 258           if( ARRAY_VAL( p_playlist->current, i ) == p_cur )
 259           {
 260               p_playlist->i_current_index = i;
 261               break;
 262           }
 263      }
 264      PL_DEBUG( "%s is at %i", PLI_NAME( p_cur ), p_playlist->i_current_index );
 265 }
 266
 267 void ResetCurrentlyPlaying( playlist_t *p_playlist, bool b_random,
 268                             playlist_item_t *p_cur )
 269 {
 270     playlist_item_t *p_next = NULL;
 271     stats_TimerStart( p_playlist, "Items array build",
 272                       STATS_TIMER_PLAYLIST_BUILD );
 273     PL_DEBUG( "rebuilding array of current - root %s",
 274               PLI_NAME( p_playlist->status.p_node ) );
 275     ARRAY_RESET( p_playlist->current );
 276     p_playlist->i_current_index = -1;
 277     while( 1 )
 278     {
 279         /** FIXME: this is *slow* */
 280         p_next = playlist_GetNextLeaf( p_playlist,
 281                                        p_playlist->status.p_node,
 282                                        p_next, true, false );
 283         if( p_next )
 284         {
 285             if( p_next == p_cur )
 286                 p_playlist->i_current_index = p_playlist->current.i_size;
 287             ARRAY_APPEND( p_playlist->current, p_next);
 288         }
 289         else break;
 290     }
 291     PL_DEBUG("rebuild done - %i items, index %i", p_playlist->current.i_size,
 292                                                   p_playlist->i_current_index);
 293     if( b_random )
 294     {
 295         /* Shuffle the array */
 296         srand( (unsigned int)mdate() );
 297         int j;
 298         for( j = p_playlist->current.i_size - 1; j > 0; j-- )
 299         {
 300             int i = rand() % (j+1); /* between 0 and j */
 301             playlist_item_t *p_tmp;
 302             /* swap the two items */
 303             p_tmp = ARRAY_VAL(p_playlist->current, i);
 304             ARRAY_VAL(p_playlist->current,i) = ARRAY_VAL(p_playlist->current,j);
 305             ARRAY_VAL(p_playlist->current,j) = p_tmp;
 306         }
 307     }
 308     p_playlist->b_reset_currently_playing = false;
 309     stats_TimerStop( p_playlist, STATS_TIMER_PLAYLIST_BUILD );
 310 }
 311
 312 /**
 313  * Compute the next playlist item depending on
 314  * the playlist course mode (forward, backward, random, view,...).
 315  *
 316  * \param p_playlist the playlist object
 317  * \return nothing
 318  */
 319 playlist_item_t * playlist_NextItem( playlist_t *p_playlist )
 320 {
 321     playlist_item_t *p_new = NULL;
 322     int i_skip = 0, i;
 323
 324     bool b_loop = var_GetBool( p_playlist, "loop" );
 325     bool b_random = var_GetBool( p_playlist, "random" );
 326     bool b_repeat = var_GetBool( p_playlist, "repeat" );
 327     bool b_playstop = var_GetBool( p_playlist, "play-and-stop" );
 328
 329     /* Handle quickly a few special cases */
 330     /* No items to play */
 331     if( p_playlist->items.i_size == 0 )
 332     {
 333         msg_Info( p_playlist, "playlist is empty" );
 334         return NULL;
 335     }
 336
 337     /* Repeat and play/stop */
 338     if( !p_playlist->request.b_request && b_repeat == true &&
 339          p_playlist->status.p_item )
 340     {
 341         msg_Dbg( p_playlist,"repeating item" );
 342         return p_playlist->status.p_item;
 343     }
 344     if( !p_playlist->request.b_request && b_playstop == true )
 345     {
 346         msg_Dbg( p_playlist,"stopping (play and stop)" );
 347         return NULL;
 348     }
 349
 350     if( !p_playlist->request.b_request && p_playlist->status.p_item )
 351     {
 352         playlist_item_t *p_parent = p_playlist->status.p_item;
 353         while( p_parent )
 354         {
 355             if( p_parent->i_flags & PLAYLIST_SKIP_FLAG )
 356             {
 357                 msg_Dbg( p_playlist, "blocking item, stopping") ;
 358                 return NULL;
 359             }
 360             p_parent = p_parent->p_parent;
 361         }
 362     }
 363
 364     /* Start the real work */
 365     if( p_playlist->request.b_request )
 366     {
 367         p_new = p_playlist->request.p_item;
 368         i_skip = p_playlist->request.i_skip;
 369         PL_DEBUG( "processing request item %s node %s skip %i",
 370                         PLI_NAME( p_playlist->request.p_item ),
 371                         PLI_NAME( p_playlist->request.p_node ), i_skip );
 372
 373         if( p_playlist->request.p_node &&
 374             p_playlist->request.p_node != p_playlist->status.p_node )
 375         {
 376             p_playlist->status.p_node = p_playlist->request.p_node;
 377             p_playlist->b_reset_currently_playing = true;
 378         }
 379
 380         /* If we are asked for a node, don't take it */
 381         if( i_skip == 0 && ( p_new == NULL || p_new->i_children != -1 ) )
 382             i_skip++;
 383
 384         if( p_playlist->b_reset_currently_playing )
 385             /* A bit too bad to reset twice ... */
 386             ResetCurrentlyPlaying( p_playlist, b_random, p_new );
 387         else if( p_new )
 388             ResyncCurrentIndex( p_playlist, p_new );
 389         else
 390             p_playlist->i_current_index = -1;
 391
 392         if( p_playlist->current.i_size && (i_skip > 0) )
 393         {
 394             if( p_playlist->i_current_index < -1 )
 395                 p_playlist->i_current_index = -1;
 396             for( i = i_skip; i > 0 ; i-- )
 397             {
 398                 p_playlist->i_current_index++;
 399                 if( p_playlist->i_current_index >= p_playlist->current.i_size )
 400                 {
 401                     PL_DEBUG( "looping - restarting at beginning of node" );
 402                     p_playlist->i_current_index = 0;
 403                 }
 404             }
 405             p_new = ARRAY_VAL( p_playlist->current,
 406                                p_playlist->i_current_index );
 407         }
 408         else if( p_playlist->current.i_size && (i_skip < 0) )
 409         {
 410             for( i = i_skip; i < 0 ; i++ )
 411             {
 412                 p_playlist->i_current_index--;
 413                 if( p_playlist->i_current_index <= -1 )
 414                 {
 415                     PL_DEBUG( "looping - restarting at end of node" );
 416                     p_playlist->i_current_index = p_playlist->current.i_size-1;
 417                 }
 418             }
 419             p_new = ARRAY_VAL( p_playlist->current,
 420                                p_playlist->i_current_index );
 421         }
 422         /* Clear the request */
 423         p_playlist->request.b_request = false;
 424     }
 425     /* "Automatic" item change ( next ) */
 426     else
 427     {
 428         PL_DEBUG( "changing item without a request (current %i/%i)",
 429                   p_playlist->i_current_index, p_playlist->current.i_size );
 430         /* Cant go to next from current item */
 431         if( p_playlist->status.p_item &&
 432             p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG )
 433             return NULL;
 434
 435         if( p_playlist->b_reset_currently_playing )
 436             ResetCurrentlyPlaying( p_playlist, b_random,
 437                                    p_playlist->status.p_item );
 438
 439         p_playlist->i_current_index++;
 440         assert( p_playlist->i_current_index <= p_playlist->current.i_size );
 441         if( p_playlist->i_current_index == p_playlist->current.i_size )
 442         {
 443             if( !b_loop || p_playlist->current.i_size == 0 ) return NULL;
 444             p_playlist->i_current_index = 0;
 445         }
 446         PL_DEBUG( "using item %i", p_playlist->i_current_index );
 447         if ( p_playlist->current.i_size == 0 ) return NULL;
 448
 449         p_new = ARRAY_VAL( p_playlist->current, p_playlist->i_current_index );
 450         /* The new item can't be autoselected  */
 451         if( p_new != NULL && p_new->i_flags & PLAYLIST_SKIP_FLAG )
 452             return NULL;
 453     }
 454     return p_new;
 455 }
 456
 457 /**
 458  * Start the input for an item
 459  *
 460  * \param p_playlist the playlist objetc
 461  * \param p_item the item to play
 462  * \return nothing
 463  */
 464 int playlist_PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
 465 {
 466     input_item_t *p_input = p_item->p_input;
 467     sout_instance_t **pp_sout = &libvlc_priv(p_playlist->p_libvlc)->p_sout;
 468     int i_activity = var_GetInteger( p_playlist, "activity" ) ;
 469
 470     msg_Dbg( p_playlist, "creating new input thread" );
 471
 472     p_input->i_nb_played++;
 473     p_playlist->status.p_item = p_item;
 474
 475     p_playlist->status.i_status = PLAYLIST_RUNNING;
 476
 477     var_SetInteger( p_playlist, "activity", i_activity +
 478                     DEFAULT_INPUT_ACTIVITY );
 479
 480     input_thread_t * p_input_thread =
 481         input_CreateThreadExtended( p_playlist, p_input, NULL, *pp_sout );
 482     playlist_set_current_input( p_playlist, p_input_thread );
 483     vlc_object_release( p_input_thread );
 484
 485     *pp_sout = NULL;
 486
 487     char *psz_uri = input_item_GetURI( p_item->p_input );
 488     if( psz_uri && ( !strncmp( psz_uri, "directory:", 10 ) ||
 489                      !strncmp( psz_uri, "vlc:", 4 ) ) )
 490     {
 491         free( psz_uri );
 492         return VLC_SUCCESS;
 493     }
 494     free( psz_uri );
 495
 496     if( p_playlist->p_fetcher &&
 497             p_playlist->p_fetcher->i_art_policy == ALBUM_ART_WHEN_PLAYED )
 498     {
 499         bool b_has_art;
 500
 501         char *psz_arturl, *psz_name;
 502         psz_arturl = input_item_GetArtURL( p_input );
 503         psz_name = input_item_GetName( p_input );
 504
 505         /* p_input->p_meta should not be null after a successfull CreateThread */
 506         b_has_art = !EMPTY_STR( psz_arturl );
 507
 508         if( !b_has_art || strncmp( psz_arturl, "attachment://", 13 ) )
 509         {
 510             PL_DEBUG( "requesting art for %s", psz_name );
 511             playlist_AskForArtEnqueue( p_playlist, p_input );
 512         }
 513         free( psz_arturl );
 514         free( psz_name );
 515     }
 516
 517     PL_UNLOCK;
 518     var_SetInteger( p_playlist, "playlist-current", p_input->i_id );
 519     PL_LOCK;
 520
 521     return VLC_SUCCESS;
 522 }