2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008-2009 Ariff Abdullah <ariff@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * feeder_eq: Parametric (compile time) Software Equalizer. Though accidental,
31 * it proves good enough for educational and general consumption.
33 * "Cookbook formulae for audio EQ biquad filter coefficients"
34 * by Robert Bristow-Johnson <rbj@audioimagination.com>
35 * - http://www.musicdsp.org/files/Audio-EQ-Cookbook.txt
39 #ifdef HAVE_KERNEL_OPTION_HEADERS
42 #include <dev/sound/pcm/sound.h>
43 #include <dev/sound/pcm/pcm.h>
44 #include "feeder_if.h"
47 #include "snd_fxdiv_gen.h"
49 SND_DECLARE_FILE("$FreeBSD$");
52 #include "feeder_eq_gen.h"
54 #define FEEDEQ_LEVELS \
55 (((FEEDEQ_GAIN_MAX - FEEDEQ_GAIN_MIN) * \
56 (FEEDEQ_GAIN_DIV / FEEDEQ_GAIN_STEP)) + 1)
58 #define FEEDEQ_L2GAIN(v) \
59 ((int)min(((v) * FEEDEQ_LEVELS) / 100, FEEDEQ_LEVELS - 1))
61 #define FEEDEQ_PREAMP_IPART(x) (abs(x) >> FEEDEQ_GAIN_SHIFT)
62 #define FEEDEQ_PREAMP_FPART(x) (abs(x) & FEEDEQ_GAIN_FMASK)
63 #define FEEDEQ_PREAMP_SIGNVAL(x) ((x) < 0 ? -1 : 1)
64 #define FEEDEQ_PREAMP_SIGNMARK(x) (((x) < 0) ? '-' : '+')
66 #define FEEDEQ_PREAMP_IMIN -192
67 #define FEEDEQ_PREAMP_IMAX 192
68 #define FEEDEQ_PREAMP_FMIN 0
69 #define FEEDEQ_PREAMP_FMAX 9
71 #define FEEDEQ_PREAMP_INVALID INT_MAX
73 #define FEEDEQ_IF2PREAMP(i, f) \
74 ((abs(i) << FEEDEQ_GAIN_SHIFT) | \
75 (((abs(f) / FEEDEQ_GAIN_STEP) * FEEDEQ_GAIN_STEP) & \
78 #define FEEDEQ_PREAMP_MIN \
79 (FEEDEQ_PREAMP_SIGNVAL(FEEDEQ_GAIN_MIN) * \
80 FEEDEQ_IF2PREAMP(FEEDEQ_GAIN_MIN, 0))
82 #define FEEDEQ_PREAMP_MAX \
83 (FEEDEQ_PREAMP_SIGNVAL(FEEDEQ_GAIN_MAX) * \
84 FEEDEQ_IF2PREAMP(FEEDEQ_GAIN_MAX, 0))
86 #define FEEDEQ_PREAMP_DEFAULT FEEDEQ_IF2PREAMP(0, 0)
88 #define FEEDEQ_PREAMP2IDX(v) \
89 ((int32_t)((FEEDEQ_GAIN_MAX * (FEEDEQ_GAIN_DIV / \
90 FEEDEQ_GAIN_STEP)) + (FEEDEQ_PREAMP_SIGNVAL(v) * \
91 FEEDEQ_PREAMP_IPART(v) * (FEEDEQ_GAIN_DIV / \
92 FEEDEQ_GAIN_STEP)) + (FEEDEQ_PREAMP_SIGNVAL(v) * \
93 (FEEDEQ_PREAMP_FPART(v) / FEEDEQ_GAIN_STEP))))
95 static int feeder_eq_exact_rate = 0;
98 static char feeder_eq_presets[] = FEEDER_EQ_PRESETS;
99 SYSCTL_STRING(_hw_snd, OID_AUTO, feeder_eq_presets, CTLFLAG_RD,
100 &feeder_eq_presets, 0, "compile-time eq presets");
102 SYSCTL_INT(_hw_snd, OID_AUTO, feeder_eq_exact_rate, CTLFLAG_RWTUN,
103 &feeder_eq_exact_rate, 0, "force exact rate validation");
108 typedef void (*feed_eq_t)(struct feed_eq_info *, uint8_t *, uint32_t);
110 struct feed_eq_tone {
111 intpcm_t o1[SND_CHN_MAX];
112 intpcm_t o2[SND_CHN_MAX];
113 intpcm_t i1[SND_CHN_MAX];
114 intpcm_t i2[SND_CHN_MAX];
118 struct feed_eq_info {
119 struct feed_eq_tone treble;
120 struct feed_eq_tone bass;
121 struct feed_eq_coeff *coeff;
130 #if !defined(_KERNEL) && defined(FEEDEQ_ERR_CLIP)
131 #define FEEDEQ_ERR_CLIP_CHECK(t, v) do { \
132 if ((v) < PCM_S32_MIN || (v) > PCM_S32_MAX) \
133 errx(1, "\n\n%s(): ["#t"] Sample clipping: %jd\n", \
134 __func__, (intmax_t)(v)); \
137 #define FEEDEQ_ERR_CLIP_CHECK(...)
140 #define FEEDEQ_CLAMP(v) (((v) > PCM_S32_MAX) ? PCM_S32_MAX : \
141 (((v) < PCM_S32_MIN) ? PCM_S32_MIN : \
144 #define FEEDEQ_DECLARE(SIGN, BIT, ENDIAN) \
146 feed_eq_biquad_##SIGN##BIT##ENDIAN(struct feed_eq_info *info, \
147 uint8_t *dst, uint32_t count) \
149 struct feed_eq_coeff_tone *treble, *bass; \
153 int32_t pmul, pshift; \
155 pmul = feed_eq_preamp[info->preamp].mul; \
156 pshift = feed_eq_preamp[info->preamp].shift; \
158 if (info->state == FEEDEQ_DISABLE) { \
159 j = count * info->channels; \
160 dst += j * PCM_##BIT##_BPS; \
162 dst -= PCM_##BIT##_BPS; \
163 v = _PCM_READ_##SIGN##BIT##_##ENDIAN(dst); \
164 v = ((intpcm64_t)pmul * v) >> pshift; \
165 _PCM_WRITE_##SIGN##BIT##_##ENDIAN(dst, v); \
166 } while (--j != 0); \
171 treble = &(info->coeff[info->treble.gain].treble); \
172 bass = &(info->coeff[info->bass.gain].bass); \
176 j = info->channels; \
178 v = _PCM_READ_##SIGN##BIT##_##ENDIAN(dst); \
180 v = ((intpcm64_t)pmul * v) >> pshift; \
182 w = (intpcm64_t)v * treble->b0; \
183 w += (intpcm64_t)info->treble.i1[i] * treble->b1; \
184 w += (intpcm64_t)info->treble.i2[i] * treble->b2; \
185 w -= (intpcm64_t)info->treble.o1[i] * treble->a1; \
186 w -= (intpcm64_t)info->treble.o2[i] * treble->a2; \
187 info->treble.i2[i] = info->treble.i1[i]; \
188 info->treble.i1[i] = v; \
189 info->treble.o2[i] = info->treble.o1[i]; \
190 w >>= FEEDEQ_COEFF_SHIFT; \
191 FEEDEQ_ERR_CLIP_CHECK(treble, w); \
192 v = FEEDEQ_CLAMP(w); \
193 info->treble.o1[i] = v; \
195 w = (intpcm64_t)v * bass->b0; \
196 w += (intpcm64_t)info->bass.i1[i] * bass->b1; \
197 w += (intpcm64_t)info->bass.i2[i] * bass->b2; \
198 w -= (intpcm64_t)info->bass.o1[i] * bass->a1; \
199 w -= (intpcm64_t)info->bass.o2[i] * bass->a2; \
200 info->bass.i2[i] = info->bass.i1[i]; \
201 info->bass.i1[i] = v; \
202 info->bass.o2[i] = info->bass.o1[i]; \
203 w >>= FEEDEQ_COEFF_SHIFT; \
204 FEEDEQ_ERR_CLIP_CHECK(bass, w); \
205 v = FEEDEQ_CLAMP(w); \
206 info->bass.o1[i] = v; \
209 _PCM_WRITE_##SIGN##BIT##_##ENDIAN(dst, v); \
210 dst += PCM_##BIT##_BPS; \
212 } while (--j != 0); \
213 } while (--count != 0); \
216 #if BYTE_ORDER == LITTLE_ENDIAN || defined(SND_FEEDER_MULTIFORMAT)
217 FEEDEQ_DECLARE(S, 16, LE)
218 FEEDEQ_DECLARE(S, 32, LE)
220 #if BYTE_ORDER == BIG_ENDIAN || defined(SND_FEEDER_MULTIFORMAT)
221 FEEDEQ_DECLARE(S, 16, BE)
222 FEEDEQ_DECLARE(S, 32, BE)
224 #ifdef SND_FEEDER_MULTIFORMAT
225 FEEDEQ_DECLARE(S, 8, NE)
226 FEEDEQ_DECLARE(S, 24, LE)
227 FEEDEQ_DECLARE(S, 24, BE)
228 FEEDEQ_DECLARE(U, 8, NE)
229 FEEDEQ_DECLARE(U, 16, LE)
230 FEEDEQ_DECLARE(U, 24, LE)
231 FEEDEQ_DECLARE(U, 32, LE)
232 FEEDEQ_DECLARE(U, 16, BE)
233 FEEDEQ_DECLARE(U, 24, BE)
234 FEEDEQ_DECLARE(U, 32, BE)
237 #define FEEDEQ_ENTRY(SIGN, BIT, ENDIAN) \
239 AFMT_##SIGN##BIT##_##ENDIAN, \
240 feed_eq_biquad_##SIGN##BIT##ENDIAN \
244 static const struct {
247 } feed_eq_biquad_tab[] = {
248 #if BYTE_ORDER == LITTLE_ENDIAN || defined(SND_FEEDER_MULTIFORMAT)
249 FEEDEQ_ENTRY(S, 16, LE),
250 FEEDEQ_ENTRY(S, 32, LE),
252 #if BYTE_ORDER == BIG_ENDIAN || defined(SND_FEEDER_MULTIFORMAT)
253 FEEDEQ_ENTRY(S, 16, BE),
254 FEEDEQ_ENTRY(S, 32, BE),
256 #ifdef SND_FEEDER_MULTIFORMAT
257 FEEDEQ_ENTRY(S, 8, NE),
258 FEEDEQ_ENTRY(S, 24, LE),
259 FEEDEQ_ENTRY(S, 24, BE),
260 FEEDEQ_ENTRY(U, 8, NE),
261 FEEDEQ_ENTRY(U, 16, LE),
262 FEEDEQ_ENTRY(U, 24, LE),
263 FEEDEQ_ENTRY(U, 32, LE),
264 FEEDEQ_ENTRY(U, 16, BE),
265 FEEDEQ_ENTRY(U, 24, BE),
266 FEEDEQ_ENTRY(U, 32, BE)
270 #define FEEDEQ_BIQUAD_TAB_SIZE \
271 ((int32_t)(sizeof(feed_eq_biquad_tab) / sizeof(feed_eq_biquad_tab[0])))
273 static struct feed_eq_coeff *
274 feed_eq_coeff_rate(uint32_t rate)
276 uint32_t spd, threshold;
279 if (rate < FEEDEQ_RATE_MIN || rate > FEEDEQ_RATE_MAX)
283 * Not all rates are supported. Choose the best rate that we can to
284 * allow 'sloppy' conversion. Good enough for naive listeners.
286 for (i = 0; i < FEEDEQ_TAB_SIZE; i++) {
287 spd = feed_eq_tab[i].rate;
288 threshold = spd + ((i < (FEEDEQ_TAB_SIZE - 1) &&
289 feed_eq_tab[i + 1].rate > spd) ?
290 ((feed_eq_tab[i + 1].rate - spd) >> 1) : 0);
292 (feeder_eq_exact_rate == 0 && rate <= threshold))
293 return (feed_eq_tab[i].coeff);
300 feeder_eq_validrate(uint32_t rate)
303 if (feed_eq_coeff_rate(rate) != NULL)
310 feed_eq_reset(struct feed_eq_info *info)
314 for (i = 0; i < info->channels; i++) {
315 info->treble.i1[i] = 0;
316 info->treble.i2[i] = 0;
317 info->treble.o1[i] = 0;
318 info->treble.o2[i] = 0;
319 info->bass.i1[i] = 0;
320 info->bass.i2[i] = 0;
321 info->bass.o1[i] = 0;
322 info->bass.o2[i] = 0;
327 feed_eq_setup(struct feed_eq_info *info)
330 info->coeff = feed_eq_coeff_rate(info->rate);
331 if (info->coeff == NULL)
340 feed_eq_init(struct pcm_feeder *f)
342 struct feed_eq_info *info;
346 if (f->desc->in != f->desc->out)
351 for (i = 0; i < FEEDEQ_BIQUAD_TAB_SIZE && biquad_op == NULL; i++) {
352 if (AFMT_ENCODING(f->desc->in) == feed_eq_biquad_tab[i].format)
353 biquad_op = feed_eq_biquad_tab[i].biquad;
356 if (biquad_op == NULL)
359 info = malloc(sizeof(*info), M_DEVBUF, M_NOWAIT | M_ZERO);
363 info->channels = AFMT_CHANNEL(f->desc->in);
364 info->align = info->channels * AFMT_BPS(f->desc->in);
366 info->rate = FEEDEQ_RATE_MIN;
367 info->treble.gain = FEEDEQ_L2GAIN(50);
368 info->bass.gain = FEEDEQ_L2GAIN(50);
369 info->preamp = FEEDEQ_PREAMP2IDX(FEEDEQ_PREAMP_DEFAULT);
370 info->state = FEEDEQ_UNKNOWN;
372 info->biquad = biquad_op;
376 return (feed_eq_setup(info));
380 feed_eq_set(struct pcm_feeder *f, int what, int value)
382 struct feed_eq_info *info;
387 case FEEDEQ_CHANNELS:
388 if (value < SND_CHN_MIN || value > SND_CHN_MAX)
390 info->channels = (uint32_t)value;
391 info->align = info->channels * AFMT_BPS(f->desc->in);
395 if (feeder_eq_validrate(value) == 0)
397 info->rate = (uint32_t)value;
398 if (info->state == FEEDEQ_UNKNOWN)
399 info->state = FEEDEQ_ENABLE;
400 return (feed_eq_setup(info));
404 if (value < 0 || value > 100)
406 if (what == FEEDEQ_TREBLE)
407 info->treble.gain = FEEDEQ_L2GAIN(value);
409 info->bass.gain = FEEDEQ_L2GAIN(value);
412 if (value < FEEDEQ_PREAMP_MIN || value > FEEDEQ_PREAMP_MAX)
414 info->preamp = FEEDEQ_PREAMP2IDX(value);
417 if (!(value == FEEDEQ_BYPASS || value == FEEDEQ_ENABLE ||
418 value == FEEDEQ_DISABLE))
432 feed_eq_free(struct pcm_feeder *f)
434 struct feed_eq_info *info;
438 free(info, M_DEVBUF);
446 feed_eq_feed(struct pcm_feeder *f, struct pcm_channel *c, uint8_t *b,
447 uint32_t count, void *source)
449 struct feed_eq_info *info;
457 * FEEDEQ_BYPASS - Bypass entirely, nothing happened.
458 * FEEDEQ_ENABLE - Preamp+biquad filtering.
459 * FEEDEQ_DISABLE - Preamp only.
461 if (info->state == FEEDEQ_BYPASS)
462 return (FEEDER_FEED(f->source, c, b, count, source));
465 count = SND_FXROUND(count, info->align);
468 if (count < info->align)
471 j = SND_FXDIV(FEEDER_FEED(f->source, c, dst, count, source),
476 info->biquad(info, dst, j);
482 } while (count != 0);
487 static struct pcm_feederdesc feeder_eq_desc[] = {
488 { FEEDER_EQ, 0, 0, 0, 0 },
492 static kobj_method_t feeder_eq_methods[] = {
493 KOBJMETHOD(feeder_init, feed_eq_init),
494 KOBJMETHOD(feeder_free, feed_eq_free),
495 KOBJMETHOD(feeder_set, feed_eq_set),
496 KOBJMETHOD(feeder_feed, feed_eq_feed),
500 FEEDER_DECLARE(feeder_eq, NULL);
503 feed_eq_scan_preamp_arg(const char *s)
509 bzero(buf, sizeof(buf));
511 /* XXX kind of ugly, but works for now.. */
513 r = sscanf(s, "%d.%d", &i, &f);
515 if (r == 1 && !(i < FEEDEQ_PREAMP_IMIN || i > FEEDEQ_PREAMP_IMAX)) {
516 snprintf(buf, sizeof(buf), "%c%d",
517 FEEDEQ_PREAMP_SIGNMARK(i), abs(i));
520 !(i < FEEDEQ_PREAMP_IMIN || i > FEEDEQ_PREAMP_IMAX ||
521 f < FEEDEQ_PREAMP_FMIN || f > FEEDEQ_PREAMP_FMAX))
522 snprintf(buf, sizeof(buf), "%c%d.%d",
523 FEEDEQ_PREAMP_SIGNMARK(i), abs(i), f);
525 return (FEEDEQ_PREAMP_INVALID);
528 if (len > 2 && strcasecmp(s + len - 2, "dB") == 0)
529 strlcat(buf, "dB", sizeof(buf));
531 if (i == 0 && *s == '-')
534 if (strcasecmp(buf + ((*s >= '0' && *s <= '9') ? 1 : 0), s) != 0)
535 return (FEEDEQ_PREAMP_INVALID);
537 while ((f / FEEDEQ_GAIN_DIV) > 0)
538 f /= FEEDEQ_GAIN_DIV;
540 return (((i < 0 || *buf == '-') ? -1 : 1) * FEEDEQ_IF2PREAMP(i, f));
545 sysctl_dev_pcm_eq(SYSCTL_HANDLER_ARGS)
547 struct snddev_info *d;
548 struct pcm_channel *c;
549 struct pcm_feeder *f;
553 if (!PCM_REGISTERED(d))
558 if (d->flags & SD_F_EQ_BYPASSED)
560 else if (d->flags & SD_F_EQ_ENABLED)
568 err = sysctl_handle_int(oidp, &val, 0, req);
570 if (err == 0 && req->newptr != NULL && val != oval) {
571 if (!(val == 0 || val == 1 || val == 2)) {
572 PCM_RELEASE_QUICK(d);
578 d->flags &= ~(SD_F_EQ_ENABLED | SD_F_EQ_BYPASSED);
581 d->flags |= SD_F_EQ_BYPASSED;
582 } else if (val == 1) {
584 d->flags |= SD_F_EQ_ENABLED;
586 val = FEEDEQ_DISABLE;
588 CHN_FOREACH(c, d, channels.pcm.busy) {
590 f = chn_findfeeder(c, FEEDER_EQ);
592 (void)FEEDER_SET(f, FEEDEQ_STATE, val);
599 PCM_RELEASE_QUICK(d);
605 sysctl_dev_pcm_eq_preamp(SYSCTL_HANDLER_ARGS)
607 struct snddev_info *d;
608 struct pcm_channel *c;
609 struct pcm_feeder *f;
614 if (!PCM_REGISTERED(d))
620 bzero(buf, sizeof(buf));
621 (void)snprintf(buf, sizeof(buf), "%c%d.%ddB",
622 FEEDEQ_PREAMP_SIGNMARK(val), FEEDEQ_PREAMP_IPART(val),
623 FEEDEQ_PREAMP_FPART(val));
628 err = sysctl_handle_string(oidp, buf, sizeof(buf), req);
630 if (err == 0 && req->newptr != NULL) {
631 val = feed_eq_scan_preamp_arg(buf);
632 if (val == FEEDEQ_PREAMP_INVALID) {
633 PCM_RELEASE_QUICK(d);
640 if (val < FEEDEQ_PREAMP_MIN)
641 val = FEEDEQ_PREAMP_MIN;
642 else if (val > FEEDEQ_PREAMP_MAX)
643 val = FEEDEQ_PREAMP_MAX;
647 CHN_FOREACH(c, d, channels.pcm.busy) {
649 f = chn_findfeeder(c, FEEDER_EQ);
651 (void)FEEDER_SET(f, FEEDEQ_PREAMP, val);
660 PCM_RELEASE_QUICK(d);
666 feeder_eq_initsys(device_t dev)
668 struct snddev_info *d;
672 d = device_get_softc(dev);
674 if (!(resource_string_value(device_get_name(dev), device_get_unit(dev),
675 "eq_preamp", &preamp) == 0 &&
676 (d->eqpreamp = feed_eq_scan_preamp_arg(preamp)) !=
677 FEEDEQ_PREAMP_INVALID))
678 d->eqpreamp = FEEDEQ_PREAMP_DEFAULT;
680 if (d->eqpreamp < FEEDEQ_PREAMP_MIN)
681 d->eqpreamp = FEEDEQ_PREAMP_MIN;
682 else if (d->eqpreamp > FEEDEQ_PREAMP_MAX)
683 d->eqpreamp = FEEDEQ_PREAMP_MAX;
685 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
686 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
687 "eq", CTLTYPE_INT | CTLFLAG_RWTUN, d, sizeof(d),
688 sysctl_dev_pcm_eq, "I",
689 "Bass/Treble Equalizer (0=disable, 1=enable, 2=bypass)");
691 (void)snprintf(buf, sizeof(buf), "Bass/Treble Equalizer Preamp "
692 "(-/+ %d.0dB , %d.%ddB step)",
693 FEEDEQ_GAIN_MAX, FEEDEQ_GAIN_STEP / FEEDEQ_GAIN_DIV,
694 FEEDEQ_GAIN_STEP - ((FEEDEQ_GAIN_STEP / FEEDEQ_GAIN_DIV) *
697 SYSCTL_ADD_PROC(device_get_sysctl_ctx(dev),
698 SYSCTL_CHILDREN(device_get_sysctl_tree(dev)), OID_AUTO,
699 "eq_preamp", CTLTYPE_STRING | CTLFLAG_RWTUN, d, sizeof(d),
700 sysctl_dev_pcm_eq_preamp, "A", buf);