item.c 33.1 KB
Newer Older
1
/*****************************************************************************
2
 * item.c : Playlist item creation/deletion/add/removal functions
3
 *****************************************************************************
4
 * Copyright (C) 1999-2007 the VideoLAN team
zorglub's avatar
zorglub committed
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
dionoea's avatar
dionoea 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>
zorglub's avatar
zorglub 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 );
zorglub's avatar
zorglub committed
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
(oops).    
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
(oops).    
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,
ivoire's avatar
ivoire committed
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,
ivoire's avatar
ivoire committed
97
                NULL, NULL, pl_Locked );
98

99
        if( i_ret == VLC_SUCCESS && b_play )
100
101
        {
            playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
ivoire's avatar
ivoire committed
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 );
zorglub's avatar
zorglub committed
165

166
167
    p_item->p_input = p_input;
    vlc_gc_incref( p_item->p_input );
168

169
    p_item->i_id = ++p_playlist->i_last_playlist_id;
zorglub's avatar
zorglub committed
170

171
    p_item->p_parent = NULL;
zorglub's avatar
zorglub committed
172
173
174
    p_item->i_children = -1;
    p_item->pp_children = NULL;
    p_item->i_flags = 0;
175
    p_item->p_playlist = p_playlist;
zorglub's avatar
zorglub committed
176

177
    install_input_item_observer( p_item );
178

179
180
181
    return p_item;
}

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

197
198
199
200
/***************************************************************************
 * Playlist item destruction
 ***************************************************************************/

201
/**
202
 * Release an item
203
204
205
206
 *
 * \param p_item item to delete
 * \return VLC_SUCCESS
*/
207
int playlist_ItemRelease( playlist_item_t *p_item )
208
{
209
210
211
212
213
214
215
216
    /* 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? */
    ARRAY_APPEND( p_item->p_playlist->items_to_delete, p_item);
217
218
219
    return VLC_SUCCESS;
}

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

252
253
254
255
256
257
258
259
260
261
/**
 * 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
 */
262
263
int playlist_DeleteFromInputInParent( playlist_t *p_playlist, int i_input_id,
                                      playlist_item_t *p_root, bool b_locked )
264
265
{
    int i_ret;
266
    PL_LOCK_IF( !b_locked );
267
    i_ret = DeleteFromInput( p_playlist, i_input_id,
268
                             p_root, true );
269
    PL_UNLOCK_IF( !b_locked );
270
271
272
    return i_ret;
}

273
274
275
276
277
278
279
280
281
/**
 * 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
 */
282
int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
283
                              bool b_locked )
284
{
285
    int i_ret1, i_ret2;
286
    PL_LOCK_IF( !b_locked );
287
    i_ret1 = DeleteFromInput( p_playlist, i_input_id,
288
                             p_playlist->p_root_category, true );
289
    i_ret2 = DeleteFromInput( p_playlist, i_input_id,
290
                     p_playlist->p_root_onelevel, true );
291
    PL_UNLOCK_IF( !b_locked );
292
293
    return ( i_ret1 == VLC_SUCCESS || i_ret2 == VLC_SUCCESS ) ?
                            VLC_SUCCESS : VLC_ENOITEM;
294
295
}

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

311
312
313
314
315
316
317
318
319
/**
 * 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
 */
320
int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
321
{
322
    playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id,
ivoire's avatar
ivoire committed
323
                                                    pl_Locked );
324
    if( !p_item ) return VLC_EGENERIC;
325
    return DeleteInner( p_playlist, p_item, true );
326
327
328
329
330
}

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

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

381
382
    i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
                               b_locked );
Jean-Paul Saman's avatar
Jean-Paul Saman committed
383
    int i_id = (i_ret == VLC_SUCCESS) ? p_input->i_id : -1;
384

385
    vlc_gc_decref( p_input );
386
387

    return i_id;
388
}
389

390
391
392
393
394
395
396
397
398
399
400
/**
 * 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
401
 * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
402
*/
403
int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
404
405
                       int i_mode, int i_pos, bool b_playlist,
                       bool b_locked )
406
{
zorglub's avatar
zorglub committed
407
    playlist_item_t *p_item_cat, *p_item_one;
408
    if( p_playlist->b_die ) return VLC_EGENERIC;
409
410
411
    if( !p_playlist->b_doing_ml )
        PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
                                             p_input->psz_uri );
412

413
    PL_LOCK_IF( !b_locked );
414

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

    /* Add to CATEGORY */
