item.c 33.7 KB
Newer Older
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 11 12 13 14 15 16 17 18 19 20 21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23
 *****************************************************************************/
24 25 26 27
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

28
#include <vlc_common.h>
Clément Stenac's avatar
Clément Stenac committed
29
#include <assert.h>
30 31
#include <vlc_playlist.h>
#include "playlist_internal.h"
32

33 34 35 36 37 38
static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_mode, int i_pos );
static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
                           playlist_item_t *, playlist_item_t * );
static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item );
static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
39
                        bool b_stop );
40

41 42 43 44 45 46
/*****************************************************************************
 * An input item has gained a subitem (Event Callback)
 *****************************************************************************/
static void input_item_subitem_added( const vlc_event_t * p_event,
                                      void * user_data )
{
47 48
    playlist_item_t *p_parent_playlist_item = user_data;
    playlist_t * p_playlist = p_parent_playlist_item->p_playlist;
49
    input_item_t * p_parent, * p_child;
50 51
    playlist_item_t * p_child_in_category;
    playlist_item_t * p_item_in_category;
52
    bool b_play;
53 54 55 56

    p_parent = p_event->p_obj;
    p_child = p_event->u.input_item_subitem_added.p_new_child;

57 58
    PL_LOCK;
    b_play = var_CreateGetBool( p_playlist, "playlist-autostart" );
59

60
    /* This part is really hakish, but this playlist system isn't simple */
61 62
    /* First check if we haven't already added the item as we are
     * listening using the onelevel and the category representent
63 64 65 66
     * (Because of the playlist design) */
    p_child_in_category = playlist_ItemFindFromInputAndRoot(
                            p_playlist, p_child->i_id,
                            p_playlist->p_root_category,
67
                            false /* Only non-node */ );
68

69
    if( !p_child_in_category )
70
    {
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
71
        /* Then, transform to a node if needed */
72 73 74
        p_item_in_category = playlist_ItemFindFromInputAndRoot(
                                p_playlist, p_parent->i_id,
                                p_playlist->p_root_category,
75
                                false /* Only non-node */ );
76 77 78 79
        if( !p_item_in_category )
        {
            /* Item may have been removed */
            PL_UNLOCK;
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
80
            return;
81 82
        }

83 84
        b_play = b_play &&
            p_item_in_category == get_current_status_item( p_playlist );
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
85

Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
86 87 88 89
        /* If this item is already a node don't transform it */
        if( p_item_in_category->i_children == -1 )
        {
            p_item_in_category = playlist_ItemToNode( p_playlist,
90
                    p_item_in_category, pl_Locked );
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
91 92
            p_item_in_category->p_input->i_type = ITEM_TYPE_PLAYLIST;
        }
93

94 95
        int i_ret = playlist_BothAddInput( p_playlist, p_child,
                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 107
    PL_UNLOCK;

108 109
}

110
/*****************************************************************************
111
 * An input item's meta or duration has changed (Event Callback)
112
 *****************************************************************************/
113 114
static void input_item_changed( const vlc_event_t * p_event,
                                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 123
/*****************************************************************************
 * Listen to vlc_InputItemAddSubItem event
 *****************************************************************************/
124
static void install_input_item_observer( playlist_item_t * p_item )
125
{
126 127 128 129 130 131 132
    vlc_event_manager_t * p_em = &p_item->p_input->event_manager;
    vlc_event_attach( p_em, vlc_InputItemSubItemAdded,
                      input_item_subitem_added, p_item );
    vlc_event_attach( p_em, vlc_InputItemDurationChanged,
                      input_item_changed, p_item );
    vlc_event_attach( p_em, vlc_InputItemMetaChanged,
                      input_item_changed, p_item );
133 134 135 136
    vlc_event_attach( p_em, vlc_InputItemNameChanged,
                      input_item_changed, p_item );
    vlc_event_attach( p_em, vlc_InputItemInfoChanged,
                      input_item_changed, p_item );
137 138
    vlc_event_attach( p_em, vlc_InputItemErrorWhenReadingChanged,
                      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 145
    vlc_event_detach( p_em, vlc_InputItemSubItemAdded,
                      input_item_subitem_added, p_item );
146 147 148 149
    vlc_event_detach( p_em, vlc_InputItemMetaChanged,
                      input_item_changed, p_item );
    vlc_event_detach( p_em, vlc_InputItemDurationChanged,
                      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 155
    vlc_event_detach( p_em, vlc_InputItemErrorWhenReadingChanged,
                      input_item_changed, p_item );
156 157
}

158 159 160
/*****************************************************************************
 * Playlist item creation
 *****************************************************************************/
161
playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
162
                                              input_item_t *p_input )
163
{
164 165 166
    playlist_item_t* p_item = malloc( sizeof( playlist_item_t ) );
    if( !p_item )
        return NULL;
167

168 169
    assert( p_input );

170 171
    p_item->p_input = p_input;
    vlc_gc_incref( p_item->p_input );
172

173
    p_item->i_id = ++pl_priv(p_playlist)->i_last_playlist_id;
174

175
    p_item->p_parent = NULL;
176 177 178
    p_item->i_children = -1;
    p_item->pp_children = NULL;
    p_item->i_flags = 0;
179
    p_item->p_playlist = p_playlist;
180

181
    install_input_item_observer( p_item );
182

183 184 185
    return p_item;
}

186 187 188 189
/***************************************************************************
 * Playlist item destruction
 ***************************************************************************/

190
/**
191
 * Release an item
192 193 194 195
 *
 * \param p_item item to delete
 * \return VLC_SUCCESS
*/
196
int playlist_ItemRelease( playlist_item_t *p_item )
197
{
198 199
    /* For the assert */
    playlist_t *p_playlist = p_item->p_playlist;
200 201
    PL_ASSERT_LOCKED;

202 203 204 205 206 207 208
    /* Surprise, we can't actually do more because we
     * don't do refcounting, or eauivalent.
     * Because item are not only accessed by their id
     * using playlist_item outside the PL_LOCK isn't safe.
     * Most of the modules does that.
     *
     * Who wants to add proper memory management? */
209
    uninstall_input_item_observer( p_item );
210
    ARRAY_APPEND( pl_priv(p_playlist)->items_to_delete, p_item);
211 212 213
    return VLC_SUCCESS;
}

214 215 216 217 218 219 220 221 222 223
/**
 * Delete input item
 *
 * Remove an input item when it appears from a root playlist item
 * \param p_playlist playlist object
 * \param i_input_id id of the input to delete
 * \param p_root root playlist item
 * \param b_do_stop must stop or not the playlist
 * \return VLC_SUCCESS or VLC_EGENERIC
*/
224
static int DeleteFromInput( playlist_t *p_playlist, int i_input_id,
225
                            playlist_item_t *p_root, bool b_do_stop )
226 227
{
    int i;
228
    PL_ASSERT_LOCKED;
229 230 231 232 233 234
    for( i = 0 ; i< p_root->i_children ; i++ )
    {
        if( p_root->pp_children[i]->i_children == -1 &&
            p_root->pp_children[i]->p_input->i_id == i_input_id )
        {
            DeleteInner( p_playlist, p_root->pp_children[i], b_do_stop );
235
            return VLC_SUCCESS;
236 237 238
        }
        else if( p_root->pp_children[i]->i_children >= 0 )
        {
239 240
            int i_ret = DeleteFromInput( p_playlist, i_input_id,
                                         p_root->pp_children[i], b_do_stop );
241
            if( i_ret == VLC_SUCCESS ) return VLC_SUCCESS;
242 243
        }
    }
244
    return VLC_EGENERIC;
245 246
}

247 248 249 250 251 252 253 254 255 256
/**
 * Delete input item
 *
 * Remove an input item when it appears from a root playlist item
 * \param p_playlist playlist object
 * \param i_input_id id of the input to delete
 * \param p_root root playlist item
 * \param b_locked TRUE if the playlist is locked
 * \return VLC_SUCCESS or VLC_EGENERIC
 */
257 258
int playlist_DeleteFromInputInParent( playlist_t *p_playlist, int i_input_id,
                                      playlist_item_t *p_root, bool b_locked )
259 260
{
    int i_ret;
261
    PL_LOCK_IF( !b_locked );
262
    i_ret = DeleteFromInput( p_playlist, i_input_id,
263
                             p_root, true );
264
    PL_UNLOCK_IF( !b_locked );
265 266 267
    return i_ret;
}

268 269 270 271 272 273 274 275 276
/**
 * Delete from input
 *
 * Remove an input item from ONELEVEL and CATEGORY
 * \param p_playlist playlist object
 * \param i_input_id id of the input to delete
 * \param b_locked TRUE if the playlist is locked
 * \return VLC_SUCCESS or VLC_ENOITEM
 */
277
int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
278
                              bool b_locked )
279
{
280
    int i_ret1, i_ret2;
281
    PL_LOCK_IF( !b_locked );
282
    i_ret1 = DeleteFromInput( p_playlist, i_input_id,
283
                             p_playlist->p_root_category, true );
284
    i_ret2 = DeleteFromInput( p_playlist, i_input_id,
285
                     p_playlist->p_root_onelevel, true );
286
    PL_UNLOCK_IF( !b_locked );
287 288
    return ( i_ret1 == VLC_SUCCESS || i_ret2 == VLC_SUCCESS ) ?
                            VLC_SUCCESS : VLC_ENOITEM;
289 290
}

291 292 293 294 295 296 297
/**
 * Clear the playlist
 *
 * \param p_playlist playlist object
 * \param b_locked TRUE if the playlist is locked
 * \return nothing
 */
298
void playlist_Clear( playlist_t * p_playlist, bool b_locked )
299
{
300
    PL_LOCK_IF( !b_locked );
301 302
    playlist_NodeEmpty( p_playlist, p_playlist->p_local_category, true );
    playlist_NodeEmpty( p_playlist, p_playlist->p_local_onelevel, true );
303
    PL_UNLOCK_IF( !b_locked );
304
}
305

306 307 308 309 310 311 312 313 314
/**
 * Delete playlist item
 *
 * Remove a playlist item from the playlist, given its id
 * This function is to be used only by the playlist
 * \param p_playlist playlist object
 * \param i_id id of the item do delete
 * \return VLC_SUCCESS or an error
 */
315
int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
316
{
317
    PL_ASSERT_LOCKED;
318
    playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id,
319
                                                    pl_Locked );
320
    if( !p_item ) return VLC_EGENERIC;
321
    return DeleteInner( p_playlist, p_item, true );
322 323 324 325 326
}

/***************************************************************************
 * Playlist item addition
 ***************************************************************************/
327 328 329 330
/**
 * Playlist add
 *
 * Add an item to the playlist or the media library
331 332 333 334 335 336
 * \param p_playlist the playlist to add into
 * \param psz_uri the mrl to add to the playlist
 * \param psz_name a text giving a name or description of this item
 * \param i_mode the mode used when adding
 * \param i_pos the position in the playlist where to add. If this is
 *        PLAYLIST_END the item will be added at the end of the playlist
337
 *        regardless of its size
338
 * \param b_playlist TRUE for playlist, FALSE for media library
339
 * \param b_locked TRUE if the playlist is locked
340
 * \return The id of the playlist item
341
 */
342 343
int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
                  const char *psz_name, int i_mode, int i_pos,
344
                  bool b_playlist, bool b_locked )
345
{
346
    return playlist_AddExt( p_playlist, psz_uri, psz_name,
347
                            i_mode, i_pos, -1, 0, NULL, 0, b_playlist, b_locked );
348
}
349

350
/**
351
 * Add a MRL into the playlist or the media library, duration and options given
352 353 354 355 356 357 358
 *
 * \param p_playlist the playlist to add into
 * \param psz_uri the mrl to add to the playlist
 * \param psz_name a text giving a name or description of this item
 * \param i_mode the mode used when adding
 * \param i_pos the position in the playlist where to add. If this is
 *        PLAYLIST_END the item will be added at the end of the playlist
359
 *        regardless of its size
360 361
 * \param i_duration length of the item in milliseconds.
 * \param i_options the number of options
362 363
 * \param ppsz_options an array of options
 * \param i_option_flags options flags
364
 * \param b_playlist TRUE for playlist, FALSE for media library
365
 * \param b_locked TRUE if the playlist is locked
366 367
 * \return The id of the playlist item
*/
368 369
int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
                     const char *psz_name, int i_mode, int i_pos,
370 371 372
                     mtime_t i_duration,
                     int i_options, const char *const *ppsz_options, unsigned i_option_flags,
                     bool b_playlist, bool b_locked )
