item.c 31.4 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/vlc.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
        }

Pierre d'Herbemont's avatar
(oops).    
Pierre d'Herbemont committed
83
84
        b_play = b_play && p_item_in_category == p_playlist->status.p_item;

Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
85
86
87
88
        /* 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,
89
                    p_item_in_category, true );
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
90
91
            p_item_in_category->p_input->i_type = ITEM_TYPE_PLAYLIST;
        }
92

93
94
        int i_ret = playlist_BothAddInput( p_playlist, p_child,
                p_item_in_category,
95
                PLAYLIST_APPEND | PLAYLIST_SPREPARSE , PLAYLIST_END,
96
                NULL, NULL,  true );
97

98
        if( i_ret == VLC_SUCCESS && b_play )
99
100
        {
            playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
101
                          true, p_item_in_category, NULL );
102
        }
103
    }
104

105
106
    PL_UNLOCK;

107
108
109
110
111
}

/*****************************************************************************
 * Listen to vlc_InputItemAddSubItem event
 *****************************************************************************/
112
static void install_input_item_observer( playlist_item_t * p_item )
113
{
114
115
    vlc_event_attach( &p_item->p_input->event_manager,
                      vlc_InputItemSubItemAdded,
116
                      input_item_subitem_added,
117
                      p_item );
118
119
}

120
static void uninstall_input_item_observer( playlist_item_t * p_item )
121
{
122
123
    vlc_event_detach( &p_item->p_input->event_manager,
                      vlc_InputItemSubItemAdded,
124
                      input_item_subitem_added,
125
                      p_item );
126

127
128
}

129
130
131
/*****************************************************************************
 * Playlist item creation
 *****************************************************************************/
132
133
134
playlist_item_t * playlist_ItemNewWithType( vlc_object_t *p_obj,
                                            const char *psz_uri,
                                            const char *psz_name,
135
                                            int i_options,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
136
                                            const char *const *ppsz_options,
137
                                            int i_duration, int i_type )
138
{
139
    input_item_t *p_input;
140
    if( psz_uri == NULL ) return NULL;
141
    p_input = input_ItemNewWithType( p_obj, psz_uri,
142
143
                                     psz_name, i_options, ppsz_options,
                                     i_duration, i_type );
144
145
    return playlist_ItemNewFromInput( p_obj, p_input );
}
146

147
playlist_item_t *__playlist_ItemNewFromInput( vlc_object_t *p_obj,
148
                                              input_item_t *p_input )
149
{
150
    DECMALLOC_NULL( p_item, playlist_item_t );
151
    playlist_t *p_playlist = pl_Yield( p_obj );
zorglub's avatar
zorglub committed
152

153
154
    p_item->p_input = p_input;
    vlc_gc_incref( p_item->p_input );
155

156
    p_item->i_id = ++p_playlist->i_last_playlist_id;
zorglub's avatar
zorglub committed
157

158
    p_item->p_parent = NULL;
zorglub's avatar
zorglub committed
159
160
161
    p_item->i_children = -1;
    p_item->pp_children = NULL;
    p_item->i_flags = 0;
162
    p_item->p_playlist = p_playlist;
zorglub's avatar
zorglub committed
163

164
    install_input_item_observer( p_item );
165

166
167
    pl_Release( p_item->p_playlist );

168
169
170
    return p_item;
}

171
172
173
174
/***************************************************************************
 * Playlist item destruction
 ***************************************************************************/

175
176
177
178
179
180
181
/**
 * Delete item
 *
 * Delete a playlist item and detach its input item
 * \param p_item item to delete
 * \return VLC_SUCCESS
*/
182
183
int playlist_ItemDelete( playlist_item_t *p_item )
{
184
    uninstall_input_item_observer( p_item );
185

186
187
188
189
190
    vlc_gc_decref( p_item->p_input );
    free( p_item );
    return VLC_SUCCESS;
}

191
192
193
194
195
196
197
198
199
200
/**
 * 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
*/
201
static int DeleteFromInput( playlist_t *p_playlist, int i_input_id,
202
                            playlist_item_t *p_root, bool b_do_stop )
