2 * PCM Interface - misc routines
3 * Copyright (c) 1998 by Jaroslav Kysela <perex@perex.cz>
6 * This library is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU Library General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/time.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #define SND_PCM_FORMAT_UNKNOWN (-1)
27 /* NOTE: "signed" prefix must be given below since the default char is
28 * unsigned on some architectures!
30 struct pcm_format_data
{
31 unsigned char width
; /* bit width */
32 unsigned char phys
; /* physical bit width */
33 signed char le
; /* 0 = big-endian, 1 = little-endian, -1 = others */
34 signed char signd
; /* 0 = unsigned, 1 = signed, -1 = others */
35 unsigned char silence
[8]; /* silence data to fill */
38 static struct pcm_format_data pcm_formats
[SNDRV_PCM_FORMAT_LAST
+1] = {
39 [SNDRV_PCM_FORMAT_S8
] = {
40 .width
= 8, .phys
= 8, .le
= -1, .signd
= 1,
43 [SNDRV_PCM_FORMAT_U8
] = {
44 .width
= 8, .phys
= 8, .le
= -1, .signd
= 0,
47 [SNDRV_PCM_FORMAT_S16_LE
] = {
48 .width
= 16, .phys
= 16, .le
= 1, .signd
= 1,
51 [SNDRV_PCM_FORMAT_S16_BE
] = {
52 .width
= 16, .phys
= 16, .le
= 0, .signd
= 1,
55 [SNDRV_PCM_FORMAT_U16_LE
] = {
56 .width
= 16, .phys
= 16, .le
= 1, .signd
= 0,
57 .silence
= { 0x00, 0x80 },
59 [SNDRV_PCM_FORMAT_U16_BE
] = {
60 .width
= 16, .phys
= 16, .le
= 0, .signd
= 0,
61 .silence
= { 0x80, 0x00 },
63 [SNDRV_PCM_FORMAT_S24_LE
] = {
64 .width
= 24, .phys
= 32, .le
= 1, .signd
= 1,
67 [SNDRV_PCM_FORMAT_S24_BE
] = {
68 .width
= 24, .phys
= 32, .le
= 0, .signd
= 1,
71 [SNDRV_PCM_FORMAT_U24_LE
] = {
72 .width
= 24, .phys
= 32, .le
= 1, .signd
= 0,
73 .silence
= { 0x00, 0x00, 0x80 },
75 [SNDRV_PCM_FORMAT_U24_BE
] = {
76 .width
= 24, .phys
= 32, .le
= 0, .signd
= 0,
77 .silence
= { 0x00, 0x80, 0x00, 0x00 },
79 [SNDRV_PCM_FORMAT_S32_LE
] = {
80 .width
= 32, .phys
= 32, .le
= 1, .signd
= 1,
83 [SNDRV_PCM_FORMAT_S32_BE
] = {
84 .width
= 32, .phys
= 32, .le
= 0, .signd
= 1,
87 [SNDRV_PCM_FORMAT_U32_LE
] = {
88 .width
= 32, .phys
= 32, .le
= 1, .signd
= 0,
89 .silence
= { 0x00, 0x00, 0x00, 0x80 },
91 [SNDRV_PCM_FORMAT_U32_BE
] = {
92 .width
= 32, .phys
= 32, .le
= 0, .signd
= 0,
93 .silence
= { 0x80, 0x00, 0x00, 0x00 },
95 [SNDRV_PCM_FORMAT_FLOAT_LE
] = {
96 .width
= 32, .phys
= 32, .le
= 1, .signd
= -1,
99 [SNDRV_PCM_FORMAT_FLOAT_BE
] = {
100 .width
= 32, .phys
= 32, .le
= 0, .signd
= -1,
103 [SNDRV_PCM_FORMAT_FLOAT64_LE
] = {
104 .width
= 64, .phys
= 64, .le
= 1, .signd
= -1,
107 [SNDRV_PCM_FORMAT_FLOAT64_BE
] = {
108 .width
= 64, .phys
= 64, .le
= 0, .signd
= -1,
111 [SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE
] = {
112 .width
= 32, .phys
= 32, .le
= 1, .signd
= -1,
115 [SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE
] = {
116 .width
= 32, .phys
= 32, .le
= 0, .signd
= -1,
119 [SNDRV_PCM_FORMAT_MU_LAW
] = {
120 .width
= 8, .phys
= 8, .le
= -1, .signd
= -1,
123 [SNDRV_PCM_FORMAT_A_LAW
] = {
124 .width
= 8, .phys
= 8, .le
= -1, .signd
= -1,
127 [SNDRV_PCM_FORMAT_IMA_ADPCM
] = {
128 .width
= 4, .phys
= 4, .le
= -1, .signd
= -1,
131 [SNDRV_PCM_FORMAT_G723_24
] = {
132 .width
= 3, .phys
= 3, .le
= -1, .signd
= -1,
135 [SNDRV_PCM_FORMAT_G723_40
] = {
136 .width
= 5, .phys
= 5, .le
= -1, .signd
= -1,
139 [SNDRV_PCM_FORMAT_MPEG
] = {
140 .le
= -1, .signd
= -1,
142 [SNDRV_PCM_FORMAT_GSM
] = {
143 .le
= -1, .signd
= -1,
145 [SNDRV_PCM_FORMAT_SPECIAL
] = {
146 .le
= -1, .signd
= -1,
148 [SNDRV_PCM_FORMAT_S24_3LE
] = {
149 .width
= 24, .phys
= 24, .le
= 1, .signd
= 1,
152 [SNDRV_PCM_FORMAT_S24_3BE
] = {
153 .width
= 24, .phys
= 24, .le
= 0, .signd
= 1,
156 [SNDRV_PCM_FORMAT_U24_3LE
] = {
157 .width
= 24, .phys
= 24, .le
= 1, .signd
= 0,
158 .silence
= { 0x00, 0x00, 0x80 },
160 [SNDRV_PCM_FORMAT_U24_3BE
] = {
161 .width
= 24, .phys
= 24, .le
= 0, .signd
= 0,
162 .silence
= { 0x80, 0x00, 0x00 },
164 [SNDRV_PCM_FORMAT_S20_3LE
] = {
165 .width
= 20, .phys
= 24, .le
= 1, .signd
= 1,
168 [SNDRV_PCM_FORMAT_S20_3BE
] = {
169 .width
= 20, .phys
= 24, .le
= 0, .signd
= 1,
172 [SNDRV_PCM_FORMAT_U20_3LE
] = {
173 .width
= 20, .phys
= 24, .le
= 1, .signd
= 0,
174 .silence
= { 0x00, 0x00, 0x08 },
176 [SNDRV_PCM_FORMAT_U20_3BE
] = {
177 .width
= 20, .phys
= 24, .le
= 0, .signd
= 0,
178 .silence
= { 0x08, 0x00, 0x00 },
180 [SNDRV_PCM_FORMAT_S18_3LE
] = {
181 .width
= 18, .phys
= 24, .le
= 1, .signd
= 1,
184 [SNDRV_PCM_FORMAT_S18_3BE
] = {
185 .width
= 18, .phys
= 24, .le
= 0, .signd
= 1,
188 [SNDRV_PCM_FORMAT_U18_3LE
] = {
189 .width
= 18, .phys
= 24, .le
= 1, .signd
= 0,
190 .silence
= { 0x00, 0x00, 0x02 },
192 [SNDRV_PCM_FORMAT_U18_3BE
] = {
193 .width
= 18, .phys
= 24, .le
= 0, .signd
= 0,
194 .silence
= { 0x02, 0x00, 0x00 },
196 [SNDRV_PCM_FORMAT_G723_24_1B
] = {
197 .width
= 3, .phys
= 8, .le
= -1, .signd
= -1,
200 [SNDRV_PCM_FORMAT_G723_40_1B
] = {
201 .width
= 5, .phys
= 8, .le
= -1, .signd
= -1,
208 * snd_pcm_format_signed - Check the PCM format is signed linear
209 * @format: the format to check
211 * Returns 1 if the given PCM format is signed linear, 0 if unsigned
212 * linear, and a negative error code for non-linear formats.
214 int snd_pcm_format_signed(snd_pcm_format_t format
)
217 if (format
< 0 || format
> SNDRV_PCM_FORMAT_LAST
)
219 if ((val
= pcm_formats
[format
].signd
) < 0)
224 EXPORT_SYMBOL(snd_pcm_format_signed
);
227 * snd_pcm_format_unsigned - Check the PCM format is unsigned linear
228 * @format: the format to check
230 * Returns 1 if the given PCM format is unsigned linear, 0 if signed
231 * linear, and a negative error code for non-linear formats.
233 int snd_pcm_format_unsigned(snd_pcm_format_t format
)
237 val
= snd_pcm_format_signed(format
);
243 EXPORT_SYMBOL(snd_pcm_format_unsigned
);
246 * snd_pcm_format_linear - Check the PCM format is linear
247 * @format: the format to check
249 * Returns 1 if the given PCM format is linear, 0 if not.
251 int snd_pcm_format_linear(snd_pcm_format_t format
)
253 return snd_pcm_format_signed(format
) >= 0;
256 EXPORT_SYMBOL(snd_pcm_format_linear
);
259 * snd_pcm_format_little_endian - Check the PCM format is little-endian
260 * @format: the format to check
262 * Returns 1 if the given PCM format is little-endian, 0 if
263 * big-endian, or a negative error code if endian not specified.
265 int snd_pcm_format_little_endian(snd_pcm_format_t format
)
268 if (format
< 0 || format
> SNDRV_PCM_FORMAT_LAST
)
270 if ((val
= pcm_formats
[format
].le
) < 0)
275 EXPORT_SYMBOL(snd_pcm_format_little_endian
);
278 * snd_pcm_format_big_endian - Check the PCM format is big-endian
279 * @format: the format to check
281 * Returns 1 if the given PCM format is big-endian, 0 if
282 * little-endian, or a negative error code if endian not specified.
284 int snd_pcm_format_big_endian(snd_pcm_format_t format
)
288 val
= snd_pcm_format_little_endian(format
);
294 EXPORT_SYMBOL(snd_pcm_format_big_endian
);
297 * snd_pcm_format_width - return the bit-width of the format
298 * @format: the format to check
300 * Returns the bit-width of the format, or a negative error code
303 int snd_pcm_format_width(snd_pcm_format_t format
)
306 if (format
< 0 || format
> SNDRV_PCM_FORMAT_LAST
)
308 if ((val
= pcm_formats
[format
].width
) == 0)
313 EXPORT_SYMBOL(snd_pcm_format_width
);
316 * snd_pcm_format_physical_width - return the physical bit-width of the format
317 * @format: the format to check
319 * Returns the physical bit-width of the format, or a negative error code
322 int snd_pcm_format_physical_width(snd_pcm_format_t format
)
325 if (format
< 0 || format
> SNDRV_PCM_FORMAT_LAST
)
327 if ((val
= pcm_formats
[format
].phys
) == 0)
332 EXPORT_SYMBOL(snd_pcm_format_physical_width
);
335 * snd_pcm_format_size - return the byte size of samples on the given format
336 * @format: the format to check
337 * @samples: sampling rate
339 * Returns the byte size of the given samples for the format, or a
340 * negative error code if unknown format.
342 ssize_t
snd_pcm_format_size(snd_pcm_format_t format
, size_t samples
)
344 int phys_width
= snd_pcm_format_physical_width(format
);
347 return samples
* phys_width
/ 8;
350 EXPORT_SYMBOL(snd_pcm_format_size
);
353 * snd_pcm_format_silence_64 - return the silent data in 8 bytes array
354 * @format: the format to check
356 * Returns the format pattern to fill or NULL if error.
358 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format
)
360 if (format
< 0 || format
> SNDRV_PCM_FORMAT_LAST
)
362 if (! pcm_formats
[format
].phys
)
364 return pcm_formats
[format
].silence
;
367 EXPORT_SYMBOL(snd_pcm_format_silence_64
);
370 * snd_pcm_format_set_silence - set the silence data on the buffer
371 * @format: the PCM format
372 * @data: the buffer pointer
373 * @samples: the number of samples to set silence
375 * Sets the silence data on the buffer for the given samples.
377 * Returns zero if successful, or a negative error code on failure.
379 int snd_pcm_format_set_silence(snd_pcm_format_t format
, void *data
, unsigned int samples
)
382 unsigned char *dst
, *pat
;
384 if (format
< 0 || format
> SNDRV_PCM_FORMAT_LAST
)
388 width
= pcm_formats
[format
].phys
; /* physical width */
389 pat
= pcm_formats
[format
].silence
;
392 /* signed or 1 byte data */
393 if (pcm_formats
[format
].signd
== 1 || width
<= 8) {
394 unsigned int bytes
= samples
* width
/ 8;
395 memset(data
, *pat
, bytes
);
398 /* non-zero samples, fill using a loop */
401 /* a bit optimization for constant width */
431 EXPORT_SYMBOL(snd_pcm_format_set_silence
);
434 * snd_pcm_limit_hw_rates - determine rate_min/rate_max fields
435 * @runtime: the runtime instance
437 * Determines the rate_min and rate_max fields from the rates bits of
438 * the given runtime->hw.
440 * Returns zero if successful.
442 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime
*runtime
)
445 for (i
= 0; i
< (int)snd_pcm_known_rates
.count
; i
++) {
446 if (runtime
->hw
.rates
& (1 << i
)) {
447 runtime
->hw
.rate_min
= snd_pcm_known_rates
.list
[i
];
451 for (i
= (int)snd_pcm_known_rates
.count
- 1; i
>= 0; i
--) {
452 if (runtime
->hw
.rates
& (1 << i
)) {
453 runtime
->hw
.rate_max
= snd_pcm_known_rates
.list
[i
];
460 EXPORT_SYMBOL(snd_pcm_limit_hw_rates
);
463 * snd_pcm_rate_to_rate_bit - converts sample rate to SNDRV_PCM_RATE_xxx bit
464 * @rate: the sample rate to convert
466 * Returns the SNDRV_PCM_RATE_xxx flag that corresponds to the given rate, or
467 * SNDRV_PCM_RATE_KNOT for an unknown rate.
469 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate
)
473 for (i
= 0; i
< snd_pcm_known_rates
.count
; i
++)
474 if (snd_pcm_known_rates
.list
[i
] == rate
)
476 return SNDRV_PCM_RATE_KNOT
;
478 EXPORT_SYMBOL(snd_pcm_rate_to_rate_bit
);