2 * PCM Plug-In shared (kernel/library) code
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Library General Public License as
9 * published by the Free Software Foundation; either version 2 of
10 * the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #include <linux/slab.h>
28 #include <linux/time.h>
29 #include <linux/vmalloc.h>
30 #include <sound/core.h>
31 #include <sound/pcm.h>
32 #include <sound/pcm_params.h>
33 #include "pcm_plugin.h"
35 #define snd_pcm_plug_first(plug) ((plug)->runtime->oss.plugin_first)
36 #define snd_pcm_plug_last(plug) ((plug)->runtime->oss.plugin_last)
39 * because some cards might have rates "very close", we ignore
40 * all "resampling" requests within +-5%
42 static int rate_match(unsigned int src_rate, unsigned int dst_rate)
44 unsigned int low = (src_rate * 95) / 100;
45 unsigned int high = (src_rate * 105) / 100;
46 return dst_rate >= low && dst_rate <= high;
49 static int snd_pcm_plugin_alloc(struct snd_pcm_plugin *plugin, snd_pcm_uframes_t frames)
51 struct snd_pcm_plugin_format *format;
55 struct snd_pcm_plugin_channel *c;
57 if (plugin->stream == SNDRV_PCM_STREAM_PLAYBACK) {
58 format = &plugin->src_format;
60 format = &plugin->dst_format;
62 if ((width = snd_pcm_format_physical_width(format->format)) < 0)
64 size = frames * format->channels * width;
65 if (snd_BUG_ON(size % 8))
68 if (plugin->buf_frames < frames) {
70 plugin->buf = kvzalloc(size, GFP_KERNEL);
71 plugin->buf_frames = frames;
74 plugin->buf_frames = 0;
77 c = plugin->buf_channels;
78 if (plugin->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED) {
79 for (channel = 0; channel < format->channels; channel++, c++) {
83 c->area.addr = plugin->buf;
84 c->area.first = channel * width;
85 c->area.step = format->channels * width;
87 } else if (plugin->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED) {
88 if (snd_BUG_ON(size % format->channels))
90 size /= format->channels;
91 for (channel = 0; channel < format->channels; channel++, c++) {
95 c->area.addr = plugin->buf + (channel * size);
104 int snd_pcm_plug_alloc(struct snd_pcm_substream *plug, snd_pcm_uframes_t frames)
107 if (snd_BUG_ON(!snd_pcm_plug_first(plug)))
109 if (snd_pcm_plug_stream(plug) == SNDRV_PCM_STREAM_PLAYBACK) {
110 struct snd_pcm_plugin *plugin = snd_pcm_plug_first(plug);
111 while (plugin->next) {
112 if (plugin->dst_frames)
113 frames = plugin->dst_frames(plugin, frames);
114 if ((snd_pcm_sframes_t)frames <= 0)
116 plugin = plugin->next;
117 err = snd_pcm_plugin_alloc(plugin, frames);
122 struct snd_pcm_plugin *plugin = snd_pcm_plug_last(plug);
123 while (plugin->prev) {
124 if (plugin->src_frames)
125 frames = plugin->src_frames(plugin, frames);
126 if ((snd_pcm_sframes_t)frames <= 0)
128 plugin = plugin->prev;
129 err = snd_pcm_plugin_alloc(plugin, frames);
138 snd_pcm_sframes_t snd_pcm_plugin_client_channels(struct snd_pcm_plugin *plugin,
139 snd_pcm_uframes_t frames,
140 struct snd_pcm_plugin_channel **channels)
142 *channels = plugin->buf_channels;
146 int snd_pcm_plugin_build(struct snd_pcm_substream *plug,
148 struct snd_pcm_plugin_format *src_format,
149 struct snd_pcm_plugin_format *dst_format,
151 struct snd_pcm_plugin **ret)
153 struct snd_pcm_plugin *plugin;
154 unsigned int channels;
156 if (snd_BUG_ON(!plug))
158 if (snd_BUG_ON(!src_format || !dst_format))
160 plugin = kzalloc(sizeof(*plugin) + extra, GFP_KERNEL);
165 plugin->stream = snd_pcm_plug_stream(plug);
166 plugin->access = SNDRV_PCM_ACCESS_RW_INTERLEAVED;
167 plugin->src_format = *src_format;
168 plugin->src_width = snd_pcm_format_physical_width(src_format->format);
169 snd_BUG_ON(plugin->src_width <= 0);
170 plugin->dst_format = *dst_format;
171 plugin->dst_width = snd_pcm_format_physical_width(dst_format->format);
172 snd_BUG_ON(plugin->dst_width <= 0);
173 if (plugin->stream == SNDRV_PCM_STREAM_PLAYBACK)
174 channels = src_format->channels;
176 channels = dst_format->channels;
177 plugin->buf_channels = kcalloc(channels, sizeof(*plugin->buf_channels), GFP_KERNEL);
178 if (plugin->buf_channels == NULL) {
179 snd_pcm_plugin_free(plugin);
182 plugin->client_channels = snd_pcm_plugin_client_channels;
187 int snd_pcm_plugin_free(struct snd_pcm_plugin *plugin)
191 if (plugin->private_free)
192 plugin->private_free(plugin);
193 kfree(plugin->buf_channels);
199 static snd_pcm_sframes_t calc_dst_frames(struct snd_pcm_substream *plug,
200 snd_pcm_sframes_t frames,
203 struct snd_pcm_plugin *plugin, *plugin_next;
205 plugin = snd_pcm_plug_first(plug);
206 while (plugin && frames > 0) {
207 plugin_next = plugin->next;
208 if (plugin->dst_frames) {
209 frames = plugin->dst_frames(plugin, frames);
213 if (check_size && frames > plugin->buf_frames)
214 frames = plugin->buf_frames;
215 plugin = plugin_next;
220 static snd_pcm_sframes_t calc_src_frames(struct snd_pcm_substream *plug,
221 snd_pcm_sframes_t frames,
224 struct snd_pcm_plugin *plugin, *plugin_prev;
226 plugin = snd_pcm_plug_last(plug);
227 while (plugin && frames > 0) {
228 if (check_size && frames > plugin->buf_frames)
229 frames = plugin->buf_frames;
230 plugin_prev = plugin->prev;
231 if (plugin->src_frames) {
232 frames = plugin->src_frames(plugin, frames);
236 plugin = plugin_prev;
241 snd_pcm_sframes_t snd_pcm_plug_client_size(struct snd_pcm_substream *plug, snd_pcm_uframes_t drv_frames)
243 if (snd_BUG_ON(!plug))
245 switch (snd_pcm_plug_stream(plug)) {
246 case SNDRV_PCM_STREAM_PLAYBACK:
247 return calc_src_frames(plug, drv_frames, false);
248 case SNDRV_PCM_STREAM_CAPTURE:
249 return calc_dst_frames(plug, drv_frames, false);
256 snd_pcm_sframes_t snd_pcm_plug_slave_size(struct snd_pcm_substream *plug, snd_pcm_uframes_t clt_frames)
258 if (snd_BUG_ON(!plug))
260 switch (snd_pcm_plug_stream(plug)) {
261 case SNDRV_PCM_STREAM_PLAYBACK:
262 return calc_dst_frames(plug, clt_frames, false);
263 case SNDRV_PCM_STREAM_CAPTURE:
264 return calc_src_frames(plug, clt_frames, false);
271 static int snd_pcm_plug_formats(const struct snd_mask *mask,
272 snd_pcm_format_t format)
274 struct snd_mask formats = *mask;
275 u64 linfmts = (SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S8 |
276 SNDRV_PCM_FMTBIT_U16_LE | SNDRV_PCM_FMTBIT_S16_LE |
277 SNDRV_PCM_FMTBIT_U16_BE | SNDRV_PCM_FMTBIT_S16_BE |
278 SNDRV_PCM_FMTBIT_U24_LE | SNDRV_PCM_FMTBIT_S24_LE |
279 SNDRV_PCM_FMTBIT_U24_BE | SNDRV_PCM_FMTBIT_S24_BE |
280 SNDRV_PCM_FMTBIT_U24_3LE | SNDRV_PCM_FMTBIT_S24_3LE |
281 SNDRV_PCM_FMTBIT_U24_3BE | SNDRV_PCM_FMTBIT_S24_3BE |
282 SNDRV_PCM_FMTBIT_U32_LE | SNDRV_PCM_FMTBIT_S32_LE |
283 SNDRV_PCM_FMTBIT_U32_BE | SNDRV_PCM_FMTBIT_S32_BE);
284 snd_mask_set(&formats, (__force int)SNDRV_PCM_FORMAT_MU_LAW);
286 if (formats.bits[0] & lower_32_bits(linfmts))
287 formats.bits[0] |= lower_32_bits(linfmts);
288 if (formats.bits[1] & upper_32_bits(linfmts))
289 formats.bits[1] |= upper_32_bits(linfmts);
290 return snd_mask_test(&formats, (__force int)format);
293 static const snd_pcm_format_t preferred_formats[] = {
294 SNDRV_PCM_FORMAT_S16_LE,
295 SNDRV_PCM_FORMAT_S16_BE,
296 SNDRV_PCM_FORMAT_U16_LE,
297 SNDRV_PCM_FORMAT_U16_BE,
298 SNDRV_PCM_FORMAT_S24_3LE,
299 SNDRV_PCM_FORMAT_S24_3BE,
300 SNDRV_PCM_FORMAT_U24_3LE,
301 SNDRV_PCM_FORMAT_U24_3BE,
302 SNDRV_PCM_FORMAT_S24_LE,
303 SNDRV_PCM_FORMAT_S24_BE,
304 SNDRV_PCM_FORMAT_U24_LE,
305 SNDRV_PCM_FORMAT_U24_BE,
306 SNDRV_PCM_FORMAT_S32_LE,
307 SNDRV_PCM_FORMAT_S32_BE,
308 SNDRV_PCM_FORMAT_U32_LE,
309 SNDRV_PCM_FORMAT_U32_BE,
314 snd_pcm_format_t snd_pcm_plug_slave_format(snd_pcm_format_t format,
315 const struct snd_mask *format_mask)
319 if (snd_mask_test(format_mask, (__force int)format))
321 if (!snd_pcm_plug_formats(format_mask, format))
322 return (__force snd_pcm_format_t)-EINVAL;
323 if (snd_pcm_format_linear(format)) {
324 unsigned int width = snd_pcm_format_width(format);
325 int unsignd = snd_pcm_format_unsigned(format) > 0;
326 int big = snd_pcm_format_big_endian(format) > 0;
327 unsigned int badness, best = -1;
328 snd_pcm_format_t best_format = (__force snd_pcm_format_t)-1;
329 for (i = 0; i < ARRAY_SIZE(preferred_formats); i++) {
330 snd_pcm_format_t f = preferred_formats[i];
332 if (!snd_mask_test(format_mask, (__force int)f))
334 w = snd_pcm_format_width(f);
338 badness = width - w + 32;
339 badness += snd_pcm_format_unsigned(f) != unsignd;
340 badness += snd_pcm_format_big_endian(f) != big;
341 if (badness < best) {
346 if ((__force int)best_format >= 0)
349 return (__force snd_pcm_format_t)-EINVAL;
352 case SNDRV_PCM_FORMAT_MU_LAW:
353 for (i = 0; i < ARRAY_SIZE(preferred_formats); ++i) {
354 snd_pcm_format_t format1 = preferred_formats[i];
355 if (snd_mask_test(format_mask, (__force int)format1))
360 return (__force snd_pcm_format_t)-EINVAL;
365 int snd_pcm_plug_format_plugins(struct snd_pcm_substream *plug,
366 struct snd_pcm_hw_params *params,
367 struct snd_pcm_hw_params *slave_params)
369 struct snd_pcm_plugin_format tmpformat;
370 struct snd_pcm_plugin_format dstformat;
371 struct snd_pcm_plugin_format srcformat;
372 snd_pcm_access_t src_access, dst_access;
373 struct snd_pcm_plugin *plugin = NULL;
375 int stream = snd_pcm_plug_stream(plug);
376 int slave_interleaved = (params_channels(slave_params) == 1 ||
377 params_access(slave_params) == SNDRV_PCM_ACCESS_RW_INTERLEAVED);
380 case SNDRV_PCM_STREAM_PLAYBACK:
381 dstformat.format = params_format(slave_params);
382 dstformat.rate = params_rate(slave_params);
383 dstformat.channels = params_channels(slave_params);
384 srcformat.format = params_format(params);
385 srcformat.rate = params_rate(params);
386 srcformat.channels = params_channels(params);
387 src_access = SNDRV_PCM_ACCESS_RW_INTERLEAVED;
388 dst_access = (slave_interleaved ? SNDRV_PCM_ACCESS_RW_INTERLEAVED :
389 SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
391 case SNDRV_PCM_STREAM_CAPTURE:
392 dstformat.format = params_format(params);
393 dstformat.rate = params_rate(params);
394 dstformat.channels = params_channels(params);
395 srcformat.format = params_format(slave_params);
396 srcformat.rate = params_rate(slave_params);
397 srcformat.channels = params_channels(slave_params);
398 src_access = (slave_interleaved ? SNDRV_PCM_ACCESS_RW_INTERLEAVED :
399 SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
400 dst_access = SNDRV_PCM_ACCESS_RW_INTERLEAVED;
406 tmpformat = srcformat;
408 pdprintf("srcformat: format=%i, rate=%i, channels=%i\n",
412 pdprintf("dstformat: format=%i, rate=%i, channels=%i\n",
417 /* Format change (linearization) */
418 if (! rate_match(srcformat.rate, dstformat.rate) &&
419 ! snd_pcm_format_linear(srcformat.format)) {
420 if (srcformat.format != SNDRV_PCM_FORMAT_MU_LAW)
422 tmpformat.format = SNDRV_PCM_FORMAT_S16;
423 err = snd_pcm_plugin_build_mulaw(plug,
424 &srcformat, &tmpformat,
428 err = snd_pcm_plugin_append(plugin);
430 snd_pcm_plugin_free(plugin);
433 srcformat = tmpformat;
434 src_access = dst_access;
437 /* channels reduction */
438 if (srcformat.channels > dstformat.channels) {
439 tmpformat.channels = dstformat.channels;
440 err = snd_pcm_plugin_build_route(plug, &srcformat, &tmpformat, &plugin);
441 pdprintf("channels reduction: src=%i, dst=%i returns %i\n", srcformat.channels, tmpformat.channels, err);
444 err = snd_pcm_plugin_append(plugin);
446 snd_pcm_plugin_free(plugin);
449 srcformat = tmpformat;
450 src_access = dst_access;
453 /* rate resampling */
454 if (!rate_match(srcformat.rate, dstformat.rate)) {
455 if (srcformat.format != SNDRV_PCM_FORMAT_S16) {
456 /* convert to S16 for resampling */
457 tmpformat.format = SNDRV_PCM_FORMAT_S16;
458 err = snd_pcm_plugin_build_linear(plug,
459 &srcformat, &tmpformat,
463 err = snd_pcm_plugin_append(plugin);
465 snd_pcm_plugin_free(plugin);
468 srcformat = tmpformat;
469 src_access = dst_access;
471 tmpformat.rate = dstformat.rate;
472 err = snd_pcm_plugin_build_rate(plug,
473 &srcformat, &tmpformat,
475 pdprintf("rate down resampling: src=%i, dst=%i returns %i\n", srcformat.rate, tmpformat.rate, err);
478 err = snd_pcm_plugin_append(plugin);
480 snd_pcm_plugin_free(plugin);
483 srcformat = tmpformat;
484 src_access = dst_access;
488 if (srcformat.format != dstformat.format) {
489 tmpformat.format = dstformat.format;
490 if (srcformat.format == SNDRV_PCM_FORMAT_MU_LAW ||
491 tmpformat.format == SNDRV_PCM_FORMAT_MU_LAW) {
492 err = snd_pcm_plugin_build_mulaw(plug,
493 &srcformat, &tmpformat,
496 else if (snd_pcm_format_linear(srcformat.format) &&
497 snd_pcm_format_linear(tmpformat.format)) {
498 err = snd_pcm_plugin_build_linear(plug,
499 &srcformat, &tmpformat,
504 pdprintf("format change: src=%i, dst=%i returns %i\n", srcformat.format, tmpformat.format, err);
507 err = snd_pcm_plugin_append(plugin);
509 snd_pcm_plugin_free(plugin);
512 srcformat = tmpformat;
513 src_access = dst_access;
516 /* channels extension */
517 if (srcformat.channels < dstformat.channels) {
518 tmpformat.channels = dstformat.channels;
519 err = snd_pcm_plugin_build_route(plug, &srcformat, &tmpformat, &plugin);
520 pdprintf("channels extension: src=%i, dst=%i returns %i\n", srcformat.channels, tmpformat.channels, err);
523 err = snd_pcm_plugin_append(plugin);
525 snd_pcm_plugin_free(plugin);
528 srcformat = tmpformat;
529 src_access = dst_access;
533 if (src_access != dst_access) {
534 err = snd_pcm_plugin_build_copy(plug,
538 pdprintf("interleave change (copy: returns %i)\n", err);
541 err = snd_pcm_plugin_append(plugin);
543 snd_pcm_plugin_free(plugin);
551 snd_pcm_sframes_t snd_pcm_plug_client_channels_buf(struct snd_pcm_substream *plug,
553 snd_pcm_uframes_t count,
554 struct snd_pcm_plugin_channel **channels)
556 struct snd_pcm_plugin *plugin;
557 struct snd_pcm_plugin_channel *v;
558 struct snd_pcm_plugin_format *format;
559 int width, nchannels, channel;
560 int stream = snd_pcm_plug_stream(plug);
562 if (snd_BUG_ON(!buf))
564 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
565 plugin = snd_pcm_plug_first(plug);
566 format = &plugin->src_format;
568 plugin = snd_pcm_plug_last(plug);
569 format = &plugin->dst_format;
571 v = plugin->buf_channels;
573 if ((width = snd_pcm_format_physical_width(format->format)) < 0)
575 nchannels = format->channels;
576 if (snd_BUG_ON(plugin->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED &&
577 format->channels > 1))
579 for (channel = 0; channel < nchannels; channel++, v++) {
582 v->wanted = (stream == SNDRV_PCM_STREAM_CAPTURE);
584 v->area.first = channel * width;
585 v->area.step = nchannels * width;
590 snd_pcm_sframes_t snd_pcm_plug_write_transfer(struct snd_pcm_substream *plug, struct snd_pcm_plugin_channel *src_channels, snd_pcm_uframes_t size)
592 struct snd_pcm_plugin *plugin, *next;
593 struct snd_pcm_plugin_channel *dst_channels;
595 snd_pcm_sframes_t frames = size;
597 plugin = snd_pcm_plug_first(plug);
601 if ((next = plugin->next) != NULL) {
602 snd_pcm_sframes_t frames1 = frames;
603 if (plugin->dst_frames) {
604 frames1 = plugin->dst_frames(plugin, frames);
608 if ((err = next->client_channels(next, frames1, &dst_channels)) < 0) {
611 if (err != frames1) {
613 if (plugin->src_frames) {
614 frames = plugin->src_frames(plugin, frames1);
621 pdprintf("write plugin: %s, %li\n", plugin->name, frames);
622 if ((frames = plugin->transfer(plugin, src_channels, dst_channels, frames)) < 0)
624 src_channels = dst_channels;
627 return calc_src_frames(plug, frames, true);
630 snd_pcm_sframes_t snd_pcm_plug_read_transfer(struct snd_pcm_substream *plug, struct snd_pcm_plugin_channel *dst_channels_final, snd_pcm_uframes_t size)
632 struct snd_pcm_plugin *plugin, *next;
633 struct snd_pcm_plugin_channel *src_channels, *dst_channels;
634 snd_pcm_sframes_t frames = size;
637 frames = calc_src_frames(plug, frames, true);
642 plugin = snd_pcm_plug_first(plug);
643 while (plugin && frames > 0) {
644 if ((next = plugin->next) != NULL) {
645 if ((err = plugin->client_channels(plugin, frames, &dst_channels)) < 0) {
650 dst_channels = dst_channels_final;
652 pdprintf("read plugin: %s, %li\n", plugin->name, frames);
653 if ((frames = plugin->transfer(plugin, src_channels, dst_channels, frames)) < 0)
656 src_channels = dst_channels;
661 int snd_pcm_area_silence(const struct snd_pcm_channel_area *dst_area, size_t dst_offset,
662 size_t samples, snd_pcm_format_t format)
664 /* FIXME: sub byte resolution and odd dst_offset */
666 unsigned int dst_step;
668 const unsigned char *silence;
671 dst = dst_area->addr + (dst_area->first + dst_area->step * dst_offset) / 8;
672 width = snd_pcm_format_physical_width(format);
675 if (dst_area->step == (unsigned int) width && width >= 8)
676 return snd_pcm_format_set_silence(format, dst, samples);
677 silence = snd_pcm_format_silence_64(format);
680 dst_step = dst_area->step / 8;
683 int dstbit = dst_area->first % 8;
684 int dstbit_step = dst_area->step % 8;
685 while (samples-- > 0) {
691 dstbit += dstbit_step;
699 while (samples-- > 0) {
700 memcpy(dst, silence, width);
707 int snd_pcm_area_copy(const struct snd_pcm_channel_area *src_area, size_t src_offset,
708 const struct snd_pcm_channel_area *dst_area, size_t dst_offset,
709 size_t samples, snd_pcm_format_t format)
711 /* FIXME: sub byte resolution and odd dst_offset */
714 int src_step, dst_step;
715 src = src_area->addr + (src_area->first + src_area->step * src_offset) / 8;
717 return snd_pcm_area_silence(dst_area, dst_offset, samples, format);
718 dst = dst_area->addr + (dst_area->first + dst_area->step * dst_offset) / 8;
721 width = snd_pcm_format_physical_width(format);
724 if (src_area->step == (unsigned int) width &&
725 dst_area->step == (unsigned int) width && width >= 8) {
726 size_t bytes = samples * width / 8;
727 memcpy(dst, src, bytes);
730 src_step = src_area->step / 8;
731 dst_step = dst_area->step / 8;
734 int srcbit = src_area->first % 8;
735 int srcbit_step = src_area->step % 8;
736 int dstbit = dst_area->first % 8;
737 int dstbit_step = dst_area->step % 8;
738 while (samples-- > 0) {
739 unsigned char srcval;
741 srcval = *src & 0x0f;
743 srcval = (*src & 0xf0) >> 4;
745 *dst = (*dst & 0xf0) | srcval;
747 *dst = (*dst & 0x0f) | (srcval << 4);
749 srcbit += srcbit_step;
755 dstbit += dstbit_step;
763 while (samples-- > 0) {
764 memcpy(dst, src, width);