2 * PCM Plug-In shared (kernel/library) code
3 * Copyright (c) 1999 by Jaroslav Kysela <perex@perex.cz>
4 * Copyright (c) 2000 by Abramo Bagnara <abramo@alsa-project.org>
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 plug_client_size(struct snd_pcm_substream *plug,
200 snd_pcm_uframes_t drv_frames,
203 struct snd_pcm_plugin *plugin, *plugin_prev, *plugin_next;
206 if (snd_BUG_ON(!plug))
210 stream = snd_pcm_plug_stream(plug);
211 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
212 plugin = snd_pcm_plug_last(plug);
213 while (plugin && drv_frames > 0) {
214 plugin_prev = plugin->prev;
215 if (plugin->src_frames)
216 drv_frames = plugin->src_frames(plugin, drv_frames);
217 if (check_size && plugin->buf_frames &&
218 drv_frames > plugin->buf_frames)
219 drv_frames = plugin->buf_frames;
220 plugin = plugin_prev;
222 } else if (stream == SNDRV_PCM_STREAM_CAPTURE) {
223 plugin = snd_pcm_plug_first(plug);
224 while (plugin && drv_frames > 0) {
225 plugin_next = plugin->next;
226 if (check_size && plugin->buf_frames &&
227 drv_frames > plugin->buf_frames)
228 drv_frames = plugin->buf_frames;
229 if (plugin->dst_frames)
230 drv_frames = plugin->dst_frames(plugin, drv_frames);
231 plugin = plugin_next;
238 static snd_pcm_sframes_t plug_slave_size(struct snd_pcm_substream *plug,
239 snd_pcm_uframes_t clt_frames,
242 struct snd_pcm_plugin *plugin, *plugin_prev, *plugin_next;
243 snd_pcm_sframes_t frames;
246 if (snd_BUG_ON(!plug))
251 stream = snd_pcm_plug_stream(plug);
252 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
253 plugin = snd_pcm_plug_first(plug);
254 while (plugin && frames > 0) {
255 plugin_next = plugin->next;
256 if (check_size && plugin->buf_frames &&
257 frames > plugin->buf_frames)
258 frames = plugin->buf_frames;
259 if (plugin->dst_frames) {
260 frames = plugin->dst_frames(plugin, frames);
264 plugin = plugin_next;
266 } else if (stream == SNDRV_PCM_STREAM_CAPTURE) {
267 plugin = snd_pcm_plug_last(plug);
269 plugin_prev = plugin->prev;
270 if (plugin->src_frames) {
271 frames = plugin->src_frames(plugin, frames);
275 if (check_size && plugin->buf_frames &&
276 frames > plugin->buf_frames)
277 frames = plugin->buf_frames;
278 plugin = plugin_prev;
285 snd_pcm_sframes_t snd_pcm_plug_client_size(struct snd_pcm_substream *plug,
286 snd_pcm_uframes_t drv_frames)
288 return plug_client_size(plug, drv_frames, false);
291 snd_pcm_sframes_t snd_pcm_plug_slave_size(struct snd_pcm_substream *plug,
292 snd_pcm_uframes_t clt_frames)
294 return plug_slave_size(plug, clt_frames, false);
297 static int snd_pcm_plug_formats(const struct snd_mask *mask,
298 snd_pcm_format_t format)
300 struct snd_mask formats = *mask;
301 u64 linfmts = (SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S8 |
302 SNDRV_PCM_FMTBIT_U16_LE | SNDRV_PCM_FMTBIT_S16_LE |
303 SNDRV_PCM_FMTBIT_U16_BE | SNDRV_PCM_FMTBIT_S16_BE |
304 SNDRV_PCM_FMTBIT_U24_LE | SNDRV_PCM_FMTBIT_S24_LE |
305 SNDRV_PCM_FMTBIT_U24_BE | SNDRV_PCM_FMTBIT_S24_BE |
306 SNDRV_PCM_FMTBIT_U24_3LE | SNDRV_PCM_FMTBIT_S24_3LE |
307 SNDRV_PCM_FMTBIT_U24_3BE | SNDRV_PCM_FMTBIT_S24_3BE |
308 SNDRV_PCM_FMTBIT_U32_LE | SNDRV_PCM_FMTBIT_S32_LE |
309 SNDRV_PCM_FMTBIT_U32_BE | SNDRV_PCM_FMTBIT_S32_BE);
310 snd_mask_set(&formats, (__force int)SNDRV_PCM_FORMAT_MU_LAW);
312 if (formats.bits[0] & (u32)linfmts)
313 formats.bits[0] |= (u32)linfmts;
314 if (formats.bits[1] & (u32)(linfmts >> 32))
315 formats.bits[1] |= (u32)(linfmts >> 32);
316 return snd_mask_test(&formats, (__force int)format);
319 static snd_pcm_format_t preferred_formats[] = {
320 SNDRV_PCM_FORMAT_S16_LE,
321 SNDRV_PCM_FORMAT_S16_BE,
322 SNDRV_PCM_FORMAT_U16_LE,
323 SNDRV_PCM_FORMAT_U16_BE,
324 SNDRV_PCM_FORMAT_S24_3LE,
325 SNDRV_PCM_FORMAT_S24_3BE,
326 SNDRV_PCM_FORMAT_U24_3LE,
327 SNDRV_PCM_FORMAT_U24_3BE,
328 SNDRV_PCM_FORMAT_S24_LE,
329 SNDRV_PCM_FORMAT_S24_BE,
330 SNDRV_PCM_FORMAT_U24_LE,
331 SNDRV_PCM_FORMAT_U24_BE,
332 SNDRV_PCM_FORMAT_S32_LE,
333 SNDRV_PCM_FORMAT_S32_BE,
334 SNDRV_PCM_FORMAT_U32_LE,
335 SNDRV_PCM_FORMAT_U32_BE,
340 snd_pcm_format_t snd_pcm_plug_slave_format(snd_pcm_format_t format,
341 const struct snd_mask *format_mask)
345 if (snd_mask_test(format_mask, (__force int)format))
347 if (!snd_pcm_plug_formats(format_mask, format))
348 return (__force snd_pcm_format_t)-EINVAL;
349 if (snd_pcm_format_linear(format)) {
350 unsigned int width = snd_pcm_format_width(format);
351 int unsignd = snd_pcm_format_unsigned(format) > 0;
352 int big = snd_pcm_format_big_endian(format) > 0;
353 unsigned int badness, best = -1;
354 snd_pcm_format_t best_format = (__force snd_pcm_format_t)-1;
355 for (i = 0; i < ARRAY_SIZE(preferred_formats); i++) {
356 snd_pcm_format_t f = preferred_formats[i];
358 if (!snd_mask_test(format_mask, (__force int)f))
360 w = snd_pcm_format_width(f);
364 badness = width - w + 32;
365 badness += snd_pcm_format_unsigned(f) != unsignd;
366 badness += snd_pcm_format_big_endian(f) != big;
367 if (badness < best) {
372 if ((__force int)best_format >= 0)
375 return (__force snd_pcm_format_t)-EINVAL;
378 case SNDRV_PCM_FORMAT_MU_LAW:
379 for (i = 0; i < ARRAY_SIZE(preferred_formats); ++i) {
380 snd_pcm_format_t format1 = preferred_formats[i];
381 if (snd_mask_test(format_mask, (__force int)format1))
385 return (__force snd_pcm_format_t)-EINVAL;
390 int snd_pcm_plug_format_plugins(struct snd_pcm_substream *plug,
391 struct snd_pcm_hw_params *params,
392 struct snd_pcm_hw_params *slave_params)
394 struct snd_pcm_plugin_format tmpformat;
395 struct snd_pcm_plugin_format dstformat;
396 struct snd_pcm_plugin_format srcformat;
397 snd_pcm_access_t src_access, dst_access;
398 struct snd_pcm_plugin *plugin = NULL;
400 int stream = snd_pcm_plug_stream(plug);
401 int slave_interleaved = (params_channels(slave_params) == 1 ||
402 params_access(slave_params) == SNDRV_PCM_ACCESS_RW_INTERLEAVED);
405 case SNDRV_PCM_STREAM_PLAYBACK:
406 dstformat.format = params_format(slave_params);
407 dstformat.rate = params_rate(slave_params);
408 dstformat.channels = params_channels(slave_params);
409 srcformat.format = params_format(params);
410 srcformat.rate = params_rate(params);
411 srcformat.channels = params_channels(params);
412 src_access = SNDRV_PCM_ACCESS_RW_INTERLEAVED;
413 dst_access = (slave_interleaved ? SNDRV_PCM_ACCESS_RW_INTERLEAVED :
414 SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
416 case SNDRV_PCM_STREAM_CAPTURE:
417 dstformat.format = params_format(params);
418 dstformat.rate = params_rate(params);
419 dstformat.channels = params_channels(params);
420 srcformat.format = params_format(slave_params);
421 srcformat.rate = params_rate(slave_params);
422 srcformat.channels = params_channels(slave_params);
423 src_access = (slave_interleaved ? SNDRV_PCM_ACCESS_RW_INTERLEAVED :
424 SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
425 dst_access = SNDRV_PCM_ACCESS_RW_INTERLEAVED;
431 tmpformat = srcformat;
433 pdprintf("srcformat: format=%i, rate=%i, channels=%i\n",
437 pdprintf("dstformat: format=%i, rate=%i, channels=%i\n",
442 /* Format change (linearization) */
443 if (! rate_match(srcformat.rate, dstformat.rate) &&
444 ! snd_pcm_format_linear(srcformat.format)) {
445 if (srcformat.format != SNDRV_PCM_FORMAT_MU_LAW)
447 tmpformat.format = SNDRV_PCM_FORMAT_S16;
448 err = snd_pcm_plugin_build_mulaw(plug,
449 &srcformat, &tmpformat,
453 err = snd_pcm_plugin_append(plugin);
455 snd_pcm_plugin_free(plugin);
458 srcformat = tmpformat;
459 src_access = dst_access;
462 /* channels reduction */
463 if (srcformat.channels > dstformat.channels) {
464 tmpformat.channels = dstformat.channels;
465 err = snd_pcm_plugin_build_route(plug, &srcformat, &tmpformat, &plugin);
466 pdprintf("channels reduction: src=%i, dst=%i returns %i\n", srcformat.channels, tmpformat.channels, err);
469 err = snd_pcm_plugin_append(plugin);
471 snd_pcm_plugin_free(plugin);
474 srcformat = tmpformat;
475 src_access = dst_access;
478 /* rate resampling */
479 if (!rate_match(srcformat.rate, dstformat.rate)) {
480 if (srcformat.format != SNDRV_PCM_FORMAT_S16) {
481 /* convert to S16 for resampling */
482 tmpformat.format = SNDRV_PCM_FORMAT_S16;
483 err = snd_pcm_plugin_build_linear(plug,
484 &srcformat, &tmpformat,
488 err = snd_pcm_plugin_append(plugin);
490 snd_pcm_plugin_free(plugin);
493 srcformat = tmpformat;
494 src_access = dst_access;
496 tmpformat.rate = dstformat.rate;
497 err = snd_pcm_plugin_build_rate(plug,
498 &srcformat, &tmpformat,
500 pdprintf("rate down resampling: src=%i, dst=%i returns %i\n", srcformat.rate, tmpformat.rate, err);
503 err = snd_pcm_plugin_append(plugin);
505 snd_pcm_plugin_free(plugin);
508 srcformat = tmpformat;
509 src_access = dst_access;
513 if (srcformat.format != dstformat.format) {
514 tmpformat.format = dstformat.format;
515 if (srcformat.format == SNDRV_PCM_FORMAT_MU_LAW ||
516 tmpformat.format == SNDRV_PCM_FORMAT_MU_LAW) {
517 err = snd_pcm_plugin_build_mulaw(plug,
518 &srcformat, &tmpformat,
521 else if (snd_pcm_format_linear(srcformat.format) &&
522 snd_pcm_format_linear(tmpformat.format)) {
523 err = snd_pcm_plugin_build_linear(plug,
524 &srcformat, &tmpformat,
529 pdprintf("format change: src=%i, dst=%i returns %i\n", srcformat.format, tmpformat.format, err);
532 err = snd_pcm_plugin_append(plugin);
534 snd_pcm_plugin_free(plugin);
537 srcformat = tmpformat;
538 src_access = dst_access;
541 /* channels extension */
542 if (srcformat.channels < dstformat.channels) {
543 tmpformat.channels = dstformat.channels;
544 err = snd_pcm_plugin_build_route(plug, &srcformat, &tmpformat, &plugin);
545 pdprintf("channels extension: src=%i, dst=%i returns %i\n", srcformat.channels, tmpformat.channels, err);
548 err = snd_pcm_plugin_append(plugin);
550 snd_pcm_plugin_free(plugin);
553 srcformat = tmpformat;
554 src_access = dst_access;
558 if (src_access != dst_access) {
559 err = snd_pcm_plugin_build_copy(plug,
563 pdprintf("interleave change (copy: returns %i)\n", err);
566 err = snd_pcm_plugin_append(plugin);
568 snd_pcm_plugin_free(plugin);
576 snd_pcm_sframes_t snd_pcm_plug_client_channels_buf(struct snd_pcm_substream *plug,
578 snd_pcm_uframes_t count,
579 struct snd_pcm_plugin_channel **channels)
581 struct snd_pcm_plugin *plugin;
582 struct snd_pcm_plugin_channel *v;
583 struct snd_pcm_plugin_format *format;
584 int width, nchannels, channel;
585 int stream = snd_pcm_plug_stream(plug);
587 if (snd_BUG_ON(!buf))
589 if (stream == SNDRV_PCM_STREAM_PLAYBACK) {
590 plugin = snd_pcm_plug_first(plug);
591 format = &plugin->src_format;
593 plugin = snd_pcm_plug_last(plug);
594 format = &plugin->dst_format;
596 v = plugin->buf_channels;
598 if ((width = snd_pcm_format_physical_width(format->format)) < 0)
600 nchannels = format->channels;
601 if (snd_BUG_ON(plugin->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED &&
602 format->channels > 1))
604 for (channel = 0; channel < nchannels; channel++, v++) {
607 v->wanted = (stream == SNDRV_PCM_STREAM_CAPTURE);
609 v->area.first = channel * width;
610 v->area.step = nchannels * width;
615 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)
617 struct snd_pcm_plugin *plugin, *next;
618 struct snd_pcm_plugin_channel *dst_channels;
620 snd_pcm_sframes_t frames = size;
622 plugin = snd_pcm_plug_first(plug);
626 if ((next = plugin->next) != NULL) {
627 snd_pcm_sframes_t frames1 = frames;
628 if (plugin->dst_frames) {
629 frames1 = plugin->dst_frames(plugin, frames);
633 if ((err = next->client_channels(next, frames1, &dst_channels)) < 0) {
636 if (err != frames1) {
638 if (plugin->src_frames) {
639 frames = plugin->src_frames(plugin, frames1);
646 pdprintf("write plugin: %s, %li\n", plugin->name, frames);
647 if ((frames = plugin->transfer(plugin, src_channels, dst_channels, frames)) < 0)
649 src_channels = dst_channels;
652 return plug_client_size(plug, frames, true);
655 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)
657 struct snd_pcm_plugin *plugin, *next;
658 struct snd_pcm_plugin_channel *src_channels, *dst_channels;
659 snd_pcm_sframes_t frames = size;
662 frames = plug_slave_size(plug, frames, true);
667 plugin = snd_pcm_plug_first(plug);
668 while (plugin && frames > 0) {
669 if ((next = plugin->next) != NULL) {
670 if ((err = plugin->client_channels(plugin, frames, &dst_channels)) < 0) {
675 dst_channels = dst_channels_final;
677 pdprintf("read plugin: %s, %li\n", plugin->name, frames);
678 if ((frames = plugin->transfer(plugin, src_channels, dst_channels, frames)) < 0)
681 src_channels = dst_channels;
686 int snd_pcm_area_silence(const struct snd_pcm_channel_area *dst_area, size_t dst_offset,
687 size_t samples, snd_pcm_format_t format)
689 /* FIXME: sub byte resolution and odd dst_offset */
691 unsigned int dst_step;
693 const unsigned char *silence;
696 dst = dst_area->addr + (dst_area->first + dst_area->step * dst_offset) / 8;
697 width = snd_pcm_format_physical_width(format);
700 if (dst_area->step == (unsigned int) width && width >= 8)
701 return snd_pcm_format_set_silence(format, dst, samples);
702 silence = snd_pcm_format_silence_64(format);
705 dst_step = dst_area->step / 8;
708 int dstbit = dst_area->first % 8;
709 int dstbit_step = dst_area->step % 8;
710 while (samples-- > 0) {
716 dstbit += dstbit_step;
724 while (samples-- > 0) {
725 memcpy(dst, silence, width);
732 int snd_pcm_area_copy(const struct snd_pcm_channel_area *src_area, size_t src_offset,
733 const struct snd_pcm_channel_area *dst_area, size_t dst_offset,
734 size_t samples, snd_pcm_format_t format)
736 /* FIXME: sub byte resolution and odd dst_offset */
739 int src_step, dst_step;
740 src = src_area->addr + (src_area->first + src_area->step * src_offset) / 8;
742 return snd_pcm_area_silence(dst_area, dst_offset, samples, format);
743 dst = dst_area->addr + (dst_area->first + dst_area->step * dst_offset) / 8;
746 width = snd_pcm_format_physical_width(format);
749 if (src_area->step == (unsigned int) width &&
750 dst_area->step == (unsigned int) width && width >= 8) {
751 size_t bytes = samples * width / 8;
752 memcpy(dst, src, bytes);
755 src_step = src_area->step / 8;
756 dst_step = dst_area->step / 8;
759 int srcbit = src_area->first % 8;
760 int srcbit_step = src_area->step % 8;
761 int dstbit = dst_area->first % 8;
762 int dstbit_step = dst_area->step % 8;
763 while (samples-- > 0) {
764 unsigned char srcval;
766 srcval = *src & 0x0f;
768 srcval = (*src & 0xf0) >> 4;
770 *dst = (*dst & 0xf0) | srcval;
772 *dst = (*dst & 0x0f) | (srcval << 4);
774 srcbit += srcbit_step;
780 dstbit += dstbit_step;
788 while (samples-- > 0) {
789 memcpy(dst, src, width);