373
{
374
    int i_ret;
375
    input_item_t *p_input = input_item_NewExt( p_playlist, psz_uri, psz_name,
376
                                              i_options, ppsz_options, i_option_flags,
377
                                              i_duration );
378

379 380
    i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
                               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 390 391 392 393 394 395 396 397 398
/**
 * Add an input item to the playlist node
 *
 * \param p_playlist the playlist to add into
 * \param p_input the input item to add
 * \param i_mode the mode used when adding
 * \param i_pos the position in the playlist where to add. If this is
 *        PLAYLIST_END the item will be added at the end of the playlist
 *        regardless of its size
 * \param b_playlist TRUE for playlist, FALSE for media library
 * \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 403
                       int i_mode, int i_pos, bool b_playlist,
                       bool b_locked )
404
{
Clément Stenac's avatar
Clément Stenac committed
405
    playlist_item_t *p_item_cat, *p_item_one;
406
    if( p_playlist->b_die ) return VLC_EGENERIC;
407
    if( !pl_priv(p_playlist)->b_doing_ml )
408 409
        PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
                                             p_input->psz_uri );
410

411
    PL_LOCK_IF( !b_locked );
412

413
    /* Add to ONELEVEL */
Clément Stenac's avatar
Clément Stenac committed
414
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
415
    if( p_item_one == NULL ) return VLC_ENOMEM;
416 417
    AddItem( p_playlist, p_item_one,
             b_playlist ? p_playlist->p_local_onelevel :
418
                          p_playlist->p_ml_onelevel , i_mode, i_pos );
419 420

    /* Add to CATEGORY */
Clément Stenac's avatar
Clément Stenac committed
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

Clément Stenac's avatar
Clément Stenac committed
427
    GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
428

429
    PL_UNLOCK_IF( !b_locked );
430 431 432
    return VLC_SUCCESS;
}

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
/**
 * Add input
 *
 * Add an input item to p_direct_parent in the category tree, and to the
 * matching top category in onelevel
 * \param p_playlist the playlist to add into
 * \param p_input the input item to add
 * \param p_direct_parent the parent item to add into
 * \param i_mode the mode used when adding
 * \param i_pos the position in the playlist where to add. If this is
 *        PLAYLIST_END the item will be added at the end of the playlist
 *        regardless of its size
 * \param i_cat id of the items category
 * \param i_one id of the item onelevel category
 * \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 451 452
int playlist_BothAddInput( playlist_t *p_playlist,
                           input_item_t *p_input,
                           playlist_item_t *p_direct_parent,
453
                           int i_mode, int i_pos,
454
                           int *i_cat, int *i_one, bool b_locked )
455
{
Clément Stenac's avatar
Clément Stenac committed
456
    playlist_item_t *p_item_cat, *p_item_one, *p_up;
457
    int i_top;
Clément Stenac's avatar
Clément Stenac committed
458
    assert( p_input );
459 460 461

    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;
462 463

    PL_LOCK_IF( !b_locked );
464

465
    /* Add to category */
