PulseAudio  5.0
sample.h
Go to the documentation of this file.
1 #ifndef foosamplehfoo
2 #define foosamplehfoo
3 
4 /***
5  This file is part of PulseAudio.
6 
7  Copyright 2004-2006 Lennart Poettering
8  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 
10  PulseAudio is free software; you can redistribute it and/or modify
11  it under the terms of the GNU Lesser General Public License as published
12  by the Free Software Foundation; either version 2.1 of the License,
13  or (at your option) any later version.
14 
15  PulseAudio is distributed in the hope that it will be useful, but
16  WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  General Public License for more details.
19 
20  You should have received a copy of the GNU Lesser General Public License
21  along with PulseAudio; if not, write to the Free Software
22  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23  USA.
24 ***/
25 
26 #include <inttypes.h>
27 #include <sys/types.h>
28 #include <sys/param.h>
29 
30 #include <pulse/gccmacro.h>
31 #include <pulse/cdecl.h>
32 #include <pulse/version.h>
33 
112 PA_C_DECL_BEGIN
113 
114 #if !defined(WORDS_BIGENDIAN)
115 
116 #if defined(__BYTE_ORDER)
117 #if __BYTE_ORDER == __BIG_ENDIAN
118 #define WORDS_BIGENDIAN
119 #endif
120 #endif
121 
122 /* On Sparc, WORDS_BIGENDIAN needs to be set if _BIG_ENDIAN is defined. */
123 #if defined(__sparc__) && defined(_BIG_ENDIAN)
124 #define WORDS_BIGENDIAN
125 #endif
126 
127 #endif
128 
130 #define PA_CHANNELS_MAX 32U
131 
133 #define PA_RATE_MAX (48000U*4U)
134 
136 typedef enum pa_sample_format {
182 
183 #ifdef WORDS_BIGENDIAN
184 
185 #define PA_SAMPLE_S16NE PA_SAMPLE_S16BE
186 
187 #define PA_SAMPLE_FLOAT32NE PA_SAMPLE_FLOAT32BE
188 
189 #define PA_SAMPLE_S32NE PA_SAMPLE_S32BE
190 
191 #define PA_SAMPLE_S24NE PA_SAMPLE_S24BE
192 
193 #define PA_SAMPLE_S24_32NE PA_SAMPLE_S24_32BE
194 
196 #define PA_SAMPLE_S16RE PA_SAMPLE_S16LE
197 
198 #define PA_SAMPLE_FLOAT32RE PA_SAMPLE_FLOAT32LE
199 
200 #define PA_SAMPLE_S32RE PA_SAMPLE_S32LE
201 
202 #define PA_SAMPLE_S24RE PA_SAMPLE_S24LE
203 
204 #define PA_SAMPLE_S24_32RE PA_SAMPLE_S24_32LE
205 #else
206 
207 #define PA_SAMPLE_S16NE PA_SAMPLE_S16LE
208 
209 #define PA_SAMPLE_FLOAT32NE PA_SAMPLE_FLOAT32LE
210 
211 #define PA_SAMPLE_S32NE PA_SAMPLE_S32LE
212 
213 #define PA_SAMPLE_S24NE PA_SAMPLE_S24LE
214 
215 #define PA_SAMPLE_S24_32NE PA_SAMPLE_S24_32LE
216 
218 #define PA_SAMPLE_S16RE PA_SAMPLE_S16BE
219 
220 #define PA_SAMPLE_FLOAT32RE PA_SAMPLE_FLOAT32BE
221 
222 #define PA_SAMPLE_S32RE PA_SAMPLE_S32BE
223 
224 #define PA_SAMPLE_S24RE PA_SAMPLE_S24BE
225 
226 #define PA_SAMPLE_S24_32RE PA_SAMPLE_S24_32BE
227 #endif
228 
230 #define PA_SAMPLE_FLOAT32 PA_SAMPLE_FLOAT32NE
231 
233 /* Allow clients to check with #ifdef for these sample formats */
234 #define PA_SAMPLE_U8 PA_SAMPLE_U8
235 #define PA_SAMPLE_ALAW PA_SAMPLE_ALAW
236 #define PA_SAMPLE_ULAW PA_SAMPLE_ULAW
237 #define PA_SAMPLE_S16LE PA_SAMPLE_S16LE
238 #define PA_SAMPLE_S16BE PA_SAMPLE_S16BE
239 #define PA_SAMPLE_FLOAT32LE PA_SAMPLE_FLOAT32LE
240 #define PA_SAMPLE_FLOAT32BE PA_SAMPLE_FLOAT32BE
241 #define PA_SAMPLE_S32LE PA_SAMPLE_S32LE
242 #define PA_SAMPLE_S32BE PA_SAMPLE_S32BE
243 #define PA_SAMPLE_S24LE PA_SAMPLE_S24LE
244 #define PA_SAMPLE_S24BE PA_SAMPLE_S24BE
245 #define PA_SAMPLE_S24_32LE PA_SAMPLE_S24_32LE
246 #define PA_SAMPLE_S24_32BE PA_SAMPLE_S24_32BE
247 
250 typedef struct pa_sample_spec {
254  uint32_t rate;
257  uint8_t channels;
260 
262 typedef uint64_t pa_usec_t;
263 
266 
268 size_t pa_frame_size(const pa_sample_spec *spec) PA_GCC_PURE;
269 
271 size_t pa_sample_size(const pa_sample_spec *spec) PA_GCC_PURE;
272 
276 
280 pa_usec_t pa_bytes_to_usec(uint64_t length, const pa_sample_spec *spec) PA_GCC_PURE;
281 
286 
291 
293 int pa_sample_format_valid(unsigned format) PA_GCC_PURE;
294 
296 int pa_sample_rate_valid(uint32_t rate) PA_GCC_PURE;
297 
300 int pa_channels_valid(uint8_t channels) PA_GCC_PURE;
301 
304 
307 
310 
313 
319 #define PA_SAMPLE_SPEC_SNPRINT_MAX 32
320 
322 char* pa_sample_spec_snprint(char *s, size_t l, const pa_sample_spec *spec);
323 
329 #define PA_BYTES_SNPRINT_MAX 11
330 
332 char* pa_bytes_snprint(char *s, size_t l, unsigned v);
333 
337 
341 
342 #ifdef WORDS_BIGENDIAN
343 #define pa_sample_format_is_ne(f) pa_sample_format_is_be(f)
344 #define pa_sample_format_is_re(f) pa_sample_format_is_le(f)
345 #else
346 
348 #define pa_sample_format_is_ne(f) pa_sample_format_is_le(f)
349 
351 #define pa_sample_format_is_re(f) pa_sample_format_is_be(f)
352 #endif
353 
354 PA_C_DECL_END
355 
356 #endif
const char * pa_sample_format_to_string(pa_sample_format_t f) PA_GCC_PURE
Return a descriptive string for the specified sample format.
A sample format and attribute specification.
Definition: sample.h:250
8 Bit a-Law
Definition: sample.h:140
int pa_sample_format_valid(unsigned format) PA_GCC_PURE
Return non-zero if the given integer is a valid sample format.
pa_sample_format_t pa_parse_sample_format(const char *format) PA_GCC_PURE
Parse a sample format text.
Signed 24 Bit PCM packed, little endian (PC).
Definition: sample.h:164
Signed 16 Bit PCM, big endian.
Definition: sample.h:149
pa_sample_format
Sample format.
Definition: sample.h:136
size_t pa_sample_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_of_format(pa_sample_format_t f) PA_GCC_PURE
Similar to pa_sample_size() but take a sample format instead of a full sample spec.
uint8_t channels
Audio channels.
Definition: sample.h:257
uint64_t pa_usec_t
Type for usec specifications (unsigned).
Definition: sample.h:262
enum pa_sample_format pa_sample_format_t
Sample format.
#define PA_GCC_PURE
This function's return value depends only the arguments list and global state.
Definition: gccmacro.h:75
GCC attribute macros.
int pa_channels_valid(uint8_t channels) PA_GCC_PURE
Return non-zero if the channel count is within the supported range.
uint32_t rate
The sample rate.
Definition: sample.h:254
Signed 24 Bit PCM in LSB of 32 Bit words, little endian (PC).
Definition: sample.h:170
int pa_sample_format_is_be(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 fo...
int pa_sample_spec_equal(const pa_sample_spec *a, const pa_sample_spec *b) PA_GCC_PURE
Return non-zero when the two sample type specifications match.
int pa_sample_spec_valid(const pa_sample_spec *spec) PA_GCC_PURE
Return non-zero when the sample type specification is valid.
size_t pa_bytes_per_second(const pa_sample_spec *spec) PA_GCC_PURE
Return the amount of bytes playback of a second of audio with the specified sample type takes...
Define header version.
pa_usec_t pa_bytes_to_usec(uint64_t length, const pa_sample_spec *spec) PA_GCC_PURE
Calculate the time the specified bytes take to play with the specified sample type.
An invalid value.
Definition: sample.h:179
Upper limit of valid sample types.
Definition: sample.h:176
8 Bit mu-Law
Definition: sample.h:143
32 Bit IEEE floating point, big endian, range -1.0 to 1.0
Definition: sample.h:155
Signed 16 Bit PCM, little endian (PC)
Definition: sample.h:146
pa_sample_spec * pa_sample_spec_init(pa_sample_spec *spec)
Initialize the specified sample spec and return a pointer to it.
Unsigned 8 Bit PCM.
Definition: sample.h:137
Signed 32 Bit PCM, little endian (PC)
Definition: sample.h:158
Signed 24 Bit PCM packed, big endian.
Definition: sample.h:167
Signed 24 Bit PCM in LSB of 32 Bit words, big endian.
Definition: sample.h:173
char * pa_bytes_snprint(char *s, size_t l, unsigned v)
Pretty print a byte size value (i.e. "2.5 MiB")
32 Bit IEEE floating point, little endian (PC), range -1.0 to 1.0
Definition: sample.h:152
int pa_sample_rate_valid(uint32_t rate) PA_GCC_PURE
Return non-zero if the rate is within the supported range.
size_t pa_usec_to_bytes(pa_usec_t t, const pa_sample_spec *spec) PA_GCC_PURE
Calculates the number of bytes that are required for the specified time.
size_t pa_frame_size(const pa_sample_spec *spec) PA_GCC_PURE
Return the size of a frame with the specific sample type.
char * pa_sample_spec_snprint(char *s, size_t l, const pa_sample_spec *spec)
Pretty print a sample type specification to a string.
Signed 32 Bit PCM, big endian.
Definition: sample.h:161
pa_sample_format_t format
The sample format.
Definition: sample.h:251
struct pa_sample_spec pa_sample_spec
A sample format and attribute specification.
int pa_sample_format_is_le(pa_sample_format_t f) PA_GCC_PURE
Return 1 when the specified format is little endian, return -1 when endianness does not apply to this...