qt: playlist: use item title if available
[vlc.git] / src / playlist / item.c
1 /*****************************************************************************
2  * item.c : Playlist item creation/deletion/add/removal functions
3  *****************************************************************************
4  * Copyright (C) 1999-2007 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          ClĂ©ment Stenac <zorglub@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <assert.h>
29 #include <limits.h>
30 #ifdef HAVE_SEARCH_H
31 # include <search.h>
32 #endif
33
34 #include <vlc_common.h>
35 #include <vlc_playlist.h>
36 #include <vlc_rand.h>
37 #include "playlist_internal.h"
38
39 static void playlist_Preparse( playlist_t *, playlist_item_t * );
40
41 static int RecursiveAddIntoParent (
42                 playlist_t *p_playlist, playlist_item_t *p_parent,
43                 input_item_node_t *p_node, int i_pos, bool b_flat,
44                 playlist_item_t **pp_first_leaf );
45 static int RecursiveInsertCopy (
46                 playlist_t *p_playlist, playlist_item_t *p_item,
47                 playlist_item_t *p_parent, int i_pos, bool b_flat );
48
49 /*****************************************************************************
50  * An input item has gained subitems (Event Callback)
51  *****************************************************************************/
52
53 static void input_item_add_subitem_tree ( const vlc_event_t * p_event,
54                                           void * user_data )
55 {
56     input_item_t *p_input = p_event->p_obj;
57     playlist_t *p_playlist = user_data;
58     playlist_private_t *p_sys = pl_priv( p_playlist );
59     input_item_node_t *p_new_root = p_event->u.input_item_subitem_tree_added.p_root;
60
61     PL_LOCK;
62
63     playlist_item_t *p_item =
64         playlist_ItemGetByInput( p_playlist, p_input );
65
66     assert( p_item != NULL );
67
68     bool b_current = get_current_status_item( p_playlist ) == p_item;
69     bool b_autostart = var_GetBool( p_playlist, "playlist-autostart" );
70     bool b_stop = p_item->i_flags & PLAYLIST_SUBITEM_STOP_FLAG;
71     bool b_flat = false;
72
73     p_item->i_flags &= ~PLAYLIST_SUBITEM_STOP_FLAG;
74
75     /* We will have to flatten the tree out if we are in "the playlist" node and
76     the user setting demands flat playlist */
77
78     if( !pl_priv(p_playlist)->b_tree ) {
79         playlist_item_t *p_up = p_item;
80         while( p_up->p_parent )
81         {
82             if( p_up->p_parent == p_playlist->p_playing )
83             {
84                 b_flat = true;
85                 break;
86             }
87             p_up = p_up->p_parent;
88         }
89     }
90
91     int pos = 0;
92
93     /* If we have to flatten out, then take the item's position in the parent as
94     insertion point and delete the item */
95
96     bool b_redirect_request = false;
97
98     if( b_flat )
99     {
100         playlist_item_t *p_parent = p_item->p_parent;
101         assert( p_parent != NULL );
102
103         int i;
104         for( i = 0; i < p_parent->i_children; i++ )
105         {
106             if( p_parent->pp_children[i] == p_item )
107             {
108                 pos = i;
109                 break;
110             }
111         }
112         assert( i < p_parent->i_children );
113
114         playlist_NodeDeleteExplicit( p_playlist, p_item, 0 );
115
116         /* If there is a pending request referring to the item we just deleted
117          * it needs to be updated so that we do not try to play an entity that
118          * is no longer part of the playlist. */
119
120         if( p_sys->request.b_request &&
121             ( p_sys->request.p_item == p_item ||
122               p_sys->request.p_node == p_item ) )
123         {
124             b_redirect_request = true;
125         }
126
127         p_item = p_parent;
128     }
129     else
130     {
131         pos = p_item->i_children >= 0 ? p_item->i_children : 0;
132     }
133
134     /* At this point:
135     "p_item" is the node where sub-items should be inserted,
136     "pos" is the insertion position in that node */
137
138     int last_pos = playlist_InsertInputItemTree( p_playlist,
139                                                  p_item,
140                                                  p_new_root,
141                                                  pos,
142                                                  b_flat );
143     if( b_redirect_request )
144     {
145         /* a redirect of the pending request is required, as such we update the
146          * request to refer to the item that would have been the next in line
147          * (if any). */
148
149         assert( b_flat );
150
151         playlist_item_t* p_redirect = NULL;
152
153         if( p_item->i_children > pos )
154             p_redirect = p_item->pp_children[pos];
155
156         p_sys->request.p_item = p_redirect;
157         p_sys->request.p_node = NULL;
158     }
159
160     if( !b_flat ) var_SetInteger( p_playlist, "leaf-to-parent", p_item->i_id );
161
162     //control playback only if it was the current playing item that got subitems
163     if( b_current )
164     {
165         if( ( b_stop && !b_flat ) || !b_autostart )
166         {
167             playlist_Control( p_playlist, PLAYLIST_STOP, pl_Locked );
168         }
169         else if( last_pos != pos ) /* any children? */
170         {
171             /* Continue to play, either random or the first new item */
172             playlist_item_t *p_play_item;
173
174             if( var_GetBool( p_playlist, "random" ) )
175             {
176                 p_play_item = NULL;
177             }
178             else
179             {
180                 p_play_item = p_item->pp_children[pos];
181                 /* NOTE: this is a work around the general bug:
182                 if node-to-be-played contains sub-nodes, then second instead
183                 of first leaf starts playing (only in case the leafs have just
184                 been instered and playlist has not yet been rebuilt.)
185                 */
186                 while( p_play_item->i_children > 0 )
187                     p_play_item = p_play_item->pp_children[0];
188             }
189
190             playlist_ViewPlay( p_playlist, NULL, p_play_item );
191         }
192         else if( b_flat && p_playlist->current.i_size > 0 )
193         {
194             /* If the playlist is flat, empty nodes are automatically deleted;
195              * meaning that moving from the current index (the index of a now
196              * removed node) to the next would result in a skip of one entry
197              * (as the empty node is deleted, the logical next item would be
198              * the one that now resides in its place).
199              *
200              * Imagine [ A, B, C, D ], where B (at index 1) is currently being
201              * played and deleted. C is the logically next item, but since the
202              * list now looks like [ A, C, D ], advancing to index 2 would mean
203              * D is played - and not C.
204              *
205              * By positioning the playlist-head at index 0 (A), when the
206              * playlist advance to the next item, C will correctly be played.
207              *
208              * Note: Of course, if the deleted item is at index 0, we should
209              * play whatever item is at position 0 since we cannot advance to
210              * index -1 (as there cannot possibly be any item there).
211              **/
212
213             if( last_pos )
214                 ResetCurrentlyPlaying( p_playlist,
215                     ARRAY_VAL( p_playlist->current, last_pos - 1 ) );
216             else
217                 playlist_ViewPlay( p_playlist, NULL,
218                     ARRAY_VAL( p_playlist->current, 0 ) );
219         }
220     }
221
222     PL_UNLOCK;
223 }
224 /*****************************************************************************
225  * An input item's meta or duration has changed (Event Callback)
226  *****************************************************************************/
227 static void input_item_changed( const vlc_event_t * p_event,
228                                 void * user_data )
229 {
230     playlist_t *p_playlist = user_data;
231
232     var_SetAddress( p_playlist, "item-change", p_event->p_obj );
233 }
234
235 static int playlist_ItemCmpId( const void *a, const void *b )
236 {
237     const playlist_item_t *pa = a, *pb = b;
238
239     /* ID are between 1 and INT_MAX, this cannot overflow. */
240     return pa->i_id - pb->i_id;
241 }
242
243 static int playlist_ItemCmpInput( const void *a, const void *b )
244 {
245     const playlist_item_t *pa = a, *pb = b;
246
247     if( pa->p_input == pb->p_input )
248         return 0;
249     return (((uintptr_t)pa->p_input) > ((uintptr_t)pb->p_input))
250         ? +1 : -1;
251 }
252
253 /*****************************************************************************
254  * Playlist item creation
255  *****************************************************************************/
256 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
257                                               input_item_t *p_input )
258 {
259     playlist_private_t *p = pl_priv(p_playlist);
260     playlist_item_t **pp, *p_item;
261
262     p_item = malloc( sizeof( playlist_item_t ) );
263     if( unlikely(p_item == NULL) )
264         return NULL;
265
266     assert( p_input );
267
268     p_item->p_input = p_input;
269     p_item->i_id = p->i_last_playlist_id;
270     p_item->p_parent = NULL;
271     p_item->i_children = (p_input->i_type == ITEM_TYPE_NODE) ? 0 : -1;
272     p_item->pp_children = NULL;
273     p_item->i_nb_played = 0;
274     p_item->i_flags = 0;
275
276     PL_ASSERT_LOCKED;
277
278     do  /* Find an unused ID for the item */
279     {
280         if( unlikely(p_item->i_id == INT_MAX) )
281             p_item->i_id = 0;
282
283         p_item->i_id++;
284
285         if( unlikely(p_item->i_id == p->i_last_playlist_id) )
286             goto error; /* All IDs taken */
287
288         pp = tsearch( p_item, &p->id_tree, playlist_ItemCmpId );
289         if( unlikely(pp == NULL) )
290             goto error;
291
292         assert( (*pp)->i_id == p_item->i_id );
293         assert( (*pp) == p_item || (*pp)->p_input != p_input );
294     }
295     while( p_item != *pp );
296
297     pp = tsearch( p_item, &p->input_tree, playlist_ItemCmpInput );
298     if( unlikely(pp == NULL) )
299     {
300         tdelete( p_item, &p->id_tree, playlist_ItemCmpId );
301         goto error;
302     }
303     /* Same input item cannot be inserted twice. */
304     assert( p_item == *pp );
305
306     p->i_last_playlist_id = p_item->i_id;
307     input_item_Hold( p_item->p_input );
308
309     vlc_event_manager_t *p_em = &p_item->p_input->event_manager;
310
311     vlc_event_attach( p_em, vlc_InputItemSubItemTreeAdded,
312                       input_item_add_subitem_tree, p_playlist );
313     vlc_event_attach( p_em, vlc_InputItemDurationChanged,
314                       input_item_changed, p_playlist );
315     vlc_event_attach( p_em, vlc_InputItemMetaChanged,
316                       input_item_changed, p_playlist );
317     vlc_event_attach( p_em, vlc_InputItemNameChanged,
318                       input_item_changed, p_playlist );
319     vlc_event_attach( p_em, vlc_InputItemInfoChanged,
320                       input_item_changed, p_playlist );
321     vlc_event_attach( p_em, vlc_InputItemErrorWhenReadingChanged,
322                       input_item_changed, p_playlist );
323
324     return p_item;
325
326 error:
327     free( p_item );
328     return NULL;
329 }
330
331 /***************************************************************************
332  * Playlist item destruction
333  ***************************************************************************/
334
335 /**
336  * Release an item
337  *
338  * \param p_item item to delete
339 */
340 void playlist_ItemRelease( playlist_t *p_playlist, playlist_item_t *p_item )
341 {
342     playlist_private_t *p = pl_priv(p_playlist);
343
344     PL_ASSERT_LOCKED;
345
346     vlc_event_manager_t *p_em = &p_item->p_input->event_manager;
347
348     vlc_event_detach( p_em, vlc_InputItemSubItemTreeAdded,
349                       input_item_add_subitem_tree, p_playlist );
350     vlc_event_detach( p_em, vlc_InputItemMetaChanged,
351                       input_item_changed, p_playlist );
352     vlc_event_detach( p_em, vlc_InputItemDurationChanged,
353                       input_item_changed, p_playlist );
354     vlc_event_detach( p_em, vlc_InputItemNameChanged,
355                       input_item_changed, p_playlist );
356     vlc_event_detach( p_em, vlc_InputItemInfoChanged,
357                       input_item_changed, p_playlist );
358     vlc_event_detach( p_em, vlc_InputItemErrorWhenReadingChanged,
359                       input_item_changed, p_playlist );
360
361     input_item_Release( p_item->p_input );
362
363     tdelete( p_item, &p->input_tree, playlist_ItemCmpInput );
364     tdelete( p_item, &p->id_tree, playlist_ItemCmpId );
365     free( p_item->pp_children );
366     free( p_item );
367 }
368
369 /**
370  * Finds a playlist item by ID.
371  *
372  * Searches for a playlist item with the given ID.
373  *
374  * \note The playlist must be locked, and the result is only valid until the
375  * playlist is unlocked.
376  *
377  * \warning If an item with the given ID is deleted, it is unlikely but
378  * possible that another item will get the same ID. This can result in
379  * mismatches.
380  * Where holding a reference to an input item is a viable option, then
381  * playlist_ItemGetByInput() should be used instead - to avoid this issue.
382  *
383  * @param p_playlist the playlist
384  * @param id ID to look for
385  * @return the matching item or NULL if not found
386  */
387 playlist_item_t *playlist_ItemGetById( playlist_t *p_playlist , int id )
388 {
389     playlist_private_t *p = pl_priv(p_playlist);
390     playlist_item_t key, **pp;
391
392     PL_ASSERT_LOCKED;
393     key.i_id = id;
394     pp = tfind( &key, &p->id_tree, playlist_ItemCmpId );
395     return (pp != NULL) ? *pp : NULL;
396 }
397
398 /**
399  * Finds a playlist item by input item.
400  *
401  * Searches for a playlist item for the given input item.
402  *
403  * \note The playlist must be locked, and the result is only valid until the
404  * playlist is unlocked.
405  *
406  * \param p_playlist the playlist
407  * \param item input item to look for
408  * \return the playlist item or NULL on failure
409  */
410 playlist_item_t *playlist_ItemGetByInput( playlist_t * p_playlist,
411                                           const input_item_t *item )
412 {
413     playlist_private_t *p = pl_priv(p_playlist);
414     playlist_item_t key, **pp;
415
416     PL_ASSERT_LOCKED;
417     key.p_input = (input_item_t *)item;
418     pp = tfind( &key, &p->input_tree, playlist_ItemCmpInput );
419     return (pp != NULL) ? *pp : NULL;
420 }
421
422 /**
423  * Clear the playlist
424  *
425  * \param p_playlist playlist object
426  * \param b_locked TRUE if the playlist is locked
427  * \return nothing
428  */
429 void playlist_Clear( playlist_t * p_playlist, bool b_locked )
430 {
431     playlist_item_t *p_root = p_playlist->p_playing;
432
433     PL_LOCK_IF( !b_locked );
434
435     for( int i = p_root->i_children - 1; i >= 0 ;i-- )
436         playlist_NodeDelete( p_playlist, p_root->pp_children[i] );
437
438     PL_UNLOCK_IF( !b_locked );
439 }
440
441 /***************************************************************************
442  * Playlist item addition
443  ***************************************************************************/
444 /**
445  * Playlist add
446  *
447  * Add an item to the playlist
448  * \param p_playlist the playlist to add into
449  * \param psz_uri the mrl to add to the playlist
450  * \param play_now whether to start playing immediately or not
451  * \return VLC_SUCCESS or a VLC error code
452  */
453 int playlist_Add( playlist_t *p_playlist, const char *psz_uri, bool play_now )
454 {
455     return playlist_AddExt( p_playlist, psz_uri, NULL, play_now,
456                             0, NULL, 0, true );
457 }
458
459 /**
460  * Add a MRL into the playlist or the media library, duration and options given
461  *
462  * \param p_playlist the playlist to add into
463  * \param psz_uri the mrl to add to the playlist
464  * \param psz_name a text giving a name or description of this item
465  * \param play_now whether to start playing immediately or not
466  * \param i_options the number of options
467  * \param ppsz_options an array of options
468  * \param i_option_flags options flags
469  * \param b_playlist TRUE for playlist, FALSE for media library
470  * \return VLC_SUCCESS or a VLC error code
471 */
472 int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
473                      const char *psz_name, bool play_now,
474                      int i_options, const char *const *ppsz_options,
475                      unsigned i_option_flags,
476                      bool b_playlist )
477 {
478     input_item_t *p_input = input_item_New( psz_uri, psz_name );
479     if( !p_input )
480         return VLC_ENOMEM;
481     input_item_AddOptions( p_input, i_options, ppsz_options, i_option_flags );
482     int i_ret = playlist_AddInput( p_playlist, p_input, play_now, b_playlist );
483     input_item_Release( p_input );
484     return i_ret;
485 }
486
487 /**
488  * Add an input item to the playlist node
489  *
490  * \param p_playlist the playlist to add into
491  * \param p_input the input item to add
492  * \param i_mode the mode used when adding
493  * \param b_playlist TRUE for playlist, FALSE for media library
494  * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
495 */
496 int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
497                        bool play_now, bool b_playlist )
498 {
499     PL_LOCK;
500     playlist_item_t *item = b_playlist ? p_playlist->p_playing
501                                        : p_playlist->p_media_library;
502
503     item = playlist_NodeAddInput( p_playlist, p_input, item, PLAYLIST_END );
504
505     if( likely(item != NULL) && play_now )
506         playlist_ViewPlay( p_playlist, NULL, item );
507     PL_UNLOCK;
508     return (item != NULL) ? VLC_SUCCESS : VLC_ENOMEM;
509 }
510
511 /**
512  * Add an input item to a given node
513  *
514  * \param p_playlist the playlist to add into
515  * \param p_input the input item to add
516  * \param p_parent the parent item to add into
517  * \param i_pos the position in the playlist where to add. If this is
518  *        PLAYLIST_END the item will be added at the end of the playlist
519  *        regardless of its size
520  * \return the new playlist item
521  */
522 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
523                                          input_item_t *p_input,
524                                          playlist_item_t *p_parent, int i_pos )
525 {
526     PL_ASSERT_LOCKED;
527
528     assert( p_input );
529     assert( p_parent && p_parent->i_children != -1 );
530
531     playlist_item_t *p_item = playlist_ItemNewFromInput( p_playlist, p_input );
532     if( unlikely(p_item == NULL) )
533         return NULL;
534
535     if( p_input->i_type != ITEM_TYPE_NODE )
536         ARRAY_APPEND(p_playlist->items, p_item);
537
538     playlist_NodeInsert( p_parent, p_item, i_pos );
539     playlist_SendAddNotify( p_playlist, p_item );
540     playlist_Preparse( p_playlist, p_item );
541
542     return p_item;
543 }
544
545 /**
546  * Copy an item (and all its children, if any) into another node
547  *
548  * \param p_playlist the playlist to operate on
549  * \param p_item the playlist item to copy
550  * \param p_parent the parent item to copy into
551  * \param i_pos the position in the parent item for the new copy;
552  *              if this is PLAYLIST_END, the copy is appended after all
553  *              parent's children
554  * \return the position in parent item just behind the last new item inserted
555  */
556 int playlist_NodeAddCopy( playlist_t *p_playlist, playlist_item_t *p_item,
557     playlist_item_t *p_parent, int i_pos )
558 {
559     PL_ASSERT_LOCKED;
560     assert( p_parent != NULL && p_item != NULL );
561     assert( p_parent->i_children > -1 );
562
563     if( i_pos == PLAYLIST_END )
564         i_pos = p_parent->i_children;
565
566     bool b_flat = false;
567
568     for( playlist_item_t* p_up = p_parent; p_up; p_up = p_up->p_parent )
569     {
570         if( p_up == p_playlist->p_playing && !pl_priv(p_playlist)->b_tree )
571             b_flat = true;
572
573         if( p_up == p_item )
574             /* TODO: We don't support copying a node into itself (yet),
575             because we insert items as we copy. Instead, we should copy
576             all items first and then insert. */
577             return i_pos;
578     }
579
580     return RecursiveInsertCopy( p_playlist, p_item, p_parent, i_pos, b_flat );
581 }
582
583 /**
584  * Insert a tree of input items into a given playlist node
585  *
586  * \param p_playlist the playlist to insert into
587  * \param p_parent the receiving playlist node (can be an item)
588  * \param p_node the root of input item tree,
589           only it's contents will be inserted
590  * \param i_pos the position in the playlist where to insert. If this is
591  *        PLAYLIST_END the items will be added at the end of the playlist
592  *        regardless of its size
593  * \param b_flat TRUE if the new tree contents should be flattened into a list
594  * \return the first new leaf inserted (in playing order)
595  */
596 int playlist_InsertInputItemTree (
597     playlist_t *p_playlist, playlist_item_t *p_parent,
598     input_item_node_t *p_node, int i_pos, bool b_flat )
599 {
600     return RecursiveAddIntoParent( p_playlist, p_parent, p_node, i_pos, b_flat,
601                                    &(playlist_item_t*){ NULL } );
602 }
603
604
605 /*****************************************************************************
606  * Playlist item misc operations
607  *****************************************************************************/
608
609 static int ItemIndex ( playlist_item_t *p_item )
610 {
611     int idx;
612
613     TAB_FIND( p_item->p_parent->i_children,
614               p_item->p_parent->pp_children,
615               p_item,
616               idx );
617
618     return idx;
619 }
620
621 /**
622  * Moves an item
623  *
624  * This function must be entered with the playlist lock
625  *
626  * \param p_playlist the playlist
627  * \param p_item the item to move
628  * \param p_node the new parent of the item
629  * \param i_newpos the new position under this new parent
630  * \return VLC_SUCCESS or an error
631  */
632 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
633                        playlist_item_t *p_node, int i_newpos )
634 {
635     PL_ASSERT_LOCKED;
636
637     if( p_node->i_children == -1 ) return VLC_EGENERIC;
638
639     playlist_item_t *p_detach = p_item->p_parent;
640     int i_index = ItemIndex( p_item );
641
642     TAB_ERASE(p_detach->i_children, p_detach->pp_children, i_index);
643
644     if( p_detach == p_node && i_index < i_newpos )
645         i_newpos--;
646
647     TAB_INSERT(p_node->i_children, p_node->pp_children, p_item, i_newpos);
648     p_item->p_parent = p_node;
649
650     pl_priv( p_playlist )->b_reset_currently_playing = true;
651     vlc_cond_signal( &pl_priv( p_playlist )->signal );
652     return VLC_SUCCESS;
653 }
654
655 /**
656  * Moves an array of items
657  *
658  * This function must be entered with the playlist lock
659  *
660  * \param p_playlist the playlist
661  * \param i_items the number of indexes to move
662  * \param pp_items the array of indexes to move
663  * \param p_node the target node
664  * \param i_newpos the target position under this node
665  * \return VLC_SUCCESS or an error
666  */
667 int playlist_TreeMoveMany( playlist_t *p_playlist,
668                             int i_items, playlist_item_t **pp_items,
669                             playlist_item_t *p_node, int i_newpos )
670 {
671     PL_ASSERT_LOCKED;
672
673     if ( p_node->i_children == -1 ) return VLC_EGENERIC;
674
675     for( int i = 0; i < i_items; i++ )
676     {
677         playlist_item_t *p_item = pp_items[i];
678         int i_index = ItemIndex( p_item );
679         playlist_item_t *p_parent = p_item->p_parent;
680         TAB_ERASE(p_parent->i_children, p_parent->pp_children, i_index);
681         if ( p_parent == p_node && i_index < i_newpos ) i_newpos--;
682     }
683     for( int i = i_items - 1; i >= 0; i-- )
684     {
685         playlist_item_t *p_item = pp_items[i];
686         TAB_INSERT(p_node->i_children, p_node->pp_children, p_item, i_newpos);
687         p_item->p_parent = p_node;
688     }
689
690     pl_priv( p_playlist )->b_reset_currently_playing = true;
691     vlc_cond_signal( &pl_priv( p_playlist )->signal );
692     return VLC_SUCCESS;
693 }
694
695 /**
696  * Send a notification that an item has been added to a node
697  *
698  * \param p_playlist the playlist object
699  * \param i_item_id id of the item added
700  * \param i_node_id id of the node in which the item was added
701  * \return nothing
702  */
703 void playlist_SendAddNotify( playlist_t *p_playlist, playlist_item_t *item )
704 {
705     playlist_private_t *p_sys = pl_priv(p_playlist);
706     PL_ASSERT_LOCKED;
707
708     p_sys->b_reset_currently_playing = true;
709     vlc_cond_signal( &p_sys->signal );
710
711     var_SetAddress( p_playlist, "playlist-item-append", item );
712 }
713
714 /**
715  * Get the duration of all items in a node.
716  */
717 vlc_tick_t playlist_GetNodeDuration( playlist_item_t* node )
718 {
719     vlc_tick_t duration = input_item_GetDuration( node->p_input );
720     if( duration == VLC_TICK_INVALID )
721         duration = 0;
722
723     for( int i = 0; i < node->i_children; i++ )
724         duration += playlist_GetNodeDuration( node->pp_children[i] );
725
726     return duration;
727 }
728
729 /***************************************************************************
730  * The following functions are local
731  ***************************************************************************/
732
733 /* Enqueue an item for preparsing */
734 static void playlist_Preparse( playlist_t *p_playlist,
735                                playlist_item_t *p_item )
736 {
737     playlist_private_t *sys = pl_priv(p_playlist);
738     input_item_t *input = p_item->p_input;
739
740     PL_ASSERT_LOCKED;
741     /* Preparse if no artist/album info, and hasn't been preparsed already
742        and if user has some preparsing option (auto-preparse variable)
743        enabled*/
744     char *psz_artist = input_item_GetArtist( input );
745     char *psz_album = input_item_GetAlbum( input );
746
747     if( sys->b_preparse && !input_item_IsPreparsed( input )
748      && (EMPTY_STR(psz_artist) || EMPTY_STR(psz_album)) )
749         libvlc_MetadataRequest( p_playlist->obj.libvlc, input, 0, -1, p_item );
750     free( psz_artist );
751     free( psz_album );
752 }
753
754 /* Actually convert an item to a node */
755 static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
756 {
757     int i;
758     if( p_item->i_children != -1 ) return;
759
760     p_item->i_children = 0;
761
762     input_item_t *p_input = p_item->p_input;
763     vlc_mutex_lock( &p_input->lock );
764     p_input->i_type = ITEM_TYPE_NODE;
765     vlc_mutex_unlock( &p_input->lock );
766
767     var_SetAddress( p_playlist, "item-change", p_item->p_input );
768
769     /* Remove it from the array of available items */
770     ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
771     if( i != -1 )
772         ARRAY_REMOVE( p_playlist->items, i );
773 }
774
775 static int RecursiveAddIntoParent (
776     playlist_t *p_playlist, playlist_item_t *p_parent,
777     input_item_node_t *p_node, int i_pos, bool b_flat,
778     playlist_item_t **pp_first_leaf )
779 {
780     *pp_first_leaf = NULL;
781
782     if( p_parent->i_children == -1 ) ChangeToNode( p_playlist, p_parent );
783
784     if( i_pos == PLAYLIST_END ) i_pos = p_parent->i_children;
785
786     for( int i = 0; i < p_node->i_children; i++ )
787     {
788         input_item_node_t *p_child_node = p_node->pp_children[i];
789
790         playlist_item_t *p_new_item = NULL;
791         bool b_children = p_child_node->i_children > 0;
792
793         //Create the playlist item represented by input node, if allowed.
794         if( !(b_flat && b_children) )
795         {
796             p_new_item = playlist_NodeAddInput( p_playlist,
797                                                 p_child_node->p_item,
798                                                 p_parent, i_pos );
799             if( !p_new_item ) return i_pos;
800
801             i_pos++;
802         }
803         //Recurse if any children
804         if( b_children )
805         {
806             //Substitute p_new_item for first child leaf
807             //(If flat, continue counting from current position)
808             int i_last_pos = RecursiveAddIntoParent(
809                     p_playlist,
810                     p_new_item ? p_new_item : p_parent,
811                     p_child_node,
812                     ( b_flat ? i_pos : 0 ),
813                     b_flat,
814                     &p_new_item );
815             //If flat, take position after recursion as current position
816             if( b_flat ) i_pos = i_last_pos;
817         }
818
819         assert( p_new_item != NULL );
820         if( i == 0 ) *pp_first_leaf = p_new_item;
821     }
822     return i_pos;
823 }
824
825 static int RecursiveInsertCopy (
826     playlist_t *p_playlist, playlist_item_t *p_item,
827     playlist_item_t *p_parent, int i_pos, bool b_flat )
828 {
829     PL_ASSERT_LOCKED;
830     assert( p_parent != NULL && p_item != NULL );
831
832     if( p_item == p_parent ) return i_pos;
833
834     input_item_t *p_input = p_item->p_input;
835
836     if( p_item->i_children == -1 || !b_flat )
837     {
838         playlist_item_t *p_new_item = NULL;
839
840         if( p_item->i_children == -1 )
841         {
842             input_item_t *p_new_input = input_item_Copy( p_input );
843
844             if( likely(p_new_input != NULL) )
845             {
846                 p_new_item = playlist_NodeAddInput( p_playlist, p_new_input,
847                                                     p_parent, i_pos );
848                 input_item_Release( p_new_input );
849             }
850         }
851         else
852         {
853             vlc_mutex_lock( &p_input->lock );
854             p_new_item = playlist_NodeCreate( p_playlist, p_input->psz_name,
855                                               p_parent, i_pos, 0 );
856             vlc_mutex_unlock( &p_input->lock );
857         }
858         if( unlikely(p_new_item == NULL) )
859             return i_pos;
860
861         i_pos++;
862
863         if( p_new_item->i_children != -1 )
864             p_parent = p_new_item;
865     }
866
867     for( int i = 0; i < p_item->i_children; i++ )
868     {
869         if( b_flat )
870             i_pos = RecursiveInsertCopy( p_playlist, p_item->pp_children[i],
871                                          p_parent, i_pos, true );
872         else
873             RecursiveInsertCopy( p_playlist, p_item->pp_children[i],
874                                  p_parent, p_parent->i_children, false );
875     }
876
877     return i_pos;
878 }