vlc_aout.h 14.6 KB
Newer Older
1
/*****************************************************************************
2
 * audio_output.h : audio output interface
3
 *****************************************************************************
4
 * Copyright (C) 2002-2005 the VideoLAN team
5
 * $Id$
6
 *
7
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8 9 10 11 12
 *
 * 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.
13
 *
14 15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
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
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
23

24 25
#ifndef VLC_AOUT_H
#define VLC_AOUT_H 1
Clément Stenac's avatar
Clément Stenac committed
26

27 28 29 30 31
/**
 * \file
 * This file defines functions, structures and macros for audio output object
 */

Clément Stenac's avatar
Clément Stenac committed
32 33 34
# ifdef __cplusplus
extern "C" {
# endif
35

36
#include "vlc_es.h"
Michel Kaempf's avatar
Michel Kaempf committed
37

38
#define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
39 40
    ((p_first)->i_format == (p_second)->i_format)                           \
      && ((p_first)->i_rate == (p_second)->i_rate)                          \
41 42
      && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
      && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
43

44 45 46
/* Check if i_rate == i_rate and i_channels == i_channels */
#define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
    ((p_first)->i_rate == (p_second)->i_rate)                               \
47 48
      && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
      && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
49

50 51
#define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
#define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
52

53 54 55 56 57
#define AOUT_FMT_NON_LINEAR( p_format )                 \
    ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
       || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
       || ((p_format)->i_format == VLC_CODEC_A52)       \
       || ((p_format)->i_format == VLC_CODEC_DTS) )
58

59 60 61 62
/* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
/*
 * Fixed-point format: 0xABBBBBBB
 * A == whole part      (sign + 3 bits)
63
 * B == fractional part (28 bits)
64 65 66 67 68 69 70 71 72 73
 *
 * Values are signed two's complement, so the effective range is:
 * 0x80000000 to 0x7fffffff
 *       -8.0 to +7.9999999962747097015380859375
 *
 * The smallest representable value is:
 * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
 *
 * 28 bits of fractional accuracy represent about
 * 8.6 digits of decimal accuracy.
74
 *
75 76 77 78
 * Fixed-point numbers can be added or subtracted as normal
 * integers, but multiplication requires shifting the 64-bit result
 * from 56 fractional bits back to 28 (and rounding.)
 */
79
typedef int32_t vlc_fixed_t;
80 81 82 83 84
#define FIXED32_FRACBITS 28
#define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
#define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
#define FIXED32_ONE ((vlc_fixed_t) 0x10000000)

85 86 87 88 89 90 91 92 93 94 95
/*
 * Channels descriptions
 */

/* Values available for physical and original channels */
#define AOUT_CHAN_CENTER            0x1
#define AOUT_CHAN_LEFT              0x2
#define AOUT_CHAN_RIGHT             0x4
#define AOUT_CHAN_REARCENTER        0x10
#define AOUT_CHAN_REARLEFT          0x20
#define AOUT_CHAN_REARRIGHT         0x40
96 97 98
#define AOUT_CHAN_MIDDLELEFT        0x100
#define AOUT_CHAN_MIDDLERIGHT       0x200
#define AOUT_CHAN_LFE               0x1000
99 100 101 102

/* Values available for original channels only */
#define AOUT_CHAN_DOLBYSTEREO       0x10000
#define AOUT_CHAN_DUALMONO          0x20000
Christophe Massiot's avatar
Christophe Massiot committed
103
#define AOUT_CHAN_REVERSESTEREO     0x40000
104 105

#define AOUT_CHAN_PHYSMASK          0xFFFF
106
#define AOUT_CHAN_MAX               9
107

Gildas Bazin's avatar
 
Gildas Bazin committed
108 109 110
/* Values used for the audio-device and audio-channels object variables */
#define AOUT_VAR_MONO               1
#define AOUT_VAR_STEREO             2
111 112 113 114 115 116
#define AOUT_VAR_2F2R               4
#define AOUT_VAR_3F2R               5
#define AOUT_VAR_5_1                6
#define AOUT_VAR_6_1                7
#define AOUT_VAR_7_1                8
#define AOUT_VAR_SPDIF              10
Gildas Bazin's avatar
 
Gildas Bazin committed
117 118 119 120 121 122

#define AOUT_VAR_CHAN_STEREO        1
#define AOUT_VAR_CHAN_RSTEREO       2
#define AOUT_VAR_CHAN_LEFT          3
#define AOUT_VAR_CHAN_RIGHT         4
#define AOUT_VAR_CHAN_DOLBYS        5
123

124
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
125
 * Main audio output structures
126
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
127 128

/** audio output buffer */
129 130
struct aout_buffer_t
{
131
    uint8_t *               p_buffer;
132
    int                     i_alloc_type;
133
    /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
134 135
     * is the number of significative bytes in it. */
    size_t                  i_size, i_nb_bytes;
136
    unsigned int            i_nb_samples;
137
    mtime_t                 start_date, end_date;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
138
    bool                    b_discontinuity; /* Set on discontinuity (for non pcm stream) */
139

140
    struct aout_buffer_t *  p_next;
141 142 143 144 145 146 147