Clément Stenac's avatar
Clément Stenac committed
466
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
467
    if( p_item_cat == NULL ) return VLC_ENOMEM;
468
    AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
469 470

    /* Add to onelevel */
471
    /** \todo make a faster case for ml import */
Clément Stenac's avatar
Clément Stenac committed
472
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
473
    if( p_item_one == NULL ) return VLC_ENOMEM;
474 475 476

    p_up = p_direct_parent;
    while( p_up->p_parent != p_playlist->p_root_category )
477
    {
478
        p_up = p_up->p_parent;
479
    }
480
    for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
Clément Stenac's avatar
Clément Stenac committed
481
    {
482 483
        if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id ==
                             p_up->p_input->i_id )
484
        {
Clément Stenac's avatar
Clément Stenac committed
485
            AddItem( p_playlist, p_item_one,
486 487
                     p_playlist->p_root_onelevel->pp_children[i_top],
                     i_mode, i_pos );
488 489
            break;
        }
Clément Stenac's avatar
Clément Stenac committed
490
    }
Clément Stenac's avatar
Clément Stenac committed
491
    GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
Clément Stenac's avatar
Clément Stenac committed
492

493 494 495
    if( i_cat ) *i_cat = p_item_cat->i_id;
    if( i_one ) *i_one = p_item_one->i_id;

