]> git.sesse.net Git - vlc/blobdiff - include/vlc_aout.h
Merge branch 1.0-bugfix
[vlc] / include / vlc_aout.h
index d3f20b6cf9eb6628180879ed07122b3c36ff6d42..21b67fbdb6a47e4ed8a9a93ab569da508bed4cdc 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_AOUT_H
+#define VLC_AOUT_H 1
 
-#ifndef _VLC_AOUT_H
-#define _VLC_AOUT_H 1
+/**
+ * \file
+ * This file defines functions, structures and macros for audio output object
+ */
 
 # ifdef __cplusplus
 extern "C" {
@@ -46,23 +47,14 @@ extern "C" {
       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
 
-#ifdef WORDS_BIGENDIAN
-#   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','b')
-#   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','b')
-#   define AOUT_FMT_S24_NE VLC_FOURCC('s','2','4','b')
-#   define AOUT_FMT_SPDIF_NE VLC_FOURCC('s','p','d','b')
-#else
-#   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
-#   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
-#   define AOUT_FMT_S24_NE VLC_FOURCC('s','2','4','l')
-#   define AOUT_FMT_SPDIF_NE VLC_FOURCC('s','p','d','i')
-#endif
-
-#define AOUT_FMT_NON_LINEAR( p_format )                                    \
-    ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i'))                \
-       || ((p_format)->i_format == VLC_FOURCC('s','p','d','b'))            \
-       || ((p_format)->i_format == VLC_FOURCC('a','5','2',' '))            \
-       || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
+#define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
+#define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
+
+#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) )
 
 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
 /*
@@ -90,7 +82,6 @@ typedef int32_t vlc_fixed_t;
 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
 
-
 /*
  * Channels descriptions
  */
@@ -137,13 +128,14 @@ typedef int32_t vlc_fixed_t;
 /** audio output buffer */
 struct aout_buffer_t
 {
-    byte_t *                p_buffer;
+    uint8_t *               p_buffer;
     int                     i_alloc_type;
     /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
      * is the number of significative bytes in it. */
     size_t                  i_size, i_nb_bytes;
     unsigned int            i_nb_samples;
     mtime_t                 start_date, end_date;
+    bool                    b_discontinuity; /* Set on discontinuity (for non pcm stream) */
 
     struct aout_buffer_t *  p_next;
 
@@ -155,12 +147,12 @@ struct aout_buffer_t
     void (*pf_release)( aout_buffer_t * );
 };
 
-#define aout_BufferFree( p_buffer )                                         \
+#define aout_BufferFree( p_buffer ) do {                                    \
     if( p_buffer != NULL && (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )   \
     {                                                                       \
         free( p_buffer );                                                   \
     }                                                                       \
-    p_buffer = NULL;
+    p_buffer = NULL; } while(0)
 
 /* Size of a frame for S/PDIF output. */
 #define AOUT_SPDIF_SIZE 6144
@@ -168,6 +160,9 @@ struct aout_buffer_t
 /* Number of samples in an A/52 frame. */
 #define A52_FRAME_NB 1536
 
+/* Max input rate factor (1/4 -> 4) */
+#define AOUT_MAX_INPUT_RATE (4)
+
 /** date incrementation helper structure without long-term
  * rounding errors
  */
@@ -201,7 +196,7 @@ typedef struct aout_mixer_t
                                          struct aout_buffer_t * );
 
     /** If b_error == 1, there is no mixer. */
-    vlc_bool_t              b_error;
+    bool              b_error;
     /** Multiplier used to raise or lower the volume of the sound in
      * software. Beware, this creates sound distortion and should be avoided
      * as much as possible. This isn't available for non-float32 mixer. */
@@ -216,7 +211,17 @@ struct aout_fifo_t
     audio_date_t            end_date;
 };
 
+/* */
+typedef struct
+{
+    vout_thread_t  *(*pf_request_vout)( void *,
+                                        vout_thread_t *, video_format_t *, bool b_recycle );
+    void *p_private;
+} aout_request_vout_t;
+
 /** audio output filter */
