item.c 34.3 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 190 191 192 193 194
playlist_item_t * playlist_ItemNewWithType( playlist_t *p_playlist,
                                            const char *psz_uri,
                                            const char *psz_name,
                                            int i_options,
                                            const char *const *ppsz_options,
                                            int i_duration, int i_type )
{
    input_item_t *p_input;
    if( psz_uri == NULL ) return NULL;
195
    p_input = input_item_NewWithType( VLC_OBJECT(p_playlist), psz_uri,
196 197 198 199 200
                                     psz_name, i_options, ppsz_options,
                                     i_duration, i_type );
    return playlist_ItemNewFromInput( p_playlist, p_input );
}

201 202 203 204
/***************************************************************************
 * Playlist item destruction
 ***************************************************************************/

205
/**
206
 * Release an item
207 208 209 210
 *
 * \param p_item item to delete
 * \return VLC_SUCCESS
*/
211
int playlist_ItemRelease( playlist_item_t *p_item )
212
{
213 214
    /* For the assert */
    playlist_t *p_playlist = p_item->p_playlist;
215 216
    PL_ASSERT_LOCKED;

217 218 219 220 221 222 223
    /* 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? */
224
    uninstall_input_item_observer( p_item );
225
    ARRAY_APPEND( pl_priv(p_playlist)->items_to_delete, p_item);
226 227 228
    return VLC_SUCCESS;
}

229 230 231 232 233 234 235 236 237 238
/**
 * 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
*/
239
static int DeleteFromInput( playlist_t *p_playlist, int i_input_id,
240
                            playlist_item_t *p_root, bool b_do_stop )
241 242
{
    int i;
243
    PL_ASSERT_LOCKED;
244 245 246 247 248 249
    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 );
250
            return VLC_SUCCESS;
251 252 253
        }
        else if( p_root->pp_children[i]->i_children >= 0 )
        {
254 255
            int i_ret = DeleteFromInput( p_playlist, i_input_id,
                                         p_root->pp_children[i], b_do_stop );
256
            if( i_ret == VLC_SUCCESS ) return VLC_SUCCESS;
257 258
        }
    }
259
    return VLC_EGENERIC;
260 261
}

262 263 264 265 266 267 268 269 270 271
/**
 * 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
 */
272 273
int playlist_DeleteFromInputInParent( playlist_t *p_playlist, int i_input_id,
                                      playlist_item_t *p_root, bool b_locked )
274 275
{
    int i_ret;
276
    PL_LOCK_IF( !b_locked );
277
    i_ret = DeleteFromInput( p_playlist, i_input_id,
278
                             p_root, true );
279
    PL_UNLOCK_IF( !b_locked );
280 281 282
    return i_ret;
}

283 284 285 286 287 288 289 290 291
/**
 * 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
 */
292
int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
293
                              bool b_locked )
294
{
295
    int i_ret1, i_ret2;
296
    PL_LOCK_IF( !b_locked );
297
    i_ret1 = DeleteFromInput( p_playlist, i_input_id,
298
                             p_playlist->p_root_category, true );
299
    i_ret2 = DeleteFromInput( p_playlist, i_input_id,
300
                     p_playlist->p_root_onelevel, true );
301
    PL_UNLOCK_IF( !b_locked );
302 303
    return ( i_ret1 == VLC_SUCCESS || i_ret2 == VLC_SUCCESS ) ?
                            VLC_SUCCESS : VLC_ENOITEM;
304 305
}

306 307 308 309 310 311 312
/**
 * Clear the playlist
 *
 * \param p_playlist playlist object
 * \param b_locked TRUE if the playlist is locked
 * \return nothing
 */
313
void playlist_Clear( playlist_t * p_playlist, bool b_locked )
314
{
315
    PL_LOCK_IF( !b_locked );
316 317
    playlist_NodeEmpty( p_playlist, p_playlist->p_local_category, true );
    playlist_NodeEmpty( p_playlist, p_playlist->p_local_onelevel, true );
318
    PL_UNLOCK_IF( !b_locked );
319
}
320