203
204
205
206
207
208
209
210
{
    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 );
211
            return VLC_SUCCESS;
212
213
214
        }
        else if( p_root->pp_children[i]->i_children >= 0 )
        {
215
216
            int i_ret = DeleteFromInput( p_playlist, i_input_id,
                                         p_root->pp_children[i], b_do_stop );
217
            if( i_ret == VLC_SUCCESS ) return VLC_SUCCESS;
218
219
        }
    }
220
    return VLC_EGENERIC;
221
222
}

223
224
225
226
227
228
229
230
231
232
/**
 * 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
 */
233
int playlist_DeleteInputInParent( playlist_t *p_playlist, int i_input_id,
234
                                  playlist_item_t *p_root, bool b_locked )
235
236
237
238
{
    int i_ret;
    if( !b_locked ) PL_LOCK;
    i_ret = DeleteFromInput( p_playlist, i_input_id,
239
                             p_root, true );
240
241
242
243
    if( !b_locked ) PL_UNLOCK;
    return i_ret;
}

244
245
246
247
248
249
250
251
252
/**
 * 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
 */
253
int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
254
                              bool b_locked )
255
{
256
    int i_ret1, i_ret2;
257
    if( !b_locked ) PL_LOCK;
258
    i_ret1 = DeleteFromInput( p_playlist, i_input_id,
259
                             p_playlist->p_root_category, true );
260
    i_ret2 = DeleteFromInput( p_playlist, i_input_id,
261
                     p_playlist->p_root_onelevel, true );
262
    if( !b_locked ) PL_UNLOCK;
263
264
    return ( i_ret1 == VLC_SUCCESS || i_ret2 == VLC_SUCCESS ) ?
                            VLC_SUCCESS : VLC_ENOITEM;
265
266
}

267
268
269
270
271
272
273
/**
 * Clear the playlist
 *
 * \param p_playlist playlist object
 * \param b_locked TRUE if the playlist is locked
 * \return nothing
 */
274
void playlist_Clear( playlist_t * p_playlist, bool b_locked )
275
{
276
    if( !b_locked ) PL_LOCK;
277
278
    playlist_NodeEmpty( p_playlist, p_playlist->p_local_category, true );
    playlist_NodeEmpty( p_playlist, p_playlist->p_local_onelevel, true );
279
    if( !b_locked ) PL_UNLOCK;
280
}
281

282
283
284
285
286
287
288
289
290
/**
 * 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
 */
291
int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
292
{
293
    playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id,
294
                                                    true );
295
    if( !p_item ) return VLC_EGENERIC;
296
    return DeleteInner( p_playlist, p_item, true );
297
298
299
300
301
}

/***************************************************************************
 * Playlist item addition
 ***************************************************************************/
302
303
304
305
/**
 * Playlist add
 *
 * Add an item to the playlist or the media library
306
307
308
309
310
311
 * \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
312
 *        regardless of its size
313
 * \param b_playlist TRUE for playlist, FALSE for media library
314
 * \param b_locked TRUE if the playlist is locked
315
 * \return The id of the playlist item
316
 */
317
318
int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
                  const char *psz_name, int i_mode, int i_pos,
319
                  bool b_playlist, bool b_locked )
320
{
321
    return playlist_AddExt( p_playlist, psz_uri, psz_name,
322
                            i_mode, i_pos, -1, NULL, 0, b_playlist, b_locked );
323
}
324

325
/**
326
 * Add a MRL into the playlist or the media library, duration and options given
327
328
329
330
331
332
333
 *
 * \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
334
 *        regardless of its size
335
336
337
 * \param i_duration length of the item in milliseconds.
 * \param ppsz_options an array of options
 * \param i_options the number of options
338
 * \param b_playlist TRUE for playlist, FALSE for media library
339
 * \param b_locked TRUE if the playlist is locked
340
341
 * \return The id of the playlist item
*/
342
343
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
344
                     mtime_t i_duration, const char *const *ppsz_options,
345
                     int i_options, bool b_playlist, bool b_locked )