    /** Private data (aout_buffer_t will disappear soon so no need for an
     * aout_buffer_sys_t type) */
    void * p_sys;

    /** This way the release can be overloaded */
    void (*pf_release)( aout_buffer_t * );
148
};
149

150
#define aout_BufferFree( p_buffer ) do {                                    \
Clément Stenac's avatar
Clément Stenac committed
151 152 153 154
    if( p_buffer != NULL && (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )   \
    {                                                                       \
        free( p_buffer );                                                   \
    }                                                                       \
155
    p_buffer = NULL; } while(0)
Clément Stenac's avatar
Clément Stenac committed
156

Christophe Massiot's avatar
Christophe Massiot committed
157 158
/* Size of a frame for S/PDIF output. */
#define AOUT_SPDIF_SIZE 6144
159

160
/* Number of samples in an A/52 frame. */
161
#define A52_FRAME_NB 1536
162

163 164 165
/* Max input rate factor (1/4 -> 4) */
#define AOUT_MAX_INPUT_RATE (4)

Clément Stenac's avatar
Clément Stenac committed
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
/** allocation of memory in the audio output */
typedef struct aout_alloc_t
{
    int                     i_alloc_type;
    int                     i_bytes_per_sec;
} aout_alloc_t;

#define AOUT_ALLOC_NONE     0
#define AOUT_ALLOC_STACK    1
#define AOUT_ALLOC_HEAP     2

/** audio output buffer FIFO */
struct aout_fifo_t
{
    aout_buffer_t *         p_first;
    aout_buffer_t **        pp_last;
182
    date_t                  end_date;
Clément Stenac's avatar
Clément Stenac committed
183 184
};

185 186 187
/* FIXME to remove once aout.h is cleaned a bit more */
#include <vlc_aout_mixer.h>

188 189 190 191
/* */
typedef struct
{
    vout_thread_t  *(*pf_request_vout)( void *,
192
                                        vout_thread_t *, video_format_t *, bool b_recycle );
193 194 195
    void *p_private;
} aout_request_vout_t;

Clément Stenac's avatar
Clément Stenac committed
196
/** audio output filter */
197 198
typedef struct aout_filter_owner_sys_t aout_filter_owner_sys_t;
typedef struct aout_filter_sys_t aout_filter_sys_t;
Clément Stenac's avatar
Clément Stenac committed
199 200 201 202 203 204 205 206 207
struct aout_filter_t
{
    VLC_COMMON_MEMBERS

    audio_sample_format_t   input;
    audio_sample_format_t   output;
    aout_alloc_t            output_alloc;

    module_t *              p_module;
208 209 210 211 212 213 214 215 216 217 218 219 220
    aout_filter_sys_t       *p_sys;

    bool                    b_in_place;
    bool                    b_continuity;

    void                    (*pf_do_work)( aout_instance_t *, aout_filter_t *,
                                           aout_buffer_t *, aout_buffer_t * );

    /* Owner fieldS
     * XXX You MUST not use them directly */

    /* Vout callback
     * XXX use aout_filter_RequestVout */
221
    aout_request_vout_t request_vout;
222 223 224

    /* Private structure for the owner of the filter */
    aout_filter_owner_sys_t *p_owner;
Clément Stenac's avatar
Clément Stenac committed
225 226 227 228 229 230 231 232 233 234 235 236
};

#define AOUT_RESAMPLING_NONE     0
#define AOUT_RESAMPLING_UP       1
#define AOUT_RESAMPLING_DOWN     2

