1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
5 * $Id: vlc_playlist.h,v 1.15 2003/10/29 17:32:54 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
40 struct playlist_item_t
42 char * psz_name; /**< text describing this item */
43 char * psz_uri; /**< mrl of this item */
44 mtime_t i_duration; /**< A hint about the duration of this
45 * item, in miliseconds*/
46 char ** ppsz_options; /**< options passed with the :foo=bar syntax */
47 int i_options; /**< number of items in the
48 * ppsz_options array */
49 int i_type; /**< unused yet */
50 int i_status; /**< unused yet */
51 vlc_bool_t b_autodeletion; /**< Indicates whther this item is to
52 * be deleted after playback. True mean
53 * that this item is to be deleted
54 * after playback, false otherwise */
55 vlc_bool_t b_enabled; /**< Indicates whether this item is to be
56 * played or skipped */
58 int i_group; /**< unused yet */
59 char * psz_author; /**< Author */
62 struct playlist_group_t
64 char * psz_name; /**< name of the group */
65 int i_id; /**< Identifier for the group */
71 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
74 * Structure containing information about the playlist
81 These members are uniq to playlist_t
84 int i_index; /**< current index into the playlist */
85 playlist_status_t i_status; /**< current status of playlist */
86 int i_size; /**< total size of the list */
87 int i_enabled; /**< How many items are enabled ? */
88 playlist_item_t ** pp_items; /**< array of pointers to the
90 int i_groups; /**< How many groups are in the playlist */
91 playlist_group_t ** pp_groups;/**< array of pointers to the playlist
93 int i_max_id; /**< Maximal group id given */
94 input_thread_t * p_input; /**< the input thread ascosiated
95 * with the current item */
100 #define SORT_REVERSE 1
102 #define PLAYLIST_TYPE_MANUAL 1
103 #define PLAYLIST_TYPE_SAP 2
105 /*****************************************************************************
107 *****************************************************************************/
108 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
109 playlist_t * __playlist_Create ( vlc_object_t * );
110 void playlist_Destroy ( playlist_t * );
112 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
113 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
114 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
115 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
116 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
117 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
118 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
119 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
121 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char **, int, int, int ) );
122 VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, mtime_t, const char **, int, int, int ) );
123 VLC_EXPORT( int, playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
124 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
125 VLC_EXPORT( int, playlist_Disable, ( playlist_t *, int ) );
126 VLC_EXPORT( int, playlist_Enable, ( playlist_t *, int ) );
127 VLC_EXPORT( int, playlist_DisableGroup, ( playlist_t *, int ) );
128 VLC_EXPORT( int, playlist_EnableGroup, ( playlist_t *, int ) );
130 VLC_EXPORT( playlist_group_t *, playlist_CreateGroup, (playlist_t *, char* ) );
131 VLC_EXPORT( int, playlist_DeleteGroup, (playlist_t *, int ) );
132 VLC_EXPORT( char *, playlist_FindGroup, (playlist_t *, int ) );
134 VLC_EXPORT( int, playlist_SortTitle, ( playlist_t *, int) );
135 VLC_EXPORT( int, playlist_SortAuthor, ( playlist_t *, int) );
136 VLC_EXPORT( int, playlist_SortGroup, ( playlist_t *, int) );
138 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
139 VLC_EXPORT( int, playlist_LoadFile, ( playlist_t *, const char * ) );
140 VLC_EXPORT( int, playlist_SaveFile, ( playlist_t *, const char * ) );
143 * tell if a playlist is currently playing.
144 * \param p_playlist the playlist to check
145 * \return true if playlist is playing, false otherwise
147 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
149 vlc_bool_t b_playing;
151 vlc_mutex_lock( &p_playlist->object_lock );
152 b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
153 vlc_mutex_unlock( &p_playlist->object_lock );
159 * tell if a playlist is currently empty
160 * \param p_playlist the playlist to check
161 * \return true if the playlist is empty, false otherwise
163 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
167 vlc_mutex_lock( &p_playlist->object_lock );
168 b_empty = p_playlist->i_size == 0;
169 vlc_mutex_unlock( &p_playlist->object_lock );