496
    PL_UNLOCK_IF( !b_locked );
497
    return VLC_SUCCESS;
498
}
499

500 501 502 503 504 505 506 507 508 509 510 511 512
/**
 * Add an input item to a given node
 *
 * \param p_playlist the playlist to add into
 * \param p_input the input item to add
 * \param p_parent the parent item to add into
 * \param i_mode the mode used when addin
 * \param i_pos the position in the playlist where to add. If this is
 *        PLAYLIST_END the item will be added at the end of the playlist
 *        regardless of its size
 * \param b_locked TRUE if the playlist is locked
 * \return the new playlist item
 */
513 514 515
playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
                                         input_item_t *p_input,
                                         playlist_item_t *p_parent,
516
                                         int i_mode, int i_pos,
517
                                         bool b_locked )
518
{
519
    playlist_item_t *p_item;
Clément Stenac's avatar
Clément Stenac committed
520 521
    assert( p_input );
    assert( p_parent && p_parent->i_children != -1 );
522

523 524
    if( p_playlist->b_die )
        return NULL;
525
    PL_LOCK_IF( !b_locked );
526

527 528
    p_item = playlist_ItemNewFromInput( p_playlist, p_input );
    if( p_item == NULL ) return NULL;
529
    AddItem( p_playlist, p_item, p_parent, i_mode, i_pos );
530

531
    PL_UNLOCK_IF( !b_locked );
532 533

    return p_item;
534
}
535

