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.26 2004/01/25 18:17:08 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 **pp_categories;
  80                                /**< Pointer to the first info category */
  81     int        i_status;       /**< unused yet */
  82     int        i_nb_played;    /**< How many times was this item played ? */
  83     vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
  84                                 * be deleted after playback. True mean
  85                                 * that this item is to be deleted
  86                                 * after playback, false otherwise */
  87     vlc_bool_t b_enabled;      /**< Indicates whether this item is to be
  88                                 * played or skipped */
  89     int        i_group;         /**< Which group does this item belongs to ? */
  90     int        i_id;           /**< Unique id to track this item */
  91 };
  92
  93 /**
  94  * playlist group
  95  * \see playlist_t
  96  */
  97 struct playlist_group_t
  98 {
  99     char *   psz_name;        /**< name of the group */
 100     int      i_id;            /**< Identifier for the group */
 101 };
 102
 103 /**
 104  * Playlist status
 105  */
 106 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
 107
 108 /**
 109  * Structure containing information about the playlist
 110  */
 111 struct playlist_t
 112 {
 113     VLC_COMMON_MEMBERS
 114 /**
 115    \name playlist_t
 116    These members are uniq to playlist_t
 117 */
 118 /*@{*/
 119     int                   i_index;  /**< current index into the playlist */
 120     playlist_status_t     i_status; /**< current status of playlist */
 121     int                   i_size;   /**< total size of the list */
 122     int                   i_enabled; /**< How many items are enabled ? */
 123     playlist_item_t **    pp_items; /**< array of pointers to the
 124                                      * playlist items */
 125     int                   i_groups; /**< How many groups are in the playlist */
 126     playlist_group_t **   pp_groups;/**< array of pointers to the playlist
 127                                      * groups */
 128     int                   i_last_group; /**< Maximal group id given */
 129     input_thread_t *      p_input;  /**< the input thread ascosiated
 130                                      * with the current item */
 131     int                   i_last_id; /**< Last id to an item */
 132     int                   i_sort; /**< Last sorting applied to the playlist */
 133     int                   i_order; /**< Last ordering applied to the playlist */
 134     /*@}*/
 135 };
 136
 137 #define SORT_ID 0
 138 #define SORT_TITLE 1
 139 #define SORT_AUTHOR 2
 140 #define SORT_GROUP 3
 141 #define SORT_RANDOM 4
 142 #define SORT_DURATION 5
 143
 144 #define ORDER_NORMAL 0
 145 #define ORDER_REVERSE 1
 146
 147 #define PLAYLIST_TYPE_MANUAL 1
 148 #define PLAYLIST_TYPE_SAP 2
 149
 150 /*****************************************************************************
 151  * Prototypes
 152  *****************************************************************************/
 153 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
 154 playlist_t * __playlist_Create   ( vlc_object_t * );
 155 void           playlist_Destroy  ( playlist_t * );
 156
 157 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
 158 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
 159 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
 160 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
 161 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
 162 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
 163 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
 164
 165 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
 166
 167
 168 /* Item functions */
 169 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int ) );
 170 VLC_EXPORT( int,  playlist_AddWDuration, ( playlist_t *, const char *, const char *, int, int, mtime_t ) );
 171 /* For internal use. Do not use this one anymore */
 172 VLC_EXPORT( int,  playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
 173 VLC_EXPORT( int,  playlist_Clear, ( playlist_t * ) );
 174 VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
 175 VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, int ) );
 176 VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, int ) );
 177 VLC_EXPORT( int,  playlist_DisableGroup, ( playlist_t *, int ) );
 178 VLC_EXPORT( int,  playlist_EnableGroup, ( playlist_t *, int ) );
 179
 180 /* Basic item informations accessors */
 181 VLC_EXPORT( int, playlist_SetGroup, (playlist_t *, int, int ) );
 182 VLC_EXPORT( int, playlist_SetName, (playlist_t *, int, char * ) );
 183 VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int, mtime_t ) );
 184
 185 /* Item search functions */
 186 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
 187 VLC_EXPORT( playlist_item_t *, playlist_GetItemById, (playlist_t *, int) );
 188
 189
 190 /* Group management functions */
 191 VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) );
 192 VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) );
 193 VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) );
 194 VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
 195
 196 /* Info functions */
 197 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
 198 VLC_EXPORT( char * , playlist_GetItemInfo, ( playlist_item_t * , const char *, const char *) );
 199
 200 VLC_EXPORT( item_info_category_t*, playlist_GetCategory, ( playlist_t *, int, const char *) );
 201 VLC_EXPORT( item_info_category_t*, playlist_GetItemCategory, ( playlist_item_t *, const char *) );
 202
 203 VLC_EXPORT( item_info_category_t*, playlist_CreateCategory, ( playlist_t *, int, const char *) );
 204 VLC_EXPORT( item_info_category_t*, playlist_CreateItemCategory, ( playlist_item_t *, const char *) );
 205
 206 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
 207 VLC_EXPORT( int, playlist_AddItemInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
 208
 209 /* Option functions */
 210 VLC_EXPORT( int, playlist_AddOption, (playlist_t *, int, const char *, ...) );
 211 VLC_EXPORT( int, playlist_AddItemOption, (playlist_item_t *, const char *, ...) );
 212
 213 /* Playlist sorting */
 214 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
 215 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
 216 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
 217 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
 218 VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int, int) );
 219 VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
 220
 221 /* Load/Save */
 222 VLC_EXPORT( int,  playlist_Import, ( playlist_t *, const char * ) );
 223 VLC_EXPORT( int,  playlist_Export, ( playlist_t *, const char *, const char * ) );
 224
 225 /**
 226  *  tell if a playlist is currently playing.
 227  *  \param p_playlist the playlist to check
 228  *  \return true if playlist is playing, false otherwise
 229  */
 230 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
 231 {
 232     vlc_bool_t b_playing;
 233
 234     vlc_mutex_lock( &p_playlist->object_lock );
 235     b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
 236     vlc_mutex_unlock( &p_playlist->object_lock );
 237
 238     return( b_playing );
 239 }
 240
 241 /**
 242  *  tell if a playlist is currently empty
 243  *  \param p_playlist the playlist to check
 244  *  \return true if the playlist is empty, false otherwise
 245  */
 246 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
 247 {
 248     vlc_bool_t b_empty;
 249
 250     vlc_mutex_lock( &p_playlist->object_lock );
 251     b_empty = p_playlist->i_size == 0;
 252     vlc_mutex_unlock( &p_playlist->object_lock );
 253
 254     return( b_empty );
 255 }
 256
 257 /**
 258  * @}
 259  */