xref: /freebsd/sys/dev/sound/pcm/feeder.h (revision 88eaa1504d12c82a36d83c16e9fd6c41175d2e0a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
5  * Copyright (c) 1999 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 
30 struct pcm_feederdesc {
31 	u_int32_t type;
32 	u_int32_t in, out;
33 	u_int32_t flags;
34 	int idx;
35 };
36 
37 struct feeder_class {
38 	KOBJ_CLASS_FIELDS;
39 	struct pcm_feederdesc *desc;
40 	void *data;
41 };
42 
43 struct pcm_feeder {
44     	KOBJ_FIELDS;
45 	int align;
46 	struct pcm_feederdesc *desc, desc_static;
47 	void *data;
48 	struct feeder_class *class;
49 	struct pcm_feeder *source, *parent;
50 
51 };
52 
53 void feeder_register(void *p);
54 struct feeder_class *feeder_getclass(struct pcm_feederdesc *desc);
55 
56 u_int32_t snd_fmtscore(u_int32_t fmt);
57 u_int32_t snd_fmtbestbit(u_int32_t fmt, u_int32_t *fmts);
58 u_int32_t snd_fmtbestchannel(u_int32_t fmt, u_int32_t *fmts);
59 u_int32_t snd_fmtbest(u_int32_t fmt, u_int32_t *fmts);
60 
61 int feeder_add(struct pcm_channel *c, struct feeder_class *fc,
62     struct pcm_feederdesc *desc);
63 void feeder_remove(struct pcm_channel *c);
64 struct pcm_feeder *feeder_find(struct pcm_channel *c, u_int32_t type);
65 void feeder_printchain(struct pcm_feeder *head);
66 int feeder_chain(struct pcm_channel *);
67 
68 #define FEEDER_DECLARE(feeder, pdata)					\
69 static struct feeder_class feeder ## _class = {				\
70 	.name =		#feeder,					\
71 	.methods =	feeder ## _methods,				\
72 	.size =		sizeof(struct pcm_feeder),			\
73 	.desc =		feeder ## _desc,				\
74 	.data =		pdata,						\
75 };									\
76 SYSINIT(feeder, SI_SUB_DRIVERS, SI_ORDER_ANY, feeder_register,		\
77     &feeder ## _class)
78 
79 enum {
80 	FEEDER_ROOT,
81 	FEEDER_FORMAT,
82 	FEEDER_MIXER,
83 	FEEDER_RATE,
84 	FEEDER_EQ,
85 	FEEDER_VOLUME,
86 	FEEDER_MATRIX,
87 	FEEDER_LAST,
88 };
89 
90 /* feeder_format */
91 enum {
92 	FEEDFORMAT_CHANNELS
93 };
94 
95 /* feeder_mixer */
96 enum {
97 	FEEDMIXER_CHANNELS
98 };
99 
100 /* feeder_rate */
101 enum {
102 	FEEDRATE_SRC,
103 	FEEDRATE_DST,
104 	FEEDRATE_QUALITY,
105 	FEEDRATE_CHANNELS
106 };
107 
108 #define FEEDRATE_RATEMIN	1
109 #define FEEDRATE_RATEMAX	2016000		/* 48000 * 42 */
110 #define FEEDRATE_MIN		1
111 #define FEEDRATE_MAX		0x7fffff	/* sign 24bit ~ 8ghz ! */
112 #define FEEDRATE_ROUNDHZ	25
113 #define FEEDRATE_ROUNDHZ_MIN	0
114 #define FEEDRATE_ROUNDHZ_MAX	500
115 
116 extern int feeder_rate_min;
117 extern int feeder_rate_max;
118 extern int feeder_rate_round;
119 extern int feeder_rate_quality;
120 
121 /* feeder_eq */
122 enum {
123 	FEEDEQ_CHANNELS,
124 	FEEDEQ_RATE,
125 	FEEDEQ_TREBLE,
126 	FEEDEQ_BASS,
127 	FEEDEQ_PREAMP,
128 	FEEDEQ_STATE,
129 	FEEDEQ_DISABLE,
130 	FEEDEQ_ENABLE,
131 	FEEDEQ_BYPASS,
132 	FEEDEQ_UNKNOWN
133 };
134 
135 int feeder_eq_validrate(uint32_t);
136 void feeder_eq_initsys(device_t);
137 
138 /* feeder_volume */
139 enum {
140 	FEEDVOLUME_CLASS,
141 	FEEDVOLUME_CHANNELS,
142 	FEEDVOLUME_STATE,
143 	FEEDVOLUME_ENABLE,
144 	FEEDVOLUME_BYPASS
145 };
146 
147 int feeder_volume_apply_matrix(struct pcm_feeder *, struct pcmchan_matrix *);
148 
149 /* feeder_matrix */
150 int feeder_matrix_default_id(uint32_t);
151 struct pcmchan_matrix *feeder_matrix_default_channel_map(uint32_t);
152 
153 uint32_t feeder_matrix_default_format(uint32_t);
154 
155 int feeder_matrix_format_id(uint32_t);
156 struct pcmchan_matrix *feeder_matrix_format_map(uint32_t);
157 
158 struct pcmchan_matrix *feeder_matrix_id_map(int);
159 
160 int feeder_matrix_setup(struct pcm_feeder *, struct pcmchan_matrix *,
161     struct pcmchan_matrix *);
162 int feeder_matrix_compare(struct pcmchan_matrix *, struct pcmchan_matrix *);
163 
164 /* feeder_format */
165 typedef intpcm_t intpcm_read_t(uint8_t *);
166 typedef void intpcm_write_t(uint8_t *, intpcm_t);
167 
168 intpcm_read_t *feeder_format_read_op(uint32_t);
169 intpcm_write_t *feeder_format_write_op(uint32_t);
170 
171 /* 4Front OSS stuffs */
172 int feeder_matrix_oss_get_channel_order(struct pcmchan_matrix *,
173     unsigned long long *);
174 int feeder_matrix_oss_set_channel_order(struct pcmchan_matrix *,
175     unsigned long long *);
176 
177 /*
178  * By default, various feeders only deal with sign 16/32 bit native-endian
179  * since it should provide the fastest processing path. Processing 8bit samples
180  * is too noisy due to limited dynamic range, while 24bit is quite slow due to
181  * unnatural per-byte read/write. However, for debugging purposes, ensuring
182  * implementation correctness and torture test, the following can be defined:
183  *
184  *      SND_FEEDER_MULTIFORMAT - Compile all type of converters, but force
185  *                               8bit samples to be converted to 16bit
186  *                               native-endian for better dynamic range.
187  *                               Process 24bit samples natively.
188  * SND_FEEDER_FULL_MULTIFORMAT - Ditto, but process 8bit samples natively.
189  */
190 #ifdef SND_FEEDER_FULL_MULTIFORMAT
191 #undef SND_FEEDER_MULTIFORMAT
192 #define SND_FEEDER_MULTIFORMAT	1
193 #endif
194