1 /*****************************************************************************
2 * tree.c : Playlist tree walking functions
3 *****************************************************************************
4 * Copyright (C) 1999-2007 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
27 #include <vlc_common.h>
29 #include "vlc_playlist.h"
30 #include "playlist_internal.h"
32 /************************************************************************
34 ************************************************************************/
35 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
36 playlist_item_t *p_root );
37 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
38 playlist_item_t *p_root );
40 playlist_item_t *GetNextItem( playlist_t *p_playlist,
41 playlist_item_t *p_root,
42 playlist_item_t *p_item );
43 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
44 playlist_item_t *p_item,
45 playlist_item_t *p_root );
48 * Create a playlist node
50 * \param p_playlist the playlist
51 * \param psz_name the name of the node
52 * \param p_parent the parent node to attach to or NULL if no attach
53 * \param i_pos position of the node in the parent, PLAYLIST_END to append to end.
54 * \param p_flags miscellaneous flags
55 * \param p_input the input_item to attach to or NULL if it has to be created
56 * \return the new node
58 playlist_item_t * playlist_NodeCreate( playlist_t *p_playlist,
60 playlist_item_t *p_parent, int i_pos,
61 int i_flags, input_item_t *p_input )
63 input_item_t *p_new_input = NULL;
64 playlist_item_t *p_item;
67 if( !psz_name ) psz_name = _("Undefined");
70 p_new_input = input_item_NewWithType( VLC_OBJECT(p_playlist), NULL,
71 psz_name, 0, NULL, 0, -1, ITEM_TYPE_NODE );
72 p_item = playlist_ItemNewFromInput( p_playlist,
73 p_input ? p_input : p_new_input );
75 vlc_gc_decref( p_new_input );
77 if( p_item == NULL ) return NULL;
78 p_item->i_children = 0;
80 ARRAY_APPEND(p_playlist->all_items, p_item);
82 if( p_parent != NULL )
83 playlist_NodeInsert( p_playlist, p_item, p_parent,
84 i_pos == PLAYLIST_END ? -1 : i_pos );
85 playlist_SendAddNotify( p_playlist, p_item->i_id,
86 p_parent ? p_parent->i_id : -1,
87 !( i_flags & PLAYLIST_NO_REBUILD ));
89 p_item->i_flags |= i_flags;
95 * Remove all the children of a node
97 * This function must be entered with the playlist lock
99 * \param p_playlist the playlist
100 * \param p_root the node
101 * \param b_delete_items do we have to delete the children items ?
102 * \return VLC_SUCCESS or an error
104 int playlist_NodeEmpty( playlist_t *p_playlist, playlist_item_t *p_root,
105 bool b_delete_items )
109 if( p_root->i_children == -1 )
114 /* Delete the children */
115 for( i = p_root->i_children-1 ; i >= 0 ;i-- )
117 if( p_root->pp_children[i]->i_children > -1 )
119 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
120 b_delete_items , false );
122 else if( b_delete_items )
124 /* Delete the item here */
125 playlist_DeleteFromItemId( p_playlist,
126 p_root->pp_children[i]->i_id );
133 * Remove all the children of a node and removes the node
135 * \param p_playlist the playlist
136 * \param p_root the node
137 * \param b_delete_items do we have to delete the children items ?
138 * \return VLC_SUCCESS or an error
140 int playlist_NodeDelete( playlist_t *p_playlist, playlist_item_t *p_root,
141 bool b_delete_items, bool b_force )
146 /* Delete the children */
147 for( i = p_root->i_children - 1 ; i >= 0; i-- )
149 if( b_delete_items || p_root->pp_children[i]->i_children > -1 )
151 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
152 b_delete_items, b_force );
155 /* Delete the node */
156 if( p_root->i_flags & PLAYLIST_RO_FLAG && !b_force )
161 pl_priv(p_playlist)->b_reset_currently_playing = true;
164 var_SetInteger( p_playlist, "playlist-item-deleted", p_root->i_id );
165 ARRAY_BSEARCH( p_playlist->all_items, ->i_id, int,
168 ARRAY_REMOVE( p_playlist->all_items, i );
170 if( p_root->i_children == -1 ) {
171 ARRAY_BSEARCH( p_playlist->items,->i_id, int, p_root->i_id, i );
173 ARRAY_REMOVE( p_playlist->items, i );
176 /* Check if it is the current item */
177 if( get_current_status_item( p_playlist ) == p_root )
180 playlist_Control( p_playlist, PLAYLIST_STOP, pl_Locked );
181 msg_Info( p_playlist, "stopping playback" );
182 /* This item can't be the next one to be played ! */
183 set_current_status_item( p_playlist, NULL );
186 ARRAY_BSEARCH( p_playlist->current,->i_id, int, p_root->i_id, i );
188 ARRAY_REMOVE( p_playlist->current, i );
190 PL_DEBUG( "deleting item `%s'", p_root->p_input->psz_name );
192 /* Remove the item from its parent */
193 if( p_root->p_parent )
194 playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
196 playlist_ItemRelease( p_root );
203 * Adds an item to the children of a node
205 * \param p_playlist the playlist
206 * \param p_item the item to append
207 * \param p_parent the parent node
208 * \return VLC_SUCCESS or an error
210 int playlist_NodeAppend( playlist_t *p_playlist,
211 playlist_item_t *p_item,
212 playlist_item_t *p_parent )
214 return playlist_NodeInsert( p_playlist, p_item, p_parent, -1 );
217 int playlist_NodeInsert( playlist_t *p_playlist,
218 playlist_item_t *p_item,
219 playlist_item_t *p_parent,
224 assert( p_parent && p_parent->i_children != -1 );
225 if( i_position == -1 ) i_position = p_parent->i_children ;
226 assert( i_position <= p_parent->i_children);
228 INSERT_ELEM( p_parent->pp_children,
229 p_parent->i_children,
232 p_item->p_parent = p_parent;
237 * Deletes an item from the children of a node
239 * \param p_playlist the playlist
240 * \param p_item the item to remove
241 * \param p_parent the parent node
242 * \return VLC_SUCCESS or an error
244 int playlist_NodeRemoveItem( playlist_t *p_playlist,
245 playlist_item_t *p_item,
246 playlist_item_t *p_parent )
251 int ret = VLC_EGENERIC;
253 for(int i= 0; i< p_parent->i_children ; i++ )
255 if( p_parent->pp_children[i] == p_item )
257 REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
262 if( ret == VLC_SUCCESS ) {
263 assert( p_item->p_parent == p_parent );
264 p_item->p_parent = NULL;
271 * Search a child of a node by its name
273 * \param p_node the node
274 * \param psz_search the name of the child to search
275 * \return the child item or NULL if not found or error
277 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
278 const char *psz_search )
280 playlist_t * p_playlist = p_node->p_playlist; /* For assert_locked */
284 if( p_node->i_children < 0 )
288 for( i = 0 ; i< p_node->i_children; i++ )
290 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
292 return p_node->pp_children[i];
298 /**********************************************************************
299 * Tree walking functions
300 **********************************************************************/
302 * Finds the next item to play
304 * \param p_playlist the playlist
305 * \param p_root the root node
306 * \param p_item the previous item (NULL if none )
307 * \return the next item to play, or NULL if none found
309 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
310 playlist_item_t *p_root,
311 playlist_item_t *p_item,
312 bool b_ena, bool b_unplayed )
315 playlist_item_t *p_next;
317 assert( p_root && p_root->i_children != -1 );
319 PL_DEBUG2( "finding next of %s within %s",
320 PLI_NAME( p_item ), PLI_NAME( p_root ) );
322 /* Now, walk the tree until we find a suitable next item */
326 bool b_ena_ok = true, b_unplayed_ok = true;
327 p_next = GetNextItem( p_playlist, p_root, p_next );
328 if( !p_next || p_next == p_root )
330 if( p_next->i_children == -1 )
332 if( b_ena && p_next->i_flags & PLAYLIST_DBL_FLAG )
334 if( b_unplayed && p_next->p_input->i_nb_played != 0 )
335 b_unplayed_ok = false;
336 if( b_ena_ok && b_unplayed_ok ) break;
339 if( p_next == NULL ) PL_DEBUG2( "at end of node" );
344 * Finds the previous item to play
346 * \param p_playlist the playlist
347 * \param p_root the root node
348 * \param p_item the previous item (NULL if none )
349 * \return the next item to play, or NULL if none found
351 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
352 playlist_item_t *p_root,
353 playlist_item_t *p_item,
354 bool b_ena, bool b_unplayed )
357 playlist_item_t *p_prev;
359 PL_DEBUG2( "finding previous of %s within %s", PLI_NAME( p_item ),
360 PLI_NAME( p_root ) );
361 assert( p_root && p_root->i_children != -1 );
363 /* Now, walk the tree until we find a suitable previous item */
367 bool b_ena_ok = true, b_unplayed_ok = true;
368 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
369 if( !p_prev || p_prev == p_root )
371 if( p_prev->i_children == -1 )
373 if( b_ena && p_prev->i_flags & PLAYLIST_DBL_FLAG )
375 if( b_unplayed && p_prev->p_input->i_nb_played != 0 )
376 b_unplayed_ok = false;
377 if( b_ena_ok && b_unplayed_ok ) break;
380 if( p_prev == NULL ) PL_DEBUG2( "at beginning of node" );
384 /************************************************************************
385 * Following functions are local
386 ***********************************************************************/
389 * Get the next item in the tree
390 * If p_item is NULL, return the first child of root
392 playlist_item_t *GetNextItem( playlist_t *p_playlist,
393 playlist_item_t *p_root,
394 playlist_item_t *p_item )
396 /* If the item is NULL, return the firt child of root */
399 if( p_root->i_children > 0 )
400 return p_root->pp_children[0];
405 /* Node with children, get the first one */
406 if( p_item->i_children > 0 )
407 return p_item->pp_children[0];
409 playlist_item_t* p_parent = p_item->p_parent;
410 for( int i = 0 ; i < p_parent->i_children ; i++ )
412 if( p_parent->pp_children[i] == p_item )
414 // Return the next children
415 if( i + 1 < p_parent->i_children )
416 return p_parent->pp_children[i+1];
417 // We are the least one, so try to have uncles
420 PL_DEBUG2( "Current item is the last of the node,"
421 "looking for uncle from %s",
422 p_parent->p_input->psz_name );
423 if( p_parent == p_root )
425 PL_DEBUG2( "already at root" );
429 return GetNextUncle( p_playlist, p_item, p_root );
436 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
437 playlist_item_t *p_root )
439 playlist_item_t *p_parent = p_item->p_parent;
440 playlist_item_t *p_grandparent;
441 bool b_found = false;
445 if( p_parent != NULL )
447 p_grandparent = p_parent->p_parent;
448 while( p_grandparent )
451 for( i = 0 ; i< p_grandparent->i_children ; i++ )
453 if( p_parent == p_grandparent->pp_children[i] )
455 PL_DEBUG2( "parent %s found as child %i of grandparent %s",
456 p_parent->p_input->psz_name, i,
457 p_grandparent->p_input->psz_name );
462 if( b_found && i + 1 < p_grandparent->i_children )
464 return p_grandparent->pp_children[i+1];
466 /* Not found at root */
467 if( p_grandparent == p_root )
473 p_parent = p_grandparent;
474 p_grandparent = p_parent->p_parent;
478 /* We reached root */
482 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
483 playlist_item_t *p_root )
485 playlist_item_t *p_parent = p_item->p_parent;
486 playlist_item_t *p_grandparent;
487 bool b_found = false;
491 if( p_parent != NULL )
493 p_grandparent = p_parent->p_parent;
497 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
499 if( p_parent == p_grandparent->pp_children[i] )
505 if( b_found && i - 1 > 0 )
507 return p_grandparent->pp_children[i-1];
509 /* Not found at root */
510 if( p_grandparent == p_root )
516 p_parent = p_grandparent;
517 p_grandparent = p_parent->p_parent;
521 /* We reached root */
526 /* Recursively search the tree for previous item */
527 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
528 playlist_item_t *p_root,
529 playlist_item_t *p_item )
531 playlist_item_t *p_parent;
534 /* Node with children, get the last one */
535 if( p_item && p_item->i_children > 0 )
536 return p_item->pp_children[p_item->i_children - 1];
538 /* Last child of its parent ? */
540 p_parent = p_item->p_parent;
543 msg_Err( p_playlist, "Get the last one" );
547 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
549 if( p_parent->pp_children[i] == p_item )
553 /* Was already the first sibling. Look for uncles */
554 PL_DEBUG2( "current item is the first of its node,"
555 "looking for uncle from %s",
556 p_parent->p_input->psz_name );
557 if( p_parent == p_root )
559 PL_DEBUG2( "already at root" );
562 return GetPrevUncle( p_playlist, p_item, p_root );
566 return p_parent->pp_children[i-1];