audio_output.h 8.74 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2 3
 * audio_output.h : audio output thread interface
 * (c)1999 VideoLAN
4
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
5 6 7 8
 * Required headers:
 * - <sys/soundcard.h>                                       ( audio_buf_info )
 * - "common.h"                                                   ( boolean_t )
 * - "mtime.h"                                                      ( mtime_t )
9
 * - "vlc_thread.h"                                            ( vlc_thread_t )
10
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

/* 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"

/* Default audio output format (AFMT_S16_NE = Native Endianess) */
#define AOUT_DEFAULT_FORMAT     AFMT_S16_NE

/* Default stereo mode (0 stands for mono, 1 for stereo) */
#define AOUT_DEFAULT_STEREO     1

/* Audio output rate, in Hz */
#define AOUT_MIN_RATE           22050 /* ?? */
#define AOUT_DEFAULT_RATE       44100
#define AOUT_MAX_RATE           48000

/* 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
48
#define AOUT_MAX_FIFOS          2
Michel Kaempf's avatar
Michel Kaempf committed
49 50 51 52 53 54 55 56 57 58 59 60 61

/* 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 )

62
/*****************************************************************************
63
 * aout_sys_t
64
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
65 66 67 68 69 70 71 72 73 74 75 76 77
typedef struct
{
    /* Path to the audio output device (default is set to "/dev/dsp") */
    char *              psz_device;
    int                 i_fd;

    /* Format of the audio output samples (see <sys/soundcard.h>) */
    int                 i_format;
    /* Following boolean is set to 0 if output sound is mono, 1 if stereo */
    boolean_t           b_stereo;
    /* Rate of the audio output sound (in Hz) */
    long                l_rate;

78
    /* Buffer information structure, used by aout_sys_getbufinfo() to store the
Michel Kaempf's avatar
Michel Kaempf committed
79 80 81
     * current state of the internal sound card buffer */
    audio_buf_info      buf_info;

82
} aout_sys_t;
Michel Kaempf's avatar
Michel Kaempf committed
83

84
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
85
 * aout_increment_t
86
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
87 88 89
 * 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.
90
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
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;

112
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
113
 * aout_fifo_t
114
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
115 116 117 118 119 120 121 122 123
typedef struct
{
    /* See the fifo types below */
    int                 i_type;
    boolean_t           b_die;

    boolean_t           b_stereo;
    long                l_rate;

124 125
    vlc_mutex_t         data_lock;
    vlc_cond_t          data_wait;
Michel Kaempf's avatar
Michel Kaempf committed
126

Michel Kaempf's avatar
Michel Kaempf committed
127
    long                l_frame_size;
Michel Kaempf's avatar
Michel Kaempf committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
    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

158
/*****************************************************************************
159
 * aout_thread_t : audio output thread descriptor
160
 *****************************************************************************/
161 162 163 164 165 166 167 168 169 170
typedef int  (aout_sys_open_t)           ( aout_sys_t *p_sys );
typedef int  (aout_sys_reset_t)          ( aout_sys_t *p_sys );
typedef int  (aout_sys_setformat_t)      ( aout_sys_t *p_sys );
typedef int  (aout_sys_setchannels_t)    ( aout_sys_t *p_sys );
typedef int  (aout_sys_setrate_t)        ( aout_sys_t *p_sys );
typedef long (aout_sys_getbufinfo_t)     ( aout_sys_t *p_sys );
typedef void (aout_sys_playsamples_t)    ( aout_sys_t *p_sys,
                                           byte_t *buffer, int i_size );
typedef void (aout_sys_close_t)          ( aout_sys_t *p_sys );

Michel Kaempf's avatar
Michel Kaempf committed
171 172
typedef struct aout_thread_s
{
173
    vlc_thread_t        thread_id;
Michel Kaempf's avatar
Michel Kaempf committed
174 175
    boolean_t           b_die;

176
    aout_sys_t          sys;
Michel Kaempf's avatar
Michel Kaempf committed
177

178
    vlc_mutex_t         fifos_lock;
Michel Kaempf's avatar
Michel Kaempf committed
179 180
    aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];

181 182 183 184 185 186 187 188 189 190
    /* method-dependant functions */
    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
191 192 193 194 195 196 197 198
    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
199
    long                l_msleep;
Michel Kaempf's avatar
Michel Kaempf committed
200 201

    /* date is the moment where the first audio unit of the output buffer
Michel Kaempf's avatar
Michel Kaempf committed
202 203
     * will be played */
    mtime_t             date;
Michel Kaempf's avatar
Michel Kaempf committed
204 205 206

} aout_thread_t;

207 208 209 210 211 212 213 214 215
/* Output methods */
#define AOUT_DUMMY_METHOD       0x0000                 /* dummy video output */
#define AOUT_DSP_METHOD         0x0001                     /* linux /dev/dsp */

/* Get the fallback method */
#ifdef AUDIO_DSP
#define AOUT_DEFAULT_METHOD "dsp"
#endif

216
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
217
 * Prototypes
218
 *****************************************************************************/
Vincent Seguin's avatar
Vincent Seguin committed
219 220 221
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
222 223 224

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