2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
5 * Portions Copyright (c) Ryan Beasley <ryan.beasley@gmail.com> - GSoC 2006
6 * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #ifdef HAVE_KERNEL_OPTION_HEADERS
35 #include <dev/sound/pcm/sound.h>
37 #include "feeder_if.h"
40 #define SND_DECLARE_FXDIV
41 #include "snd_fxdiv_gen.h"
43 SND_DECLARE_FILE("$FreeBSD$");
46 sndbuf_create(device_t dev, char *drv, char *desc, struct pcm_channel *channel)
50 b = malloc(sizeof(*b), M_DEVBUF, M_WAITOK | M_ZERO);
51 snprintf(b->name, SNDBUF_NAMELEN, "%s:%s", drv, desc);
59 sndbuf_destroy(struct snd_dbuf *b)
66 sndbuf_getbufaddr(struct snd_dbuf *buf)
68 return (buf->buf_addr);
72 sndbuf_setmap(void *arg, bus_dma_segment_t *segs, int nseg, int error)
74 struct snd_dbuf *b = (struct snd_dbuf *)arg;
76 if (snd_verbose > 3) {
77 device_printf(b->dev, "sndbuf_setmap %lx, %lx; ",
78 (u_long)segs[0].ds_addr, (u_long)segs[0].ds_len);
79 printf("%p -> %lx\n", b->buf, (u_long)segs[0].ds_addr);
82 b->buf_addr = segs[0].ds_addr;
88 * Allocate memory for DMA buffer. If the device does not use DMA transfers,
89 * the driver can call malloc(9) and sndbuf_setup() itself.
93 sndbuf_alloc(struct snd_dbuf *b, bus_dma_tag_t dmatag, int dmaflags,
99 b->dmaflags = dmaflags | BUS_DMA_NOWAIT | BUS_DMA_COHERENT;
101 b->bufsize = b->maxsize;
103 b->flags |= SNDBUF_F_MANAGED;
104 if (bus_dmamem_alloc(b->dmatag, (void **)&b->buf, b->dmaflags,
109 if (bus_dmamap_load(b->dmatag, b->dmamap, b->buf, b->maxsize,
110 sndbuf_setmap, b, 0) != 0 || b->buf_addr == 0) {
115 ret = sndbuf_resize(b, 2, b->maxsize / 2);
123 sndbuf_setup(struct snd_dbuf *b, void *buf, unsigned int size)
125 b->flags &= ~SNDBUF_F_MANAGED;
127 b->flags |= SNDBUF_F_MANAGED;
130 b->bufsize = b->maxsize;
131 return sndbuf_resize(b, 2, b->maxsize / 2);
135 sndbuf_free(struct snd_dbuf *b)
138 free(b->tmpbuf, M_DEVBUF);
141 free(b->shadbuf, M_DEVBUF);
144 if (b->flags & SNDBUF_F_MANAGED) {
146 bus_dmamap_unload(b->dmatag, b->dmamap);
148 bus_dmamem_free(b->dmatag, b->buf, b->dmamap);
150 free(b->buf, M_DEVBUF);
161 #define SNDBUF_CACHE_SHIFT 5
164 sndbuf_resize(struct snd_dbuf *b, unsigned int blkcnt, unsigned int blksz)
166 unsigned int bufsize, allocsize;
169 CHN_LOCK(b->channel);
176 if (blkcnt < 2 || blksz < 16 || (blkcnt * blksz) > b->maxsize) {
177 CHN_UNLOCK(b->channel);
180 if (blkcnt == b->blkcnt && blksz == b->blksz)
183 bufsize = blkcnt * blksz;
185 if (bufsize > b->allocsize ||
186 bufsize < (b->allocsize >> SNDBUF_CACHE_SHIFT)) {
187 allocsize = round_page(bufsize);
188 CHN_UNLOCK(b->channel);
189 tmpbuf = malloc(allocsize, M_DEVBUF, M_WAITOK);
190 CHN_LOCK(b->channel);
192 printf("%s(): b=%p %p -> %p [%d -> %d : %d]\n",
193 __func__, b, b->tmpbuf, tmpbuf,
194 b->allocsize, allocsize, bufsize);
195 if (b->tmpbuf != NULL)
196 free(b->tmpbuf, M_DEVBUF);
198 b->allocsize = allocsize;
199 } else if (snd_verbose > 3)
200 printf("%s(): b=%p %d [%d] NOCHANGE\n",
201 __func__, b, b->allocsize, b->bufsize);
205 b->bufsize = bufsize;
209 CHN_UNLOCK(b->channel);
214 sndbuf_remalloc(struct snd_dbuf *b, unsigned int blkcnt, unsigned int blksz)
216 unsigned int bufsize, allocsize;
217 u_int8_t *buf, *tmpbuf, *shadbuf;
219 if (blkcnt < 2 || blksz < 16)
222 bufsize = blksz * blkcnt;
224 if (bufsize > b->allocsize ||
225 bufsize < (b->allocsize >> SNDBUF_CACHE_SHIFT)) {
226 allocsize = round_page(bufsize);
227 CHN_UNLOCK(b->channel);
228 buf = malloc(allocsize, M_DEVBUF, M_WAITOK);
229 tmpbuf = malloc(allocsize, M_DEVBUF, M_WAITOK);
230 shadbuf = malloc(allocsize, M_DEVBUF, M_WAITOK);
231 CHN_LOCK(b->channel);
233 free(b->buf, M_DEVBUF);
235 if (b->tmpbuf != NULL)
236 free(b->tmpbuf, M_DEVBUF);
238 if (b->shadbuf != NULL)
239 free(b->shadbuf, M_DEVBUF);
240 b->shadbuf = shadbuf;
242 printf("%s(): b=%p %d -> %d [%d]\n",
243 __func__, b, b->allocsize, allocsize, bufsize);
244 b->allocsize = allocsize;
245 } else if (snd_verbose > 3)
246 printf("%s(): b=%p %d [%d] NOCHANGE\n",
247 __func__, b, b->allocsize, b->bufsize);
251 b->bufsize = bufsize;
252 b->maxsize = bufsize;
261 * @brief Zero out space in buffer free area
263 * This function clears a chunk of @c length bytes in the buffer free area
264 * (i.e., where the next write will be placed).
266 * @param b buffer context
267 * @param length number of bytes to blank
270 sndbuf_clear(struct snd_dbuf *b, unsigned int length)
277 if (length > b->bufsize)
280 data = sndbuf_zerodata(b->fmt);
282 i = sndbuf_getfreeptr(b);
283 p = sndbuf_getbuf(b);
294 * @brief Zap buffer contents, resetting "ready area" fields
296 * @param b buffer context
299 sndbuf_fillsilence(struct snd_dbuf *b)
302 memset(sndbuf_getbuf(b), sndbuf_zerodata(b->fmt), b->bufsize);
308 sndbuf_fillsilence_rl(struct snd_dbuf *b, u_int rl)
311 memset(sndbuf_getbuf(b), sndbuf_zerodata(b->fmt), b->bufsize);
313 b->rl = min(b->bufsize, rl);
317 * @brief Reset buffer w/o flushing statistics
319 * This function just zeroes out buffer contents and sets the "ready length"
320 * to zero. This was originally to facilitate minimal playback interruption
321 * (i.e., dropped samples) in SNDCTL_DSP_SILENCE/SKIP ioctls.
323 * @param b buffer context
326 sndbuf_softreset(struct snd_dbuf *b)
329 if (b->buf && b->bufsize > 0)
330 sndbuf_clear(b, b->bufsize);
334 sndbuf_reset(struct snd_dbuf *b)
343 if (b->buf && b->bufsize > 0)
344 sndbuf_clear(b, b->bufsize);
345 sndbuf_clearshadow(b);
349 sndbuf_getfmt(struct snd_dbuf *b)
355 sndbuf_setfmt(struct snd_dbuf *b, u_int32_t fmt)
358 b->bps = AFMT_BPS(b->fmt);
359 b->align = AFMT_ALIGN(b->fmt);
361 b->bps = AFMT_CHANNEL(b->fmt);
362 if (b->fmt & AFMT_16BIT)
364 else if (b->fmt & AFMT_24BIT)
366 else if (b->fmt & AFMT_32BIT)
373 sndbuf_getspd(struct snd_dbuf *b)
379 sndbuf_setspd(struct snd_dbuf *b, unsigned int spd)
385 sndbuf_getalign(struct snd_dbuf *b)
391 sndbuf_getblkcnt(struct snd_dbuf *b)
397 sndbuf_setblkcnt(struct snd_dbuf *b, unsigned int blkcnt)
403 sndbuf_getblksz(struct snd_dbuf *b)
409 sndbuf_setblksz(struct snd_dbuf *b, unsigned int blksz)
415 sndbuf_getbps(struct snd_dbuf *b)
421 sndbuf_getbuf(struct snd_dbuf *b)
427 sndbuf_getbufofs(struct snd_dbuf *b, unsigned int ofs)
429 KASSERT(ofs < b->bufsize, ("%s: ofs invalid %d", __func__, ofs));
435 sndbuf_getsize(struct snd_dbuf *b)
441 sndbuf_getmaxsize(struct snd_dbuf *b)
447 sndbuf_getallocsize(struct snd_dbuf *b)
453 sndbuf_runsz(struct snd_dbuf *b)
459 sndbuf_setrun(struct snd_dbuf *b, int go)
461 b->dl = go? b->blksz : 0;
465 sndbuf_getsel(struct snd_dbuf *b)
470 /************************************************************/
472 sndbuf_getxrun(struct snd_dbuf *b)
474 SNDBUF_LOCKASSERT(b);
480 sndbuf_setxrun(struct snd_dbuf *b, unsigned int xrun)
482 SNDBUF_LOCKASSERT(b);
488 sndbuf_gethwptr(struct snd_dbuf *b)
490 SNDBUF_LOCKASSERT(b);
496 sndbuf_sethwptr(struct snd_dbuf *b, unsigned int ptr)
498 SNDBUF_LOCKASSERT(b);
504 sndbuf_getready(struct snd_dbuf *b)
506 SNDBUF_LOCKASSERT(b);
507 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d", __func__, b->rl));
513 sndbuf_getreadyptr(struct snd_dbuf *b)
515 SNDBUF_LOCKASSERT(b);
516 KASSERT((b->rp >= 0) && (b->rp <= b->bufsize), ("%s: b->rp invalid %d", __func__, b->rp));
522 sndbuf_getfree(struct snd_dbuf *b)
524 SNDBUF_LOCKASSERT(b);
525 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d", __func__, b->rl));
527 return b->bufsize - b->rl;
531 sndbuf_getfreeptr(struct snd_dbuf *b)
533 SNDBUF_LOCKASSERT(b);
534 KASSERT((b->rp >= 0) && (b->rp <= b->bufsize), ("%s: b->rp invalid %d", __func__, b->rp));
535 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d", __func__, b->rl));
537 return (b->rp + b->rl) % b->bufsize;
541 sndbuf_getblocks(struct snd_dbuf *b)
543 SNDBUF_LOCKASSERT(b);
545 return b->total / b->blksz;
549 sndbuf_getprevblocks(struct snd_dbuf *b)
551 SNDBUF_LOCKASSERT(b);
553 return b->prev_total / b->blksz;
557 sndbuf_gettotal(struct snd_dbuf *b)
559 SNDBUF_LOCKASSERT(b);
565 sndbuf_getprevtotal(struct snd_dbuf *b)
567 SNDBUF_LOCKASSERT(b);
569 return b->prev_total;
573 sndbuf_updateprevtotal(struct snd_dbuf *b)
575 SNDBUF_LOCKASSERT(b);
577 b->prev_total = b->total;
581 sndbuf_xbytes(unsigned int v, struct snd_dbuf *from, struct snd_dbuf *to)
583 if (from == NULL || to == NULL || v == 0)
586 return snd_xbytes(v, sndbuf_getalign(from) * sndbuf_getspd(from),
587 sndbuf_getalign(to) * sndbuf_getspd(to));
591 sndbuf_zerodata(u_int32_t fmt)
593 if (fmt & (AFMT_SIGNED | AFMT_PASSTHROUGH))
595 else if (fmt & AFMT_MU_LAW)
597 else if (fmt & AFMT_A_LAW)
602 /************************************************************/
605 * @brief Acquire buffer space to extend ready area
607 * This function extends the ready area length by @c count bytes, and may
608 * optionally copy samples from another location stored in @c from. The
609 * counter @c snd_dbuf::total is also incremented by @c count bytes.
611 * @param b audio buffer
612 * @param from sample source (optional)
613 * @param count number of bytes to acquire
615 * @retval 0 Unconditional
618 sndbuf_acquire(struct snd_dbuf *b, u_int8_t *from, unsigned int count)
622 KASSERT(count <= sndbuf_getfree(b), ("%s: count %d > free %d", __func__, count, sndbuf_getfree(b)));
623 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d", __func__, b->rl));
627 l = min(count, sndbuf_getsize(b) - sndbuf_getfreeptr(b));
628 bcopy(from, sndbuf_getbufofs(b, sndbuf_getfreeptr(b)), l);
635 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d, count %d", __func__, b->rl, count));
641 * @brief Dispose samples from channel buffer, increasing size of ready area
643 * This function discards samples from the supplied buffer by advancing the
644 * ready area start pointer and decrementing the ready area length. If
645 * @c to is not NULL, then the discard samples will be copied to the location
648 * @param b PCM channel sound buffer
649 * @param to destination buffer (optional)
650 * @param count number of bytes to discard
652 * @returns 0 unconditionally
655 sndbuf_dispose(struct snd_dbuf *b, u_int8_t *to, unsigned int count)
659 KASSERT(count <= sndbuf_getready(b), ("%s: count %d > ready %d", __func__, count, sndbuf_getready(b)));
660 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d", __func__, b->rl));
663 l = min(count, sndbuf_getsize(b) - sndbuf_getreadyptr(b));
664 bcopy(sndbuf_getbufofs(b, sndbuf_getreadyptr(b)), to, l);
667 b->rp = (b->rp + l) % b->bufsize;
672 b->rp = (b->rp + count) % b->bufsize;
674 KASSERT((b->rl >= 0) && (b->rl <= b->bufsize), ("%s: b->rl invalid %d, count %d", __func__, b->rl, count));
679 #ifdef SND_DIAGNOSTIC
680 static uint32_t snd_feeder_maxfeed = 0;
681 SYSCTL_UINT(_hw_snd, OID_AUTO, feeder_maxfeed, CTLFLAG_RD,
682 &snd_feeder_maxfeed, 0, "maximum feeder count request");
684 static uint32_t snd_feeder_maxcycle = 0;
685 SYSCTL_UINT(_hw_snd, OID_AUTO, feeder_maxcycle, CTLFLAG_RD,
686 &snd_feeder_maxcycle, 0, "maximum feeder cycle");
689 /* count is number of bytes we want added to destination buffer */
691 sndbuf_feed(struct snd_dbuf *from, struct snd_dbuf *to, struct pcm_channel *channel, struct pcm_feeder *feeder, unsigned int count)
693 unsigned int cnt, maxfeed;
694 #ifdef SND_DIAGNOSTIC
697 if (count > snd_feeder_maxfeed)
698 snd_feeder_maxfeed = count;
703 KASSERT(count > 0, ("can't feed 0 bytes"));
705 if (sndbuf_getfree(to) < count)
708 maxfeed = SND_FXROUND(SND_FXDIV_MAX, sndbuf_getalign(to));
711 cnt = FEEDER_FEED(feeder, channel, to->tmpbuf,
712 min(count, maxfeed), from);
715 sndbuf_acquire(to, to->tmpbuf, cnt);
717 #ifdef SND_DIAGNOSTIC
720 } while (count != 0);
722 #ifdef SND_DIAGNOSTIC
723 if (cycle > snd_feeder_maxcycle)
724 snd_feeder_maxcycle = cycle;
730 /************************************************************/
733 sndbuf_dump(struct snd_dbuf *b, char *s, u_int32_t what)
737 printf(" bufsize: %d, maxsize: %d", b->bufsize, b->maxsize);
739 printf(" dl: %d, rp: %d, rl: %d, hp: %d", b->dl, b->rp, b->rl, b->hp);
741 printf(" total: %ju, prev_total: %ju, xrun: %d", (uintmax_t)b->total, (uintmax_t)b->prev_total, b->xrun);
743 printf(" fmt: 0x%x, spd: %d", b->fmt, b->spd);
745 printf(" blksz: %d, blkcnt: %d, flags: 0x%x", b->blksz, b->blkcnt, b->flags);
749 /************************************************************/
751 sndbuf_getflags(struct snd_dbuf *b)
757 sndbuf_setflags(struct snd_dbuf *b, u_int32_t flags, int on)
765 * @brief Clear the shadow buffer by filling with samples equal to zero.
767 * @param b buffer to clear
770 sndbuf_clearshadow(struct snd_dbuf *b)
772 KASSERT(b != NULL, ("b is a null pointer"));
773 KASSERT(b->sl >= 0, ("illegal shadow length"));
775 if ((b->shadbuf != NULL) && (b->sl > 0))
776 memset(b->shadbuf, sndbuf_zerodata(b->fmt), b->sl);
779 #ifdef OSSV4_EXPERIMENT
781 * @brief Return peak value from samples in buffer ready area.
783 * Peak ranges from 0-32767. If channel is monaural, most significant 16
784 * bits will be zero. For now, only expects to work with 1-2 channel
787 * @note Currently only operates with linear PCM formats.
789 * @param b buffer to analyze
790 * @param lpeak pointer to store left peak value
791 * @param rpeak pointer to store right peak value
794 sndbuf_getpeaks(struct snd_dbuf *b, int *lp, int *rp)
796 u_int32_t lpeak, rpeak;
802 * @todo fill this in later