/*****************************************************************************
- * audio_output.h : audio output thread interface
+ * audio_output.h : audio output interface
*****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
- * $Id: audio_output.h,v 1.46 2002/04/24 00:36:24 sam Exp $
+ * Copyright (C) 2002-2005 the VideoLAN team
+ * $Id$
*
- * 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
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
+#ifndef _VLC_AUDIO_OUTPUT_H
+#define _VLC_AUDIO_OUTPUT_H 1
-/*****************************************************************************
- * aout_bank_t, p_aout_bank (global variable)
- *****************************************************************************
- * This global variable is accessed by any function using the audio output.
- *****************************************************************************/
-typedef struct aout_bank_s
-{
- /* Array to all the audio outputs */
- struct aout_thread_s *pp_aout[ AOUT_MAX_THREADS ];
+#include "vlc_es.h"
- int i_count;
- vlc_mutex_t lock; /* Global lock */
+#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_physical_channels == (p_second)->i_physical_channels)\
+ && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
-} aout_bank_t;
+/* 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_physical_channels == (p_second)->i_physical_channels)\
+ && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
-#ifndef __PLUGIN__
-extern aout_bank_t *p_aout_bank;
+#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')
#else
-# define p_aout_bank (p_symbols->p_aout_bank)
+# 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')
#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. */
- int i_r;
-
- /*
- * The increment structure is initialized with the result of an euclidean
- * division :
- *
- * i_x i_b
- * ----- = i_a + -----
- * i_y i_c
- *
- */
- int i_a, i_b, i_c;
-
-} aout_increment_t;
+#define AOUT_FMT_NON_LINEAR( p_format ) \
+ ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i')) \
+ || ((p_format)->i_format == VLC_FOURCC('a','5','2',' ')) \
+ || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
-/*****************************************************************************
- * aout_fifo_t
- *****************************************************************************/
-typedef struct aout_fifo_s
-{
- /* See the fifo formats below */
- int i_format;
- int i_channels;
- int i_rate;
- int i_frame_size;
-
- boolean_t b_die;
- int i_fifo; /* Just to keep track of the fifo index */
-
- vlc_mutex_t data_lock;
- vlc_cond_t data_wait;
-
- u8 * 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 */
- int i_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. */
- int i_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. */
- int i_end_frame;
-
- /* Current index in p_aout->buffer */
- int i_unit;
- /* Max index in p_aout->buffer */
- int i_unit_limit;
- /* Structure used to calculate i_unit with a Bresenham algorithm */
- aout_increment_t unit_increment;
-
- /* The following variable is used to store the number of remaining audio
- * units in the current timestamped frame area. */
- int i_units;
-
-} aout_fifo_t;
-
-#define AOUT_FIFO_ISEMPTY( fifo ) \
- ( (fifo).i_end_frame == (fifo).i_start_frame )
-
-#define AOUT_FIFO_ISFULL( fifo ) \
- ( ((((fifo).i_end_frame + 1) - (fifo).i_start_frame) & AOUT_FIFO_SIZE) == 0 )
-
-#define AOUT_FIFO_INC( i_index ) \
- ( ((i_index) + 1) & AOUT_FIFO_SIZE )
-
-/* List of known fifo formats */
-#define AOUT_FIFO_NONE 0
-#define AOUT_FIFO_PCM 1
-#define AOUT_FIFO_SPDIF 2
+/* 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 int32_t 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)
+
+
+/*
+ * 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
+#define AOUT_CHAN_MIDDLELEFT 0x100
+#define AOUT_CHAN_MIDDLERIGHT 0x200
+#define AOUT_CHAN_LFE 0x1000
+
+/* Values available for original channels only */
+#define AOUT_CHAN_DOLBYSTEREO 0x10000
+#define AOUT_CHAN_DUALMONO 0x20000
+#define AOUT_CHAN_REVERSESTEREO 0x40000
+
+#define AOUT_CHAN_PHYSMASK 0xFFFF
+#define AOUT_CHAN_MAX 9
+
+/* Values used for the audio-device and audio-channels object variables */
+#define AOUT_VAR_MONO 1
+#define AOUT_VAR_STEREO 2
+#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
+
+#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
/*****************************************************************************
- * aout_thread_t : audio output thread descriptor
+ * aout_buffer_t : audio output buffer
*****************************************************************************/
-typedef struct aout_thread_s
+struct aout_buffer_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 );
- int ( *pf_getbufinfo ) ( p_aout_thread_t, int );
- 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 */
- int i_units;
-
- /* date is the moment where the first audio unit of the output buffer
- * will be played */
- mtime_t date;
-
- /* The current volume */
- int i_volume;
- int i_savedvolume;
-
- /* Format of the audio output samples, number of channels, and
- * rate and gain (in Hz) of the audio output sound */
- int i_format;
- int i_channels;
- int i_rate;
-
- /* Latency of the audio output plugin, in bytes */
- 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 */
+ 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;
+ unsigned int i_nb_samples;
+ mtime_t start_date, end_date;
-#ifdef WORDS_BIGENDIAN
-#define AOUT_FMT_S16_NE AOUT_FMT_S16_BE
-#else
-#define AOUT_FMT_S16_NE AOUT_FMT_S16_LE
-#endif
+ struct aout_buffer_t * p_next;
-/* Number of samples in an AC3 frame */
-#define AC3_FRAME_SIZE 1536
+ /** Private data (aout_buffer_t will disappear soon so no need for an
+ * aout_buffer_sys_t type) */
+ void * p_sys;
-/* Size of a frame for spdif output */
-#define SPDIF_FRAME_SIZE 6144
+ /** This way the release can be overloaded */
+ void (*pf_release)( aout_buffer_t * );
+};
-/*****************************************************************************
- * Prototypes
- *****************************************************************************/
-#ifndef __PLUGIN__
-void aout_InitBank ( void );
-void aout_EndBank ( void );
+/* Size of a frame for S/PDIF output. */
+#define AOUT_SPDIF_SIZE 6144
-aout_thread_t * aout_CreateThread ( int *, int, int );
-void aout_DestroyThread ( aout_thread_t *, int * );
+/* Number of samples in an A/52 frame. */
+#define A52_FRAME_NB 1536
-aout_fifo_t * aout_CreateFifo ( int, int, int, int, 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
+/*****************************************************************************
+ * audio_date_t : date incrementation without long-term rounding errors
+ *****************************************************************************/
+struct audio_date_t
+{
+ mtime_t date;
+ uint32_t i_divider;
+ uint32_t i_remainder;
+};
+/*****************************************************************************
+ * Prototypes
+ *****************************************************************************/
+/* From common.c : */
+#define aout_New(a) __aout_New(VLC_OBJECT(a))
+VLC_EXPORT( aout_instance_t *, __aout_New, ( vlc_object_t * ) );
+VLC_EXPORT( void, aout_Delete, ( 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_DateIncrement, ( audio_date_t *, uint32_t ) );
+
+VLC_EXPORT( int, aout_CheckChannelReorder, ( const uint32_t *, const uint32_t *, uint32_t, int, int * ) );
+VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );
+
+/* From dec.c : */
+#define aout_DecNew(a, b, c) __aout_DecNew(VLC_OBJECT(a), b, c)
+VLC_EXPORT( aout_input_t *, __aout_DecNew, ( vlc_object_t *, aout_instance_t **, audio_sample_format_t * ) );
+VLC_EXPORT( int, aout_DecDelete, ( aout_instance_t *, aout_input_t * ) );
+VLC_EXPORT( aout_buffer_t *, aout_DecNewBuffer, ( aout_instance_t *, aout_input_t *, size_t ) );
+VLC_EXPORT( void, aout_DecDeleteBuffer, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
+VLC_EXPORT( int, aout_DecPlay, ( aout_instance_t *, aout_input_t *, aout_buffer_t * ) );
+
+/* From intf.c : */
+#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_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
+VLC_EXPORT( int, __aout_VolumeInfos, ( 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 * ) );
+#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 * ) );
+
+#endif /* _VLC_AUDIO_OUTPUT_H */
projects / vlc / blobdiff