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 #ifndef __LIBVLC_PLAYLIST_INTERNAL_H
  26 # define __LIBVLC_PLAYLIST_INTERNAL_H 1
  27
  28 /**
  29  *  \file
  30  *  This file contain internal structures and function prototypes related
  31  *  to the playlist in vlc
  32  *
  33  * \defgroup vlc_playlist Playlist
  34  * @{
  35  */
  36
  37 #include "input/input_internal.h"
  38
  39 struct playlist_preparse_t
  40 {
  41     VLC_COMMON_MEMBERS
  42     vlc_mutex_t     lock;
  43     int             i_waiting;
  44     input_item_t  **pp_waiting;
  45 };
  46
  47 typedef struct preparse_item_t
  48 {
  49     input_item_t *p_item;
  50     vlc_bool_t   b_fetch_art;
  51 } preparse_item_t;
  52
  53 struct playlist_fetcher_t
  54 {
  55     VLC_COMMON_MEMBERS
  56     vlc_mutex_t     lock;
  57     int             i_art_policy;
  58     int             i_waiting;
  59     preparse_item_t *p_waiting;
  60
  61     DECL_ARRAY(playlist_album_t) albums;
  62 };
  63
  64 /*****************************************************************************
  65  * Prototypes
  66  *****************************************************************************/
  67
  68 /* Global thread */
  69 #define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
  70 void        __playlist_ThreadCreate   ( vlc_object_t * );
  71 int           playlist_ThreadDestroy  ( playlist_t * );
  72
  73 /* Creation/Deletion */
  74 playlist_t *playlist_Create   ( vlc_object_t * );
  75 void        playlist_Destroy  ( playlist_t * );
  76
  77 /* Engine */
  78 void playlist_MainLoop( playlist_t * );
  79 void playlist_LastLoop( playlist_t * );
  80 void playlist_PreparseLoop( playlist_preparse_t * );
  81 void playlist_FetcherLoop( playlist_fetcher_t * );
  82
  83 void ResetCurrentlyPlaying( playlist_t *, vlc_bool_t, playlist_item_t * );
  84
  85 /* Control */
  86 playlist_item_t * playlist_NextItem  ( playlist_t * );
  87 int playlist_PlayItem  ( playlist_t *, playlist_item_t * );
  88
  89 /* Load/Save */
  90 int playlist_MLLoad( playlist_t *p_playlist );
  91 int playlist_MLDump( playlist_t *p_playlist );
  92
  93 /**********************************************************************
  94  * Item management
  95  **********************************************************************/
  96
  97 void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
  98                              int i_node_id, vlc_bool_t b_signal );
  99
 100 /* Tree walking */
 101 int playlist_GetAllEnabledChildren( playlist_t *p_playlist,
 102                                     playlist_item_t *p_node,
 103                                     playlist_item_t ***ppp_items );
 104 playlist_item_t *playlist_GetNextLeaf( playlist_t *p_playlist,
 105                                     playlist_item_t *p_root,
 106                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
 107 playlist_item_t *playlist_GetPrevLeaf( playlist_t *p_playlist,
 108                                     playlist_item_t *p_root,
 109                                     playlist_item_t *, vlc_bool_t, vlc_bool_t );
 110 playlist_item_t *playlist_GetLastLeaf( playlist_t *p_playlist,
 111                                     playlist_item_t *p_root );
 112
 113 int playlist_DeleteFromItemId( playlist_t*, int );
 114 int playlist_ItemDelete ( playlist_item_t * );
 115
 116 /**
 117  * @}
 118  */
 119
 120 #define PLAYLIST_DEBUG 1
 121 //#undef PLAYLIST_DEBUG2
 122
 123 #ifdef PLAYLIST_DEBUG
 124  #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 125  #ifdef PLAYLIST_DEBUG2
 126   #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 127  #else
 128   #define PL_DEBUG2( msg, args... ) {}
 129  #endif
 130 #else
 131  #define PL_DEBUG( msg, args ... ) {}
 132  #define PL_DEBUG2( msg, args... ) {}
 133 #endif
 134
 135 #define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
 136 #endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */