[deliverable/linux.git] / include / sound / pcm_params.h

#ifndef __SOUND_PCM_PARAMS_H
#define __SOUND_PCM_PARAMS_H

/*
 *  PCM params helpers
 *  Copyright (c) by Abramo Bagnara <abramo@alsa-project.org>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include <sound/pcm.h>

int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm, 
			   struct snd_pcm_hw_params *params,
			   snd_pcm_hw_param_t var, int *dir);
int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm, 
			  struct snd_pcm_hw_params *params,
			  snd_pcm_hw_param_t var, int *dir);
int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
			   snd_pcm_hw_param_t var, int *dir);

#define SNDRV_MASK_BITS	64	/* we use so far 64bits only */
#define SNDRV_MASK_SIZE	(SNDRV_MASK_BITS / 32)
#define MASK_OFS(i)	((i) >> 5)
#define MASK_BIT(i)	(1U << ((i) & 31))

static inline size_t snd_mask_sizeof(void)
{
	return sizeof(struct snd_mask);
}

static inline void snd_mask_none(struct snd_mask *mask)
{
	memset(mask, 0, sizeof(*mask));
}

static inline void snd_mask_any(struct snd_mask *mask)
{
	memset(mask, 0xff, SNDRV_MASK_SIZE * sizeof(u_int32_t));
}

static inline int snd_mask_empty(const struct snd_mask *mask)
{
	int i;
	for (i = 0; i < SNDRV_MASK_SIZE; i++)
		if (mask->bits[i])
			return 0;
	return 1;
}

static inline unsigned int snd_mask_min(const struct snd_mask *mask)
{
	int i;
	for (i = 0; i < SNDRV_MASK_SIZE; i++) {
		if (mask->bits[i])
			return __ffs(mask->bits[i]) + (i << 5);
	}
	return 0;
}

static inline unsigned int snd_mask_max(const struct snd_mask *mask)
{
	int i;
	for (i = SNDRV_MASK_SIZE - 1; i >= 0; i--) {
		if (mask->bits[i])
			return __fls(mask->bits[i]) + (i << 5);
	}
	return 0;
}

static inline void snd_mask_set(struct snd_mask *mask, unsigned int val)
{
	mask->bits[MASK_OFS(val)] |= MASK_BIT(val);
}

static inline void snd_mask_reset(struct snd_mask *mask, unsigned int val)
{
	mask->bits[MASK_OFS(val)] &= ~MASK_BIT(val);
}

static inline void snd_mask_set_range(struct snd_mask *mask,
				      unsigned int from, unsigned int to)
{
	unsigned int i;
	for (i = from; i <= to; i++)
		mask->bits[MASK_OFS(i)] |= MASK_BIT(i);
}

static inline void snd_mask_reset_range(struct snd_mask *mask,
					unsigned int from, unsigned int to)
{
	unsigned int i;
	for (i = from; i <= to; i++)
		mask->bits[MASK_OFS(i)] &= ~MASK_BIT(i);
}

static inline void snd_mask_leave(struct snd_mask *mask, unsigned int val)
{
	unsigned int v;
	v = mask->bits[MASK_OFS(val)] & MASK_BIT(val);
	snd_mask_none(mask);
	mask->bits[MASK_OFS(val)] = v;
}

static inline void snd_mask_intersect(struct snd_mask *mask,
				      const struct snd_mask *v)
{
	int i;
	for (i = 0; i < SNDRV_MASK_SIZE; i++)
		mask->bits[i] &= v->bits[i];
}

static inline int snd_mask_eq(const struct snd_mask *mask,
			      const struct snd_mask *v)
{
	return ! memcmp(mask, v, SNDRV_MASK_SIZE * sizeof(u_int32_t));
}

static inline void snd_mask_copy(struct snd_mask *mask,
				 const struct snd_mask *v)
{
	*mask = *v;
}

static inline int snd_mask_test(const struct snd_mask *mask, unsigned int val)
{
	return mask->bits[MASK_OFS(val)] & MASK_BIT(val);
}

static inline int snd_mask_single(const struct snd_mask *mask)
{
	int i, c = 0;
	for (i = 0; i < SNDRV_MASK_SIZE; i++) {
		if (! mask->bits[i])
			continue;
		if (mask->bits[i] & (mask->bits[i] - 1))
			return 0;
		if (c)
			return 0;
		c++;
	}
	return 1;
}

static inline int snd_mask_refine(struct snd_mask *mask,
				  const struct snd_mask *v)
{
	struct snd_mask old;
	snd_mask_copy(&old, mask);
	snd_mask_intersect(mask, v);
	if (snd_mask_empty(mask))
		return -EINVAL;
	return !snd_mask_eq(mask, &old);
}

