X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/6dc76d11583979ba73dbe4bbf54f52fc1af901e2..e11b699d45fa3dca2cde8a976cbf25490f5501a4:/src/pulse/sample.h diff --git a/src/pulse/sample.h b/src/pulse/sample.h index 8d09d32e..86973d41 100644 --- a/src/pulse/sample.h +++ b/src/pulse/sample.h @@ -9,7 +9,7 @@ PulseAudio is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published - by the Free Software Foundation; either version 2 of the License, + by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. PulseAudio is distributed in the hope that it will be useful, but @@ -26,10 +26,10 @@ #include #include #include -#include #include #include +#include /** \page sample Sample Format Specifications * @@ -51,8 +51,10 @@ * \li PA_SAMPLE_ULAW - 8 bit mu-Law. * \li PA_SAMPLE_S32LE - Signed 32 bit integer PCM, little endian. * \li PA_SAMPLE_S32BE - Signed 32 bit integer PCM, big endian. - * \li PA_SAMPLE_242LE - Signed 24 bit integer PCM packed, little endian. - * \li PA_SAMPLE_242BE - Signed 24 bit integer PCM packed, big endian. + * \li PA_SAMPLE_S24LE - Signed 24 bit integer PCM packed, little endian. + * \li PA_SAMPLE_S24BE - Signed 24 bit integer PCM packed, big endian. + * \li PA_SAMPLE_S24_32LE - Signed 24 bit integer PCM in LSB of 32 bit words, little endian. + * \li PA_SAMPLE_S24_32BE - Signed 24 bit integer PCM in LSB of 32 bit words, big endian. * * The floating point sample formats have the range from -1.0 to 1.0. * @@ -61,15 +63,15 @@ * * \section rate_sec Sample Rates * - * PulseAudio supports any sample rate between 1 Hz and 4 GHz. There is no + * PulseAudio supports any sample rate between 1 Hz and 192000 Hz. There is no * point trying to exceed the sample rate of the output device though as the * signal will only get downsampled, consuming CPU on the machine running the * server. * * \section chan_sec Channels * - * PulseAudio supports up to 16 individiual channels. The order of the - * channels is up to the application, but they must be continous. To map + * PulseAudio supports up to 32 individual channels. The order of the + * channels is up to the application, but they must be continuous. To map * channels to speakers, see \ref channelmap. * * \section calc_sec Calculations @@ -102,16 +104,26 @@ */ /** \file - * Constants and routines for sample type handling */ + * Constants and routines for sample type handling + * + * See also \subpage sample + */ PA_C_DECL_BEGIN #if !defined(WORDS_BIGENDIAN) + #if defined(__BYTE_ORDER) #if __BYTE_ORDER == __BIG_ENDIAN #define WORDS_BIGENDIAN #endif #endif + +/* On Sparc, WORDS_BIGENDIAN needs to be set if _BIG_ENDIAN is defined. */ +#if defined(__sparc__) && defined(_BIG_ENDIAN) +#define WORDS_BIGENDIAN +#endif + #endif /** Maximum number of allowed channels */ @@ -138,10 +150,10 @@ typedef enum pa_sample_format { /**< Signed 16 Bit PCM, big endian */ PA_SAMPLE_FLOAT32LE, - /**< 32 Bit IEEE floating point, little endian, range -1 to 1 */ + /**< 32 Bit IEEE floating point, little endian (PC), range -1.0 to 1.0 */ PA_SAMPLE_FLOAT32BE, - /**< 32 Bit IEEE floating point, big endian, range -1 to 1 */ + /**< 32 Bit IEEE floating point, big endian, range -1.0 to 1.0 */ PA_SAMPLE_S32LE, /**< Signed 32 Bit PCM, little endian (PC) */ @@ -150,10 +162,16 @@ typedef enum pa_sample_format { /**< Signed 32 Bit PCM, big endian */ PA_SAMPLE_S24LE, - /**< Signed 24 Bit PCM packed, little endian (PC) */ + /**< Signed 24 Bit PCM packed, little endian (PC). \since 0.9.15 */ PA_SAMPLE_S24BE, - /**< Signed 24 Bit PCM packed, big endian */ + /**< Signed 24 Bit PCM packed, big endian. \since 0.9.15 */ + + PA_SAMPLE_S24_32LE, + /**< Signed 24 Bit PCM in LSB of 32 Bit words, little endian (PC). \since 0.9.15 */ + + PA_SAMPLE_S24_32BE, + /**< Signed 24 Bit PCM in LSB of 32 Bit words, big endian. \since 0.9.15 */ PA_SAMPLE_MAX, /**< Upper limit of valid sample types */ @@ -169,16 +187,21 @@ typedef enum pa_sample_format { #define PA_SAMPLE_FLOAT32NE PA_SAMPLE_FLOAT32BE /** Signed 32 Bit PCM, native endian */ #define PA_SAMPLE_S32NE PA_SAMPLE_S32BE -/** Signed 24 Bit PCM packed, native endian */ +/** Signed 24 Bit PCM packed, native endian. \since 0.9.15 */ #define PA_SAMPLE_S24NE PA_SAMPLE_S24BE +/** Signed 24 Bit PCM in LSB of 32 Bit words, native endian. \since 0.9.15 */ +#define PA_SAMPLE_S24_32NE PA_SAMPLE_S24_32BE + /** Signed 16 Bit PCM reverse endian */ #define PA_SAMPLE_S16RE PA_SAMPLE_S16LE /** 32 Bit IEEE floating point, reverse endian */ #define PA_SAMPLE_FLOAT32RE PA_SAMPLE_FLOAT32LE /** Signed 32 Bit PCM, reverse endian */ #define PA_SAMPLE_S32RE PA_SAMPLE_S32LE -/** Signed 24 Bit PCM, packed reverse endian */ -#define PA_SAMPLE_S24RE PA_SAMPLE_242LE +/** Signed 24 Bit PCM, packed reverse endian. \since 0.9.15 */ +#define PA_SAMPLE_S24RE PA_SAMPLE_S24LE +/** Signed 24 Bit PCM, in LSB of 32 Bit words, reverse endian. \since 0.9.15 */ +#define PA_SAMPLE_S24_32RE PA_SAMPLE_S24_32LE #else /** Signed 16 Bit PCM, native endian */ #define PA_SAMPLE_S16NE PA_SAMPLE_S16LE @@ -186,23 +209,28 @@ typedef enum pa_sample_format { #define PA_SAMPLE_FLOAT32NE PA_SAMPLE_FLOAT32LE /** Signed 32 Bit PCM, native endian */ #define PA_SAMPLE_S32NE PA_SAMPLE_S32LE -/** Signed 24 Bit PCM packed, native endian */ +/** Signed 24 Bit PCM packed, native endian. \since 0.9.15 */ #define PA_SAMPLE_S24NE PA_SAMPLE_S24LE +/** Signed 24 Bit PCM in LSB of 32 Bit words, native endian. \since 0.9.15 */ +#define PA_SAMPLE_S24_32NE PA_SAMPLE_S24_32LE + /** Signed 16 Bit PCM, reverse endian */ #define PA_SAMPLE_S16RE PA_SAMPLE_S16BE /** 32 Bit IEEE floating point, reverse endian */ #define PA_SAMPLE_FLOAT32RE PA_SAMPLE_FLOAT32BE /** Signed 32 Bit PCM, reverse endian */ #define PA_SAMPLE_S32RE PA_SAMPLE_S32BE -/** Signed 24 Bit PCM packed, reverse endian */ +/** Signed 24 Bit PCM, packed reverse endian. \since 0.9.15 */ #define PA_SAMPLE_S24RE PA_SAMPLE_S24BE +/** Signed 24 Bit PCM, in LSB of 32 Bit words, reverse endian. \since 0.9.15 */ +#define PA_SAMPLE_S24_32RE PA_SAMPLE_S24_32BE #endif /** A Shortcut for PA_SAMPLE_FLOAT32NE */ #define PA_SAMPLE_FLOAT32 PA_SAMPLE_FLOAT32NE /** \cond fulldocs */ -/* Allow clients to check with #ifdef for thse sample formats */ +/* Allow clients to check with #ifdef for these sample formats */ #define PA_SAMPLE_U8 PA_SAMPLE_U8 #define PA_SAMPLE_ALAW PA_SAMPLE_ALAW #define PA_SAMPLE_ULAW PA_SAMPLE_ULAW @@ -214,6 +242,8 @@ typedef enum pa_sample_format { #define PA_SAMPLE_S32BE PA_SAMPLE_S32BE #define PA_SAMPLE_S24LE PA_SAMPLE_S24LE #define PA_SAMPLE_S24BE PA_SAMPLE_S24BE +#define PA_SAMPLE_S24_32LE PA_SAMPLE_S24_32LE +#define PA_SAMPLE_S24_32BE PA_SAMPLE_S24_32BE /** \endcond */ /** A sample format and attribute specification */ @@ -240,6 +270,10 @@ size_t pa_frame_size(const pa_sample_spec *spec) PA_GCC_PURE; /** Return the size of a sample with the specific sample type */ size_t pa_sample_size(const pa_sample_spec *spec) PA_GCC_PURE; +/** Similar to pa_sample_size() but take a sample format instead of a + * full sample spec. \since 0.9.15 */ +size_t pa_sample_size_of_format(pa_sample_format_t f) PA_GCC_PURE; + /** Calculate the time the specified bytes take to play with the * specified sample type. The return value will always be rounded * down for non-integral return values. */ @@ -255,6 +289,16 @@ size_t pa_usec_to_bytes(pa_usec_t t, const pa_sample_spec *spec) PA_GCC_PURE; * pa_sample_spec_valid() will fail for it. \since 0.9.13 */ pa_sample_spec* pa_sample_spec_init(pa_sample_spec *spec); +/** Return non-zero if the given integer is a valid sample format. \since 5.0 */ +int pa_sample_format_valid(unsigned format) PA_GCC_PURE; + +/** Return non-zero if the rate is within the supported range. \since 5.0 */ +int pa_sample_rate_valid(uint32_t rate) PA_GCC_PURE; + +/** Return non-zero if the channel count is within the supported range. + * \since 5.0 */ +int pa_channels_valid(uint8_t channels) PA_GCC_PURE; + /** Return non-zero when the sample type specification is valid */ int pa_sample_spec_valid(const pa_sample_spec *spec) PA_GCC_PURE; @@ -277,9 +321,36 @@ pa_sample_format_t pa_parse_sample_format(const char *format) PA_GCC_PURE; /** Pretty print a sample type specification to a string */ char* pa_sample_spec_snprint(char *s, size_t l, const pa_sample_spec *spec); -/** Pretty print a byte size value. (i.e. "2.5 MiB") */ +/** Maximum required string length for pa_bytes_snprint(). Please note + * that this value can change with any release without warning and + * without being considered API or ABI breakage. You should not use + * this definition anywhere where it might become part of an + * ABI. \since 0.9.16 */ +#define PA_BYTES_SNPRINT_MAX 11 + +/** Pretty print a byte size value (i.e.\ "2.5 MiB") */ char* pa_bytes_snprint(char *s, size_t l, unsigned v); +/** Return 1 when the specified format is little endian, return -1 + * when endianness does not apply to this format. \since 0.9.16 */ +int pa_sample_format_is_le(pa_sample_format_t f) PA_GCC_PURE; + +/** Return 1 when the specified format is big endian, return -1 when + * endianness does not apply to this format. \since 0.9.16 */ +int pa_sample_format_is_be(pa_sample_format_t f) PA_GCC_PURE; + +#ifdef WORDS_BIGENDIAN +#define pa_sample_format_is_ne(f) pa_sample_format_is_be(f) +#define pa_sample_format_is_re(f) pa_sample_format_is_le(f) +#else +/** Return 1 when the specified format is native endian, return -1 + * when endianness does not apply to this format. \since 0.9.16 */ +#define pa_sample_format_is_ne(f) pa_sample_format_is_le(f) +/** Return 1 when the specified format is reverse endian, return -1 + * when endianness does not apply to this format. \since 0.9.16 */ +#define pa_sample_format_is_re(f) pa_sample_format_is_be(f) +#endif + PA_C_DECL_END #endif