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)
250 if( p_node->i_children == -1 )
253 for( i=0 ; i< p_node->i_children;i++ )
255 if( p_node->pp_children[i]->i_children == -1 )
258 i_nb += playlist_NodeChildrenCount( p_playlist,
259 p_node->pp_children[i] );
265 * Search a child of a node by its name
267 * \param p_node the node
268 * \param psz_search the name of the child to search
269 * \return the child item or NULL if not found or error
271 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
272 const char *psz_search )
276 if( p_node->i_children < 0 )
280 for( i = 0 ; i< p_node->i_children; i++ )
282 if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
284 return p_node->pp_children[i];
291 void playlist_NodesCreateForSD( playlist_t *p_playlist, char *psz_name,
292 playlist_item_t **pp_node_cat,
293 playlist_item_t **pp_node_one )
295 *pp_node_cat = playlist_NodeCreate( p_playlist, psz_name,
296 p_playlist->p_root_category );
297 (*pp_node_cat)->i_flags |= PLAYLIST_RO_FLAG;
298 (*pp_node_cat)->i_flags |= PLAYLIST_SKIP_FLAG;
300 *pp_node_one = playlist_NodeCreate( p_playlist, psz_name,
301 p_playlist->p_root_onelevel );
302 (*pp_node_one)->i_flags |= PLAYLIST_RO_FLAG;
303 (*pp_node_one)->i_flags |= PLAYLIST_SKIP_FLAG;
305 (*pp_node_one)->p_input->i_id = (*pp_node_cat)->p_input->i_id;
308 playlist_item_t * playlist_GetPreferredNode( playlist_t *p_playlist,
309 playlist_item_t *p_node )
312 if( p_node->p_parent == p_playlist->p_root_category )
314 if( p_playlist->b_always_tree ||
315 p_node->p_input->b_prefers_tree ) return p_node;
316 for( i = 0 ; i< p_playlist->p_root_onelevel->i_children; i++ )
318 if( p_playlist->p_root_onelevel->pp_children[i]->p_input->i_id ==
319 p_node->p_input->i_id )
320 return p_playlist->p_root_onelevel->pp_children[i];
323 else if( p_node->p_parent == p_playlist->p_root_onelevel )
325 if( p_playlist->b_never_tree || !p_node->p_input->b_prefers_tree )
327 for( i = 0 ; i< p_playlist->p_root_category->i_children; i++ )
329 if( p_playlist->p_root_category->pp_children[i]->p_input->i_id ==
330 p_node->p_input->i_id )
331 return p_playlist->p_root_category->pp_children[i];
337 /**********************************************************************
338 * Tree walking functions
339 **********************************************************************/
341 playlist_item_t *playlist_GetLastLeaf(playlist_t *p_playlist,
342 playlist_item_t *p_root )
345 playlist_item_t *p_item;
346 for ( i = p_root->i_children - 1; i >= 0; i-- )
348 if( p_root->pp_children[i]->i_children == -1 )
349 return p_root->pp_children[i];
350 else if( p_root->pp_children[i]->i_children > 0)
352 p_item = playlist_GetLastLeaf( p_playlist,
353 p_root->pp_children[i] );
354 if ( p_item != NULL )
363 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
364 playlist_item_t *p_node,
365 playlist_item_t ***ppp_items )
368 playlist_item_t *p_next = NULL;
371 p_next = playlist_GetNextLeaf( p_playlist, p_node,
372 p_next, VLC_TRUE, VLC_FALSE );
374 INSERT_ELEM( *ppp_items, i_count, i_count, p_next );
382 * Finds the next item to play
384 * \param p_playlist the playlist
385 * \param p_root the root node
386 * \param p_item the previous item (NULL if none )
387 * \return the next item to play, or NULL if none found
389 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
390 playlist_item_t *p_root,
391 playlist_item_t *p_item,
392 vlc_bool_t b_ena, vlc_bool_t b_unplayed )
394 playlist_item_t *p_next;
396 assert( p_root && p_root->i_children != -1 );
398 #ifdef PLAYLIST_DEBUG
400 msg_Dbg( p_playlist, "finding next of %s within %s",
401 p_item->p_input->psz_name, p_root->p_input->psz_name );
403 msg_Dbg( p_playlist, "finding something to play within %s",
404 p_root->p_input->psz_name );
407 /* Now, walk the tree until we find a suitable next item */
411 vlc_bool_t b_ena_ok = VLC_TRUE, b_unplayed_ok = VLC_TRUE;
412 p_next = GetNextItem( p_playlist, p_root, p_next );
413 if( !p_next || p_next == p_root )
415 if( p_next->i_children == -1 )
417 if( b_ena && p_next->i_flags & PLAYLIST_DBL_FLAG )
418 b_ena_ok = VLC_FALSE;
419 if( b_unplayed && p_next->p_input->i_nb_played != 0 )
420 b_unplayed_ok = VLC_FALSE;
421 if( b_ena_ok && b_unplayed_ok ) break;
424 #ifdef PLAYLIST_DEBUG
426 msg_Dbg( p_playlist, "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 vlc_bool_t b_ena, vlc_bool_t b_unplayed )
444 playlist_item_t *p_prev;
446 #ifdef PLAYLIST_DEBUG
448 msg_Dbg( p_playlist, "finding previous of %s within %s",
449 p_item->p_input->psz_name, p_root->p_input->psz_name );
451 msg_Dbg( p_playlist, "finding previous to play within %s",
452 p_root->p_input->psz_name );
454 assert( p_root && p_root->i_children != -1 );
456 /* Now, walk the tree until we find a suitable previous item */
460 vlc_bool_t b_ena_ok = VLC_TRUE, b_unplayed_ok = VLC_TRUE;
461 p_prev = GetPrevItem( p_playlist, p_root, p_prev );
462 if( !p_prev || p_prev == p_root )
464 if( p_prev->i_children == -1 )
466 if( b_ena && p_prev->i_flags & PLAYLIST_DBL_FLAG )
467 b_ena_ok = VLC_FALSE;
468 if( b_unplayed && p_prev->p_input->i_nb_played != 0 )
469 b_unplayed_ok = VLC_FALSE;
470 if( b_ena_ok && b_unplayed_ok ) break;
473 #ifdef PLAYLIST_DEBUG
475 msg_Dbg( p_playlist, "At beginning of node" );
480 /************************************************************************
481 * Following functions are local
482 ***********************************************************************/
485 * Get the next item in the tree
486 * If p_item is NULL, return the first child of root
488 playlist_item_t *GetNextItem( playlist_t *p_playlist,
489 playlist_item_t *p_root,
490 playlist_item_t *p_item )
492 playlist_item_t *p_parent;
495 /* Node with children, get the first one */
496 if( p_item && p_item->i_children > 0 )
497 return p_item->pp_children[0];
500 p_parent = p_item->p_parent;
504 for( i= 0 ; i < p_parent->i_children ; i++ )
506 if( p_item == NULL || p_parent->pp_children[i] == p_item )
511 if( i+1 >= p_parent->i_children )
513 /* Was already the last sibling. Look for uncles */
514 PL_DEBUG( "Current item is the last of the node,"
515 "looking for uncle from %s",
516 p_parent->p_input->psz_name );
518 if( p_parent == p_root )
520 PL_DEBUG( "already at root" );
523 return GetNextUncle( p_playlist, p_item, p_root );
527 return p_parent->pp_children[i+1];
531 msg_Err( p_playlist, "I should not be here" );
535 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
536 playlist_item_t *p_root )
538 playlist_item_t *p_parent = p_item->p_parent;
539 playlist_item_t *p_grandparent;
540 vlc_bool_t b_found = VLC_FALSE;
542 if( p_parent != NULL )
544 p_grandparent = p_parent->p_parent;
548 for( i = 0 ; i< p_grandparent->i_children ; i++ )
550 if( p_parent == p_grandparent->pp_children[i] )
552 PL_DEBUG( "parent %s found as child %i of grandparent %s",
553 p_parent->p_input->psz_name, i,
554 p_grandparent->p_input->psz_name );
559 if( b_found && i + 1 < p_grandparent->i_children )
561 return p_grandparent->pp_children[i+1];
563 /* Not found at root */
564 if( p_grandparent == p_root )
570 p_parent = p_grandparent;
571 p_grandparent = p_parent->p_parent;
575 /* We reached root */
579 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
580 playlist_item_t *p_root )
582 playlist_item_t *p_parent = p_item->p_parent;
583 playlist_item_t *p_grandparent;
584 vlc_bool_t b_found = VLC_FALSE;
586 if( p_parent != NULL )
588 p_grandparent = p_parent->p_parent;
592 for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
594 if( p_parent == p_grandparent->pp_children[i] )
600 if( b_found && i - 1 > 0 )
602 return p_grandparent->pp_children[i-1];
604 /* Not found at root */
605 if( p_grandparent == p_root )
611 p_parent = p_grandparent;
612 p_grandparent = p_parent->p_parent;
616 /* We reached root */
621 /* Recursively search the tree for previous item */
622 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
623 playlist_item_t *p_root,
624 playlist_item_t *p_item )
626 playlist_item_t *p_parent;
629 /* Node with children, get the last one */
630 if( p_item && p_item->i_children > 0 )
631 return p_item->pp_children[p_item->i_children - 1];
633 /* Last child of its parent ? */
635 p_parent = p_item->p_parent;
638 msg_Err( p_playlist, "Get the last one" );
642 for( i = p_parent->i_children -1 ; i >= 0 ; i-- )
644 if( p_parent->pp_children[i] == p_item )
648 /* Was already the first sibling. Look for uncles */
649 PL_DEBUG( "Current item is the first of the node,"
650 "looking for uncle from %s",
651 p_parent->p_input->psz_name );
652 return GetPrevUncle( p_playlist, p_item, p_root );
656 return p_parent->pp_children[i-1];
660 msg_Err( p_playlist, "I should not be here" );
664 /* Dump the contents of a node */
665 void playlist_NodeDump( playlist_t *p_playlist, playlist_item_t *p_item,
673 msg_Dbg( p_playlist, "%s (%i)",
674 p_item->p_input->psz_name, p_item->i_children );
677 if( p_item->i_children == -1 )
682 for( i = 0; i< p_item->i_children; i++ )
684 memset( str, 32, 512 );
685 sprintf( str + 2 * i_level , "%s (%i)",
686 p_item->pp_children[i]->p_input->psz_name,
687 p_item->pp_children[i]->i_children );
688 msg_Dbg( p_playlist, "%s",str );
689 if( p_item->pp_children[i]->i_children >= 0 )
691 playlist_NodeDump( p_playlist, p_item->pp_children[i],