audio_output.h 10.4 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * audio_output.h : audio output thread interface
3
 *****************************************************************************
4 5 6 7 8 9 10 11
 * Copyright (C) 1999, 2000 VideoLAN
 *
 * Authors:
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
12
 * 
13 14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
17
 *
18 19 20
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
21 22 23
 *****************************************************************************/

/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
24 25 26
 * Required headers:
 * - "common.h"                                                   ( boolean_t )
 * - "mtime.h"                                                      ( mtime_t )
27
 * - "threads.h"                                               ( vlc_thread_t )
28
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

/* TODO :
 *
 * - Créer un flag destroy dans les fifos audio pour indiquer au thread audio
 *   qu'il peut libérer la mémoire occupée par le buffer de la fifo lorsqu'il
 *   le désire (fin du son ou fin du thread)
 * - Redéplacer les #define dans config.h
 *
 */

/*
 * Defines => "config.h"
 */

/* Default output device. You probably should not change this. */
#define AOUT_DEFAULT_DEVICE     "/dev/dsp"

46 47
/* Default audio output format (AOUT_FMT_S16_NE = Native Endianess) */
#define AOUT_DEFAULT_FORMAT     AOUT_FMT_S16_NE
Michel Kaempf's avatar
Michel Kaempf committed
48

Renaud Dartus's avatar
 
Renaud Dartus committed
49 50 51 52 53 54 55 56
/* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S8 */
/* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_U8 */
/* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S16_BE */
/* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_S16_LE */
/* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_U16_BE */
/* #define AOUT_DEFAULT_FORMAT     AOUT_FMT_U16_LE */


Michel Kaempf's avatar
Michel Kaempf committed
57 58
/* Default stereo mode (0 stands for mono, 1 for stereo) */
#define AOUT_DEFAULT_STEREO     1
Renaud Dartus's avatar
 
Renaud Dartus committed
59
/* #define AOUT_DEFAULT_STEREO     0 */
Michel Kaempf's avatar
Michel Kaempf committed
60 61

/* Audio output rate, in Hz */
62
#define AOUT_MIN_RATE           22050 /* XXX?? */
Michel Kaempf's avatar
Michel Kaempf committed
63 64 65
#define AOUT_DEFAULT_RATE       44100
#define AOUT_MAX_RATE           48000

Renaud Dartus's avatar
 
Renaud Dartus committed
66 67 68 69 70 71

/* Volume (default 100) */
#define VOL 100
#define VOLSTEP 5
#define VOLMAX 300

Michel Kaempf's avatar
Michel Kaempf committed
72 73 74 75 76 77 78 79 80
/* Number of audio output frames contained in an audio output fifo.
 * (AOUT_FIFO_SIZE + 1) must be a power of 2, in order to optimise the
 * %(AOUT_FIFO_SIZE + 1) operation with an &AOUT_FIFO_SIZE.
 * With 511 we have at least 511*384/2/48000=2 seconds of sound */
#define AOUT_FIFO_SIZE          511

/* Maximum number of audio fifos. The value of AOUT_MAX_FIFOS should be a power
 * of two, in order to optimize the '/AOUT_MAX_FIFOS' and '*AOUT_MAX_FIFOS'
 * operations with '>>' and '<<' (gcc changes this at compilation-time) */
Michel Kaempf's avatar
Michel Kaempf committed
81
#define AOUT_MAX_FIFOS          2
Michel Kaempf's avatar
Michel Kaempf committed
82 83 84 85 86 87 88 89 90 91 92 93 94

/* Duration (in microseconds) of an audio output buffer should be :
 * - short, in order to be able to play a new song very quickly (especially a
 *   song from the interface)
 * - long, in order to perform the buffer calculations as few as possible */
#define AOUT_BUFFER_DURATION    100000

/*
 * Macros
 */