346
{
347
    int i_ret;
348
349
350
    input_item_t *p_input = input_ItemNewExt( p_playlist, psz_uri, psz_name,
                                              i_options, ppsz_options,
                                              i_duration );
351

352
353
    i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
                               b_locked );
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
354
    int i_id = i_ret == VLC_SUCCESS ? p_input->i_id : -1;
355

356
    vlc_gc_decref( p_input );
357
358

    return i_id;
359
}
360

361
362
363
364
365
366
367
368
369
370
371
/**
 * 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
372
 * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
373
*/
374
int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
375
376
                       int i_mode, int i_pos, bool b_playlist,
                       bool b_locked )
377
{
zorglub's avatar
zorglub committed
378
    playlist_item_t *p_item_cat, *p_item_one;
379
    if( p_playlist->b_die ) return VLC_EGENERIC;
380
381
382
    if( !p_playlist->b_doing_ml )
        PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
                                             p_input->psz_uri );
383

384
    if( !b_locked ) PL_LOCK;
385

386
    /* Add to ONELEVEL */
zorglub's avatar
zorglub committed
387
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
388
    if( p_item_one == NULL ) return VLC_ENOMEM;
389
390
    AddItem( p_playlist, p_item_one,
             b_playlist ? p_playlist->p_local_onelevel :
391
                          p_playlist->p_ml_onelevel , i_mode, i_pos );
392
393

    /* Add to CATEGORY */
zorglub's avatar
zorglub committed
394
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
395
    if( p_item_cat == NULL ) return VLC_ENOMEM;
396
    AddItem( p_playlist, p_item_cat,
397
             b_playlist ? p_playlist->p_local_category :
398
                          p_playlist->p_ml_category , i_mode, i_pos );
399

zorglub's avatar
zorglub committed
400
    GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
401

402
    if( !b_locked ) PL_UNLOCK;
403
404
405
    return VLC_SUCCESS;
}

406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
/**
 * 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
421
 * \return VLC_SUCCESS if success, VLC_EGENERIC if fail, VLC_ENOMEM if OOM
422
 */
423
424
425
int playlist_BothAddInput( playlist_t *p_playlist,
                           input_item_t *p_input,
                           playlist_item_t *p_direct_parent,
426
                           int i_mode, int i_pos,
427
                           int *i_cat, int *i_one, bool b_locked )
428
{
zorglub's avatar
zorglub committed
429
    playlist_item_t *p_item_cat, *p_item_one, *p_up;
430
    int i_top;
zorglub's avatar
zorglub committed
431
    assert( p_input );
432
    if( p_playlist->b_die ) return VLC_EGENERIC;
433
    if( !b_locked ) PL_LOCK;
434
435

    /* Add to category */
zorglub's avatar
zorglub committed
436
    p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
437
    if( p_item_cat == NULL ) return VLC_ENOMEM;
438
    AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
439
440

    /* Add to onelevel */
441
    /** \todo make a faster case for ml import */
zorglub's avatar
zorglub committed
442
    p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
443
    if( p_item_one == NULL ) return VLC_ENOMEM;
444
445
446

    p_up = p_direct_parent;
    while( p_up->p_parent != p_playlist->p_root_category )
447
    {
448
        p_up = p_up->p_parent;
449
    }
450
    for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
zorglub's avatar
zorglub committed
451
    {
452
453
        if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id ==
                             p_up->p_input->i_id )
454
        {
zorglub's avatar
zorglub committed
455
            AddItem( p_playlist, p_item_one,
456
457
                     p_playlist->p_root_onelevel->pp_children[i_top],
                     i_mode, i_pos );
458
459
            break;
        }
zorglub's avatar
zorglub committed
460
    }
zorglub's avatar
zorglub committed
461
    GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
zorglub's avatar
zorglub committed
462

463
464
465
    if( i_cat ) *i_cat = p_item_cat->i_id;
    if( i_one ) *i_one = p_item_one->i_id;

466
    if( !b_locked ) PL_UNLOCK;
zorglub's avatar
zorglub committed
467
    return VLC_SUCCESS;
468
}
gbazin's avatar
   
