]> git.sesse.net Git - vlc/blob - src/playlist/item.c
Changed playlist_AddExt to be more consistant with input_item_NewWithType.
[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                                                     pl_Locked );
320     if( !p_item ) return VLC_EGENERIC;
321     return DeleteInner( p_playlist, p_item, true );
322 }
323
324 /***************************************************************************
325  * Playlist item addition
326  ***************************************************************************/
327 /**
328  * Playlist add
329  *
330  * Add an item to the playlist or the media library
331  * \param p_playlist the playlist to add into
332  * \param psz_uri the mrl to add to the playlist
333  * \param psz_name a text giving a name or description of this item
334  * \param i_mode the mode used when adding
335  * \param i_pos the position in the playlist where to add. If this is
336  *        PLAYLIST_END the item will be added at the end of the playlist
337  *        regardless of its size
338  * \param b_playlist TRUE for playlist, FALSE for media library
339  * \param b_locked TRUE if the playlist is locked
340  * \return The id of the playlist item
341  */
342 int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
343                   const char *psz_name, int i_mode, int i_pos,
344                   bool b_playlist, bool b_locked )
345 {
346     return playlist_AddExt( p_playlist, psz_uri, psz_name,
347                             i_mode, i_pos, -1, 0, NULL, 0, b_playlist, b_locked );
348 }
349
350 /**
351  * Add a MRL into the playlist or the media library, duration and options given
352  *
353  * \param p_playlist the playlist to add into
354  * \param psz_uri the mrl to add to the playlist
355  * \param psz_name a text giving a name or description of this item
356  * \param i_mode the mode used when adding
357  * \param i_pos the position in the playlist where to add. If this is
358  *        PLAYLIST_END the item will be added at the end of the playlist
359  *        regardless of its size
360  * \param i_duration length of the item in milliseconds.
361  * \param i_options the number of options
362  * \param ppsz_options an array of options
363  * \param i_option_flags options flags
364  * \param b_playlist TRUE for playlist, FALSE for media library
365  * \param b_locked TRUE if the playlist is locked
366  * \return The id of the playlist item
367 */
368 int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
369                      const char *psz_name, int i_mode, int i_pos,
370                      mtime_t i_duration,
371                      int i_options, const char *const *ppsz_options, unsigned i_option_flags,
372                      bool b_playlist, bool b_locked )
373 {
374     int i_ret;
375     input_item_t *p_input = input_item_NewExt( p_playlist, psz_uri, psz_name,
376                                               i_options, ppsz_options, i_option_flags,
377                                               i_duration );
378
379     i_ret = playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist,
380                                b_locked );
381     int i_id = (i_ret == VLC_SUCCESS) ? p_input->i_id : -1;
382
383     vlc_gc_decref( p_input );
384
385     return i_id;
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 );
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 );
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 );
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 );
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->i_id ==
483                              p_up->p_input->i_id )
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 );
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 playlist_item_t *playlist_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->i_id,
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->i_id,
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->i_id,
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_SetInteger( p_playlist, "item-change", p_item_in_category->
627                                                         p_input->i_id );
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 i_input_id id of the input
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                                                     int i_input_id,
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->i_id == i_input_id )
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, i_input_id,
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 TreeMove( playlist_t *p_playlist, playlist_item_t *p_item,
675                      playlist_item_t *p_node, int i_newpos )
676 {
677     int j;
678     playlist_item_t *p_detach = p_item->p_parent;
679     (void)p_playlist;
680
681     if( p_node->i_children == -1 ) return VLC_EGENERIC;
682
683     for( j = 0; j < p_detach->i_children; j++ )
684     {
685          if( p_detach->pp_children[j] == p_item ) break;
686     }
687     REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );
688
689     /* If j < i_newpos, we are moving the element from the top to the
690      * down of the playlist. So when removing the element we have
691      * to change the position as we loose one element
692      */
693     if( j < i_newpos )
694         i_newpos--;
695
696     /* Attach to new parent */
697     INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
698     p_item->p_parent = p_node;
699
700     return VLC_SUCCESS;
701 }
702
703 /**
704  * Moves an item
705  *
706  * This function must be entered with the playlist lock
707  *
708  * \param p_playlist the playlist
709  * \param p_item the item to move
710  * \param p_node the new parent of the item
711  * \param i_newpos the new position under this new parent
712  * \return VLC_SUCCESS or an error
713  */
714 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
715                        playlist_item_t *p_node, int i_newpos )
716 {
717     int i_ret;
718     PL_ASSERT_LOCKED;
719
720     /* Drop on a top level node. Move in the two trees */
721     if( p_node->p_parent == p_playlist->p_root_category ||
722         p_node->p_parent == p_playlist->p_root_onelevel )
723     {
724         /* Fixme: avoid useless lookups but we need some clean helpers */
725         {
726             /* Fixme: if we try to move a node on a top-level node, it will
727              * fail because the node doesn't exist in onelevel and we will
728              * do some shit in onelevel. We should recursively move all items
729              * within the node */
730             playlist_item_t *p_node_onelevel;
731             playlist_item_t *p_item_onelevel;
732             p_node_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
733                                                 p_node->p_input->i_id,
734                                                 p_playlist->p_root_onelevel,
735                                                 false );
736             p_item_onelevel = playlist_ItemFindFromInputAndRoot( p_playlist,
737                                                 p_item->p_input->i_id,
738                                                 p_playlist->p_root_onelevel,
739                                                 false );
740             if( p_node_onelevel && p_item_onelevel )
741                 TreeMove( p_playlist, p_item_onelevel, p_node_onelevel, i_newpos );
742         }
743         {
744             playlist_item_t *p_node_category;
745             playlist_item_t *p_item_category;
746             p_node_category = playlist_ItemFindFromInputAndRoot( p_playlist,
747                                                 p_node->p_input->i_id,
748                                                 p_playlist->p_root_category,
749                                                 false );
750             p_item_category = playlist_ItemFindFromInputAndRoot( p_playlist,
751                                                 p_item->p_input->i_id,
752                                                 p_playlist->p_root_category,
753                                                 false );
754             if( p_node_category && p_item_category )
755                 TreeMove( p_playlist, p_item_category, p_node_category, 0 );
756         }
757         i_ret = VLC_SUCCESS;
758     }
759     else
760         i_ret = TreeMove( p_playlist, p_item, p_node, i_newpos );
761     pl_priv(p_playlist)->b_reset_currently_playing = true;
762     vlc_cond_signal( &pl_priv(p_playlist)->signal );
763     return i_ret;
764 }
765
766 /**
767  * Send a notification that an item has been added to a node
768  *
769  * \param p_playlist the playlist object
770  * \param i_item_id id of the item added
771  * \param i_node_id id of the node in wich the item was added
772  * \param b_signal TRUE if the function must send a signal
773  * \return nothing
774  */
775 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
776                              int i_node_id, bool b_signal )
777 {
778     vlc_value_t val;
779     PL_ASSERT_LOCKED;
780
781     playlist_add_t *p_add = (playlist_add_t *)malloc( sizeof( playlist_add_t) );
782     if( !p_add )
783         return;
784
785     p_add->i_item = i_item_id;
786     p_add->i_node = i_node_id;
787     val.p_address = p_add;
788     pl_priv(p_playlist)->b_reset_currently_playing = true;
789     if( b_signal )
790         vlc_cond_signal( &pl_priv(p_playlist)->signal );
791
792     var_Set( p_playlist, "item-append", val );
793     free( p_add );
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_StopThread( pl_priv(p_playlist)->p_input );
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, "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         /* Hack we don't call playlist_Control for lock reasons */
906         if( b_stop )
907         {
908             pl_priv(p_playlist)->request.i_status = PLAYLIST_STOPPED;
909             pl_priv(p_playlist)->request.b_request = true;
910             pl_priv(p_playlist)->request.p_item = NULL;
911             msg_Info( p_playlist, "stopping playback" );
912             vlc_cond_signal( &pl_priv(p_playlist)->signal );
913         }
914     }
915
916     PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
917
918     /* Remove the item from its parent */
919     playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
920
921     playlist_ItemRelease( p_item );
922
923     return VLC_SUCCESS;
924 }