#define AOUT_FIFO_ISEMPTY( fifo )       ( (fifo).l_end_frame == (fifo).i_start_frame )
#define AOUT_FIFO_ISFULL( fifo )        ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )

95
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
96
 * aout_increment_t
97
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
98 99 100
 * This structure is used to keep the progression of an index up-to-date, in
 * order to avoid rounding problems and heavy computations, as the function
 * that handles this structure only uses additions.
101
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
typedef struct
{
    /* The remainder is used to keep track of the fractional part of the
     * index. */
    long                l_remainder;

    /*
     * The increment structure is initialized with the result of an euclidean
     * division :
     *
     *  l_euclidean_numerator                           l_euclidean_remainder
     * ----------------------- = l_euclidean_integer + -----------------------
     * l_euclidean_denominator                         l_euclidean_denominator
     *
     */
    long                l_euclidean_integer;
    long                l_euclidean_remainder;
    long                l_euclidean_denominator;

} aout_increment_t;

123
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
124
 * aout_fifo_t
125
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
126 127 128 129 130 131
typedef struct
{
    /* See the fifo types below */
    int                 i_type;
    boolean_t           b_die;

132
    int                 i_channels;
133
    boolean_t           b_stereo;
Michel Kaempf's avatar
Michel Kaempf committed
134 135
    long                l_rate;

136 137
    vlc_mutex_t         data_lock;
    vlc_cond_t          data_wait;
Michel Kaempf's avatar
Michel Kaempf committed
138

Michel Kaempf's avatar
Michel Kaempf committed
139
    long                l_frame_size;
Michel Kaempf's avatar
Michel Kaempf committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
    void *              buffer;
    mtime_t *           date;
    /* The start frame is the first frame in the buffer that contains decoded
     * audio data. It it also the first frame in the current timestamped frame
     * area, ie the first dated frame in the decoded part of the buffer. :-p */
    long                l_start_frame;
    boolean_t           b_start_frame;
    /* The next frame is the end frame of the current timestamped frame area,
     * ie the first dated frame after the start frame. */
    long                l_next_frame;
    boolean_t           b_next_frame;
    /* The end frame is the first frame, after the start frame, that doesn't
     * contain decoded audio data. That's why the end frame is the first frame
     * where the audio decoder can store its decoded audio frames. */
    long                l_end_frame;

    long                l_unit;
    aout_increment_t    unit_increment;
    /* The following variable is used to store the number of remaining audio
     * units in the current timestamped frame area. */
    long                l_units;

} aout_fifo_t;

#define AOUT_EMPTY_FIFO         0
#define AOUT_INTF_MONO_FIFO     1
#define AOUT_INTF_STEREO_FIFO   2
#define AOUT_ADEC_MONO_FIFO     3
#define AOUT_ADEC_STEREO_FIFO   4

170
/*****************************************************************************
171
 * aout_thread_t : audio output thread descriptor
172
 *****************************************************************************/
173 174 175 176 177
typedef int  (aout_sys_open_t)           ( p_aout_thread_t p_aout );
typedef int  (aout_sys_reset_t)          ( p_aout_thread_t p_aout );
typedef int  (aout_sys_setformat_t)      ( p_aout_thread_t p_aout );
typedef int  (aout_sys_setchannels_t)    ( p_aout_thread_t p_aout );
typedef int  (aout_sys_setrate_t)        ( p_aout_thread_t p_aout );
178 179
typedef long (aout_sys_getbufinfo_t)     ( p_aout_thread_t p_aout,
                                           long l_buffer_limit );
180
typedef void (aout_sys_playsamples_t)    ( p_aout_thread_t p_aout,
181
                                           byte_t *buffer, int i_size );
182
typedef void (aout_sys_close_t)          ( p_aout_thread_t p_aout );
183