gbazin committed
469

470
471
472
473
474
475
476
477
478
479
480
481
482
/**
 * 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
 */
483
484
485
playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
                                         input_item_t *p_input,
                                         playlist_item_t *p_parent,
486
                                         int i_mode, int i_pos,
487
                                         bool b_locked )
gbazin's avatar
   
gbazin committed
488
{
489
    playlist_item_t *p_item;
zorglub's avatar
zorglub committed
490
491
    assert( p_input );
    assert( p_parent && p_parent->i_children != -1 );
gbazin's avatar
   
gbazin committed
492

493
494
    if( p_playlist->b_die )
        return NULL;
495
    if( !b_locked ) PL_LOCK;
gbazin's avatar
   
gbazin committed
496

497
498
    p_item = playlist_ItemNewFromInput( p_playlist, p_input );
    if( p_item == NULL ) return NULL;
499
    AddItem( p_playlist, p_item, p_parent, i_mode, i_pos );
500

501
    if( !b_locked ) PL_UNLOCK;
502
503

    return p_item;
gbazin's avatar
   
gbazin committed
504
}
zorglub's avatar
zorglub committed
505

506
507
508
509
/*****************************************************************************
 * Playlist item misc operations
 *****************************************************************************/

zorglub's avatar
zorglub committed
510
/**
ivoire's avatar
ivoire committed
511
512
 * Item to node
 *
513
514
 * 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
515
 * This function must be entered without the playlist lock
ivoire's avatar
ivoire committed
516
517
518
519
 * \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
520
 */
521
playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
522
                                      playlist_item_t *p_item,
523
                                      bool b_locked )
zorglub's avatar
zorglub committed
524
{
525
526

    playlist_item_t *p_item_in_category;
527
528
529
530
531
    /* What we do
     * Find the input in CATEGORY.
     *  - If we find it
     *    - change it to node
     *    - we'll return it at the end
532
533
     *    - If we are a direct child of onelevel root, change to node, else
     *      delete the input from ONELEVEL
534
535
536
537
538
539
540
     *  - 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 )
     */

541
542
    if( !b_locked ) PL_LOCK;

543
    /* Fast track the media library, no time to loose */
544
545
    if( p_item == p_playlist->p_ml_category ) {
        if( !b_locked ) PL_UNLOCK;
546
        return p_item;
547
    }
548

549
    /** \todo First look if we don't already have it */
550
    p_item_in_category = playlist_ItemFindFromInputAndRoot(
551
                                            p_playlist, p_item->p_input->i_id,
zorglub's avatar
zorglub committed
552
                                            p_playlist->p_root_category,
553
                                            true );
554
555

    if( p_item_in_category )
zorglub's avatar
zorglub committed
556
    {
557
558
        playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
                                            p_playlist, p_item->p_input->i_id,
zorglub's avatar
zorglub committed
559
                                            p_playlist->p_root_onelevel,
560
                                            true );
561
562
        assert( p_item_in_one );

563
        /* We already have it, and there is nothing more to do */
564
        ChangeToNode( p_playlist, p_item_in_category );
565

566
        /* Item in one is a root, change it to node */
567
568
569
570
        if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
            ChangeToNode( p_playlist, p_item_in_one );
        else
        {
571
            DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
572
                             p_playlist->p_root_onelevel, false );
573
        }
574
        p_playlist->b_reset_currently_playing = true;
575
        vlc_cond_signal( &p_playlist->object_wait );
576
577
        var_SetInteger( p_playlist, "item-change", p_item_in_category->
                                                        p_input->i_id );
578
        if( !b_locked ) PL_UNLOCK;
579
580
581
582
583
        return p_item_in_category;
    }
    else
    {
        ChangeToNode( p_playlist, p_item );
584
        if( !b_locked ) PL_UNLOCK;
585
        return NULL;
zorglub's avatar
zorglub committed
586
587
588
    }
}

