/*****************************************************************************
- * audio_output.h : audio output thread interface
+ * audio_output.h : audio output interface
*****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
- * $Id: audio_output.h,v 1.40 2002/01/09 00:33:37 asmax Exp $
+ * Copyright (C) 2002 VideoLAN
+ * $Id: audio_output.h,v 1.61 2002/08/21 22:41:59 massiot Exp $
*
- * Authors: Michel Kaempf <maxx@via.ecp.fr>
- * Cyril Deguet <asmax@via.ecp.fr>
+ * Authors: Christophe Massiot <massiot@via.ecp.fr>
*
* 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
*****************************************************************************/
/*****************************************************************************
- * aout_bank_t, p_aout_bank (global variable)
+ * audio_sample_format_t
*****************************************************************************
- * This global variable is accessed by any function using the audio output.
+ * This structure defines a format for audio samples.
*****************************************************************************/
-typedef struct aout_bank_s
+struct audio_sample_format_t
{
- /* Array to all the audio outputs */
- struct aout_thread_s *pp_aout[ AOUT_MAX_THREADS ];
-
- int i_count;
- vlc_mutex_t lock; /* Global lock */
-
-} aout_bank_t;
+ int i_format;
+ int i_rate;
+ int i_channels;
+ /* Optional - for A52, SPDIF and DTS types */
+ int i_bytes_per_frame;
+ int i_frame_length;
+ /* Please note that it may be completely arbitrary - buffers are not
+ * obliged to contain a integral number of so-called "frames". It's
+ * just here for the division :
+ * i_nb_samples * i_bytes_per_frame / i_frame_length */
+};
+
+#define AOUT_FMT_MU_LAW 0x00000001
+#define AOUT_FMT_A_LAW 0x00000002
+#define AOUT_FMT_IMA_ADPCM 0x00000004
+#define AOUT_FMT_U8 0x00000008
+#define AOUT_FMT_S16_LE 0x00000010 /* Little endian signed 16 */
+#define AOUT_FMT_S16_BE 0x00000020 /* Big endian signed 16 */
+#define AOUT_FMT_S8 0x00000040
+#define AOUT_FMT_U16_LE 0x00000080 /* Little endian U16 */
+#define AOUT_FMT_U16_BE 0x00000100 /* Big endian U16 */
+#define AOUT_FMT_SPDIF 0x00000400 /* S/PDIF hardware support */
+#define AOUT_FMT_FLOAT32 0x00010000
+#define AOUT_FMT_FIXED32 0x00020000
+#define AOUT_FMT_A52 0x00100000
+#define AOUT_FMT_DTS 0x00200000
+
+#define AOUT_FMTS_IDENTICAL( p_first, p_second ) ( \
+ ((p_first)->i_format == (p_second)->i_format) \
+ && ((p_first)->i_rate == (p_second)->i_rate) \
+ && ((p_first)->i_channels == (p_second)->i_channels \
+ || (p_first)->i_channels == -1 || (p_second)->i_channels == -1) )
+
+/* 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) \
+ && ((p_first)->i_channels == (p_second)->i_channels \
+ || (p_first)->i_channels == -1 || (p_second)->i_channels == -1) )
-#ifndef PLUGIN
-extern aout_bank_t *p_aout_bank;
+#ifdef WORDS_BIGENDIAN
+# define AOUT_FMT_S16_NE AOUT_FMT_S16_BE
+# define AOUT_FMT_U16_NE AOUT_FMT_U16_BE
#else
-# define p_aout_bank (p_symbols->p_aout_bank)
+# define AOUT_FMT_S16_NE AOUT_FMT_S16_LE
+# define AOUT_FMT_U16_NE AOUT_FMT_U16_LE
#endif
-/*****************************************************************************
- * aout_increment_t
- *****************************************************************************
- * 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.
- *****************************************************************************/
-typedef struct aout_increment_s
-{
- /* The remainder is used to keep track of the fractional part of the
- * index. */
- long l_remainder;
+#define AOUT_FMT_NON_LINEAR( p_format ) \
+ ( ((p_format)->i_format == AOUT_FMT_SPDIF) \
+ || ((p_format)->i_format == AOUT_FMT_A52) \
+ || ((p_format)->i_format == AOUT_FMT_DTS) )
- /*
- * 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;
+/* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
+/*
+ * Fixed-point format: 0xABBBBBBB
+ * A == whole part (sign + 3 bits)
+ * B == fractional part (28 bits)
+ *
+ * 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.
+ *
+ * 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.)
+ */
+typedef s32 vlc_fixed_t;
+#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)
-} aout_increment_t;
/*****************************************************************************
- * aout_fifo_t
+ * aout_buffer_t : audio output buffer
*****************************************************************************/
-typedef struct aout_fifo_s
+struct aout_buffer_t
{
- /* See the fifo types below */
- int i_type;
- boolean_t b_die;
- int i_fifo; /* Just to keep track of the fifo index */
-
- int i_channels;
- boolean_t b_stereo;
- long l_rate;
-
- vlc_mutex_t data_lock;
- vlc_cond_t data_wait;
+ byte_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;
+ int i_nb_samples;
+ mtime_t start_date, end_date;
- long l_frame_size;
- 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;
+ struct aout_buffer_t * p_next;
+};
- 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_FIFO_ISEMPTY( fifo ) \
- ( (fifo).l_end_frame == (fifo).l_start_frame )
-
-#define AOUT_FIFO_ISFULL( fifo ) \
- ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )
-
-#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
-#define AOUT_ADEC_SPDIF_FIFO 5
+/* Size of a frame for S/PDIF output. */
+#define AOUT_SPDIF_SIZE 6144
/*****************************************************************************
- * aout_thread_t : audio output thread descriptor
+ * audio_date_t : date incrementation without long-term rounding errors
*****************************************************************************/
-typedef struct aout_thread_s
+struct audio_date_t
{
- vlc_thread_t thread_id;
- boolean_t b_die;
- boolean_t b_active;
-
- vlc_mutex_t fifos_lock;
- aout_fifo_t fifo[ AOUT_MAX_FIFOS ];
-
- /* Plugin used and shortcuts to access its capabilities */
- struct module_s * p_module;
- int ( *pf_open ) ( p_aout_thread_t );
- int ( *pf_setformat ) ( p_aout_thread_t );
- long ( *pf_getbufinfo ) ( p_aout_thread_t, long );
- void ( *pf_play ) ( p_aout_thread_t, byte_t *, int );
- void ( *pf_close ) ( p_aout_thread_t );
-
- 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;
- long l_msleep;
-
- /* date is the moment where the first audio unit of the output buffer
- * will be played */
- mtime_t date;
-
- /* Path to the audio output device (default is set to "/dev/dsp") */
- char * psz_device;
- int i_fd;
-
- /* The current volume */
- int i_volume;
- int i_savedvolume;
- /* Format of the audio output samples */
- int i_format;
- /* Number of channels */
- int i_channels;
- /* Mono or Stereo sound */
- boolean_t b_stereo;
- /* Rate and gain of the audio output sound (in Hz) */
- long l_rate;
- long l_gain;
- int i_latency;
-
- /* there might be some useful private structure, such as audio_buf_info
- * for the OSS output */
- p_aout_sys_t p_sys;
-
-} aout_thread_t;
-
-/* Those are from <linux/soundcard.h> but are needed because of formats
- * on other platforms */
-#define AOUT_FMT_U8 0x00000008
-#define AOUT_FMT_S16_LE 0x00000010 /* Little endian signed 16 */
-#define AOUT_FMT_S16_BE 0x00000020 /* Big endian signed 16 */
-#define AOUT_FMT_S8 0x00000040
-#define AOUT_FMT_U16_LE 0x00000080 /* Little endian U16 */
-#define AOUT_FMT_U16_BE 0x00000100 /* Big endian U16 */
-#define AOUT_FMT_AC3 0x00000400 /* Dolby Digital AC3 */
-
-#ifdef WORDS_BIGENDIAN
-#define AOUT_FMT_S16_NE AOUT_FMT_S16_BE
-#else
-#define AOUT_FMT_S16_NE AOUT_FMT_S16_LE
-#endif
-
-/* Number of samples in an AC3 frame */
-#define AC3_FRAME_SIZE 1536
-
-/* Size of a frame for spdif output */
-#define SPDIF_FRAME_SIZE 6144
+ mtime_t date;
+ u32 i_divider;
+ u32 i_remainder;
+};
/*****************************************************************************
* Prototypes
*****************************************************************************/
-#ifndef PLUGIN
-void aout_InitBank ( void );
-void aout_EndBank ( void );
-
-aout_thread_t * aout_CreateThread ( int *pi_status, int i_channels,
- long l_rate );
-void aout_DestroyThread ( aout_thread_t *, int * );
-
-aout_fifo_t * aout_CreateFifo ( int, int, long, long, long, void * );
-void aout_DestroyFifo ( aout_fifo_t *p_fifo );
-void aout_FreeFifo ( aout_fifo_t *p_fifo );
-#else
-# define aout_CreateFifo p_symbols->aout_CreateFifo
-# define aout_DestroyFifo p_symbols->aout_DestroyFifo
-#endif
+/* From audio_output.c : */
+#define aout_NewInstance(a) __aout_NewInstance(VLC_OBJECT(a))
+VLC_EXPORT( aout_instance_t *, __aout_NewInstance, ( vlc_object_t * ) );
+VLC_EXPORT( void, aout_DeleteInstance, ( aout_instance_t * ) );
+VLC_EXPORT( aout_buffer_t *, aout_BufferNew, ( aout_instance_t *, aout_input_t *, size_t ) );
+VLC_EXPORT( void, aout_BufferDelete, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
+VLC_EXPORT( void, aout_BufferPlay, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
+VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, u32 ) );
+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_DateIncrement, ( audio_date_t *, u32 ) );
+
+/* From input.c : */
+#define aout_InputNew(a,b,c) __aout_InputNew(VLC_OBJECT(a),b,c)
+VLC_EXPORT( aout_input_t *, __aout_InputNew, ( vlc_object_t *, aout_instance_t **, audio_sample_format_t * ) );
+VLC_EXPORT( void, aout_InputDelete, ( aout_instance_t *, aout_input_t * ) );