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 p_flags miscellaneous flags
54 * \param p_input the input_item to attach to or NULL if it has to be created
55 * \return the new node
57 playlist_item_t * playlist_NodeCreate( playlist_t *p_playlist,
59 playlist_item_t *p_parent, int i_flags,
60 input_item_t *p_input )
62 input_item_t *p_new_input = NULL;
63 playlist_item_t *p_item;
66 if( !psz_name ) psz_name = _("Undefined");
69 p_new_input = input_item_NewWithType( VLC_OBJECT(p_playlist), NULL,
70 psz_name, 0, NULL, 0, -1, ITEM_TYPE_NODE );
71 p_item = playlist_ItemNewFromInput( p_playlist,
72 p_input ? p_input : p_new_input );
74 vlc_gc_decref( p_new_input );
76 if( p_item == NULL ) return NULL;
77 p_item->i_children = 0;
79 ARRAY_APPEND(p_playlist->all_items, p_item);
81 if( p_parent != NULL )
82 playlist_NodeAppend( p_playlist, p_item, p_parent );
83 playlist_SendAddNotify( p_playlist, p_item->i_id,
84 p_parent ? p_parent->i_id : -1,
85 !( i_flags & PLAYLIST_NO_REBUILD ));
90 * Remove all the children of a node
92 * This function must be entered with the playlist lock
94 * \param p_playlist the playlist
95 * \param p_root the node
96 * \param b_delete_items do we have to delete the children items ?
97 * \return VLC_SUCCESS or an error
99 int playlist_NodeEmpty( playlist_t *p_playlist, playlist_item_t *p_root,
100 bool b_delete_items )
104 if( p_root->i_children == -1 )
109 /* Delete the children */
110 for( i = p_root->i_children-1 ; i >= 0 ;i-- )
112 if( p_root->pp_children[i]->i_children > -1 )
114 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
115 b_delete_items , false );
117 else if( b_delete_items )
119 /* Delete the item here */
120 playlist_DeleteFromItemId( p_playlist,
121 p_root->pp_children[i]->i_id );
128 * Remove all the children of a node and removes the node
130 * \param p_playlist the playlist
131 * \param p_root the node
132 * \param b_delete_items do we have to delete the children items ?
133 * \return VLC_SUCCESS or an error
135 int playlist_NodeDelete( playlist_t *p_playlist, playlist_item_t *p_root,
136 bool b_delete_items, bool b_force )
141 if( p_root->i_children == -1 )
146 /* Delete the children */
147 for( i = p_root->i_children - 1 ; i >= 0; i-- )
149 if( p_root->pp_children[i]->i_children > -1 )
151 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
152 b_delete_items , b_force );
154 else if( b_delete_items )
156 playlist_DeleteItem( p_playlist, p_root->pp_children[i], true );
159 /* Delete the node */
160 if( p_root->i_flags & PLAYLIST_RO_FLAG && !b_force )
166 var_SetInteger( p_playlist, "playlist-item-deleted", p_root->i_id );
167 ARRAY_BSEARCH( p_playlist->all_items, ->i_id, int,
170 ARRAY_REMOVE( p_playlist->all_items, i );
172 /* Remove the item from its parent */
173 if( p_root->p_parent )
174 playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
176 playlist_ItemRelease( p_root );
183 * Adds an item to the children of a node
185 * \param p_playlist the playlist
186 * \param p_item the item to append
187 * \param p_parent the parent node
188 * \return VLC_SUCCESS or an error
190 int playlist_NodeAppend( playlist_t *p_playlist,
191 playlist_item_t *p_item,
192 playlist_item_t *p_parent )
194 return playlist_NodeInsert( p_playlist, p_item, p_parent, -1 );
197 int playlist_NodeInsert( playlist_t *p_playlist,
198 playlist_item_t *p_item,
199 playlist_item_t *p_parent,
204 assert( p_parent && p_parent->i_children != -1 );
205 if( i_position == -1 ) i_position = p_parent->i_children ;
207 INSERT_ELEM( p_parent->pp_children,
208 p_parent->i_children,
211 p_item->p_parent = p_parent;
216 * Deletes an item from the children of a node
218 * \param p_playlist the playlist
219 * \param p_item the item to remove
220 * \param p_parent the parent node
221 * \return VLC_SUCCESS or an error
223 int playlist_NodeRemoveItem( playlist_t *p_playlist,
224 playlist_item_t *p_item,
225 playlist_item_t *p_parent )
230 for(int i= 0; i< p_parent->i_children ; i++ )
232 if( p_parent->pp_children[i] == p_item )
234 REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
242 * Search a child of a node by its name
244 * \param p_node the node
245 * \param psz_search the name of the child to search
246 * \return the child item or NULL if not found or error
248 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
249 const char *psz_search )
251 playlist_t * p_playlist = p_node->p_playlist; /* For assert_locked */
255 if( p_node->i_children < 0 )
259 for( i = 0 ; i< p_node->i_children; i++ )
261 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
263 return p_node->pp_children[i];
269 /**********************************************************************
270 * Tree walking functions
271 **********************************************************************/
273 * Finds the next item to play
275 * \param p_playlist the playlist
276 * \param p_root the root node
277 * \param p_item the previous item (NULL if none )
278 * \return the next item to play, or NULL if none found
280 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
281 playlist_item_t *p_root,
282 playlist_item_t *p_item,
283 bool b_ena, bool b_unplayed )
286 playlist_item_t *p_next;
288 assert( p_root && p_root->i_children != -1 );
290 PL_DEBUG2( "finding next of %s within %s",
291 PLI_NAME( p_item ), PLI_NAME( p_root ) );
293 /* Now, walk the tree until we find a suitable next item */
297 bool b_ena_ok = true, b_unplayed_ok = true;
298 p_next = GetNextItem( p_playlist, p_root, p_next );
299 if( !p_next || p_next == p_root )
301 if( p_next->i_children == -1 )
303 if( b_ena && p_next->i_flags & PLAYLIST_DBL_FLAG )
305 if( b_unplayed && p_next->p_input->i_nb_played != 0 )
306 b_unplayed_ok = false;
307 if( b_ena_ok && b_unplayed_ok ) break;
310 if( p_next == NULL ) PL_DEBUG2( "at end of node" );
315 * Finds the previous item to play
317 * \param p_playlist the playlist
318 * \param p_root the root node
319 * \param p_item the previous item (NULL if none )
320 * \return the next item to play, or NULL if none found
322 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
323 playlist_item_t *p_root,
324 playlist_item_t *p_item,
325 bool b_ena, bool b_unplayed )
328 playlist_item_t *p_prev;
330 PL_DEBUG2( "finding previous of %s within %s", PLI_NAME( p_item ),
331 PLI_NAME( p_root ) );
332 assert( p_root && p_root->i_children != -1 );
334 /* Now, walk the tree until we find a suitable previous item */
338 bool b_ena_ok = true, b_unplayed_ok = true;
339 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
340 if( !p_prev || p_prev == p_root )
342 if( p_prev->i_children == -1 )
344 if( b_ena && p_prev->i_flags & PLAYLIST_DBL_FLAG )
346 if( b_unplayed && p_prev->p_input->i_nb_played != 0 )
347 b_unplayed_ok = false;
348 if( b_ena_ok && b_unplayed_ok ) break;
351 if( p_prev == NULL ) PL_DEBUG2( "at beginning of node" );
355 /************************************************************************
356 * Following functions are local
357 ***********************************************************************/
360 * Get the next item in the tree
361 * If p_item is NULL, return the first child of root
363 playlist_item_t *GetNextItem( playlist_t *p_playlist,
364 playlist_item_t *p_root,
365 playlist_item_t *p_item )
367 /* If the item is NULL, return the firt child of root */
370 if( p_root->i_children > 0 )
371 return p_root->pp_children[0];
376 /* Node with children, get the first one */
377 if( p_item->i_children > 0 )
378 return p_item->pp_children[0];
380 playlist_item_t* p_parent = p_item->p_parent;
381 for( int i = 0 ; i < p_parent->i_children ; i++ )
383 if( p_parent->pp_children[i] == p_item )
385 // Return the next children
386 if( i + 1 < p_parent->i_children )
387 return p_parent->pp_children[i+1];
388 // We are the least one, so try to have uncles
391 PL_DEBUG2( "Current item is the last of the node,"
392 "looking for uncle from %s",
393 p_parent->p_input->psz_name );
394 if( p_parent == p_root )
396 PL_DEBUG2( "already at root" );
400 return GetNextUncle( p_playlist, p_item, p_root );
407 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
408 playlist_item_t *p_root )
410 playlist_item_t *p_parent = p_item->p_parent;
411 playlist_item_t *p_grandparent;
412 bool b_found = false;
416 if( p_parent != NULL )
418 p_grandparent = p_parent->p_parent;
419 while( p_grandparent )
422 for( i = 0 ; i< p_grandparent->i_children ; i++ )
424 if( p_parent == p_grandparent->pp_children[i] )
426 PL_DEBUG2( "parent %s found as child %i of grandparent %s",
427 p_parent->p_input->psz_name, i,
428 p_grandparent->p_input->psz_name );
433 if( b_found && i + 1 < p_grandparent->i_children )
435 return p_grandparent->pp_children[i+1];
437 /* Not found at root */
438 if( p_grandparent == p_root )
444 p_parent = p_grandparent;
445 p_grandparent = p_parent->p_parent;
449 /* We reached root */
453 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
454 playlist_item_t *p_root )
456 playlist_item_t *p_parent = p_item->p_parent;
457 playlist_item_t *p_grandparent;
458 bool b_found = false;
462 if( p_parent != NULL )
464 p_grandparent = p_parent->p_parent;
468 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
470 if( p_parent == p_grandparent->pp_children[i] )
476 if( b_found && i - 1 > 0 )
478 return p_grandparent->pp_children[i-1];
480 /* Not found at root */
481 if( p_grandparent == p_root )
487 p_parent = p_grandparent;
488 p_grandparent = p_parent->p_parent;
492 /* We reached root */
497 /* Recursively search the tree for previous item */
498 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
499 playlist_item_t *p_root,
500 playlist_item_t *p_item )
502 playlist_item_t *p_parent;
505 /* Node with children, get the last one */
506 if( p_item && p_item->i_children > 0 )
507 return p_item->pp_children[p_item->i_children - 1];
509 /* Last child of its parent ? */
511 p_parent = p_item->p_parent;
514 msg_Err( p_playlist, "Get the last one" );
518 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
520 if( p_parent->pp_children[i] == p_item )
524 /* Was already the first sibling. Look for uncles */
525 PL_DEBUG2( "current item is the first of its node,"
526 "looking for uncle from %s",
527 p_parent->p_input->psz_name );
528 if( p_parent == p_root )
530 PL_DEBUG2( "already at root" );
533 return GetPrevUncle( p_playlist, p_item, p_root );
537 return p_parent->pp_children[i-1];