ivoire's avatar
ivoire committed
589
590
591
592
593
594
595
/**
 * 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
596
597
598
599
 * \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
600
                                                    playlist_item_t *p_root,
601
                                                    bool b_items_only )
602
603
604
605
{
    int i;
    for( i = 0 ; i< p_root->i_children ; i++ )
    {
zorglub's avatar
zorglub committed
606
        if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
607
608
609
610
611
612
613
614
            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
615
616
                                                    p_root->pp_children[i],
                                                    b_items_only );
617
618
619
620
621
            if( p_search ) return p_search;
        }
    }
    return NULL;
}
zorglub's avatar
zorglub committed
622
623


zorglub's avatar
zorglub committed
624
625
626
627
628
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;
629
630
    (void)p_playlist;

zorglub's avatar
zorglub committed
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
    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
646
/**
647
648
649
 * Moves an item
 *
 * This function must be entered with the playlist lock
zorglub's avatar
zorglub committed
650
 *
651
652
653
654
655
 * \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
656
 */
657
658
659
int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
                       playlist_item_t *p_node, int i_newpos )
{
660
    int i_ret;
zorglub's avatar
zorglub committed
661
662
663
    /* 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 )
664
    {
zorglub's avatar
zorglub committed
665
666
        /* Fixme: avoid useless lookups but we need some clean helpers */
        {
zorglub's avatar
zorglub committed
667
668
669
670
            /* 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
671
672
673
674
675
            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,
676
                                                false );
zorglub's avatar
zorglub committed
677
678
679
            p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_onelevel,
680
                                                false );
zorglub's avatar
zorglub committed
681
682
            if( p_node_onelevel && p_item_onelevel )
                TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, 0 );
zorglub's avatar
zorglub committed
683
684
685
686
687
688
689
        }
        {
            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,
690
                                                false );
zorglub's avatar
zorglub committed
691
692
693
            p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
                                                p_item->p_input->i_id,
                                                p_playlist->p_root_category,
694
                                                false );
zorglub's avatar
zorglub committed
695
696
            if( p_node_category && p_item_category )
                TreeMove( p_playlist, p_item_category, p_node_category, 0 );
zorglub's avatar
zorglub committed
697
        }
698
        i_ret = VLC_SUCCESS;
699
    }
zorglub's avatar
zorglub committed
700
    else
701
        i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
702
    p_playlist->b_reset_currently_playing = true;
703
704
    vlc_cond_signal( &p_playlist->object_wait );
    return i_ret;
705
706
}

ivoire's avatar
ivoire committed
707
708
/**
 * Send a notification that an item has been added to a node
ivoire's avatar
ivoire committed
709
 *
ivoire's avatar
ivoire committed
710
711
712
713
714
715
 * \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
 */
716
void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
717
                             int i_node_id, bool b_signal )
718
719
{
    vlc_value_t val;
ivoire's avatar
ivoire committed
720
    playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
721
722
723
    if( !p_add )
        return;

724
725
726
    p_add->i_item = i_item_id;
    p_add->i_node = i_node_id;
    val.p_address = p_add;
727
    p_playlist->b_reset_currently_playing = true;
728
729
    if( b_signal )
        vlc_cond_signal( &p_playlist->object_wait );
730
731
732
733
734
735
736
737
    var_Set( p_playlist, "item-append", val );
    free( p_add );
}

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

ivoire's avatar
ivoire committed
738
739
740
741
742
743
744
/**
 * 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
745
int playlist_ItemSetName( playlist_item_t *p_item, const char *psz_name )
zorglub's avatar
zorglub committed
746
747
748
{
    if( psz_name && p_item )
    {
749
        input_item_SetName( p_item->p_input, psz_name );
zorglub's avatar
zorglub committed
750
751
752
753
754
        return VLC_SUCCESS;
    }
    return VLC_EGENERIC;
}

755
756
757
758
759
/***************************************************************************
 * The following functions are local
 ***************************************************************************/

/* Enqueue an item for preparsing, and play it, if needed */
760
761
762
static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
                           playlist_item_t *p_item_cat,
                           playlist_item_t *p_item_one )