zorglub's avatar
zorglub committed
423
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
424
    if( p_item_cat == NULL ) return VLC_ENOMEM;
425
    AddItem( p_playlist, p_item_cat,
426
             b_playlist ? p_playlist->p_local_category :
427
                          p_playlist->p_ml_category , i_mode, i_pos );
428

zorglub's avatar
zorglub committed
429
    GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
430

431
    PL_UNLOCK_IF( !b_locked );
432
433
434
    return VLC_SUCCESS;
}

435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
/**
 * 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
450
 * \return VLC_SUCCESS if success, VLC_EGENERIC if fail, VLC_ENOMEM if OOM
451
 */
452
453
454
int playlist_BothAddInput( playlist_t *p_playlist,
                           input_item_t *p_input,
                           playlist_item_t *p_direct_parent,
455
                           int i_mode, int i_pos,
456
                           int *i_cat, int *i_one, bool b_locked )
457
{
zorglub's avatar
zorglub committed
458
    playlist_item_t *p_item_cat, *p_item_one, *p_up;
459
    int i_top;
zorglub's avatar
zorglub committed
460
    assert( p_input );
461
462
463

    if( !vlc_object_alive( p_playlist ) )
        return VLC_EGENERIC;
464
465

    PL_LOCK_IF( !b_locked );
466

467
    /* Add to category */
zorglub's avatar
zorglub committed
468
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
469
    if( p_item_cat == NULL ) return VLC_ENOMEM;
470
    AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
471
472

    /* Add to onelevel */
473
    /** \todo make a faster case for ml import */
zorglub's avatar
zorglub committed
474
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
475
    if( p_item_one == NULL ) return VLC_ENOMEM;
476
477
478

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

495
496
497
    if( i_cat ) *i_cat = p_item_cat->i_id;
    if( i_one ) *i_one = p_item_one->i_id;

498
    PL_UNLOCK_IF( !b_locked );
zorglub's avatar
zorglub committed
499
    return VLC_SUCCESS;
500
}
gbazin's avatar
   
gbazin committed
501

502
503
504
505
506
507
508
509
510
511
512
513
514
/**
 * 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
 */
515
516
517
playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
                                         input_item_t *p_input,
                                         playlist_item_t *p_parent,
518
                                         int i_mode, int i_pos,
519
                                         bool b_locked )
gbazin's avatar
   
gbazin committed
520
{
521
    playlist_item_t *p_item;
zorglub's avatar
zorglub committed
522
523
    assert( p_input );
    assert( p_parent && p_parent->i_children != -1 );
gbazin's avatar
   
gbazin committed
524

525
526
    if( p_playlist->b_die )
        return NULL;
527
    PL_LOCK_IF( !b_locked );
gbazin's avatar
   
gbazin committed
528

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

533
    PL_UNLOCK_IF( !b_locked );
534
535

    return p_item;
gbazin's avatar
   
gbazin committed
536
}
zorglub's avatar
zorglub committed
537

538
539
540
541
/*****************************************************************************
 * Playlist item misc operations
 *****************************************************************************/

zorglub's avatar
zorglub committed
542
/**
ivoire's avatar
ivoire committed
543
544
 * Item to node
 *
545
546
 * 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
547
 * This function must be entered without the playlist lock
ivoire's avatar
ivoire committed
548
549
550
551
 * \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
zorglub's avatar
zorglub committed
552
 */
553
playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
554
                                      playlist_item_t *p_item,
555
                                      bool b_locked )
zorglub's avatar
zorglub committed
556
{
557
558

    playlist_item_t *p_item_in_category;
559
560
561
562
563
    /* What we do
     * Find the input in CATEGORY.
     *  - If we find it
     *    - change it to node
     *    - we'll return it at the end
564
565
     *    - If we are a direct child of onelevel root, change to node, else
     *      delete the input from ONELEVEL
566
567
568
569
570
571
572
     *  - 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 )
     */

573
    PL_LOCK_IF( !b_locked );
574

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

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

    if( p_item_in_category )
zorglub's avatar
zorglub committed
588
    {
589
590
        playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
                                            p_playlist, p_item->p_input->i_id,
zorglub's avatar
zorglub committed
591
                                            p_playlist->p_root_onelevel,
592
                                            true );
593
594
        assert( p_item_in_one );

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

598
        /* Item in one is a root, change it to node */
599
600
601
602
        if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
            ChangeToNode( p_playlist, p_item_in_one );
        else
        {
603
            DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
604
                             p_playlist->p_root_onelevel, false );
605
        }
