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