]> git.sesse.net Git - vlc/blob - src/playlist/item.c
The playlist have to be locked when calling playlist_ItemGetById (not tested for...
[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 static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
39                         bool b_stop );
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->i_id,
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->i_id,
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         b_play = b_play &&
84             p_item_in_category == get_current_status_item( p_playlist );
85
86         /* If this item is already a node don't transform it */
87         if( p_item_in_category->i_children == -1 )
88         {
89             p_item_in_category = playlist_ItemToNode( p_playlist,
90                     p_item_in_category, pl_Locked );
91             p_item_in_category->p_input->i_type = ITEM_TYPE_PLAYLIST;
92         }
93
94         int i_ret = playlist_BothAddInput( p_playlist, p_child,
95                 p_item_in_category,
96                 PLAYLIST_APPEND | PLAYLIST_SPREPARSE , PLAYLIST_END,
97                 NULL, NULL, pl_Locked );
98
99         if( i_ret == VLC_SUCCESS && b_play )
100         {
101             playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
102                           pl_Locked, p_item_in_category, NULL );
103         }
104     }
105
106     PL_UNLOCK;
107
108 }
109
110 /*****************************************************************************
111  * An input item's meta or duration has changed (Event Callback)
112  *****************************************************************************/
113 static void input_item_changed( const vlc_event_t * p_event,
114                                 void * user_data )
115 {
116     (void)p_event;
117     playlist_item_t * p_item = user_data;
118     var_SetInteger( p_item->p_playlist, "item-change", p_item->i_id );
119 }
120
121 /*****************************************************************************
122  * Listen to vlc_InputItemAddSubItem event
123  *****************************************************************************/
124 static void install_input_item_observer( playlist_item_t * p_item )
125 {
126     vlc_event_manager_t * p_em = &p_item->p_input->event_manager;
127     vlc_event_attach( p_em, vlc_InputItemSubItemAdded,
128                       input_item_subitem_added, p_item );
129     vlc_event_attach( p_em, vlc_InputItemDurationChanged,
130                       input_item_changed, p_item );
131     vlc_event_attach( p_em, vlc_InputItemMetaChanged,
132                       input_item_changed, p_item );
133     vlc_event_attach( p_em, vlc_InputItemNameChanged,
134                       input_item_changed, p_item );
135     vlc_event_attach( p_em, vlc_InputItemInfoChanged,
136                       input_item_changed, p_item );
137     vlc_event_attach( p_em, vlc_InputItemErrorWhenReadingChanged,
138                       input_item_changed, p_item );
139 }
140
141 static void uninstall_input_item_observer( playlist_item_t * p_item )
142 {
143     vlc_event_manager_t * p_em = &p_item->p_input->event_manager;
144     vlc_event_detach( p_em, vlc_InputItemSubItemAdded,
145                       input_item_subitem_added, p_item );
146     vlc_event_detach( p_em, vlc_InputItemMetaChanged,
147                       input_item_changed, p_item );
148     vlc_event_detach( p_em, vlc_InputItemDurationChanged,
149                       input_item_changed, p_item );
150     vlc_event_detach( p_em, vlc_InputItemNameChanged,
151                       input_item_changed, p_item );
152     vlc_event_detach( p_em, vlc_InputItemInfoChanged,
153                       input_item_changed, p_item );
154     vlc_event_detach( p_em, vlc_InputItemErrorWhenReadingChanged,
155                       input_item_changed, p_item );
156 }
157
158 /*****************************************************************************
159  * Playlist item creation
160  *****************************************************************************/
161 playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
162                                               input_item_t *p_input )
163 {
164     playlist_item_t* p_item = malloc( sizeof( playlist_item_t ) );
165     if( !p_item )
166         return NULL;
167
168     assert( p_input );
169
170     p_item->p_input = p_input;
171     vlc_gc_incref( p_item->p_input );
172
173     p_item->i_id = ++pl_priv(p_playlist)->i_last_playlist_id;
174
175     p_item->p_parent = NULL;
176     p_item->i_children = -1;
177     p_item->pp_children = NULL;
178     p_item->i_flags = 0;
179     p_item->p_playlist = p_playlist;
180
181     install_input_item_observer( p_item );
182
183     return p_item;
184 }
185
186 /***************************************************************************
187  * Playlist item destruction
188  ***************************************************************************/
189
190 /**
191  * Release an item
192  *
193  * \param p_item item to delete
194  * \return VLC_SUCCESS
195 */
196 int playlist_ItemRelease( playlist_item_t *p_item )
197 {
198     /* For the assert */
199     playlist_t *p_playlist = p_item->p_playlist;
200     PL_ASSERT_LOCKED;
201
202     /* Surprise, we can't actually do more because we
203      * don't do refcounting, or eauivalent.
204      * Because item are not only accessed by their id
205      * using playlist_item outside the PL_LOCK isn't safe.
206      * Most of the modules does that.
207      *
208      * Who wants to add proper memory management? */
209     uninstall_input_item_observer( p_item );
210     ARRAY_APPEND( pl_priv(p_playlist)->items_to_delete, p_item);
211     return VLC_SUCCESS;
212 }
213
214 /**
215  * Delete input item
216  *
217  * Remove an input item when it appears from a root playlist item
218  * \param p_playlist playlist object
219  * \param i_input_id id of the input to delete
220  * \param p_root root playlist item
221  * \param b_do_stop must stop or not the playlist
222  * \return VLC_SUCCESS or VLC_EGENERIC
223 */
224 static int DeleteFromInput( playlist_t *p_playlist, int i_input_id,
225                             playlist_item_t *p_root, bool b_do_stop )
226 {
227     int i;
228     PL_ASSERT_LOCKED;
229     for( i = 0 ; i< p_root->i_children ; i++ )
230     {
231         if( p_root->pp_children[i]->i_children == -1 &&
232             p_root->pp_children[i]->p_input->i_id == i_input_id )
233         {
234             DeleteInner( p_playlist, p_root->pp_children[i], b_do_stop );
235             return VLC_SUCCESS;
236         }
237         else if( p_root->pp_children[i]->i_children >= 0 )
238         {
239             int i_ret = DeleteFromInput( p_playlist, i_input_id,
240                                          p_root->pp_children[i], b_do_stop );
241             if( i_ret == VLC_SUCCESS ) return VLC_SUCCESS;
242         }
243     }
244     return VLC_EGENERIC;
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 i_input_id id of 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, int i_input_id,
258                                       playlist_item_t *p_root, bool b_locked )
259 {
260     int i_ret;
261     PL_LOCK_IF( !b_locked );
262     i_ret = DeleteFromInput( p_playlist, i_input_id,
263                              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 i_input_id id of 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, int i_input_id,
278                               bool b_locked )
279 {
280     int i_ret1, i_ret2;
281     PL_LOCK_IF( !b_locked );
282     i_ret1 = DeleteFromInput( p_playlist, i_input_id,
283                              p_playlist->p_root_category, true );
284     i_ret2 = DeleteFromInput( p_playlist, i_input_id,
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 DeleteInner( 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 The id of the playlist item
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 The id of the playlist item
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, unsigned i_option_flags,
371                      bool b_playlist, bool b_locked )
372 {
373     int i_ret;
374     input_item_t *p_input = input_item_NewExt( p_playlist, psz_uri, psz_name,
375                                               i_options, ppsz_options, i_option_flags,
376                                               i_duration );
377
378     i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
379                                b_locked );
380     int i_id = (i_ret == VLC_SUCCESS) ? p_input->i_id : -1;
381
382     vlc_gc_decref( p_input );
383
384     return i_id;
385 }
386
387 /**
388  * Add an input item to the playlist node
389  *
390  * \param p_playlist the playlist to add into
391  * \param p_input the input item to add
392  * \param i_mode the mode used when adding
393  * \param i_pos the position in the playlist where to add. If this is
394  *        PLAYLIST_END the item will be added at the end of the playlist
395  *        regardless of its size
396  * \param b_playlist TRUE for playlist, FALSE for media library
397  * \param b_locked TRUE if the playlist is locked
398  * \return VLC_SUCCESS or VLC_ENOMEM or VLC_EGENERIC
399 */
400 int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
401                        int i_mode, int i_pos, bool b_playlist,
402                        bool b_locked )
403 {
404     playlist_item_t *p_item_cat, *p_item_one;
405     if( p_playlist->b_die ) return VLC_EGENERIC;
406     if( !pl_priv(p_playlist)->b_doing_ml )
407         PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
408                                              p_input->psz_uri );
409
410     PL_LOCK_IF( !b_locked );
411
412     /* Add to ONELEVEL */
413     p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
414     if( p_item_one == NULL ) return VLC_ENOMEM;
415     AddItem( p_playlist, p_item_one,
416              b_playlist ? p_playlist->p_local_onelevel :
417                           p_playlist->p_ml_onelevel , i_mode, i_pos );
418
419     /* Add to CATEGORY */
420     p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
421     if( p_item_cat == NULL ) return VLC_ENOMEM;
422     AddItem( p_playlist, p_item_cat,
423              b_playlist ? p_playlist->p_local_category :
424                           p_playlist->p_ml_category , i_mode, i_pos );
425
426     GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
427
428     PL_UNLOCK_IF( !b_locked );
429     return VLC_SUCCESS;
430 }
431
432 /**
433  * Add input
434  *
435  * Add an input item to p_direct_parent in the category tree, and to the
436  * matching top category in onelevel
437  * \param p_playlist the playlist to add into
438  * \param p_input the input item to add
439  * \param p_direct_parent the parent item to add into
440  * \param i_mode the mode used when adding
441  * \param i_pos the position in the playlist where to add. If this is
442  *        PLAYLIST_END the item will be added at the end of the playlist
443  *        regardless of its size
444  * \param i_cat id of the items category
445  * \param i_one id of the item onelevel category
446  * \param b_locked TRUE if the playlist is locked
447  * \return VLC_SUCCESS if success, VLC_EGENERIC if fail, VLC_ENOMEM if OOM
448  */
449 int playlist_BothAddInput( playlist_t *p_playlist,
450                            input_item_t *p_input,
451                            playlist_item_t *p_direct_parent,
452                            int i_mode, int i_pos,
453                            int *i_cat, int *i_one, bool b_locked )
454 {
455     playlist_item_t *p_item_cat, *p_item_one, *p_up;
456     int i_top;
457     assert( p_input );
458
459     if( !vlc_object_alive( p_playlist ) )
460         return VLC_EGENERIC;
461
462     PL_LOCK_IF( !b_locked );
463
464     /* Add to category */
465     p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
466     if( p_item_cat == NULL ) return VLC_ENOMEM;
467     AddItem( p_playlist, p_item_cat, p_direct_parent, i_mode, i_pos );
468
469     /* Add to onelevel */
470     /** \todo make a faster case for ml import */
471     p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
472     if( p_item_one == NULL ) return VLC_ENOMEM;
473
474     p_up = p_direct_parent;
475     while( p_up->p_parent != p_playlist->p_root_category )
476     {
477         p_up = p_up->p_parent;
478     }
479     for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
480     {
481         if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id ==
482                              p_up->p_input->i_id )
483         {
484             AddItem( p_playlist, p_item_one,
485                      p_playlist->p_root_onelevel->pp_children[i_top],
486                      i_mode, i_pos );
487             break;
488         }
489     }
490     GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
491
492     if( i_cat ) *i_cat = p_item_cat->i_id;
493     if( i_one ) *i_one = p_item_one->i_id;
494
495     PL_UNLOCK_IF( !b_locked );
496     return VLC_SUCCESS;
497 }
498
499 /**
500  * Add an input item to a given node
501  *
502  * \param p_playlist the playlist to add into
503  * \param p_input the input item to add
504  * \param p_parent the parent item to add into
505  * \param i_mode the mode used when addin
506  * \param i_pos the position in the playlist where to add. If this is
507  *        PLAYLIST_END the item will be added at the end of the playlist
508  *        regardless of its size
509  * \param b_locked TRUE if the playlist is locked
510  * \return the new playlist item
511  */
512 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
513                                          input_item_t *p_input,
514                                          playlist_item_t *p_parent,
515                                          int i_mode, int i_pos,
516                                          bool b_locked )
517 {
518     playlist_item_t *p_item;
519     assert( p_input );
520     assert( p_parent && p_parent->i_children != -1 );
521
522     if( p_playlist->b_die )
523         return NULL;
524     PL_LOCK_IF( !b_locked );
525
526     p_item = playlist_ItemNewFromInput( p_playlist, p_input );
527     if( p_item == NULL ) return NULL;
528     AddItem( p_playlist, p_item, p_parent, i_mode, i_pos );
529
530     PL_UNLOCK_IF( !b_locked );
531
532     return p_item;
533 }
534
535 /*****************************************************************************
536  * Playlist item misc operations
537  *****************************************************************************/
538
539 /**
540  * Item to node
541  *
542  * Transform an item to a node. Return the node in the category tree, or NULL
543  * if not found there
544  * This function must be entered without the playlist lock
545  * \param p_playlist the playlist object
546  * \param p_item the item to transform
547  * \param b_locked TRUE if the playlist is locked
548  * \return the item transform in a node
549  */
550 playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
551                                       playlist_item_t *p_item,
552                                       bool b_locked )
553 {
554
555     playlist_item_t *p_item_in_category;
556     /* What we do
557      * Find the input in CATEGORY.
558      *  - If we find it
559      *    - change it to node
560      *    - we'll return it at the end
561      *    - If we are a direct child of onelevel root, change to node, else
562      *      delete the input from ONELEVEL
563      *  - If we don't find it, just change to node (we are probably in VLM)
564      *    and return NULL
565      *
566      * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
567      * useful for later BothAddInput )
568      */
569
570     PL_LOCK_IF( !b_locked );
571
572     /* Fast track the media library, no time to loose */
573     if( p_item == p_playlist->p_ml_category ) {
574         PL_UNLOCK_IF( !b_locked );
575         return p_item;
576     }
577
578     /** \todo First look if we don't already have it */
579     p_item_in_category = playlist_ItemFindFromInputAndRoot(
580                                             p_playlist, p_item->p_input->i_id,
581                                             p_playlist->p_root_category,
582                                             true );
583
584     if( p_item_in_category )
585     {
586         playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
587                                             p_playlist, p_item->p_input->i_id,
588                                             p_playlist->p_root_onelevel,
589                                             true );
590         assert( p_item_in_one );
591
592         /* We already have it, and there is nothing more to do */
593         ChangeToNode( p_playlist, p_item_in_category );
594
595         /* Item in one is a root, change it to node */
596         if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
597             ChangeToNode( p_playlist, p_item_in_one );
598         else
599         {
600             playlist_item_t *p_status_item = get_current_status_item( p_playlist );
601             playlist_item_t *p_status_node = get_current_status_node( p_playlist );
602             if( p_item_in_one == p_status_item )
603             {
604                 /* We're deleting the current playlist item. Update
605                  * the playlist object to point at the previous item
606                  * so the playlist won't be restarted */
607                 playlist_item_t *p_prev_status_item = NULL;
608                 int i = 0;
609                 while( i < p_status_node->i_children &&
610                        p_status_node->pp_children[i] != p_status_item )
611                 {
612                     p_prev_status_item = p_status_node->pp_children[i];
613                     i++;
614                 }
615                 if( i == p_status_node->i_children )
616                     p_prev_status_item = NULL;
617                 if( p_prev_status_item )
618                     set_current_status_item( p_playlist, p_prev_status_item );
619             }
620             DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
621                              p_playlist->p_root_onelevel, false );
622         }
623         pl_priv(p_playlist)->b_reset_currently_playing = true;
624         vlc_cond_signal( &pl_priv(p_playlist)->signal );
625         var_SetInteger( p_playlist, "item-change", p_item_in_category->
626                                                         p_input->i_id );
627         PL_UNLOCK_IF( !b_locked );
628         return p_item_in_category;
629     }
630     else
631     {
632         ChangeToNode( p_playlist, p_item );
633         PL_UNLOCK_IF( !b_locked );
634         return p_item;
635     }
636 }
637
638 /**
639  * Find an item within a root, given its input id.
640  *
641  * \param p_playlist the playlist object
642  * \param i_input_id id of the input
643  * \param p_root root playlist item
644  * \param b_items_only TRUE if we want the item himself
645  * \return the first found item, or NULL if not found
646  */
647 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
648                                                     int i_input_id,
649                                                     playlist_item_t *p_root,
650                                                     bool b_items_only )
651 {
652     int i;
653     for( i = 0 ; i< p_root->i_children ; i++ )
654     {
655         if( ( b_items_only ? p_root->pp_children[i]->i_children == -1 : 1 ) &&
656             p_root->pp_children[i]->p_input->i_id == i_input_id )
657         {
658             return p_root->pp_children[i];
659         }
660         else if( p_root->pp_children[i]->i_children >= 0 )
661         {
662             playlist_item_t *p_search =
663                  playlist_ItemFindFromInputAndRoot( p_playlist, i_input_id,
664                                                     p_root->pp_children[i],
665                                                     b_items_only );
666             if( p_search ) return p_search;
667         }
668     }
669     return NULL;
670 }
671
672
673 static int TreeMove( playlist_t *p_playlist, playlist_item_t *p_item,
674                      playlist_item_t *p_node, int i_newpos )
675 {
676     int j;
677     playlist_item_t *p_detach = p_item->p_parent;
678     (void)p_playlist;
679
680     if( p_node->i_children == -1 ) return VLC_EGENERIC;
681
682     for( j = 0; j < p_detach->i_children; j++ )
683     {
684          if( p_detach->pp_children[j] == p_item ) break;
685     }
686     REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );
687
688     /* If j < i_newpos, we are moving the element from the top to the
689      * down of the playlist. So when removing the element we have
690      * to change the position as we loose one element
691      */
692     if( j < i_newpos )
693         i_newpos--;
694
695     /* Attach to new parent */
696     INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
697     p_item->p_parent = p_node;
698
699     return VLC_SUCCESS;
700 }
701
702 /**
703  * Moves an item
704  *
705  * This function must be entered with the playlist lock
706  *
707  * \param p_playlist the playlist
708  * \param p_item the item to move
709  * \param p_node the new parent of the item
710  * \param i_newpos the new position under this new parent
711  * \return VLC_SUCCESS or an error
712  */
713 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
714                        playlist_item_t *p_node, int i_newpos )
715 {
716     int i_ret;
717     PL_ASSERT_LOCKED;
718
719     /* Drop on a top level node. Move in the two trees */
720     if( p_node->p_parent == p_playlist->p_root_category ||
721         p_node->p_parent == p_playlist->p_root_onelevel )
722     {
723         /* Fixme: avoid useless lookups but we need some clean helpers */
724         {
725             /* Fixme: if we try to move a node on a top-level node, it will
726              * fail because the node doesn't exist in onelevel and we will
727              * do some shit in onelevel. We should recursively move all items
728              * within the node */
729             playlist_item_t *p_node_onelevel;
730             playlist_item_t *p_item_onelevel;
731             p_node_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
732                                                 p_node->p_input->i_id,
733                                                 p_playlist->p_root_onelevel,
734                                                 false );
735             p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
736                                                 p_item->p_input->i_id,
737                                                 p_playlist->p_root_onelevel,
738                                                 false );
739             if( p_node_onelevel && p_item_onelevel )
740                 TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, i_newpos );
741         }
742         {
743             playlist_item_t *p_node_category;
744             playlist_item_t *p_item_category;
745             p_node_category = playlist_ItemFindFromInputAndRoot( p_playlist,
746                                                 p_node->p_input->i_id,
747                                                 p_playlist->p_root_category,
748                                                 false );
749             p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
750                                                 p_item->p_input->i_id,
751                                                 p_playlist->p_root_category,
752                                                 false );
753             if( p_node_category && p_item_category )
754                 TreeMove( p_playlist, p_item_category, p_node_category, 0 );
755         }
756         i_ret = VLC_SUCCESS;
757     }
758     else
759         i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
760     pl_priv(p_playlist)->b_reset_currently_playing = true;
761     vlc_cond_signal( &pl_priv(p_playlist)->signal );
762     return i_ret;
763 }
764
765 /**
766  * Send a notification that an item has been added to a node
767  *
768  * \param p_playlist the playlist object
769  * \param i_item_id id of the item added
770  * \param i_node_id id of the node in wich the item was added
771  * \param b_signal TRUE if the function must send a signal
772  * \return nothing
773  */
774 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
775                              int i_node_id, bool b_signal )
776 {
777     vlc_value_t val;
778     PL_ASSERT_LOCKED;
779
780     playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
781     if( !p_add )
782         return;
783
784     p_add->i_item = i_item_id;
785     p_add->i_node = i_node_id;
786     val.p_address = p_add;
787     pl_priv(p_playlist)->b_reset_currently_playing = true;
788     if( b_signal )
789         vlc_cond_signal( &pl_priv(p_playlist)->signal );
790
791     var_Set( p_playlist, "item-append", val );
792     free( p_add );
793 }
794
795 /***************************************************************************
796  * The following functions are local
797  ***************************************************************************/
798
799 /* Enqueue an item for preparsing, and play it, if needed */
800 static void GoAndPreparse( playlist_t *p_playlist, int i_mode,
801                            playlist_item_t *p_item_cat,
802                            playlist_item_t *p_item_one )
803 {
804     PL_ASSERT_LOCKED;
805     if( (i_mode & PLAYLIST_GO ) )
806     {
807         playlist_item_t *p_parent = p_item_one;
808         playlist_item_t *p_toplay = NULL;
809         while( p_parent )
810         {
811             if( p_parent == p_playlist->p_root_category )
812             {
813                 p_toplay = p_item_cat; break;
814             }
815             else if( p_parent == p_playlist->p_root_onelevel )
816             {
817                 p_toplay = p_item_one; break;
818             }
819             p_parent = p_parent->p_parent;
820         }
821         assert( p_toplay );
822         pl_priv(p_playlist)->request.b_request = true;
823         pl_priv(p_playlist)->request.i_skip = 0;
824         pl_priv(p_playlist)->request.p_item = p_toplay;
825         if( pl_priv(p_playlist)->p_input )
826             input_StopThread( pl_priv(p_playlist)->p_input );
827         pl_priv(p_playlist)->request.i_status = PLAYLIST_RUNNING;
828         vlc_cond_signal( &pl_priv(p_playlist)->signal );
829     }
830     /* Preparse if PREPARSE or SPREPARSE & not enough meta */
831     char *psz_artist = input_item_GetArtist( p_item_cat->p_input );
832     char *psz_album = input_item_GetAlbum( p_item_cat->p_input );
833     if( pl_priv(p_playlist)->b_auto_preparse &&
834           (i_mode & PLAYLIST_PREPARSE ||
835           ( i_mode & PLAYLIST_SPREPARSE &&
836             ( EMPTY_STR( psz_artist ) || ( EMPTY_STR( psz_album ) ) )
837           ) ) )
838         playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input, pl_Locked );
839     /* If we already have it, signal it */
840     else if( !EMPTY_STR( psz_artist ) && !EMPTY_STR( psz_album ) )
841         input_item_SetPreparsed( p_item_cat->p_input, true );
842     free( psz_artist );
843     free( psz_album );
844 }
845
846 /* Add the playlist item to the requested node and fire a notification */
847 static void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
848                      playlist_item_t *p_node, int i_mode, int i_pos )
849 {
850     PL_ASSERT_LOCKED;
851     ARRAY_APPEND(p_playlist->items, p_item);
852     ARRAY_APPEND(p_playlist->all_items, p_item);
853
854     if( i_pos == PLAYLIST_END )
855         playlist_NodeAppend( p_playlist, p_item, p_node );
856     else
857         playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
858
859     if( !pl_priv(p_playlist)->b_doing_ml )
860         playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id,
861                                  !( i_mode & PLAYLIST_NO_REBUILD ) );
862 }
863
864 /* Actually convert an item to a node */
865 static void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
866 {
867     int i;
868     if( p_item->i_children == -1 )
869         p_item->i_children = 0;
870
871     /* Remove it from the array of available items */
872     ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_item->i_id, i );
873     if( i != -1 )
874         ARRAY_REMOVE( p_playlist->items, i );
875 }
876
877 /* Do the actual removal */
878 static int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
879                         bool b_stop )
880 {
881     int i;
882     int i_id = p_item->i_id;
883     PL_ASSERT_LOCKED;
884
885     if( p_item->i_children > -1 )
886     {
887         return playlist_NodeDelete( p_playlist, p_item, true, false );
888     }
889     pl_priv(p_playlist)->b_reset_currently_playing = true;
890     var_SetInteger( p_playlist, "item-deleted", i_id );
891
892     /* Remove the item from the bank */
893     ARRAY_BSEARCH( p_playlist->all_items,->i_id, int, i_id, i );
894     if( i != -1 )
895         ARRAY_REMOVE( p_playlist->all_items, i );
896
897     ARRAY_BSEARCH( p_playlist->items,->i_id, int, i_id, i );
898     if( i != -1 )
899         ARRAY_REMOVE( p_playlist->items, i );
900
901     /* Check if it is the current item */
902     if( get_current_status_item( p_playlist ) == p_item )
903     {
904         /* Hack we don't call playlist_Control for lock reasons */
905         if( b_stop )
906         {
907             pl_priv(p_playlist)->request.i_status = PLAYLIST_STOPPED;
908             pl_priv(p_playlist)->request.b_request = true;
909             pl_priv(p_playlist)->request.p_item = NULL;
910             msg_Info( p_playlist, "stopping playback" );
911             vlc_cond_signal( &pl_priv(p_playlist)->signal );
912         }
913     }
914
915     PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
916
917     /* Remove the item from its parent */
918     playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
919
920     playlist_ItemRelease( p_item );
921
922     return VLC_SUCCESS;
923 }