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"
29 void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
30 playlist_item_t *p_node, int i_pos );
31 void GoAndPreparse( playlist_t *p_playlist, int i_mode,
32 playlist_item_t *, playlist_item_t * );
33 void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item );
34 int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
37 /*****************************************************************************
38 * Playlist item creation
39 *****************************************************************************/
41 * Create a new item, without adding it to the playlist
43 * \param p_obj a vlc object (anyone will do)
44 * \param psz_uri the mrl of the item
45 * \param psz_name a text giving a name or description of the item
46 * \return the new item or NULL on failure
48 playlist_item_t * __playlist_ItemNew( vlc_object_t *p_obj,
50 const char *psz_name )
52 return playlist_ItemNewWithType( p_obj, psz_uri,
53 psz_name, 0, NULL, -1,
57 playlist_item_t * playlist_ItemNewWithType( vlc_object_t *p_obj,
61 const char **ppsz_options,
65 input_item_t *p_input;
67 if( psz_uri == NULL ) return NULL;
68 p_input = input_ItemNewWithType( p_obj, psz_uri,
69 psz_name, i_options, ppsz_options,
71 return playlist_ItemNewFromInput( p_obj, p_input );
74 playlist_item_t *__playlist_ItemNewFromInput( vlc_object_t *p_obj,
75 input_item_t *p_input )
77 /** FIXME !!!!! don't find playlist each time */
78 playlist_t *p_playlist = (playlist_t *)vlc_object_find( p_obj, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
79 playlist_item_t * p_item;
80 p_item = malloc( sizeof( playlist_item_t ) );
81 if( p_item == NULL ) return NULL;
83 p_item->p_input = p_input;
84 vlc_gc_incref( p_item->p_input );
86 p_item->i_id = ++p_playlist->i_last_playlist_id;
88 p_item->p_parent = NULL;
89 p_item->i_children = -1;
90 p_item->pp_children = NULL;
93 vlc_object_release( p_playlist );
98 /***************************************************************************
99 * Playlist item destruction
100 ***************************************************************************/
102 /** Delete a playlist item and detach its input item */
103 int playlist_ItemDelete( playlist_item_t *p_item )
105 vlc_gc_decref( p_item->p_input );
110 /** Remove an input item from ONELEVEL and CATEGORY */
111 int playlist_DeleteAllFromInput( playlist_t *p_playlist, int i_input_id )
113 playlist_DeleteFromInput( p_playlist, i_input_id,
114 p_playlist->p_root_category, VLC_TRUE );
115 playlist_DeleteFromInput( p_playlist, i_input_id,
116 p_playlist->p_root_onelevel, VLC_TRUE );
120 /** Remove an input item from ONELEVEL and CATEGORY.
121 * This function must be entered without the playlist lock */
122 int playlist_LockDeleteAllFromInput( playlist_t * p_playlist, int i_id )
125 vlc_mutex_lock( &p_playlist->object_lock );
126 i_ret = playlist_DeleteAllFromInput( p_playlist, i_id );
127 vlc_mutex_unlock( &p_playlist->object_lock );
131 /** Remove an input item when it appears from a root playlist item */
132 int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
133 playlist_item_t *p_root, vlc_bool_t b_do_stop )
136 for( i = 0 ; i< p_root->i_children ; i++ )
138 if( p_root->pp_children[i]->i_children == -1 &&
139 p_root->pp_children[i]->p_input->i_id == i_input_id )
141 DeleteInner( p_playlist, p_root->pp_children[i], b_do_stop );
143 else if( p_root->pp_children[i]->i_children >= 0 )
145 return playlist_DeleteFromInput( p_playlist, i_input_id,
146 p_root->pp_children[i], b_do_stop );
152 /** Remove a playlist item from the playlist, given its id */
153 int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
155 playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id );
156 if( !p_item ) return VLC_EGENERIC;
157 return DeleteInner( p_playlist, p_item, VLC_TRUE );
160 /** Remove a playlist item from the playlist, given its id
161 * This function should be entered without the playlist lock */
162 int playlist_LockDelete( playlist_t * p_playlist, int i_id )
165 vlc_mutex_lock( &p_playlist->object_lock );
166 i_ret = playlist_DeleteFromItemId( p_playlist, i_id );
167 vlc_mutex_unlock( &p_playlist->object_lock );
171 /** Clear the playlist */
172 void playlist_Clear( playlist_t * p_playlist )
174 playlist_NodeEmpty( p_playlist, p_playlist->p_root_category, VLC_TRUE );
175 playlist_NodeEmpty( p_playlist, p_playlist->p_root_onelevel, VLC_TRUE );
177 /** Clear the playlist. This function must be entered without the lock */
178 void playlist_LockClear( playlist_t *p_playlist )
180 vlc_mutex_lock( &p_playlist->object_lock );
181 playlist_Clear( p_playlist );
182 vlc_mutex_unlock( &p_playlist->object_lock );
185 /***************************************************************************
186 * Playlist item addition
187 ***************************************************************************/
190 * Add a MRL into the playlist.
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 it's size
199 * \return The id of the playlist item
201 int playlist_PlaylistAdd( playlist_t *p_playlist, const char *psz_uri,
202 const char *psz_name, int i_mode, int i_pos )
204 return playlist_PlaylistAddExt( p_playlist, psz_uri, psz_name,
205 i_mode, i_pos, -1, NULL, 0 );
209 * Add a MRL into the playlist, duration and options given
211 * \param p_playlist the playlist to add into
212 * \param psz_uri the mrl to add to the playlist
213 * \param psz_name a text giving a name or description of this item
214 * \param i_mode the mode used when adding
215 * \param i_pos the position in the playlist where to add. If this is
216 * PLAYLIST_END the item will be added at the end of the playlist
217 * regardless of it's size
218 * \param i_duration length of the item in milliseconds.
219 * \param ppsz_options an array of options
220 * \param i_options the number of options
221 * \return The id of the playlist item
223 int playlist_PlaylistAddExt( playlist_t *p_playlist, const char * psz_uri,
224 const char *psz_name, int i_mode, int i_pos,
225 mtime_t i_duration, const char **ppsz_options,
228 input_item_t *p_input = input_ItemNewExt( p_playlist, psz_uri, psz_name,
229 i_options, ppsz_options,
232 return playlist_PlaylistAddInput( p_playlist, p_input, i_mode, i_pos );
235 /** Add an input item to the playlist node */
236 int playlist_PlaylistAddInput( playlist_t* p_playlist, input_item_t *p_input,
237 int i_mode, int i_pos )
239 playlist_item_t *p_item_cat, *p_item_one;
240 p_input->i_id = ++p_playlist->i_last_input_id;
242 msg_Dbg( p_playlist, "adding playlist item `%s' ( %s )",
243 p_input->psz_name, p_input->psz_uri );
245 vlc_mutex_lock( &p_playlist->object_lock );
247 /* Add to ONELEVEL */
248 p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
249 if( p_item_one == NULL ) return VLC_EGENERIC;
250 AddItem( p_playlist, p_item_one ,p_playlist->p_local_onelevel, i_pos );
252 /* Add to CATEGORY */
253 p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
254 if( p_item_cat == NULL ) return VLC_EGENERIC;
255 AddItem( p_playlist, p_item_cat, p_playlist->p_local_category, i_pos );
257 GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
259 vlc_mutex_unlock( &p_playlist->object_lock );
263 /** Add an input item to p_direct_parent in the category tree, and to the
264 * matching top category in onelevel **/
265 int playlist_BothAddInput( playlist_t *p_playlist,
266 input_item_t *p_input,
267 playlist_item_t *p_direct_parent,
268 int i_mode, int i_pos )
270 playlist_item_t *p_item_cat, *p_item_one, *p_up;
273 vlc_mutex_lock( & p_playlist->object_lock );
275 /* Add to category */
276 p_item_cat = playlist_ItemNewFromInput( p_playlist, p_input );
277 if( p_item_cat == NULL ) return VLC_EGENERIC;
278 AddItem( p_playlist, p_item_cat, p_direct_parent, i_pos );
280 /* Add to onelevel */
281 p_item_one = playlist_ItemNewFromInput( p_playlist, p_input );
282 if( p_item_one == NULL ) return VLC_EGENERIC;
284 p_up = p_direct_parent;
285 while( p_up->p_parent != p_playlist->p_root_category )
287 p_up = p_up->p_parent;
289 for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
291 if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id == p_up->p_input->i_id )
293 AddItem( p_playlist, p_item_one,
294 p_playlist->p_root_onelevel->pp_children[i_top], i_pos );
298 GoAndPreparse( p_playlist, i_mode, p_item_cat, p_item_one );
300 vlc_mutex_unlock( &p_playlist->object_lock );
305 * Add an item where it should be added, when adding from a node
306 * (ex: directory access, playlist demuxers, services discovery, ... )
307 * \param p_playlist the playlist
308 * \param p_input the input to add
309 * \param p_parent the direct node
310 * \param p_item_in_category the item within category root (as returned by playlist_ItemToNode)
311 * \param b_forced_parent Are we forced to add only to p_parent ?
313 void playlist_AddWhereverNeeded( playlist_t *p_playlist, input_item_t *p_input,
314 playlist_item_t *p_parent,
315 playlist_item_t *p_item_in_category,
316 vlc_bool_t b_forced_parent, int i_mode )
318 /* If we have forced a parent :
319 * - Just add the input to the forced parent (which should be p_parent)
321 * - If we have item in category, add to it, and to onelevel (bothadd)
322 * - If we don't, just add to p_parent
324 if( b_forced_parent == VLC_TRUE || !p_item_in_category )
326 playlist_NodeAddInput( p_playlist, p_input, p_parent, i_mode,
331 playlist_BothAddInput( p_playlist, p_input, p_item_in_category,
332 i_mode, PLAYLIST_END );
337 /** Add an input item to a given node */
338 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
339 input_item_t *p_input,
340 playlist_item_t *p_parent,
341 int i_mode, int i_pos )
343 playlist_item_t *p_item;
345 assert( p_parent && p_parent->i_children != -1 );
347 vlc_mutex_lock( &p_playlist->object_lock );
349 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
350 if( p_item == NULL ) return NULL;
351 AddItem( p_playlist, p_item, p_parent, i_pos );
353 vlc_mutex_unlock( &p_playlist->object_lock );
358 /** Add a playlist item to a given node */
359 void playlist_NodeAddItem( playlist_t *p_playlist, playlist_item_t *p_item,
360 playlist_item_t *p_parent, int i_mode, int i_pos )
362 vlc_mutex_lock( &p_playlist->object_lock );
363 AddItem( p_playlist, p_item, p_parent, i_pos );
364 vlc_mutex_unlock( &p_playlist->object_lock );
367 /*****************************************************************************
368 * Playlist item misc operations
369 *****************************************************************************/
372 * Transform an item to a node. Return the node in the category tree, or NULL
374 * This function must be entered without the playlist lock
376 playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
377 playlist_item_t *p_item )
380 * Find the input in CATEGORY.
382 * - change it to node
383 * - we'll return it at the end
384 * - If we are a direct child of onelevel root, change to node, else
385 * delete the input from ONELEVEL
386 * - If we don't find it, just change to node (we are probably in VLM)
389 * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
390 * useful for later BothAddInput )
393 /** \todo First look if we don't already have it */
394 playlist_item_t *p_item_in_category = playlist_ItemFindFromInputAndRoot(
395 p_playlist, p_item->p_input->i_id,
396 p_playlist->p_root_category );
398 if( p_item_in_category )
400 playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
401 p_playlist, p_item->p_input->i_id,
402 p_playlist->p_root_onelevel );
403 ChangeToNode( p_playlist, p_item_in_category );
404 if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
406 ChangeToNode( p_playlist, p_item_in_one );
410 playlist_DeleteFromInput( p_playlist, p_item->p_input->i_id,
411 p_playlist->p_root_onelevel, VLC_FALSE );
413 var_SetInteger( p_playlist, "item-change", p_item->p_input->i_id );
414 return p_item_in_category;
418 ChangeToNode( p_playlist, p_item );
423 /** Transform an item to a node
424 * This function must be entered without the playlist lock
425 * \see playlist_ItemToNode
427 playlist_item_t * playlist_LockItemToNode( playlist_t *p_playlist,
428 playlist_item_t *p_item )
430 playlist_item_t *p_ret;
431 vlc_mutex_lock( &p_playlist->object_lock );
432 p_ret = playlist_ItemToNode( p_playlist, p_item );
433 vlc_mutex_unlock( &p_playlist->object_lock );
437 /** Find an item within a root, given its input id.
438 * \return the first found item, or NULL if not found
440 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
442 playlist_item_t *p_root )
445 for( i = 0 ; i< p_root->i_children ; i++ )
447 if( p_root->pp_children[i]->i_children == -1 &&
448 p_root->pp_children[i]->p_input->i_id == i_input_id )
450 return p_root->pp_children[i];
452 else if( p_root->pp_children[i]->i_children >= 0 )
454 playlist_item_t *p_search =
455 playlist_ItemFindFromInputAndRoot( p_playlist, i_input_id,
456 p_root->pp_children[i] );
457 if( p_search ) return p_search;
467 * This function must be entered with the playlist lock
469 * \param p_playlist the playlist
470 * \param p_item the item to move
471 * \param p_node the new parent of the item
472 * \param i_newpos the new position under this new parent
473 * \return VLC_SUCCESS or an error
475 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
476 playlist_item_t *p_node, int i_newpos )
479 playlist_item_t *p_detach = NULL;
481 if( p_node->i_children == -1 ) return VLC_EGENERIC;
483 p_detach = p_item->p_parent;
484 for( j = 0; j < p_detach->i_children; j++ )
486 if( p_detach->pp_children[j] == p_item ) break;
488 REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );
490 /* Attach to new parent */
491 INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
496 /** Send a notification that an item has been added to a node */
497 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
501 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
502 p_add->i_item = i_item_id;
503 p_add->i_node = i_node_id;
504 val.p_address = p_add;
505 var_Set( p_playlist, "item-append", val );
509 /*****************************************************************************
510 * Playlist item accessors
511 *****************************************************************************/
513 /** Set the name of a playlist item */
514 int playlist_ItemSetName( playlist_item_t *p_item, char *psz_name )
516 if( psz_name && p_item )
518 if( p_item->p_input->psz_name ) free( p_item->p_input->psz_name );
519 p_item->p_input->psz_name = strdup( psz_name );
525 /** Set the duration of a playlist item
526 * \param i_duration the new duration in microseconds
528 int playlist_ItemSetDuration( playlist_item_t *p_item, mtime_t i_duration )
530 char psz_buffer[MSTRTIME_MAX_SIZE];
533 p_item->p_input->i_duration = i_duration;
534 if( i_duration != -1 )
536 secstotimestr( psz_buffer, (int)(i_duration/1000000) );
540 memcpy( psz_buffer, "--:--:--", sizeof("--:--:--") );
542 vlc_input_item_AddInfo( p_item->p_input, _("General") , _("Duration"),
550 /** Add an option to a playlist item */
551 void playlist_ItemAddOption( playlist_item_t *p_item,
552 const char *psz_option)
554 vlc_input_item_AddOption( p_item->p_input, psz_option );
557 /***************************************************************************
558 * The following functions are local
559 ***************************************************************************/
561 /* Enqueue an item for preparsing, and play it, if needed */
562 void GoAndPreparse( playlist_t *p_playlist, int i_mode,
563 playlist_item_t *p_item_cat, playlist_item_t *p_item_one )
565 if( (i_mode & PLAYLIST_GO ) )
567 playlist_item_t *p_parent = p_item_one;
568 playlist_item_t *p_toplay = NULL;
571 if( p_parent == p_playlist->p_root_category )
573 p_toplay = p_item_cat; break;
575 else if( p_parent == p_playlist->p_root_onelevel )
577 p_toplay = p_item_one; break;
579 p_parent = p_parent->p_parent;
582 p_playlist->request.b_request = VLC_TRUE;
583 p_playlist->request.p_item = p_toplay;
584 if( p_playlist->p_input )
586 input_StopThread( p_playlist->p_input );
588 p_playlist->request.i_status = PLAYLIST_RUNNING;
590 if( i_mode & PLAYLIST_PREPARSE &&
591 var_CreateGetBool( p_playlist, "auto-preparse" ) )
593 playlist_PreparseEnqueue( p_playlist, p_item_cat->p_input );
597 /* Add the playlist item to the requested node and fire a notification */
598 void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
599 playlist_item_t *p_node, int i_pos )
601 INSERT_ELEM( p_playlist->pp_items, p_playlist->i_size,
602 p_playlist->i_size, p_item );
604 fprintf( stderr, "Adding input %s (id %i) - playlist item id %i "
605 "to node %s (id %i)\n",
606 p_item->p_input->psz_name, p_item->p_input->i_id,
607 p_item->i_id, p_node->p_input->psz_name,
610 INSERT_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size,
611 p_playlist->i_all_size, p_item );
612 p_playlist->i_enabled ++;
614 if( i_pos == PLAYLIST_END )
616 playlist_NodeAppend( p_playlist, p_item, p_node );
620 playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
623 playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id );
626 /* Actually convert an item to a node */
627 void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
630 if( p_item->i_children == -1 )
631 p_item->i_children = 0;
633 /* Remove it from the array of available items */
634 for( i = 0 ; i < p_playlist->i_size ; i++ )
636 if( p_item == p_playlist->pp_items[i] )
638 REMOVE_ELEM( p_playlist->pp_items, p_playlist->i_size, i );
643 /* Do the actual removal */
644 int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
647 int i, i_top, i_bottom;
648 int i_id = p_item->i_id;
649 vlc_bool_t b_flag = VLC_FALSE;
651 //fprintf( stderr, "Deleting item %i - %s\n", i_id,
652 // p_item->p_input->psz_name );
654 if( p_item->i_children > -1 )
656 return playlist_NodeDelete( p_playlist, p_item, VLC_TRUE, VLC_FALSE );
658 var_SetInteger( p_playlist, "item-deleted", i_id );
660 /* Remove the item from the bank */
661 i_bottom = 0; i_top = p_playlist->i_all_size - 1;
663 while( p_playlist->pp_all_items[i]->i_id != i_id &&
666 if( p_playlist->pp_all_items[i]->i_id < i_id )
674 i = i_bottom + ( i_top - i_bottom ) / 2;
676 if( p_playlist->pp_all_items[i]->i_id == i_id )
678 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size, i );
681 /* Check if it is the current item */
682 if( p_playlist->status.p_item == p_item )
684 /* Hack we don't call playlist_Control for lock reasons */
687 p_playlist->status.i_status = PLAYLIST_STOPPED;
688 p_playlist->request.b_request = VLC_TRUE;
689 p_playlist->request.p_item = NULL;
690 msg_Info( p_playlist, "stopping playback" );
695 msg_Dbg( p_playlist, "deleting playlist item `%s'",
696 p_item->p_input->psz_name );
698 /* Remove the item from its parent */
699 playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
701 if( b_flag == VLC_FALSE )
702 playlist_ItemDelete( p_item );
704 p_item->i_flags |= PLAYLIST_REMOVE_FLAG;