/** an output stream for the audio output */
typedef struct aout_output_t
{
    audio_sample_format_t   output;
    /* Indicates whether the audio output is currently starving, to avoid
     * printing a 1,000 "output is starving" messages. */
237
    bool              b_starving;
Clément Stenac's avatar
Clément Stenac committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

    /* post-filters */
    aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
    int                     i_nb_filters;

    aout_fifo_t             fifo;

    struct module_t *       p_module;
    struct aout_sys_t *     p_sys;
    void                 (* pf_play)( aout_instance_t * );
    int                  (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
    int                  (* pf_volume_set )( aout_instance_t *, audio_volume_t );
    int                     i_nb_samples;

    /* Current volume for the output - it's just a placeholder, the plug-in
     * may or may not use it. */
    audio_volume_t          i_volume;

    /* If b_error == 1, there is no audio output pipeline. */
257
    bool              b_error;
Clément Stenac's avatar
Clément Stenac committed
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
} aout_output_t;

/** audio output thread descriptor */
struct aout_instance_t
{
    VLC_COMMON_MEMBERS

    /* Locks : please note that if you need several of these locks, it is
     * mandatory (to avoid deadlocks) to take them in the following order :
     * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
     * --Meuuh */
    /* When input_fifos_lock is taken, none of the p_input->fifo structures
     * can be read or modified by a third-party thread. */
    vlc_mutex_t             input_fifos_lock;
    /* When mixer_lock is taken, all decoder threads willing to mix a
     * buffer must wait until it is released. The output pipeline cannot
     * be modified. No input stream can be added or removed. */
    vlc_mutex_t             mixer_lock;
    /* When output_fifo_lock is taken, the p_aout->output.fifo structure
     * cannot be read or written  by a third-party thread. */
    vlc_mutex_t             output_fifo_lock;

    /* Input streams & pre-filters */
    aout_input_t *          pp_inputs[AOUT_MAX_INPUTS];
    int                     i_nb_inputs;

    /* Mixer */
285 286 287 288
    audio_sample_format_t   mixer_format;
    aout_alloc_t            mixer_allocation;
    float                   mixer_multiplier;
    aout_mixer_t            *p_mixer;
Clément Stenac's avatar
Clément Stenac committed
289 290 291 292 293

    /* Output plug-in */
    aout_output_t           output;
};

294 295 296 297 298 299 300 301 302 303 304
/**
 * It describes the audio channel order VLC except.
 */
static const uint32_t pi_vlc_chan_order_wg4[] =
{
    AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
    AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
    AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
    AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
};

305
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
306
 * Prototypes
307
 *****************************************************************************/
Clément Stenac's avatar
Clément Stenac committed
308

309
VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, bool ) LIBVLC_USED );
Clément Stenac's avatar
Clément Stenac committed
310

311 312 313 314 315 316 317
/**
 * This function computes the reordering needed to go from pi_chan_order_in to
 * pi_chan_order_out.
 * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
 * internal (WG4) order is requested.
 */
VLC_EXPORT( int, aout_CheckChannelReorder, ( const uint32_t *pi_chan_order_in, const uint32_t *pi_chan_order_out, uint32_t i_channel_mask, int i_channels, int *pi_chan_table ) );
318 319
VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
/**
 * This fonction will compute the extraction parameter into pi_selection to go
 * from i_channels with their type given by pi_order_src[] into the order
 * describe by pi_order_dst.
 * It will also set :
 * - *pi_channels as the number of channels that will be extracted which is
 * lower (in case of non understood channels type) or equal to i_channels.
 * - the layout of the channels (*pi_layout).
 *
 * It will return true if channel extraction is really needed, in which case
 * aout_ChannelExtract must be used
 *
 * XXX It must be used when the source may have channel type not understood
 * by VLC. In this case the channel type pi_order_src[] must be set to 0.
 * XXX It must also be used if multiple channels have the same type.
 */
VLC_EXPORT( bool, aout_CheckChannelExtraction, ( int *pi_selection, uint32_t *pi_layout, int *pi_channels, const uint32_t pi_order_dst[AOUT_CHAN_MAX], const uint32_t *pi_order_src, int i_channels ) );

/**
 * Do the actual channels extraction using the parameters created by
 * aout_CheckChannelExtraction.
 *
 * XXX this function does not work in place (p_dst and p_src must not overlap).
 * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
 */
VLC_EXPORT( void, aout_ChannelExtract, ( void *p_dst, int i_dst_channels, const void *p_src, int i_src_channels, int i_sample_count, const int *pi_selection, int i_bits_per_sample ) );

/* */
348 349
VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) LIBVLC_USED );
VLC_EXPORT( unsigned int, aout_BitsPerSample, ( vlc_fourcc_t i_format ) LIBVLC_USED );
Clément Stenac's avatar
Clément Stenac committed
350 351
VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
352
VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) LIBVLC_USED );
Clément Stenac's avatar
Clément Stenac committed
353

354 355
VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) LIBVLC_USED );
VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) LIBVLC_USED );
356

357
/* From intf.c : */
Clément Stenac's avatar
Clément Stenac committed
358 359
VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
360 361 362 363 364 365 366 367
#define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
#define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
#define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
#define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
368 369
#define aout_ToggleMute(a, b) __aout_ToggleMute(VLC_OBJECT(a), b)
VLC_EXPORT( int, __aout_ToggleMute, ( vlc_object_t *, audio_volume_t * ) );
Gildas Bazin's avatar
 
Gildas Bazin committed
370
VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
371
VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
Clément Stenac's avatar
Clément Stenac committed
372

373
VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, bool ));
374 375
#define aout_EnableFilter( o, n, b ) \
        aout_EnableFilter( VLC_OBJECT(o), n, b )
376

377 378 379
/* */
VLC_EXPORT( vout_thread_t *, aout_filter_RequestVout, ( aout_filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) );

Clément Stenac's avatar
Clément Stenac committed
380 381 382 383 384
# ifdef __cplusplus
}
# endif

#endif /* _VLC_AOUT_H */