606
        p_playlist->b_reset_currently_playing = true;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
607
        vlc_object_signal_unlocked( p_playlist );
608
609
        var_SetInteger( p_playlist, "item-change", p_item_in_category->
                                                        p_input->i_id );
610
        PL_UNLOCK_IF( !b_locked );
611
612
613
614
615
        return p_item_in_category;
    }
    else
    {
        ChangeToNode( p_playlist, p_item );
616
        PL_UNLOCK_IF( !b_locked );
617
        return p_item;
zorglub's avatar
zorglub committed
618
619
620
    }
}

ivoire's avatar
ivoire committed
621
622
623
624
625
626
627
/**
 * 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
628
629
630
631
 * \return the first found item, or NULL if not found
 */
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
                                                    int i_input_id,
zorglub's avatar
zorglub committed
632
                                                    playlist_item_t *p_root,
633
                                                    bool b_items_only )
634
635
636
637
{
    int i;
    for( i = 0 ; i< p_root->i_children ; i++ )
    {
zorglub's avatar
zorglub committed
638
        if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
639
640
641
642
643
644
645
646
            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,
zorglub's avatar
zorglub committed
647
648
                                                    p_root->pp_children[i],
                                                    b_items_only );
649
650
651
652
653
            if( p_search ) return p_search;
        }
    }
    return NULL;
}
zorglub's avatar
zorglub committed
654
655


zorglub's avatar
zorglub committed
656
657
658
659
660
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;
661
662
    (void)p_playlist;

zorglub's avatar
zorglub committed
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
    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 );

    /* 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;
}

zorglub's avatar
zorglub committed
678
/**
679
680
681
 * Moves an item
 *
 * This function must be entered with the playlist lock
zorglub's avatar
zorglub committed
682
 *
683
684
685
686
687
 * \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
zorglub's avatar
zorglub committed
688
 */
689
690
691
int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
                       playlist_item_t *p_node, int i_newpos )
{
692
    int i_ret;
zorglub's avatar
zorglub committed
693
694
695
    /* 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 )
696
    {
zorglub's avatar
zorglub committed
697
698
        /* Fixme: avoid useless lookups but we need some clean helpers */
        {
zorglub's avatar
zorglub committed
699
700
701
702
            /* 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 */
zorglub's avatar
zorglub committed
703
704
705
706
707
            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,
708
                                                false );
zorglub's avatar
zorglub committed
709
710
711
            p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_onelevel,
712
                                                false );
zorglub's avatar
zorglub committed
713
714
            if( p_node_onelevel && p_item_onelevel )
                TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, 0 );
zorglub's avatar
zorglub committed
715
716
717
718
719
720
721
        }
        {
            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,
722
                                                false );
zorglub's avatar
zorglub committed
723
724
725
            p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_category,
726
                                                false );
zorglub's avatar
zorglub committed
727
728
            if( p_node_category && p_item_category )
                TreeMove( p_playlist, p_item_category, p_node_category, 0 );
zorglub's avatar
zorglub committed
729
        }
730
        i_ret = VLC_SUCCESS;
731
    }
zorglub's avatar
zorglub committed
732
    else
733
        i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
734
    p_playlist->b_reset_currently_playing = true;
735
    vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
736
    return i_ret;
737
738
}

ivoire's avatar
ivoire committed
739
740
/**
 * Send a notification that an item has been added to a node
ivoire's avatar
ivoire committed
741
 *
ivoire's avatar
ivoire committed
742
743
744
745
746
747
 * \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
 */
748
void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
749
                             int i_node_id, bool b_signal )
750
751
{
    vlc_value_t val;
ivoire's avatar
ivoire committed
752
    playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
753
754
755
    if( !p_add )
        return;

756
757
758
    p_add->i_item = i_item_id;
    p_add->i_node = i_node_id;
    val.p_address = p_add;
759
    p_playlist->b_reset_currently_playing = true;
760
    if( b_signal )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
761
        vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
762
763
764
765
766
767
768
769
    var_Set( p_playlist, "item-append", val );
    free( p_add );
}

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

ivoire's avatar
ivoire committed
770
771
772
773
774
775
776
/**
 * 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
777
int playlist_ItemSetName( playlist_item_t *p_item, const char *psz_name )
zorglub's avatar
zorglub committed
778
779
780
{
    if( psz_name && p_item )
    {
781
        input_item_SetName( p_item->p_input, psz_name );
zorglub's avatar
zorglub committed
782
783
784
785
786
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}

787
788
789
790
791
/***************************************************************************
 * The following functions are local
 ***************************************************************************/

