1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999-2004 VideoLAN
5 * $Id: vlc_playlist.h,v 1.24 2004/01/11 00:45:06 zorglub Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
26 * This file contain structures and function prototypes related
27 * to the playlist in vlc
31 * \defgroup vlc_playlist Playlist
32 * Brief description. Longer description
38 * \see playlist_item_t
43 char * psz_name; /**< Name of this info */
44 char * psz_value; /**< Value of the info */
48 * playlist item info category
49 * \see playlist_item_t
52 struct item_info_category_t
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 */
60 * playlist export helper structure
62 struct playlist_export_t
72 struct playlist_item_t
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 */
97 struct playlist_group_t
99 char * psz_name; /**< name of the group */
100 int i_id; /**< Identifier for the group */
106 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
109 * Structure containing information about the playlist
116 These members are uniq to playlist_t
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
125 int i_groups; /**< How many groups are in the playlist */
126 playlist_group_t ** pp_groups;/**< array of pointers to the playlist
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 */
139 #define SORT_AUTHOR 2
141 #define SORT_RANDOM 4
143 #define ORDER_NORMAL 0
144 #define ORDER_REVERSE 1
146 #define PLAYLIST_TYPE_MANUAL 1
147 #define PLAYLIST_TYPE_SAP 2
149 /*****************************************************************************
151 *****************************************************************************/
152 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
153 playlist_t * __playlist_Create ( vlc_object_t * );
154 void playlist_Destroy ( playlist_t * );
156 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
157 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
158 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
159 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
160 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
161 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
162 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
164 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
168 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) );
169 VLC_EXPORT( int, playlist_AddWDuration, ( playlist_t *, const char *, const char *, int, int, mtime_t ) );
170 /* For internal use. Do not use this one anymore */
171 VLC_EXPORT( int, playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
172 VLC_EXPORT( int, playlist_Clear, ( playlist_t * ) );
173 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
174 VLC_EXPORT( int, playlist_Disable, ( playlist_t *, int ) );
175 VLC_EXPORT( int, playlist_Enable, ( playlist_t *, int ) );
176 VLC_EXPORT( int, playlist_DisableGroup, ( playlist_t *, int ) );
177 VLC_EXPORT( int, playlist_EnableGroup, ( playlist_t *, int ) );
179 /* Basic item informations accessors */
180 VLC_EXPORT( int, playlist_SetGroup, (playlist_t *, int, int ) );
181 VLC_EXPORT( int, playlist_SetName, (playlist_t *, int, char * ) );
182 VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int, mtime_t ) );
184 /* Item search functions */
185 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
186 VLC_EXPORT( playlist_item_t *, playlist_GetItemById, (playlist_t *, int) );
189 /* Group management functions */
190 VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) );
191 VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) );
192 VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) );
193 VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
196 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
197 VLC_EXPORT( char * , playlist_GetItemInfo, ( playlist_item_t * , const char *, const char *) );
199 VLC_EXPORT( item_info_category_t*, playlist_GetCategory, ( playlist_t *, int, const char *) );
200 VLC_EXPORT( item_info_category_t*, playlist_GetItemCategory, ( playlist_item_t *, const char *) );
202 VLC_EXPORT( item_info_category_t*, playlist_CreateCategory, ( playlist_t *, int, const char *) );
203 VLC_EXPORT( item_info_category_t*, playlist_CreateItemCategory, ( playlist_item_t *, const char *) );
205 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
206 VLC_EXPORT( int, playlist_AddItemInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
208 /* Option functions */
209 VLC_EXPORT( int, playlist_AddOption, (playlist_t *, int, const char *, ...) );
210 VLC_EXPORT( int, playlist_AddItemOption, (playlist_item_t *, const char *, ...) );
212 /* Playlist sorting */
213 #define playlist_SortID(p, i) playlist_Sort( p, SORT_ID, i)
214 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
215 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
216 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
217 VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) );
218 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
221 VLC_EXPORT( int, playlist_Import, ( playlist_t *, const char * ) );
222 VLC_EXPORT( int, playlist_Export, ( playlist_t *, const char *, const char * ) );
225 * tell if a playlist is currently playing.
226 * \param p_playlist the playlist to check
227 * \return true if playlist is playing, false otherwise
229 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
231 vlc_bool_t b_playing;
233 vlc_mutex_lock( &p_playlist->object_lock );
234 b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
235 vlc_mutex_unlock( &p_playlist->object_lock );
241 * tell if a playlist is currently empty
242 * \param p_playlist the playlist to check
243 * \return true if the playlist is empty, false otherwise
245 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
249 vlc_mutex_lock( &p_playlist->object_lock );
250 b_empty = p_playlist->i_size == 0;
251 vlc_mutex_unlock( &p_playlist->object_lock );