1 /*****************************************************************************
2 * item-ext.c : Playlist item management functions (act on the playlist)
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 *****************************************************************************/
24 #include <stdlib.h> /* free(), strtol() */
25 #include <stdio.h> /* sprintf() */
26 #include <string.h> /* strerror() */
29 #include <vlc/input.h>
31 #include "vlc_playlist.h"
33 /***************************************************************************
34 * Item creation/addition functions
35 ***************************************************************************/
38 * Add a MRL into the playlist, duration and options given
40 * \param p_playlist the playlist to add into
41 * \param psz_uri the mrl to add to the playlist
42 * \param psz_name a text giving a name or description of this item
43 * \param i_mode the mode used when adding
44 * \param i_pos the position in the playlist where to add. If this is
45 * PLAYLIST_END the item will be added at the end of the playlist
46 * regardless of it's size
47 * \param i_duration length of the item in milliseconds.
48 * \param ppsz_options an array of options
49 * \param i_options the number of options
50 * \return The id of the playlist item
52 int playlist_AddExt( playlist_t *p_playlist, const char * psz_uri,
53 const char *psz_name, int i_mode, int i_pos,
54 mtime_t i_duration, const char **ppsz_options,
57 playlist_item_t *p_item;
58 p_item = playlist_ItemNew( p_playlist , psz_uri, psz_name );
62 msg_Err( p_playlist, "unable to add item to playlist" );
66 p_item->input.i_duration = i_duration;
67 p_item->input.i_options = i_options;
68 p_item->input.ppsz_options = NULL;
70 for( p_item->input.i_options = 0; p_item->input.i_options < i_options;
71 p_item->input.i_options++ )
73 if( !p_item->input.i_options )
75 p_item->input.ppsz_options = malloc( i_options * sizeof(char *) );
76 if( !p_item->input.ppsz_options ) break;
79 p_item->input.ppsz_options[p_item->input.i_options] =
80 strdup( ppsz_options[p_item->input.i_options] );
83 return playlist_AddItem( p_playlist, p_item, i_mode, i_pos );
87 * Add a MRL into the playlist.
89 * \param p_playlist the playlist to add into
90 * \param psz_uri the mrl to add to the playlist
91 * \param psz_name a text giving a name or description of this item
92 * \param i_mode the mode used when adding
93 * \param i_pos the position in the playlist where to add. If this is
94 * PLAYLIST_END the item will be added at the end of the playlist
95 * regardless of it's size
96 * \return The id of the playlist item
98 int playlist_Add( playlist_t *p_playlist, const char *psz_uri,
99 const char *psz_name, int i_mode, int i_pos )
101 return playlist_AddExt( p_playlist, psz_uri, psz_name, i_mode, i_pos,
106 * Add a playlist item into a playlist
108 * \param p_playlist the playlist to insert into
109 * \param p_item the playlist item to insert
110 * \param i_mode the mode used when adding
111 * \param i_pos the possition in the playlist where to add. If this is
112 * PLAYLIST_END the item will be added at the end of the playlist
113 * regardless of it's size
114 * \return The id of the playlist item
116 int playlist_AddItem( playlist_t *p_playlist, playlist_item_t *p_item,
117 int i_mode, int i_pos)
120 vlc_bool_t b_end = VLC_FALSE;
121 playlist_view_t *p_view = NULL;
123 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
125 vlc_mutex_lock( &p_playlist->object_lock );
128 * CHECK_INSERT : checks if the item is already enqued before
132 /* That should not change */
133 if ( i_mode & PLAYLIST_CHECK_INSERT )
137 if ( p_playlist->pp_items )
139 for ( j = 0; j < p_playlist->i_size; j++ )
141 if ( !strcmp( p_playlist->pp_items[j]->input.psz_uri,
142 p_item->input.psz_uri ) )
144 playlist_ItemDelete( p_item );
145 vlc_mutex_unlock( &p_playlist->object_lock );
150 i_mode &= ~PLAYLIST_CHECK_INSERT;
151 i_mode |= PLAYLIST_APPEND;
154 msg_Dbg( p_playlist, "adding playlist item `%s' ( %s )",
155 p_item->input.psz_name, p_item->input.psz_uri );
157 p_item->input.i_id = ++p_playlist->i_last_id;
159 /* Do a few boundary checks and allocate space for the item */
160 if( i_pos == PLAYLIST_END )
163 if( i_mode & PLAYLIST_INSERT )
165 i_mode &= ~PLAYLIST_INSERT;
166 i_mode |= PLAYLIST_APPEND;
169 i_pos = p_playlist->i_size - 1;
172 if( !(i_mode & PLAYLIST_REPLACE)
173 || i_pos < 0 || i_pos >= p_playlist->i_size )
175 /* Additional boundary checks */
176 if( i_mode & PLAYLIST_APPEND )
185 else if( i_pos > p_playlist->i_size )
187 i_pos = p_playlist->i_size;
190 INSERT_ELEM( p_playlist->pp_items, p_playlist->i_size, i_pos, p_item );
191 INSERT_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size,
192 p_playlist->i_all_size, p_item );
193 p_playlist->i_enabled ++;
195 /* We update the ALL view directly */
196 playlist_ViewUpdate( p_playlist, VIEW_ALL );
198 /* Add the item to the General category */
199 if( b_end == VLC_TRUE )
201 playlist_NodeAppend( p_playlist, VIEW_CATEGORY, p_item,
202 p_playlist->p_general );
203 p_add->i_item = p_item->input.i_id;
204 p_add->i_node = p_playlist->p_general->input.i_id;
205 p_add->i_view = VIEW_CATEGORY;
206 val.p_address = p_add;
207 var_Set( p_playlist, "item-append", val );
211 playlist_NodeInsert( p_playlist, VIEW_CATEGORY, p_item,
212 p_playlist->p_general, i_pos );
216 p_view = playlist_ViewFind( p_playlist, VIEW_ALL );
217 playlist_ItemAddParent( p_item, VIEW_ALL, p_view->p_root );
219 /* FIXME : Update sorted views */
221 if( p_playlist->i_index >= i_pos )
223 p_playlist->i_index++;
228 msg_Err( p_playlist, "Insert mode not implemented" );
231 if( (i_mode & PLAYLIST_GO ) && p_view )
233 p_playlist->request.b_request = VLC_TRUE;
235 p_playlist->request.i_view = VIEW_CATEGORY;
236 p_playlist->request.p_node = p_view->p_root;
237 p_playlist->request.p_item = p_item;
239 if( p_playlist->p_input )
241 input_StopThread( p_playlist->p_input );
243 p_playlist->status.i_status = PLAYLIST_RUNNING;
246 vlc_mutex_unlock( &p_playlist->object_lock );
248 if( b_end == VLC_FALSE )
250 val.b_bool = VLC_TRUE;
251 var_Set( p_playlist, "intf-change", val );
256 return p_item->input.i_id;
261 * Add a playlist item to a given node (in the category view )
263 * \param p_playlist the playlist to insert into
264 * \param p_item the playlist item to insert
265 * \param i_view the view for which to add or TODO: ALL_VIEWS
266 * \param p_parent the parent node
267 * \param i_mode the mode used when adding
268 * \param i_pos the possition in the node where to add. If this is
269 * PLAYLIST_END the item will be added at the end of the node
270 ** \return The id of the playlist item
272 int playlist_NodeAddItem( playlist_t *p_playlist, playlist_item_t *p_item,
273 int i_view,playlist_item_t *p_parent,
274 int i_mode, int i_pos)
278 playlist_view_t *p_view;
280 playlist_add_t *p_add = (playlist_add_t *)malloc(sizeof( playlist_add_t));
282 vlc_mutex_lock( &p_playlist->object_lock );
284 if ( i_pos == PLAYLIST_END ) i_pos = -1;
287 if( !p_parent || p_parent->i_children == -1 )
289 msg_Err( p_playlist, "invalid node" );
293 * CHECK_INSERT : checks if the item is already enqued before
296 if ( i_mode & PLAYLIST_CHECK_INSERT )
300 if ( p_playlist->pp_items )
302 for ( j = 0; j < p_playlist->i_size; j++ )
304 if ( !strcmp( p_playlist->pp_items[j]->input.psz_uri,
305 p_item->input.psz_uri ) )
307 playlist_ItemDelete( p_item );
308 vlc_mutex_unlock( &p_playlist->object_lock );
314 i_mode &= ~PLAYLIST_CHECK_INSERT;
315 i_mode |= PLAYLIST_APPEND;
318 msg_Dbg( p_playlist, "adding playlist item `%s' ( %s )",
319 p_item->input.psz_name, p_item->input.psz_uri );
321 p_item->input.i_id = ++p_playlist->i_last_id;
323 /* First, add the item at the right position in the item bank */
325 //i_position = p_playlist->i_index == -1 ? 0 : p_playlist->i_index;
326 i_position = p_playlist->i_size ;
328 INSERT_ELEM( p_playlist->pp_items,
332 INSERT_ELEM( p_playlist->pp_all_items,
333 p_playlist->i_all_size,
334 p_playlist->i_all_size,
336 p_playlist->i_enabled ++;
338 /* TODO: Handle modes */
339 playlist_NodeInsert( p_playlist, i_view, p_item, p_parent, i_pos );
341 p_add->i_item = p_item->input.i_id;
342 p_add->i_node = p_parent->input.i_id;
343 p_add->i_view = i_view;
344 val.p_address = p_add;
345 var_Set( p_playlist, "item-append", val );
347 /* We update the ALL view directly */
348 p_view = playlist_ViewFind( p_playlist, VIEW_ALL );
349 playlist_ItemAddParent( p_item, VIEW_ALL, p_view->p_root );
350 playlist_ViewUpdate( p_playlist, VIEW_ALL );
352 /* TODO : Update sorted views*/
354 if( i_mode & PLAYLIST_GO )
356 p_playlist->request.b_request = VLC_TRUE;
357 p_playlist->request.i_view = VIEW_CATEGORY;
358 p_playlist->request.p_node = p_parent;
359 p_playlist->request.p_item = p_item;
360 if( p_playlist->p_input )
362 input_StopThread( p_playlist->p_input );
364 p_playlist->status.i_status = PLAYLIST_RUNNING;
367 vlc_mutex_unlock( &p_playlist->object_lock );
369 val.b_bool = VLC_TRUE;
370 // var_Set( p_playlist, "intf-change", val );
374 return p_item->input.i_id;
377 /***************************************************************************
378 * Item search functions
379 ***************************************************************************/
382 * Search the position of an item by its id
383 * This function must be entered with the playlist lock
385 * \param p_playlist the playlist
386 * \param i_id the id to find
387 * \return the position, or VLC_EGENERIC on failure
389 int playlist_GetPositionById( playlist_t * p_playlist , int i_id )
392 for( i = 0 ; i < p_playlist->i_size ; i++ )
394 if( p_playlist->pp_items[i]->input.i_id == i_id )
404 * Search an item by its position
405 * This function must be entered with the playlist lock
407 * \param p_playlist the playlist
408 * \param i_pos the position of the item to find
409 * \return the item, or NULL on failure
411 playlist_item_t * playlist_ItemGetByPos( playlist_t * p_playlist , int i_pos )
413 if( i_pos >= 0 && i_pos < p_playlist->i_size)
415 return p_playlist->pp_items[i_pos];
417 else if( p_playlist->i_size > 0)
419 return p_playlist->pp_items[p_playlist->i_index];
427 playlist_item_t *playlist_LockItemGetByPos( playlist_t *p_playlist, int i_pos )
429 playlist_item_t *p_ret;
430 vlc_mutex_lock( &p_playlist->object_lock );
431 p_ret = playlist_ItemGetByPos( p_playlist, i_pos );
432 vlc_mutex_unlock( &p_playlist->object_lock );
437 * Search an item by its id
439 * \param p_playlist the playlist
440 * \param i_id the id to find
441 * \return the item, or NULL on failure
443 playlist_item_t * playlist_ItemGetById( playlist_t * p_playlist , int i_id )
445 int i, i_top, i_bottom;
446 i_bottom = 0; i_top = p_playlist->i_all_size - 1;
448 while( p_playlist->pp_all_items[i]->input.i_id != i_id &&
451 if( p_playlist->pp_all_items[i]->input.i_id < i_id )
459 i = i_bottom + ( i_top - i_bottom ) / 2;
461 if( p_playlist->pp_all_items[i]->input.i_id == i_id )
463 return p_playlist->pp_all_items[i];
468 playlist_item_t *playlist_LockItemGetById( playlist_t *p_playlist, int i_id)
470 playlist_item_t *p_ret;
471 vlc_mutex_lock( &p_playlist->object_lock );
472 p_ret = playlist_ItemGetById( p_playlist, i_id );
473 vlc_mutex_unlock( &p_playlist->object_lock );
478 * Search an item by its input_item_t
480 * \param p_playlist the playlist
481 * \param p_item the input_item_t to find
482 * \return the item, or NULL on failure
484 playlist_item_t * playlist_ItemGetByInput( playlist_t * p_playlist ,
485 input_item_t *p_item )
488 if( &p_playlist->status.p_item->input == p_item )
490 return p_playlist->status.p_item;
493 for( i = 0 ; i < p_playlist->i_size ; i++ )
495 if( &p_playlist->pp_items[i]->input == p_item )
497 return p_playlist->pp_items[i];
503 playlist_item_t *playlist_LockItemGetByInput( playlist_t *p_playlist,
504 input_item_t *p_item )
506 playlist_item_t *p_ret;
507 vlc_mutex_lock( &p_playlist->object_lock );
508 p_ret = playlist_ItemGetByInput( p_playlist, p_item );
509 vlc_mutex_unlock( &p_playlist->object_lock );
514 /***********************************************************************
516 ***********************************************************************/
519 * Transform an item to a node
521 * This function must be entered without the playlist lock
523 * \param p_playlist the playlist object
524 * \param p_item the item to transform
527 int playlist_ItemToNode( playlist_t *p_playlist,playlist_item_t *p_item )
530 if( p_item->i_children == -1 )
532 p_item->i_children = 0;
535 /* Remove it from the array of available items */
536 for( i = 0 ; i < p_playlist->i_size ; i++ )
538 if( p_item == p_playlist->pp_items[i] )
540 REMOVE_ELEM( p_playlist->pp_items, p_playlist->i_size, i );
543 var_SetInteger( p_playlist, "item-change", p_item->input.i_id );
548 int playlist_LockItemToNode( playlist_t *p_playlist, playlist_item_t *p_item )
551 vlc_mutex_lock( &p_playlist->object_lock );
552 i_ret = playlist_ItemToNode( p_playlist, p_item );
553 vlc_mutex_unlock( &p_playlist->object_lock );
558 * Replaces an item with another one
559 * This function must be entered without the playlist lock
561 * \see playlist_Replace
563 int playlist_LockReplace( playlist_t *p_playlist,
564 playlist_item_t *p_olditem,
565 input_item_t *p_new )
568 vlc_mutex_lock( &p_playlist->object_lock );
569 i_ret = playlist_Replace( p_playlist, p_olditem, p_new );
570 vlc_mutex_unlock( &p_playlist->object_lock );
575 * Replaces an item with another one
576 * This function must be entered with the playlist lock:
578 * \param p_playlist the playlist
579 * \param p_olditem the item to replace
580 * \param p_new the new input_item
581 * \return VLC_SUCCESS or an error
583 int playlist_Replace( playlist_t *p_playlist, playlist_item_t *p_olditem,
584 input_item_t *p_new )
589 if( p_olditem->i_children != -1 )
591 msg_Err( p_playlist, "playlist_Replace can only be used on leafs");
595 p_olditem->i_nb_played = 0;
596 memcpy( &p_olditem->input, p_new, sizeof( input_item_t ) );
598 p_olditem->i_nb_played = 0;
600 for( i = 0 ; i< p_olditem->i_parents ; i++ )
602 playlist_item_t *p_parent = p_olditem->pp_parents[i]->p_parent;
604 for( j = 0 ; j< p_parent->i_children ; i++ )
606 if( p_parent->pp_children[j] == p_olditem )
608 p_parent->i_serial++;
616 * Deletes an item from a playlist.
618 * This function must be entered without the playlist lock
620 * \param p_playlist the playlist to remove from.
621 * \param i_id the identifier of the item to delete
622 * \return returns VLC_SUCCESS or an error
624 int playlist_Delete( playlist_t * p_playlist, int i_id )
626 int i, i_top, i_bottom;
628 vlc_bool_t b_flag = VLC_FALSE;
630 playlist_item_t *p_item = playlist_ItemGetById( p_playlist, i_id );
636 if( p_item->i_children > -1 )
638 return playlist_NodeDelete( p_playlist, p_item, VLC_TRUE, VLC_FALSE );
641 var_SetInteger( p_playlist, "item-deleted", i_id );
643 i_bottom = 0; i_top = p_playlist->i_all_size - 1;
645 while( p_playlist->pp_all_items[i]->input.i_id != i_id &&
648 if( p_playlist->pp_all_items[i]->input.i_id < i_id )
656 i = i_bottom + ( i_top - i_bottom ) / 2;
658 if( p_playlist->pp_all_items[i]->input.i_id == i_id )
660 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size, i );
663 /* Check if it is the current item */
664 if( p_playlist->status.p_item == p_item )
666 /* Hack we don't call playlist_Control for lock reasons */
667 p_playlist->status.i_status = PLAYLIST_STOPPED;
668 p_playlist->request.b_request = VLC_TRUE;
669 p_playlist->request.p_item = NULL;
670 msg_Info( p_playlist, "stopping playback" );
674 /* Get position and update index if needed */
675 i_pos = playlist_GetPositionById( p_playlist, i_id );
677 if( i_pos >= 0 && i_pos <= p_playlist->i_index )
679 p_playlist->i_index--;
682 msg_Dbg( p_playlist, "deleting playlist item `%s'",
683 p_item->input.psz_name );
685 /* Remove the item from all its parent nodes */
686 for ( i= 0 ; i < p_item->i_parents ; i++ )
688 playlist_NodeRemoveItem( p_playlist, p_item,
689 p_item->pp_parents[i]->p_parent );
690 if( p_item->pp_parents[i]->i_view == VIEW_ALL )
692 p_playlist->i_size--;
696 /* TODO : Update views */
698 if( b_flag == VLC_FALSE )
699 playlist_ItemDelete( p_item );
701 p_item->i_flags |= PLAYLIST_REMOVE_FLAG;
706 int playlist_LockDelete( playlist_t * p_playlist, int i_id )
709 vlc_mutex_lock( &p_playlist->object_lock );
710 i_ret = playlist_Delete( p_playlist, i_id );
711 vlc_mutex_unlock( &p_playlist->object_lock );
716 * Clear all playlist items
718 * \param p_playlist the playlist to be cleared.
721 int playlist_Clear( playlist_t * p_playlist )
724 for( i = p_playlist->i_size; i > 0 ; i-- )
726 playlist_Delete( p_playlist, p_playlist->pp_items[0]->input.i_id );
728 for( i = 0 ; i< p_playlist->i_views; i++ )
730 playlist_ViewEmpty( p_playlist, i, VLC_TRUE );
735 int playlist_LockClear( playlist_t *p_playlist )
738 vlc_mutex_lock( &p_playlist->object_lock );
739 i_ret = playlist_Clear( p_playlist );
740 vlc_mutex_unlock( &p_playlist->object_lock );
746 * Disables a playlist item
748 * \param p_playlist the playlist to disable from.
749 * \param i_pos the position of the item to disable
752 int playlist_Disable( playlist_t * p_playlist, playlist_item_t *p_item )
754 if( !p_item ) return VLC_EGENERIC;
756 msg_Dbg( p_playlist, "disabling playlist item `%s'",
757 p_item->input.psz_name );
759 if( p_item->i_flags & PLAYLIST_ENA_FLAG )
761 p_playlist->i_enabled--;
763 p_item->i_flags &= ~PLAYLIST_ENA_FLAG;
765 var_SetInteger( p_playlist, "item-change", p_item->input.i_id );
770 * Enables a playlist item
772 * \param p_playlist the playlist to enable from.
773 * \param i_pos the position of the item to enable
776 int playlist_Enable( playlist_t * p_playlist, playlist_item_t *p_item )
778 if( !p_item ) return VLC_EGENERIC;
780 msg_Dbg( p_playlist, "enabling playlist item `%s'",
781 p_item->input.psz_name );
783 if( p_item->i_flags & ~PLAYLIST_ENA_FLAG )
785 p_playlist->i_enabled++;
787 p_item->i_flags |= PLAYLIST_ENA_FLAG;
789 var_SetInteger( p_playlist, "item-change", p_item->input.i_id );
794 * Move an item in a playlist
796 * This function must be entered without the playlist lock
798 * Move the item in the playlist with position i_pos before the current item
799 * at position i_newpos.
800 * \param p_playlist the playlist to move items in
801 * \param i_pos the position of the item to move
802 * \param i_newpos the position of the item that will be behind the moved item
804 * \return returns VLC_SUCCESS
806 int playlist_Move( playlist_t * p_playlist, int i_pos, int i_newpos )
809 vlc_mutex_lock( &p_playlist->object_lock );
811 /* take into account that our own row disappears. */
812 if( i_pos < i_newpos ) i_newpos--;
814 if( i_pos >= 0 && i_newpos >=0 && i_pos <= p_playlist->i_size &&
815 i_newpos <= p_playlist->i_size )
817 playlist_item_t * temp;
819 msg_Dbg( p_playlist, "moving playlist item `%s' (%i -> %i)",
820 p_playlist->pp_items[i_pos]->input.psz_name, i_pos, i_newpos);
822 if( i_pos == p_playlist->i_index )
824 p_playlist->i_index = i_newpos;
826 else if( i_pos > p_playlist->i_index &&
827 i_newpos <= p_playlist->i_index )
829 p_playlist->i_index++;
831 else if( i_pos < p_playlist->i_index &&
832 i_newpos >= p_playlist->i_index )
834 p_playlist->i_index--;
837 if ( i_pos < i_newpos )
839 temp = p_playlist->pp_items[i_pos];
840 while ( i_pos < i_newpos )
842 p_playlist->pp_items[i_pos] = p_playlist->pp_items[i_pos+1];
845 p_playlist->pp_items[i_newpos] = temp;
847 else if ( i_pos > i_newpos )
849 temp = p_playlist->pp_items[i_pos];
850 while ( i_pos > i_newpos )
852 p_playlist->pp_items[i_pos] = p_playlist->pp_items[i_pos-1];
855 p_playlist->pp_items[i_newpos] = temp;
859 vlc_mutex_unlock( &p_playlist->object_lock );
861 val.b_bool = VLC_TRUE;
862 var_Set( p_playlist, "intf-change", val );
870 * \param p_playlist the playlist
871 * \param p_item the item to move
872 * \param p_node the new parent of the item
873 * \param i_newpos the new position under this new parent
874 * \param i_view the view in which the move must be done or ALL_VIEWS
875 * \return VLC_SUCCESS or an error
877 int playlist_TreeMove( playlist_t * p_playlist, playlist_item_t *p_item,
878 playlist_item_t *p_node, int i_newpos, int i_view )
881 playlist_item_t *p_detach = NULL;
883 if( i_view == ALL_VIEWS )
885 for( i = 0 ; i < p_playlist->i_views; i++ )
887 playlist_TreeMove( p_playlist, p_item, p_node, i_newpos,
888 p_playlist->pp_views[i] );
893 /* Find the parent */
894 for( i = 0 ; i< p_item->i_parents; i++ )
896 if( p_item->pp_parents[i]->i_view == i_view )
898 p_detach = p_item->pp_parents[i]->p_parent;
902 if( p_detach == NULL )
904 msg_Err( p_playlist, "item not found in view %i", i_view );
908 /* Detach from the parent */
909 // playlist_NodeDetach( p_detach, p_item );
911 /* Attach to new parent */