321 322 323 324 325 326 327 328 329
/**
 * 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
 */
330
int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
331
{
332
    PL_ASSERT_LOCKED;
333
    playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id,
334
                                                    pl_Locked );
335
    if( !p_item ) return VLC_EGENERIC;
336
    return DeleteInner( p_playlist, p_item, true );
337 338 339 340 341
}

/***************************************************************************
 * Playlist item addition
 ***************************************************************************/
342 343 344 345
/**
 * Playlist add
 *
 * Add an item to the playlist or the media library
346 347 348 349 350 351
 * \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
352
 *        regardless of its size
353
 * \param b_playlist TRUE for playlist, FALSE for media library
354
 * \param b_locked TRUE if the playlist is locked
355
 * \return The id of the playlist item
356
 */
357 358
int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
                  const char *psz_name, int i_mode, int i_pos,
359
                  bool b_playlist, bool b_locked )
360
{
361
    return playlist_AddExt( p_playlist, psz_uri, psz_name,
362
                            i_mode, i_pos, -1, NULL, 0, b_playlist, b_locked );
363
}
364

365
/**
366
 * Add a MRL into the playlist or the media library, duration and options given
367 368 369 370 371 372 373
 *
 * \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
374
 *        regardless of its size
375 376 377
 * \param i_duration length of the item in milliseconds.
 * \param ppsz_options an array of options
 * \param i_options the number of options
378
 * \param b_playlist TRUE for playlist, FALSE for media library
379
 * \param b_locked TRUE if the playlist is locked
380 381
 * \return The id of the playlist item
*/
382 383
int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
                     const char *psz_name, int i_mode, int i_pos,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
384
                     mtime_t i_duration, const char *const *ppsz_options,
385
                     int i_options, bool b_playlist, bool b_locked )
386
{
387
    int i_ret;
388
    input_item_t *p_input = input_item_NewExt( p_playlist, psz_uri, psz_name,
389 390
                                              i_options, ppsz_options,
                                              i_duration );
391

392 393
    i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
                               b_locked );
394
    int i_id = (i_ret == VLC_SUCCESS) ? p_input->i_id : -1;
395

396
    vlc_gc_decref( p_input );
397 398

    return i_id;
399
}
400

401 402 403 404 405 406 407 408 409 410 411
/**
 * 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
412
 * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
413
*/
414
int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
415 416
                       int i_mode, int i_pos, bool b_playlist,
                       bool b_locked )
417
{
Clément Stenac's avatar
Clément Stenac committed
418
    playlist_item_t *p_item_cat, *p_item_one;
419
    if( p_playlist->b_die ) return VLC_EGENERIC;
420
    if( !pl_priv(p_playlist)->b_doing_ml )
421 422
        PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
                                             p_input->psz_uri );
423

424
    PL_LOCK_IF( !b_locked );
425

426
    /* Add to ONELEVEL */
Clément Stenac's avatar
Clément Stenac committed
427
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
428
    if( p_item_one == NULL ) return VLC_ENOMEM;
429 430
    AddItem( p_playlist, p_item_one,
             b_playlist ? p_playlist->p_local_onelevel :
431
                          p_playlist->p_ml_onelevel , i_mode, i_pos );
432 433

    /* Add to CATEGORY */
Clément Stenac's avatar
Clément Stenac committed
434
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
435
    if( p_item_cat == NULL ) return VLC_ENOMEM;
436
    AddItem( p_playlist, p_item_cat,
437
             b_playlist ? p_playlist->p_local_category :
438
                          p_playlist->p_ml_category , i_mode, i_pos );
439

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

442
    PL_UNLOCK_IF( !b_locked );
443 444 445
    return VLC_SUCCESS;
}

446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
/**
 * 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
461
 * \return VLC_SUCCESS if success, VLC_EGENERIC if fail, VLC_ENOMEM if OOM
462
 */
