X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_aout.h;h=032157fbd5f76cd96591b166d1caa111a8a9aa47;hb=3705c13a7677f85b4d168e55a071cbcf6d227be5;hp=e2ef66812dbb553a7cddf587413add64d61a228a;hpb=1387f38f99d1c48b6355780c156fa0544b4a45b4;p=vlc diff --git a/include/vlc_aout.h b/include/vlc_aout.h index e2ef66812d..032157fbd5 100644 --- a/include/vlc_aout.h +++ b/include/vlc_aout.h @@ -28,9 +28,6 @@ * This file defines functions, structures and macros for audio output object */ -/* Max number of pre-filters per input, and max number of post-filters */ -#define AOUT_MAX_FILTERS 10 - /* Buffers which arrive in advance of more than AOUT_MAX_ADVANCE_TIME * will be considered as bogus and be trashed */ #define AOUT_MAX_ADVANCE_TIME (AOUT_MAX_PREPARE_TIME + CLOCK_FREQ) @@ -79,42 +76,8 @@ || ((p_format)->i_format == VLC_CODEC_A52) \ || ((p_format)->i_format == VLC_CODEC_DTS) ) -/* This is heavily borrowed from libmad, by Robert Leslie */ -/* - * 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) - -/* 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 - +/* Values used for the audio-channels object variable */ +#define AOUT_VAR_CHAN_UNSET 0 /* must be zero */ #define AOUT_VAR_CHAN_STEREO 1 #define AOUT_VAR_CHAN_RSTEREO 2 #define AOUT_VAR_CHAN_LEFT 3 @@ -125,8 +88,6 @@ typedef int32_t vlc_fixed_t; * Main audio output structures *****************************************************************************/ -#define aout_BufferFree( buffer ) block_Release( buffer ) - /* Size of a frame for S/PDIF output. */ #define AOUT_SPDIF_SIZE 6144 @@ -136,23 +97,73 @@ typedef int32_t vlc_fixed_t; /* FIXME to remove once aout.h is cleaned a bit more */ #include -typedef int (*aout_volume_cb) (audio_output_t *, float, bool); - /** Audio output object */ struct audio_output { VLC_COMMON_MEMBERS - audio_sample_format_t format; /**< Output format (plugin can modify it - only when succesfully probed and not afterward) */ - - struct aout_sys_t *sys; /**< Output plugin private data */ - void (*pf_play)(audio_output_t *, block_t *); /**< Audio buffer callback */ - void (* pf_pause)( audio_output_t *, bool, mtime_t ); /**< Pause/resume - callback (optional, may be NULL) */ - void (* pf_flush)( audio_output_t *, bool ); /**< Flush/drain callback - (optional, may be NULL) */ - aout_volume_cb pf_volume_set; /**< Volume setter (or NULL) */ + struct aout_sys_t *sys; /**< Private data for callbacks */ + + int (*start)(audio_output_t *, audio_sample_format_t *fmt); + /**< Starts a new stream (mandatory, cannot be NULL). + * \param fmt input stream sample format upon entry, + * output stream sample format upon return [IN/OUT] + * \return VLC_SUCCESS on success, non-zero on failure + * \note No other stream may be already started when called. + */ + void (*stop)(audio_output_t *); + /**< Stops the existing stream (optional, may be NULL). + * \note A stream must have been started when called. + */ + int (*time_get)(audio_output_t *, mtime_t *delay); + /**< Estimates playback buffer latency (optional, may be NULL). + * \param delay pointer to the delay until the next sample to be written + * to the playback buffer is rendered [OUT] + * \return 0 on success, non-zero on failure or lack of data + * \note A stream must have been started when called. + */ + void (*play)(audio_output_t *, block_t *); + /**< Queues a block of samples for playback (mandatory, cannot be NULL). + * \note A stream must have been started when called. + */ + void (*pause)( audio_output_t *, bool pause, mtime_t date); + /**< Pauses or resumes playback (optional, may be NULL). + * \param pause pause if true, resume from pause if false + * \param date timestamp when the pause or resume was requested + * \note A stream must have been started when called. + */ + void (*flush)( audio_output_t *, bool wait); + /**< Flushes or drains the playback buffers (mandatory, cannot be NULL). + * \param wait true to wait for playback of pending buffers (drain), + * false to discard pending buffers (flush) + * \note A stream must have been started when called. + */ + int (*volume_set)(audio_output_t *, float volume); + /**< Changes playback volume (optional, may be NULL). + * \param volume requested volume (0. = mute, 1. = nominal) + * \note The volume is always a positive number. + * \warning A stream may or may not have been started when called. + */ + int (*mute_set)(audio_output_t *, bool mute); + /**< Changes muting (optinal, may be NULL). + * \param mute true to mute, false to unmute + * \warning A stream may or may not have been started when called. + */ + int (*device_select)(audio_output_t *, const char *id); + /**< Selects an audio output device (optional, may be NULL). + * \param id nul-terminated device unique identifier. + * \return 0 on success, non-zero on failure. + * \warning A stream may or may not have been started when called. + */ + struct { + void (*volume_report)(audio_output_t *, float); + void (*mute_report)(audio_output_t *, bool); + void (*policy_report)(audio_output_t *, bool); + void (*device_report)(audio_output_t *, const char *); + void (*hotplug_report)(audio_output_t *, const char *, const char *); + int (*gain_request)(audio_output_t *, float); + void (*restart_request)(audio_output_t *, unsigned); + } event; }; /** @@ -166,6 +177,10 @@ static const uint32_t pi_vlc_chan_order_wg4[] = AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 }; +#define AOUT_RESTART_FILTERS 1 +#define AOUT_RESTART_OUTPUT 2 +#define AOUT_RESTART_DECODER 4 + /***************************************************************************** * Prototypes *****************************************************************************/ @@ -176,11 +191,18 @@ static const uint32_t pi_vlc_chan_order_wg4[] = * If pi_chan_order_in or pi_chan_order_out is NULL, it will assume that vlc * internal (WG4) order is requested. */ -VLC_API 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_API void aout_ChannelReorder( uint8_t *, int, int, const int *, int ); +VLC_API unsigned aout_CheckChannelReorder( const uint32_t *, const uint32_t *, + uint32_t mask, uint8_t *table ); +VLC_API void aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t); + +VLC_API void aout_Interleave(void *dst, const void *const *planes, + unsigned samples, unsigned channels, + vlc_fourcc_t fourcc); +VLC_API void aout_Deinterleave(void *dst, const void *src, unsigned samples, + unsigned channels, vlc_fourcc_t fourcc); /** - * This fonction will compute the extraction parameter into pi_selection to go + * This function 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 : @@ -219,46 +241,99 @@ VLC_API void aout_FormatPrint(vlc_object_t *, const char *, #define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f) VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED; -VLC_API void aout_VolumeNoneInit( audio_output_t * ); -VLC_API void aout_VolumeSoftInit( audio_output_t * ); -VLC_API void aout_VolumeHardInit( audio_output_t *, aout_volume_cb, bool ); -VLC_API void aout_VolumeHardSet( audio_output_t *, float, bool ); +VLC_API float aout_VolumeGet (audio_output_t *); +VLC_API int aout_VolumeSet (audio_output_t *, float); +VLC_API int aout_MuteGet (audio_output_t *); +VLC_API int aout_MuteSet (audio_output_t *, bool); +VLC_API char *aout_DeviceGet (audio_output_t *); +VLC_API int aout_DeviceSet (audio_output_t *, const char *); +VLC_API int aout_DevicesList (audio_output_t *, char ***, char ***); -VLC_API void aout_TimeReport(audio_output_t *, mtime_t); +/** + * Report change of configured audio volume to the core and UI. + */ +static inline void aout_VolumeReport(audio_output_t *aout, float volume) +{ + aout->event.volume_report(aout, volume); +} -VLC_API int aout_ChannelsRestart( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ); +/** + * Report change of muted flag to the core and UI. + */ +static inline void aout_MuteReport(audio_output_t *aout, bool mute) +{ + aout->event.mute_report(aout, mute); +} -/* */ -VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ) VLC_USED; +/** + * Report audio policy status. + * \parm cork true to request a cork, false to undo any pending cork. + */ +static inline void aout_PolicyReport(audio_output_t *aout, bool cork) +{ + aout->event.policy_report(aout, cork); +} -/** Audio output buffer FIFO */ -struct aout_fifo_t +/** + * Report change of output device. + */ +static inline void aout_DeviceReport(audio_output_t *aout, const char *id) { - aout_buffer_t * p_first; - aout_buffer_t ** pp_last; - date_t end_date; -}; + aout->event.device_report(aout, id); +} + +/** + * Report a device hot-plug event. + * @param id device ID + * @param name human-readable device name (NULL for hot unplug) + */ +static inline void aout_HotplugReport(audio_output_t *aout, + const char *id, const char *name) +{ + aout->event.hotplug_report(aout, id, name); +} -/* Legacy packet-oriented audio output helpers */ -typedef struct +/** + * Request a change of software audio amplification. + * \param gain linear amplitude gain (must be positive) + * \warning Values in excess 1.0 may cause overflow and distorsion. + */ +static inline int aout_GainRequest(audio_output_t *aout, float gain) { - vlc_mutex_t lock; - aout_fifo_t partial; /**< Audio blocks before packetization */ - aout_fifo_t fifo; /**< Packetized audio blocks */ - mtime_t pause_date; /**< Date when paused or VLC_TS_INVALID */ - mtime_t time_report; /**< Desynchronization estimate or VLC_TS_INVALID */ - unsigned samples; /**< Samples per packet */ - bool starving; /**< Whether currently starving (to limit error messages) */ -} aout_packet_t; + return aout->event.gain_request(aout, gain); +} -VLC_DEPRECATED void aout_PacketInit(audio_output_t *, aout_packet_t *, unsigned); -VLC_DEPRECATED void aout_PacketDestroy(audio_output_t *); +static inline void aout_RestartRequest(audio_output_t *aout, unsigned mode) +{ + aout->event.restart_request(aout, mode); +} -VLC_DEPRECATED void aout_PacketPlay(audio_output_t *, block_t *); -VLC_DEPRECATED void aout_PacketPause(audio_output_t *, bool, mtime_t); -VLC_DEPRECATED void aout_PacketFlush(audio_output_t *, bool); +static inline int aout_ChannelsRestart (vlc_object_t *obj, const char *varname, + vlc_value_t oldval, vlc_value_t newval, void *data) +{ + audio_output_t *aout = (audio_output_t *)obj; + (void)varname; (void)oldval; (void)newval; (void)data; -VLC_DEPRECATED block_t *aout_PacketNext(audio_output_t *, mtime_t) VLC_USED; + aout_RestartRequest (aout, AOUT_RESTART_OUTPUT); + return 0; +} +/* Audio output filters */ +typedef struct aout_filters aout_filters_t; +typedef struct aout_request_vout aout_request_vout_t; + +VLC_API aout_filters_t *aout_FiltersNew(vlc_object_t *, + const audio_sample_format_t *, + const audio_sample_format_t *, + const aout_request_vout_t *) VLC_USED; +#define aout_FiltersNew(o,inf,outf,rv) \ + aout_FiltersNew(VLC_OBJECT(o),inf,outf,rv) +VLC_API void aout_FiltersDelete(vlc_object_t *, aout_filters_t *); +#define aout_FiltersDelete(o,f) \ + aout_FiltersDelete(VLC_OBJECT(o),f) +VLC_API bool aout_FiltersAdjustResampling(aout_filters_t *, int); +VLC_API block_t *aout_FiltersPlay(aout_filters_t *, block_t *, int rate); + +VLC_API vout_thread_t * aout_filter_RequestVout( filter_t *, vout_thread_t *p_vout, video_format_t *p_fmt ); #endif /* VLC_AOUT_H */