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