git.sesse.net Git - vlc/blob - src/playlist/playlist_internal.h

   1 /*****************************************************************************
   2  * playlist_internal.h : Functions for use by the playlist
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   5  * $Id: vlc_playlist.h 16505 2006-09-03 21:53:38Z zorglub $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Clément Stenac <zorglub@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /**
  26  *  \file
  27  *  This file contain internal structures and function prototypes related
  28  *  to the playlist in vlc
  29  *
  30  * \defgroup vlc_playlist Playlist
  31  * @{
  32  */
  33
  34 struct playlist_preparse_t
  35 {
  36     VLC_COMMON_MEMBERS
  37     vlc_mutex_t     lock;
  38     int             i_waiting;
  39     input_item_t  **pp_waiting;
  40 };
  41
  42 typedef struct preparse_item_t
  43 {
  44     input_item_t *p_item;
  45     vlc_bool_t   b_fetch_art;
  46 } preparse_item_t;
  47
  48 struct playlist_secondary_preparse_t
  49 {
  50     VLC_COMMON_MEMBERS
  51     vlc_mutex_t     lock;
  52     int             i_waiting;
  53     preparse_item_t *p_waiting;
  54 };
  55
  56 /*****************************************************************************
  57  * Prototypes
  58  *****************************************************************************/
  59
  60 /* Creation/Deletion */
  61 playlist_t *playlist_Create   ( vlc_object_t * );
  62 void        playlist_Destroy  ( playlist_t * );
  63
  64 /* Engine */
  65 void playlist_MainLoop( playlist_t * );
  66 void playlist_LastLoop( playlist_t * );
  67 void playlist_PreparseLoop( playlist_preparse_t * );
  68 void playlist_SecondaryPreparseLoop( playlist_secondary_preparse_t * );
  69
  70 /* Control */
  71 playlist_item_t * playlist_NextItem  ( playlist_t * );
  72 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
  73
  74 /* Load/Save */
  75 int playlist_MLLoad( playlist_t *p_playlist );
  76 int playlist_MLDump( playlist_t *p_playlist );
  77
  78 /**********************************************************************
  79  * Item management
  80  **********************************************************************/
  81
  82 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id, int i_node_id );
  83
  84 /* Tree walking */
  85 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
  86                                     playlist_item_t *p_node,
  87                                     playlist_item_t ***ppp_items );
  88 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
  89                                     playlist_item_t *p_root,
  90                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
  91 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
  92                                     playlist_item_t *p_root,
  93                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
  94 playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
  95                                     playlist_item_t *p_root );
  96
  97 /**
  98  * @}
  99  */
 100
 101 #define PLAYLIST_DEBUG 1
 102
 103 #ifdef PLAYLIST_DEBUG
 104 #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 105 #else
 106 #define PL_DEBUG( msg, args ... ) {}
 107 #endif
 108
 109 #define PLI_NAME( p ) p ? p->p_input->psz_name : "null"