git.sesse.net Git - vlc/blob - include/vlc_playlist.h

   1 /*****************************************************************************
   2  * vlc_playlist.h : Playlist functions
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
   5  * $Id: vlc_playlist.h,v 1.14 2003/10/06 16:23:30 zorglub 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 item
  38  * \see playlist_t
  39  */
  40 struct playlist_item_t
  41 {
  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 */
  57
  58     int        i_group;         /**< unused yet */
  59     char *     psz_author;     /**< Author */
  60 };
  61
  62 /**
  63  * Playlist status
  64  */
  65 typedef enum { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
  66
  67 /**
  68  * Structure containing information about the playlist
  69  */
  70 struct playlist_t
  71 {
  72     VLC_COMMON_MEMBERS
  73 /**
  74    \name playlist_t
  75    These members are uniq to playlist_t
  76 */
  77 /*@{*/
  78     int                   i_index;  /**< current index into the playlist */
  79     playlist_status_t     i_status; /**< current status of playlist */
  80     int                   i_size;   /**< total size of the list */
  81     int                   i_enabled; /**< How many items are enabled ? */
  82     playlist_item_t **    pp_items; /**< array of pointers to the
  83                                      * playlist items */
  84
  85     input_thread_t *      p_input;  /**< the input thread ascosiated
  86                                      * with the current item */
  87     /*@}*/
  88 };
  89
  90 #define SORT_NORMAL 0
  91 #define SORT_REVERSE 1
  92
  93 #define PLAYLIST_TYPE_MANUAL 0
  94 #define PLAYLIST_TYPE_SAP 1
  95
  96 /*****************************************************************************
  97  * Prototypes
  98  *****************************************************************************/
  99 #define playlist_Create(a) __playlist_Create(VLC_OBJECT(a))
 100 playlist_t * __playlist_Create   ( vlc_object_t * );
 101 void           playlist_Destroy  ( playlist_t * );
 102
 103 #define playlist_Play(p) playlist_Command(p,PLAYLIST_PLAY,0)
 104 #define playlist_Pause(p) playlist_Command(p,PLAYLIST_PAUSE,0)
 105 #define playlist_Stop(p) playlist_Command(p,PLAYLIST_STOP,0)
 106 #define playlist_Next(p) playlist_Command(p,PLAYLIST_SKIP,1)
 107 #define playlist_Prev(p) playlist_Command(p,PLAYLIST_SKIP,-1)
 108 #define playlist_Skip(p,i) playlist_Command(p,PLAYLIST_SKIP,i)
 109 #define playlist_Goto(p,i) playlist_Command(p,PLAYLIST_GOTO,i)
 110 VLC_EXPORT( void, playlist_Command, ( playlist_t *, playlist_command_t, int ) );
 111
 112 VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char **, int, int, int ) );
 113 VLC_EXPORT( int,  playlist_AddExt,    ( playlist_t *, const char *, const char *, mtime_t, const char **, int, int, int ) );
 114 VLC_EXPORT( int,  playlist_AddItem, ( playlist_t *, playlist_item_t *, int, int ) );
 115 VLC_EXPORT( int,  playlist_Delete, ( playlist_t *, int ) );
 116 VLC_EXPORT( int,  playlist_Disable, ( playlist_t *, int ) );
 117 VLC_EXPORT( int,  playlist_Enable, ( playlist_t *, int ) );
 118 VLC_EXPORT( int,  playlist_DisableGroup, ( playlist_t *, int ) );
 119 VLC_EXPORT( int,  playlist_EnableGroup, ( playlist_t *, int ) );
 120 VLC_EXPORT( int,  playlist_Sort, ( playlist_t *, int) );
 121 VLC_EXPORT( int,  playlist_Move, ( playlist_t *, int, int ) );
 122 VLC_EXPORT( int,  playlist_LoadFile, ( playlist_t *, const char * ) );
 123 VLC_EXPORT( int,  playlist_SaveFile, ( playlist_t *, const char * ) );
 124
 125 /**
 126  *  tell if a playlist is currently playing.
 127  *  \param p_playlist the playlist to check
 128  *  \return true if playlist is playing, false otherwise
 129  */
 130 static inline vlc_bool_t playlist_IsPlaying( playlist_t * p_playlist )
 131 {
 132     vlc_bool_t b_playing;
 133
 134     vlc_mutex_lock( &p_playlist->object_lock );
 135     b_playing = p_playlist->i_status == PLAYLIST_RUNNING;
 136     vlc_mutex_unlock( &p_playlist->object_lock );
 137
 138     return( b_playing );
 139 }
 140
 141 /**
 142  *  tell if a playlist is currently empty
 143  *  \param p_playlist the playlist to check
 144  *  \return true if the playlist is empty, false otherwise
 145  */
 146 static inline vlc_bool_t playlist_IsEmpty( playlist_t * p_playlist )
 147 {
 148     vlc_bool_t b_empty;
 149
 150     vlc_mutex_lock( &p_playlist->object_lock );
 151     b_empty = p_playlist->i_size == 0;
 152     vlc_mutex_unlock( &p_playlist->object_lock );
 153
 154     return( b_empty );
 155 }
 156
 157 /**
 158  * @}
 159  */