Michel Kaempf's avatar
Michel Kaempf committed
184 185
typedef struct aout_thread_s
{
186
    vlc_thread_t        thread_id;
Michel Kaempf's avatar
Michel Kaempf committed
187
    boolean_t           b_die;
Sam Hocevar's avatar
Sam Hocevar committed
188
    boolean_t           b_active;
Michel Kaempf's avatar
Michel Kaempf committed
189

190
    vlc_mutex_t         fifos_lock;
Michel Kaempf's avatar
Michel Kaempf committed
191 192
    aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];

193
    /* Plugins */
194
    plugin_id_t                 aout_plugin;          /* video output plugin */
195 196 197 198 199 200 201 202 203
    aout_sys_open_t *           p_sys_open;
    aout_sys_reset_t *          p_sys_reset;
    aout_sys_setformat_t *      p_sys_setformat;
    aout_sys_setchannels_t *    p_sys_setchannels;
    aout_sys_setrate_t *        p_sys_setrate;
    aout_sys_getbufinfo_t *     p_sys_getbufinfo;
    aout_sys_playsamples_t *    p_sys_playsamples;
    aout_sys_close_t *          p_sys_close;

Michel Kaempf's avatar
Michel Kaempf committed
204 205 206 207 208 209 210 211
    void *              buffer;
    /* The s32 buffer is used to mix all the audio fifos together before
     * converting them and storing them in the audio output buffer */
    s32 *               s32_buffer;

    /* The size of the audio output buffer is kept in audio units, as this is
     * the only unit that is common with every audio decoder and audio fifo */
    long                l_units;
Michel Kaempf's avatar
Michel Kaempf committed
212
    long                l_msleep;
Michel Kaempf's avatar
Michel Kaempf committed
213 214

    /* date is the moment where the first audio unit of the output buffer
Michel Kaempf's avatar
Michel Kaempf committed
215 216
     * will be played */
    mtime_t             date;
Michel Kaempf's avatar
Michel Kaempf committed
217

218 219 220 221 222 223 224 225
    /* Path to the audio output device (default is set to "/dev/dsp") */
    char *              psz_device;
    int                 i_fd;

    /* Format of the audio output samples */
    int                 i_format;
    /* Number of channels */
    int                 i_channels;
226 227
    /* Mono or Stereo sound */
    boolean_t           b_stereo;
228 229 230 231 232 233 234 235
    /* Rate and gain of the audio output sound (in Hz) */
    long                l_rate;
    long                l_gain;

    /* there might be some useful private structure, such as audio_buf_info
     * for the OSS output */
    p_aout_sys_t        p_sys;

Renaud Dartus's avatar
 
Renaud Dartus committed
236 237 238 239

    /* there is the current volume */
    int                 vol;

Michel Kaempf's avatar
Michel Kaempf committed
240 241
} aout_thread_t;

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
/* Those are from <linux/soundcard.h> but are needed because of formats
 * on other platforms */
#define AOUT_FMT_U8          0x00000008
#define AOUT_FMT_S16_LE      0x00000010           /* Little endian signed 16 */
#define AOUT_FMT_S16_BE      0x00000020              /* Big endian signed 16 */
#define AOUT_FMT_S8          0x00000040
#define AOUT_FMT_U16_LE      0x00000080                 /* Little endian U16 */
#define AOUT_FMT_U16_BE      0x00000100                    /* Big endian U16 */

#if __BYTE_ORDER == __LITTLE_ENDIAN
#define AOUT_FMT_S16_NE      AOUT_FMT_S16_LE
#elif __BYTE_ORDER == __BIG_ENDIAN
#define AOUT_FMT_S16_NE      AOUT_FMT_S16_BE
#endif

257
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
258
 * Prototypes
259
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
260 261 262
aout_thread_t * aout_CreateThread       ( int *pi_status );
void            aout_DestroyThread      ( aout_thread_t *p_aout, int *pi_status );

Michel Kaempf's avatar
Michel Kaempf committed
263 264 265

aout_fifo_t *   aout_CreateFifo         ( aout_thread_t *p_aout, aout_fifo_t *p_fifo );
void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );