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