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;
65 if( !psz_name ) psz_name = _("Undefined");
68 p_new_input = input_ItemNewWithType( VLC_OBJECT(p_playlist), NULL,
69 psz_name, 0, NULL, -1, ITEM_TYPE_NODE );
70 p_item = playlist_ItemNewFromInput( VLC_OBJECT(p_playlist),
71 p_input ? p_input : p_new_input );
73 vlc_gc_decref( p_new_input );
75 if( p_item == NULL ) return NULL;
76 p_item->i_children = 0;
78 ARRAY_APPEND(p_playlist->all_items, p_item);
80 if( p_parent != NULL )
81 playlist_NodeAppend( p_playlist, p_item, p_parent );
82 playlist_SendAddNotify( p_playlist, p_item->i_id,
83 p_parent ? p_parent->i_id : -1,
84 !( i_flags & PLAYLIST_NO_REBUILD ));
89 * Remove all the children of a node
91 * This function must be entered with the playlist lock
93 * \param p_playlist the playlist
94 * \param p_root the node
95 * \param b_delete_items do we have to delete the children items ?
96 * \return VLC_SUCCESS or an error
98 int playlist_NodeEmpty( playlist_t *p_playlist, playlist_item_t *p_root,
102 if( p_root->i_children == -1 )
107 /* Delete the children */
108 for( i = p_root->i_children-1 ; i >= 0 ;i-- )
110 if( p_root->pp_children[i]->i_children > -1 )
112 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
113 b_delete_items , false );
115 else if( b_delete_items )
117 /* Delete the item here */
118 playlist_DeleteFromItemId( p_playlist,
119 p_root->pp_children[i]->i_id );
126 * Remove all the children of a node and removes the node
128 * \param p_playlist the playlist
129 * \param p_root the node
130 * \param b_delete_items do we have to delete the children items ?
131 * \return VLC_SUCCESS or an error
133 int playlist_NodeDelete( playlist_t *p_playlist, playlist_item_t *p_root,
134 bool b_delete_items, bool b_force )
138 if( p_root->i_children == -1 )
143 /* Delete the children */
144 for( i = p_root->i_children - 1 ; i >= 0; i-- )
146 if( p_root->pp_children[i]->i_children > -1 )
148 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
149 b_delete_items , b_force );
151 else if( b_delete_items )
153 playlist_DeleteFromItemId( p_playlist,
154 p_root->pp_children[i]->i_id );
157 /* Delete the node */
158 if( p_root->i_flags & PLAYLIST_RO_FLAG && !b_force )
164 var_SetInteger( p_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 /* Remove the item from its parent */
171 if( p_root->p_parent )
172 playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
174 /* Check if it is the current node */
175 if( p_playlist->status.p_node == p_root )
177 /* Hack we don't call playlist_Control for lock reasons */
178 p_playlist->request.i_status = PLAYLIST_STOPPED;
179 p_playlist->request.b_request = true;
180 p_playlist->request.p_item = NULL;
181 p_playlist->request.p_node = NULL;
182 msg_Info( p_playlist, "stopping playback" );
183 vlc_object_signal_maybe( VLC_OBJECT(p_playlist) );
185 PL_DEBUG( "marking %s for further deletion", PLI_NAME( p_root ) );
186 p_root->i_flags |= PLAYLIST_REMOVE_FLAG;
189 playlist_ItemDelete( p_root );
198 * Adds an item to the children of a node
200 * \param p_playlist the playlist
201 * \param p_item the item to append
202 * \param p_parent the parent node
203 * \return VLC_SUCCESS or an error
205 int playlist_NodeAppend( playlist_t *p_playlist,
206 playlist_item_t *p_item,
207 playlist_item_t *p_parent )
209 return playlist_NodeInsert( p_playlist, p_item, p_parent, -1 );
212 int playlist_NodeInsert( playlist_t *p_playlist,
213 playlist_item_t *p_item,
214 playlist_item_t *p_parent,
218 assert( p_parent && p_parent->i_children != -1 );
219 if( i_position == -1 ) i_position = p_parent->i_children ;
221 INSERT_ELEM( p_parent->pp_children,
222 p_parent->i_children,
225 p_item->p_parent = p_parent;
230 * Deletes an item from the children of a node
232 * \param p_playlist the playlist
233 * \param p_item the item to remove
234 * \param p_parent the parent node
235 * \return VLC_SUCCESS or an error
237 int playlist_NodeRemoveItem( playlist_t *p_playlist,
238 playlist_item_t *p_item,
239 playlist_item_t *p_parent )
243 for(int i= 0; i< p_parent->i_children ; i++ )
245 if( p_parent->pp_children[i] == p_item )
247 REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
256 * Count the children of a node
258 * \param p_playlist the playlist
259 * \param p_node the node
260 * \return the number of children
262 int playlist_NodeChildrenCount( playlist_t *p_playlist, playlist_item_t*p_node)
267 if( p_node->i_children == -1 )
270 i_nb = p_node->i_children;
271 for( i=0 ; i< p_node->i_children;i++ )
273 if( p_node->pp_children[i]->i_children == -1 )
276 i_nb += playlist_NodeChildrenCount( p_playlist,
277 p_node->pp_children[i] );
283 * Search a child of a node by its name
285 * \param p_node the node
286 * \param psz_search the name of the child to search
287 * \return the child item or NULL if not found or error
289 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
290 const char *psz_search )
294 if( p_node->i_children < 0 )
298 for( i = 0 ; i< p_node->i_children; i++ )
300 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
302 return p_node->pp_children[i];
309 * Create a pair of nodes in the category and onelevel trees.
310 * They share the same input item.
311 * \param p_playlist the playlist
312 * \param psz_name the name of the nodes
313 * \param pp_node_cat pointer to return the node in category tree
314 * \param pp_node_one pointer to return the node in onelevel tree
315 * \param b_for_sd For Services Discovery ? (make node read-only and unskipping)
317 void playlist_NodesPairCreate( playlist_t *p_playlist, const char *psz_name,
318 playlist_item_t **pp_node_cat,
319 playlist_item_t **pp_node_one,
322 *pp_node_cat = playlist_NodeCreate( p_playlist, psz_name,
323 p_playlist->p_root_category, 0, NULL );
324 *pp_node_one = playlist_NodeCreate( p_playlist, psz_name,
325 p_playlist->p_root_onelevel, 0,
326 (*pp_node_cat)->p_input );
329 (*pp_node_cat)->i_flags |= PLAYLIST_RO_FLAG;
330 (*pp_node_cat)->i_flags |= PLAYLIST_SKIP_FLAG;
331 (*pp_node_one)->i_flags |= PLAYLIST_RO_FLAG;
332 (*pp_node_one)->i_flags |= PLAYLIST_SKIP_FLAG;
337 * Get the node in the preferred tree from a node in one of category
340 playlist_item_t * playlist_GetPreferredNode( playlist_t *p_playlist,
341 playlist_item_t *p_node )
344 if( p_node->p_parent == p_playlist->p_root_category )
346 if( p_playlist->b_tree )
348 for( i = 0 ; i< p_playlist->p_root_onelevel->i_children; i++ )
350 if( p_playlist->p_root_onelevel->pp_children[i]->p_input->i_id ==
351 p_node->p_input->i_id )
352 return p_playlist->p_root_onelevel->pp_children[i];
355 else if( p_node->p_parent == p_playlist->p_root_onelevel )
357 if( !p_playlist->b_tree )
359 for( i = 0 ; i< p_playlist->p_root_category->i_children; i++ )
361 if( p_playlist->p_root_category->pp_children[i]->p_input->i_id ==
362 p_node->p_input->i_id )
363 return p_playlist->p_root_category->pp_children[i];
369 /**********************************************************************
370 * Tree walking functions
371 **********************************************************************/
373 playlist_item_t *playlist_GetLastLeaf(playlist_t *p_playlist,
374 playlist_item_t *p_root )
377 playlist_item_t *p_item;
378 for ( i = p_root->i_children - 1; i >= 0; i-- )
380 if( p_root->pp_children[i]->i_children == -1 )
381 return p_root->pp_children[i];
382 else if( p_root->pp_children[i]->i_children > 0)
384 p_item = playlist_GetLastLeaf( p_playlist,
385 p_root->pp_children[i] );
386 if ( p_item != NULL )
395 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
396 playlist_item_t *p_node,
397 playlist_item_t ***ppp_items )
400 playlist_item_t *p_next = NULL;
403 p_next = playlist_GetNextLeaf( p_playlist, p_node,
404 p_next, true, false );
406 INSERT_ELEM( *ppp_items, i_count, i_count, p_next );
414 * Finds the next item to play
416 * \param p_playlist the playlist
417 * \param p_root the root node
418 * \param p_item the previous item (NULL if none )
419 * \return the next item to play, or NULL if none found
421 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
422 playlist_item_t *p_root,
423 playlist_item_t *p_item,
424 bool b_ena, bool b_unplayed )
426 playlist_item_t *p_next;
428 assert( p_root && p_root->i_children != -1 );
430 PL_DEBUG2( "finding next of %s within %s",
431 PLI_NAME( p_item ), PLI_NAME( p_root ) );
433 /* Now, walk the tree until we find a suitable next item */
437 bool b_ena_ok = true, b_unplayed_ok = true;
438 p_next = GetNextItem( p_playlist, p_root, p_next );
439 if( !p_next || p_next == p_root )
441 if( p_next->i_children == -1 )
443 if( b_ena && p_next->i_flags & PLAYLIST_DBL_FLAG )
445 if( b_unplayed && p_next->p_input->i_nb_played != 0 )
446 b_unplayed_ok = false;
447 if( b_ena_ok && b_unplayed_ok ) break;
450 if( p_next == NULL ) PL_DEBUG2( "at end of node" );
455 * Finds the previous item to play
457 * \param p_playlist the playlist
458 * \param p_root the root node
459 * \param p_item the previous item (NULL if none )
460 * \return the next item to play, or NULL if none found
462 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
463 playlist_item_t *p_root,
464 playlist_item_t *p_item,
465 bool b_ena, bool b_unplayed )
467 playlist_item_t *p_prev;
469 PL_DEBUG2( "finding previous os %s within %s", PLI_NAME( p_item ),
470 PLI_NAME( p_root ) );
471 assert( p_root && p_root->i_children != -1 );
473 /* Now, walk the tree until we find a suitable previous item */
477 bool b_ena_ok = true, b_unplayed_ok = true;
478 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
479 if( !p_prev || p_prev == p_root )
481 if( p_prev->i_children == -1 )
483 if( b_ena && p_prev->i_flags & PLAYLIST_DBL_FLAG )
485 if( b_unplayed && p_prev->p_input->i_nb_played != 0 )
486 b_unplayed_ok = false;
487 if( b_ena_ok && b_unplayed_ok ) break;
490 if( p_prev == NULL ) PL_DEBUG2( "at beginning of node" );
494 /************************************************************************
495 * Following functions are local
496 ***********************************************************************/
499 * Get the next item in the tree
500 * If p_item is NULL, return the first child of root
502 playlist_item_t *GetNextItem( playlist_t *p_playlist,
503 playlist_item_t *p_root,
504 playlist_item_t *p_item )
506 playlist_item_t *p_parent;
509 /* Node with children, get the first one */
510 if( p_item && p_item->i_children > 0 )
511 return p_item->pp_children[0];
514 p_parent = p_item->p_parent;
517 for( i= 0 ; i < p_parent->i_children ; i++ )
519 if( p_item == NULL || p_parent->pp_children[i] == p_item )
524 if( i+1 >= p_parent->i_children )
526 /* Was already the last sibling. Look for uncles */
527 PL_DEBUG2( "Current item is the last of the node,"
528 "looking for uncle from %s",
529 p_parent->p_input->psz_name );
531 if( p_parent == p_root )
533 PL_DEBUG2( "already at root" );
536 return GetNextUncle( p_playlist, p_item, p_root );
540 return p_parent->pp_children[i+1];
547 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
548 playlist_item_t *p_root )
550 playlist_item_t *p_parent = p_item->p_parent;
551 playlist_item_t *p_grandparent;
552 bool b_found = false;
556 if( p_parent != NULL )
558 p_grandparent = p_parent->p_parent;
559 while( p_grandparent )
562 for( i = 0 ; i< p_grandparent->i_children ; i++ )
564 if( p_parent == p_grandparent->pp_children[i] )
566 PL_DEBUG2( "parent %s found as child %i of grandparent %s",
567 p_parent->p_input->psz_name, i,
568 p_grandparent->p_input->psz_name );
573 if( b_found && i + 1 < p_grandparent->i_children )
575 return p_grandparent->pp_children[i+1];
577 /* Not found at root */
578 if( p_grandparent == p_root )
584 p_parent = p_grandparent;
585 p_grandparent = p_parent->p_parent;
589 /* We reached root */
593 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
594 playlist_item_t *p_root )
596 playlist_item_t *p_parent = p_item->p_parent;
597 playlist_item_t *p_grandparent;
598 bool b_found = false;
602 if( p_parent != NULL )
604 p_grandparent = p_parent->p_parent;
608 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
610 if( p_parent == p_grandparent->pp_children[i] )
616 if( b_found && i - 1 > 0 )
618 return p_grandparent->pp_children[i-1];
620 /* Not found at root */
621 if( p_grandparent == p_root )
627 p_parent = p_grandparent;
628 p_grandparent = p_parent->p_parent;
632 /* We reached root */
637 /* Recursively search the tree for previous item */
638 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
639 playlist_item_t *p_root,
640 playlist_item_t *p_item )
642 playlist_item_t *p_parent;
645 /* Node with children, get the last one */
646 if( p_item && p_item->i_children > 0 )
647 return p_item->pp_children[p_item->i_children - 1];
649 /* Last child of its parent ? */
651 p_parent = p_item->p_parent;
654 msg_Err( p_playlist, "Get the last one" );
658 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
660 if( p_parent->pp_children[i] == p_item )
664 /* Was already the first sibling. Look for uncles */
665 PL_DEBUG2( "current item is the first of its node,"
666 "looking for uncle from %s",
667 p_parent->p_input->psz_name );
668 if( p_parent == p_root )
670 PL_DEBUG2( "already at root" );
673 return GetPrevUncle( p_playlist, p_item, p_root );
677 return p_parent->pp_children[i-1];