463 464 465
int playlist_BothAddInput( playlist_t *p_playlist,
                           input_item_t *p_input,
                           playlist_item_t *p_direct_parent,
466
                           int i_mode, int i_pos,
467
                           int *i_cat, int *i_one, bool b_locked )
468
{
Clément Stenac's avatar
Clément Stenac committed
469
    playlist_item_t *p_item_cat, *p_item_one, *p_up;
470
    int i_top;
Clément Stenac's avatar
Clément Stenac committed
471
    assert( p_input );
472 473 474

    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;
475 476

    PL_LOCK_IF( !b_locked );
477

478
    /* Add to category */
Clément Stenac's avatar
Clément Stenac committed
479
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
480
    if( p_item_cat == NULL ) return VLC_ENOMEM;
481
    AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
482 483

    /* Add to onelevel */
484
    /** \todo make a faster case for ml import */
Clément Stenac's avatar
Clément Stenac committed
485
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
486
    if( p_item_one == NULL ) return VLC_ENOMEM;
487 488 489

    p_up = p_direct_parent;
    while( p_up->p_parent != p_playlist->p_root_category )
490
    {
491
        p_up = p_up->p_parent;
492
    }
493
    for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
Clément Stenac's avatar
Clément Stenac committed
494
    {
495 496
        if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id ==
                             p_up->p_input->i_id )
497
        {
Clément Stenac's avatar
Clément Stenac committed
498
            AddItem( p_playlist, p_item_one,
499 500
                     p_playlist->p_root_onelevel->pp_children[i_top],
                     i_mode, i_pos );
501 502
            break;
        }
Clément Stenac's avatar
Clément Stenac committed
503
    }
Clément Stenac's avatar
Clément Stenac committed
504
    GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
Clément Stenac's avatar
Clément Stenac committed
505

506 507 508
    if( i_cat ) *i_cat = p_item_cat->i_id;
    if( i_one ) *i_one = p_item_one->i_id;

509
    PL_UNLOCK_IF( !b_locked );
510
    return VLC_SUCCESS;
511
}
512

513 514 515 516 517 518 519 520 521 522 523 524 525
/**
 * 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
 */
526 527 528
playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
                                         input_item_t *p_input,
                                         playlist_item_t *p_parent,
529
                                         int i_mode, int i_pos,
530
                                         bool b_locked )
531
{
532
    playlist_item_t *p_item;
Clément Stenac's avatar
Clément Stenac committed
533 534
    assert( p_input );
    assert( p_parent && p_parent->i_children != -1 );
535

536 537
    if( p_playlist->b_die )
        return NULL;
538
    PL_LOCK_IF( !b_locked );
539

540 541
    p_item = playlist_ItemNewFromInput( p_playlist, p_input );
    if( p_item == NULL ) return NULL;
542
    AddItem( p_playlist, p_item, p_parent, i_mode, i_pos );
543

544
    PL_UNLOCK_IF( !b_locked );
545 546

    return p_item;
547
}
548

549 550 551 552
/*****************************************************************************
 * Playlist item misc operations
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
553
/**
554 555
 * Item to node
 *
556 557
 * 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
558
 * This function must be entered without the playlist lock
559 560 561 562
 * \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
563
 */
564
playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
565
                                      playlist_item_t *p_item,
566
                                      bool b_locked )
