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, -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_DeleteFromItemId( p_playlist,
157 p_root->pp_children[i]->i_id );
160 /* Delete the node */
161 if( p_root->i_flags & PLAYLIST_RO_FLAG && !b_force )
167 var_SetInteger( p_playlist, "item-deleted", p_root->i_id );
168 ARRAY_BSEARCH( p_playlist->all_items, ->i_id, int,
171 ARRAY_REMOVE( p_playlist->all_items, i );
173 /* Remove the item from its parent */
174 if( p_root->p_parent )
175 playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
177 playlist_ItemRelease( p_root );
184 * Adds an item to the children of a node
186 * \param p_playlist the playlist
187 * \param p_item the item to append
188 * \param p_parent the parent node
189 * \return VLC_SUCCESS or an error
191 int playlist_NodeAppend( playlist_t *p_playlist,
192 playlist_item_t *p_item,
193 playlist_item_t *p_parent )
195 return playlist_NodeInsert( p_playlist, p_item, p_parent, -1 );
198 int playlist_NodeInsert( playlist_t *p_playlist,
199 playlist_item_t *p_item,
200 playlist_item_t *p_parent,
205 assert( p_parent && p_parent->i_children != -1 );
206 if( i_position == -1 ) i_position = p_parent->i_children ;
208 INSERT_ELEM( p_parent->pp_children,
209 p_parent->i_children,
212 p_item->p_parent = p_parent;
217 * Deletes an item from the children of a node
219 * \param p_playlist the playlist
220 * \param p_item the item to remove
221 * \param p_parent the parent node
222 * \return VLC_SUCCESS or an error
224 int playlist_NodeRemoveItem( playlist_t *p_playlist,
225 playlist_item_t *p_item,
226 playlist_item_t *p_parent )
231 for(int i= 0; i< p_parent->i_children ; i++ )
233 if( p_parent->pp_children[i] == p_item )
235 REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
244 * Count the children of a node
246 * \param p_playlist the playlist
247 * \param p_node the node
248 * \return the number of children
250 int playlist_NodeChildrenCount( playlist_t *p_playlist, playlist_item_t*p_node)
256 if( p_node->i_children == -1 )
259 i_nb = p_node->i_children;
260 for( i=0 ; i< p_node->i_children;i++ )
262 if( p_node->pp_children[i]->i_children == -1 )
265 i_nb += playlist_NodeChildrenCount( p_playlist,
266 p_node->pp_children[i] );
272 * Search a child of a node by its name
274 * \param p_node the node
275 * \param psz_search the name of the child to search
276 * \return the child item or NULL if not found or error
278 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
279 const char *psz_search )
281 playlist_t * p_playlist = p_node->p_playlist; /* For assert_locked */
285 if( p_node->i_children < 0 )
289 for( i = 0 ; i< p_node->i_children; i++ )
291 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
293 return p_node->pp_children[i];
300 * Create a pair of nodes in the category and onelevel trees.
301 * They share the same input item.
302 * \param p_playlist the playlist
303 * \param psz_name the name of the nodes
304 * \param pp_node_cat pointer to return the node in category tree
305 * \param pp_node_one pointer to return the node in onelevel tree
306 * \param b_for_sd For Services Discovery ? (make node read-only and unskipping)
308 void playlist_NodesPairCreate( playlist_t *p_playlist, const char *psz_name,
309 playlist_item_t **pp_node_cat,
310 playlist_item_t **pp_node_one,
314 *pp_node_cat = playlist_NodeCreate( p_playlist, psz_name,
315 p_playlist->p_root_category, 0, NULL );
316 *pp_node_one = playlist_NodeCreate( p_playlist, psz_name,
317 p_playlist->p_root_onelevel, 0,
318 (*pp_node_cat)->p_input );
321 (*pp_node_cat)->i_flags |= PLAYLIST_RO_FLAG;
322 (*pp_node_cat)->i_flags |= PLAYLIST_SKIP_FLAG;
323 (*pp_node_one)->i_flags |= PLAYLIST_RO_FLAG;
324 (*pp_node_one)->i_flags |= PLAYLIST_SKIP_FLAG;
329 * Get the node in the preferred tree from a node in one of category
332 playlist_item_t * playlist_GetPreferredNode( playlist_t *p_playlist,
333 playlist_item_t *p_node )
337 if( p_node->p_parent == p_playlist->p_root_category )
339 if( pl_priv(p_playlist)->b_tree || p_node->p_input->b_prefers_tree )
341 for( i = 0 ; i< p_playlist->p_root_onelevel->i_children; i++ )
343 if( p_playlist->p_root_onelevel->pp_children[i]->p_input->i_id ==
344 p_node->p_input->i_id )
345 return p_playlist->p_root_onelevel->pp_children[i];
348 else if( p_node->p_parent == p_playlist->p_root_onelevel )
350 if( !pl_priv(p_playlist)->b_tree || !p_node->p_input->b_prefers_tree )
352 for( i = 0 ; i< p_playlist->p_root_category->i_children; i++ )
354 if( p_playlist->p_root_category->pp_children[i]->p_input->i_id ==
355 p_node->p_input->i_id )
356 return p_playlist->p_root_category->pp_children[i];
362 /**********************************************************************
363 * Tree walking functions
364 **********************************************************************/
366 playlist_item_t *playlist_GetLastLeaf(playlist_t *p_playlist,
367 playlist_item_t *p_root )
371 playlist_item_t *p_item;
372 for ( i = p_root->i_children - 1; i >= 0; i-- )
374 if( p_root->pp_children[i]->i_children == -1 )
375 return p_root->pp_children[i];
376 else if( p_root->pp_children[i]->i_children > 0)
378 p_item = playlist_GetLastLeaf( p_playlist,
379 p_root->pp_children[i] );
380 if ( p_item != NULL )
390 * Finds the next item to play
392 * \param p_playlist the playlist
393 * \param p_root the root node
394 * \param p_item the previous item (NULL if none )
395 * \return the next item to play, or NULL if none found
397 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
398 playlist_item_t *p_root,
399 playlist_item_t *p_item,
400 bool b_ena, bool b_unplayed )
403 playlist_item_t *p_next;
405 assert( p_root && p_root->i_children != -1 );
407 PL_DEBUG2( "finding next of %s within %s",
408 PLI_NAME( p_item ), PLI_NAME( p_root ) );
410 /* Now, walk the tree until we find a suitable next item */
414 bool b_ena_ok = true, b_unplayed_ok = true;
415 p_next = GetNextItem( p_playlist, p_root, p_next );
416 if( !p_next || p_next == p_root )
418 if( p_next->i_children == -1 )
420 if( b_ena && p_next->i_flags & PLAYLIST_DBL_FLAG )
422 if( b_unplayed && p_next->p_input->i_nb_played != 0 )
423 b_unplayed_ok = false;
424 if( b_ena_ok && b_unplayed_ok ) break;
427 if( p_next == NULL ) PL_DEBUG2( "at end of node" );
432 * Finds the previous item to play
434 * \param p_playlist the playlist
435 * \param p_root the root node
436 * \param p_item the previous item (NULL if none )
437 * \return the next item to play, or NULL if none found
439 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
440 playlist_item_t *p_root,
441 playlist_item_t *p_item,
442 bool b_ena, bool b_unplayed )
445 playlist_item_t *p_prev;
447 PL_DEBUG2( "finding previous os %s within %s", PLI_NAME( p_item ),
448 PLI_NAME( p_root ) );
449 assert( p_root && p_root->i_children != -1 );
451 /* Now, walk the tree until we find a suitable previous item */
455 bool b_ena_ok = true, b_unplayed_ok = true;
456 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
457 if( !p_prev || p_prev == p_root )
459 if( p_prev->i_children == -1 )
461 if( b_ena && p_prev->i_flags & PLAYLIST_DBL_FLAG )
463 if( b_unplayed && p_prev->p_input->i_nb_played != 0 )
464 b_unplayed_ok = false;
465 if( b_ena_ok && b_unplayed_ok ) break;
468 if( p_prev == NULL ) PL_DEBUG2( "at beginning of node" );
472 /************************************************************************
473 * Following functions are local
474 ***********************************************************************/
477 * Get the next item in the tree
478 * If p_item is NULL, return the first child of root
480 playlist_item_t *GetNextItem( playlist_t *p_playlist,
481 playlist_item_t *p_root,
482 playlist_item_t *p_item )
484 playlist_item_t *p_parent;
487 /* Node with children, get the first one */
488 if( p_item && p_item->i_children > 0 )
489 return p_item->pp_children[0];
492 p_parent = p_item->p_parent;
495 for( i= 0 ; i < p_parent->i_children ; i++ )
497 if( p_item == NULL || p_parent->pp_children[i] == p_item )
502 if( i+1 >= p_parent->i_children )
504 /* Was already the last sibling. Look for uncles */
505 PL_DEBUG2( "Current item is the last of the node,"
506 "looking for uncle from %s",
507 p_parent->p_input->psz_name );
509 if( p_parent == p_root )
511 PL_DEBUG2( "already at root" );
514 return GetNextUncle( p_playlist, p_item, p_root );
518 return p_parent->pp_children[i+1];
525 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
526 playlist_item_t *p_root )
528 playlist_item_t *p_parent = p_item->p_parent;
529 playlist_item_t *p_grandparent;
530 bool b_found = false;
534 if( p_parent != NULL )
536 p_grandparent = p_parent->p_parent;
537 while( p_grandparent )
540 for( i = 0 ; i< p_grandparent->i_children ; i++ )
542 if( p_parent == p_grandparent->pp_children[i] )
544 PL_DEBUG2( "parent %s found as child %i of grandparent %s",
545 p_parent->p_input->psz_name, i,
546 p_grandparent->p_input->psz_name );
551 if( b_found && i + 1 < p_grandparent->i_children )
553 return p_grandparent->pp_children[i+1];
555 /* Not found at root */
556 if( p_grandparent == p_root )
562 p_parent = p_grandparent;
563 p_grandparent = p_parent->p_parent;
567 /* We reached root */
571 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
572 playlist_item_t *p_root )
574 playlist_item_t *p_parent = p_item->p_parent;
575 playlist_item_t *p_grandparent;
576 bool b_found = false;
580 if( p_parent != NULL )
582 p_grandparent = p_parent->p_parent;
586 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
588 if( p_parent == p_grandparent->pp_children[i] )
594 if( b_found && i - 1 > 0 )
596 return p_grandparent->pp_children[i-1];
598 /* Not found at root */
599 if( p_grandparent == p_root )
605 p_parent = p_grandparent;
606 p_grandparent = p_parent->p_parent;
610 /* We reached root */
615 /* Recursively search the tree for previous item */
616 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
617 playlist_item_t *p_root,
618 playlist_item_t *p_item )
620 playlist_item_t *p_parent;
623 /* Node with children, get the last one */
624 if( p_item && p_item->i_children > 0 )
625 return p_item->pp_children[p_item->i_children - 1];
627 /* Last child of its parent ? */
629 p_parent = p_item->p_parent;
632 msg_Err( p_playlist, "Get the last one" );
636 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
638 if( p_parent->pp_children[i] == p_item )
642 /* Was already the first sibling. Look for uncles */
643 PL_DEBUG2( "current item is the first of its node,"
644 "looking for uncle from %s",
645 p_parent->p_input->psz_name );
646 if( p_parent == p_root )
648 PL_DEBUG2( "already at root" );
651 return GetPrevUncle( p_playlist, p_item, p_root );
655 return p_parent->pp_children[i-1];