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

   1 /*****************************************************************************
   2  * playlist.c : Playlist management functions
   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 #include <stdlib.h>                                      /* free(), strtol() */
  25 #include <stdio.h>                                              /* sprintf() */
  26 #include <string.h>                                            /* strerror() */
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc/vout.h>
  30 #include <vlc/sout.h>
  31 #include <vlc/input.h>
  32
  33 #include "vlc_playlist.h"
  34
  35 #include "vlc_interaction.h"
  36
  37 #define TITLE_CATEGORY N_( "By category" )
  38 #define TITLE_SIMPLE   N_( "Manually added" )
  39 #define TITLE_ALL      N_( "All items, unsorted" )
  40
  41 #undef PLAYLIST_PROFILE
  42 #undef PLAYLIST_DEBUG
  43
  44 /*****************************************************************************
  45  * Local prototypes
  46  *****************************************************************************/
  47 static void RunThread ( playlist_t * );
  48 static void RunPreparse( playlist_preparse_t * );
  49 static playlist_item_t * NextItem  ( playlist_t * );
  50 static int PlayItem  ( playlist_t *, playlist_item_t * );
  51
  52 int playlist_vaControl( playlist_t * p_playlist, int i_query, va_list args );
  53
  54 void playlist_PreparseEnqueueItemSub( playlist_t *, playlist_item_t * );
  55
  56 playlist_item_t *playlist_RecursiveFindLast(playlist_t *p_playlist,
  57                                             playlist_item_t *p_node );
  58
  59 /*****************************************************************************
  60  * Helper Function for NextItem
  61  *****************************************************************************/
  62
  63 playlist_item_t *playlist_RecursiveFindLast(playlist_t *p_playlist,
  64                                             playlist_item_t *p_node )
  65 {
  66     int i;
  67     playlist_item_t *p_item;
  68     for ( i = p_node->i_children - 1; i >= 0; i-- )
  69     {
  70         if( p_node->pp_children[i]->i_children == -1 )
  71             return p_node->pp_children[i];
  72         else if(p_node->pp_children[i]->i_children > 0)
  73         {
  74              p_item = playlist_RecursiveFindLast( p_playlist,
  75                                         p_node->pp_children[i] );
  76             if ( p_item != NULL )
  77                 return p_item;
  78         }
  79         else if( i == 0 )
  80             return NULL;
  81     }
  82     return NULL;
  83 }
  84
  85
  86 /**
  87  * Create playlist
  88  *
  89  * Create a playlist structure.
  90  * \param p_parent the vlc object that is to be the parent of this playlist
  91  * \return a pointer to the created playlist, or NULL on error
  92  */
  93 playlist_t * __playlist_Create ( vlc_object_t *p_parent )
  94 {
  95     playlist_t *p_playlist;
  96     playlist_view_t *p_view;
  97     vlc_value_t     val;
  98
  99     /* Allocate structure */
 100     p_playlist = vlc_object_create( p_parent, VLC_OBJECT_PLAYLIST );
 101     if( !p_playlist )
 102     {
 103         msg_Err( p_parent, "out of memory" );
 104         return NULL;
 105     }
 106
 107     /* These variables control updates */
 108     var_Create( p_playlist, "intf-change", VLC_VAR_BOOL );
 109     val.b_bool = VLC_TRUE;
 110     var_Set( p_playlist, "intf-change", val );
 111
 112     var_Create( p_playlist, "item-change", VLC_VAR_INTEGER );
 113     val.i_int = -1;
 114     var_Set( p_playlist, "item-change", val );
 115
 116     var_Create( p_playlist, "item-deleted", VLC_VAR_INTEGER );
 117     val.i_int = -1;
 118     var_Set( p_playlist, "item-deleted", val );
 119
 120     var_Create( p_playlist, "item-append", VLC_VAR_ADDRESS );
 121
 122     var_Create( p_playlist, "playlist-current", VLC_VAR_INTEGER );
 123     val.i_int = -1;
 124     var_Set( p_playlist, "playlist-current", val );
 125
 126     var_Create( p_playlist, "intf-popupmenu", VLC_VAR_BOOL );
 127
 128     var_Create( p_playlist, "intf-show", VLC_VAR_BOOL );
 129     val.b_bool = VLC_TRUE;
 130     var_Set( p_playlist, "intf-show", val );
 131
 132
 133     /* Variables to control playback */
 134     var_CreateGetBool( p_playlist, "play-and-stop" );
 135     var_CreateGetBool( p_playlist, "random" );
 136     var_CreateGetBool( p_playlist, "repeat" );
 137     var_CreateGetBool( p_playlist, "loop" );
 138
 139     /* Initialise data structures */
 140     vlc_mutex_init( p_playlist, &p_playlist->gc_lock );
 141     p_playlist->i_last_id = 0;
 142     p_playlist->b_go_next = VLC_TRUE;
 143     p_playlist->p_input = NULL;
 144
 145     p_playlist->request_date = 0;
 146
 147     p_playlist->i_views = 0;
 148     p_playlist->pp_views = NULL;
 149
 150     p_playlist->i_index = -1;
 151     p_playlist->i_size = 0;
 152     p_playlist->pp_items = NULL;
 153     p_playlist->i_all_size = 0;
 154     p_playlist->pp_all_items = 0;
 155
 156     playlist_ViewInsert( p_playlist, VIEW_CATEGORY, TITLE_CATEGORY );
 157     playlist_ViewInsert( p_playlist, VIEW_ALL, TITLE_ALL );
 158
 159     p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
 160
 161     p_playlist->p_general =
 162         playlist_NodeCreate( p_playlist, VIEW_CATEGORY,
 163                              _( "General" ), p_view->p_root );
 164     p_playlist->p_general->i_flags |= PLAYLIST_RO_FLAG;
 165
 166     /* Set startup status
 167      * We set to simple view on startup for interfaces that don't do
 168      * anything */
 169     p_view = playlist_ViewFind( p_playlist, VIEW_CATEGORY );
 170     p_playlist->status.i_view = VIEW_CATEGORY;
 171     p_playlist->status.p_item = NULL;
 172     p_playlist->status.p_node = p_view->p_root;
 173     p_playlist->request.b_request = VLC_FALSE;
 174     p_playlist->status.i_status = PLAYLIST_STOPPED;
 175
 176
 177     p_playlist->i_sort = SORT_ID;
 178     p_playlist->i_order = ORDER_NORMAL;
 179
 180     /* Finally, launch the thread ! */
 181     if( vlc_thread_create( p_playlist, "playlist", RunThread,
 182                            VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
 183     {
 184         msg_Err( p_playlist, "cannot spawn playlist thread" );
 185         vlc_object_destroy( p_playlist );
 186         return NULL;
 187     }
 188
 189     /* Preparsing stuff */
 190     p_playlist->p_preparse = vlc_object_create( p_playlist,
 191                                                 sizeof( playlist_preparse_t ) );
 192     if( !p_playlist->p_preparse )
 193     {
 194         msg_Err( p_playlist, "unable to create preparser" );
 195         vlc_object_destroy( p_playlist );
 196         return NULL;
 197     }
 198
 199     // Preparse
 200     p_playlist->p_preparse->i_waiting = 0;
 201     p_playlist->p_preparse->pi_waiting = NULL;
 202
 203     // Interaction
 204     p_playlist->p_interaction = NULL;
 205
 206     vlc_object_attach( p_playlist->p_preparse, p_playlist );
 207     if( vlc_thread_create( p_playlist->p_preparse, "preparser",
 208                            RunPreparse, VLC_THREAD_PRIORITY_LOW, VLC_TRUE ) )
 209     {
 210         msg_Err( p_playlist, "cannot spawn preparse thread" );
 211         vlc_object_detach( p_playlist->p_preparse );
 212         vlc_object_destroy( p_playlist->p_preparse );
 213         return NULL;
 214     }
 215
 216     /* The object has been initialized, now attach it */
 217     vlc_object_attach( p_playlist, p_parent );
 218
 219     return p_playlist;
 220 }
 221
 222 /**
 223  * Destroy the playlist.
 224  *
 225  * Delete all items in the playlist and free the playlist structure.
 226  * \param p_playlist the playlist structure to destroy
 227  * \return VLC_SUCCESS or an error
 228  */
 229 int playlist_Destroy( playlist_t * p_playlist )
 230 {
 231     int i;
 232     p_playlist->b_die = 1;
 233
 234     while( p_playlist->i_sds )
 235     {
 236         playlist_ServicesDiscoveryRemove( p_playlist,
 237                                           p_playlist->pp_sds[0]->psz_module );
 238     }
 239
 240     if( p_playlist->p_interaction )
 241     {
 242         intf_InteractionDestroy( p_playlist->p_interaction );
 243     }
 244
 245     vlc_thread_join( p_playlist->p_preparse );
 246     vlc_thread_join( p_playlist );
 247
 248     vlc_object_detach( p_playlist->p_preparse );
 249
 250     var_Destroy( p_playlist, "intf-change" );
 251     var_Destroy( p_playlist, "item-change" );
 252     var_Destroy( p_playlist, "playlist-current" );
 253     var_Destroy( p_playlist, "intf-popmenu" );
 254     var_Destroy( p_playlist, "intf-show" );
 255     var_Destroy( p_playlist, "play-and-stop" );
 256     var_Destroy( p_playlist, "random" );
 257     var_Destroy( p_playlist, "repeat" );
 258     var_Destroy( p_playlist, "loop" );
 259
 260     playlist_Clear( p_playlist );
 261
 262     for( i = p_playlist->i_views - 1; i >= 0 ; i-- )
 263     {
 264         playlist_view_t *p_view = p_playlist->pp_views[i];
 265         if( p_view->psz_name )
 266             free( p_view->psz_name );
 267         playlist_ItemDelete( p_view->p_root );
 268         REMOVE_ELEM( p_playlist->pp_views, p_playlist->i_views, i );
 269         free( p_view );
 270     }
 271
 272     vlc_mutex_destroy( &p_playlist->gc_lock );
 273     vlc_object_destroy( p_playlist->p_preparse );
 274     vlc_object_destroy( p_playlist );
 275
 276     return VLC_SUCCESS;
 277 }
 278
 279
 280 /**
 281  * Do a playlist action.
 282  *
 283  * If there is something in the playlist then you can do playlist actions.
 284  *
 285  * Playlist lock must not be taken when calling this function
 286  *
 287  * \param p_playlist the playlist to do the command on
 288  * \param i_query the command to do
 289  * \param variable number of arguments
 290  * \return VLC_SUCCESS or an error
 291  */
 292 int playlist_LockControl( playlist_t * p_playlist, int i_query, ... )
 293 {
 294     va_list args;
 295     int i_result;
 296     va_start( args, i_query );
 297     vlc_mutex_lock( &p_playlist->object_lock );
 298     i_result = playlist_vaControl( p_playlist, i_query, args );
 299     va_end( args );
 300     vlc_mutex_unlock( &p_playlist->object_lock );
 301     return i_result;
 302 }
 303
 304 /**
 305  * Do a playlist action.
 306  *
 307  * If there is something in the playlist then you can do playlist actions.
 308  *
 309  * Playlist lock must be taken when calling this function
 310  *
 311  * \param p_playlist the playlist to do the command on
 312  * \param i_query the command to do
 313  * \param variable number of arguments
 314  * \return VLC_SUCCESS or an error
 315  */
 316 int playlist_Control( playlist_t * p_playlist, int i_query, ... )
 317 {
 318     va_list args;
 319     int i_result;
 320     va_start( args, i_query );
 321     i_result = playlist_vaControl( p_playlist, i_query, args );
 322     va_end( args );
 323
 324     return i_result;
 325 }
 326
 327 int playlist_vaControl( playlist_t * p_playlist, int i_query, va_list args )
 328 {
 329     playlist_view_t *p_view;
 330     playlist_item_t *p_item, *p_node;
 331     int i_view;
 332     vlc_value_t val;
 333
 334 #ifdef PLAYLIST_PROFILE
 335     p_playlist->request_date = mdate();
 336 #endif
 337
 338     if( p_playlist->i_size <= 0 )
 339     {
 340         return VLC_EGENERIC;
 341     }
 342
 343     switch( i_query )
 344     {
 345     case PLAYLIST_STOP:
 346         p_playlist->status.i_status = PLAYLIST_STOPPED;
 347         p_playlist->request.b_request = VLC_TRUE;
 348         p_playlist->request.p_item = NULL;
 349         break;
 350
 351     case PLAYLIST_ITEMPLAY:
 352         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
 353         if ( p_item == NULL || p_item->input.psz_uri == NULL )
 354             return VLC_EGENERIC;
 355         p_playlist->status.i_status = PLAYLIST_RUNNING;
 356         p_playlist->request.i_skip = 0;
 357         p_playlist->request.b_request = VLC_TRUE;
 358         p_playlist->request.p_item = p_item;
 359         p_playlist->request.i_view = p_playlist->status.i_view;
 360         p_view = playlist_ViewFind( p_playlist, p_playlist->status.i_view );
 361         if( p_view )
 362         {
 363             p_playlist->request.p_node = p_view->p_root;
 364         }
 365         else
 366         {
 367             p_playlist->request.p_node = NULL;
 368         }
 369         break;
 370
 371     case PLAYLIST_VIEWPLAY:
 372         i_view = (int)va_arg( args,int );
 373         p_node = (playlist_item_t *)va_arg( args, playlist_item_t * );
 374         p_item = (playlist_item_t *)va_arg( args, playlist_item_t * );
 375         if ( p_node == NULL ) //|| (p_item != NULL && p_item->input.psz_uri
 376                                 //                         == NULL ))
 377         {
 378             p_playlist->status.i_status = PLAYLIST_STOPPED;
 379             p_playlist->request.b_request = VLC_TRUE;
 380             return VLC_SUCCESS;
 381         }
 382         p_playlist->status.i_status = PLAYLIST_RUNNING;
 383         p_playlist->request.i_skip = 0;
 384         p_playlist->request.b_request = VLC_TRUE;
 385         p_playlist->request.i_view = i_view;
 386         p_playlist->request.p_node = p_node;
 387         p_playlist->request.p_item = p_item;
 388
 389         /* Don't go further if the node doesn't want to */
 390         if( ! p_playlist->request.p_node->i_flags & PLAYLIST_SKIP_FLAG )
 391         {
 392             p_playlist->b_go_next = VLC_FALSE;
 393         }
 394         else
 395         {
 396             p_playlist->b_go_next = VLC_TRUE;
 397         }
 398         break;
 399
 400     case PLAYLIST_PLAY:
 401         p_playlist->status.i_status = PLAYLIST_RUNNING;
 402
 403         if( p_playlist->p_input )
 404         {
 405             val.i_int = PLAYING_S;
 406             var_Set( p_playlist->p_input, "state", val );
 407             break;
 408         }
 409
 410         /* FIXME : needed ? */
 411         p_playlist->request.b_request = VLC_TRUE;
 412         p_playlist->request.i_view = p_playlist->status.i_view;
 413         p_playlist->request.p_node = p_playlist->status.p_node;
 414         p_playlist->request.p_item = p_playlist->status.p_item;
 415         p_playlist->request.i_skip = 0;
 416         p_playlist->request.i_goto = -1;
 417         break;
 418
 419     case PLAYLIST_AUTOPLAY:
 420         p_playlist->status.i_status = PLAYLIST_RUNNING;
 421         p_playlist->status.p_node = p_playlist->p_general;
 422
 423         p_playlist->request.b_request = VLC_FALSE;
 424         break;
 425
 426     case PLAYLIST_PAUSE:
 427         val.i_int = 0;
 428         if( p_playlist->p_input )
 429             var_Get( p_playlist->p_input, "state", &val );
 430
 431         if( val.i_int == PAUSE_S )
 432         {
 433             p_playlist->status.i_status = PLAYLIST_RUNNING;
 434             if( p_playlist->p_input )
 435             {
 436                 val.i_int = PLAYING_S;
 437                 var_Set( p_playlist->p_input, "state", val );
 438             }
 439         }
 440         else
 441         {
 442             p_playlist->status.i_status = PLAYLIST_PAUSED;
 443             if( p_playlist->p_input )
 444             {
 445                 val.i_int = PAUSE_S;
 446                 var_Set( p_playlist->p_input, "state", val );
 447             }
 448         }
 449         break;
 450
 451     case PLAYLIST_SKIP:
 452         p_playlist->request.i_view = p_playlist->status.i_view;
 453         if( p_playlist->status.i_view > -1 )
 454         {
 455             p_playlist->request.p_node = p_playlist->status.p_node;
 456             p_playlist->request.p_item = p_playlist->status.p_item;
 457         }
 458         else
 459         {
 460             p_playlist->request.p_node = NULL;
 461             p_playlist->request.p_item = NULL;
 462         }
 463         p_playlist->request.i_skip = (int) va_arg( args, int );
 464         p_playlist->request.b_request = VLC_TRUE;
 465         break;
 466
 467     case PLAYLIST_GOTO:
 468         p_playlist->status.i_status = PLAYLIST_RUNNING;
 469         p_playlist->request.p_node = NULL;
 470         p_playlist->request.p_item = NULL;
 471         p_playlist->request.i_view = -1;
 472         p_playlist->request.i_goto = (int) va_arg( args, int );
 473         p_playlist->request.b_request = VLC_TRUE;
 474         break;
 475
 476     default:
 477         msg_Err( p_playlist, "unknown playlist query" );
 478         return VLC_EBADVAR;
 479         break;
 480     }
 481
 482     return VLC_SUCCESS;
 483 }
 484
 485 int playlist_PreparseEnqueue( playlist_t *p_playlist,
 486                               input_item_t *p_item )
 487 {
 488     vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
 489     INSERT_ELEM( p_playlist->p_preparse->pi_waiting,
 490                  p_playlist->p_preparse->i_waiting,
 491                  p_playlist->p_preparse->i_waiting,
 492                  p_item->i_id );
 493     vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
 494     return VLC_SUCCESS;
 495 }
 496
 497 /* Should only be called if playlist and preparser are locked */
 498 void playlist_PreparseEnqueueItemSub( playlist_t *p_playlist,
 499                                      playlist_item_t *p_item )
 500 {
 501     int i;
 502     if( p_item->i_children == -1 )
 503     {
 504         INSERT_ELEM( p_playlist->p_preparse->pi_waiting,
 505                      p_playlist->p_preparse->i_waiting,
 506                      p_playlist->p_preparse->i_waiting,
 507                      (p_item->input.i_id) );
 508     }
 509     else
 510     {
 511         for( i = 0; i < p_item->i_children; i++)
 512         {
 513             playlist_PreparseEnqueueItemSub( p_playlist,
 514                                              p_item->pp_children[i] );
 515         }
 516     }
 517 }
 518
 519 int playlist_PreparseEnqueueItem( playlist_t *p_playlist,
 520                                   playlist_item_t *p_item )
 521 {
 522     vlc_mutex_lock( &p_playlist->object_lock );
 523     vlc_mutex_lock( &p_playlist->p_preparse->object_lock );
 524     playlist_PreparseEnqueueItemSub( p_playlist, p_item );
 525     vlc_mutex_unlock( &p_playlist->p_preparse->object_lock );
 526     vlc_mutex_unlock( &p_playlist->object_lock );
 527     return VLC_SUCCESS;
 528 }
 529
 530
 531 /* Destroy remaining objects */
 532 static mtime_t ObjectGarbageCollector( playlist_t *p_playlist, int i_type,
 533                                        mtime_t destroy_date )
 534 {
 535     vlc_object_t *p_obj;
 536
 537     if( destroy_date > mdate() ) return destroy_date;
 538
 539     if( destroy_date == 0 )
 540     {
 541         /* give a little time */
 542         return mdate() + I64C(1000000);
 543     }
 544     else
 545     {
 546         vlc_mutex_lock( &p_playlist->gc_lock );
 547         while( ( p_obj = vlc_object_find( p_playlist, i_type, FIND_CHILD ) ) )
 548         {
 549             if( p_obj->p_parent != (vlc_object_t*)p_playlist )
 550             {
 551                 /* only first child (ie unused) */
 552                 vlc_object_release( p_obj );
 553                 break;
 554             }
 555             if( i_type == VLC_OBJECT_VOUT )
 556             {
 557                 msg_Dbg( p_playlist, "garbage collector destroying 1 vout" );
 558                 vlc_object_detach( p_obj );
 559                 vlc_object_release( p_obj );
 560                 vout_Destroy( (vout_thread_t *)p_obj );
 561             }
 562             else if( i_type == VLC_OBJECT_SOUT )
 563             {
 564                 vlc_object_release( p_obj );
 565                 sout_DeleteInstance( (sout_instance_t*)p_obj );
 566             }
 567         }
 568         vlc_mutex_unlock( &p_playlist->gc_lock );
 569         return 0;
 570     }
 571 }
 572
 573 /*****************************************************************************
 574  * RunThread: main playlist thread
 575  *****************************************************************************/
 576 static void RunThread ( playlist_t *p_playlist )
 577 {
 578     vlc_object_t *p_obj;
 579     playlist_item_t *p_item = NULL;
 580
 581     mtime_t    i_vout_destroyed_date = 0;
 582     mtime_t    i_sout_destroyed_date = 0;
 583
 584     int i_loops = 0;
 585
 586     playlist_item_t *p_autodelete_item = NULL;
 587
 588     /* Tell above that we're ready */
 589     vlc_thread_ready( p_playlist );
 590
 591     while( !p_playlist->b_die )
 592     {
 593         i_loops++;
 594         if( p_playlist->p_interaction )
 595         {
 596             stats_TimerStart( p_playlist, "Interaction thread" );
 597             intf_InteractionManage( p_playlist );
 598             stats_TimerStop( p_playlist, "Interaction thread" );
 599         }
 600
 601         vlc_mutex_lock( &p_playlist->object_lock );
 602
 603         /* First, check if we have something to do */
 604         /* FIXME : this can be called several times */
 605         if( p_playlist->request.b_request )
 606         {
 607 #ifdef PLAYLIST_PROFILE
 608             msg_Dbg(p_playlist, "beginning processing of request, "
 609                          I64Fi" us ", mdate() - p_playlist->request_date );
 610 #endif
 611             /* Stop the existing input */
 612             if( p_playlist->p_input )
 613             {
 614                 input_StopThread( p_playlist->p_input );
 615             }
 616             /* The code below will start the next input for us */
 617             if( p_playlist->status.i_status == PLAYLIST_STOPPED )
 618             {
 619                 p_playlist->request.b_request = VLC_FALSE;
 620             }
 621         }
 622
 623         /* If there is an input, check that it doesn't need to die. */
 624         if( p_playlist->p_input )
 625         {
 626             if( i_loops % 5 == 0 )
 627             {
 628                 stats_ComputeInputStats( p_playlist->p_input,
 629                                   p_playlist->p_input->input.p_item->p_stats );
 630 //                stats_DumpInputStats(
 631 //                            p_playlist->p_input->input.p_item->p_stats );
 632             }
 633
 634             /* This input is dead. Remove it ! */
 635             if( p_playlist->p_input->b_dead )
 636             {
 637                 input_thread_t *p_input;
 638
 639                 p_input = p_playlist->p_input;
 640                 p_playlist->p_input = NULL;
 641
 642                 /* Release the playlist lock, because we may get stuck
 643                  * in input_DestroyThread() for some time. */
 644                 vlc_mutex_unlock( &p_playlist->object_lock );
 645
 646                 /* Destroy input */
 647                 input_DestroyThread( p_input );
 648
 649                 /* Unlink current input
 650                  * (_after_ input_DestroyThread for vout garbage collector) */
 651                 vlc_object_detach( p_input );
 652
 653                 /* Destroy object */
 654                 vlc_object_destroy( p_input );
 655
 656                 i_vout_destroyed_date = 0;
 657                 i_sout_destroyed_date = 0;
 658
 659                 if( p_playlist->status.p_item->i_flags
 660                     & PLAYLIST_REMOVE_FLAG )
 661                 {
 662                      playlist_ItemDelete( p_item );
 663                      p_playlist->status.p_item = NULL;
 664                 }
 665
 666                 continue;
 667             }
 668             /* This input is dying, let it do */
 669             else if( p_playlist->p_input->b_die )
 670             {
 671                 ;
 672             }
 673             /* This input has finished, ask it to die ! */
 674             else if( p_playlist->p_input->b_error
 675                       || p_playlist->p_input->b_eof )
 676             {
 677                 /* TODO FIXME XXX TODO FIXME XXX */
 678                 /* Check for autodeletion */
 679
 680                 if( p_playlist->status.p_item->i_flags & PLAYLIST_DEL_FLAG )
 681                 {
 682                     p_autodelete_item = p_playlist->status.p_item;
 683                 }
 684                 input_StopThread( p_playlist->p_input );
 685                 /* Select the next playlist item */
 686                 vlc_mutex_unlock( &p_playlist->object_lock );
 687                 continue;
 688             }
 689             else if( p_playlist->p_input->i_state != INIT_S )
 690             {
 691                 vlc_mutex_unlock( &p_playlist->object_lock );
 692                 i_vout_destroyed_date =
 693                     ObjectGarbageCollector( p_playlist, VLC_OBJECT_VOUT,
 694                                             i_vout_destroyed_date );
 695                 i_sout_destroyed_date =
 696                     ObjectGarbageCollector( p_playlist, VLC_OBJECT_SOUT,
 697                                             i_sout_destroyed_date );
 698                 vlc_mutex_lock( &p_playlist->object_lock );
 699             }
 700         }
 701         else if( p_playlist->status.i_status != PLAYLIST_STOPPED )
 702         {
 703             /* Start another input.
 704              * Get the next item to play */
 705             stats_TimerStart( p_playlist, "Playlist walk" );
 706             p_item = NextItem( p_playlist );
 707             stats_TimerStop( p_playlist, "Playlist walk" );
 708
 709             /* We must stop */
 710             if( p_item == NULL )
 711             {
 712                 if( p_autodelete_item )
 713                 {
 714                     playlist_Delete( p_playlist,
 715                                      p_autodelete_item->input.i_id );
 716                     p_autodelete_item = NULL;
 717                 }
 718                 p_playlist->status.i_status = PLAYLIST_STOPPED;
 719                 vlc_mutex_unlock( &p_playlist->object_lock );
 720                 continue;
 721             }
 722
 723             PlayItem( p_playlist, p_item );
 724
 725             if( p_autodelete_item )
 726             {
 727                 playlist_Delete( p_playlist, p_autodelete_item->input.i_id );
 728                 p_autodelete_item = NULL;
 729             }
 730         }
 731         else if( p_playlist->status.i_status == PLAYLIST_STOPPED )
 732         {
 733             if( p_item && p_playlist->status.p_item &&
 734                 p_playlist->status.p_item->i_flags & PLAYLIST_REMOVE_FLAG )
 735             {
 736                  playlist_ItemDelete( p_item );
 737                  p_playlist->status.p_item = NULL;
 738             }
 739
 740             /* Collect garbage */
 741             vlc_mutex_unlock( &p_playlist->object_lock );
 742             i_sout_destroyed_date =
 743                 ObjectGarbageCollector( p_playlist, VLC_OBJECT_SOUT, mdate() );
 744             i_vout_destroyed_date =
 745                 ObjectGarbageCollector( p_playlist, VLC_OBJECT_VOUT, mdate() );
 746             vlc_mutex_lock( &p_playlist->object_lock );
 747         }
 748         vlc_mutex_unlock( &p_playlist->object_lock );
 749
 750         msleep( INTF_IDLE_SLEEP / 2 );
 751
 752         /* Stop sleeping earlier if we have work */
 753         /* TODO : statistics about this */
 754         if ( p_playlist->request.b_request &&
 755                         p_playlist->status.i_status == PLAYLIST_RUNNING )
 756         {
 757             continue;
 758         }
 759
 760         msleep( INTF_IDLE_SLEEP / 2 );
 761     }
 762
 763     /* Playlist dying */
 764
 765     /* If there is an input, kill it */
 766     while( 1 )
 767     {
 768         vlc_mutex_lock( &p_playlist->object_lock );
 769
 770         if( p_playlist->p_input == NULL )
 771         {
 772             vlc_mutex_unlock( &p_playlist->object_lock );
 773             break;
 774         }
 775
 776         if( p_playlist->p_input->b_dead )
 777         {
 778             input_thread_t *p_input;
 779
 780             /* Unlink current input */
 781             p_input = p_playlist->p_input;
 782             p_playlist->p_input = NULL;
 783             vlc_mutex_unlock( &p_playlist->object_lock );
 784
 785             /* Destroy input */
 786             input_DestroyThread( p_input );
 787             /* Unlink current input (_after_ input_DestroyThread for vout
 788              * garbage collector)*/
 789             vlc_object_detach( p_input );
 790
 791             /* Destroy object */
 792             vlc_object_destroy( p_input );
 793             continue;
 794         }
 795         else if( p_playlist->p_input->b_die )
 796         {
 797             /* This input is dying, leave it alone */
 798             ;
 799         }
 800         else if( p_playlist->p_input->b_error || p_playlist->p_input->b_eof )
 801         {
 802             input_StopThread( p_playlist->p_input );
 803             vlc_mutex_unlock( &p_playlist->object_lock );
 804             continue;
 805         }
 806         else
 807         {
 808             p_playlist->p_input->b_eof = 1;
 809         }
 810
 811         vlc_mutex_unlock( &p_playlist->object_lock );
 812
 813         msleep( INTF_IDLE_SLEEP );
 814     }
 815
 816     /* close all remaining sout */
 817     while( ( p_obj = vlc_object_find( p_playlist,
 818                                       VLC_OBJECT_SOUT, FIND_CHILD ) ) )
 819     {
 820         vlc_object_release( p_obj );
 821         sout_DeleteInstance( (sout_instance_t*)p_obj );
 822     }
 823
 824     /* close all remaining vout */
 825     while( ( p_obj = vlc_object_find( p_playlist,
 826                                       VLC_OBJECT_VOUT, FIND_CHILD ) ) )
 827     {
 828         vlc_object_detach( p_obj );
 829         vlc_object_release( p_obj );
 830         vout_Destroy( (vout_thread_t *)p_obj );
 831     }
 832 }
 833
 834 /* Queue for items to preparse */
 835 static void RunPreparse ( playlist_preparse_t *p_obj )
 836 {
 837     playlist_t *p_playlist = (playlist_t *)p_obj->p_parent;
 838     vlc_bool_t b_sleep;
 839
 840     /* Tell above that we're ready */
 841     vlc_thread_ready( p_obj );
 842
 843     while( !p_playlist->b_die )
 844     {
 845         vlc_mutex_lock( &p_obj->object_lock );
 846
 847         if( p_obj->i_waiting > 0 )
 848         {
 849             int i_current_id = p_obj->pi_waiting[0];
 850             playlist_item_t *p_current;
 851             REMOVE_ELEM( p_obj->pi_waiting, p_obj->i_waiting, 0 );
 852             vlc_mutex_unlock( &p_obj->object_lock );
 853             vlc_mutex_lock( &p_playlist->object_lock );
 854
 855             p_current = playlist_ItemGetById( p_playlist, i_current_id );
 856             if( p_current )
 857             {
 858                 vlc_bool_t b_preparsed = VLC_FALSE;
 859                 if( strncmp( p_current->input.psz_uri, "http:", 5 ) &&
 860                     strncmp( p_current->input.psz_uri, "rtsp:", 5 ) &&
 861                     strncmp( p_current->input.psz_uri, "udp:", 4 ) &&
 862                     strncmp( p_current->input.psz_uri, "mms:", 4 ) &&
 863                     strncmp( p_current->input.psz_uri, "cdda:", 4 ) &&
 864                     strncmp( p_current->input.psz_uri, "dvd:", 4 ) &&
 865                     strncmp( p_current->input.psz_uri, "v4l:", 4 ) &&
 866                     strncmp( p_current->input.psz_uri, "dshow:", 6 ) )
 867                 {
 868                     b_preparsed = VLC_TRUE;
 869                     stats_TimerStart( p_playlist, "Preparse run" );
 870                     input_Preparse( p_playlist, &p_current->input );
 871                     stats_TimerStop( p_playlist, "Preparse run" );
 872                 }
 873                 vlc_mutex_unlock( &p_playlist->object_lock );
 874                 if( b_preparsed )
 875                 {
 876                     var_SetInteger( p_playlist, "item-change",
 877                                     p_current->input.i_id );
 878                 }
 879             }
 880             else
 881                 vlc_mutex_unlock( &p_playlist->object_lock );
 882             vlc_mutex_lock( &p_obj->object_lock );
 883         }
 884         b_sleep = ( p_obj->i_waiting == 0 );
 885
 886         vlc_mutex_unlock( &p_obj->object_lock );
 887
 888         if( p_obj->i_waiting == 0 )
 889         {
 890             msleep( INTF_IDLE_SLEEP );
 891         }
 892     }
 893 }
 894
 895 /*****************************************************************************
 896  * NextItem
 897  *****************************************************************************
 898  * This function calculates the next playlist item, depending
 899  * on the playlist course mode (forward, backward, random, view,...).
 900  *****************************************************************************/
 901 static playlist_item_t * NextItem( playlist_t *p_playlist )
 902 {
 903     playlist_item_t *p_new = NULL;
 904     int i_skip,i_goto,i, i_new, i_count ;
 905     playlist_view_t *p_view;
 906
 907     vlc_bool_t b_loop = var_GetBool( p_playlist, "loop" );
 908     vlc_bool_t b_random = var_GetBool( p_playlist, "random" );
 909     vlc_bool_t b_repeat = var_GetBool( p_playlist, "repeat" );
 910     vlc_bool_t b_playstop = var_GetBool( p_playlist, "play-and-stop" );
 911
 912 #ifdef PLAYLIST_PROFILE
 913     /* Calculate time needed */
 914     int64_t start = mdate();
 915 #endif
 916     /* Handle quickly a few special cases */
 917
 918     /* No items to play */
 919     if( p_playlist->i_size == 0 )
 920     {
 921         msg_Info( p_playlist, "playlist is empty" );
 922         return NULL;
 923     }
 924     /* Nothing requested */
 925     if( !p_playlist->request.b_request && p_playlist->status.p_item == NULL )
 926     {
 927         msg_Dbg( p_playlist,"nothing requested, starting" );
 928     }
 929
 930     /* Repeat and play/stop */
 931     if( !p_playlist->request.b_request && b_repeat == VLC_TRUE &&
 932          p_playlist->status.p_item )
 933     {
 934         msg_Dbg( p_playlist,"repeating item" );
 935         return p_playlist->status.p_item;
 936     }
 937
 938     if( !p_playlist->request.b_request && b_playstop == VLC_TRUE )
 939     {
 940         msg_Dbg( p_playlist,"stopping (play and stop)");
 941         return NULL;
 942     }
 943
 944     if( !p_playlist->request.b_request && p_playlist->status.p_item &&
 945         !( p_playlist->status.p_item->i_flags & PLAYLIST_SKIP_FLAG ) )
 946     {
 947         msg_Dbg( p_playlist, "no-skip mode, stopping") ;
 948         return NULL;
 949     }
 950
 951     /* TODO: improve this (only use current node) */
 952     /* TODO: use the "shuffled view" internally ? */
 953     /* Random case. This is an exception: if request, but request is skip +- 1
 954      * we don't go to next item but select a new random one. */
 955     if( b_random &&
 956         ( !p_playlist->request.b_request ||
 957         ( p_playlist->request.b_request && ( p_playlist->request.p_item == NULL ||
 958           p_playlist->request.i_skip == 1 || p_playlist->request.i_skip == -1 ) ) ) )
 959     {
 960         /* how many items to choose from ? */
 961         i_count = 0;
 962         for ( i = 0; i < p_playlist->i_size; i++ )
 963         {
 964             if ( p_playlist->pp_items[i]->i_nb_played == 0 )
 965                 i_count++;
 966         }
 967         /* Nothing left? */
 968         if ( i_count == 0 )
 969         {
 970             /* Don't loop? Exit! */
 971             if( !b_loop )
 972                 return NULL;
 973             /* Otherwise reset the counter */
 974             for ( i = 0; i < p_playlist->i_size; i++ )
 975             {
 976                 p_playlist->pp_items[i]->i_nb_played = 0;
 977             }
 978             i_count = p_playlist->i_size;
 979         }
 980         srand( (unsigned int)mdate() );
 981         i = rand() % i_count + 1 ;
 982         /* loop thru the list and count down the unplayed items to the selected one */
 983         for ( i_new = 0; i_new < p_playlist->i_size && i > 0; i_new++ )
 984         {
 985             if ( p_playlist->pp_items[i_new]->i_nb_played == 0 )
 986                 i--;
 987         }
 988         i_new--;
 989
 990         p_playlist->request.i_skip = 0;
 991         p_playlist->request.b_request = VLC_FALSE;
 992         return p_playlist->pp_items[i_new];
 993     }
 994
 995     /* Start the real work */
 996     if( p_playlist->request.b_request )
 997     {
 998 #ifdef PLAYLIST_DEBUG
 999         msg_Dbg( p_playlist,"processing request" );
1000 #endif
1001         /* We are not playing from a view */
1002         if( p_playlist->request.i_view == -1  )
1003         {
1004 #ifdef PLAYLIST_DEBUG
1005             msg_Dbg( p_playlist, "non-view mode request");
1006 #endif
1007             /* Directly select the item, just like now */
1008             p_new = p_playlist->request.p_item;
1009             i_skip = p_playlist->request.i_skip;
1010             i_goto = p_playlist->request.i_goto;
1011
1012             if( p_playlist->i_index < 0 ) p_playlist->i_index = 0;
1013             if ( p_new == NULL )
1014                 p_new = p_playlist->pp_items[p_playlist->i_index];
1015
1016             if( i_goto >= 0  && i_goto < p_playlist->i_size )
1017             {
1018                 p_playlist->i_index = i_goto;
1019                 p_new = p_playlist->pp_items[p_playlist->i_index];
1020                 p_playlist->request.i_goto = -1;
1021             }
1022
1023             if( i_skip != 0 )
1024             {
1025                 if( p_playlist->i_index + i_skip < p_playlist->i_size &&
1026                     p_playlist->i_index + i_skip >=  0 )
1027                 {
1028                     p_playlist->i_index += i_skip;
1029                     p_new = p_playlist->pp_items[p_playlist->i_index];
1030                 }
1031                 p_playlist->request.i_skip = 0;
1032             }
1033             if( !( p_new->i_flags & PLAYLIST_SKIP_FLAG ) )
1034             {
1035                 return NULL;
1036             }
1037         }
1038         else
1039         {
1040 #ifdef PLAYLIST_DEBUG
1041             msg_Dbg( p_playlist, "view mode request" );
1042 #endif
1043             p_new = p_playlist->request.p_item;
1044             i_skip = p_playlist->request.i_skip;
1045
1046             /* If we are asked for a node, take its first item */
1047             if( p_playlist->request.p_item == NULL && i_skip == 0 )
1048             {
1049                 i_skip++;
1050             }
1051
1052             p_view = playlist_ViewFind( p_playlist,p_playlist->request.i_view );
1053             p_playlist->status.p_node = p_playlist->request.p_node;
1054             p_playlist->status.i_view = p_playlist->request.i_view;
1055             if( !p_view )
1056             {
1057                 msg_Err( p_playlist, "p_view is NULL and should not! (requested view is %i", p_playlist->request.i_view );
1058             }
1059             else if( i_skip > 0 )
1060             {
1061                 for( i = i_skip; i > 0 ; i-- )
1062                 {
1063                     p_new = playlist_FindNextFromParent( p_playlist,
1064                                     p_playlist->request.i_view,
1065                                     p_view->p_root,
1066                                     p_playlist->request.p_node,
1067                                     p_new );
1068                     if( p_new == NULL )
1069                     {
1070 #ifdef PLAYLIST_DEBUG
1071                         msg_Dbg( p_playlist, "looping" );
1072 #endif
1073                         p_new = playlist_FindNextFromParent( p_playlist,
1074                                   p_playlist->request.i_view,
1075                                   p_view->p_root,
1076                                   p_view->p_root,
1077                                   NULL );
1078                         if( p_new == NULL ) break;
1079                     }
1080                 }
1081             }
1082             else if( i_skip < 0 )
1083             {
1084                 for( i = i_skip; i < 0 ; i++ )
1085                 {
1086                     p_new = playlist_FindPrevFromParent( p_playlist,
1087                                     p_playlist->request.i_view,
1088                                     p_view->p_root,
1089                                     p_playlist->request.p_node,
1090                                     p_new );
1091                     if( p_new == NULL )
1092                     {
1093                     /* We reach the beginning of the playlist.
1094                        Go back to the last item. */
1095                         p_new = playlist_RecursiveFindLast( p_playlist,
1096                                                             p_view->p_root );
1097                     }
1098                     if( p_new == NULL ) break;
1099                 }
1100
1101             }
1102         }
1103         /* Clear the request */
1104         p_playlist->request.b_request = VLC_FALSE;
1105     }
1106     /* "Automatic" item change ( next ) */
1107     else
1108     {
1109         p_playlist->request_date = 0;
1110
1111         if( p_playlist->status.i_view == -1 )
1112         {
1113 #ifdef PLAYLIST_DEBUG
1114         msg_Dbg( p_playlist, "no request - old mode" );
1115 #endif
1116             if( p_playlist->i_index + 1 < p_playlist->i_size )
1117             {
1118                 p_playlist->i_index++;
1119                 p_new = p_playlist->pp_items[p_playlist->i_index];
1120                 if( !( p_new->i_flags & PLAYLIST_SKIP_FLAG ) )
1121                 {
1122                     return NULL;
1123                 }
1124             }
1125             else
1126             {
1127                 if( b_loop && p_playlist->i_size > 0)
1128                 {
1129                     p_playlist->i_index = 0;
1130                     p_new = p_playlist->pp_items[0];
1131                 }
1132                 else
1133                     p_new = NULL;
1134             }
1135         }
1136         /* We are playing with a view */
1137         else
1138         {
1139 #ifdef PLAYLIST_DEBUG
1140             msg_Dbg( p_playlist,"no request - from a view" );
1141 #endif
1142             playlist_view_t *p_view =
1143                     playlist_ViewFind( p_playlist,
1144                                    p_playlist->status.i_view );
1145             if( !p_view )
1146             {
1147                 msg_Err( p_playlist, "p_view is NULL and should not! (FIXME)" );
1148             }
1149             else
1150             {
1151                 p_new = playlist_FindNextFromParent( p_playlist,
1152                             p_playlist->status.i_view,
1153                             p_view->p_root,
1154                             p_playlist->status.p_node,
1155                             p_playlist->status.p_item );
1156                 if( p_new == NULL && b_loop )
1157                 {
1158 #ifdef PLAYLIST_DEBUG
1159                     msg_Dbg( p_playlist, "looping" );
1160 #endif
1161                     p_new = playlist_FindNextFromParent( p_playlist,
1162                                    p_playlist->status.i_view,
1163                                    p_view->p_root,
1164                                    p_view->p_root,
1165                                    NULL );
1166                 }
1167                 if( p_new != NULL && !(p_new->i_flags & PLAYLIST_SKIP_FLAG) )
1168                     return NULL;
1169             }
1170         }
1171     }
1172
1173     /* Reset index */
1174     if( p_playlist->i_index >= 0 && p_new != NULL &&
1175             p_playlist->pp_items[p_playlist->i_index] != p_new )
1176     {
1177         p_playlist->i_index = playlist_GetPositionById( p_playlist,
1178                                                         p_new->input.i_id );
1179     }
1180
1181 #ifdef PLAYLIST_PROFILE
1182     msg_Dbg(p_playlist,"next item found in "I64Fi " us", mdate()-start );
1183 #endif
1184
1185     if( p_new == NULL )
1186     {
1187         msg_Info( p_playlist, "nothing to play" );
1188     }
1189
1190     return p_new;
1191 }
1192
1193 /*****************************************************************************
1194  * PlayItem: start the input thread for an item
1195  ****************************************************************************/
1196 static int PlayItem( playlist_t *p_playlist, playlist_item_t *p_item )
1197 {
1198     vlc_value_t val;
1199
1200     msg_Dbg( p_playlist, "creating new input thread" );
1201
1202     p_item->i_nb_played++;
1203     p_playlist->status.p_item = p_item;
1204
1205     p_playlist->i_index = playlist_GetPositionById( p_playlist,
1206                                                     p_item->input.i_id );
1207
1208 #ifdef PLAYLIST_PROFILE
1209     if( p_playlist->request_date != 0 )
1210     {
1211         msg_Dbg( p_playlist, "request processed after "I64Fi " us",
1212                   mdate() - p_playlist->request_date );
1213     }
1214 #endif
1215
1216     p_playlist->p_input = input_CreateThread( p_playlist, &p_item->input );
1217
1218     val.i_int = p_item->input.i_id;
1219     /* unlock the playlist to set the var...mmm */
1220     vlc_mutex_unlock( &p_playlist->object_lock);
1221     var_Set( p_playlist, "playlist-current", val);
1222     vlc_mutex_lock( &p_playlist->object_lock);
1223
1224     return VLC_SUCCESS;
1225
1226 }