static inline int snd_mask_refine_first(struct snd_mask *mask)
{
	if (snd_mask_single(mask))
		return 0;
	snd_mask_leave(mask, snd_mask_min(mask));
	return 1;
}

static inline int snd_mask_refine_last(struct snd_mask *mask)
{
	if (snd_mask_single(mask))
		return 0;
	snd_mask_leave(mask, snd_mask_max(mask));
	return 1;
}

static inline int snd_mask_refine_min(struct snd_mask *mask, unsigned int val)
{
	if (snd_mask_min(mask) >= val)
		return 0;
	snd_mask_reset_range(mask, 0, val - 1);
	if (snd_mask_empty(mask))
		return -EINVAL;
	return 1;
}

static inline int snd_mask_refine_max(struct snd_mask *mask, unsigned int val)
{
	if (snd_mask_max(mask) <= val)
		return 0;
	snd_mask_reset_range(mask, val + 1, SNDRV_MASK_BITS);
	if (snd_mask_empty(mask))
		return -EINVAL;
	return 1;
}

static inline int snd_mask_refine_set(struct snd_mask *mask, unsigned int val)
{
	int changed;
	changed = !snd_mask_single(mask);
	snd_mask_leave(mask, val);
	if (snd_mask_empty(mask))
		return -EINVAL;
	return changed;
}

static inline int snd_mask_value(const struct snd_mask *mask)
{
	return snd_mask_min(mask);
}

static inline void snd_interval_any(struct snd_interval *i)
{
	i->min = 0;
	i->openmin = 0;
	i->max = UINT_MAX;
	i->openmax = 0;
	i->integer = 0;
	i->empty = 0;
}

static inline void snd_interval_none(struct snd_interval *i)
{
	i->empty = 1;
}

static inline int snd_interval_checkempty(const struct snd_interval *i)
{
	return (i->min > i->max ||
		(i->min == i->max && (i->openmin || i->openmax)));
}

static inline int snd_interval_empty(const struct snd_interval *i)
{
	return i->empty;
}

static inline int snd_interval_single(const struct snd_interval *i)
{
	return (i->min == i->max || 
		(i->min + 1 == i->max && i->openmax));
}

static inline int snd_interval_value(const struct snd_interval *i)
{
	return i->min;
}

static inline int snd_interval_min(const struct snd_interval *i)
{
	return i->min;
}

static inline int snd_interval_max(const struct snd_interval *i)
{
	unsigned int v;
	v = i->max;
	if (i->openmax)
		v--;
	return v;
}

static inline int snd_interval_test(const struct snd_interval *i, unsigned int val)
{
	return !((i->min > val || (i->min == val && i->openmin) ||
		  i->max < val || (i->max == val && i->openmax)));
}

static inline void snd_interval_copy(struct snd_interval *d, const struct snd_interval *s)
{
	*d = *s;
}

static inline int snd_interval_setinteger(struct snd_interval *i)
{
	if (i->integer)
		return 0;
	if (i->openmin && i->openmax && i->min == i->max)
		return -EINVAL;
	i->integer = 1;
	return 1;
}

static inline int snd_interval_eq(const struct snd_interval *i1, const struct snd_interval *i2)
{
	if (i1->empty)
		return i2->empty;
	if (i2->empty)
		return i1->empty;
	return i1->min == i2->min && i1->openmin == i2->openmin &&
		i1->max == i2->max && i1->openmax == i2->openmax;
}

/**
 * params_access - get the access type from the hw params
 * @p: hw params
 */
static inline snd_pcm_access_t params_access(const struct snd_pcm_hw_params *p)
{
	return (__force snd_pcm_access_t)snd_mask_min(hw_param_mask_c(p,
		SNDRV_PCM_HW_PARAM_ACCESS));
}

/**
 * params_format - get the sample format from the hw params
 * @p: hw params
 */
static inline snd_pcm_format_t params_format(const struct snd_pcm_hw_params *p)
{
	return (__force snd_pcm_format_t)snd_mask_min(hw_param_mask_c(p,
		SNDRV_PCM_HW_PARAM_FORMAT));
}

/**
 * params_subformat - get the sample subformat from the hw params
 * @p: hw params
 */
static inline snd_pcm_subformat_t
params_subformat(const struct snd_pcm_hw_params *p)
{
	return (__force snd_pcm_subformat_t)snd_mask_min(hw_param_mask_c(p,
		SNDRV_PCM_HW_PARAM_SUBFORMAT));
}

/**
 * params_period_bytes - get the period size (in bytes) from the hw params
 * @p: hw params
 */
