]> git.sesse.net Git - vlc/blob - src/playlist/item.c
playlist: make playlist_DeleteFromInput delete container nodes as well
[vlc] / src / playlist / item.c
1 /*****************************************************************************
2  * item.c : Playlist item creation/deletion/add/removal functions
3  *****************************************************************************
4  * Copyright (C) 1999-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          ClĂ©ment Stenac <zorglub@videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 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 General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, 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 <vlc_common.h>
29 #include <assert.h>
30 #include <vlc_playlist.h>
31 #include "playlist_internal.h"
32
33 static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
34                      playlist_item_t *p_node, int i_mode, int i_pos );
35 static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
36                            playlist_item_t *, playlist_item_t * );
37 static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item );
38
39 static playlist_item_t *ItemToNode( playlist_t *, playlist_item_t *, bool );
40
41 /*****************************************************************************
42  * An input item has gained a subitem (Event Callback)
43  *****************************************************************************/
44 static void input_item_subitem_added( const vlc_event_t * p_event,
45                                       void * user_data )
46 {
47     playlist_item_t *p_parent_playlist_item = user_data;
48     playlist_t * p_playlist = p_parent_playlist_item->p_playlist;
49     input_item_t * p_parent, * p_child;
50     playlist_item_t * p_child_in_category;
51     playlist_item_t * p_item_in_category;
52     bool b_play;
53
54     p_parent = p_event->p_obj;
55     p_child = p_event->u.input_item_subitem_added.p_new_child;
56
57     PL_LOCK;
58     b_play = var_CreateGetBool( p_playlist, "playlist-autostart" );
59
60     /* This part is really hakish, but this playlist system isn't simple */
61     /* First check if we haven't already added the item as we are
62      * listening using the onelevel and the category representent
63      * (Because of the playlist design) */
64     p_child_in_category = playlist_ItemFindFromInputAndRoot(
65                             p_playlist, p_child,
66                             p_playlist->p_root_category,
67                             false /* Only non-node */ );
68
69     if( !p_child_in_category )
70     {
71         /* Then, transform to a node if needed */
72         p_item_in_category = playlist_ItemFindFromInputAndRoot(
73                                 p_playlist, p_parent,
74                                 p_playlist->p_root_category,
75                                 false /* Only non-node */ );
76         if( !p_item_in_category )
77         {
78             /* Item may have been removed */
79             PL_UNLOCK;
80             return;
81         }
82
83         bool b_stop = p_item_in_category->i_flags & PLAYLIST_SUBITEM_STOP_FLAG;
84
85         b_play = b_play &&
86             p_item_in_category == get_current_status_item( p_playlist ) &&
87             p_item_in_category->i_children == -1;
88
89         /* If this item is already a node don't transform it */
90         if( p_item_in_category->i_children == -1 )
91         {
92             p_item_in_category = ItemToNode( p_playlist,
93                     p_item_in_category, pl_Locked );
94             p_item_in_category->p_input->i_type = ITEM_TYPE_PLAYLIST;
95         }
96
97         int i_ret = playlist_BothAddInput( p_playlist, p_child,
98                 p_item_in_category,
99                 PLAYLIST_APPEND | PLAYLIST_SPREPARSE , PLAYLIST_END,
100                 NULL, NULL, pl_Locked );
101
102         if( i_ret == VLC_SUCCESS && b_play )
103         {
104             if( b_stop )
105             {
106                 p_item_in_category->i_flags &= ~PLAYLIST_SUBITEM_STOP_FLAG;
107                 PL_UNLOCK;
108                 playlist_Stop( p_playlist );
109                 return;
110             }
111             playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
112                           pl_Locked, p_item_in_category, NULL );
113         }
114     }
115
116     PL_UNLOCK;
117
118 }
119
120 /*****************************************************************************
121  * An input item's meta or duration has changed (Event Callback)
122  *****************************************************************************/
123 static void input_item_changed( const vlc_event_t * p_event,
124                                 void * user_data )
125 {
126     playlist_item_t *p_item = user_data;
127     VLC_UNUSED( p_event );
128     var_SetAddress( p_item->p_playlist, "item-change", p_item->p_input );
129 }
130
131 /*****************************************************************************
132  * Listen to vlc_InputItemAddSubItem event
133  *****************************************************************************/
134 static void install_input_item_observer( playlist_item_t * p_item )
135 {
136     vlc_event_manager_t * p_em = &p_item->p_input->event_manager;
137     vlc_event_attach( p_em, vlc_InputItemSubItemAdded,
138                       input_item_subitem_added, p_item );
139     vlc_event_attach( p_em, vlc_InputItemDurationChanged,
140                       input_item_changed, p_item );
141     vlc_event_attach( p_em, vlc_InputItemMetaChanged,
142                       input_item_changed, p_item );
143     vlc_event_attach( p_em, vlc_InputItemNameChanged,
144                       input_item_changed, p_item );
145     vlc_event_attach( p_em, vlc_InputItemInfoChanged,
146                       input_item_changed, p_item );
147     vlc_event_attach( p_em, vlc_InputItemErrorWhenReadingChanged,
148                       input_item_changed, p_item );
149 }
150
151 static void uninstall_input_item_observer( playlist_item_t * p_item )
152 {
153     vlc_event_manager_t * p_em = &p_item->p_input->event_manager;
154     vlc_event_detach( p_em, vlc_InputItemSubItemAdded,
155                       input_item_subitem_added, p_item );
156     vlc_event_detach( p_em, vlc_InputItemMetaChanged,
157                       input_item_changed, p_item );
158     vlc_event_detach( p_em, vlc_InputItemDurationChanged,
159                       input_item_changed, p_item );
160     vlc_event_detach( p_em, vlc_InputItemNameChanged,
161                       input_item_changed, p_item );
162     vlc_event_detach( p_em, vlc_InputItemInfoChanged,
163                       input_item_changed, p_item );
164     vlc_event_detach( p_em, vlc_InputItemErrorWhenReadingChanged,
165                       input_item_changed, p_item );
166 }
167
168 /*****************************************************************************
169  * Playlist item creation
170  *****************************************************************************/
171 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
172                                               input_item_t *p_input, bool install_observer )
173 {
174     playlist_item_t* p_item = malloc( sizeof( playlist_item_t ) );
175     if( !p_item )
176         return NULL;
177
178     assert( p_input );
179
180     p_item->p_input = p_input;
181     vlc_gc_incref( p_item->p_input );
182
183     p_item->i_id = ++pl_priv(p_playlist)->i_last_playlist_id;
184
185     p_item->p_parent = NULL;
186     p_item->i_children = -1;
187     p_item->pp_children = NULL;
188     p_item->i_flags = 0;
189     p_item->p_playlist = p_playlist;
190     p_item->b_input_item_observer = install_observer;
191
192     if( install_observer )
193         install_input_item_observer( p_item );
194
195     return p_item;
196 }
197
198 /***************************************************************************
199  * Playlist item destruction
200  ***************************************************************************/
201
202 /**
203  * Release an item
204  *
205  * \param p_item item to delete
206  * \return VLC_SUCCESS
207 */
208 int playlist_ItemRelease( playlist_item_t *p_item )
209 {
210     /* For the assert */
211     playlist_t *p_playlist = p_item->p_playlist;
212     PL_ASSERT_LOCKED;
213
214     /* Surprise, we can't actually do more because we
215      * don't do refcounting, or eauivalent.
216      * Because item are not only accessed by their id
217      * using playlist_item outside the PL_LOCK isn't safe.
218      * Most of the modules does that.
219      *
220      * Who wants to add proper memory management? */
221     if( p_item->b_input_item_observer )
222         uninstall_input_item_observer( p_item );
223     ARRAY_APPEND( pl_priv(p_playlist)->items_to_delete, p_item);
224     return VLC_SUCCESS;
225 }
226
227 /**
228  * Delete input item
229  *
230  * Remove an input item when it appears from a root playlist item
231  * \param p_playlist playlist object
232  * \param p_input the input to delete
233  * \param p_root root playlist item
234  * \param b_do_stop must stop or not the playlist
235  * \return VLC_SUCCESS or VLC_EGENERIC
236 */
237 static int DeleteFromInput( playlist_t *p_playlist, input_item_t *p_input,
238                             playlist_item_t *p_root, bool b_do_stop )
239 {
240     PL_ASSERT_LOCKED;
241     playlist_item_t *p_item = playlist_ItemFindFromInputAndRoot(
242         p_playlist, p_input, p_root, false );
243     if( !p_item ) return VLC_EGENERIC;
244     return playlist_DeleteItem( p_playlist, p_item, b_do_stop );
245 }
246
247 /**
248  * Delete input item
249  *
250  * Remove an input item when it appears from a root playlist item
251  * \param p_playlist playlist object
252  * \param p_input the input to delete
253  * \param p_root root playlist item
254  * \param b_locked TRUE if the playlist is locked
255  * \return VLC_SUCCESS or VLC_EGENERIC
256  */
257 int playlist_DeleteFromInputInParent( playlist_t *p_playlist,
258                                       input_item_t *p_item,
259                                       playlist_item_t *p_root, bool b_locked )
260 {
261     int i_ret;
262     PL_LOCK_IF( !b_locked );
263     i_ret = DeleteFromInput( p_playlist, p_item, p_root, true );
264     PL_UNLOCK_IF( !b_locked );
265     return i_ret;
266 }
267
268 /**
269  * Delete from input
270  *
271  * Remove an input item from ONELEVEL and CATEGORY
272  * \param p_playlist playlist object
273  * \param p_input the input to delete
274  * \param b_locked TRUE if the playlist is locked
275  * \return VLC_SUCCESS or VLC_ENOITEM
276  */
277 int playlist_DeleteFromInput( playlist_t *p_playlist, input_item_t *p_input,
278                               bool b_locked )
279 {
280     int i_ret1, i_ret2;
281     PL_LOCK_IF( !b_locked );
282     i_ret1 = DeleteFromInput( p_playlist, p_input,
283                              p_playlist->p_root_category, true );
284     i_ret2 = DeleteFromInput( p_playlist, p_input,
285                      p_playlist->p_root_onelevel, true );
286     PL_UNLOCK_IF( !b_locked );
287     return ( i_ret1 == VLC_SUCCESS || i_ret2 == VLC_SUCCESS ) ?
288                             VLC_SUCCESS : VLC_ENOITEM;
289 }
290
291 /**
292  * Clear the playlist
293  *
294  * \param p_playlist playlist object
295  * \param b_locked TRUE if the playlist is locked
296  * \return nothing
297  */
298 void playlist_Clear( playlist_t * p_playlist, bool b_locked )
299 {
300     PL_LOCK_IF( !b_locked );
301     playlist_NodeEmpty( p_playlist, p_playlist->p_local_category, true );
302     playlist_NodeEmpty( p_playlist, p_playlist->p_local_onelevel, true );
303     PL_UNLOCK_IF( !b_locked );
304 }
305
306 /**
307  * Delete playlist item
308  *
309  * Remove a playlist item from the playlist, given its id
310  * This function is to be used only by the playlist
311  * \param p_playlist playlist object
312  * \param i_id id of the item do delete
313  * \return VLC_SUCCESS or an error
314  */
315 int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
316 {
317     PL_ASSERT_LOCKED;
318     playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id );
319     if( !p_item ) return VLC_EGENERIC;
320     return playlist_DeleteItem( p_playlist, p_item, true );
321 }
322
323 /***************************************************************************
324  * Playlist item addition
325  ***************************************************************************/
326 /**
327  * Playlist add
328  *
329  * Add an item to the playlist or the media library
330  * \param p_playlist the playlist to add into
331  * \param psz_uri the mrl to add to the playlist
332  * \param psz_name a text giving a name or description of this item
333  * \param i_mode the mode used when adding
334  * \param i_pos the position in the playlist where to add. If this is
335  *        PLAYLIST_END the item will be added at the end of the playlist
336  *        regardless of its size
337  * \param b_playlist TRUE for playlist, FALSE for media library
338  * \param b_locked TRUE if the playlist is locked
339  * \return VLC_SUCCESS or a VLC error code
340  */
341 int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
342                   const char *psz_name, int i_mode, int i_pos,
343                   bool b_playlist, bool b_locked )
344 {
345     return playlist_AddExt( p_playlist, psz_uri, psz_name,
346                             i_mode, i_pos, -1, 0, NULL, 0, b_playlist, b_locked );
347 }
348
349 /**
350  * Add a MRL into the playlist or the media library, duration and options given
351  *
352  * \param p_playlist the playlist to add into
353  * \param psz_uri the mrl to add to the playlist
354  * \param psz_name a text giving a name or description of this item
355  * \param i_mode the mode used when adding
356  * \param i_pos the position in the playlist where to add. If this is
357  *        PLAYLIST_END the item will be added at the end of the playlist
358  *        regardless of its size
359  * \param i_duration length of the item in milliseconds.
360  * \param i_options the number of options
361  * \param ppsz_options an array of options
362  * \param i_option_flags options flags
363  * \param b_playlist TRUE for playlist, FALSE for media library
364  * \param b_locked TRUE if the playlist is locked
365  * \return VLC_SUCCESS or a VLC error code
366 */
367 int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
368                      const char *psz_name, int i_mode, int i_pos,
369                      mtime_t i_duration,
370                      int i_options, const char *const *ppsz_options,
371                      unsigned i_option_flags,
372                      bool b_playlist, bool b_locked )
373 {
374     int i_ret;
375     input_item_t *p_input;
376
377     p_input = input_item_NewExt( p_playlist, psz_uri, psz_name,
378                                  i_options, ppsz_options, i_option_flags,
379                                  i_duration );
380     if( p_input == NULL )
381         return VLC_ENOMEM;
382     i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
383                                b_locked );
384     vlc_gc_decref( p_input );
385     return i_ret;
386 }
387
388 /**
389  * Add an input item to the playlist node
390  *
391  * \param p_playlist the playlist to add into
392  * \param p_input the input item to add
393  * \param i_mode the mode used when adding
394  * \param i_pos the position in the playlist where to add. If this is
395  *        PLAYLIST_END the item will be added at the end of the playlist
396  *        regardless of its size
397  * \param b_playlist TRUE for playlist, FALSE for media library
398  * \param b_locked TRUE if the playlist is locked
399  * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
400 */
401 int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
402                        int i_mode, int i_pos, bool b_playlist,
403                        bool b_locked )
404 {
405     playlist_item_t *p_item_cat, *p_item_one;
406     if( p_playlist->b_die ) return VLC_EGENERIC;
407     if( !pl_priv(p_playlist)->b_doing_ml )
408         PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
409                                              p_input->psz_uri );
410
411     PL_LOCK_IF( !b_locked );
412
413     /* Add to ONELEVEL */
414     p_item_one = playlist_ItemNewFromInput( p_playlist, p_input, false );
415     if( p_item_one == NULL ) return VLC_ENOMEM;
416     AddItem( p_playlist, p_item_one,
417              b_playlist ? p_playlist->p_local_onelevel :
418                           p_playlist->p_ml_onelevel , i_mode, i_pos );
419
420     /* Add to CATEGORY */
421     p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input, true );
422     if( p_item_cat == NULL ) return VLC_ENOMEM;
423     AddItem( p_playlist, p_item_cat,
424              b_playlist ? p_playlist->p_local_category :
425                           p_playlist->p_ml_category , i_mode, i_pos );
426
427     GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
428
429     PL_UNLOCK_IF( !b_locked );
430     return VLC_SUCCESS;
431 }
432
433 /**
434  * Add input
435  *
436  * Add an input item to p_direct_parent in the category tree, and to the
437  * matching top category in onelevel
438  * \param p_playlist the playlist to add into
439  * \param p_input the input item to add
440  * \param p_direct_parent the parent item to add into
441  * \param i_mode the mode used when adding
442  * \param i_pos the position in the playlist where to add. If this is
443  *        PLAYLIST_END the item will be added at the end of the playlist
444  *        regardless of its size
445  * \param i_cat id of the items category
446  * \param i_one id of the item onelevel category
447  * \param b_locked TRUE if the playlist is locked
448  * \return VLC_SUCCESS if success, VLC_EGENERIC if fail, VLC_ENOMEM if OOM
449  */
450 int playlist_BothAddInput( playlist_t *p_playlist,
451                            input_item_t *p_input,
452                            playlist_item_t *p_direct_parent,
453                            int i_mode, int i_pos,
454                            int *i_cat, int *i_one, bool b_locked )
455 {
456     playlist_item_t *p_item_cat, *p_item_one, *p_up;
457     int i_top;
458     assert( p_input );
459
460     if( !vlc_object_alive( p_playlist ) )
461         return VLC_EGENERIC;
462
463     PL_LOCK_IF( !b_locked );
464
465     /* Add to category */
466     p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input, true );
467     if( p_item_cat == NULL ) return VLC_ENOMEM;
468     AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
469
470     /* Add to onelevel */
471     /** \todo make a faster case for ml import */
472     p_item_one = playlist_ItemNewFromInput( p_playlist, p_input, false );
473     if( p_item_one == NULL ) return VLC_ENOMEM;
474
475     p_up = p_direct_parent;
476     while( p_up->p_parent != p_playlist->p_root_category )
477     {
478         p_up = p_up->p_parent;
479     }
480     for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
481     {
482         if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input ==
483                              p_up->p_input )
484         {
485             AddItem( p_playlist, p_item_one,
486                      p_playlist->p_root_onelevel->pp_children[i_top],
487                      i_mode, i_pos );
488             break;
489         }
490     }
491     GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
492
493     if( i_cat ) *i_cat = p_item_cat->i_id;
494     if( i_one ) *i_one = p_item_one->i_id;
495
496     PL_UNLOCK_IF( !b_locked );
497     return VLC_SUCCESS;
498 }
499
500 /**
501  * Add an input item to a given node
502  *
503  * \param p_playlist the playlist to add into
504  * \param p_input the input item to add
505  * \param p_parent the parent item to add into
506  * \param i_mode the mode used when addin
507  * \param i_pos the position in the playlist where to add. If this is
508  *        PLAYLIST_END the item will be added at the end of the playlist
509  *        regardless of its size
510  * \param b_locked TRUE if the playlist is locked
511  * \return the new playlist item
512  */
513 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
514                                          input_item_t *p_input,
515                                          playlist_item_t *p_parent,
516                                          int i_mode, int i_pos,
517                                          bool b_locked )
518 {
519     playlist_item_t *p_item;
520     assert( p_input );
521     assert( p_parent && p_parent->i_children != -1 );
522
523     if( p_playlist->b_die )
524         return NULL;
525     PL_LOCK_IF( !b_locked );
526
527     p_item = playlist_ItemNewFromInput( p_playlist, p_input, true );
528     if( p_item == NULL ) return NULL;
529     AddItem( p_playlist, p_item, p_parent, i_mode, i_pos );
530
531     PL_UNLOCK_IF( !b_locked );
532
533     return p_item;
534 }
535
536 /*****************************************************************************
537  * Playlist item misc operations
538  *****************************************************************************/
539
540 /**
541  * Item to node
542  *
543  * Transform an item to a node. Return the node in the category tree, or NULL
544  * if not found there
545  * This function must be entered without the playlist lock
546  * \param p_playlist the playlist object
547  * \param p_item the item to transform
548  * \param b_locked TRUE if the playlist is locked
549  * \return the item transform in a node
550  */
551 static playlist_item_t *ItemToNode( playlist_t *p_playlist,
552                                     playlist_item_t *p_item,
553                                     bool b_locked )
554 {
555
556     playlist_item_t *p_item_in_category;
557     /* What we do
558      * Find the input in CATEGORY.
559      *  - If we find it
560      *    - change it to node
561      *    - we'll return it at the end
562      *    - If we are a direct child of onelevel root, change to node, else
563      *      delete the input from ONELEVEL
564      *  - If we don't find it, just change to node (we are probably in VLM)
565      *    and return NULL
566      *
567      * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
568      * useful for later BothAddInput )
569      */
570
571     PL_LOCK_IF( !b_locked );
572
573     /* Fast track the media library, no time to loose */
574     if( p_item == p_playlist->p_ml_category ) {
575         PL_UNLOCK_IF( !b_locked );
576         return p_item;
577     }
578
579     /** \todo First look if we don't already have it */
580     p_item_in_category = playlist_ItemFindFromInputAndRoot(
581                                             p_playlist, p_item->p_input,
582                                             p_playlist->p_root_category,
583                                             true );
584
585     if( p_item_in_category )
586     {
587         playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
588                                             p_playlist, p_item->p_input,
589                                             p_playlist->p_root_onelevel,
590                                             true );
591         assert( p_item_in_one );
592
593         /* We already have it, and there is nothing more to do */
594         ChangeToNode( p_playlist, p_item_in_category );
595
596         /* Item in one is a root, change it to node */
597         if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
598             ChangeToNode( p_playlist, p_item_in_one );
599         else
600         {
601             playlist_item_t *p_status_item = get_current_status_item( p_playlist );
602             playlist_item_t *p_status_node = get_current_status_node( p_playlist );
603             if( p_item_in_one == p_status_item )
604             {
605                 /* We're deleting the current playlist item. Update
606                  * the playlist object to point at the previous item
607                  * so the playlist won't be restarted */
608                 playlist_item_t *p_prev_status_item = NULL;
609                 int i = 0;
610                 while( i < p_status_node->i_children &&
611                        p_status_node->pp_children[i] != p_status_item )
612                 {
613                     p_prev_status_item = p_status_node->pp_children[i];
614                     i++;
615                 }
616                 if( i == p_status_node->i_children )
617                     p_prev_status_item = NULL;
618                 if( p_prev_status_item )
619                     set_current_status_item( p_playlist, p_prev_status_item );
620             }
621             DeleteFromInput( p_playlist, p_item_in_one->p_input,
622                              p_playlist->p_root_onelevel, false );
623         }
624         pl_priv(p_playlist)->b_reset_currently_playing = true;
625         vlc_cond_signal( &pl_priv(p_playlist)->signal );
626         var_SetAddress( p_playlist, "item-change", p_item_in_category->p_input );
627         var_SetAddress( p_playlist, "leaf-to-parent", p_item_in_category->p_input );
628         PL_UNLOCK_IF( !b_locked );
629         return p_item_in_category;
630     }
631     else
632     {
633         ChangeToNode( p_playlist, p_item );
634         PL_UNLOCK_IF( !b_locked );
635         return p_item;
636     }
637 }
638
639 /**
640  * Find an item within a root, given its input id.
641  *
642  * \param p_playlist the playlist object
643  * \param p_item the input item
644  * \param p_root root playlist item
645  * \param b_items_only TRUE if we want the item himself
646  * \return the first found item, or NULL if not found
647  */
648 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
649                                                     input_item_t *p_item,
650                                                     playlist_item_t *p_root,
651                                                     bool b_items_only )
652 {
653     int i;
654     for( i = 0 ; i< p_root->i_children ; i++ )
655     {
656         if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
657             p_root->pp_children[i]->p_input == p_item )
658         {
659             return p_root->pp_children[i];
660         }
661         else if( p_root->pp_children[i]->i_children >= 0 )
662         {
663             playlist_item_t *p_search =
664                  playlist_ItemFindFromInputAndRoot( p_playlist, p_item,
665                                                     p_root->pp_children[i],
666                                                     b_items_only );
667             if( p_search ) return p_search;
668         }
669     }
670     return NULL;
671 }
672
673
674 static int ItemIndex ( playlist_item_t *p_item )
675 {
676     for( int i = 0; i < p_item->p_parent->i_children; i++ )
677         if( p_item->p_parent->pp_children[i] == p_item ) return i;
678     return -1;
679 }
680
681 /**
682  * Moves an item
683  *
684  * This function must be entered with the playlist lock
685  *
686  * \param p_playlist the playlist
687  * \param p_item the item to move
688  * \param p_node the new parent of the item
689  * \param i_newpos the new position under this new parent
690  * \return VLC_SUCCESS or an error
691  */
692 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
693                        playlist_item_t *p_node, int i_newpos )
694 {
695     PL_ASSERT_LOCKED;
696
697     if( p_node->i_children == -1 ) return VLC_EGENERIC;
698
699     playlist_item_t *p_detach = p_item->p_parent;
700     int i_index = ItemIndex( p_item );
701
702     REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, i_index );
703
704     if( p_detach == p_node && i_index < i_newpos )
705         i_newpos--;
706
707     INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
708     p_item->p_parent = p_node;
709
710     pl_priv( p_playlist )->b_reset_currently_playing = true;
711     vlc_cond_signal( &pl_priv( p_playlist )->signal );
712     return VLC_SUCCESS;
713 }
714
715 /**
716  * Moves an array of items
717  *
718  * This function must be entered with the playlist lock
719  *
720  * \param p_playlist the playlist
721  * \param i_items the number of indexes to move
722  * \param pp_items the array of indexes to move
723  * \param p_node the target node
724  * \param i_newpos the target position under this node
725  * \return VLC_SUCCESS or an error
726  */
727 int playlist_TreeMoveMany( playlist_t *p_playlist,
728                             int i_items, playlist_item_t **pp_items,
729                             playlist_item_t *p_node, int i_newpos )
730 {
731     PL_ASSERT_LOCKED;
732
733     if ( p_node->i_children == -1 ) return VLC_EGENERIC;
734
735     int i;
736     for( i = 0; i < i_items; i++ )
737     {
738         playlist_item_t *p_item = pp_items[i];
739         int i_index = ItemIndex( p_item );
740         playlist_item_t *p_parent = p_item->p_parent;
741         REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i_index );
742         if ( p_parent == p_node && i_index < i_newpos ) i_newpos--;
743     }
744     for( i = i_items - 1; i >= 0; i-- )
745     {
746         playlist_item_t *p_item = pp_items[i];
747         INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
748         p_item->p_parent = p_node;
749     }
750
751     pl_priv( p_playlist )->b_reset_currently_playing = true;
752     vlc_cond_signal( &pl_priv( p_playlist )->signal );
753     return VLC_SUCCESS;
754 }
755
756 /**
757  * Send a notification that an item has been added to a node
758  *
759  * \param p_playlist the playlist object
760  * \param i_item_id id of the item added
761  * \param i_node_id id of the node in wich the item was added
762  * \param b_signal TRUE if the function must send a signal
763  * \return nothing
764  */
765 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
766                              int i_node_id, bool b_signal )
767 {
768     playlist_private_t *p_sys = pl_priv(p_playlist);
769     PL_ASSERT_LOCKED;
770
771     p_sys->b_reset_currently_playing = true;
772     if( b_signal )
773         vlc_cond_signal( &p_sys->signal );
774
775     playlist_add_t add;
776     add.i_item = i_item_id;
777     add.i_node = i_node_id;
778
779     vlc_value_t val;
780     val.p_address = &add;
781
782     var_Set( p_playlist, "playlist-item-append", val );
783 }
784
785 /***************************************************************************
786  * The following functions are local
787  ***************************************************************************/
788
789 /* Enqueue an item for preparsing, and play it, if needed */
790 static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
791                            playlist_item_t *p_item_cat,
792                            playlist_item_t *p_item_one )
793 {
794     PL_ASSERT_LOCKED;
795     if( (i_mode & PLAYLIST_GO ) )
796     {
797         playlist_item_t *p_parent = p_item_one;
798         playlist_item_t *p_toplay = NULL;
799         while( p_parent )
800         {
801             if( p_parent == p_playlist->p_root_category )
802             {
803                 p_toplay = p_item_cat; break;
804             }
805             else if( p_parent == p_playlist->p_root_onelevel )
806             {
807                 p_toplay = p_item_one; break;
808             }
809             p_parent = p_parent->p_parent;
810         }
811         assert( p_toplay );
812         pl_priv(p_playlist)->request.b_request = true;
813         pl_priv(p_playlist)->request.i_skip = 0;
814         pl_priv(p_playlist)->request.p_item = p_toplay;
815         if( pl_priv(p_playlist)->p_input )
816             input_Stop( pl_priv(p_playlist)->p_input, true );
817         pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
818         vlc_cond_signal( &pl_priv(p_playlist)->signal );
819     }
820     /* Preparse if PREPARSE or SPREPARSE & not enough meta */
821     char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
822     char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
823     if( pl_priv(p_playlist)->b_auto_preparse &&
824           (i_mode & PLAYLIST_PREPARSE ||
825           ( i_mode & PLAYLIST_SPREPARSE &&
826             ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
827           ) ) )
828         playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input, pl_Locked );
829     /* If we already have it, signal it */
830     else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
831         input_item_SetPreparsed( p_item_cat->p_input, true );
832     free( psz_artist );
833     free( psz_album );
834 }
835
836 /* Add the playlist item to the requested node and fire a notification */
837 static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
838                      playlist_item_t *p_node, int i_mode, int i_pos )
839 {
840     PL_ASSERT_LOCKED;
841     ARRAY_APPEND(p_playlist->items, p_item);
842     ARRAY_APPEND(p_playlist->all_items, p_item);
843
844     if( i_pos == PLAYLIST_END )
845         playlist_NodeAppend( p_playlist, p_item, p_node );
846     else
847         playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
848
849     if( !pl_priv(p_playlist)->b_doing_ml )
850         playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
851                                  !( 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     int i;
858     if( p_item->i_children == -1 )
859         p_item->i_children = 0;
860
861     /* Remove it from the array of available items */
862     ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
863     if( i != -1 )
864         ARRAY_REMOVE( p_playlist->items, i );
865 }
866
867 /* Do the actual removal */
868 int playlist_DeleteItem( playlist_t * p_playlist, playlist_item_t *p_item,
869                         bool b_stop )
870 {
871     int i;
872     int i_id = p_item->i_id;
873     PL_ASSERT_LOCKED;
874
875     if( p_item->i_children > -1 )
876     {
877         return playlist_NodeDelete( p_playlist, p_item, true, false );
878     }
879
880     pl_priv(p_playlist)->b_reset_currently_playing = true;
881     var_SetInteger( p_playlist, "playlist-item-deleted", i_id );
882
883     /* Remove the item from the bank */
884     ARRAY_BSEARCH( p_playlist->all_items,->i_id, int, i_id, i );
885     if( i != -1 )
886         ARRAY_REMOVE( p_playlist->all_items, i );
887
888     ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
889     if( i != -1 )
890         ARRAY_REMOVE( p_playlist->items, i );
891
892     /* Check if it is the current item */
893     if( get_current_status_item( p_playlist ) == p_item )
894     {
895         /* Stop it if we have to */
896         if( b_stop )
897         {
898             playlist_Control( p_playlist, PLAYLIST_STOP, pl_Locked );
899             msg_Info( p_playlist, "stopping playback" );
900         }
901         /* In any case, this item can't be the next one to be played ! */
902         set_current_status_item( p_playlist, NULL );
903     }
904
905     ARRAY_BSEARCH( p_playlist->current,->i_id, int, i_id, i );
906     if( i != -1 )
907         ARRAY_REMOVE( p_playlist->current, i );
908
909     PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
910
911     /* Remove the item from its parent */
912     playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
913
914     playlist_ItemRelease( p_item );
915
916     return VLC_SUCCESS;
917 }