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 #include "input/input_internal.h"
  35
  36 struct playlist_preparse_t
  37 {
  38     VLC_COMMON_MEMBERS
  39     vlc_mutex_t     lock;
  40     int             i_waiting;
  41     input_item_t  **pp_waiting;
  42 };
  43
  44 typedef struct preparse_item_t
  45 {
  46     input_item_t *p_item;
  47     vlc_bool_t   b_fetch_art;
  48 } preparse_item_t;
  49
  50 struct playlist_fetcher_t
  51 {
  52     VLC_COMMON_MEMBERS
  53     vlc_mutex_t     lock;
  54     int             i_art_policy;
  55     int             i_waiting;
  56     preparse_item_t *p_waiting;
  57
  58     DECL_ARRAY(playlist_album_t) albums;
  59 };
  60
  61 typedef struct playlist_archived_services_discovery_t {
  62         services_discovery_t * p_sd; /* The service discovery module */
  63         playlist_item_t      * p_cat;/* Corresponding item in the category view */
  64         playlist_item_t      * p_one;/* Corresponding item in the one level view */
  65 } playlist_archived_services_discovery_t;
  66
  67 struct playlist_internal_t {
  68     struct playlist_archived_services_discovery_t
  69                 **pp_asds; /**< Loaded service discovery modules */
  70     int         i_asds;    /**< Number of service discovery modules */
  71 };
  72
  73
  74 /*****************************************************************************
  75  * Prototypes
  76  *****************************************************************************/
  77
  78 /* Global thread */
  79 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
  80 void        __playlist_ThreadCreate   ( vlc_object_t * );
  81 int           playlist_ThreadDestroy  ( playlist_t * );
  82
  83 /* Creation/Deletion */
  84 playlist_t *playlist_Create   ( vlc_object_t * );
  85 void        playlist_Destroy  ( playlist_t * );
  86
  87 /* Engine */
  88 void playlist_MainLoop( playlist_t * );
  89 void playlist_LastLoop( playlist_t * );
  90 void playlist_PreparseLoop( playlist_preparse_t * );
  91 void playlist_FetcherLoop( playlist_fetcher_t * );
  92
  93 void ResetCurrentlyPlaying( playlist_t *, vlc_bool_t, playlist_item_t * );
  94
  95 /* Control */
  96 playlist_item_t * playlist_NextItem  ( playlist_t * );
  97 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
  98
  99 /* Load/Save */
 100 int playlist_MLLoad( playlist_t *p_playlist );
 101 int playlist_MLDump( playlist_t *p_playlist );
 102
 103 /**********************************************************************
 104  * Item management
 105  **********************************************************************/
 106
 107 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
 108                              int i_node_id, vlc_bool_t b_signal );
 109
 110 /* Tree walking */
 111 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
 112                                     playlist_item_t *p_node,
 113                                     playlist_item_t ***ppp_items );
 114 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
 115                                     playlist_item_t *p_root,
 116                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
 117 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
 118                                     playlist_item_t *p_root,
 119                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
 120 playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
 121                                     playlist_item_t *p_root );
 122
 123 int playlist_DeleteFromItemId( playlist_t*, int );
 124 int playlist_ItemDelete ( playlist_item_t * );
 125
 126 /**
 127  * @}
 128  */
 129
 130 #define PLAYLIST_DEBUG 1
 131 //#undef PLAYLIST_DEBUG2
 132
 133 #ifdef PLAYLIST_DEBUG
 134  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 135  #ifdef PLAYLIST_DEBUG2
 136   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 137  #else
 138   #define PL_DEBUG2( msg, args... ) {}
 139  #endif
 140 #else
 141  #define PL_DEBUG( msg, args ... ) {}
 142  #define PL_DEBUG2( msg, args... ) {}
 143 #endif
 144
 145 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"