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

   1 /*****************************************************************************
   2  * item.c : Playlist item creation/deletion/add/removal functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2007 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 <assert.h>
  30 #include <vlc_playlist.h>
  31 #include "playlist_internal.h"
  32
  33 static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
  34                      playlist_item_t *p_node, int i_mode, int i_pos );
  35 static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
  36                            playlist_item_t *, playlist_item_t * );
  37 static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item );
  38 static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
  39                         bool b_stop );
  40
  41 /*****************************************************************************
  42  * An input item has gained a subitem (Event Callback)
  43  *****************************************************************************/
  44 static void input_item_subitem_added( const vlc_event_t * p_event,
  45                                       void * user_data )
  46 {
  47     playlist_item_t *p_parent_playlist_item = user_data;
  48     playlist_t * p_playlist = p_parent_playlist_item->p_playlist;
  49     input_item_t * p_parent, * p_child;
  50     playlist_item_t * p_child_in_category;
  51     playlist_item_t * p_item_in_category;
  52     bool b_play;
  53
  54     p_parent = p_event->p_obj;
  55     p_child = p_event->u.input_item_subitem_added.p_new_child;
  56
  57     PL_LOCK;
  58     b_play = var_CreateGetBool( p_playlist, "playlist-autostart" );
  59
  60     /* This part is really hakish, but this playlist system isn't simple */
  61     /* First check if we haven't already added the item as we are
  62      * listening using the onelevel and the category representent
  63      * (Because of the playlist design) */
  64     p_child_in_category = playlist_ItemFindFromInputAndRoot(
  65                             p_playlist, p_child->i_id,
  66                             p_playlist->p_root_category,
  67                             false /* Only non-node */ );
  68
  69     if( !p_child_in_category )
  70     {
  71         /* Then, transform to a node if needed */
  72         p_item_in_category = playlist_ItemFindFromInputAndRoot(
  73                                 p_playlist, p_parent->i_id,
  74                                 p_playlist->p_root_category,
  75                                 false /* Only non-node */ );
  76         if( !p_item_in_category )
  77         {
  78             /* Item may have been removed */
  79             PL_UNLOCK;
  80             return;
  81         }
  82
  83         b_play = b_play && p_item_in_category == p_playlist->status.p_item;
  84
  85         /* If this item is already a node don't transform it */
  86         if( p_item_in_category->i_children == -1 )
  87         {
  88             p_item_in_category = playlist_ItemToNode( p_playlist,
  89                     p_item_in_category, true );
  90             p_item_in_category->p_input->i_type = ITEM_TYPE_PLAYLIST;
  91         }
  92
  93         int i_ret = playlist_BothAddInput( p_playlist, p_child,
  94                 p_item_in_category,
  95                 PLAYLIST_APPEND | PLAYLIST_SPREPARSE , PLAYLIST_END,
  96                 NULL, NULL,  true );
  97
  98         if( i_ret == VLC_SUCCESS && b_play )
  99         {
 100             playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
 101                           true, p_item_in_category, NULL );
 102         }
 103     }
 104
 105     PL_UNLOCK;
 106
 107 }
 108
 109 /*****************************************************************************
 110  * An input item's meta or duration has changed (Event Callback)
 111  *****************************************************************************/
 112 static void input_item_changed( const vlc_event_t * p_event,
 113                                 void * user_data )
 114 {
 115     (void)p_event;
 116     playlist_item_t * p_item = user_data;
 117     var_SetInteger( p_item->p_playlist,
 118                     "item-change", p_item->i_id );
 119 }
 120
 121 /*****************************************************************************
 122  * Listen to vlc_InputItemAddSubItem event
 123  *****************************************************************************/
 124 static void install_input_item_observer( playlist_item_t * p_item )
 125 {
 126     vlc_event_attach( &p_item->p_input->event_manager,
 127                       vlc_InputItemSubItemAdded,
 128                       input_item_subitem_added,
 129                       p_item );
 130     vlc_event_attach( &p_item->p_input->event_manager,
 131                       vlc_InputItemDurationChanged,
 132                       input_item_changed,
 133                       p_item );
 134     vlc_event_attach( &p_item->p_input->event_manager,
 135                       vlc_InputItemMetaChanged,
 136                       input_item_changed,
 137                       p_item );
 138 }
 139
 140 static void uninstall_input_item_observer( playlist_item_t * p_item )
 141 {
 142     vlc_event_detach( &p_item->p_input->event_manager,
 143                       vlc_InputItemMetaChanged,
 144                       input_item_changed,
 145                       p_item );
 146     vlc_event_detach( &p_item->p_input->event_manager,
 147                       vlc_InputItemDurationChanged,
 148                       input_item_changed,
 149                       p_item );
 150     vlc_event_detach( &p_item->p_input->event_manager,
 151                       vlc_InputItemSubItemAdded,
 152                       input_item_subitem_added,
 153                       p_item );
 154 }
 155
 156 /*****************************************************************************
 157  * Playlist item creation
 158  *****************************************************************************/
 159 playlist_item_t * playlist_ItemNewWithType( vlc_object_t *p_obj,
 160                                             const char *psz_uri,
 161                                             const char *psz_name,
 162                                             int i_options,
 163                                             const char *const *ppsz_options,
 164                                             int i_duration, int i_type )
 165 {
 166     input_item_t *p_input;
 167     if( psz_uri == NULL ) return NULL;
 168     p_input = input_ItemNewWithType( p_obj, psz_uri,
 169                                      psz_name, i_options, ppsz_options,
 170                                      i_duration, i_type );
 171     return playlist_ItemNewFromInput( p_obj, p_input );
 172 }
 173
 174 playlist_item_t *__playlist_ItemNewFromInput( vlc_object_t *p_obj,
 175                                               input_item_t *p_input )
 176 {
 177     DECMALLOC_NULL( p_item, playlist_item_t );
 178     playlist_t *p_playlist = pl_Yield( p_obj );
 179
 180     p_item->p_input = p_input;
 181     vlc_gc_incref( p_item->p_input );
 182
 183     p_item->i_id = ++p_playlist->i_last_playlist_id;
 184
 185     p_item->p_parent = NULL;
 186     p_item->i_children = -1;
 187     p_item->pp_children = NULL;
 188     p_item->i_flags = 0;
 189     p_item->p_playlist = p_playlist;
 190
 191     install_input_item_observer( p_item );
 192
 193     pl_Release( p_item->p_playlist );
 194
 195     return p_item;
 196 }
 197
 198 /***************************************************************************
 199  * Playlist item destruction
 200  ***************************************************************************/
 201
 202 /**
 203  * Delete item
 204  *
 205  * Delete a playlist item and detach its input item
 206  * \param p_item item to delete
 207  * \return VLC_SUCCESS
 208 */
 209 int playlist_ItemDelete( playlist_item_t *p_item )
 210 {
 211     uninstall_input_item_observer( p_item );
 212
 213     vlc_gc_decref( p_item->p_input );
 214     free( p_item );
 215     return VLC_SUCCESS;
 216 }
 217
 218 /**
 219  * Delete input item
 220  *
 221  * Remove an input item when it appears from a root playlist item
 222  * \param p_playlist playlist object
 223  * \param i_input_id id of the input to delete
 224  * \param p_root root playlist item
 225  * \param b_do_stop must stop or not the playlist
 226  * \return VLC_SUCCESS or VLC_EGENERIC
 227 */
 228 static int DeleteFromInput( playlist_t *p_playlist, int i_input_id,
 229                             playlist_item_t *p_root, bool b_do_stop )
 230 {
 231     int i;
 232     for( i = 0 ; i< p_root->i_children ; i++ )
 233     {
 234         if( p_root->pp_children[i]->i_children == -1 &&
 235             p_root->pp_children[i]->p_input->i_id == i_input_id )
 236         {
 237             DeleteInner( p_playlist, p_root->pp_children[i], b_do_stop );
 238             return VLC_SUCCESS;
 239         }
 240         else if( p_root->pp_children[i]->i_children >= 0 )
 241         {
 242             int i_ret = DeleteFromInput( p_playlist, i_input_id,
 243                                          p_root->pp_children[i], b_do_stop );
 244             if( i_ret == VLC_SUCCESS ) return VLC_SUCCESS;
 245         }
 246     }
 247     return VLC_EGENERIC;
 248 }
 249
 250 /**
 251  * Delete input item
 252  *
 253  * Remove an input item when it appears from a root playlist item
 254  * \param p_playlist playlist object
 255  * \param i_input_id id of the input to delete
 256  * \param p_root root playlist item
 257  * \param b_locked TRUE if the playlist is locked
 258  * \return VLC_SUCCESS or VLC_EGENERIC
 259  */
 260 int playlist_DeleteInputInParent( playlist_t *p_playlist, int i_input_id,
 261                                   playlist_item_t *p_root, bool b_locked )
 262 {
 263     int i_ret;
 264     if( !b_locked ) PL_LOCK;
 265     i_ret = DeleteFromInput( p_playlist, i_input_id,
 266                              p_root, true );
 267     if( !b_locked ) PL_UNLOCK;
 268     return i_ret;
 269 }
 270
 271 /**
 272  * Delete from input
 273  *
 274  * Remove an input item from ONELEVEL and CATEGORY
 275  * \param p_playlist playlist object
 276  * \param i_input_id id of the input to delete
 277  * \param b_locked TRUE if the playlist is locked
 278  * \return VLC_SUCCESS or VLC_ENOITEM
 279  */
 280 int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
 281                               bool b_locked )
 282 {
 283     int i_ret1, i_ret2;
 284     if( !b_locked ) PL_LOCK;
 285     i_ret1 = DeleteFromInput( p_playlist, i_input_id,
 286                              p_playlist->p_root_category, true );
 287     i_ret2 = DeleteFromInput( p_playlist, i_input_id,
 288                      p_playlist->p_root_onelevel, true );
 289     if( !b_locked ) PL_UNLOCK;
 290     return ( i_ret1 == VLC_SUCCESS || i_ret2 == VLC_SUCCESS ) ?
 291                             VLC_SUCCESS : VLC_ENOITEM;
 292 }
 293
 294 /**
 295  * Clear the playlist
 296  *
 297  * \param p_playlist playlist object
 298  * \param b_locked TRUE if the playlist is locked
 299  * \return nothing
 300  */
 301 void playlist_Clear( playlist_t * p_playlist, bool b_locked )
 302 {
 303     if( !b_locked ) PL_LOCK;
 304     playlist_NodeEmpty( p_playlist, p_playlist->p_local_category, true );
 305     playlist_NodeEmpty( p_playlist, p_playlist->p_local_onelevel, true );
 306     if( !b_locked ) PL_UNLOCK;
 307 }
 308
 309 /**
 310  * Delete playlist item
 311  *
 312  * Remove a playlist item from the playlist, given its id
 313  * This function is to be used only by the playlist
 314  * \param p_playlist playlist object
 315  * \param i_id id of the item do delete
 316  * \return VLC_SUCCESS or an error
 317  */
 318 int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
 319 {
 320     playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id,
 321                                                     true );
 322     if( !p_item ) return VLC_EGENERIC;
 323     return DeleteInner( p_playlist, p_item, true );
 324 }
 325
 326 /***************************************************************************
 327  * Playlist item addition
 328  ***************************************************************************/
 329 /**
 330  * Playlist add
 331  *
 332  * Add an item to the playlist or the media library
 333  * \param p_playlist the playlist to add into
 334  * \param psz_uri the mrl to add to the playlist
 335  * \param psz_name a text giving a name or description of this item
 336  * \param i_mode the mode used when adding
 337  * \param i_pos the position in the playlist where to add. If this is
 338  *        PLAYLIST_END the item will be added at the end of the playlist
 339  *        regardless of its size
 340  * \param b_playlist TRUE for playlist, FALSE for media library
 341  * \param b_locked TRUE if the playlist is locked
 342  * \return The id of the playlist item
 343  */
 344 int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
 345                   const char *psz_name, int i_mode, int i_pos,
 346                   bool b_playlist, bool b_locked )
 347 {
 348     return playlist_AddExt( p_playlist, psz_uri, psz_name,
 349                             i_mode, i_pos, -1, NULL, 0, b_playlist, b_locked );
 350 }
 351
 352 /**
 353  * Add a MRL into the playlist or the media library, duration and options given
 354  *
 355  * \param p_playlist the playlist to add into
 356  * \param psz_uri the mrl to add to the playlist
 357  * \param psz_name a text giving a name or description of this item
 358  * \param i_mode the mode used when adding
 359  * \param i_pos the position in the playlist where to add. If this is
 360  *        PLAYLIST_END the item will be added at the end of the playlist
 361  *        regardless of its size
 362  * \param i_duration length of the item in milliseconds.
 363  * \param ppsz_options an array of options
 364  * \param i_options the number of options
 365  * \param b_playlist TRUE for playlist, FALSE for media library
 366  * \param b_locked TRUE if the playlist is locked
 367  * \return The id of the playlist item
 368 */
 369 int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
 370                      const char *psz_name, int i_mode, int i_pos,
 371                      mtime_t i_duration, const char *const *ppsz_options,
 372                      int i_options, bool b_playlist, bool b_locked )
 373 {
 374     int i_ret;
 375     input_item_t *p_input = input_ItemNewExt( p_playlist, psz_uri, psz_name,
 376                                               i_options, ppsz_options,
 377                                               i_duration );
 378
 379     i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
 380                                b_locked );
 381     int i_id = i_ret == VLC_SUCCESS ? p_input->i_id : -1;
 382
 383     vlc_gc_decref( p_input );
 384
 385     return i_id;
 386 }
 387
 388 /**
 389  * Add an input item to the playlist node
 390  *
 391  * \param p_playlist the playlist to add into
 392  * \param p_input the input item to add
 393  * \param i_mode the mode used when adding
 394  * \param i_pos the position in the playlist where to add. If this is
 395  *        PLAYLIST_END the item will be added at the end of the playlist
 396  *        regardless of its size
 397  * \param b_playlist TRUE for playlist, FALSE for media library
 398  * \param b_locked TRUE if the playlist is locked
 399  * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
 400 */
 401 int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
 402                        int i_mode, int i_pos, bool b_playlist,
 403                        bool b_locked )
 404 {
 405     playlist_item_t *p_item_cat, *p_item_one;
 406     if( p_playlist->b_die ) return VLC_EGENERIC;
 407     if( !p_playlist->b_doing_ml )
 408         PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
 409                                              p_input->psz_uri );
 410
 411     if( !b_locked ) PL_LOCK;
 412
 413     /* Add to ONELEVEL */
 414     p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
 415     if( p_item_one == NULL ) return VLC_ENOMEM;
 416     AddItem( p_playlist, p_item_one,
 417              b_playlist ? p_playlist->p_local_onelevel :
 418                           p_playlist->p_ml_onelevel , i_mode, i_pos );
 419
 420     /* Add to CATEGORY */
 421     p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
 422     if( p_item_cat == NULL ) return VLC_ENOMEM;
 423     AddItem( p_playlist, p_item_cat,
 424              b_playlist ? p_playlist->p_local_category :
 425                           p_playlist->p_ml_category , i_mode, i_pos );
 426
 427     GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
 428
 429     if( !b_locked ) PL_UNLOCK;
 430     return VLC_SUCCESS;
 431 }
 432
 433 /**
 434  * Add input
 435  *
 436  * Add an input item to p_direct_parent in the category tree, and to the
 437  * matching top category in onelevel
 438  * \param p_playlist the playlist to add into
 439  * \param p_input the input item to add
 440  * \param p_direct_parent the parent item to add into
 441  * \param i_mode the mode used when adding
 442  * \param i_pos the position in the playlist where to add. If this is
 443  *        PLAYLIST_END the item will be added at the end of the playlist
 444  *        regardless of its size
 445  * \param i_cat id of the items category
 446  * \param i_one id of the item onelevel category
 447  * \param b_locked TRUE if the playlist is locked
 448  * \return VLC_SUCCESS if success, VLC_EGENERIC if fail, VLC_ENOMEM if OOM
 449  */
 450 int playlist_BothAddInput( playlist_t *p_playlist,
 451                            input_item_t *p_input,
 452                            playlist_item_t *p_direct_parent,
 453                            int i_mode, int i_pos,
 454                            int *i_cat, int *i_one, bool b_locked )
 455 {
 456     playlist_item_t *p_item_cat, *p_item_one, *p_up;
 457     int i_top;
 458     assert( p_input );
 459     if( p_playlist->b_die ) return VLC_EGENERIC;
 460     if( !b_locked ) PL_LOCK;
 461
 462     /* Add to category */
 463     p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
 464     if( p_item_cat == NULL ) return VLC_ENOMEM;
 465     AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
 466
 467     /* Add to onelevel */
 468     /** \todo make a faster case for ml import */
 469     p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
 470     if( p_item_one == NULL ) return VLC_ENOMEM;
 471
 472     p_up = p_direct_parent;
 473     while( p_up->p_parent != p_playlist->p_root_category )
 474     {
 475         p_up = p_up->p_parent;
 476     }
 477     for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
 478     {
 479         if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id ==
 480                              p_up->p_input->i_id )
 481         {
 482             AddItem( p_playlist, p_item_one,
 483                      p_playlist->p_root_onelevel->pp_children[i_top],
 484                      i_mode, i_pos );
 485             break;
 486         }
 487     }
 488     GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
 489
 490     if( i_cat ) *i_cat = p_item_cat->i_id;
 491     if( i_one ) *i_one = p_item_one->i_id;
 492
 493     if( !b_locked ) PL_UNLOCK;
 494     return VLC_SUCCESS;
 495 }
 496
 497 /**
 498  * Add an input item to a given node
 499  *
 500  * \param p_playlist the playlist to add into
 501  * \param p_input the input item to add
 502  * \param p_parent the parent item to add into
 503  * \param i_mode the mode used when addin
 504  * \param i_pos the position in the playlist where to add. If this is
 505  *        PLAYLIST_END the item will be added at the end of the playlist
 506  *        regardless of its size
 507  * \param b_locked TRUE if the playlist is locked
 508  * \return the new playlist item
 509  */
 510 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
 511                                          input_item_t *p_input,
 512                                          playlist_item_t *p_parent,
 513                                          int i_mode, int i_pos,
 514                                          bool b_locked )
 515 {
 516     playlist_item_t *p_item;
 517     assert( p_input );
 518     assert( p_parent && p_parent->i_children != -1 );
 519
 520     if( p_playlist->b_die )
 521         return NULL;
 522     if( !b_locked ) PL_LOCK;
 523
 524     p_item = playlist_ItemNewFromInput( p_playlist, p_input );
 525     if( p_item == NULL ) return NULL;
 526     AddItem( p_playlist, p_item, p_parent, i_mode, i_pos );
 527
 528     if( !b_locked ) PL_UNLOCK;
 529
 530     return p_item;
 531 }
 532
 533 /*****************************************************************************
 534  * Playlist item misc operations
 535  *****************************************************************************/
 536
 537 /**
 538  * Item to node
 539  *
 540  * Transform an item to a node. Return the node in the category tree, or NULL
 541  * if not found there
 542  * This function must be entered without the playlist lock
 543  * \param p_playlist the playlist object
 544  * \param p_item the item to transform
 545  * \param b_locked TRUE if the playlist is locked
 546  * \return the item transform in a node
 547  */
 548 playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
 549                                       playlist_item_t *p_item,
 550                                       bool b_locked )
 551 {
 552
 553     playlist_item_t *p_item_in_category;
 554     /* What we do
 555      * Find the input in CATEGORY.
 556      *  - If we find it
 557      *    - change it to node
 558      *    - we'll return it at the end
 559      *    - If we are a direct child of onelevel root, change to node, else
 560      *      delete the input from ONELEVEL
 561      *  - If we don't find it, just change to node (we are probably in VLM)
 562      *    and return NULL
 563      *
 564      * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
 565      * useful for later BothAddInput )
 566      */
 567
 568     if( !b_locked ) PL_LOCK;
 569
 570     /* Fast track the media library, no time to loose */
 571     if( p_item == p_playlist->p_ml_category ) {
 572         if( !b_locked ) PL_UNLOCK;
 573         return p_item;
 574     }
 575
 576     /** \todo First look if we don't already have it */
 577     p_item_in_category = playlist_ItemFindFromInputAndRoot(
 578                                             p_playlist, p_item->p_input->i_id,
 579                                             p_playlist->p_root_category,
 580                                             true );
 581
 582     if( p_item_in_category )
 583     {
 584         playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
 585                                             p_playlist, p_item->p_input->i_id,
 586                                             p_playlist->p_root_onelevel,
 587                                             true );
 588         assert( p_item_in_one );
 589
 590         /* We already have it, and there is nothing more to do */
 591         ChangeToNode( p_playlist, p_item_in_category );
 592
 593         /* Item in one is a root, change it to node */
 594         if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
 595             ChangeToNode( p_playlist, p_item_in_one );
 596         else
 597         {
 598             DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
 599                              p_playlist->p_root_onelevel, false );
 600         }
 601         p_playlist->b_reset_currently_playing = true;
 602         vlc_cond_signal( &p_playlist->object_wait );
 603         var_SetInteger( p_playlist, "item-change", p_item_in_category->
 604                                                         p_input->i_id );
 605         if( !b_locked ) PL_UNLOCK;
 606         return p_item_in_category;
 607     }
 608     else
 609     {
 610         ChangeToNode( p_playlist, p_item );
 611         if( !b_locked ) PL_UNLOCK;
 612         return NULL;
 613     }
 614 }
 615
 616 /**
 617  * Find an item within a root, given its input id.
 618  *
 619  * \param p_playlist the playlist object
 620  * \param i_input_id id of the input
 621  * \param p_root root playlist item
 622  * \param b_items_only TRUE if we want the item himself
 623  * \return the first found item, or NULL if not found
 624  */
 625 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
 626                                                     int i_input_id,
 627                                                     playlist_item_t *p_root,
 628                                                     bool b_items_only )
 629 {
 630     int i;
 631     for( i = 0 ; i< p_root->i_children ; i++ )
 632     {
 633         if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
 634             p_root->pp_children[i]->p_input->i_id == i_input_id )
 635         {
 636             return p_root->pp_children[i];
 637         }
 638         else if( p_root->pp_children[i]->i_children >= 0 )
 639         {
 640             playlist_item_t *p_search =
 641                  playlist_ItemFindFromInputAndRoot( p_playlist, i_input_id,
 642                                                     p_root->pp_children[i],
 643                                                     b_items_only );
 644             if( p_search ) return p_search;
 645         }
 646     }
 647     return NULL;
 648 }
 649
 650
 651 static int TreeMove( playlist_t *p_playlist, playlist_item_t *p_item,
 652                      playlist_item_t *p_node, int i_newpos )
 653 {
 654     int j;
 655     playlist_item_t *p_detach = p_item->p_parent;
 656     (void)p_playlist;
 657
 658     if( p_node->i_children == -1 ) return VLC_EGENERIC;
 659
 660     for( j = 0; j < p_detach->i_children; j++ )
 661     {
 662          if( p_detach->pp_children[j] == p_item ) break;
 663     }
 664     REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );
 665
 666     /* Attach to new parent */
 667     INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
 668     p_item->p_parent = p_node;
 669
 670     return VLC_SUCCESS;
 671 }
 672
 673 /**
 674  * Moves an item
 675  *
 676  * This function must be entered with the playlist lock
 677  *
 678  * \param p_playlist the playlist
 679  * \param p_item the item to move
 680  * \param p_node the new parent of the item
 681  * \param i_newpos the new position under this new parent
 682  * \return VLC_SUCCESS or an error
 683  */
 684 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
 685                        playlist_item_t *p_node, int i_newpos )
 686 {
 687     int i_ret;
 688     /* Drop on a top level node. Move in the two trees */
 689     if( p_node->p_parent == p_playlist->p_root_category ||
 690         p_node->p_parent == p_playlist->p_root_onelevel )
 691     {
 692         /* Fixme: avoid useless lookups but we need some clean helpers */
 693         {
 694             /* Fixme: if we try to move a node on a top-level node, it will
 695              * fail because the node doesn't exist in onelevel and we will
 696              * do some shit in onelevel. We should recursively move all items
 697              * within the node */
 698             playlist_item_t *p_node_onelevel;
 699             playlist_item_t *p_item_onelevel;
 700             p_node_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
 701                                                 p_node->p_input->i_id,
 702                                                 p_playlist->p_root_onelevel,
 703                                                 false );
 704             p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
 705                                                 p_item->p_input->i_id,
 706                                                 p_playlist->p_root_onelevel,
 707                                                 false );
 708             if( p_node_onelevel && p_item_onelevel )
 709                 TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, 0 );
 710         }
 711         {
 712             playlist_item_t *p_node_category;
 713             playlist_item_t *p_item_category;
 714             p_node_category = playlist_ItemFindFromInputAndRoot( p_playlist,
 715                                                 p_node->p_input->i_id,
 716                                                 p_playlist->p_root_category,
 717                                                 false );
 718             p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
 719                                                 p_item->p_input->i_id,
 720                                                 p_playlist->p_root_category,
 721                                                 false );
 722             if( p_node_category && p_item_category )
 723                 TreeMove( p_playlist, p_item_category, p_node_category, 0 );
 724         }
 725         i_ret = VLC_SUCCESS;
 726     }
 727     else
 728         i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
 729     p_playlist->b_reset_currently_playing = true;
 730     vlc_cond_signal( &p_playlist->object_wait );
 731     return i_ret;
 732 }
 733
 734 /**
 735  * Send a notification that an item has been added to a node
 736  *
 737  * \param p_playlist the playlist object
 738  * \param i_item_id id of the item added
 739  * \param i_node_id id of the node in wich the item was added
 740  * \param b_signal TRUE if the function must send a signal
 741  * \return nothing
 742  */
 743 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
 744                              int i_node_id, bool b_signal )
 745 {
 746     vlc_value_t val;
 747     playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
 748     if( !p_add )
 749         return;
 750
 751     p_add->i_item = i_item_id;
 752     p_add->i_node = i_node_id;
 753     val.p_address = p_add;
 754     p_playlist->b_reset_currently_playing = true;
 755     if( b_signal )
 756         vlc_cond_signal( &p_playlist->object_wait );
 757     var_Set( p_playlist, "item-append", val );
 758     free( p_add );
 759 }
 760
 761 /*****************************************************************************
 762  * Playlist item accessors
 763  *****************************************************************************/
 764
 765 /**
 766  * Set the name of a playlist item
 767  *
 768  * \param p_item the item
 769  * \param psz_name the name
 770  * \return VLC_SUCCESS or VLC_EGENERIC
 771  */
 772 int playlist_ItemSetName( playlist_item_t *p_item, const char *psz_name )
 773 {
 774     if( psz_name && p_item )
 775     {
 776         input_item_SetName( p_item->p_input, psz_name );
 777         return VLC_SUCCESS;
 778     }
 779     return VLC_EGENERIC;
 780 }
 781
 782 /***************************************************************************
 783  * The following functions are local
 784  ***************************************************************************/
 785
 786 /* Enqueue an item for preparsing, and play it, if needed */
 787 static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
 788                            playlist_item_t *p_item_cat,
 789                            playlist_item_t *p_item_one )
 790 {
 791     if( (i_mode & PLAYLIST_GO ) )
 792     {
 793         playlist_item_t *p_parent = p_item_one;
 794         playlist_item_t *p_toplay = NULL;
 795         while( p_parent )
 796         {
 797             if( p_parent == p_playlist->p_root_category )
 798             {
 799                 p_toplay = p_item_cat; break;
 800             }
 801             else if( p_parent == p_playlist->p_root_onelevel )
 802             {
 803                 p_toplay = p_item_one; break;
 804             }
 805             p_parent = p_parent->p_parent;
 806         }
 807         assert( p_toplay );
 808         p_playlist->request.b_request = true;
 809         p_playlist->request.i_skip = 0;
 810         p_playlist->request.p_item = p_toplay;
 811         if( p_playlist->p_input )
 812             input_StopThread( p_playlist->p_input );
 813         p_playlist->request.i_status = PLAYLIST_RUNNING;
 814         vlc_cond_signal( &p_playlist->object_wait );
 815     }
 816     /* Preparse if PREPARSE or SPREPARSE & not enough meta */
 817     char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
 818     char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
 819     if( p_playlist->b_auto_preparse &&
 820           (i_mode & PLAYLIST_PREPARSE ||
 821           ( i_mode & PLAYLIST_SPREPARSE &&
 822             ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
 823           ) ) )
 824         playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
 825     /* If we already have it, signal it */
 826     else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
 827         input_item_SetPreparsed( p_item_cat->p_input, true );
 828     free( psz_artist );
 829     free( psz_album );
 830 }
 831
 832 /* Add the playlist item to the requested node and fire a notification */
 833 static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
 834                      playlist_item_t *p_node, int i_mode, int i_pos )
 835 {
 836     ARRAY_APPEND(p_playlist->items, p_item);
 837     ARRAY_APPEND(p_playlist->all_items, p_item);
 838
 839     if( i_pos == PLAYLIST_END )
 840         playlist_NodeAppend( p_playlist, p_item, p_node );
 841     else
 842         playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
 843
 844     if( !p_playlist->b_doing_ml )
 845         playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
 846                                  !( i_mode & PLAYLIST_NO_REBUILD ) );
 847 }
 848
 849 /* Actually convert an item to a node */
 850 static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
 851 {
 852     int i;
 853     if( p_item->i_children == -1 )
 854         p_item->i_children = 0;
 855
 856     /* Remove it from the array of available items */
 857     ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
 858     if( i != -1 )
 859         ARRAY_REMOVE( p_playlist->items, i );
 860 }
 861
 862 /* Do the actual removal */
 863 static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
 864                         bool b_stop )
 865 {
 866     int i;
 867     int i_id = p_item->i_id;
 868     bool b_delay_deletion = false;
 869
 870     if( p_item->i_children > -1 )
 871     {
 872         return playlist_NodeDelete( p_playlist, p_item, true, false );
 873     }
 874     p_playlist->b_reset_currently_playing = true;
 875     var_SetInteger( p_playlist, "item-deleted", i_id );
 876
 877     /* Remove the item from the bank */
 878     ARRAY_BSEARCH( p_playlist->all_items,->i_id, int, i_id, i );
 879     if( i != -1 )
 880         ARRAY_REMOVE( p_playlist->all_items, i );
 881
 882     ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
 883     if( i != -1 )
 884         ARRAY_REMOVE( p_playlist->items, i );
 885
 886     /* Check if it is the current item */
 887     if( p_playlist->status.p_item == p_item )
 888     {
 889         /* Hack we don't call playlist_Control for lock reasons */
 890         if( b_stop )
 891         {
 892             p_playlist->request.i_status = PLAYLIST_STOPPED;
 893             p_playlist->request.b_request = true;
 894             p_playlist->request.p_item = NULL;
 895             msg_Info( p_playlist, "stopping playback" );
 896             vlc_cond_signal( &p_playlist->object_wait );
 897         }
 898         b_delay_deletion = true;
 899     }
 900
 901     PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
 902
 903     /* Remove the item from its parent */
 904     playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
 905
 906     if( !b_delay_deletion )
 907         playlist_ItemDelete( p_item );
 908     else
 909     {
 910         PL_DEBUG( "marking %s for further deletion", PLI_NAME( p_item ) );
 911         p_item->i_flags |= PLAYLIST_REMOVE_FLAG;
 912     }
 913
 914     return VLC_SUCCESS;
 915 }