536 537 538 539
/*****************************************************************************
 * Playlist item misc operations
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
540
/**
541 542
 * Item to node
 *
543 544
 * Transform an item to a node. Return the node in the category tree, or NULL
 * if not found there
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
545
 * This function must be entered without the playlist lock
546 547 548 549
 * \param p_playlist the playlist object
 * \param p_item the item to transform
 * \param b_locked TRUE if the playlist is locked
 * \return the item transform in a node
Clément Stenac's avatar
Clément Stenac committed
550
 */
551
playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
552
                                      playlist_item_t *p_item,
553
                                      bool b_locked )
Clément Stenac's avatar
Clément Stenac committed
554
{
555 556

    playlist_item_t *p_item_in_category;
557 558 559 560 561
    /* What we do
     * Find the input in CATEGORY.
     *  - If we find it
     *    - change it to node
     *    - we'll return it at the end
562 563
     *    - If we are a direct child of onelevel root, change to node, else
     *      delete the input from ONELEVEL
564 565 566 567 568 569 570
     *  - If we don't find it, just change to node (we are probably in VLM)
     *    and return NULL
     *
     * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
     * useful for later BothAddInput )
     */

571
    PL_LOCK_IF( !b_locked );
572

573
    /* Fast track the media library, no time to loose */
574
    if( p_item == p_playlist->p_ml_category ) {
575
        PL_UNLOCK_IF( !b_locked );
576
        return p_item;
577
    }
578

579
    /** \todo First look if we don't already have it */
580
    p_item_in_category = playlist_ItemFindFromInputAndRoot(
581
                                            p_playlist, p_item->p_input->i_id,
582
                                            p_playlist->p_root_category,
583
                                            true );
584 585

    if( p_item_in_category )
Clément Stenac's avatar
Clément Stenac committed
586
    {
587 588
        playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
                                            p_playlist, p_item->p_input->i_id,
589
                                            p_playlist->p_root_onelevel,
590
                                            true );
591 592
        assert( p_item_in_one );

593
        /* We already have it, and there is nothing more to do */
594
        ChangeToNode( p_playlist, p_item_in_category );
595

596
        /* Item in one is a root, change it to node */
597 598 599 600
        if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
            ChangeToNode( p_playlist, p_item_in_one );
        else
        {
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
            playlist_item_t *p_status_item = get_current_status_item( p_playlist );
            playlist_item_t *p_status_node = get_current_status_node( p_playlist );
            if( p_item_in_one == p_status_item )
            {
                /* We're deleting the current playlist item. Update
                 * the playlist object to point at the previous item
                 * so the playlist won't be restarted */
                playlist_item_t *p_prev_status_item = NULL;
                int i = 0;
                while( i < p_status_node->i_children &&
                       p_status_node->pp_children[i] != p_status_item )
                {
                    p_prev_status_item = p_status_node->pp_children[i];
                    i++;
                }
                if( i == p_status_node->i_children )
                    p_prev_status_item = NULL;
                if( p_prev_status_item )
                    set_current_status_item( p_playlist, p_prev_status_item );
            }
621
            DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
622
                             p_playlist->p_root_onelevel, false );
623
        }