+typedef struct aout_filter_owner_sys_t aout_filter_owner_sys_t;
+typedef struct aout_filter_sys_t aout_filter_sys_t;
 struct aout_filter_t
 {
     VLC_COMMON_MEMBERS
@@ -226,13 +231,23 @@ struct aout_filter_t
     aout_alloc_t            output_alloc;
 
     module_t *              p_module;
-    struct aout_filter_sys_t * p_sys;
-    void                 (* pf_do_work)( struct aout_instance_t *,
-                                         struct aout_filter_t *,
-                                         struct aout_buffer_t *,
-                                         struct aout_buffer_t * );
-    vlc_bool_t              b_in_place;
-    vlc_bool_t              b_continuity;
+    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 */
+    aout_request_vout_t request_vout;
+
+    /* Private structure for the owner of the filter */
+    aout_filter_owner_sys_t *p_owner;
 };
 
 #define AOUT_RESAMPLING_NONE     0
@@ -245,9 +260,6 @@ struct aout_input_t
      * third-party. */
     vlc_mutex_t             lock;
 
-    /* The input thread that spawned this input */
-    input_thread_t         *p_input_thread;
-
     audio_sample_format_t   input;
     aout_alloc_t            input_alloc;
 
@@ -255,6 +267,8 @@ struct aout_input_t
     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
     int                     i_nb_filters;
 
+    aout_filter_t *         p_playback_rate_filter;
+
     /* resamplers */
     aout_filter_t *         pp_resamplers[AOUT_MAX_FILTERS];
     int                     i_nb_resamplers;
@@ -265,23 +279,33 @@ struct aout_input_t
     aout_fifo_t             fifo;
 
     /* Mixer information */
-    byte_t *                p_first_byte_to_mix;
+    uint8_t *               p_first_byte_to_mix;
+    audio_replay_gain_t     replay_gain;
+    float                   f_multiplier;
 
     /* If b_restart == 1, the input pipeline will be re-created. */
-    vlc_bool_t              b_restart;
+    bool              b_restart;
 
     /* If b_error == 1, there is no input pipeline. */
-    vlc_bool_t              b_error;
+    bool              b_error;
 
     /* Did we just change the output format? (expect buffer inconsistencies) */
-    vlc_bool_t              b_changed;
+    bool              b_changed;
 
-    /* internal caching delay from input */
-    int                     i_pts_delay;
-    /* desynchronisation delay request by the user */
-    int                     i_desync;
+    /* last rate from input */
+    int               i_last_input_rate;
 
-};
+    /* */
+    int               i_buffer_lost;
+
+    /* */
+    bool              b_paused;
+    mtime_t           i_pause_date;
+
+    /* */
+    bool                b_recycle_vout;
+    aout_request_vout_t request_vout;
+ };
 
 /** an output stream for the audio output */
 typedef struct aout_output_t
@@ -289,7 +313,7 @@ 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. */
-    vlc_bool_t              b_starving;
+    bool              b_starving;
 
     /* post-filters */
     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
@@ -310,7 +334,7 @@ typedef struct aout_output_t
     audio_volume_t          i_volume;
 
     /* If b_error == 1, there is no audio output pipeline. */
-    vlc_bool_t              b_error;
+    bool              b_error;
 } aout_output_t;
 
 /** audio output thread descriptor */
@@ -344,6 +368,17 @@ struct aout_instance_t
     aout_output_t           output;
 };
 
+/**
+ * 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
+};
+
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
@@ -352,21 +387,56 @@ struct aout_instance_t
 VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
 VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
 VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
-VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
+VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) LIBVLC_USED);
 VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
 
-VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, vlc_bool_t ) );
+VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, bool ) LIBVLC_USED );
 
-VLC_EXPORT( int, aout_CheckChannelReorder, ( const uint32_t *, const uint32_t *, uint32_t, int, int * ) );
+/**
+ * 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 ) );
 VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );
 
-VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) );
+/**
+ * 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 ) );
+
+/* */
+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 );
 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 ) );
-VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) );
+VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) LIBVLC_USED );
 
-VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) );
-VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
+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 );
 
 /* From intf.c : */
 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
@@ -383,17 +453,19 @@ VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
 VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
 #define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
 VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
-VLC_EXPORT( int, aout_Restart, ( aout_instance_t * p_aout ) );
 VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 
-VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, vlc_bool_t ));
+VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, bool ));
 
 #define aout_VisualNext(a) aout_VisualChange( VLC_OBJECT(a),1 )
 #define aout_VisualPrev(a) aout_VisualChange( VLC_OBJECT(a),-1 )
 
 VLC_EXPORT( char *, aout_VisualChange, (vlc_object_t *, int ) );
 
+/* */
+VLC_EXPORT( vout_thread_t *, aout_filter_RequestVout, ( aout_filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) );
+
 # ifdef __cplusplus
 }
 # endif