/* Enqueue an item for preparsing, and play it, if needed */
792
793
794
static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
                           playlist_item_t *p_item_cat,
                           playlist_item_t *p_item_one )
795
{
zorglub's avatar
zorglub committed
796
    if( (i_mode & PLAYLIST_GO ) )
zorglub's avatar
zorglub committed
797
    {
zorglub's avatar
zorglub committed
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
        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 );
813
        p_playlist->request.b_request = true;
814
        p_playlist->request.i_skip = 0;
zorglub's avatar
zorglub committed
815
        p_playlist->request.p_item = p_toplay;
816
817
        if( p_playlist->p_input )
            input_StopThread( p_playlist->p_input );
zorglub's avatar
zorglub committed
818
        p_playlist->request.i_status = PLAYLIST_RUNNING;
819
        vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
820
    }
821
    /* Preparse if PREPARSE or SPREPARSE & not enough meta */
Rafaël Carré's avatar
Rafaël Carré committed
822
823
    char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
    char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
824
825
826
    if( p_playlist->b_auto_preparse &&
          (i_mode & PLAYLIST_PREPARSE ||
          ( i_mode & PLAYLIST_SPREPARSE &&
Rafaël Carré's avatar
Rafaël Carré committed
827
            ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
828
          ) ) )
zorglub's avatar
zorglub committed
829
        playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
830
    /* If we already have it, signal it */
Rafaël Carré's avatar
Rafaël Carré committed
831
    else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
832
        input_item_SetPreparsed( p_item_cat->p_input, true );
Rafaël Carré's avatar
Rafaël Carré committed
833
834
    free( psz_artist );
    free( psz_album );
835
836
837
}

/* Add the playlist item to the requested node and fire a notification */
838
839
static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_mode, int i_pos )
840
{
zorglub's avatar
zorglub committed
841
842
    ARRAY_APPEND(p_playlist->items, p_item);
    ARRAY_APPEND(p_playlist->all_items, p_item);
843
844
845
846
847

    if( i_pos == PLAYLIST_END )
        playlist_NodeAppend( p_playlist, p_item, p_node );
    else
        playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
zorglub's avatar
zorglub committed
848

849
    if( !p_playlist->b_doing_ml )
850
851
        playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
                                 !( i_mode & PLAYLIST_NO_REBUILD ) );
852
853
854
}

/* Actually convert an item to a node */
855
static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
856
857
858
859
860
861
{
    int i;
    if( p_item->i_children == -1 )
        p_item->i_children = 0;

    /* Remove it from the array of available items */
zorglub's avatar
zorglub committed
862
863
864
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );
865
866
867
}

/* Do the actual removal */
868
static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
869
                        bool b_stop )
870
{
zorglub's avatar
zorglub committed
871
    int i;
872
873
874
875
    int i_id = p_item->i_id;

    if( p_item->i_children > -1 )
    {
876
        return playlist_NodeDelete( p_playlist, p_item, true, false );
877
    }
878
    p_playlist->b_reset_currently_playing = true;
879
880
881
    var_SetInteger( p_playlist, "item-deleted", i_id );

    /* Remove the item from the bank */
zorglub's avatar
zorglub committed
882
883
884
    ARRAY_BSEARCH( p_playlist->all_items,->i_id, int, i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->all_items, i );
zorglub's avatar
zorglub committed
885

886
887
888
889
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );

890
    /* Check if it is the current item */
891
    if( get_current_status_item( p_playlist ) == p_item )
zorglub's avatar
zorglub committed
892
    {
893
894
        /* Hack we don't call playlist_Control for lock reasons */
        if( b_stop )
zorglub's avatar
zorglub committed
895
        {
zorglub's avatar
zorglub committed
896
            p_playlist->request.i_status = PLAYLIST_STOPPED;
897
            p_playlist->request.b_request = true;
898
899
            p_playlist->request.p_item = NULL;
            msg_Info( p_playlist, "stopping playback" );
900
            vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
zorglub's avatar
zorglub committed
901
902
        }
    }
903

904
    PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
905
906
907
908

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

909
    playlist_ItemRelease( p_item );
910
911

    return VLC_SUCCESS;
zorglub's avatar
zorglub committed
912
}