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"
28 #define PLAYLIST_DEBUG 1
30 /************************************************************************
32 ************************************************************************/
33 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
34 playlist_item_t *p_root );
35 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
36 playlist_item_t *p_root );
38 playlist_item_t *GetNextItem( playlist_t *p_playlist,
39 playlist_item_t *p_root,
40 playlist_item_t *p_item );
41 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
42 playlist_item_t *p_item,
43 playlist_item_t *p_root );
46 * Create a playlist node
48 * \param p_playlist the playlist
49 * \paam psz_name the name of the node
50 * \param p_parent the parent node to attach to or NULL if no attach
51 * \return the new node
53 playlist_item_t * playlist_NodeCreate( playlist_t *p_playlist, char *psz_name,
54 playlist_item_t *p_parent )
56 input_item_t *p_input;
57 playlist_item_t *p_item;
59 if( !psz_name ) psz_name = strdup( _("Undefined") );
60 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist), NULL, psz_name,
61 0, NULL, -1, ITEM_TYPE_NODE );
62 p_input->i_id = ++p_playlist->i_last_input_id;
63 p_item = playlist_ItemNewFromInput( VLC_OBJECT(p_playlist), p_input );
64 p_item->i_children = 0;
70 INSERT_ELEM( p_playlist->pp_all_items,
71 p_playlist->i_all_size,
72 p_playlist->i_all_size,
75 if( p_parent != NULL )
77 playlist_NodeAppend( p_playlist, p_item, p_parent );
80 playlist_SendAddNotify( p_playlist, p_item->i_id,
81 p_parent ? p_parent->i_id : -1 );
86 * Remove all the children of a node
88 * This function must be entered with the playlist lock
90 * \param p_playlist the playlist
91 * \param p_root the node
92 * \param b_delete_items do we have to delete the children items ?
93 * \return VLC_SUCCESS or an error
95 int playlist_NodeEmpty( playlist_t *p_playlist, playlist_item_t *p_root,
96 vlc_bool_t b_delete_items )
99 if( p_root->i_children == -1 )
104 /* Delete the children */
105 for( i = p_root->i_children-1 ; i >= 0 ;i-- )
107 if( p_root->pp_children[i]->i_children > -1 )
109 playlist_NodeDelete( p_playlist, p_root->pp_children[i],
110 b_delete_items , VLC_FALSE );
112 else if( b_delete_items )
114 /* Delete the item here */
115 playlist_DeleteFromItemId( p_playlist,
116 p_root->pp_children[i]->i_id );
123 * Remove all the children of a node and removes the node
125 * \param p_playlist the playlist
126 * \param p_root the node
127 * \param b_delete_items do we have to delete the children items ?
128 * \return VLC_SUCCESS or an error
130 int playlist_NodeDelete( playlist_t *p_playlist, playlist_item_t *p_root,
131 vlc_bool_t b_delete_items, vlc_bool_t b_force )
133 int i, i_top, i_bottom;
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 );
161 i_bottom = 0; i_top = p_playlist->i_all_size - 1;
163 while( p_playlist->pp_all_items[i]->p_input->i_id !=
164 p_root->p_input->i_id && i_top > i_bottom )
166 if( p_playlist->pp_all_items[i]->p_input->i_id <
167 p_root->p_input->i_id )
175 i = i_bottom + ( i_top - i_bottom ) / 2;
177 if( p_playlist->pp_all_items[i]->p_input->i_id ==
178 p_root->p_input->i_id )
180 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size, i );
183 /* Remove the item from its parent */
184 if( p_root->p_parent )
186 playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
189 playlist_ItemDelete( p_root );
196 * Adds an item to the children of a node
198 * \param p_playlist the playlist
199 * \param p_item the item to append
200 * \param p_parent the parent node
201 * \return VLC_SUCCESS or an error
203 int playlist_NodeAppend( playlist_t *p_playlist,
204 playlist_item_t *p_item,
205 playlist_item_t *p_parent )
207 return playlist_NodeInsert( p_playlist, p_item, p_parent, -1 );
210 int playlist_NodeInsert( playlist_t *p_playlist,
211 playlist_item_t *p_item,
212 playlist_item_t *p_parent,
215 assert( p_parent && p_parent->i_children != -1 );
216 if( i_position == -1 ) i_position = p_parent->i_children ;
218 INSERT_ELEM( p_parent->pp_children,
219 p_parent->i_children,
222 p_item->p_parent = p_parent;
227 * Deletes an item from the children of a node
229 * \param p_playlist the playlist
230 * \param p_item the item to remove
231 * \param p_parent the parent node
232 * \return VLC_SUCCESS or an error
234 int playlist_NodeRemoveItem( playlist_t *p_playlist,
235 playlist_item_t *p_item,
236 playlist_item_t *p_parent )
239 for( i= 0; i< p_parent->i_children ; i++ )
241 if( p_parent->pp_children[i] == p_item )
243 REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
252 * Count the children of a node
254 * \param p_playlist the playlist
255 * \param p_node the node
256 * \return the number of children
258 int playlist_NodeChildrenCount( playlist_t *p_playlist, playlist_item_t*p_node)
262 if( p_node->i_children == -1 )
265 for( i=0 ; i< p_node->i_children;i++ )
267 if( p_node->pp_children[i]->i_children == -1 )
270 i_nb += playlist_NodeChildrenCount( p_playlist,
271 p_node->pp_children[i] );
277 * Search a child of a node by its name
279 * \param p_node the node
280 * \param psz_search the name of the child to search
281 * \return the child item or NULL if not found or error
283 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
284 const char *psz_search )
288 if( p_node->i_children < 0 )
292 for( i = 0 ; i< p_node->i_children; i++ )
294 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
296 return p_node->pp_children[i];
303 void playlist_NodesCreateForSD( playlist_t *p_playlist, char *psz_name,
304 playlist_item_t **pp_node_cat,
305 playlist_item_t **pp_node_one )
307 *pp_node_cat = playlist_NodeCreate( p_playlist, psz_name,
308 p_playlist->p_root_category );
309 (*pp_node_cat)->i_flags |= PLAYLIST_RO_FLAG;
310 (*pp_node_cat)->i_flags |= PLAYLIST_SKIP_FLAG;
312 *pp_node_one = playlist_NodeCreate( p_playlist, psz_name,
313 p_playlist->p_root_onelevel );
314 (*pp_node_one)->i_flags |= PLAYLIST_RO_FLAG;
315 (*pp_node_one)->i_flags |= PLAYLIST_SKIP_FLAG;
319 /**********************************************************************
320 * Tree walking functions
321 **********************************************************************/
323 playlist_item_t *playlist_GetLastLeaf(playlist_t *p_playlist,
324 playlist_item_t *p_root )
327 playlist_item_t *p_item;
328 for ( i = p_root->i_children - 1; i >= 0; i-- )
330 if( p_root->pp_children[i]->i_children == -1 )
331 return p_root->pp_children[i];
332 else if( p_root->pp_children[i]->i_children > 0)
334 p_item = playlist_GetLastLeaf( p_playlist,
335 p_root->pp_children[i] );
336 if ( p_item != NULL )
346 * Finds the next item to play
348 * \param p_playlist the playlist
349 * \param p_root the root node
350 * \param p_item the previous item (NULL if none )
351 * \return the next item to play, or NULL if none found
353 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
354 playlist_item_t *p_root,
355 playlist_item_t *p_item )
357 playlist_item_t *p_next;
359 #ifdef PLAYLIST_DEBUG
361 msg_Dbg( p_playlist, "finding next of %s within %s",
362 p_item->p_input->psz_name, p_root->p_input->psz_name );
364 msg_Dbg( p_playlist, "finding something to play within %s",
365 p_root->p_input->psz_name );
368 assert( p_root && p_root->i_children != -1 );
370 /* Now, walk the tree until we find a suitable next item */
374 p_next = GetNextItem( p_playlist, p_root, p_next );
375 } while ( p_next && p_next != p_root && p_next->i_children != -1 );
377 #ifdef PLAYLIST_DEBUG
379 msg_Dbg( p_playlist, "At end of node" );
384 playlist_item_t *playlist_GetNextEnabledLeaf( playlist_t *p_playlist,
385 playlist_item_t *p_root,
386 playlist_item_t *p_item )
388 playlist_item_t *p_next;
390 #ifdef PLAYLIST_DEBUG
392 msg_Dbg( p_playlist, "finding next of %s within %s",
393 p_item->p_input->psz_name, p_root->p_input->psz_name );
395 msg_Dbg( p_playlist, "finding something to play within %s",
396 p_root->p_input->psz_name );
399 assert( p_root && p_root->i_children != -1 );
401 /* Now, walk the tree until we find a suitable next item */
405 p_next = GetNextItem( p_playlist, p_root, p_next );
406 } while ( p_next && p_next != p_root &&
407 !( p_next->i_children == -1 &&
408 !(p_next->i_flags & PLAYLIST_DBL_FLAG) ) );
410 #ifdef PLAYLIST_DEBUG
412 msg_Dbg( p_playlist, "At end of node" );
418 * Finds the previous item to play
420 * \param p_playlist the playlist
421 * \param p_root the root node
422 * \param p_item the previous item (NULL if none )
423 * \return the next item to play, or NULL if none found
425 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
426 playlist_item_t *p_root,
427 playlist_item_t *p_item )
429 playlist_item_t *p_prev;
431 #ifdef PLAYLIST_DEBUG
433 msg_Dbg( p_playlist, "finding previous of %s within %s",
434 p_item->p_input->psz_name, p_root->p_input->psz_name );
436 msg_Dbg( p_playlist, "finding previous to play within %s",
437 p_root->p_input->psz_name );
439 assert( p_root && p_root->i_children != -1 );
441 /* Now, walk the tree until we find a suitable previous item */
445 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
446 } while ( p_prev && p_prev != p_root && p_prev->i_children != -1 );
448 #ifdef PLAYLIST_DEBUG
450 msg_Dbg( p_playlist, "At beginning of node" );
455 /************************************************************************
456 * Following functions are local
457 ***********************************************************************/
460 * Get the next item in the tree
461 * If p_item is NULL, return the first child of root
463 playlist_item_t *GetNextItem( playlist_t *p_playlist,
464 playlist_item_t *p_root,
465 playlist_item_t *p_item )
467 playlist_item_t *p_parent;
470 /* Node with children, get the first one */
471 if( p_item && p_item->i_children > 0 )
472 return p_item->pp_children[0];
475 p_parent = p_item->p_parent;
479 for( i= 0 ; i < p_parent->i_children ; i++ )
481 if( p_item == NULL || p_parent->pp_children[i] == p_item )
486 if( i+1 >= p_parent->i_children )
488 /* Was already the last sibling. Look for uncles */
489 #ifdef PLAYLIST_DEBUG
490 msg_Dbg( p_playlist, "Current item is the last of the node,"
491 "looking for uncle from %s",
492 p_parent->p_input->psz_name );
494 if( p_parent == p_root )
496 #ifdef PLAYLIST_DEBUG
497 msg_Dbg( p_playlist, "Already at root" );
501 return GetNextUncle( p_playlist, p_item, p_root );
505 return p_parent->pp_children[i+1];
509 msg_Err( p_playlist, "I should not be here" );
513 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
514 playlist_item_t *p_root )
516 playlist_item_t *p_parent = p_item->p_parent;
517 playlist_item_t *p_grandparent;
518 vlc_bool_t b_found = VLC_FALSE;
520 if( p_parent != NULL )
522 p_grandparent = p_parent->p_parent;
526 for( i = 0 ; i< p_grandparent->i_children ; i++ )
528 if( p_parent == p_grandparent->pp_children[i] )
530 #ifdef PLAYLIST_DEBUG
531 msg_Dbg( p_playlist, "parent %s found as child %i of "
533 p_parent->p_input->psz_name, i,
534 p_grandparent->p_input->psz_name );
540 if( b_found && i + 1 < p_grandparent->i_children )
542 return p_grandparent->pp_children[i+1];
544 /* Not found at root */
545 if( p_grandparent == p_root )
551 p_parent = p_grandparent;
552 p_grandparent = p_parent->p_parent;
556 /* We reached root */
560 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
561 playlist_item_t *p_root )
563 playlist_item_t *p_parent = p_item->p_parent;
564 playlist_item_t *p_grandparent;
565 vlc_bool_t b_found = VLC_FALSE;
567 if( p_parent != NULL )
569 p_grandparent = p_parent->p_parent;
573 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
575 if( p_parent == p_grandparent->pp_children[i] )
581 if( b_found && i - 1 > 0 )
583 return p_grandparent->pp_children[i-1];
585 /* Not found at root */
586 if( p_grandparent == p_root )
592 p_parent = p_grandparent;
593 p_grandparent = p_parent->p_parent;
597 /* We reached root */
602 /* Recursively search the tree for previous item */
603 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
604 playlist_item_t *p_root,
605 playlist_item_t *p_item )
607 playlist_item_t *p_parent;
610 /* Node with children, get the last one */
611 if( p_item && p_item->i_children > 0 )
612 return p_item->pp_children[p_item->i_children - 1];
614 /* Last child of its parent ? */
616 p_parent = p_item->p_parent;
619 msg_Err( p_playlist, "Get the last one" );
623 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
625 if( p_parent->pp_children[i] == p_item )
629 /* Was already the first sibling. Look for uncles */
630 #ifdef PLAYLIST_DEBUG
631 msg_Dbg( p_playlist, "Current item is the first of the node,"
632 "looking for uncle from %s",
633 p_parent->p_input->psz_name );
635 return GetPrevUncle( p_playlist, p_item, p_root );
639 return p_parent->pp_children[i-1];
643 msg_Err( p_playlist, "I should not be here" );
647 /* Dump the contents of a node */
648 void playlist_NodeDump( playlist_t *p_playlist, playlist_item_t *p_item,
656 msg_Dbg( p_playlist, "%s (%i)",
657 p_item->p_input->psz_name, p_item->i_children );
660 if( p_item->i_children == -1 )
665 for( i = 0; i< p_item->i_children; i++ )
667 memset( str, 32, 512 );
668 sprintf( str + 2 * i_level , "%s (%i)",
669 p_item->pp_children[i]->p_input->psz_name,
670 p_item->pp_children[i]->i_children );
671 msg_Dbg( p_playlist, "%s",str );
672 if( p_item->pp_children[i]->i_children >= 0 )
674 playlist_NodeDump( p_playlist, p_item->pp_children[i],