include/vlc_aout.h

   1 /*****************************************************************************
   2  * vlc_aout.h : audio output interface
   3  *****************************************************************************
   4  * Copyright (C) 2002-2011 VLC authors and VideoLAN
   5  *
   6  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 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
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifndef VLC_AOUT_H
  24 #define VLC_AOUT_H 1
  25
  26 #include <assert.h>
  27
  28 /**
  29  * \defgroup audio_output Audio output
  30  * \ingroup output
  31  * @{
  32  * \file
  33  * Audio output modules interface
  34  */
  35
  36 /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME
  37  * will be considered as bogus and be trashed */
  38 #define AOUT_MAX_ADVANCE_TIME           (AOUT_MAX_PREPARE_TIME + CLOCK_FREQ)
  39
  40 /* Buffers which arrive in advance of more than AOUT_MAX_PREPARE_TIME
  41  * will cause the calling thread to sleep */
  42 #define AOUT_MAX_PREPARE_TIME           (2 * CLOCK_FREQ)
  43
  44 /* Buffers which arrive after pts - AOUT_MIN_PREPARE_TIME will be trashed
  45  * to avoid too heavy resampling */
  46 #define AOUT_MIN_PREPARE_TIME           AOUT_MAX_PTS_ADVANCE
  47
  48 /* Tolerance values from EBU Recommendation 37 */
  49 /** Maximum advance of actual audio playback time to coded PTS,
  50  * above which downsampling will be performed */
  51 #define AOUT_MAX_PTS_ADVANCE            (CLOCK_FREQ / 25)
  52
  53 /** Maximum delay of actual audio playback time from coded PTS,
  54  * above which upsampling will be performed */
  55 #define AOUT_MAX_PTS_DELAY              (3 * CLOCK_FREQ / 50)
  56
  57 /* Max acceptable resampling (in %) */
  58 #define AOUT_MAX_RESAMPLING             10
  59
  60 #include "vlc_es.h"
  61
  62 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
  63     ((p_first)->i_format == (p_second)->i_format)                           \
  64       && AOUT_FMTS_SIMILAR(p_first, p_second) )
  65
  66 /* Check if i_rate == i_rate and i_channels == i_channels */
  67 #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
  68     ((p_first)->i_rate == (p_second)->i_rate)                               \
  69       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
  70       && ((p_first)->i_chan_mode == (p_second)->i_chan_mode) )
  71
  72 #define AOUT_FMT_LINEAR( p_format ) \
  73     (aout_BitsPerSample((p_format)->i_format) != 0)
  74
  75 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
  76 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
  77
  78 #define AOUT_FMT_SPDIF( p_format ) \
  79     ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
  80        || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
  81        || ((p_format)->i_format == VLC_CODEC_A52)      \
  82        || ((p_format)->i_format == VLC_CODEC_DTS) )
  83
  84 #define AOUT_FMT_HDMI( p_format )                   \
  85     ( (p_format)->i_format == VLC_CODEC_EAC3        \
  86     ||(p_format)->i_format == VLC_CODEC_TRUEHD      \
  87     ||(p_format)->i_format == VLC_CODEC_MLP         \
  88     )
  89
  90 /* Values used for the audio-channels object variable */
  91 #define AOUT_VAR_CHAN_UNSET         0 /* must be zero */
  92 #define AOUT_VAR_CHAN_STEREO        1
  93 #define AOUT_VAR_CHAN_RSTEREO       2
  94 #define AOUT_VAR_CHAN_LEFT          3
  95 #define AOUT_VAR_CHAN_RIGHT         4
  96 #define AOUT_VAR_CHAN_DOLBYS        5
  97
  98 /*****************************************************************************
  99  * Main audio output structures
 100  *****************************************************************************/
 101
 102 /* Size of a frame for S/PDIF output. */
 103 #define AOUT_SPDIF_SIZE 6144
 104
 105 /* Number of samples in an A/52 frame. */
 106 #define A52_FRAME_NB 1536
 107
 108 /* FIXME to remove once aout.h is cleaned a bit more */
 109 #include <vlc_block.h>
 110
 111 /** Audio output object */
 112 struct audio_output
 113 {
 114     VLC_COMMON_MEMBERS
 115
 116     struct aout_sys_t *sys; /**< Private data for callbacks */
 117
 118     int (*start)(audio_output_t *, audio_sample_format_t *fmt);
 119     /**< Starts a new stream (mandatory, cannot be NULL).
 120       * \param fmt input stream sample format upon entry,
 121       *            output stream sample format upon return [IN/OUT]
 122       * \return VLC_SUCCESS on success, non-zero on failure
 123       * \note No other stream may be already started when called.
 124       */
 125     void (*stop)(audio_output_t *);
 126     /**< Stops the existing stream (optional, may be NULL).
 127       * \note A stream must have been started when called.
 128       */
 129     int (*time_get)(audio_output_t *, mtime_t *delay);
 130     /**< Estimates playback buffer latency (optional, may be NULL).
 131       * \param delay pointer to the delay until the next sample to be written
 132       *              to the playback buffer is rendered [OUT]
 133       * \return 0 on success, non-zero on failure or lack of data
 134       * \note A stream must have been started when called.
 135       */
 136     void (*play)(audio_output_t *, block_t *);
 137     /**< Queues a block of samples for playback (mandatory, cannot be NULL).
 138       * \note A stream must have been started when called.
 139       */
 140     void (*pause)( audio_output_t *, bool pause, mtime_t date);
 141     /**< Pauses or resumes playback (optional, may be NULL).
 142       * \param pause pause if true, resume from pause if false
 143       * \param date timestamp when the pause or resume was requested
 144       * \note A stream must have been started when called.
 145       */
 146     void (*flush)( audio_output_t *, bool wait);
 147     /**< Flushes or drains the playback buffers (mandatory, cannot be NULL).
 148       * \param wait true to wait for playback of pending buffers (drain),
 149       *             false to discard pending buffers (flush)
 150       * \note A stream must have been started when called.
 151       */
 152     int (*volume_set)(audio_output_t *, float volume);
 153     /**< Changes playback volume (optional, may be NULL).
 154       * \param volume requested volume (0. = mute, 1. = nominal)
 155       * \note The volume is always a positive number.
 156       * \warning A stream may or may not have been started when called.
 157       */
 158     int (*mute_set)(audio_output_t *, bool mute);
 159     /**< Changes muting (optinal, may be NULL).
 160       * \param mute true to mute, false to unmute
 161       * \warning A stream may or may not have been started when called.
 162       */
 163     int (*device_select)(audio_output_t *, const char *id);
 164     /**< Selects an audio output device (optional, may be NULL).
 165       * \param id nul-terminated device unique identifier.
 166       * \return 0 on success, non-zero on failure.
 167       * \warning A stream may or may not have been started when called.
 168       */
 169     struct {
 170         void (*volume_report)(audio_output_t *, float);
 171         void (*mute_report)(audio_output_t *, bool);
 172         void (*policy_report)(audio_output_t *, bool);
 173         void (*device_report)(audio_output_t *, const char *);
 174         void (*hotplug_report)(audio_output_t *, const char *, const char *);
 175         int (*gain_request)(audio_output_t *, float);
 176         void (*restart_request)(audio_output_t *, unsigned);
 177     } event;
 178 };
 179
 180 typedef enum
 181 {
 182     AOUT_CHANIDX_DISABLE = -1,
 183     AOUT_CHANIDX_LEFT,
 184     AOUT_CHANIDX_RIGHT,
 185     AOUT_CHANIDX_MIDDLELEFT,
 186     AOUT_CHANIDX_MIDDLERIGHT,
 187     AOUT_CHANIDX_REARLEFT,
 188     AOUT_CHANIDX_REARRIGHT,
 189     AOUT_CHANIDX_REARCENTER,
 190     AOUT_CHANIDX_CENTER,
 191     AOUT_CHANIDX_LFE,
 192     AOUT_CHANIDX_MAX
 193 } vlc_chan_order_idx_t;
 194
 195 static_assert(AOUT_CHANIDX_MAX == AOUT_CHAN_MAX, "channel count mismatch");
 196
 197 #define AOUT_CHAN_REMAP_INIT { \
 198     AOUT_CHANIDX_LEFT,  \
 199     AOUT_CHANIDX_RIGHT, \
 200     AOUT_CHANIDX_MIDDLELEFT, \
 201     AOUT_CHANIDX_MIDDLERIGHT, \
 202     AOUT_CHANIDX_REARLEFT, \
 203     AOUT_CHANIDX_REARRIGHT, \
 204     AOUT_CHANIDX_REARCENTER, \
 205     AOUT_CHANIDX_CENTER, \
 206     AOUT_CHANIDX_LFE, \
 207 }
 208
 209 /**
 210  * It describes the audio channel order VLC expect.
 211  */
 212 static const uint32_t pi_vlc_chan_order_wg4[] =
 213 {
 214     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
 215     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
 216     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
 217     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
 218 };
 219
 220 #define AOUT_RESTART_FILTERS        0x1
 221 #define AOUT_RESTART_OUTPUT         (AOUT_RESTART_FILTERS|0x2)
 222 #define AOUT_RESTART_STEREOMODE     (AOUT_RESTART_OUTPUT|0x4)
 223
 224 /*****************************************************************************
 225  * Prototypes
 226  *****************************************************************************/
 227
 228 /**
 229  * This function computes the reordering needed to go from pi_chan_order_in to
 230  * pi_chan_order_out.
 231  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
 232  * internal (WG4) order is requested.
 233  */
 234 VLC_API unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *,
 235                                            uint32_t mask, uint8_t *table );
 236 VLC_API void aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t);
 237
 238 VLC_API void aout_Interleave(void *dst, const void *const *planes,
 239                              unsigned samples, unsigned channels,
 240                              vlc_fourcc_t fourcc);
 241 VLC_API void aout_Deinterleave(void *dst, const void *src, unsigned samples,
 242                              unsigned channels, vlc_fourcc_t fourcc);
 243
 244 /**
 245  * This function will compute the extraction parameter into pi_selection to go
 246  * from i_channels with their type given by pi_order_src[] into the order
 247  * describe by pi_order_dst.
 248  * It will also set :
 249  * - *pi_channels as the number of channels that will be extracted which is
 250  * lower (in case of non understood channels type) or equal to i_channels.
 251  * - the layout of the channels (*pi_layout).
 252  *
 253  * It will return true if channel extraction is really needed, in which case
 254  * aout_ChannelExtract must be used
 255  *
 256  * XXX It must be used when the source may have channel type not understood
 257  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
 258  * XXX It must also be used if multiple channels have the same type.
 259  */
 260 VLC_API 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 );
 261
 262 /**
 263  * Do the actual channels extraction using the parameters created by
 264  * aout_CheckChannelExtraction.
 265  *
 266  * XXX this function does not work in place (p_dst and p_src must not overlap).
 267  * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
 268  */
 269 VLC_API 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 );
 270
 271 /* */
 272 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
 273 {
 274     return popcount(fmt->i_physical_channels);
 275 }
 276
 277 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
 278 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
 279 VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
 280                               const audio_sample_format_t *);
 281 #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
 282 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
 283
 284 VLC_API float aout_VolumeGet (audio_output_t *);
 285 VLC_API int aout_VolumeSet (audio_output_t *, float);
 286 VLC_API int aout_MuteGet (audio_output_t *);
 287 VLC_API int aout_MuteSet (audio_output_t *, bool);
 288 VLC_API char *aout_DeviceGet (audio_output_t *);
 289 VLC_API int aout_DeviceSet (audio_output_t *, const char *);
 290 VLC_API int aout_DevicesList (audio_output_t *, char ***, char ***);
 291
 292 /**
 293  * Report change of configured audio volume to the core and UI.
 294  */
 295 static inline void aout_VolumeReport(audio_output_t *aout, float volume)
 296 {
 297     aout->event.volume_report(aout, volume);
 298 }
 299
 300 /**
 301  * Report change of muted flag to the core and UI.
 302  */
 303 static inline void aout_MuteReport(audio_output_t *aout, bool mute)
 304 {
 305     aout->event.mute_report(aout, mute);
 306 }
 307
 308 /**
 309  * Report audio policy status.
 310  * \param cork true to request a cork, false to undo any pending cork.
 311  */
 312 static inline void aout_PolicyReport(audio_output_t *aout, bool cork)
 313 {
 314     aout->event.policy_report(aout, cork);
 315 }
 316
 317 /**
 318  * Report change of output device.
 319  */
 320 static inline void aout_DeviceReport(audio_output_t *aout, const char *id)
 321 {
 322     aout->event.device_report(aout, id);
 323 }
 324
 325 /**
 326  * Report a device hot-plug event.
 327  * @param id device ID
 328  * @param name human-readable device name (NULL for hot unplug)
 329  */
 330 static inline void aout_HotplugReport(audio_output_t *aout,
 331                                       const char *id, const char *name)
 332 {
 333     aout->event.hotplug_report(aout, id, name);
 334 }
 335
 336 /**
 337  * Request a change of software audio amplification.
 338  * \param gain linear amplitude gain (must be positive)
 339  * \warning Values in excess 1.0 may cause overflow and distorsion.
 340  */
 341 static inline int aout_GainRequest(audio_output_t *aout, float gain)
 342 {
 343     return aout->event.gain_request(aout, gain);
 344 }
 345
 346 static inline void aout_RestartRequest(audio_output_t *aout, unsigned mode)
 347 {
 348     aout->event.restart_request(aout, mode);
 349 }
 350
 351 /* Audio output filters */
 352 typedef struct aout_filters aout_filters_t;
 353 typedef struct aout_request_vout aout_request_vout_t;
 354
 355 VLC_API aout_filters_t *aout_FiltersNew(vlc_object_t *,
 356                                         const audio_sample_format_t *,
 357                                         const audio_sample_format_t *,
 358                                         const aout_request_vout_t *,
 359                                         const int *remap) VLC_USED;
 360 #define aout_FiltersNew(o,inf,outf,rv,remap) \
 361         aout_FiltersNew(VLC_OBJECT(o),inf,outf,rv,remap)
 362 VLC_API void aout_FiltersDelete(vlc_object_t *, aout_filters_t *);
 363 #define aout_FiltersDelete(o,f) \
 364         aout_FiltersDelete(VLC_OBJECT(o),f)
 365 VLC_API bool aout_FiltersAdjustResampling(aout_filters_t *, int);
 366 VLC_API block_t *aout_FiltersPlay(aout_filters_t *, block_t *, int rate);
 367 VLC_API block_t *aout_FiltersDrain(aout_filters_t *);
 368 VLC_API void     aout_FiltersFlush(aout_filters_t *);
 369
 370 VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, const video_format_t *p_fmt );
 371
 372 /** @} */
 373
 374 #endif /* VLC_AOUT_H */