1 /*****************************************************************************
2 * tree.c : Playlist tree walking functions
3 *****************************************************************************
4 * Copyright (C) 1999-2004 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 *****************************************************************************/
25 #include <vlc/input.h>
26 #include "vlc_playlist.h"
27 #include "playlist_internal.h"
29 /************************************************************************
31 ************************************************************************/
32 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
33 playlist_item_t *p_root );
34 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
35 playlist_item_t *p_root );
37 playlist_item_t *GetNextItem( playlist_t *p_playlist,
38 playlist_item_t *p_root,
39 playlist_item_t *p_item );
40 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
41 playlist_item_t *p_item,
42 playlist_item_t *p_root );
45 * Create a playlist node
47 * \param p_playlist the playlist
48 * \paam psz_name the name of the node
49 * \param p_parent the parent node to attach to or NULL if no attach
50 * \return the new node
52 playlist_item_t * playlist_NodeCreate( playlist_t *p_playlist, char *psz_name,
53 playlist_item_t *p_parent )
55 input_item_t *p_input;
56 playlist_item_t *p_item;
58 if( !psz_name ) psz_name = _("Undefined");
59 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist), NULL, psz_name,
60 0, NULL, -1, ITEM_TYPE_NODE );
61 p_input->i_id = ++p_playlist->i_last_input_id;
62 p_item = playlist_ItemNewFromInput( VLC_OBJECT(p_playlist), p_input );
63 p_item->i_children = 0;
69 INSERT_ELEM( p_playlist->pp_all_items,
70 p_playlist->i_all_size,
71 p_playlist->i_all_size,
74 if( p_parent != NULL )
76 playlist_NodeAppend( p_playlist, p_item, p_parent );
79 playlist_SendAddNotify( p_playlist, p_item->i_id,
80 p_parent ? p_parent->i_id : -1 );
85 * Remove all the children of a node
87 * This function must be entered with the playlist lock
89 * \param p_playlist the playlist
90 * \param p_root the node
91 * \param b_delete_items do we have to delete the children items ?
92 * \return VLC_SUCCESS or an error
94 int playlist_NodeEmpty( playlist_t *p_playlist, playlist_item_t *p_root,
95 vlc_bool_t b_delete_items )
98 if( p_root->i_children == -1 )
103 /* Delete the children */
104 for( i = p_root->i_children-1 ; i >= 0 ;i-- )
106 if( p_root->pp_children[i]->i_children > -1 )
108 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
109 b_delete_items , VLC_FALSE );
111 else if( b_delete_items )
113 /* Delete the item here */
114 playlist_DeleteFromItemId( p_playlist,
115 p_root->pp_children[i]->i_id );
122 * Remove all the children of a node and removes the node
124 * \param p_playlist the playlist
125 * \param p_root the node
126 * \param b_delete_items do we have to delete the children items ?
127 * \return VLC_SUCCESS or an error
129 int playlist_NodeDelete( playlist_t *p_playlist, playlist_item_t *p_root,
130 vlc_bool_t b_delete_items, vlc_bool_t b_force )
134 if( p_root->i_children == -1 )
139 /* Delete the children */
140 for( i = p_root->i_children - 1 ; i >= 0; i-- )
142 if( p_root->pp_children[i]->i_children > -1 )
144 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
145 b_delete_items , b_force );
147 else if( b_delete_items )
149 playlist_DeleteFromItemId( p_playlist,
150 p_root->pp_children[i]->i_id );
153 /* Delete the node */
154 if( p_root->i_flags & PLAYLIST_RO_FLAG && !b_force )
159 var_SetInteger( p_playlist, "item-deleted", p_root->p_input->i_id );
160 for( i = 0 ; i< p_playlist->i_all_size; i ++ )
162 if( p_playlist->pp_all_items[i]->p_input->i_id ==
163 p_root->p_input->i_id )
165 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size,
171 /* Remove the item from its parent */
172 if( p_root->p_parent )
174 playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
177 playlist_ItemDelete( 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,
203 assert( p_parent && p_parent->i_children != -1 );
204 if( i_position == -1 ) i_position = p_parent->i_children ;
206 INSERT_ELEM( p_parent->pp_children,
207 p_parent->i_children,
210 p_item->p_parent = p_parent;
215 * Deletes an item from the children of a node
217 * \param p_playlist the playlist
218 * \param p_item the item to remove
219 * \param p_parent the parent node
220 * \return VLC_SUCCESS or an error
222 int playlist_NodeRemoveItem( playlist_t *p_playlist,
223 playlist_item_t *p_item,
224 playlist_item_t *p_parent )
227 for( i= 0; i< p_parent->i_children ; i++ )
229 if( p_parent->pp_children[i] == p_item )
231 REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
240 * Count the children of a node
242 * \param p_playlist the playlist
243 * \param p_node the node
244 * \return the number of children
246 int playlist_NodeChildrenCount( playlist_t *p_playlist, playlist_item_t*p_node)
251 if( p_node->i_children == -1 )
254 i_nb = p_node->i_children;
255 for( i=0 ; i< p_node->i_children;i++ )
257 if( p_node->pp_children[i]->i_children == -1 )
260 i_nb += playlist_NodeChildrenCount( p_playlist,
261 p_node->pp_children[i] );
267 * Search a child of a node by its name
269 * \param p_node the node
270 * \param psz_search the name of the child to search
271 * \return the child item or NULL if not found or error
273 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
274 const char *psz_search )
278 if( p_node->i_children < 0 )
282 for( i = 0 ; i< p_node->i_children; i++ )
284 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
286 return p_node->pp_children[i];
293 * Create a pair of nodes in the category and onelevel trees.
294 * They share the same input ID.
295 * \todo really share the input item
296 * \param p_playlist the playlist
297 * \param psz_name the name of the nodes
298 * \param pp_node_cat pointer to return the node in category tree
299 * \param pp_node_one pointer to return the node in onelevel tree
300 * \param b_for_sd For Services Discovery ? (make node read-only and unskipping)
302 void playlist_NodesPairCreate( playlist_t *p_playlist, char *psz_name,
303 playlist_item_t **pp_node_cat,
304 playlist_item_t **pp_node_one,
305 vlc_bool_t b_for_sd )
307 *pp_node_cat = playlist_NodeCreate( p_playlist, psz_name,
308 p_playlist->p_root_category );
309 *pp_node_one = playlist_NodeCreate( p_playlist, psz_name,
310 p_playlist->p_root_onelevel );
311 (*pp_node_one)->p_input->i_id = (*pp_node_cat)->p_input->i_id;
314 (*pp_node_cat)->i_flags |= PLAYLIST_RO_FLAG;
315 (*pp_node_cat)->i_flags |= PLAYLIST_SKIP_FLAG;
316 (*pp_node_one)->i_flags |= PLAYLIST_RO_FLAG;
317 (*pp_node_one)->i_flags |= PLAYLIST_SKIP_FLAG;
322 * Get the node in the preferred tree from a node in one of category
324 * For example, for the SAP node, it will return the node in the category
325 * tree if --playlist-tree is not set to never, because the SAP node prefers
328 playlist_item_t * playlist_GetPreferredNode( playlist_t *p_playlist,
329 playlist_item_t *p_node )
332 if( p_node->p_parent == p_playlist->p_root_category )
334 if( p_playlist->b_always_tree ||
335 p_node->p_input->b_prefers_tree ) return p_node;
336 for( i = 0 ; i< p_playlist->p_root_onelevel->i_children; i++ )
338 if( p_playlist->p_root_onelevel->pp_children[i]->p_input->i_id ==
339 p_node->p_input->i_id )
340 return p_playlist->p_root_onelevel->pp_children[i];
343 else if( p_node->p_parent == p_playlist->p_root_onelevel )
345 if( p_playlist->b_never_tree || !p_node->p_input->b_prefers_tree )
347 for( i = 0 ; i< p_playlist->p_root_category->i_children; i++ )
349 if( p_playlist->p_root_category->pp_children[i]->p_input->i_id ==
350 p_node->p_input->i_id )
351 return p_playlist->p_root_category->pp_children[i];
357 /**********************************************************************
358 * Tree walking functions
359 **********************************************************************/
361 playlist_item_t *playlist_GetLastLeaf(playlist_t *p_playlist,
362 playlist_item_t *p_root )
365 playlist_item_t *p_item;
366 for ( i = p_root->i_children - 1; i >= 0; i-- )
368 if( p_root->pp_children[i]->i_children == -1 )
369 return p_root->pp_children[i];
370 else if( p_root->pp_children[i]->i_children > 0)
372 p_item = playlist_GetLastLeaf( p_playlist,
373 p_root->pp_children[i] );
374 if ( p_item != NULL )
383 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
384 playlist_item_t *p_node,
385 playlist_item_t ***ppp_items )
388 playlist_item_t *p_next = NULL;
391 p_next = playlist_GetNextLeaf( p_playlist, p_node,
392 p_next, VLC_TRUE, VLC_FALSE );
394 INSERT_ELEM( *ppp_items, i_count, i_count, p_next );
402 * Finds the next item to play
404 * \param p_playlist the playlist
405 * \param p_root the root node
406 * \param p_item the previous item (NULL if none )
407 * \return the next item to play, or NULL if none found
409 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
410 playlist_item_t *p_root,
411 playlist_item_t *p_item,
412 vlc_bool_t b_ena, vlc_bool_t b_unplayed )
414 playlist_item_t *p_next;
416 assert( p_root && p_root->i_children != -1 );
418 #ifdef PLAYLIST_DEBUG
420 msg_Dbg( p_playlist, "finding next of %s within %s",
421 p_item->p_input->psz_name, p_root->p_input->psz_name );
423 msg_Dbg( p_playlist, "finding something to play within %s",
424 p_root->p_input->psz_name );
427 /* Now, walk the tree until we find a suitable next item */
431 vlc_bool_t b_ena_ok = VLC_TRUE, b_unplayed_ok = VLC_TRUE;
432 p_next = GetNextItem( p_playlist, p_root, p_next );
433 PL_DEBUG( "Got next item %s, testing suitability", PLI_NAME(p_next) );
434 if( !p_next || p_next == p_root )
436 if( p_next->i_children == -1 )
438 if( b_ena && p_next->i_flags & PLAYLIST_DBL_FLAG )
439 b_ena_ok = VLC_FALSE;
440 if( b_unplayed && p_next->p_input->i_nb_played != 0 )
441 b_unplayed_ok = VLC_FALSE;
442 if( b_ena_ok && b_unplayed_ok ) break;
445 #ifdef PLAYLIST_DEBUG
447 msg_Dbg( p_playlist, "At end of node" );
453 * Finds the previous item to play
455 * \param p_playlist the playlist
456 * \param p_root the root node
457 * \param p_item the previous item (NULL if none )
458 * \return the next item to play, or NULL if none found
460 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
461 playlist_item_t *p_root,
462 playlist_item_t *p_item,
463 vlc_bool_t b_ena, vlc_bool_t b_unplayed )
465 playlist_item_t *p_prev;
467 #ifdef PLAYLIST_DEBUG
469 msg_Dbg( p_playlist, "finding previous of %s within %s",
470 p_item->p_input->psz_name, p_root->p_input->psz_name );
472 msg_Dbg( p_playlist, "finding previous to play within %s",
473 p_root->p_input->psz_name );
475 assert( p_root && p_root->i_children != -1 );
477 /* Now, walk the tree until we find a suitable previous item */
481 vlc_bool_t b_ena_ok = VLC_TRUE, b_unplayed_ok = VLC_TRUE;
482 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
483 if( !p_prev || p_prev == p_root )
485 if( p_prev->i_children == -1 )
487 if( b_ena && p_prev->i_flags & PLAYLIST_DBL_FLAG )
488 b_ena_ok = VLC_FALSE;
489 if( b_unplayed && p_prev->p_input->i_nb_played != 0 )
490 b_unplayed_ok = VLC_FALSE;
491 if( b_ena_ok && b_unplayed_ok ) break;
494 #ifdef PLAYLIST_DEBUG
496 msg_Dbg( p_playlist, "At beginning of node" );
501 /************************************************************************
502 * Following functions are local
503 ***********************************************************************/
506 * Get the next item in the tree
507 * If p_item is NULL, return the first child of root
509 playlist_item_t *GetNextItem( playlist_t *p_playlist,
510 playlist_item_t *p_root,
511 playlist_item_t *p_item )
513 playlist_item_t *p_parent;
516 /* Node with children, get the first one */
517 if( p_item && p_item->i_children > 0 )
518 return p_item->pp_children[0];
521 p_parent = p_item->p_parent;
524 PL_DEBUG( "Parent %s has %i children", PLI_NAME(p_parent),
525 p_parent->i_children );
526 for( i= 0 ; i < p_parent->i_children ; i++ )
528 if( p_item == NULL || p_parent->pp_children[i] == p_item )
533 if( i+1 >= p_parent->i_children )
535 /* Was already the last sibling. Look for uncles */
536 PL_DEBUG( "Current item is the last of the node,"
537 "looking for uncle from %s",
538 p_parent->p_input->psz_name );
540 if( p_parent == p_root )
542 PL_DEBUG( "already at root" );
545 return GetNextUncle( p_playlist, p_item, p_root );
549 return p_parent->pp_children[i+1];
556 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
557 playlist_item_t *p_root )
559 playlist_item_t *p_parent = p_item->p_parent;
560 playlist_item_t *p_grandparent;
561 vlc_bool_t b_found = VLC_FALSE;
563 if( p_parent != NULL )
565 p_grandparent = p_parent->p_parent;
569 for( i = 0 ; i< p_grandparent->i_children ; i++ )
571 if( p_parent == p_grandparent->pp_children[i] )
573 PL_DEBUG( "parent %s found as child %i of grandparent %s",
574 p_parent->p_input->psz_name, i,
575 p_grandparent->p_input->psz_name );
580 if( b_found && i + 1 < p_grandparent->i_children )
582 return p_grandparent->pp_children[i+1];
584 /* Not found at root */
585 if( p_grandparent == p_root )
591 p_parent = p_grandparent;
592 p_grandparent = p_parent->p_parent;
596 /* We reached root */
600 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
601 playlist_item_t *p_root )
603 playlist_item_t *p_parent = p_item->p_parent;
604 playlist_item_t *p_grandparent;
605 vlc_bool_t b_found = VLC_FALSE;
607 if( p_parent != NULL )
609 p_grandparent = p_parent->p_parent;
613 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
615 if( p_parent == p_grandparent->pp_children[i] )
621 if( b_found && i - 1 > 0 )
623 return p_grandparent->pp_children[i-1];
625 /* Not found at root */
626 if( p_grandparent == p_root )
632 p_parent = p_grandparent;
633 p_grandparent = p_parent->p_parent;
637 /* We reached root */
642 /* Recursively search the tree for previous item */
643 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
644 playlist_item_t *p_root,
645 playlist_item_t *p_item )
647 playlist_item_t *p_parent;
650 /* Node with children, get the last one */
651 if( p_item && p_item->i_children > 0 )
652 return p_item->pp_children[p_item->i_children - 1];
654 /* Last child of its parent ? */
656 p_parent = p_item->p_parent;
659 msg_Err( p_playlist, "Get the last one" );
663 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
665 if( p_parent->pp_children[i] == p_item )
669 /* Was already the first sibling. Look for uncles */
670 PL_DEBUG( "current item is the first of its node,"
671 "looking for uncle from %s",
672 p_parent->p_input->psz_name );
673 if( p_parent == p_root )
675 PL_DEBUG( "already at root" );
678 return GetPrevUncle( p_playlist, p_item, p_root );
682 return p_parent->pp_children[i-1];
689 /* Dump the contents of a node */
690 void playlist_NodeDump( playlist_t *p_playlist, playlist_item_t *p_item,
698 msg_Dbg( p_playlist, "%s (%i)",
699 p_item->p_input->psz_name, p_item->i_children );
702 if( p_item->i_children == -1 )
707 for( i = 0; i< p_item->i_children; i++ )
709 memset( str, 32, 512 );
710 sprintf( str + 2 * i_level , "%s (%i)",
711 p_item->pp_children[i]->p_input->psz_name,
712 p_item->pp_children[i]->i_children );
713 msg_Dbg( p_playlist, "%s",str );
714 if( p_item->pp_children[i]->i_children >= 0 )
716 playlist_NodeDump( p_playlist, p_item->pp_children[i],