vlc_aout.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:18k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * audio_output.h : audio output interface
  3.  *****************************************************************************
  4.  * Copyright (C) 2002-2005 the VideoLAN team
  5.  * $Id: 00b7e2e6b13cdf550528c25f8a06fe1014d17aa8 $
  6.  *
  7.  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23. #ifndef VLC_AOUT_H
  24. #define VLC_AOUT_H 1
  25. /**
  26.  * file
  27.  * This file defines functions, structures and macros for audio output object
  28.  */
  29. # ifdef __cplusplus
  30. extern "C" {
  31. # endif
  32. #include "vlc_es.h"
  33. #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          
  34.     ((p_first)->i_format == (p_second)->i_format)                           
  35.       && ((p_first)->i_rate == (p_second)->i_rate)                          
  36.       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)
  37.       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
  38. /* Check if i_rate == i_rate and i_channels == i_channels */
  39. #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            
  40.     ((p_first)->i_rate == (p_second)->i_rate)                               
  41.       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)
  42.       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
  43. #ifdef WORDS_BIGENDIAN
  44. #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','b')
  45. #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','b')
  46. #   define AOUT_FMT_S24_NE VLC_FOURCC('s','2','4','b')
  47. #   define AOUT_FMT_S32_NE VLC_FOURCC('s','3','2','b')
  48. #   define AOUT_FMT_SPDIF_NE VLC_FOURCC('s','p','d','b')
  49. #else
  50. #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
  51. #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
  52. #   define AOUT_FMT_S24_NE VLC_FOURCC('s','2','4','l')
  53. #   define AOUT_FMT_S32_NE VLC_FOURCC('s','3','2','l')
  54. #   define AOUT_FMT_SPDIF_NE VLC_FOURCC('s','p','d','i')
  55. #endif
  56. #define AOUT_FMT_NON_LINEAR( p_format )                                    
  57.     ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i'))                
  58.        || ((p_format)->i_format == VLC_FOURCC('s','p','d','b'))            
  59.        || ((p_format)->i_format == VLC_FOURCC('a','5','2',' '))            
  60.        || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
  61. /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
  62. /*
  63.  * Fixed-point format: 0xABBBBBBB
  64.  * A == whole part      (sign + 3 bits)
  65.  * B == fractional part (28 bits)
  66.  *
  67.  * Values are signed two's complement, so the effective range is:
  68.  * 0x80000000 to 0x7fffffff
  69.  *       -8.0 to +7.9999999962747097015380859375
  70.  *
  71.  * The smallest representable value is:
  72.  * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
  73.  *
  74.  * 28 bits of fractional accuracy represent about
  75.  * 8.6 digits of decimal accuracy.
  76.  *
  77.  * Fixed-point numbers can be added or subtracted as normal
  78.  * integers, but multiplication requires shifting the 64-bit result
  79.  * from 56 fractional bits back to 28 (and rounding.)
  80.  */
  81. typedef int32_t vlc_fixed_t;
  82. #define FIXED32_FRACBITS 28
  83. #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
  84. #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
  85. #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
  86. /*
  87.  * Channels descriptions
  88.  */
  89. /* Values available for physical and original channels */
  90. #define AOUT_CHAN_CENTER            0x1
  91. #define AOUT_CHAN_LEFT              0x2
  92. #define AOUT_CHAN_RIGHT             0x4
  93. #define AOUT_CHAN_REARCENTER        0x10
  94. #define AOUT_CHAN_REARLEFT          0x20
  95. #define AOUT_CHAN_REARRIGHT         0x40
  96. #define AOUT_CHAN_MIDDLELEFT        0x100
  97. #define AOUT_CHAN_MIDDLERIGHT       0x200
  98. #define AOUT_CHAN_LFE               0x1000
  99. /* Values available for original channels only */
  100. #define AOUT_CHAN_DOLBYSTEREO       0x10000
  101. #define AOUT_CHAN_DUALMONO          0x20000
  102. #define AOUT_CHAN_REVERSESTEREO     0x40000
  103. #define AOUT_CHAN_PHYSMASK          0xFFFF
  104. #define AOUT_CHAN_MAX               9
  105. /* Values used for the audio-device and audio-channels object variables */
  106. #define AOUT_VAR_MONO               1
  107. #define AOUT_VAR_STEREO             2
  108. #define AOUT_VAR_2F2R               4
  109. #define AOUT_VAR_3F2R               5
  110. #define AOUT_VAR_5_1                6
  111. #define AOUT_VAR_6_1                7
  112. #define AOUT_VAR_7_1                8
  113. #define AOUT_VAR_SPDIF              10
  114. #define AOUT_VAR_CHAN_STEREO        1
  115. #define AOUT_VAR_CHAN_RSTEREO       2
  116. #define AOUT_VAR_CHAN_LEFT          3
  117. #define AOUT_VAR_CHAN_RIGHT         4
  118. #define AOUT_VAR_CHAN_DOLBYS        5
  119. /*****************************************************************************
  120.  * Main audio output structures
  121.  *****************************************************************************/
  122. /** audio output buffer */
  123. struct aout_buffer_t
  124. {
  125.     uint8_t *               p_buffer;
  126.     int                     i_alloc_type;
  127.     /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
  128.      * is the number of significative bytes in it. */
  129.     size_t                  i_size, i_nb_bytes;
  130.     unsigned int            i_nb_samples;
  131.     mtime_t                 start_date, end_date;
  132.     bool                    b_discontinuity; /* Set on discontinuity (for non pcm stream) */
  133.     struct aout_buffer_t *  p_next;
  134.     /** Private data (aout_buffer_t will disappear soon so no need for an
  135.      * aout_buffer_sys_t type) */
  136.     void * p_sys;
  137.     /** This way the release can be overloaded */
  138.     void (*pf_release)( aout_buffer_t * );
  139. };
  140. #define aout_BufferFree( p_buffer ) do {                                    
  141.     if( p_buffer != NULL && (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )   
  142.     {                                                                       
  143.         free( p_buffer );                                                   
  144.     }                                                                       
  145.     p_buffer = NULL; } while(0)
  146. /* Size of a frame for S/PDIF output. */
  147. #define AOUT_SPDIF_SIZE 6144
  148. /* Number of samples in an A/52 frame. */
  149. #define A52_FRAME_NB 1536
  150. /* Max input rate factor (1/4 -> 4) */
  151. #define AOUT_MAX_INPUT_RATE (4)
  152. /** date incrementation helper structure without long-term
  153.  * rounding errors
  154.  */
  155. struct audio_date_t
  156. {
  157.     mtime_t  date;
  158.     uint32_t i_divider;
  159.     uint32_t i_remainder;
  160. };
  161. /** allocation of memory in the audio output */
  162. typedef struct aout_alloc_t
  163. {
  164.     int                     i_alloc_type;
  165.     int                     i_bytes_per_sec;
  166. } aout_alloc_t;
  167. #define AOUT_ALLOC_NONE     0
  168. #define AOUT_ALLOC_STACK    1
  169. #define AOUT_ALLOC_HEAP     2
  170. /** audio output mixer */
  171. typedef struct aout_mixer_t
  172. {
  173.     audio_sample_format_t   mixer;
  174.     aout_alloc_t            output_alloc;
  175.     module_t *              p_module;
  176.     struct aout_mixer_sys_t * p_sys;
  177.     void                 (* pf_do_work)( struct aout_instance_t *,
  178.                                          struct aout_buffer_t * );
  179.     /** If b_error == 1, there is no mixer. */
  180.     bool              b_error;
  181.     /** Multiplier used to raise or lower the volume of the sound in
  182.      * software. Beware, this creates sound distortion and should be avoided
  183.      * as much as possible. This isn't available for non-float32 mixer. */
  184.     float                   f_multiplier;
  185. } aout_mixer_t;
  186. /** audio output buffer FIFO */
  187. struct aout_fifo_t
  188. {
  189.     aout_buffer_t *         p_first;
  190.     aout_buffer_t **        pp_last;
  191.     audio_date_t            end_date;
  192. };
  193. /* */
  194. typedef struct
  195. {
  196.     vout_thread_t  *(*pf_request_vout)( void *,
  197.                                         vout_thread_t *, video_format_t *, bool b_recycle );
  198.     void *p_private;
  199. } aout_request_vout_t;
  200. /** audio output filter */
  201. typedef struct aout_filter_owner_sys_t aout_filter_owner_sys_t;
  202. typedef struct aout_filter_sys_t aout_filter_sys_t;
  203. struct aout_filter_t
  204. {
  205.     VLC_COMMON_MEMBERS
  206.     audio_sample_format_t   input;
  207.     audio_sample_format_t   output;
  208.     aout_alloc_t            output_alloc;
  209.     module_t *              p_module;
  210.     aout_filter_sys_t       *p_sys;
  211.     bool                    b_in_place;
  212.     bool                    b_continuity;
  213.     void                    (*pf_do_work)( aout_instance_t *, aout_filter_t *,
  214.                                            aout_buffer_t *, aout_buffer_t * );
  215.     /* Owner fieldS
  216.      * XXX You MUST not use them directly */
  217.     /* Vout callback
  218.      * XXX use aout_filter_RequestVout */
  219.     aout_request_vout_t request_vout;
  220.     /* Private structure for the owner of the filter */
  221.     aout_filter_owner_sys_t *p_owner;
  222. };
  223. #define AOUT_RESAMPLING_NONE     0
  224. #define AOUT_RESAMPLING_UP       1
  225. #define AOUT_RESAMPLING_DOWN     2
  226. /** an input stream for the audio output */
  227. struct aout_input_t
  228. {
  229.     /* When this lock is taken, the pipeline cannot be changed by a
  230.      * third-party. */
  231.     vlc_mutex_t             lock;
  232.     audio_sample_format_t   input;
  233.     aout_alloc_t            input_alloc;
  234.     /* pre-filters */
  235.     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
  236.     int                     i_nb_filters;
  237.     aout_filter_t *         p_playback_rate_filter;
  238.     /* resamplers */
  239.     aout_filter_t *         pp_resamplers[AOUT_MAX_FILTERS];
  240.     int                     i_nb_resamplers;
  241.     int                     i_resampling_type;
  242.     mtime_t                 i_resamp_start_date;
  243.     int                     i_resamp_start_drift;
  244.     aout_fifo_t             fifo;
  245.     /* Mixer information */
  246.     uint8_t *               p_first_byte_to_mix;
  247.     audio_replay_gain_t     replay_gain;
  248.     float                   f_multiplier;
  249.     /* If b_restart == 1, the input pipeline will be re-created. */
  250.     bool              b_restart;
  251.     /* If b_error == 1, there is no input pipeline. */
  252.     bool              b_error;
  253.     /* Did we just change the output format? (expect buffer inconsistencies) */
  254.     bool              b_changed;
  255.     /* last rate from input */
  256.     int               i_last_input_rate;
  257.     /* */
  258.     int               i_buffer_lost;
  259.     /* */
  260.     bool              b_paused;
  261.     mtime_t           i_pause_date;
  262.     /* */
  263.     bool                b_recycle_vout;
  264.     aout_request_vout_t request_vout;
  265.  };
  266. /** an output stream for the audio output */
  267. typedef struct aout_output_t
  268. {
  269.     audio_sample_format_t   output;
  270.     /* Indicates whether the audio output is currently starving, to avoid
  271.      * printing a 1,000 "output is starving" messages. */
  272.     bool              b_starving;
  273.     /* post-filters */
  274.     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
  275.     int                     i_nb_filters;
  276.     aout_fifo_t             fifo;
  277.     struct module_t *       p_module;
  278.     struct aout_sys_t *     p_sys;
  279.     void                 (* pf_play)( aout_instance_t * );
  280.     int                  (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
  281.     int                  (* pf_volume_set )( aout_instance_t *, audio_volume_t );
  282.     int                  (* pf_volume_infos )( aout_instance_t *, audio_volume_t * );
  283.     int                     i_nb_samples;
  284.     /* Current volume for the output - it's just a placeholder, the plug-in
  285.      * may or may not use it. */
  286.     audio_volume_t          i_volume;
  287.     /* If b_error == 1, there is no audio output pipeline. */
  288.     bool              b_error;
  289. } aout_output_t;
  290. /** audio output thread descriptor */
  291. struct aout_instance_t
  292. {
  293.     VLC_COMMON_MEMBERS
  294.     /* Locks : please note that if you need several of these locks, it is
  295.      * mandatory (to avoid deadlocks) to take them in the following order :
  296.      * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
  297.      * --Meuuh */
  298.     /* When input_fifos_lock is taken, none of the p_input->fifo structures
  299.      * can be read or modified by a third-party thread. */
  300.     vlc_mutex_t             input_fifos_lock;
  301.     /* When mixer_lock is taken, all decoder threads willing to mix a
  302.      * buffer must wait until it is released. The output pipeline cannot
  303.      * be modified. No input stream can be added or removed. */
  304.     vlc_mutex_t             mixer_lock;
  305.     /* When output_fifo_lock is taken, the p_aout->output.fifo structure
  306.      * cannot be read or written  by a third-party thread. */
  307.     vlc_mutex_t             output_fifo_lock;
  308.     /* Input streams & pre-filters */
  309.     aout_input_t *          pp_inputs[AOUT_MAX_INPUTS];
  310.     int                     i_nb_inputs;
  311.     /* Mixer */
  312.     aout_mixer_t            mixer;
  313.     /* Output plug-in */
  314.     aout_output_t           output;
  315. };
  316. /**
  317.  * It describes the audio channel order VLC except.
  318.  */
  319. static const uint32_t pi_vlc_chan_order_wg4[] =
  320. {
  321.     AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
  322.     AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
  323.     AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, AOUT_CHAN_REARCENTER,
  324.     AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0
  325. };
  326. /*****************************************************************************
  327.  * Prototypes
  328.  *****************************************************************************/
  329. /* From common.c : */
  330. VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
  331. VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
  332. VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
  333. VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) LIBVLC_USED);
  334. VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
  335. VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, bool ) LIBVLC_USED );
  336. /**
  337.  * This function computes the reordering needed to go from pi_chan_order_in to
  338.  * pi_chan_order_out.
  339.  * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc
  340.  * internal (WG4) order is requested.
  341.  */
  342. 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 ) );
  343. VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );
  344. /**
  345.  * This fonction will compute the extraction parameter into pi_selection to go
  346.  * from i_channels with their type given by pi_order_src[] into the order
  347.  * describe by pi_order_dst.
  348.  * It will also set :
  349.  * - *pi_channels as the number of channels that will be extracted which is
  350.  * lower (in case of non understood channels type) or equal to i_channels.
  351.  * - the layout of the channels (*pi_layout).
  352.  *
  353.  * It will return true if channel extraction is really needed, in which case
  354.  * aout_ChannelExtract must be used
  355.  *
  356.  * XXX It must be used when the source may have channel type not understood
  357.  * by VLC. In this case the channel type pi_order_src[] must be set to 0.
  358.  * XXX It must also be used if multiple channels have the same type.
  359.  */
  360. 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 ) );
  361. /**
  362.  * Do the actual channels extraction using the parameters created by
  363.  * aout_CheckChannelExtraction.
  364.  *
  365.  * XXX this function does not work in place (p_dst and p_src must not overlap).
  366.  * XXX Only 8, 16, 24, 32, 64 bits per sample are supported.
  367.  */
  368. 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 ) );
  369. /* */
  370. VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) LIBVLC_USED );
  371. VLC_EXPORT( unsigned int, aout_BitsPerSample, ( vlc_fourcc_t i_format ) LIBVLC_USED );
  372. VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
  373. VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
  374. VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) LIBVLC_USED );
  375. VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) LIBVLC_USED );
  376. VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) LIBVLC_USED );
  377. /* From intf.c : */
  378. VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
  379. VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
  380. #define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
  381. VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
  382. #define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
  383. VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
  384. #define aout_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
  385. VLC_EXPORT( int, __aout_VolumeInfos, ( vlc_object_t *, audio_volume_t * ) );
  386. #define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
  387. VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
  388. #define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
  389. VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
  390. #define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
  391. VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
  392. VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
  393. VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
  394. VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, bool ));
  395. #define aout_VisualNext(a) aout_VisualChange( VLC_OBJECT(a),1 )
  396. #define aout_VisualPrev(a) aout_VisualChange( VLC_OBJECT(a),-1 )
  397. VLC_EXPORT( char *, aout_VisualChange, (vlc_object_t *, int ) );
  398. /* */
  399. VLC_EXPORT( vout_thread_t *, aout_filter_RequestVout, ( aout_filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) );
  400. # ifdef __cplusplus
  401. }
  402. # endif
  403. #endif /* _VLC_AOUT_H */