1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
5 * $Id: vlc_playlist.h,v 1.19 2004/01/05 12:59:43 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 */
63 struct playlist_item_t
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 miliseconds*/
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 */
88 struct playlist_group_t
90 char * psz_name; /**< name of the group */
91 int i_id; /**< Identifier for the group */
97 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
100 * Structure containing information about the playlist
107 These members are uniq to playlist_t
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
116 int i_groups; /**< How many groups are in the playlist */
117 playlist_group_t ** pp_groups;/**< array of pointers to the playlist
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 */
127 #define SORT_AUTHOR 1
129 #define SORT_RANDOM 3
131 #define SORT_NORMAL 0
132 #define SORT_REVERSE 1
134 #define PLAYLIST_TYPE_MANUAL 1
135 #define PLAYLIST_TYPE_SAP 2
137 /*****************************************************************************
139 *****************************************************************************/
140 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
141 playlist_t * __playlist_Create ( vlc_object_t * );
142 void playlist_Destroy ( playlist_t * );
144 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
145 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
146 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
147 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
148 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
149 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
150 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
152 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
156 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int ) );
157 /* For internal use. Do not use this one anymore */
158 VLC_EXPORT( int, playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
159 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
160 VLC_EXPORT( int, playlist_Disable, ( playlist_t *, int ) );
161 VLC_EXPORT( int, playlist_Enable, ( playlist_t *, int ) );
162 VLC_EXPORT( int, playlist_DisableGroup, ( playlist_t *, int ) );
163 VLC_EXPORT( int, playlist_EnableGroup, ( playlist_t *, int ) );
165 /* Basic item informations accessors */
166 VLC_EXPORT( int, playlist_SetGroup, (playlist_t *, int, int ) );
167 VLC_EXPORT( int, playlist_SetName, (playlist_t *, int, char * ) );
168 VLC_EXPORT( int, playlist_SetDuration, (playlist_t *, int, int ) );
170 /* Item search functions */
171 VLC_EXPORT( int, playlist_GetPositionById, (playlist_t *, int) );
172 VLC_EXPORT( playlist_item_t *, playlist_GetItemById, (playlist_t *, int) );
175 /* Group management functions */
176 VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) );
177 VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) );
178 VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) );
179 VLC_EXPORT( int, playlist_GroupToId, (playlist_t *, char * ) );
182 VLC_EXPORT( char * , playlist_GetInfo, ( playlist_t * , int, const char *, const char *) );
183 VLC_EXPORT( char * , playlist_GetItemInfo, ( playlist_item_t * , const char *, const char *) );
185 VLC_EXPORT( item_info_category_t*, playlist_GetCategory, ( playlist_t *, int, const char *) );
186 VLC_EXPORT( item_info_category_t*, playlist_GetItemCategory, ( playlist_item_t *, const char *) );
188 VLC_EXPORT( item_info_category_t*, playlist_CreateCategory, ( playlist_t *, int, const char *) );
189 VLC_EXPORT( item_info_category_t*, playlist_CreateItemCategory, ( playlist_item_t *, const char *) );
191 VLC_EXPORT( int, playlist_AddInfo, (playlist_t *, int, const char * , const char *, const char *, ...) );
192 VLC_EXPORT( int, playlist_AddItemInfo, (playlist_item_t *, const char * , const char *, const char *, ...) );
194 /* Option functions */
195 VLC_EXPORT( int, playlist_AddOption, (playlist_t *, int, const char *, ...) );
196 VLC_EXPORT( int, playlist_AddItemOption, (playlist_item_t *, const char *, ...) );
198 /* Playlist sorting */
199 #define playlist_SortTitle(p, i) playlist_Sort( p, SORT_TITLE, i)
200 #define playlist_SortAuthor(p, i) playlist_Sort( p, SORT_AUTHOR, i)
201 #define playlist_SortGroup(p, i) playlist_Sort( p, SORT_GROUP, i)
202 VLC_EXPORT( int, playlist_Sort, ( playlist_t *, int, int) );
203 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
206 VLC_EXPORT( int, playlist_LoadFile, ( playlist_t *, const char * ) );
207 VLC_EXPORT( int, playlist_SaveFile, ( playlist_t *, const char * ) );
210 * tell if a playlist is currently playing.
211 * \param p_playlist the playlist to check
212 * \return true if playlist is playing, false otherwise
214 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
216 vlc_bool_t b_playing;
218 vlc_mutex_lock( &p_playlist->object_lock );
219 b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
220 vlc_mutex_unlock( &p_playlist->object_lock );
226 * tell if a playlist is currently empty
227 * \param p_playlist the playlist to check
228 * \return true if the playlist is empty, false otherwise
230 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
234 vlc_mutex_lock( &p_playlist->object_lock );
235 b_empty = p_playlist->i_size == 0;
236 vlc_mutex_unlock( &p_playlist->object_lock );