Clément Stenac's avatar
Clément Stenac committed
567
{
568 569

    playlist_item_t *p_item_in_category;
570 571 572 573 574
    /* What we do
     * Find the input in CATEGORY.
     *  - If we find it
     *    - change it to node
     *    - we'll return it at the end
575 576
     *    - If we are a direct child of onelevel root, change to node, else
     *      delete the input from ONELEVEL
577 578 579 580 581 582 583
     *  - 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 )
     */

584
    PL_LOCK_IF( !b_locked );
585

586
    /* Fast track the media library, no time to loose */
587
    if( p_item == p_playlist->p_ml_category ) {
588
        PL_UNLOCK_IF( !b_locked );
589
        return p_item;
590
    }
591

592
    /** \todo First look if we don't already have it */
593
    p_item_in_category = playlist_ItemFindFromInputAndRoot(
594
                                            p_playlist, p_item->p_input->i_id,
595
                                            p_playlist->p_root_category,
596
                                            true );
597 598

    if( p_item_in_category )
Clément Stenac's avatar
Clément Stenac committed
599
    {
600 601
        playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
                                            p_playlist, p_item->p_input->i_id,
602
                                            p_playlist->p_root_onelevel,
603
                                            true );
604 605
        assert( p_item_in_one );

606
        /* We already have it, and there is nothing more to do */
607
        ChangeToNode( p_playlist, p_item_in_category );
608

609
        /* Item in one is a root, change it to node */
610 611 612 613
        if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
            ChangeToNode( p_playlist, p_item_in_one );
        else
        {
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
            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 );
            }
634
            DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
635
                             p_playlist->p_root_onelevel, false );
636
        }
637
        pl_priv(p_playlist)->b_reset_currently_playing = true;
638
        vlc_object_signal_unlocked( p_playlist );
639 640
        var_SetInteger( p_playlist, "item-change", p_item_in_category->
                                                        p_input->i_id );
641
        PL_UNLOCK_IF( !b_locked );
642 643 644 645 646
        return p_item_in_category;
    }
    else
    {
        ChangeToNode( p_playlist, p_item );
647
        PL_UNLOCK_IF( !b_locked );
648
        return p_item;
Clément Stenac's avatar
Clément Stenac committed
649 650 651
    }
}

652 653 654 655 656 657 658
/**
 * 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
659 660 661 662
 * \return the first found item, or NULL if not found
 */
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
                                                    int i_input_id,
663
                                                    playlist_item_t *p_root,
664
                                                    bool b_items_only )
665 666 667 668
{
    int i;
    for( i = 0 ; i< p_root->i_children ; i++ )
    {
669
        if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
670 671 672 673 674 675 676 677
            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,
678 679
                                                    p_root->pp_children[i],
                                                    b_items_only );
680 681 682 683 684
            if( p_search ) return p_search;
        }
    }
    return NULL;
}
685 686


687 688 689 690 691
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;
692 693
    (void)p_playlist;

694 695 696 697 698 699 700 701
    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
702 703 704 705 706 707 708
    /* If j < i_newpos, we are moving the element from the top to the
     * down of the playlist. So when removing the element we change have
     * to change the position as we loose one element
     */
    if( j < i_newpos )
        i_newpos--;

709 710 711 712 713 714 715
    /* 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;
}

716
/**
717 718 719
 * Moves an item
 *
 * This function must be entered with the playlist lock
720
 *
721 722 723 724 725
 * \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
726
 */
727 728 729
int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
                       playlist_item_t *p_node, int i_newpos )
{
730
    int i_ret;
731 732
    PL_ASSERT_LOCKED;

733 734 735
    /* 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 )
736
    {
737 738
        /* Fixme: avoid useless lookups but we need some clean helpers */
        {
Clément Stenac's avatar
Clément Stenac committed
739 740 741 742
            /* 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 */
743 744 745 746 747
            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,
748
                                                false );
749 750 751
            p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_onelevel,
752
                                                false );
Clément Stenac's avatar
Clément Stenac committed
753
            if( p_node_onelevel && p_item_onelevel )
Rémi Duraffort's avatar
Rémi Duraffort committed
754
                TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, i_newpos );
755 756 757 758 759 760 761
        }
        {
            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,
762
                                                false );
763 764 765
            p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_category,
766
                                                false );
Clément Stenac's avatar
Clément Stenac committed
767
            if( p_node_category && p_item_category )
768
                TreeMove( p_playlist, p_item_category, p_node_category, 0 );
769
        }
770
        i_ret = VLC_SUCCESS;
771
    }
772
    else
773
        i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
774
    pl_priv(p_playlist)->b_reset_currently_playing = true;