624
        pl_priv(p_playlist)->b_reset_currently_playing = true;
625
        vlc_cond_signal( &pl_priv(p_playlist)->signal );
626 627
        var_SetInteger( p_playlist, "item-change", p_item_in_category->
                                                        p_input->i_id );
628
        PL_UNLOCK_IF( !b_locked );
629 630 631 632 633
        return p_item_in_category;
    }
    else
    {
        ChangeToNode( p_playlist, p_item );
634
        PL_UNLOCK_IF( !b_locked );
635
        return p_item;
Clément Stenac's avatar
Clément Stenac committed
636 637 638
    }
}

639 640 641 642 643 644 645
/**
 * Find an item within a root, given its input id.
 *
 * \param p_playlist the playlist object
 * \param i_input_id id of the input
 * \param p_root root playlist item
 * \param b_items_only TRUE if we want the item himself
646 647 648 649
 * \return the first found item, or NULL if not found
 */
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
                                                    int i_input_id,
650
                                                    playlist_item_t *p_root,
651
                                                    bool b_items_only )
652 653 654 655
{
    int i;
    for( i = 0 ; i< p_root->i_children ; i++ )
    {
656
        if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
657 658 659 660 661 662 663 664
            p_root->pp_children[i]->p_input->i_id == i_input_id )
        {
            return p_root->pp_children[i];
        }
        else if( p_root->pp_children[i]->i_children >= 0 )
        {
            playlist_item_t *p_search =
                 playlist_ItemFindFromInputAndRoot( p_playlist, i_input_id,
665 666
                                                    p_root->pp_children[i],
                                                    b_items_only );
667 668 669 670 671
            if( p_search ) return p_search;
        }
    }
    return NULL;
}
672 673


674 675 676 677 678
static int TreeMove( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_newpos )
{
    int j;
    playlist_item_t *p_detach = p_item->p_parent;
679 680
    (void)p_playlist;

681 682 683 684 685 686 687 688
    if( p_node->i_children == -1 ) return VLC_EGENERIC;

    for( j = 0; j < p_detach->i_children; j++ )
    {
         if( p_detach->pp_children[j] == p_item ) break;
    }
    REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );

Rémi Duraffort's avatar
Rémi Duraffort committed
689
    /* If j < i_newpos, we are moving the element from the top to the
690
     * down of the playlist. So when removing the element we have
Rémi Duraffort's avatar
Rémi Duraffort committed
691 692 693 694 695
     * to change the position as we loose one element
     */
    if( j < i_newpos )
        i_newpos--;

696 697 698 699 700 701 702
    /* Attach to new parent */
    INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
    p_item->p_parent = p_node;

    return VLC_SUCCESS;
}

