1 /*****************************************************************************
2 * item.c : Playlist item creation/deletion/add/removal functions
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@videolan.org>
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.
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.
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 *****************************************************************************/
25 #include <vlc/input.h>
27 #include <vlc_playlist.h>
28 #include "playlist_internal.h"
30 void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
31 playlist_item_t *p_node, int i_pos );
32 void GoAndPreparse( playlist_t *p_playlist, int i_mode,
33 playlist_item_t *, playlist_item_t * );
34 void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item );
35 int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
38 /*****************************************************************************
39 * Playlist item creation
40 *****************************************************************************/
41 playlist_item_t * playlist_ItemNewWithType( vlc_object_t *p_obj,
45 const char **ppsz_options,
46 int i_duration, int i_type )
48 input_item_t *p_input;
49 if( psz_uri == NULL ) return NULL;
50 p_input = input_ItemNewWithType( p_obj, psz_uri,
51 psz_name, i_options, ppsz_options,
53 return playlist_ItemNewFromInput( p_obj, p_input );
56 playlist_item_t *__playlist_ItemNewFromInput( vlc_object_t *p_obj,
57 input_item_t *p_input )
59 DECMALLOC_NULL( p_item, playlist_item_t );
60 playlist_t *p_playlist = p_obj->p_libvlc->p_playlist;
61 vlc_object_yield( p_playlist );
63 p_item->p_input = p_input;
64 vlc_gc_incref( p_item->p_input );
66 p_item->i_id = ++p_playlist->i_last_playlist_id;
68 p_item->p_parent = NULL;
69 p_item->i_children = -1;
70 p_item->pp_children = NULL;
73 vlc_object_release( p_playlist );
78 /***************************************************************************
79 * Playlist item destruction
80 ***************************************************************************/
82 /** Delete a playlist item and detach its input item */
83 int playlist_ItemDelete( playlist_item_t *p_item )
85 vlc_gc_decref( p_item->p_input );
90 /** Remove an input item from ONELEVEL and CATEGORY */
91 int playlist_DeleteAllFromInput( playlist_t *p_playlist, int i_input_id )
93 playlist_DeleteFromInput( p_playlist, i_input_id,
94 p_playlist->p_root_category, VLC_TRUE );
95 playlist_DeleteFromInput( p_playlist, i_input_id,
96 p_playlist->p_root_onelevel, VLC_TRUE );
100 /** Remove an input item from ONELEVEL and CATEGORY.
101 * This function must be entered without the playlist lock */
102 int playlist_LockDeleteAllFromInput( playlist_t * p_playlist, int i_id )
105 vlc_mutex_lock( &p_playlist->object_lock );
106 i_ret = playlist_DeleteAllFromInput( p_playlist, i_id );
107 vlc_mutex_unlock( &p_playlist->object_lock );
111 /** Remove an input item when it appears from a root playlist item */
112 int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
113 playlist_item_t *p_root, vlc_bool_t b_do_stop )
116 for( i = 0 ; i< p_root->i_children ; i++ )
118 if( p_root->pp_children[i]->i_children == -1 &&
119 p_root->pp_children[i]->p_input->i_id == i_input_id )
121 DeleteInner( p_playlist, p_root->pp_children[i], b_do_stop );
124 else if( p_root->pp_children[i]->i_children >= 0 )
126 int i_ret = playlist_DeleteFromInput( p_playlist, i_input_id,
127 p_root->pp_children[i], b_do_stop );
128 if( i_ret == VLC_SUCCESS ) return VLC_SUCCESS;
134 /** Remove a playlist item from the playlist, given its id */
135 int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
137 playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id );
138 if( !p_item ) return VLC_EGENERIC;
139 return DeleteInner( p_playlist, p_item, VLC_TRUE );
142 /** Remove a playlist item from the playlist, given its id
143 * This function should be entered without the playlist lock */
144 int playlist_LockDelete( playlist_t * p_playlist, int i_id )
147 vlc_mutex_lock( &p_playlist->object_lock );
148 i_ret = playlist_DeleteFromItemId( p_playlist, i_id );
149 vlc_mutex_unlock( &p_playlist->object_lock );
153 /** Clear the playlist */
154 void playlist_Clear( playlist_t * p_playlist )
156 playlist_NodeEmpty( p_playlist, p_playlist->p_root_category, VLC_TRUE );
157 playlist_NodeEmpty( p_playlist, p_playlist->p_root_onelevel, VLC_TRUE );
159 /** Clear the playlist. This function must be entered without the lock */
160 void playlist_LockClear( playlist_t *p_playlist )
162 vlc_mutex_lock( &p_playlist->object_lock );
163 playlist_Clear( p_playlist );
164 vlc_mutex_unlock( &p_playlist->object_lock );
167 /***************************************************************************
168 * Playlist item addition
169 ***************************************************************************/
170 /** Add an item to the playlist or the media library
171 * \param p_playlist the playlist to add into
172 * \param psz_uri the mrl to add to the playlist
173 * \param psz_name a text giving a name or description of this item
174 * \param i_mode the mode used when adding
175 * \param i_pos the position in the playlist where to add. If this is
176 * PLAYLIST_END the item will be added at the end of the playlist
177 * regardless of its size
178 * \param b_playlist TRUE for playlist, FALSE for media library
179 * \return The id of the playlist item
181 int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
182 const char *psz_name, int i_mode, int i_pos,
183 vlc_bool_t b_playlist )
185 return playlist_AddExt( p_playlist, psz_uri, psz_name,
186 i_mode, i_pos, -1, NULL, 0, b_playlist );
190 * Add a MRL into the playlist or the media library, duration and options given
192 * \param p_playlist the playlist to add into
193 * \param psz_uri the mrl to add to the playlist
194 * \param psz_name a text giving a name or description of this item
195 * \param i_mode the mode used when adding
196 * \param i_pos the position in the playlist where to add. If this is
197 * PLAYLIST_END the item will be added at the end of the playlist
198 * regardless of its size
199 * \param i_duration length of the item in milliseconds.
200 * \param ppsz_options an array of options
201 * \param i_options the number of options
202 * \param b_playlist TRUE for playlist, FALSE for media library
203 * \return The id of the playlist item
205 int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
206 const char *psz_name, int i_mode, int i_pos,
207 mtime_t i_duration, const char **ppsz_options,
208 int i_options, vlc_bool_t b_playlist )
210 input_item_t *p_input = input_ItemNewExt( p_playlist, psz_uri, psz_name,
211 i_options, ppsz_options,
214 return playlist_AddInput( p_playlist, p_input, i_mode, i_pos, b_playlist );
217 /** Add an input item to the playlist node */
218 int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input,
219 int i_mode, int i_pos, vlc_bool_t b_playlist )
221 playlist_item_t *p_item_cat, *p_item_one;
223 if( !p_playlist->b_doing_ml )
224 PL_DEBUG( "adding item `%s' ( %s )", p_input->psz_name,
227 vlc_mutex_lock( &p_playlist->object_lock );
229 /* Add to ONELEVEL */
230 p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
231 if( p_item_one == NULL ) return VLC_EGENERIC;
232 AddItem( p_playlist, p_item_one,
233 b_playlist ? p_playlist->p_local_onelevel :
234 p_playlist->p_ml_onelevel , i_pos );
236 /* Add to CATEGORY */
237 p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
238 if( p_item_cat == NULL ) return VLC_EGENERIC;
239 AddItem( p_playlist, p_item_cat,
240 b_playlist ? p_playlist->p_local_category :
241 p_playlist->p_ml_category , i_pos );
243 GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
245 vlc_mutex_unlock( &p_playlist->object_lock );
249 /** Add an input item to p_direct_parent in the category tree, and to the
250 * matching top category in onelevel **/
251 int playlist_BothAddInput( playlist_t *p_playlist,
252 input_item_t *p_input,
253 playlist_item_t *p_direct_parent,
254 int i_mode, int i_pos )
256 playlist_item_t *p_item_cat, *p_item_one, *p_up;
259 vlc_mutex_lock( & p_playlist->object_lock );
261 /* Add to category */
262 p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
263 if( p_item_cat == NULL ) return VLC_EGENERIC;
264 AddItem( p_playlist, p_item_cat, p_direct_parent, i_pos );
266 /* Add to onelevel */
267 /**Â \todo make a faster case for ml import */
268 p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
269 if( p_item_one == NULL ) return VLC_EGENERIC;
271 p_up = p_direct_parent;
272 while( p_up->p_parent != p_playlist->p_root_category )
274 p_up = p_up->p_parent;
276 for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
278 if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id == p_up->p_input->i_id )
280 AddItem( p_playlist, p_item_one,
281 p_playlist->p_root_onelevel->pp_children[i_top], i_pos );
285 GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
287 vlc_mutex_unlock( &p_playlist->object_lock );
292 * Add an item where it should be added, when adding from a node
293 * (ex: directory access, playlist demuxers, services discovery, ... )
294 * \param p_playlist the playlist
295 * \param p_input the input to add
296 * \param p_parent the direct node
297 * \param p_item_in_category the item within category root (as returned by playlist_ItemToNode)
298 * \param b_forced_parent Are we forced to add only to p_parent ?
300 void playlist_AddWhereverNeeded( playlist_t *p_playlist, input_item_t *p_input,
301 playlist_item_t *p_parent,
302 playlist_item_t *p_item_in_category,
303 vlc_bool_t b_forced_parent, int i_mode )
305 /* If we have forced a parent :
306 * - Just add the input to the forced parent (which should be p_parent)
308 * - If we have item in category, add to it, and to onelevel (bothadd)
309 * - If we don't, just add to p_parent
311 if( b_forced_parent == VLC_TRUE || !p_item_in_category )
313 playlist_NodeAddInput( p_playlist, p_input, p_parent, i_mode,
318 playlist_BothAddInput( p_playlist, p_input, p_item_in_category,
319 i_mode, PLAYLIST_END );
324 /** Add an input item to a given node */
325 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
326 input_item_t *p_input,
327 playlist_item_t *p_parent,
328 int i_mode, int i_pos )
330 playlist_item_t *p_item;
332 assert( p_parent && p_parent->i_children != -1 );
334 vlc_mutex_lock( &p_playlist->object_lock );
336 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
337 if( p_item == NULL ) return NULL;
338 AddItem( p_playlist, p_item, p_parent, i_pos );
340 vlc_mutex_unlock( &p_playlist->object_lock );
345 /** Add a playlist item to a given node */
346 void playlist_NodeAddItem( playlist_t *p_playlist, playlist_item_t *p_item,
347 playlist_item_t *p_parent, int i_mode, int i_pos )
349 vlc_mutex_lock( &p_playlist->object_lock );
350 AddItem( p_playlist, p_item, p_parent, i_pos );
351 vlc_mutex_unlock( &p_playlist->object_lock );
354 /*****************************************************************************
355 * Playlist item misc operations
356 *****************************************************************************/
359 * Transform an item to a node. Return the node in the category tree, or NULL
361 * This function must be entered without the playlist lock
363 playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
364 playlist_item_t *p_item )
367 playlist_item_t *p_item_in_category;
369 * Find the input in CATEGORY.
371 * - change it to node
372 * - we'll return it at the end
373 * - If we are a direct child of onelevel root, change to node, else
374 * delete the input from ONELEVEL
375 * - If we don't find it, just change to node (we are probably in VLM)
378 * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
379 * useful for later BothAddInput )
382 /* Fast track the media library, no time to loose */
383 if( p_item == p_playlist->p_ml_category )
386 /** \todo First look if we don't already have it */
387 p_item_in_category = playlist_ItemFindFromInputAndRoot(
388 p_playlist, p_item->p_input->i_id,
389 p_playlist->p_root_category );
391 if( p_item_in_category )
393 playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
394 p_playlist, p_item->p_input->i_id,
395 p_playlist->p_root_onelevel );
396 ChangeToNode( p_playlist, p_item_in_category );
397 if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
398 ChangeToNode( p_playlist, p_item_in_one );
401 playlist_DeleteFromInput( p_playlist, p_item_in_one->p_input->i_id,
402 p_playlist->p_root_onelevel, VLC_FALSE );
404 p_playlist->b_reset_random = VLC_TRUE;
405 var_SetInteger( p_playlist, "item-change", p_item_in_category->
407 return p_item_in_category;
411 ChangeToNode( p_playlist, p_item );
416 /** Transform an item to a node
417 * This function must be entered without the playlist lock
418 * \see playlist_ItemToNode
420 playlist_item_t * playlist_LockItemToNode( playlist_t *p_playlist,
421 playlist_item_t *p_item )
423 playlist_item_t *p_ret;
424 vlc_mutex_lock( &p_playlist->object_lock );
425 p_ret = playlist_ItemToNode( p_playlist, p_item );
426 vlc_mutex_unlock( &p_playlist->object_lock );
430 /** Find an item within a root, given its input id.
431 * \return the first found item, or NULL if not found
433 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
435 playlist_item_t *p_root )
438 for( i = 0 ; i< p_root->i_children ; i++ )
440 if( p_root->pp_children[i]->i_children == -1 &&
441 p_root->pp_children[i]->p_input->i_id == i_input_id )
443 return p_root->pp_children[i];
445 else if( p_root->pp_children[i]->i_children >= 0 )
447 playlist_item_t *p_search =
448 playlist_ItemFindFromInputAndRoot( p_playlist, i_input_id,
449 p_root->pp_children[i] );
450 if( p_search ) return p_search;
460 * This function must be entered with the playlist lock
462 * \param p_playlist the playlist
463 * \param p_item the item to move
464 * \param p_node the new parent of the item
465 * \param i_newpos the new position under this new parent
466 * \return VLC_SUCCESS or an error
468 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
469 playlist_item_t *p_node, int i_newpos )
472 playlist_item_t *p_detach = NULL;
474 if( p_node->i_children == -1 ) return VLC_EGENERIC;
476 p_detach = p_item->p_parent;
477 for( j = 0; j < p_detach->i_children; j++ )
479 if( p_detach->pp_children[j] == p_item ) break;
481 REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );
483 /* Attach to new parent */
484 INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
485 p_item->p_parent = p_node;
490 /** Send a notification that an item has been added to a node */
491 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
495 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
496 p_add->i_item = i_item_id;
497 p_add->i_node = i_node_id;
498 val.p_address = p_add;
499 p_playlist->b_reset_random = VLC_TRUE;
500 var_Set( p_playlist, "item-append", val );
504 /*****************************************************************************
505 * Playlist item accessors
506 *****************************************************************************/
508 /** Set the name of a playlist item */
509 int playlist_ItemSetName( playlist_item_t *p_item, char *psz_name )
511 if( psz_name && p_item )
513 if( p_item->p_input->psz_name ) free( p_item->p_input->psz_name );
514 p_item->p_input->psz_name = strdup( psz_name );
520 /***************************************************************************
521 * The following functions are local
522 ***************************************************************************/
524 /* Enqueue an item for preparsing, and play it, if needed */
525 void GoAndPreparse( playlist_t *p_playlist, int i_mode,
526 playlist_item_t *p_item_cat, playlist_item_t *p_item_one )
528 if( (i_mode & PLAYLIST_GO ) )
530 playlist_item_t *p_parent = p_item_one;
531 playlist_item_t *p_toplay = NULL;
534 if( p_parent == p_playlist->p_root_category )
536 p_toplay = p_item_cat; break;
538 else if( p_parent == p_playlist->p_root_onelevel )
540 p_toplay = p_item_one; break;
542 p_parent = p_parent->p_parent;
545 p_playlist->request.b_request = VLC_TRUE;
546 p_playlist->request.i_skip = 0;
547 p_playlist->request.p_item = p_toplay;
548 if( p_playlist->p_input )
550 input_StopThread( p_playlist->p_input );
552 p_playlist->request.i_status = PLAYLIST_RUNNING;
554 if( i_mode & PLAYLIST_PREPARSE &&
555 var_CreateGetBool( p_playlist, "auto-preparse" ) )
557 playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
561 /* Add the playlist item to the requested node and fire a notification */
562 void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
563 playlist_item_t *p_node, int i_pos )
565 INSERT_ELEM( p_playlist->pp_items, p_playlist->i_size,
566 p_playlist->i_size, p_item );
567 INSERT_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size,
568 p_playlist->i_all_size, p_item );
569 p_playlist->i_enabled ++;
571 if( i_pos == PLAYLIST_END )
573 playlist_NodeAppend( p_playlist, p_item, p_node );
577 playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
579 if( !p_playlist->b_doing_ml )
580 playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id );
583 /* Actually convert an item to a node */
584 void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
587 if( p_item->i_children == -1 )
588 p_item->i_children = 0;
590 /* Remove it from the array of available items */
591 for( i = 0 ; i < p_playlist->i_size ; i++ )
593 if( p_item == p_playlist->pp_items[i] )
595 REMOVE_ELEM( p_playlist->pp_items, p_playlist->i_size, i );
600 /* Do the actual removal */
601 int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
604 int i, i_top, i_bottom;
605 int i_id = p_item->i_id;
606 vlc_bool_t b_flag = VLC_FALSE;
608 if( p_item->i_children > -1 )
610 return playlist_NodeDelete( p_playlist, p_item, VLC_TRUE, VLC_FALSE );
612 p_playlist->b_reset_random = VLC_TRUE;
613 var_SetInteger( p_playlist, "item-deleted", i_id );
615 /* Remove the item from the bank */
616 i_bottom = 0; i_top = p_playlist->i_all_size - 1;
618 while( p_playlist->pp_all_items[i]->i_id != i_id &&
621 if( p_playlist->pp_all_items[i]->i_id < i_id )
629 i = i_bottom + ( i_top - i_bottom ) / 2;
631 if( p_playlist->pp_all_items[i]->i_id == i_id )
633 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size, i );
636 /* Check if it is the current item */
637 if( p_playlist->status.p_item == p_item )
639 /* Hack we don't call playlist_Control for lock reasons */
642 p_playlist->request.i_status = PLAYLIST_STOPPED;
643 p_playlist->request.b_request = VLC_TRUE;
644 p_playlist->request.p_item = NULL;
645 msg_Info( p_playlist, "stopping playback" );
650 PL_DEBUG( "deleting item `%s'", p_item->p_input->psz_name );
652 /* Remove the item from its parent */
653 playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
655 if( b_flag == VLC_FALSE )
656 playlist_ItemDelete( p_item );
659 PL_DEBUG( "marking %s for further deletion", PLI_NAME( p_item ) );
660 p_item->i_flags |= PLAYLIST_REMOVE_FLAG;