git.sesse.net Git - vlc/blob - include/vlc_playlist.h

   1 /*****************************************************************************
   2  * vlc_playlist.h : Playlist functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   5  * $Id: vlc_playlist.h,v 1.27 2004/01/29 17:51:07 zorglub Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /**
  25  *  \file
  26  *  This file contain structures and function prototypes related
  27  *  to the playlist in vlc
  28  */
  29
  30 /**
  31  * \defgroup vlc_playlist Playlist
  32  * Brief description. Longer description
  33  * @{
  34  */
  35
  36 /**
  37  * Playlist info item
  38  * \see playlist_item_t
  39  */
  40
  41 struct item_info_t
  42 {
  43     char * psz_name;            /**< Name of this info */
  44     char * psz_value;           /**< Value of the info */
  45 };
  46
  47 /**
  48  * playlist item info category
  49  * \see playlist_item_t
  50  * \see item_info_t
  51  */
  52 struct item_info_category_t
  53 {
  54     char * psz_name;            /**< Name of this category */
  55     int i_infos;                /**< Number of infos in the category */
  56     item_info_t **pp_infos;     /**< Pointer to an array of infos */
  57 };
  58
  59 /**
  60  * playlist export helper structure
  61  */
  62 struct playlist_export_t
  63 {
  64     char *psz_filename;
  65     FILE *p_file;
  66 };
  67
  68 /**
  69  * playlist item
  70  * \see playlist_t
  71  */
  72 struct playlist_item_t
  73 {
  74     char *     psz_name;       /**< text describing this item */
  75     char *     psz_uri;        /**< mrl of this item */
  76     mtime_t    i_duration;     /**< A hint about the duration of this
  77                                 * item, in milliseconds*/
  78     int        i_categories;   /**< Number of info categories */
  79     item_info_category_t **
  80                pp_categories;  /**< Pointer to the first info category */
  81     int        i_options;      /**< Number of options */
  82     char **    ppsz_options;   /**< Array of options */
  83     int        i_nb_played;    /**< How many times was this item played ? */
  84     vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
  85                                 * be deleted after playback. True mean
  86                                 * that this item is to be deleted
  87                                 * after playback, false otherwise */
  88     vlc_bool_t b_enabled;      /**< Indicates whether this item is to be
  89                                 * played or skipped */
  90     int        i_group;        /**< Which group does this item belongs to ? */
  91     int        i_id;           /**< Unique id to track this item */
  92     vlc_mutex_t lock;          /**< Item cannot be changed without this lock */
  93 };
  94
  95 /**
  96  * playlist group
  97  * \see playlist_t
  98  */
  99 struct playlist_group_t
 100 {
 101     char *   psz_name;        /**< name of the group */
 102     int      i_id;            /**< Identifier for the group */
 103 };
 104
 105 /**
 106  * Playlist status
 107  */
 108 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 109
 110 /**
 111  * Structure containing information about the playlist
 112  */
 113 struct playlist_t
 114 {
 115     VLC_COMMON_MEMBERS
 116 /**
 117    \name playlist_t
 118    These members are uniq to playlist_t
 119 */
 120 /*@{*/
 121     int                   i_index;  /**< current index into the playlist */
 122     playlist_status_t     i_status; /**< current status of playlist */
 123     int                   i_size;   /**< total size of the list */
 124     int                   i_enabled; /**< How many items are enabled ? */
 125     playlist_item_t **    pp_items; /**< array of pointers to the
 126                                      * playlist items */
 127     int                   i_groups; /**< How many groups are in the playlist */
 128     playlist_group_t **   pp_groups;/**< array of pointers to the playlist
 129                                      * groups */
 130     int                   i_last_group; /**< Maximal group id given */
 131     input_thread_t *      p_input;  /**< the input thread ascosiated
 132                                      * with the current item */
 133     int                   i_last_id; /**< Last id to an item */
 134     int                   i_sort; /**< Last sorting applied to the playlist */
 135     int                   i_order; /**< Last ordering applied to the playlist */
 136     /*@}*/
 137 };
 138
 139 #define SORT_ID 0
 140 #define SORT_TITLE 1
 141 #define SORT_AUTHOR 2
 142 #define SORT_GROUP 3
 143 #define SORT_RANDOM 4
 144 #define SORT_DURATION 5
 145
 146 #define ORDER_NORMAL 0
 147 #define ORDER_REVERSE 1
 148
 149 #define PLAYLIST_TYPE_MANUAL 1
 150 #define PLAYLIST_TYPE_SAP 2
 151
 152 /*****************************************************************************
 153  * Prototypes
 154  *****************************************************************************/
 155 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
 156 playlist_t * __playlist_Create   ( vlc_object_t * );
 157 void           playlist_Destroy  ( playlist_t * );
 158
 159 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
 160 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
 161 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
 162 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
 163 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
 164 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
 165 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
 166
 167 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
 168
 169
 170 /* Item management functions */
 171 #define playlist_AddItem(p,pi,i1,i2) playlist_ItemAdd(p,pi,i1,i2)
 172 #define playlist_ItemNew( a , b, c ) __playlist_ItemNew(VLC_OBJECT(a) , b , c )
 173 VLC_EXPORT( playlist_item_t* , __playlist_ItemNew, ( vlc_object_t *,const char *,const char * ) );
 174 VLC_EXPORT( void, playlist_ItemDelete, ( playlist_item_t * ) );
 175 VLC_EXPORT( int,  playlist_ItemAdd, ( playlist_t *, playlist_item_t *, int, int ) );
 176
 177 /* Simple add/remove funcctions */
 178 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
 179 VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, const char **,int ) );
 180
 181
 182 VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
 183 VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
 184 VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, int ) );
 185 VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, int ) );
 186 VLC_EXPORT( int,  playlist_DisableGroup, ( playlist_t *, int ) );
 187 VLC_EXPORT( int,  playlist_EnableGroup, ( playlist_t *, int ) );
 188
 189 /* Basic item informations accessors */
 190 VLC_EXPORT( int, playlist_ItemSetGroup, (playlist_item_t *, int ) );
 191 VLC_EXPORT( int, playlist_ItemSetName, (playlist_item_t *,  char * ) );
 192 VLC_EXPORT( int, playlist_ItemSetDuration, (playlist_item_t *, mtime_t ) );
 193
 194 VLC_EXPORT( int, playlist_SetGroup, (playlist_t * , int , int ) );
 195 VLC_EXPORT( int, playlist_SetName, (playlist_t *, int ,  char * ) );
 196 VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int , mtime_t ) );
 197
 198 /* Item search functions */
 199 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
 200 VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int) );
 201 VLC_EXPORT( playlist_item_t *, playlist_ItemGetByPos, (playlist_t *, int) );
 202
 203
 204 /* Group management functions */
 205 VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) );
 206 VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) );
 207 VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) );
 208 VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
 209
 210 /* Info functions */
 211 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
 212 VLC_EXPORT( char * , playlist_ItemGetInfo, ( playlist_item_t * , const char *, const char *) );
 213
 214 VLC_EXPORT( item_info_category_t*, playlist_GetCategory, ( playlist_t *, int, const char *) );
 215 VLC_EXPORT( item_info_category_t*, playlist_ItemGetCategory, ( playlist_item_t *, const char *) );
 216
 217 VLC_EXPORT( item_info_category_t*, playlist_CreateCategory, ( playlist_t *, int, const char *) );
 218 VLC_EXPORT( item_info_category_t*, playlist_ItemCreateCategory, ( playlist_item_t *, const char *) );
 219
 220 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
 221 VLC_EXPORT( int, playlist_ItemAddInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
 222
 223 /* Option functions */
 224 VLC_EXPORT( int, playlist_AddOption, (playlist_t *, int, const char *) );
 225 VLC_EXPORT( int, playlist_ItemAddOption, (playlist_item_t *, const char *) );
 226
 227 /* Playlist sorting */
 228 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
 229 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
 230 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
 231 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
 232 VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int, int) );
 233 VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
 234
 235 /* Load/Save */
 236 VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
 237 VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
 238
 239 /**
 240  *  tell if a playlist is currently playing.
 241  *  \param p_playlist the playlist to check
 242  *  \return true if playlist is playing, false otherwise
 243  */
 244 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
 245 {
 246     vlc_bool_t b_playing;
 247
 248     vlc_mutex_lock( &p_playlist->object_lock );
 249     b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
 250     vlc_mutex_unlock( &p_playlist->object_lock );
 251
 252     return( b_playing );
 253 }
 254
 255 /**
 256  *  tell if a playlist is currently empty
 257  *  \param p_playlist the playlist to check
 258  *  \return true if the playlist is empty, false otherwise
 259  */
 260 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
 261 {
 262     vlc_bool_t b_empty;
 263
 264     vlc_mutex_lock( &p_playlist->object_lock );
 265     b_empty = p_playlist->i_size == 0;
 266     vlc_mutex_unlock( &p_playlist->object_lock );
 267
 268     return( b_empty );
 269 }
 270
 271 /**
 272  * @}
 273  */