static inline unsigned int
params_period_bytes(const struct snd_pcm_hw_params *p)
{
	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_BYTES)->min;
}

/**
 * params_width - get the number of bits of the sample format from the hw params
 * @p: hw params
 *
 * This function returns the number of bits per sample that the selected sample
 * format of the hw params has.
 */
static inline int params_width(const struct snd_pcm_hw_params *p)
{
	return snd_pcm_format_width(params_format(p));
}

/*
 * params_physical_width - get the storage size of the sample format from the hw params
 * @p: hw params
 *
 * This functions returns the number of bits per sample that the selected sample
 * format of the hw params takes up in memory. This will be equal or larger than
 * params_width().
 */
static inline int params_physical_width(const struct snd_pcm_hw_params *p)
{
	return snd_pcm_format_physical_width(params_format(p));
}

static inline void
params_set_format(struct snd_pcm_hw_params *p, snd_pcm_format_t fmt)
{
	snd_mask_set(hw_param_mask(p, SNDRV_PCM_HW_PARAM_FORMAT),
		(__force int)fmt);
}

#endif /* __SOUND_PCM_PARAMS_H */
Commit	Line	Data
	1	#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
	25	#include <sound/pcm.h>
	26
	27	int 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);
	30	int 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);
	33	int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
	34	snd_pcm_hw_param_t var, int *dir);
	35
	36	#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
	41	static inline size_t snd_mask_sizeof(void)
	42	{
	43	return sizeof(struct snd_mask);
	44	}
	45
	46	static inline void snd_mask_none(struct snd_mask *mask)
	47	{
	48	memset(mask, 0, sizeof(*mask));
	49	}
	50
	51	static inline void snd_mask_any(struct snd_mask *mask)
	52	{
	53	memset(mask, 0xff, SNDRV_MASK_SIZE * sizeof(u_int32_t));
	54	}
	55
	56	static inline int snd_mask_empty(const struct snd_mask *mask)
	57	{
	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
	65	static inline unsigned int snd_mask_min(const struct snd_mask *mask)
	66	{
	67	int i;
	68	for (i = 0; i < SNDRV_MASK_SIZE; i++) {
	69	if (mask->bits[i])
	70	return __ffs(mask->bits[i]) + (i << 5);
	71	}
	72	return 0;
	73	}
	74
	75	static inline unsigned int snd_mask_max(const struct snd_mask *mask)
	76	{
	77	int i;
	78	for (i = SNDRV_MASK_SIZE - 1; i >= 0; i--) {
	79	if (mask->bits[i])
	80	return __fls(mask->bits[i]) + (i << 5);
	81	}
	82	return 0;
	83	}
	84
	85	static inline void snd_mask_set(struct snd_mask *mask, unsigned int val)
	86	{
	87	mask->bits[MASK_OFS(val)] \|= MASK_BIT(val);
	88	}
	89
	90	static inline void snd_mask_reset(struct snd_mask *mask, unsigned int val)
	91	{
	92	mask->bits[MASK_OFS(val)] &= ~MASK_BIT(val);
	93	}
	94
	95	static inline void snd_mask_set_range(struct snd_mask *mask,
	96	unsigned int from, unsigned int to)
	97	{
	98	unsigned int i;
	99	for (i = from; i <= to; i++)
	100	mask->bits[MASK_OFS(i)] \|= MASK_BIT(i);
	101	}
	102
	103	static inline void snd_mask_reset_range(struct snd_mask *mask,
	104	unsigned int from, unsigned int to)
	105	{
	106	unsigned int i;
	107	for (i = from; i <= to; i++)
	108	mask->bits[MASK_OFS(i)] &= ~MASK_BIT(i);
	109	}
	110
	111	static inline void snd_mask_leave(struct snd_mask *mask, unsigned int val)
	112	{
	113	unsigned int v;
	114	v = mask->bits[MASK_OFS(val)] & MASK_BIT(val);
	115	snd_mask_none(mask);
	116	mask->bits[MASK_OFS(val)] = v;
	117	}
	118
	119	static inline void snd_mask_intersect(struct snd_mask *mask,
	120	const struct snd_mask *v)
	121	{
	122	int i;
	123	for (i = 0; i < SNDRV_MASK_SIZE; i++)
	124	mask->bits[i] &= v->bits[i];
	125	}
	126
	127	static inline int snd_mask_eq(const struct snd_mask *mask,
	128	const struct snd_mask *v)
	129	{
	130	return ! memcmp(mask, v, SNDRV_MASK_SIZE * sizeof(u_int32_t));
	131	}
	132
	133	static inline void snd_mask_copy(struct snd_mask *mask,
	134	const struct snd_mask *v)
	135	{
	136	mask = v;
	137	}
	138
	139	static inline int snd_mask_test(const struct snd_mask *mask, unsigned int val)
	140	{
	141	return mask->bits[MASK_OFS(val)] & MASK_BIT(val);
	142	}
	143
	144	static inline int snd_mask_single(const struct snd_mask *mask)
	145	{
	146	int i, c = 0;
	147	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
	159	static inline int snd_mask_refine(struct snd_mask *mask,
	160	const struct snd_mask *v)
	161	{
	162	struct snd_mask old;
	163	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
	170	static inline int snd_mask_refine_first(struct snd_mask *mask)
	171	{
	172	if (snd_mask_single(mask))
	173	return 0;
	174	snd_mask_leave(mask, snd_mask_min(mask));
	175	return 1;
	176	}
	177
	178	static inline int snd_mask_refine_last(struct snd_mask *mask)
	179	{
	180	if (snd_mask_single(mask))
	181	return 0;
	182	snd_mask_leave(mask, snd_mask_max(mask));
	183	return 1;
	184	}
	185
	186	static inline int snd_mask_refine_min(struct snd_mask *mask, unsigned int val)
	187	{
	188	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
	196	static inline int snd_mask_refine_max(struct snd_mask *mask, unsigned int val)
	197	{
	198	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
	206	static inline int snd_mask_refine_set(struct snd_mask *mask, unsigned int val)
	207	{
	208	int changed;
	209	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
	216	static inline int snd_mask_value(const struct snd_mask *mask)
	217	{
	218	return snd_mask_min(mask);
	219	}
	220
	221	static inline void snd_interval_any(struct snd_interval *i)
	222	{
	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
	231	static inline void snd_interval_none(struct snd_interval *i)
	232	{
	233	i->empty = 1;
	234	}
	235
	236	static inline int snd_interval_checkempty(const struct snd_interval *i)
	237	{
	238	return (i->min > i->max \|\|
	239	(i->min == i->max && (i->openmin \|\| i->openmax)));
	240	}
	241
	242	static inline int snd_interval_empty(const struct snd_interval *i)
	243	{
	244	return i->empty;
	245	}
	246
	247	static inline int snd_interval_single(const struct snd_interval *i)
	248	{
	249	return (i->min == i->max \|\|
	250	(i->min + 1 == i->max && i->openmax));
	251	}
	252
	253	static inline int snd_interval_value(const struct snd_interval *i)
	254	{
	255	return i->min;
	256	}
	257
	258	static inline int snd_interval_min(const struct snd_interval *i)
	259	{
	260	return i->min;
	261	}
	262
	263	static inline int snd_interval_max(const struct snd_interval *i)
	264	{
	265	unsigned int v;
	266	v = i->max;
	267	if (i->openmax)
	268	v--;
	269	return v;
	270	}
	271
	272	static inline int snd_interval_test(const struct snd_interval *i, unsigned int val)
	273	{
	274	return !((i->min > val \|\| (i->min == val && i->openmin) \|\|
	275	i->max < val \|\| (i->max == val && i->openmax)));
	276	}
	277
	278	static inline void snd_interval_copy(struct snd_interval d, const struct snd_interval s)
	279	{
	280	d = s;
	281	}
	282
	283	static inline int snd_interval_setinteger(struct snd_interval *i)
	284	{
	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
	293	static inline int snd_interval_eq(const struct snd_interval i1, const struct snd_interval i2)
	294	{
	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
	303	/**
	304	* params_access - get the access type from the hw params
	305	* @p: hw params
	306	*/
	307	static 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
	313	/**
	314	* params_format - get the sample format from the hw params
	315	* @p: hw params
	316	*/
	317	static 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
	323	/**
	324	* params_subformat - get the sample subformat from the hw params
	325	* @p: hw params
	326	*/
	327	static inline snd_pcm_subformat_t
	328	params_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	}
	333
	334	/**
	335	* params_period_bytes - get the period size (in bytes) from the hw params
	336	* @p: hw params
	337	*/
	338	static inline unsigned int
	339	params_period_bytes(const struct snd_pcm_hw_params *p)
	340	{
	341	return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_BYTES)->min;
	342	}
	343
	344	/**
	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	*/
	351	static inline int params_width(const struct snd_pcm_hw_params *p)
	352	{
	353	return snd_pcm_format_width(params_format(p));
	354	}
	355
	356	/*
	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	*/
	364	static inline int params_physical_width(const struct snd_pcm_hw_params *p)
	365	{
	366	return snd_pcm_format_physical_width(params_format(p));
	367	}
	368
	369	static inline void
	370	params_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
	376	#endif /* __SOUND_PCM_PARAMS_H */