775
    vlc_object_signal_unlocked( p_playlist );
776
    return i_ret;
777 778
}

779 780
/**
 * Send a notification that an item has been added to a node
Rémi Duraffort's avatar
Rémi Duraffort committed
781
 *
782 783 784 785 786 787
 * \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
 */
788
void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
789
                             int i_node_id, bool b_signal )
790 791
{
    vlc_value_t val;
792 793
    PL_ASSERT_LOCKED;

794
    playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
795 796 797
    if( !p_add )
        return;

798 799 800
    p_add->i_item = i_item_id;
    p_add->i_node = i_node_id;
    val.p_address = p_add;
801
    pl_priv(p_playlist)->b_reset_currently_playing = true;
802
    if( b_signal )
803 804
        vlc_object_signal_unlocked( p_playlist );

805 806 807 808 809 810 811 812 813
    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 */
814 815 816
static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
                           playlist_item_t *p_item_cat,
                           playlist_item_t *p_item_one )
817
{
818
    PL_ASSERT_LOCKED;
Clément Stenac's avatar
Clément Stenac committed
819
    if( (i_mode & PLAYLIST_GO ) )
820
    {
Clément Stenac's avatar
Clément Stenac committed
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
        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 );
836 837 838 839 840 841
        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;
842
        vlc_object_signal_unlocked( p_playlist );
843
    }
844
    /* Preparse if PREPARSE or SPREPARSE & not enough meta */
845 846
    char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
    char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
847
    if( pl_priv(p_playlist)->b_auto_preparse &&
848 849
          (i_mode & PLAYLIST_PREPARSE ||
          ( i_mode & PLAYLIST_SPREPARSE &&
850
            ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
851
          ) ) )
Clément Stenac's avatar
Clément Stenac committed
852
        playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
853
    /* If we already have it, signal it */
854
    else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
855
        input_item_SetPreparsed( p_item_cat->p_input, true );
856 857
    free( psz_artist );
    free( psz_album );
858 859 860
}

/* Add the playlist item to the requested node and fire a notification */
861 862
static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_mode, int i_pos )
863
{
864
    PL_ASSERT_LOCKED;
Clément Stenac's avatar
Clément Stenac committed
865 866
    ARRAY_APPEND(p_playlist->items, p_item);
    ARRAY_APPEND(p_playlist->all_items, p_item);
867 868 869 870 871

    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
872

873
    if( !pl_priv(p_playlist)->b_doing_ml )
874 875
        playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
                                 !( i_mode & PLAYLIST_NO_REBUILD ) );
876 877 878
}

/* Actually convert an item to a node */
879
static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
880 881 882 883 884 885
{
    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
886 887 888
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );
889 890 891
}

/* Do the actual removal */
892
static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
893
                        bool b_stop )
894
{
Clément Stenac's avatar
Clément Stenac committed
895
    int i;
896
    int i_id = p_item->i_id;
897
    PL_ASSERT_LOCKED;
898 899 900

    if( p_item->i_children > -1 )
    {
901
        return playlist_NodeDelete( p_playlist, p_item, true, false );
902
    }
903
    pl_priv(p_playlist)->b_reset_currently_playing = true;
904 905 906
    var_SetInteger( p_playlist, "item-deleted", i_id );

    /* Remove the item from the bank */
Clément Stenac's avatar
Clément Stenac committed
907 908 909
    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
910

911 912 913 914
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );

915
    /* Check if it is the current item */
916
    if( get_current_status_item( p_playlist ) == p_item )
917
    {
918 919
        /* Hack we don't call playlist_Control for lock reasons */
        if( b_stop )
920
        {
921 922 923
            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;
924
            msg_Info( p_playlist, "stopping playback" );
925
            vlc_object_signal_unlocked( VLC_OBJECT(p_playlist) );
926 927
        }
    }
928

929
    PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
930 931 932 933

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

934
    playlist_ItemRelease( p_item );
935 936

    return VLC_SUCCESS;
937
}