blob: c704357775fc4ef077ef52fb27cfb97c75b378ee [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_PCM_PARAMS_H
2#define __SOUND_PCM_PARAMS_H
3
4/*
5 * PCM params helpers
6 * Copyright (c) by Abramo Bagnara <abramo@alsa-project.org>
7 *
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 *
23 */
24
Mark Brownf3761c32012-06-19 19:31:48 +010025#include <sound/pcm.h>
26
Takashi Iwaie88e8ae62006-04-28 15:13:40 +020027int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm,
28 struct snd_pcm_hw_params *params,
29 snd_pcm_hw_param_t var, int *dir);
30int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm,
31 struct snd_pcm_hw_params *params,
32 snd_pcm_hw_param_t var, int *dir);
33int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
34 snd_pcm_hw_param_t var, int *dir);
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#define SNDRV_MASK_BITS 64 /* we use so far 64bits only */
37#define SNDRV_MASK_SIZE (SNDRV_MASK_BITS / 32)
38#define MASK_OFS(i) ((i) >> 5)
39#define MASK_BIT(i) (1U << ((i) & 31))
40
Takashi Iwai9bb22e22006-04-28 15:13:39 +020041static inline size_t snd_mask_sizeof(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042{
Takashi Iwai877211f2005-11-17 13:59:38 +010043 return sizeof(struct snd_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044}
45
Takashi Iwai9bb22e22006-04-28 15:13:39 +020046static inline void snd_mask_none(struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047{
48 memset(mask, 0, sizeof(*mask));
49}
50
Takashi Iwai9bb22e22006-04-28 15:13:39 +020051static inline void snd_mask_any(struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -070052{
53 memset(mask, 0xff, SNDRV_MASK_SIZE * sizeof(u_int32_t));
54}
55
Takashi Iwai9bb22e22006-04-28 15:13:39 +020056static inline int snd_mask_empty(const struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -070057{
58 int i;
59 for (i = 0; i < SNDRV_MASK_SIZE; i++)
60 if (mask->bits[i])
61 return 0;
62 return 1;
63}
64
Takashi Iwai9bb22e22006-04-28 15:13:39 +020065static inline unsigned int snd_mask_min(const struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066{
67 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 for (i = 0; i < SNDRV_MASK_SIZE; i++) {
69 if (mask->bits[i])
Lars-Peter Clausen599ee322014-12-29 19:41:44 +010070 return __ffs(mask->bits[i]) + (i << 5);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 }
72 return 0;
73}
74
Takashi Iwai9bb22e22006-04-28 15:13:39 +020075static inline unsigned int snd_mask_max(const struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076{
77 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 for (i = SNDRV_MASK_SIZE - 1; i >= 0; i--) {
79 if (mask->bits[i])
Lars-Peter Clausen757b0372014-12-29 19:41:46 +010080 return __fls(mask->bits[i]) + (i << 5);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 }
82 return 0;
83}
84
Takashi Iwai9bb22e22006-04-28 15:13:39 +020085static inline void snd_mask_set(struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 mask->bits[MASK_OFS(val)] |= MASK_BIT(val);
88}
89
Takashi Iwai9bb22e22006-04-28 15:13:39 +020090static inline void snd_mask_reset(struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 mask->bits[MASK_OFS(val)] &= ~MASK_BIT(val);
93}
94
Takashi Iwai9bb22e22006-04-28 15:13:39 +020095static inline void snd_mask_set_range(struct snd_mask *mask,
96 unsigned int from, unsigned int to)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097{
98 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 for (i = from; i <= to; i++)
100 mask->bits[MASK_OFS(i)] |= MASK_BIT(i);
101}
102
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200103static inline void snd_mask_reset_range(struct snd_mask *mask,
104 unsigned int from, unsigned int to)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 for (i = from; i <= to; i++)
108 mask->bits[MASK_OFS(i)] &= ~MASK_BIT(i);
109}
110
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200111static inline void snd_mask_leave(struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112{
113 unsigned int v;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 v = mask->bits[MASK_OFS(val)] & MASK_BIT(val);
115 snd_mask_none(mask);
116 mask->bits[MASK_OFS(val)] = v;
117}
118
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200119static inline void snd_mask_intersect(struct snd_mask *mask,
120 const struct snd_mask *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121{
122 int i;
123 for (i = 0; i < SNDRV_MASK_SIZE; i++)
124 mask->bits[i] &= v->bits[i];
125}
126
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200127static inline int snd_mask_eq(const struct snd_mask *mask,
128 const struct snd_mask *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
130 return ! memcmp(mask, v, SNDRV_MASK_SIZE * sizeof(u_int32_t));
131}
132
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200133static inline void snd_mask_copy(struct snd_mask *mask,
134 const struct snd_mask *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135{
136 *mask = *v;
137}
138
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200139static inline int snd_mask_test(const struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 return mask->bits[MASK_OFS(val)] & MASK_BIT(val);
142}
143
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200144static inline int snd_mask_single(const struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145{
146 int i, c = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 for (i = 0; i < SNDRV_MASK_SIZE; i++) {
148 if (! mask->bits[i])
149 continue;
150 if (mask->bits[i] & (mask->bits[i] - 1))
151 return 0;
152 if (c)
153 return 0;
154 c++;
155 }
156 return 1;
157}
158
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200159static inline int snd_mask_refine(struct snd_mask *mask,
160 const struct snd_mask *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
Takashi Iwai877211f2005-11-17 13:59:38 +0100162 struct snd_mask old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 snd_mask_copy(&old, mask);
164 snd_mask_intersect(mask, v);
165 if (snd_mask_empty(mask))
166 return -EINVAL;
167 return !snd_mask_eq(mask, &old);
168}
169
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200170static inline int snd_mask_refine_first(struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 if (snd_mask_single(mask))
173 return 0;
174 snd_mask_leave(mask, snd_mask_min(mask));
175 return 1;
176}
177
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200178static inline int snd_mask_refine_last(struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 if (snd_mask_single(mask))
181 return 0;
182 snd_mask_leave(mask, snd_mask_max(mask));
183 return 1;
184}
185
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200186static inline int snd_mask_refine_min(struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 if (snd_mask_min(mask) >= val)
189 return 0;
190 snd_mask_reset_range(mask, 0, val - 1);
191 if (snd_mask_empty(mask))
192 return -EINVAL;
193 return 1;
194}
195
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200196static inline int snd_mask_refine_max(struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 if (snd_mask_max(mask) <= val)
199 return 0;
200 snd_mask_reset_range(mask, val + 1, SNDRV_MASK_BITS);
201 if (snd_mask_empty(mask))
202 return -EINVAL;
203 return 1;
204}
205
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200206static inline int snd_mask_refine_set(struct snd_mask *mask, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207{
208 int changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 changed = !snd_mask_single(mask);
210 snd_mask_leave(mask, val);
211 if (snd_mask_empty(mask))
212 return -EINVAL;
213 return changed;
214}
215
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200216static inline int snd_mask_value(const struct snd_mask *mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 return snd_mask_min(mask);
219}
220
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200221static inline void snd_interval_any(struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222{
223 i->min = 0;
224 i->openmin = 0;
225 i->max = UINT_MAX;
226 i->openmax = 0;
227 i->integer = 0;
228 i->empty = 0;
229}
230
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200231static inline void snd_interval_none(struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
233 i->empty = 1;
234}
235
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200236static inline int snd_interval_checkempty(const struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
238 return (i->min > i->max ||
239 (i->min == i->max && (i->openmin || i->openmax)));
240}
241
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200242static inline int snd_interval_empty(const struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 return i->empty;
245}
246
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200247static inline int snd_interval_single(const struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 return (i->min == i->max ||
250 (i->min + 1 == i->max && i->openmax));
251}
252
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200253static inline int snd_interval_value(const struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 return i->min;
256}
257
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200258static inline int snd_interval_min(const struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 return i->min;
261}
262
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200263static inline int snd_interval_max(const struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
265 unsigned int v;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 v = i->max;
267 if (i->openmax)
268 v--;
269 return v;
270}
271
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200272static inline int snd_interval_test(const struct snd_interval *i, unsigned int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
274 return !((i->min > val || (i->min == val && i->openmin) ||
275 i->max < val || (i->max == val && i->openmax)));
276}
277
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200278static inline void snd_interval_copy(struct snd_interval *d, const struct snd_interval *s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279{
280 *d = *s;
281}
282
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200283static inline int snd_interval_setinteger(struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 if (i->integer)
286 return 0;
287 if (i->openmin && i->openmax && i->min == i->max)
288 return -EINVAL;
289 i->integer = 1;
290 return 1;
291}
292
Takashi Iwai9bb22e22006-04-28 15:13:39 +0200293static inline int snd_interval_eq(const struct snd_interval *i1, const struct snd_interval *i2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294{
295 if (i1->empty)
296 return i2->empty;
297 if (i2->empty)
298 return i1->empty;
299 return i1->min == i2->min && i1->openmin == i2->openmin &&
300 i1->max == i2->max && i1->openmax == i2->openmax;
301}
302
Lars-Peter Clausen89827ca2014-12-29 19:41:42 +0100303/**
304 * params_access - get the access type from the hw params
305 * @p: hw params
306 */
Lars-Peter Clausen744c2ad2014-12-29 19:41:41 +0100307static inline snd_pcm_access_t params_access(const struct snd_pcm_hw_params *p)
308{
309 return (__force snd_pcm_access_t)snd_mask_min(hw_param_mask_c(p,
310 SNDRV_PCM_HW_PARAM_ACCESS));
311}
312
Lars-Peter Clausen89827ca2014-12-29 19:41:42 +0100313/**
314 * params_format - get the sample format from the hw params
315 * @p: hw params
316 */
Lars-Peter Clausen744c2ad2014-12-29 19:41:41 +0100317static inline snd_pcm_format_t params_format(const struct snd_pcm_hw_params *p)
318{
319 return (__force snd_pcm_format_t)snd_mask_min(hw_param_mask_c(p,
320 SNDRV_PCM_HW_PARAM_FORMAT));
321}
322
Lars-Peter Clausen89827ca2014-12-29 19:41:42 +0100323/**
324 * params_subformat - get the sample subformat from the hw params
325 * @p: hw params
326 */
Lars-Peter Clausen744c2ad2014-12-29 19:41:41 +0100327static inline snd_pcm_subformat_t
328params_subformat(const struct snd_pcm_hw_params *p)
329{
330 return (__force snd_pcm_subformat_t)snd_mask_min(hw_param_mask_c(p,
331 SNDRV_PCM_HW_PARAM_SUBFORMAT));
332}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Lars-Peter Clausen89827ca2014-12-29 19:41:42 +0100334/**
335 * params_period_bytes - get the period size (in bytes) from the hw params
336 * @p: hw params
337 */
Takashi Iwaib51beb72011-07-26 12:02:56 +0200338static inline unsigned int
339params_period_bytes(const struct snd_pcm_hw_params *p)
340{
Lars-Peter Clausencd9978f2014-12-29 19:41:43 +0100341 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_BYTES)->min;
Takashi Iwaib51beb72011-07-26 12:02:56 +0200342}
343
Lars-Peter Clausen89827ca2014-12-29 19:41:42 +0100344/**
345 * params_width - get the number of bits of the sample format from the hw params
346 * @p: hw params
347 *
348 * This function returns the number of bits per sample that the selected sample
349 * format of the hw params has.
350 */
351static inline int params_width(const struct snd_pcm_hw_params *p)
Mark Brown8c5178f2013-12-24 12:24:28 +0000352{
353 return snd_pcm_format_width(params_format(p));
354}
355
Lars-Peter Clausen89827ca2014-12-29 19:41:42 +0100356/*
357 * params_physical_width - get the storage size of the sample format from the hw params
358 * @p: hw params
359 *
360 * This functions returns the number of bits per sample that the selected sample
361 * format of the hw params takes up in memory. This will be equal or larger than
362 * params_width().
363 */
364static inline int params_physical_width(const struct snd_pcm_hw_params *p)
Mark Brown8c5178f2013-12-24 12:24:28 +0000365{
366 return snd_pcm_format_physical_width(params_format(p));
367}
368
Fang, Yang A052a9f62015-02-09 00:18:11 -0800369static inline void
370params_set_format(struct snd_pcm_hw_params *p, snd_pcm_format_t fmt)
371{
372 snd_mask_set(hw_param_mask(p, SNDRV_PCM_HW_PARAM_FORMAT),
373 (__force int)fmt);
374}
375
Takashi Iwaib51beb72011-07-26 12:02:56 +0200376#endif /* __SOUND_PCM_PARAMS_H */