763
{
zorglub's avatar
zorglub committed
764
    if( (i_mode & PLAYLIST_GO ) )
zorglub's avatar
zorglub committed
765
    {
zorglub's avatar
zorglub committed
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
        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 );
781
        p_playlist->request.b_request = true;
782
        p_playlist->request.i_skip = 0;
zorglub's avatar
zorglub committed
783
        p_playlist->request.p_item = p_toplay;
784
785
        if( p_playlist->p_input )
            input_StopThread( p_playlist->p_input );
zorglub's avatar
zorglub committed
786
        p_playlist->request.i_status = PLAYLIST_RUNNING;
787
        vlc_cond_signal( &p_playlist->object_wait );
788
    }
789
    /* Preparse if PREPARSE or SPREPARSE & not enough meta */
Rafaël Carré's avatar
Rafaël Carré committed
790
791
    char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
    char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
792
793
794
    if( p_playlist->b_auto_preparse &&
          (i_mode & PLAYLIST_PREPARSE ||
          ( i_mode & PLAYLIST_SPREPARSE &&
Rafaël Carré's avatar
Rafaël Carré committed
795
            ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
796
          ) ) )
zorglub's avatar
zorglub committed
797
        playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
798
    /* If we already have it, signal it */
Rafaël Carré's avatar
Rafaël Carré committed
799
    else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
800
        input_item_SetPreparsed( p_item_cat->p_input, true );
Rafaël Carré's avatar
Rafaël Carré committed
801
802
    free( psz_artist );
    free( psz_album );
803
804
805
}

/* Add the playlist item to the requested node and fire a notification */
806
807
static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
                     playlist_item_t *p_node, int i_mode, int i_pos )
808
{
zorglub's avatar
zorglub committed
809
810
    ARRAY_APPEND(p_playlist->items, p_item);
    ARRAY_APPEND(p_playlist->all_items, p_item);
811
812
813
814
815

    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
816

817
    if( !p_playlist->b_doing_ml )
818
819
        playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
                                 !( i_mode & PLAYLIST_NO_REBUILD ) );
820
821
822
}

/* Actually convert an item to a node */
823
static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
824
825
826
827
828
829
{
    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
830
831
832
    ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
    if( i != -1 )
        ARRAY_REMOVE( p_playlist->items, i );
833
834
835
}

/* Do the actual removal */
836
static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
837
                        bool b_stop )
838
{
zorglub's avatar
zorglub committed
839
    int i;
840
    int i_id = p_item->i_id;
841
    bool b_delay_deletion = false;
842
843
844

    if( p_item->i_children > -1 )
    {
845
        return playlist_NodeDelete( p_playlist, p_item, true, false );
846
    }
847
    p_playlist->b_reset_currently_playing = true;
848
849
850
    var_SetInteger( p_playlist, "item-deleted", i_id );

    /* Remove the item from the bank */
zorglub's avatar
zorglub committed
851
852
853
    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
854

855
856
    /* Check if it is the current item */
    if( p_playlist->status.p_item == p_item )
zorglub's avatar
zorglub committed
857
    {
858
859
        /* Hack we don't call playlist_Control for lock reasons */
        if( b_stop )
zorglub's avatar
zorglub committed
860
        {
zorglub's avatar
zorglub committed
861
            p_playlist->request.i_status = PLAYLIST_STOPPED;
862
            p_playlist->request.b_request = true;
863
864
            p_playlist->request.p_item = NULL;
            msg_Info( p_playlist, "stopping playback" );
865
            vlc_cond_signal( &p_playlist->object_wait );
zorglub's avatar
zorglub committed
866
        }
867
        b_delay_deletion = true;
zorglub's avatar
zorglub committed
868
    }
869

870
    PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
871
872
873
874

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

875
    if( !b_delay_deletion )
876
877
        playlist_ItemDelete( p_item );
    else
zorglub's avatar
zorglub committed
878
879
    {
        PL_DEBUG( "marking %s for further deletion", PLI_NAME( p_item ) );
880
        p_item->i_flags |= PLAYLIST_REMOVE_FLAG;
zorglub's avatar
zorglub committed
881
    }
882
883

    return VLC_SUCCESS;
zorglub's avatar
zorglub committed
884
}