703
/**
704 705 706
 * Moves an item
 *
 * This function must be entered with the playlist lock
707
 *
708 709 710 711 712
 * \param p_playlist the playlist
 * \param p_item the item to move
 * \param p_node the new parent of the item
 * \param i_newpos the new position under this new parent
 * \return VLC_SUCCESS or an error
713
 */
714 715 716
int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
                       playlist_item_t *p_node, int i_newpos )
{
717
    int i_ret;
718 719
    PL_ASSERT_LOCKED;

720 721 722
    /* Drop on a top level node. Move in the two trees */
    if( p_node->p_parent == p_playlist->p_root_category ||
        p_node->p_parent == p_playlist->p_root_onelevel )
723
    {
724 725
        /* Fixme: avoid useless lookups but we need some clean helpers */
        {
Clément Stenac's avatar
Clément Stenac committed
726 727 728 729
            /* Fixme: if we try to move a node on a top-level node, it will
             * fail because the node doesn't exist in onelevel and we will
             * do some shit in onelevel. We should recursively move all items
             * within the node */
730 731 732 733 734
            playlist_item_t *p_node_onelevel;
            playlist_item_t *p_item_onelevel;
            p_node_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_node->p_input->i_id,
                                                p_playlist->p_root_onelevel,
735
                                                false );
736 737 738
            p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_onelevel,
739
                                                false );
Clément Stenac's avatar
Clément Stenac committed
740
            if( p_node_onelevel && p_item_onelevel )
Rémi Duraffort's avatar
Rémi Duraffort committed
741
                TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, i_newpos );
742 743 744 745 746 747 748
        }
        {
            playlist_item_t *p_node_category;
            playlist_item_t *p_item_category;
            p_node_category = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_node->p_input->i_id,
                                                p_playlist->p_root_category,
749
                                                false );
750 751 752
            p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_category,
753
                                                false );
Clément Stenac's avatar
Clément Stenac committed
754
            if( p_node_category && p_item_category )
755
                TreeMove( p_playlist, p_item_category, p_node_category, 0 );
756
        }
757
        i_ret = VLC_SUCCESS;
758
    }
759
    else
760
        i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
761
    pl_priv(p_playlist)->b_reset_currently_playing = true;
762
    vlc_cond_signal( &pl_priv(p_playlist)->signal );
763
    return i_ret;
764 765
}

766 767
/**
 * Send a notification that an item has been added to a node
Rémi Duraffort's avatar
Rémi Duraffort committed
768
 *
769 770 771 772 773 774
 * \param p_playlist the playlist object
 * \param i_item_id id of the item added
 * \param i_node_id id of the node in wich the item was added
 * \param b_signal TRUE if the function must send a signal
 * \return nothing
 */
775
void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
776
                             int i_node_id, bool b_signal )
777 778
{
    vlc_value_t val;
779 780
    PL_ASSERT_LOCKED;

781
    playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
782 783 784
    if( !p_add )
        return;

785 786 787
    p_add->i_item = i_item_id;
    p_add->i_node = i_node_id;
    val.p_address = p_add;
788
    pl_priv(p_playlist)->b_reset_currently_playing = true;
789
    if( b_signal )
790
        vlc_cond_signal( &pl_priv(p_playlist)->signal );
791

792 793 794 795 796 797 798 799 800
    var_Set( p_playlist, "item-append", val );
    free( p_add );
}

/***************************************************************************
 * The following functions are local
 ***************************************************************************/

/* Enqueue an item for preparsing, and play it, if needed */
801 802 803
static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
                           playlist_item_t *p_item_cat,
                           playlist_item_t *p_item_one )
