1 /*****************************************************************************
2 * vlc_playlist.h : Playlist functions
3 *****************************************************************************
4 * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
5 * $Id: vlc_playlist.h,v 1.11 2003/07/23 01:13:47 gbazin 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 *****************************************************************************/
24 /*****************************************************************************
25 * playlist_item_t: playlist item
26 *****************************************************************************/
27 struct playlist_item_t
33 int i_type; /* unused yet */
34 int i_status; /* unused yet */
35 vlc_bool_t b_autodeletion;
38 /*****************************************************************************
39 * playlist_t: playlist structure
40 *****************************************************************************
41 * The structure contains information about the size and browsing mode of
42 * the playlist, a change lock, a dynamic array of playlist items, and a
43 * current item which is an exact copy of one of the array members.
44 *****************************************************************************/
49 int i_index; /* current index */
51 int i_size; /* total size */
53 playlist_item_t ** pp_items;
55 input_thread_t * p_input;
58 /*****************************************************************************
60 *****************************************************************************/
61 #define PLAYLIST_STOPPED 0
62 #define PLAYLIST_RUNNING 1
63 #define PLAYLIST_PAUSED 2
65 /*****************************************************************************
67 *****************************************************************************/
68 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
69 playlist_t * __playlist_Create ( vlc_object_t * );
70 void playlist_Destroy ( playlist_t * );
72 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
73 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
74 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
75 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
76 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
77 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
78 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
79 VLC_EXPORT( void, playlist_Command, ( playlist_t *, int, int ) );
81 VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char **, int, int, int ) );
82 VLC_EXPORT( int, playlist_AddName, (playlist_t *,const char *,const char *, const char **, int, int,int ) );
83 VLC_EXPORT( int, playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
84 VLC_EXPORT( int, playlist_Delete, ( playlist_t *, int ) );
85 VLC_EXPORT( int, playlist_Move, ( playlist_t *, int, int ) );
86 VLC_EXPORT( int, playlist_LoadFile, ( playlist_t *, const char * ) );
87 VLC_EXPORT( int, playlist_SaveFile, ( playlist_t *, const char * ) );
89 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
93 vlc_mutex_lock( &p_playlist->object_lock );
94 b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
95 vlc_mutex_unlock( &p_playlist->object_lock );
100 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
104 vlc_mutex_lock( &p_playlist->object_lock );
105 b_empty = p_playlist->i_size == 0;
106 vlc_mutex_unlock( &p_playlist->object_lock );