item.c 34.6 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
    DECMALLOC_NULL( p_item, playlist_item_t );
165

166 167
    assert( p_input );

168 169
    p_item->p_input = p_input;
    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 175 176
    p_item->i_children = -1;
    p_item->pp_children = NULL;
    p_item->i_flags = 0;
177
    p_item->p_playlist = p_playlist;
178

179
    install_input_item_observer( p_item );
180

181 182 183
    return p_item;
}

184 185 186 187 188 189 190 191 192
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;
193
    p_input = input_item_NewWithType( VLC_OBJECT(p_playlist), psz_uri,
194 195 196 197 198
                                     psz_name, i_options, ppsz_options,
                                     i_duration, i_type );
    return playlist_ItemNewFromInput( p_playlist, p_input );
}

199 200 201 202
/***************************************************************************
 * Playlist item destruction
 ***************************************************************************/

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

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

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

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

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

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

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

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

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

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

394
    vlc_gc_decref( p_input );
395 396

    return i_id;
397
}
398

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

422
    PL_LOCK_IF( !b_locked );
423

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

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

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

440
    PL_UNLOCK_IF( !b_locked );
441 442 443
    return VLC_SUCCESS;
}

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

    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;
473 474

    PL_LOCK_IF( !b_locked );
475

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

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

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

504 505 506
    if( i_cat ) *i_cat = p_item_cat->i_id;
    if( i_one ) *i_one = p_item_one->i_id;

507
    PL_UNLOCK_IF( !b_locked );
508
    return VLC_SUCCESS;
509
}
510

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

534 535
    if( p_playlist->b_die )
        return NULL;
536
    PL_LOCK_IF( !b_locked );
537

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

542
    PL_UNLOCK_IF( !b_locked );
543 544

    return p_item;
545
}
546

547 548 549 550
/*****************************************************************************
 * Playlist item misc operations
 *****************************************************************************/

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

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

582
    PL_LOCK_IF( !b_locked );
583

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

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

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

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

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

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


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

692 693 694 695 696 697 698 699
    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
700 701 702 703 704 705 706
    /* 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--;

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

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

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

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

792
    playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
793 794 795
    if( !p_add )
        return;

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

803 804 805 806 807 808 809 810
    var_Set( p_playlist, "item-append", val );
    free( p_add );
}

/*****************************************************************************
 * Playlist item accessors
 *****************************************************************************/

811 812 813 814 815 816 817
/**
 * Set the name of a playlist item
 *
 * \param p_item the item
 * \param psz_name the name
 * \return VLC_SUCCESS or VLC_EGENERIC
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
818
int playlist_ItemSetName( playlist_item_t *p_item, const char *psz_name )
819 820 821
{
    if( psz_name && p_item )
    {
822
        input_item_SetName( p_item->p_input, psz_name );
823 824 825 826 827
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}

828 829 830 831 832
/***************************************************************************
 * The following functions are local
 ***************************************************************************/

/* Enqueue an item for preparsing, and play it, if needed */
833 834 835
static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
                           playlist_item_t *p_item_cat,
                           playlist_item_t *p_item_one )
836
{
837
    PL_ASSERT_LOCKED;
Clément Stenac's avatar
Clément Stenac committed
838
    if( (i_mode & PLAYLIST_GO ) )
839
    {
Clément Stenac's avatar
Clément Stenac committed
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
        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 );
855
        p_playlist->request.b_request = true;
856
        p_playlist->request.i_skip = 0;
Clément Stenac's avatar
Clément Stenac committed
857
        p_playlist->request.p_item = p_toplay;
858 859
        if( p_playlist->p_input )
            input_StopThread( p_playlist->p_input );
Clément Stenac's avatar
Clément Stenac committed
860
        p_playlist->request.i_status = PLAYLIST_RUNNING;
861
        vlc_object_signal_unlocked( p_playlist );
862
    }
863
    /* Preparse if PREPARSE or SPREPARSE & not enough meta */
864 865
    char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
    char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
866 867 868
    if( p_playlist->b_auto_preparse &&
          (i_mode & PLAYLIST_PREPARSE ||
          ( i_mode & PLAYLIST_SPREPARSE &&
869
            ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
870
          ) ) )
Clément Stenac's avatar
Clément Stenac committed
871
        playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
872
    /* If we already have it, signal it */
873
    else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
874
        input_item_SetPreparsed( p_item_cat->p_input, true );
875 876
    free( psz_artist );
    free( psz_album );
877 878 879
}

/* Add the playlist item to the requested node and fire a notification */
880 881
static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_mode, int i_pos )
882
{
883
    PL_ASSERT_LOCKED;
Clément Stenac's avatar
Clément Stenac committed
884 885
    ARRAY_APPEND(p_playlist->items, p_item);
    ARRAY_APPEND(p_playlist->all_items, p_item);
886 887 888 889 890

    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
891

892
    if( !p_playlist->b_doing_ml )
893 894
        playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
                                 !( i_mode & PLAYLIST_NO_REBUILD ) );
895 896 897
}

/* Actually convert an item to a node */
898
static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
899 900 901 902 903 904
{
    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
905 906 907
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );
908 909 910
}

/* Do the actual removal */
911
static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
912
                        bool b_stop )
913
{
Clément Stenac's avatar
Clément Stenac committed
914
    int i;
915
    int i_id = p_item->i_id;
916
    PL_ASSERT_LOCKED;
917 918 919

    if( p_item->i_children > -1 )
    {
920
        return playlist_NodeDelete( p_playlist, p_item, true, false );
921
    }
922
    p_playlist->b_reset_currently_playing = true;
923 924 925
    var_SetInteger( p_playlist, "item-deleted", i_id );

    /* Remove the item from the bank */
Clément Stenac's avatar
Clément Stenac committed
926 927 928
    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
929

930 931 932 933
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );

934
    /* Check if it is the current item */
935
    if( get_current_status_item( p_playlist ) == p_item )
936
    {
937 938
        /* Hack we don't call playlist_Control for lock reasons */
        if( b_stop )
939
        {
940
            p_playlist->request.i_status = PLAYLIST_STOPPED;
941
            p_playlist->request.b_request = true;
942 943
            p_playlist->request.p_item = NULL;
            msg_Info( p_playlist, "stopping playback" );
944
            vlc_object_signal_unlocked( VLC_OBJECT(p_playlist) );
945 946
        }
    }
947

948
    PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
949 950 951 952

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

953
    playlist_ItemRelease( p_item );
954 955

    return VLC_SUCCESS;
956
}