804
{
805
    PL_ASSERT_LOCKED;
Clément Stenac's avatar
Clément Stenac committed
806
    if( (i_mode & PLAYLIST_GO ) )
807
    {
Clément Stenac's avatar
Clément Stenac committed
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
        playlist_item_t *p_parent = p_item_one;
        playlist_item_t *p_toplay = NULL;
        while( p_parent )
        {
            if( p_parent == p_playlist->p_root_category )
            {
                p_toplay = p_item_cat; break;
            }
            else if( p_parent == p_playlist->p_root_onelevel )
            {
                p_toplay = p_item_one; break;
            }
            p_parent = p_parent->p_parent;
        }
        assert( p_toplay );
823 824 825 826 827 828
        pl_priv(p_playlist)->request.b_request = true;
        pl_priv(p_playlist)->request.i_skip = 0;
        pl_priv(p_playlist)->request.p_item = p_toplay;
        if( pl_priv(p_playlist)->p_input )
            input_StopThread( pl_priv(p_playlist)->p_input );
        pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
829
        vlc_cond_signal( &pl_priv(p_playlist)->signal );
830
    }
831
    /* Preparse if PREPARSE or SPREPARSE & not enough meta */
832 833
    char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
    char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
834
    if( pl_priv(p_playlist)->b_auto_preparse &&
835 836
          (i_mode & PLAYLIST_PREPARSE ||
          ( i_mode & PLAYLIST_SPREPARSE &&
837
            ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
838
          ) ) )
839
        playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input, pl_Locked );
840
    /* If we already have it, signal it */
841
    else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
842
        input_item_SetPreparsed( p_item_cat->p_input, true );
843 844
    free( psz_artist );
    free( psz_album );
845 846 847
}

/* Add the playlist item to the requested node and fire a notification */
848 849
static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_mode, int i_pos )
850
{
851
    PL_ASSERT_LOCKED;
Clément Stenac's avatar
Clément Stenac committed
852 853
    ARRAY_APPEND(p_playlist->items, p_item);
    ARRAY_APPEND(p_playlist->all_items, p_item);
854 855 856 857 858

    if( i_pos == PLAYLIST_END )
        playlist_NodeAppend( p_playlist, p_item, p_node );
    else
        playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
Clément Stenac's avatar
Clément Stenac committed
859

860
    if( !pl_priv(p_playlist)->b_doing_ml )
861 862
        playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
                                 !( i_mode & PLAYLIST_NO_REBUILD ) );
863 864 865
}

/* Actually convert an item to a node */
866
static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
867 868 869 870 871 872
{
    int i;
    if( p_item->i_children == -1 )
        p_item->i_children = 0;

    /* Remove it from the array of available items */
Clément Stenac's avatar
Clément Stenac committed
873 874 875
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );
876 877 878
}

/* Do the actual removal */
879
static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
880
                        bool b_stop )
881
{
Clément Stenac's avatar
Clément Stenac committed
882
    int i;
883
    int i_id = p_item->i_id;
884
    PL_ASSERT_LOCKED;
885 886 887

    if( p_item->i_children > -1 )
    {
888
        return playlist_NodeDelete( p_playlist, p_item, true, false );
889
    }
890
    pl_priv(p_playlist)->b_reset_currently_playing = true;
891 892 893
    var_SetInteger( p_playlist, "item-deleted", i_id );

    /* Remove the item from the bank */
Clément Stenac's avatar
Clément Stenac committed
894 895 896
    ARRAY_BSEARCH( p_playlist->all_items,->i_id, int, i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->all_items, i );
Clément Stenac's avatar
Clément Stenac committed
897

898 899 900 901
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );

902
    /* Check if it is the current item */
903
    if( get_current_status_item( p_playlist ) == p_item )
904
    {
905 906
        /* Hack we don't call playlist_Control for lock reasons */
        if( b_stop )
907
        {
908 909 910
            pl_priv(p_playlist)->request.i_status = PLAYLIST_STOPPED;
            pl_priv(p_playlist)->request.b_request = true;
            pl_priv(p_playlist)->request.p_item = NULL;
911
            msg_Info( p_playlist, "stopping playback" );
912
            vlc_cond_signal( &pl_priv(p_playlist)->signal );
913 914
        }
    }
915

916
    PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
917 918 919 920

    /* Remove the item from its parent */
    playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );

921
    playlist_ItemRelease( p_item );
922 923

    return VLC_SUCCESS;
924
}