xref: /freebsd/sys/dev/sound/pcm/vchan.h (revision a466cc55373fc3cf86837f09da729535b57e69a1)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
5  * Copyright (c) 2001 Cameron Grant <cg@FreeBSD.org>
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _SND_VCHAN_H_
33 #define _SND_VCHAN_H_
34 
35 int vchan_create(struct pcm_channel *, int);
36 int vchan_destroy(struct pcm_channel *);
37 
38 #ifdef SND_DEBUG
39 int vchan_passthrough(struct pcm_channel *, const char *);
40 #define vchan_sync(c)		vchan_passthrough(c, __func__)
41 #else
42 int vchan_sync(struct pcm_channel *);
43 #endif
44 
45 #define VCHAN_SYNC_REQUIRED(c)						\
46 	(((c)->flags & CHN_F_VIRTUAL) && (((c)->flags & CHN_F_DIRTY) ||	\
47 	sndbuf_getfmt((c)->bufhard) != (c)->parentchannel->format ||	\
48 	sndbuf_getspd((c)->bufhard) != (c)->parentchannel->speed))
49 
50 void vchan_initsys(device_t);
51 
52 /*
53  * Default format / rate
54  */
55 #define VCHAN_DEFAULT_FORMAT	SND_FORMAT(AFMT_S16_LE, 2, 0)
56 #define VCHAN_DEFAULT_RATE	48000
57 
58 #define VCHAN_PLAY		0
59 #define VCHAN_REC		1
60 
61 /*
62  * Offset by +/- 1 so we can distinguish bogus pointer.
63  */
64 #define VCHAN_SYSCTL_DATA(x, y)						\
65 		((void *)((intptr_t)(((((x) + 1) & 0xfff) << 2) |	\
66 		(((VCHAN_##y) + 1) & 0x3))))
67 
68 #define VCHAN_SYSCTL_DATA_SIZE	sizeof(void *)
69 #define VCHAN_SYSCTL_UNIT(x)	((int)(((intptr_t)(x) >> 2) & 0xfff) - 1)
70 #define VCHAN_SYSCTL_DIR(x)	((int)((intptr_t)(x) & 0x3) - 1)
71 
72 #endif	/* _SND_VCHAN_H_ */
73