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 *p_item );
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 if( psz_uri == NULL ) return NULL;
66 input_item_t *p_input = input_ItemNewWithType( p_obj, psz_uri,
67 psz_name, i_options, ppsz_options,
69 return playlist_ItemNewFromInput( p_obj, p_input );
72 playlist_item_t *__playlist_ItemNewFromInput( vlc_object_t *p_obj,
73 input_item_t *p_input )
75 /** FIXME !!!!! don't find playlist each time */
76 playlist_t *p_playlist = (playlist_t *)vlc_object_find( p_obj, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
77 playlist_item_t * p_item;
78 p_item = malloc( sizeof( playlist_item_t ) );
79 if( p_item == NULL ) return NULL;
81 p_item->p_input = p_input;
82 vlc_gc_incref( p_item->p_input );
84 p_item->i_id = ++p_playlist->i_last_playlist_id;
86 p_item->p_parent = NULL;
87 p_item->i_children = -1;
88 p_item->pp_children = NULL;
91 vlc_object_release( p_playlist );
96 /***************************************************************************
97 * Playlist item destruction
98 ***************************************************************************/
100 /** Delete a playlist item and detach its input item */
101 int playlist_ItemDelete( playlist_item_t *p_item )
103 vlc_gc_decref( p_item->p_input );
108 /** Remove an input item from ONELEVEL and CATEGORY */
109 int playlist_DeleteAllFromInput( playlist_t *p_playlist, int i_input_id )
111 playlist_DeleteFromInput( p_playlist, i_input_id,
112 p_playlist->p_root_category, VLC_TRUE );
113 playlist_DeleteFromInput( p_playlist, i_input_id,
114 p_playlist->p_root_onelevel, VLC_TRUE );
118 /** Remove an input item from ONELEVEL and CATEGORY.
119 * This function must be entered without the playlist lock */
120 int playlist_LockDeleteAllFromInput( playlist_t * p_playlist, int i_id )
123 vlc_mutex_lock( &p_playlist->object_lock );
124 i_ret = playlist_DeleteAllFromInput( p_playlist, i_id );
125 vlc_mutex_unlock( &p_playlist->object_lock );
129 /** Remove an input item when it appears from a root playlist item */
130 int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id,
131 playlist_item_t *p_root, vlc_bool_t b_do_stop )
134 for( i = 0 ; i< p_root->i_children ; i++ )
136 if( p_root->pp_children[i]->i_children == -1 &&
137 p_root->pp_children[i]->p_input->i_id == i_input_id )
139 DeleteInner( p_playlist, p_root->pp_children[i], b_do_stop );
141 else if( p_root->pp_children[i]->i_children >= 0 )
143 return playlist_DeleteFromInput( p_playlist, i_input_id,
144 p_root->pp_children[i], b_do_stop );
150 /** Remove a playlist item from the playlist, given its id */
151 int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id )
153 playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id );
154 if( !p_item ) return VLC_EGENERIC;
155 return DeleteInner( p_playlist, p_item, VLC_TRUE );
158 /** Remove a playlist item from the playlist, given its id
159 * This function should be entered without the playlist lock */
160 int playlist_LockDelete( playlist_t * p_playlist, int i_id )
163 vlc_mutex_lock( &p_playlist->object_lock );
164 i_ret = playlist_DeleteFromItemId( p_playlist, i_id );
165 vlc_mutex_unlock( &p_playlist->object_lock );
169 /** Clear the playlist */
170 void playlist_Clear( playlist_t * p_playlist )
172 playlist_NodeEmpty( p_playlist, p_playlist->p_root_category, VLC_TRUE );
173 playlist_NodeEmpty( p_playlist, p_playlist->p_root_onelevel, VLC_TRUE );
175 /** Clear the playlist. This function must be entered without the lock */
176 void playlist_LockClear( playlist_t *p_playlist )
178 vlc_mutex_lock( &p_playlist->object_lock );
179 playlist_Clear( p_playlist );
180 vlc_mutex_unlock( &p_playlist->object_lock );
183 /***************************************************************************
184 * Playlist item addition
185 ***************************************************************************/
188 * Add a MRL into the playlist.
190 * \param p_playlist the playlist to add into
191 * \param psz_uri the mrl to add to the playlist
192 * \param psz_name a text giving a name or description of this item
193 * \param i_mode the mode used when adding
194 * \param i_pos the position in the playlist where to add. If this is
195 * PLAYLIST_END the item will be added at the end of the playlist
196 * regardless of it's size
197 * \return The id of the playlist item
199 int playlist_PlaylistAdd( playlist_t *p_playlist, const char *psz_uri,
200 const char *psz_name, int i_mode, int i_pos )
202 return playlist_PlaylistAddExt( p_playlist, psz_uri, psz_name,
203 i_mode, i_pos, -1, NULL, 0 );
207 * Add a MRL into the playlist, duration and options given
209 * \param p_playlist the playlist to add into
210 * \param psz_uri the mrl to add to the playlist
211 * \param psz_name a text giving a name or description of this item
212 * \param i_mode the mode used when adding
213 * \param i_pos the position in the playlist where to add. If this is
214 * PLAYLIST_END the item will be added at the end of the playlist
215 * regardless of it's size
216 * \param i_duration length of the item in milliseconds.
217 * \param ppsz_options an array of options
218 * \param i_options the number of options
219 * \return The id of the playlist item
221 int playlist_PlaylistAddExt( playlist_t *p_playlist, const char * psz_uri,
222 const char *psz_name, int i_mode, int i_pos,
223 mtime_t i_duration, const char **ppsz_options,
226 input_item_t *p_input = input_ItemNewExt( p_playlist, psz_uri, psz_name,
227 i_options, ppsz_options,
230 return playlist_PlaylistAddInput( p_playlist, p_input, i_mode, i_pos );
233 /** Add an input item to the playlist node */
234 int playlist_PlaylistAddInput( playlist_t* p_playlist, input_item_t *p_input,
235 int i_mode, int i_pos )
237 playlist_item_t *p_item;
238 p_input->i_id = ++p_playlist->i_last_input_id;
240 msg_Dbg( p_playlist, "adding playlist item `%s' ( %s )",
241 p_input->psz_name, p_input->psz_uri );
243 vlc_mutex_lock( &p_playlist->object_lock );
245 /* Add to ONELEVEL */
246 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
247 if( p_item == NULL ) return VLC_EGENERIC;
248 AddItem( p_playlist, p_item,p_playlist->p_local_onelevel, i_pos );
250 /* Add to CATEGORY */
251 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
252 if( p_item == NULL ) return VLC_EGENERIC;
253 AddItem( p_playlist, p_item, p_playlist->p_local_category, i_pos );
255 GoAndPreparse( p_playlist, i_mode, p_item );
257 vlc_mutex_unlock( &p_playlist->object_lock );
261 /** Add an input item to p_direct_parent in the category tree, and to the
262 * matching top category in onelevel **/
263 int playlist_BothAddInput( playlist_t *p_playlist,
264 input_item_t *p_input,
265 playlist_item_t *p_direct_parent,
266 int i_mode, int i_pos )
268 playlist_item_t *p_item, *p_up;
271 vlc_mutex_lock( & p_playlist->object_lock );
273 /* Add to category */
274 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
275 if( p_item == NULL ) return VLC_EGENERIC;
276 AddItem( p_playlist, p_item, p_direct_parent, i_pos );
278 /* Add to onelevel */
279 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
280 if( p_item == NULL ) return VLC_EGENERIC;
282 p_up = p_direct_parent;
283 while( p_up->p_parent != p_playlist->p_root_category )
285 p_up = p_up->p_parent;
287 for( i_top = 0 ; i_top < p_playlist->p_root_onelevel->i_children; i_top++ )
289 if( p_playlist->p_root_onelevel->pp_children[i_top]->p_input->i_id == p_up->p_input->i_id )
291 AddItem( p_playlist, p_item,
292 p_playlist->p_root_onelevel->pp_children[i_top], i_pos );
296 GoAndPreparse( p_playlist, i_mode, p_item );
298 vlc_mutex_unlock( &p_playlist->object_lock );
303 * Add an item where it should be added, when adding from a node
304 * (ex: directory access, playlist demuxers, services discovery, ... )
305 * \param p_playlist the playlist
306 * \param p_input the input to add
307 * \param p_parent the direct node
308 * \param p_item_in_category the item within category root (as returned by playlist_ItemToNode)
309 * \param b_forced_parent Are we forced to add only to p_parent ?
311 void playlist_AddWhereverNeeded( playlist_t *p_playlist, input_item_t *p_input,
312 playlist_item_t *p_parent,
313 playlist_item_t *p_item_in_category,
314 vlc_bool_t b_forced_parent, int i_mode )
316 /* If we have forced a parent :
317 * - Just add the input to the forced parent (which should be p_parent)
319 * - If we have item in category, add to it, and to onelevel (bothadd)
320 * - If we don't, just add to p_parent
322 if( b_forced_parent == VLC_TRUE || !p_item_in_category )
324 playlist_NodeAddInput( p_playlist, p_input, p_parent, i_mode,
329 playlist_BothAddInput( p_playlist, p_input, p_item_in_category,
330 i_mode, PLAYLIST_END );
335 /** Add an input item to a given node */
336 playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist,
337 input_item_t *p_input,
338 playlist_item_t *p_parent,
339 int i_mode, int i_pos )
341 playlist_item_t *p_item;
343 assert( p_parent && p_parent->i_children != -1 );
345 vlc_mutex_lock( &p_playlist->object_lock );
347 p_item = playlist_ItemNewFromInput( p_playlist, p_input );
348 if( p_item == NULL ) return NULL;
349 AddItem( p_playlist, p_item, p_parent, i_pos );
351 vlc_mutex_unlock( &p_playlist->object_lock );
356 /** Add a playlist item to a given node */
357 void playlist_NodeAddItem( playlist_t *p_playlist, playlist_item_t *p_item,
358 playlist_item_t *p_parent, int i_mode, int i_pos )
360 vlc_mutex_lock( &p_playlist->object_lock );
361 AddItem( p_playlist, p_item, p_parent, i_pos );
362 vlc_mutex_unlock( &p_playlist->object_lock );
365 /*****************************************************************************
366 * Playlist item misc operations
367 *****************************************************************************/
370 * Transform an item to a node. Return the node in the category tree, or NULL
372 * This function must be entered without the playlist lock
374 playlist_item_t *playlist_ItemToNode( playlist_t *p_playlist,
375 playlist_item_t *p_item )
378 * Find the input in CATEGORY.
380 * - change it to node
381 * - we'll return it at the end
382 * - If we are a direct child of onelevel root, change to node, else
383 * delete the input from ONELEVEL
384 * - If we don't find it, just change to node (we are probably in VLM)
387 * If we were in ONELEVEL, we thus retrieve the node in CATEGORY (will be
388 * useful for later BothAddInput )
391 /** \todo First look if we don't already have it */
392 playlist_item_t *p_item_in_category = playlist_ItemFindFromInputAndRoot(
393 p_playlist, p_item->p_input->i_id,
394 p_playlist->p_root_category );
396 if( p_item_in_category )
398 playlist_item_t *p_item_in_one = playlist_ItemFindFromInputAndRoot(
399 p_playlist, p_item->p_input->i_id,
400 p_playlist->p_root_onelevel );
401 ChangeToNode( p_playlist, p_item_in_category );
402 if( p_item_in_one->p_parent == p_playlist->p_root_onelevel )
404 ChangeToNode( p_playlist, p_item_in_one );
408 playlist_DeleteFromInput( p_playlist, p_item->p_input->i_id,
409 p_playlist->p_root_onelevel, VLC_FALSE );
411 var_SetInteger( p_playlist, "item-change", p_item->p_input->i_id );
412 return p_item_in_category;
416 ChangeToNode( p_playlist, p_item );
421 /** Transform an item to a node
422 * This function must be entered without the playlist lock
423 * \see playlist_ItemToNode
425 playlist_item_t * playlist_LockItemToNode( playlist_t *p_playlist,
426 playlist_item_t *p_item )
428 playlist_item_t *p_ret;
429 vlc_mutex_lock( &p_playlist->object_lock );
430 p_ret = playlist_ItemToNode( p_playlist, p_item );
431 vlc_mutex_unlock( &p_playlist->object_lock );
435 /** Find an item within a root, given its input id.
436 * \return the first found item, or NULL if not found
438 playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
440 playlist_item_t *p_root )
443 for( i = 0 ; i< p_root->i_children ; i++ )
445 if( p_root->pp_children[i]->i_children == -1 &&
446 p_root->pp_children[i]->p_input->i_id == i_input_id )
448 return p_root->pp_children[i];
450 else if( p_root->pp_children[i]->i_children >= 0 )
452 playlist_item_t *p_search =
453 playlist_ItemFindFromInputAndRoot( p_playlist, i_input_id,
454 p_root->pp_children[i] );
455 if( p_search ) return p_search;
465 * This function must be entered with the playlist lock
467 * \param p_playlist the playlist
468 * \param p_item the item to move
469 * \param p_node the new parent of the item
470 * \param i_newpos the new position under this new parent
471 * \return VLC_SUCCESS or an error
473 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
474 playlist_item_t *p_node, int i_newpos )
477 playlist_item_t *p_detach = NULL;
479 if( p_node->i_children == -1 ) return VLC_EGENERIC;
481 p_detach = p_item->p_parent;
482 for( j = 0; j < p_detach->i_children; j++ )
484 if( p_detach->pp_children[j] == p_item ) break;
486 REMOVE_ELEM( p_detach->pp_children, p_detach->i_children, j );
488 /* Attach to new parent */
489 INSERT_ELEM( p_node->pp_children, p_node->i_children, i_newpos, p_item );
494 /** Send a notification that an item has been added to a node */
495 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
499 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
500 p_add->i_item = i_item_id;
501 p_add->i_node = i_node_id;
502 val.p_address = p_add;
503 var_Set( p_playlist, "item-append", val );
507 /*****************************************************************************
508 * Playlist item accessors
509 *****************************************************************************/
511 /** Set the name of a playlist item */
512 int playlist_ItemSetName( playlist_item_t *p_item, char *psz_name )
514 if( psz_name && p_item )
516 if( p_item->p_input->psz_name ) free( p_item->p_input->psz_name );
517 p_item->p_input->psz_name = strdup( psz_name );
523 /** Set the duration of a playlist item
524 * \param i_duration the new duration in microseconds
526 int playlist_ItemSetDuration( playlist_item_t *p_item, mtime_t i_duration )
528 char psz_buffer[MSTRTIME_MAX_SIZE];
531 p_item->p_input->i_duration = i_duration;
532 if( i_duration != -1 )
534 secstotimestr( psz_buffer, (int)(i_duration/1000000) );
538 memcpy( psz_buffer, "--:--:--", sizeof("--:--:--") );
540 vlc_input_item_AddInfo( p_item->p_input, _("General") , _("Duration"),
548 /** Add an option to a playlist item */
549 void playlist_ItemAddOption( playlist_item_t *p_item,
550 const char *psz_option)
552 vlc_input_item_AddOption( p_item->p_input, psz_option );
555 /***************************************************************************
556 * The following functions are local
557 ***************************************************************************/
559 /* Enqueue an item for preparsing, and play it, if needed */
560 void GoAndPreparse( playlist_t *p_playlist, int i_mode,
561 playlist_item_t *p_item )
564 if( (i_mode & PLAYLIST_GO ) && p_view )
566 p_playlist->request.b_request = VLC_TRUE;
568 p_playlist->request.i_view = VIEW_CATEGORY;
569 p_playlist->request.p_node = p_view->p_root;
570 p_playlist->request.p_item = p_item;
572 if( p_playlist->p_input )
574 input_StopThread( p_playlist->p_input );
576 p_playlist->status.i_status = PLAYLIST_RUNNING;
579 if( i_mode & PLAYLIST_PREPARSE &&
580 var_CreateGetBool( p_playlist, "auto-preparse" ) )
582 playlist_PreparseEnqueue( p_playlist, p_item->p_input );
586 /* Add the playlist item to the requested node and fire a notification */
587 void AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
588 playlist_item_t *p_node, int i_pos )
590 INSERT_ELEM( p_playlist->pp_items, p_playlist->i_size,
591 p_playlist->i_size, p_item );
593 fprintf( stderr, "Adding input %s (id %i) - playlist item id %i "
594 "to node %s (id %i)\n",
595 p_item->p_input->psz_name, p_item->p_input->i_id,
596 p_item->i_id, p_node->p_input->psz_name,
599 INSERT_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size,
600 p_playlist->i_all_size, p_item );
601 p_playlist->i_enabled ++;
603 if( i_pos == PLAYLIST_END )
605 playlist_NodeAppend( p_playlist, p_item, p_node );
609 playlist_NodeInsert( p_playlist, p_item, p_node, i_pos );
612 playlist_SendAddNotify( p_playlist, p_item->i_id, p_node->i_id );
615 /* Actually convert an item to a node */
616 void ChangeToNode( playlist_t *p_playlist, playlist_item_t *p_item )
619 if( p_item->i_children == -1 )
620 p_item->i_children = 0;
622 /* Remove it from the array of available items */
623 for( i = 0 ; i < p_playlist->i_size ; i++ )
625 if( p_item == p_playlist->pp_items[i] )
627 REMOVE_ELEM( p_playlist->pp_items, p_playlist->i_size, i );
632 /* Do the actual removal */
633 int DeleteInner( playlist_t * p_playlist, playlist_item_t *p_item,
636 int i, i_top, i_bottom;
637 int i_id = p_item->i_id;
638 vlc_bool_t b_flag = VLC_FALSE;
640 //fprintf( stderr, "Deleting item %i - %s\n", i_id,
641 // p_item->p_input->psz_name );
643 if( p_item->i_children > -1 )
645 return playlist_NodeDelete( p_playlist, p_item, VLC_TRUE, VLC_FALSE );
647 var_SetInteger( p_playlist, "item-deleted", i_id );
649 /* Remove the item from the bank */
650 i_bottom = 0; i_top = p_playlist->i_all_size - 1;
652 while( p_playlist->pp_all_items[i]->i_id != i_id &&
655 if( p_playlist->pp_all_items[i]->i_id < i_id )
663 i = i_bottom + ( i_top - i_bottom ) / 2;
665 if( p_playlist->pp_all_items[i]->i_id == i_id )
667 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size, i );
670 /* Check if it is the current item */
671 if( p_playlist->status.p_item == p_item )
673 /* Hack we don't call playlist_Control for lock reasons */
676 p_playlist->status.i_status = PLAYLIST_STOPPED;
677 p_playlist->request.b_request = VLC_TRUE;
678 p_playlist->request.p_item = NULL;
679 msg_Info( p_playlist, "stopping playback" );
684 msg_Dbg( p_playlist, "deleting playlist item `%s'",
685 p_item->p_input->psz_name );
687 /* Remove the item from its parent */
688 playlist_NodeRemoveItem( p_playlist, p_item, p_item->p_parent );
690 if( b_flag == VLC_FALSE )
691 playlist_ItemDelete( p_item );
693 p_item->i_flags |= PLAYLIST_REMOVE_FLAG;