git.sesse.net Git - vlc/blob - src/playlist/tree.c

   1 /*****************************************************************************
   2  * tree.c : Playlist tree walking functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23 #include <vlc/vlc.h>
  24 #include <assert.h>
  25 #include <vlc/input.h>
  26 #include "vlc_playlist.h"
  27
  28 /************************************************************************
  29  * Local prototypes
  30  ************************************************************************/
  31 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
  32                                playlist_item_t *p_root );
  33 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
  34                                playlist_item_t *p_root );
  35
  36 playlist_item_t *GetNextItem( playlist_t *p_playlist,
  37                               playlist_item_t *p_root,
  38                               playlist_item_t *p_item );
  39 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
  40                               playlist_item_t *p_item,
  41                               playlist_item_t *p_root );
  42
  43 /**
  44  * Create a playlist node
  45  *
  46  * \param p_playlist the playlist
  47  * \paam psz_name the name of the node
  48  * \param p_parent the parent node to attach to or NULL if no attach
  49  * \return the new node
  50  */
  51 playlist_item_t * playlist_NodeCreate( playlist_t *p_playlist, char *psz_name,
  52                                        playlist_item_t *p_parent )
  53 {
  54     input_item_t *p_input;
  55     playlist_item_t *p_item;
  56
  57     if( !psz_name ) psz_name = _("Undefined");
  58     p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist), NULL, psz_name,
  59                                      0, NULL, -1, ITEM_TYPE_NODE );
  60     p_input->i_id = ++p_playlist->i_last_input_id;
  61     p_item = playlist_ItemNewFromInput( VLC_OBJECT(p_playlist), p_input );
  62     p_item->i_children = 0;
  63
  64     if( p_item == NULL )
  65     {
  66         return NULL;
  67     }
  68     INSERT_ELEM( p_playlist->pp_all_items,
  69                  p_playlist->i_all_size,
  70                  p_playlist->i_all_size,
  71                  p_item );
  72
  73     if( p_parent != NULL )
  74     {
  75         playlist_NodeAppend( p_playlist, p_item, p_parent );
  76     }
  77
  78     playlist_SendAddNotify( p_playlist, p_item->i_id,
  79                             p_parent ? p_parent->i_id : -1 );
  80     return p_item;
  81 }
  82
  83 /**
  84  * Remove all the children of a node
  85  *
  86  * This function must be entered with the playlist lock
  87  *
  88  * \param p_playlist the playlist
  89  * \param p_root the node
  90  * \param b_delete_items do we have to delete the children items ?
  91  * \return VLC_SUCCESS or an error
  92  */
  93 int playlist_NodeEmpty( playlist_t *p_playlist, playlist_item_t *p_root,
  94                         vlc_bool_t b_delete_items )
  95 {
  96     int i;
  97     if( p_root->i_children == -1 )
  98     {
  99         return VLC_EGENERIC;
 100     }
 101
 102     /* Delete the children */
 103     for( i =  p_root->i_children-1 ; i >= 0 ;i-- )
 104     {
 105         if( p_root->pp_children[i]->i_children > -1 )
 106         {
 107             playlist_NodeDelete( p_playlist, p_root->pp_children[i],
 108                                  b_delete_items , VLC_FALSE );
 109         }
 110         else if( b_delete_items )
 111         {
 112             /* Delete the item here */
 113             playlist_DeleteFromItemId( p_playlist,
 114                                        p_root->pp_children[i]->i_id );
 115         }
 116     }
 117     return VLC_SUCCESS;
 118 }
 119
 120 /**
 121  * Remove all the children of a node and removes the node
 122  *
 123  * \param p_playlist the playlist
 124  * \param p_root the node
 125  * \param b_delete_items do we have to delete the children items ?
 126  * \return VLC_SUCCESS or an error
 127  */
 128 int playlist_NodeDelete( playlist_t *p_playlist, playlist_item_t *p_root,
 129                          vlc_bool_t b_delete_items, vlc_bool_t b_force )
 130 {
 131     int i;
 132
 133     if( p_root->i_children == -1 )
 134     {
 135         return VLC_EGENERIC;
 136     }
 137
 138     /* Delete the children */
 139     for( i =  p_root->i_children - 1 ; i >= 0; i-- )
 140     {
 141         if( p_root->pp_children[i]->i_children > -1 )
 142         {
 143             playlist_NodeDelete( p_playlist, p_root->pp_children[i],
 144                                  b_delete_items , b_force );
 145         }
 146         else if( b_delete_items )
 147         {
 148             playlist_DeleteFromItemId( p_playlist,
 149                                        p_root->pp_children[i]->i_id );
 150         }
 151     }
 152     /* Delete the node */
 153     if( p_root->i_flags & PLAYLIST_RO_FLAG && !b_force )
 154     {
 155     }
 156     else
 157     {
 158         var_SetInteger( p_playlist, "item-deleted", p_root->p_input->i_id );
 159         for( i = 0 ; i< p_playlist->i_all_size; i ++ )
 160         {
 161             if( p_playlist->pp_all_items[i]->p_input->i_id ==
 162                                p_root->p_input->i_id )
 163             {
 164                 REMOVE_ELEM( p_playlist->pp_all_items, p_playlist->i_all_size,
 165                              i );
 166                 break;
 167             }
 168         }
 169
 170         /* Remove the item from its parent */
 171         if( p_root->p_parent )
 172         {
 173             playlist_NodeRemoveItem( p_playlist, p_root, p_root->p_parent );
 174         }
 175
 176         playlist_ItemDelete( p_root );
 177     }
 178     return VLC_SUCCESS;
 179 }
 180
 181
 182 /**
 183  * Adds an item to the children of a node
 184  *
 185  * \param p_playlist the playlist
 186  * \param p_item the item to append
 187  * \param p_parent the parent node
 188  * \return VLC_SUCCESS or an error
 189  */
 190 int playlist_NodeAppend( playlist_t *p_playlist,
 191                          playlist_item_t *p_item,
 192                          playlist_item_t *p_parent )
 193 {
 194     return playlist_NodeInsert( p_playlist, p_item, p_parent, -1 );
 195 }
 196
 197 int playlist_NodeInsert( playlist_t *p_playlist,
 198                          playlist_item_t *p_item,
 199                          playlist_item_t *p_parent,
 200                          int i_position )
 201 {
 202    assert( p_parent && p_parent->i_children != -1 );
 203    if( i_position == -1 ) i_position = p_parent->i_children ;
 204
 205    INSERT_ELEM( p_parent->pp_children,
 206                 p_parent->i_children,
 207                 i_position,
 208                 p_item );
 209    p_item->p_parent = p_parent;
 210    return VLC_SUCCESS;
 211 }
 212
 213 /**
 214  * Deletes an item from the children of a node
 215  *
 216  * \param p_playlist the playlist
 217  * \param p_item the item to remove
 218  * \param p_parent the parent node
 219  * \return VLC_SUCCESS or an error
 220  */
 221 int playlist_NodeRemoveItem( playlist_t *p_playlist,
 222                         playlist_item_t *p_item,
 223                         playlist_item_t *p_parent )
 224 {
 225    int i;
 226    for( i= 0; i< p_parent->i_children ; i++ )
 227    {
 228        if( p_parent->pp_children[i] == p_item )
 229        {
 230            REMOVE_ELEM( p_parent->pp_children, p_parent->i_children, i );
 231        }
 232    }
 233
 234    return VLC_SUCCESS;
 235 }
 236
 237
 238 /**
 239  * Count the children of a node
 240  *
 241  * \param p_playlist the playlist
 242  * \param p_node the node
 243  * \return the number of children
 244  */
 245 int playlist_NodeChildrenCount( playlist_t *p_playlist, playlist_item_t*p_node)
 246 {
 247     int i;
 248     int i_nb = 0;
 249     if( p_node->i_children == -1 )
 250         return 0;
 251
 252     for( i=0 ; i< p_node->i_children;i++ )
 253     {
 254         if( p_node->pp_children[i]->i_children == -1 )
 255             i_nb++;
 256         else
 257             i_nb += playlist_NodeChildrenCount( p_playlist,
 258                                                 p_node->pp_children[i] );
 259     }
 260     return i_nb;
 261 }
 262
 263 /**
 264  * Search a child of a node by its name
 265  *
 266  * \param p_node the node
 267  * \param psz_search the name of the child to search
 268  * \return the child item or NULL if not found or error
 269  */
 270 playlist_item_t *playlist_ChildSearchName( playlist_item_t *p_node,
 271                                            const char *psz_search )
 272 {
 273     int i;
 274
 275     if( p_node->i_children < 0 )
 276     {
 277          return NULL;
 278     }
 279     for( i = 0 ; i< p_node->i_children; i++ )
 280     {
 281         if( !strcmp( p_node->pp_children[i]->p_input->psz_name, psz_search ) )
 282         {
 283             return p_node->pp_children[i];
 284         }
 285     }
 286     return NULL;
 287 }
 288
 289
 290 void playlist_NodesCreateForSD( playlist_t *p_playlist, char *psz_name,
 291                                 playlist_item_t **pp_node_cat,
 292                                 playlist_item_t **pp_node_one )
 293 {
 294     *pp_node_cat = playlist_NodeCreate( p_playlist, psz_name,
 295                                         p_playlist->p_root_category );
 296     (*pp_node_cat)->i_flags |= PLAYLIST_RO_FLAG;
 297     (*pp_node_cat)->i_flags |= PLAYLIST_SKIP_FLAG;
 298
 299     *pp_node_one = playlist_NodeCreate( p_playlist, psz_name,
 300                                         p_playlist->p_root_onelevel );
 301     (*pp_node_one)->i_flags |= PLAYLIST_RO_FLAG;
 302     (*pp_node_one)->i_flags |= PLAYLIST_SKIP_FLAG;
 303
 304     (*pp_node_one)->p_input->i_id = (*pp_node_cat)->p_input->i_id;
 305 }
 306
 307 playlist_item_t * playlist_GetPreferredNode( playlist_t *p_playlist,
 308                                              playlist_item_t *p_node )
 309 {
 310     int i;
 311     if( p_node->p_parent == p_playlist->p_root_category )
 312     {
 313         if( p_playlist->b_always_tree ||
 314             p_node->p_input->b_prefers_tree ) return p_node;
 315         for( i = 0 ; i< p_playlist->p_root_onelevel->i_children; i++ )
 316         {
 317             if( p_playlist->p_root_onelevel->pp_children[i]->p_input->i_id ==
 318                     p_node->p_input->i_id )
 319                 return p_playlist->p_root_onelevel->pp_children[i];
 320         }
 321     }
 322     else if( p_node->p_parent == p_playlist->p_root_onelevel )
 323     {
 324         if( p_playlist->b_never_tree || !p_node->p_input->b_prefers_tree )
 325             return p_node;
 326         for( i = 0 ; i< p_playlist->p_root_category->i_children; i++ )
 327         {
 328             if( p_playlist->p_root_category->pp_children[i]->p_input->i_id ==
 329                     p_node->p_input->i_id )
 330                 return p_playlist->p_root_category->pp_children[i];
 331         }
 332     }
 333     return NULL;
 334 }
 335
 336 /**********************************************************************
 337  * Tree walking functions
 338  **********************************************************************/
 339
 340 playlist_item_t *playlist_GetLastLeaf(playlist_t *p_playlist,
 341                                       playlist_item_t *p_root )
 342 {
 343     int i;
 344     playlist_item_t *p_item;
 345     for ( i = p_root->i_children - 1; i >= 0; i-- )
 346     {
 347         if( p_root->pp_children[i]->i_children == -1 )
 348             return p_root->pp_children[i];
 349         else if( p_root->pp_children[i]->i_children > 0)
 350         {
 351              p_item = playlist_GetLastLeaf( p_playlist,
 352                                             p_root->pp_children[i] );
 353             if ( p_item != NULL )
 354                 return p_item;
 355         }
 356         else if( i == 0 )
 357             return NULL;
 358     }
 359     return NULL;
 360 }
 361
 362 /**
 363  * Finds the next item to play
 364  *
 365  * \param p_playlist the playlist
 366  * \param p_root the root node
 367  * \param p_item the previous item  (NULL if none )
 368  * \return the next item to play, or NULL if none found
 369  */
 370 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
 371                                        playlist_item_t *p_root,
 372                                        playlist_item_t *p_item )
 373 {
 374     playlist_item_t *p_next;
 375
 376     assert( p_root && p_root->i_children != -1 );
 377
 378 #ifdef PLAYLIST_DEBUG
 379     if( p_item != NULL )
 380         msg_Dbg( p_playlist, "finding next of %s within %s",
 381                         p_item->p_input->psz_name,  p_root->p_input->psz_name );
 382     else
 383         msg_Dbg( p_playlist, "finding something to play within %s",
 384                          p_root->p_input->psz_name );
 385 #endif
 386
 387
 388     /* Now, walk the tree until we find a suitable next item */
 389     p_next = p_item;
 390     do
 391     {
 392         p_next = GetNextItem( p_playlist, p_root, p_next );
 393     } while ( p_next && p_next != p_root && p_next->i_children != -1 );
 394
 395 #ifdef PLAYLIST_DEBUG
 396     if( p_next == NULL )
 397         msg_Dbg( p_playlist, "At end of node" );
 398 #endif
 399     return p_next;
 400 }
 401
 402 playlist_item_t *playlist_GetNextEnabledLeaf( playlist_t *p_playlist,
 403                                               playlist_item_t *p_root,
 404                                               playlist_item_t *p_item )
 405 {
 406     playlist_item_t *p_next;
 407
 408 #ifdef PLAYLIST_DEBUG
 409     if( p_item != NULL )
 410         msg_Dbg( p_playlist, "finding next of %s within %s",
 411                         p_item->p_input->psz_name,  p_root->p_input->psz_name );
 412     else
 413         msg_Dbg( p_playlist, "finding something to play within %s",
 414                          p_root->p_input->psz_name );
 415 #endif
 416
 417     assert( p_root && p_root->i_children != -1 );
 418
 419     /* Now, walk the tree until we find a suitable next item */
 420     p_next = p_item;
 421     do
 422     {
 423         p_next = GetNextItem( p_playlist, p_root, p_next );
 424     } while ( p_next && p_next != p_root &&
 425               !( p_next->i_children == -1 &&
 426               !(p_next->i_flags & PLAYLIST_DBL_FLAG) ) );
 427
 428 #ifdef PLAYLIST_DEBUG
 429     if( p_next == NULL )
 430         msg_Dbg( p_playlist, "At end of node" );
 431 #endif
 432     return p_next;
 433 }
 434
 435 /**
 436  * Finds the previous item to play
 437  *
 438  * \param p_playlist the playlist
 439  * \param p_root the root node
 440  * \param p_item the previous item  (NULL if none )
 441  * \return the next item to play, or NULL if none found
 442  */
 443 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
 444                                        playlist_item_t *p_root,
 445                                        playlist_item_t *p_item )
 446 {
 447     playlist_item_t *p_prev;
 448
 449 #ifdef PLAYLIST_DEBUG
 450     if( p_item != NULL )
 451         msg_Dbg( p_playlist, "finding previous of %s within %s",
 452                         p_item->p_input->psz_name,  p_root->p_input->psz_name );
 453     else
 454         msg_Dbg( p_playlist, "finding previous to play within %s",
 455                          p_root->p_input->psz_name );
 456 #endif
 457     assert( p_root && p_root->i_children != -1 );
 458
 459     /* Now, walk the tree until we find a suitable previous item */
 460     p_prev = p_item;
 461     do
 462     {
 463         p_prev = GetPrevItem( p_playlist, p_root, p_prev );
 464     } while ( p_prev && p_prev != p_root && p_prev->i_children != -1 );
 465
 466 #ifdef PLAYLIST_DEBUG
 467     if( p_prev == NULL )
 468         msg_Dbg( p_playlist, "At beginning of node" );
 469 #endif
 470     return p_prev;
 471 }
 472
 473 /************************************************************************
 474  * Following functions are local
 475  ***********************************************************************/
 476
 477 /**
 478  * Get the next item in the tree
 479  * If p_item is NULL, return the first child of root
 480  **/
 481 playlist_item_t *GetNextItem( playlist_t *p_playlist,
 482                               playlist_item_t *p_root,
 483                               playlist_item_t *p_item )
 484 {
 485     playlist_item_t *p_parent;
 486     int i;
 487
 488     /* Node with children, get the first one */
 489     if( p_item && p_item->i_children > 0 )
 490         return p_item->pp_children[0];
 491
 492     if( p_item != NULL )
 493         p_parent = p_item->p_parent;
 494     else
 495         p_parent = p_root;
 496
 497     for( i= 0 ; i < p_parent->i_children ; i++ )
 498     {
 499         if( p_item == NULL || p_parent->pp_children[i] == p_item )
 500         {
 501             if( p_item == NULL )
 502                 i = -1;
 503
 504             if( i+1 >= p_parent->i_children )
 505             {
 506                 /* Was already the last sibling. Look for uncles */
 507                 PL_DEBUG( "Current item is the last of the node,"
 508                           "looking for uncle from %s",
 509                            p_parent->p_input->psz_name );
 510
 511                 if( p_parent == p_root )
 512                 {
 513                     PL_DEBUG( "already at root" );
 514                     return NULL;
 515                 }
 516                 return GetNextUncle( p_playlist, p_item, p_root );
 517             }
 518             else
 519             {
 520                 return  p_parent->pp_children[i+1];
 521             }
 522         }
 523     }
 524     msg_Err( p_playlist, "I should not be here" );
 525     return NULL;
 526 }
 527
 528 playlist_item_t *GetNextUncle( playlist_t *p_playlist, playlist_item_t *p_item,
 529                                playlist_item_t *p_root )
 530 {
 531     playlist_item_t *p_parent = p_item->p_parent;
 532     playlist_item_t *p_grandparent;
 533     vlc_bool_t b_found = VLC_FALSE;
 534
 535     if( p_parent != NULL )
 536     {
 537         p_grandparent = p_parent->p_parent;
 538         while( 1 )
 539         {
 540             int i;
 541             for( i = 0 ; i< p_grandparent->i_children ; i++ )
 542             {
 543                 if( p_parent == p_grandparent->pp_children[i] )
 544                 {
 545                     PL_DEBUG( "parent %s found as child %i of grandparent %s",
 546                               p_parent->p_input->psz_name, i,
 547                               p_grandparent->p_input->psz_name );
 548                     b_found = VLC_TRUE;
 549                     break;
 550                 }
 551             }
 552             if( b_found && i + 1 < p_grandparent->i_children )
 553             {
 554                     return p_grandparent->pp_children[i+1];
 555             }
 556             /* Not found at root */
 557             if( p_grandparent == p_root )
 558             {
 559                 return NULL;
 560             }
 561             else
 562             {
 563                 p_parent = p_grandparent;
 564                 p_grandparent = p_parent->p_parent;
 565             }
 566         }
 567     }
 568     /* We reached root */
 569     return NULL;
 570 }
 571
 572 playlist_item_t *GetPrevUncle( playlist_t *p_playlist, playlist_item_t *p_item,
 573                                playlist_item_t *p_root )
 574 {
 575     playlist_item_t *p_parent = p_item->p_parent;
 576     playlist_item_t *p_grandparent;
 577     vlc_bool_t b_found = VLC_FALSE;
 578
 579     if( p_parent != NULL )
 580     {
 581         p_grandparent = p_parent->p_parent;
 582         while( 1 )
 583         {
 584             int i;
 585             for( i = p_grandparent->i_children -1 ; i >= 0; i-- )
 586             {
 587                 if( p_parent == p_grandparent->pp_children[i] )
 588                 {
 589                     b_found = VLC_TRUE;
 590                     break;
 591                 }
 592             }
 593             if( b_found && i - 1 > 0 )
 594             {
 595                 return p_grandparent->pp_children[i-1];
 596             }
 597             /* Not found at root */
 598             if( p_grandparent == p_root )
 599             {
 600                 return NULL;
 601             }
 602             else
 603             {
 604                 p_parent = p_grandparent;
 605                 p_grandparent = p_parent->p_parent;
 606             }
 607         }
 608     }
 609     /* We reached root */
 610     return NULL;
 611 }
 612
 613
 614 /* Recursively search the tree for previous item */
 615 playlist_item_t *GetPrevItem( playlist_t *p_playlist,
 616                               playlist_item_t *p_root,
 617                               playlist_item_t *p_item )
 618 {
 619     playlist_item_t *p_parent;
 620     int i;
 621
 622     /* Node with children, get the last one */
 623     if( p_item && p_item->i_children > 0 )
 624         return p_item->pp_children[p_item->i_children - 1];
 625
 626     /* Last child of its parent ? */
 627     if( p_item != NULL )
 628         p_parent = p_item->p_parent;
 629     else
 630     {
 631         msg_Err( p_playlist, "Get the last one" );
 632         abort();
 633     };
 634
 635     for( i = p_parent->i_children -1 ; i >= 0 ;  i-- )
 636     {
 637         if( p_parent->pp_children[i] == p_item )
 638         {
 639             if( i-1 < 0 )
 640             {
 641                 /* Was already the first sibling. Look for uncles */
 642                 PL_DEBUG( "Current item is the first of the node,"
 643                           "looking for uncle from %s",
 644                           p_parent->p_input->psz_name );
 645                 return GetPrevUncle( p_playlist, p_item, p_root );
 646             }
 647             else
 648             {
 649                 return p_parent->pp_children[i-1];
 650             }
 651         }
 652     }
 653     msg_Err( p_playlist, "I should not be here" );
 654     return NULL;
 655 }
 656
 657 /* Dump the contents of a node */
 658 void playlist_NodeDump( playlist_t *p_playlist, playlist_item_t *p_item,
 659                         int i_level )
 660 {
 661     char str[512];
 662     int i;
 663
 664     if( i_level == 1 )
 665     {
 666         msg_Dbg( p_playlist, "%s (%i)",
 667                         p_item->p_input->psz_name, p_item->i_children );
 668     }
 669
 670     if( p_item->i_children == -1 )
 671     {
 672         return;
 673     }
 674
 675     for( i = 0; i< p_item->i_children; i++ )
 676     {
 677         memset( str, 32, 512 );
 678         sprintf( str + 2 * i_level , "%s (%i)",
 679                                 p_item->pp_children[i]->p_input->psz_name,
 680                                 p_item->pp_children[i]->i_children );
 681         msg_Dbg( p_playlist, "%s",str );
 682         if( p_item->pp_children[i]->i_children >= 0 )
 683         {
 684             playlist_NodeDump( p_playlist, p_item->pp_children[i],
 685                               i_level + 1 );
 686         }
 687     }
 688     return;
 689 }