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

   1 /*****************************************************************************
   2  * audio_output.h : audio output thread interface
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000 VideoLAN
   5  *
   6  * Authors:
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public
  19  * License along with this program; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Required headers:
  26  * - "common.h"                                                   ( boolean_t )
  27  * - "mtime.h"                                                      ( mtime_t )
  28  * - "threads.h"                                               ( vlc_thread_t )
  29  *****************************************************************************/
  30
  31 /* TODO :
  32  *
  33  * - Créer un flag destroy dans les fifos audio pour indiquer au thread audio
  34  *   qu'il peut libérer la mémoire occupée par le buffer de la fifo lorsqu'il
  35  *   le désire (fin du son ou fin du thread)
  36  * - Redéplacer les #define dans config.h
  37  *
  38  */
  39
  40 /*
  41  * Defines => "config.h"
  42  */
  43
  44 /* Default output device. You probably should not change this. */
  45 #define AOUT_DEFAULT_DEVICE     "/dev/dsp"
  46
  47 /* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
  48 #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S16_NE
  49
  50 /* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S8 */
  51 /* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_U8 */
  52 /* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S16_BE */
  53 /* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S16_LE */
  54 /* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_U16_BE */
  55 /* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_U16_LE */
  56
  57
  58 /* Default stereo mode (0 stands for mono, 1 for stereo) */
  59 #define AOUT_DEFAULT_STEREO     1
  60
  61 /* Audio output rate, in Hz */
  62 #define AOUT_MIN_RATE           22050 /* XXX?? */
  63 #define AOUT_DEFAULT_RATE       44100
  64 #define AOUT_MAX_RATE           48000
  65
  66 /* Number of audio output frames contained in an audio output fifo.
  67  * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
  68  * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
  69  * With 511 we have at least 511*384/2/48000=2 seconds of sound */
  70 #define AOUT_FIFO_SIZE          511
  71
  72 /* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
  73  * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
  74  * operations with '>>' and '<<' (gcc changes this at compilation-time) */
  75 #define AOUT_MAX_FIFOS          2
  76
  77 /* Duration (in microseconds) of an audio output buffer should be :
  78  * - short, in order to be able to play a new song very quickly (especially a
  79  *   song from the interface)
  80  * - long, in order to perform the buffer calculations as few as possible */
  81 #define AOUT_BUFFER_DURATION    100000
  82
  83 /*
  84  * Macros
  85  */
  86 #define AOUT_FIFO_ISEMPTY( fifo )       ( (fifo).l_end_frame == (fifo).i_start_frame )
  87 #define AOUT_FIFO_ISFULL( fifo )        ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )
  88
  89 /*****************************************************************************
  90  * aout_increment_t
  91  *****************************************************************************
  92  * This structure is used to keep the progression of an index up-to-date, in
  93  * order to avoid rounding problems and heavy computations, as the function
  94  * that handles this structure only uses additions.
  95  *****************************************************************************/
  96 typedef struct
  97 {
  98     /* The remainder is used to keep track of the fractional part of the
  99      * index. */
 100     long                l_remainder;
 101
 102     /*
 103      * The increment structure is initialized with the result of an euclidean
 104      * division :
 105      *
 106      *  l_euclidean_numerator                           l_euclidean_remainder
 107      * ----------------------- = l_euclidean_integer + -----------------------
 108      * l_euclidean_denominator                         l_euclidean_denominator
 109      *
 110      */
 111     long                l_euclidean_integer;
 112     long                l_euclidean_remainder;
 113     long                l_euclidean_denominator;
 114
 115 } aout_increment_t;
 116
 117 /*****************************************************************************
 118  * aout_fifo_t
 119  *****************************************************************************/
 120 typedef struct
 121 {
 122     /* See the fifo types below */
 123     int                 i_type;
 124     boolean_t           b_die;
 125
 126     int                 i_channels;
 127     boolean_t           b_stereo;
 128     long                l_rate;
 129
 130     vlc_mutex_t         data_lock;
 131     vlc_cond_t          data_wait;
 132
 133     long                l_frame_size;
 134     void *              buffer;
 135     mtime_t *           date;
 136     /* The start frame is the first frame in the buffer that contains decoded
 137      * audio data. It it also the first frame in the current timestamped frame
 138      * area, ie the first dated frame in the decoded part of the buffer. :-p */
 139     long                l_start_frame;
 140     boolean_t           b_start_frame;
 141     /* The next frame is the end frame of the current timestamped frame area,
 142      * ie the first dated frame after the start frame. */
 143     long                l_next_frame;
 144     boolean_t           b_next_frame;
 145     /* The end frame is the first frame, after the start frame, that doesn't
 146      * contain decoded audio data. That's why the end frame is the first frame
 147      * where the audio decoder can store its decoded audio frames. */
 148     long                l_end_frame;
 149
 150     long                l_unit;
 151     aout_increment_t    unit_increment;
 152     /* The following variable is used to store the number of remaining audio
 153      * units in the current timestamped frame area. */
 154     long                l_units;
 155
 156 } aout_fifo_t;
 157
 158 #define AOUT_EMPTY_FIFO         0
 159 #define AOUT_INTF_MONO_FIFO     1
 160 #define AOUT_INTF_STEREO_FIFO   2
 161 #define AOUT_ADEC_MONO_FIFO     3
 162 #define AOUT_ADEC_STEREO_FIFO   4
 163
 164 /*****************************************************************************
 165  * aout_thread_t : audio output thread descriptor
 166  *****************************************************************************/
 167 typedef int  (aout_sys_open_t)           ( p_aout_thread_t p_aout );
 168 typedef int  (aout_sys_reset_t)          ( p_aout_thread_t p_aout );
 169 typedef int  (aout_sys_setformat_t)      ( p_aout_thread_t p_aout );
 170 typedef int  (aout_sys_setchannels_t)    ( p_aout_thread_t p_aout );
 171 typedef int  (aout_sys_setrate_t)        ( p_aout_thread_t p_aout );
 172 typedef long (aout_sys_getbufinfo_t)     ( p_aout_thread_t p_aout,
 173                                            long l_buffer_limit );
 174 typedef void (aout_sys_playsamples_t)    ( p_aout_thread_t p_aout,
 175                                            byte_t *buffer, int i_size );
 176 typedef void (aout_sys_close_t)          ( p_aout_thread_t p_aout );
 177
 178 typedef struct aout_thread_s
 179 {
 180     vlc_thread_t        thread_id;
 181     boolean_t           b_die;
 182
 183     vlc_mutex_t         fifos_lock;
 184     aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];
 185
 186     /* Plugins */
 187     void *                      p_aout_plugin;        /* video output plugin */
 188     aout_sys_open_t *           p_sys_open;
 189     aout_sys_reset_t *          p_sys_reset;
 190     aout_sys_setformat_t *      p_sys_setformat;
 191     aout_sys_setchannels_t *    p_sys_setchannels;
 192     aout_sys_setrate_t *        p_sys_setrate;
 193     aout_sys_getbufinfo_t *     p_sys_getbufinfo;
 194     aout_sys_playsamples_t *    p_sys_playsamples;
 195     aout_sys_close_t *          p_sys_close;
 196
 197     void *              buffer;
 198     /* The s32 buffer is used to mix all the audio fifos together before
 199      * converting them and storing them in the audio output buffer */
 200     s32 *               s32_buffer;
 201
 202     /* The size of the audio output buffer is kept in audio units, as this is
 203      * the only unit that is common with every audio decoder and audio fifo */
 204     long                l_units;
 205     long                l_msleep;
 206
 207     /* date is the moment where the first audio unit of the output buffer
 208      * will be played */
 209     mtime_t             date;
 210
 211     /* Path to the audio output device (default is set to "/dev/dsp") */
 212     char *              psz_device;
 213     int                 i_fd;
 214
 215     /* Format of the audio output samples */
 216     int                 i_format;
 217     /* Number of channels */
 218     int                 i_channels;
 219     /* Mono or Stereo sound */
 220     boolean_t           b_stereo;
 221     /* Rate and gain of the audio output sound (in Hz) */
 222     long                l_rate;
 223     long                l_gain;
 224
 225     /* there might be some useful private structure, such as audio_buf_info
 226      * for the OSS output */
 227     p_aout_sys_t        p_sys;
 228
 229 } aout_thread_t;
 230
 231 /* Those are from <linux/soundcard.h> but are needed because of formats
 232  * on other platforms */
 233 #define AOUT_FMT_U8          0x00000008
 234 #define AOUT_FMT_S16_LE      0x00000010           /* Little endian signed 16 */
 235 #define AOUT_FMT_S16_BE      0x00000020              /* Big endian signed 16 */
 236 #define AOUT_FMT_S8          0x00000040
 237 #define AOUT_FMT_U16_LE      0x00000080                 /* Little endian U16 */
 238 #define AOUT_FMT_U16_BE      0x00000100                    /* Big endian U16 */
 239
 240 #if __BYTE_ORDER == __LITTLE_ENDIAN
 241 #define AOUT_FMT_S16_NE      AOUT_FMT_S16_LE
 242 #elif __BYTE_ORDER == __BIG_ENDIAN
 243 #define AOUT_FMT_S16_NE      AOUT_FMT_S16_BE
 244 #endif
 245
 246 /*****************************************************************************
 247  * Prototypes
 248  *****************************************************************************/
 249 aout_thread_t * aout_CreateThread       ( int *pi_status );
 250 void            aout_DestroyThread      ( aout_thread_t *p_aout, int *pi_status );
 251
 252
 253 aout_fifo_t *   aout_CreateFifo         ( aout_thread_t *p_aout, aout_fifo_t *p_fifo );
 254 void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );