[linux-2.6-block.git] / sound / core / pcm_misc.c

/*
 *  PCM Interface - misc routines
 *  Copyright (c) 1998 by Jaroslav Kysela <perex@perex.cz>
 *
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library 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 Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */
  
#include <linux/time.h>
#include <linux/export.h>
#include <sound/core.h>
#include <sound/pcm.h>
#define SND_PCM_FORMAT_UNKNOWN (-1)

/* NOTE: "signed" prefix must be given below since the default char is
 *       unsigned on some architectures!
 */
struct pcm_format_data {
	unsigned char width;	/* bit width */
	unsigned char phys;	/* physical bit width */
	signed char le;	/* 0 = big-endian, 1 = little-endian, -1 = others */
	signed char signd;	/* 0 = unsigned, 1 = signed, -1 = others */
	unsigned char silence[8];	/* silence data to fill */
};

/* we do lots of calculations on snd_pcm_format_t; shut up sparse */
#define INT	__force int

static struct pcm_format_data pcm_formats[(INT)SNDRV_PCM_FORMAT_LAST+1] = {
	[SNDRV_PCM_FORMAT_S8] = {
		.width = 8, .phys = 8, .le = -1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U8] = {
		.width = 8, .phys = 8, .le = -1, .signd = 0,
		.silence = { 0x80 },
	},
	[SNDRV_PCM_FORMAT_S16_LE] = {
		.width = 16, .phys = 16, .le = 1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_S16_BE] = {
		.width = 16, .phys = 16, .le = 0, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U16_LE] = {
		.width = 16, .phys = 16, .le = 1, .signd = 0,
		.silence = { 0x00, 0x80 },
	},
	[SNDRV_PCM_FORMAT_U16_BE] = {
		.width = 16, .phys = 16, .le = 0, .signd = 0,
		.silence = { 0x80, 0x00 },
	},
	[SNDRV_PCM_FORMAT_S24_LE] = {
		.width = 24, .phys = 32, .le = 1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_S24_BE] = {
		.width = 24, .phys = 32, .le = 0, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U24_LE] = {
		.width = 24, .phys = 32, .le = 1, .signd = 0,
		.silence = { 0x00, 0x00, 0x80 },
	},
	[SNDRV_PCM_FORMAT_U24_BE] = {
		.width = 24, .phys = 32, .le = 0, .signd = 0,
		.silence = { 0x00, 0x80, 0x00, 0x00 },
	},
	[SNDRV_PCM_FORMAT_S32_LE] = {
		.width = 32, .phys = 32, .le = 1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_S32_BE] = {
		.width = 32, .phys = 32, .le = 0, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U32_LE] = {
		.width = 32, .phys = 32, .le = 1, .signd = 0,
		.silence = { 0x00, 0x00, 0x00, 0x80 },
	},
	[SNDRV_PCM_FORMAT_U32_BE] = {
		.width = 32, .phys = 32, .le = 0, .signd = 0,
		.silence = { 0x80, 0x00, 0x00, 0x00 },
	},
	[SNDRV_PCM_FORMAT_FLOAT_LE] = {
		.width = 32, .phys = 32, .le = 1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_FLOAT_BE] = {
		.width = 32, .phys = 32, .le = 0, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_FLOAT64_LE] = {
		.width = 64, .phys = 64, .le = 1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_FLOAT64_BE] = {
		.width = 64, .phys = 64, .le = 0, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE] = {
		.width = 32, .phys = 32, .le = 1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE] = {
		.width = 32, .phys = 32, .le = 0, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_MU_LAW] = {
		.width = 8, .phys = 8, .le = -1, .signd = -1,
		.silence = { 0x7f },
	},
	[SNDRV_PCM_FORMAT_A_LAW] = {
		.width = 8, .phys = 8, .le = -1, .signd = -1,
		.silence = { 0x55 },
	},
	[SNDRV_PCM_FORMAT_IMA_ADPCM] = {
		.width = 4, .phys = 4, .le = -1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_G723_24] = {
		.width = 3, .phys = 3, .le = -1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_G723_40] = {
		.width = 5, .phys = 5, .le = -1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_DSD_U8] = {
		.width = 8, .phys = 8, .le = 1, .signd = 0,
		.silence = { 0x69 },
	},
	[SNDRV_PCM_FORMAT_DSD_U16_LE] = {
		.width = 16, .phys = 16, .le = 1, .signd = 0,
		.silence = { 0x69, 0x69 },
	},
	[SNDRV_PCM_FORMAT_DSD_U32_LE] = {
		.width = 32, .phys = 32, .le = 1, .signd = 0,
		.silence = { 0x69, 0x69, 0x69, 0x69 },
	},
	/* FIXME: the following three formats are not defined properly yet */
	[SNDRV_PCM_FORMAT_MPEG] = {
		.le = -1, .signd = -1,
	},
	[SNDRV_PCM_FORMAT_GSM] = {
		.le = -1, .signd = -1,
	},
	[SNDRV_PCM_FORMAT_SPECIAL] = {
		.le = -1, .signd = -1,
	},
	[SNDRV_PCM_FORMAT_S24_3LE] = {
		.width = 24, .phys = 24, .le = 1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_S24_3BE] = {
		.width = 24, .phys = 24, .le = 0, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U24_3LE] = {
		.width = 24, .phys = 24, .le = 1, .signd = 0,
		.silence = { 0x00, 0x00, 0x80 },
	},
	[SNDRV_PCM_FORMAT_U24_3BE] = {
		.width = 24, .phys = 24, .le = 0, .signd = 0,
		.silence = { 0x80, 0x00, 0x00 },
	},
	[SNDRV_PCM_FORMAT_S20_3LE] = {
		.width = 20, .phys = 24, .le = 1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_S20_3BE] = {
		.width = 20, .phys = 24, .le = 0, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U20_3LE] = {
		.width = 20, .phys = 24, .le = 1, .signd = 0,
		.silence = { 0x00, 0x00, 0x08 },
	},
	[SNDRV_PCM_FORMAT_U20_3BE] = {
		.width = 20, .phys = 24, .le = 0, .signd = 0,
		.silence = { 0x08, 0x00, 0x00 },
	},
	[SNDRV_PCM_FORMAT_S18_3LE] = {
		.width = 18, .phys = 24, .le = 1, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_S18_3BE] = {
		.width = 18, .phys = 24, .le = 0, .signd = 1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_U18_3LE] = {
		.width = 18, .phys = 24, .le = 1, .signd = 0,
		.silence = { 0x00, 0x00, 0x02 },
	},
	[SNDRV_PCM_FORMAT_U18_3BE] = {
		.width = 18, .phys = 24, .le = 0, .signd = 0,
		.silence = { 0x02, 0x00, 0x00 },
	},
	[SNDRV_PCM_FORMAT_G723_24_1B] = {
		.width = 3, .phys = 8, .le = -1, .signd = -1,
		.silence = {},
	},
	[SNDRV_PCM_FORMAT_G723_40_1B] = {
		.width = 5, .phys = 8, .le = -1, .signd = -1,
		.silence = {},
	},
};


/**
 * snd_pcm_format_signed - Check the PCM format is signed linear
 * @format: the format to check
 *
 * Return: 1 if the given PCM format is signed linear, 0 if unsigned
 * linear, and a negative error code for non-linear formats.
 */
int snd_pcm_format_signed(snd_pcm_format_t format)
{
	int val;
	if ((INT)format < 0 || (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
		return -EINVAL;
	if ((val = pcm_formats[(INT)format].signd) < 0)
		return -EINVAL;
	return val;
}

EXPORT_SYMBOL(snd_pcm_format_signed);

/**
 * snd_pcm_format_unsigned - Check the PCM format is unsigned linear
 * @format: the format to check
 *
 * Return: 1 if the given PCM format is unsigned linear, 0 if signed
 * linear, and a negative error code for non-linear formats.
 */
int snd_pcm_format_unsigned(snd_pcm_format_t format)
{
	int val;

	val = snd_pcm_format_signed(format);
	if (val < 0)
		return val;
	return !val;
}

EXPORT_SYMBOL(snd_pcm_format_unsigned);

/**
 * snd_pcm_format_linear - Check the PCM format is linear
 * @format: the format to check
 *
 * Return: 1 if the given PCM format is linear, 0 if not.
 */
int snd_pcm_format_linear(snd_pcm_format_t format)
{
	return snd_pcm_format_signed(format) >= 0;
}

EXPORT_SYMBOL(snd_pcm_format_linear);

/**
 * snd_pcm_format_little_endian - Check the PCM format is little-endian
 * @format: the format to check
 *
 * Return: 1 if the given PCM format is little-endian, 0 if
 * big-endian, or a negative error code if endian not specified.
 */
int snd_pcm_format_little_endian(snd_pcm_format_t format)
{
	int val;
	if ((INT)format < 0 || (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
		return -EINVAL;
	if ((val = pcm_formats[(INT)format].le) < 0)
		return -EINVAL;
	return val;
}

EXPORT_SYMBOL(snd_pcm_format_little_endian);

/**
 * snd_pcm_format_big_endian - Check the PCM format is big-endian
 * @format: the format to check
 *
 * Return: 1 if the given PCM format is big-endian, 0 if
 * little-endian, or a negative error code if endian not specified.
 */
int snd_pcm_format_big_endian(snd_pcm_format_t format)
{
	int val;

	val = snd_pcm_format_little_endian(format);
	if (val < 0)
		return val;
	return !val;
}

EXPORT_SYMBOL(snd_pcm_format_big_endian);

/**
 * snd_pcm_format_width - return the bit-width of the format
 * @format: the format to check
 *
 * Return: The bit-width of the format, or a negative error code
 * if unknown format.
 */
int snd_pcm_format_width(snd_pcm_format_t format)
{
	int val;
	if ((INT)format < 0 || (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
		return -EINVAL;
	if ((val = pcm_formats[(INT)format].width) == 0)
		return -EINVAL;
	return val;
}

EXPORT_SYMBOL(snd_pcm_format_width);

/**
 * snd_pcm_format_physical_width - return the physical bit-width of the format
 * @format: the format to check
 *
 * Return: The physical bit-width of the format, or a negative error code
 * if unknown format.
 */
int snd_pcm_format_physical_width(snd_pcm_format_t format)
{
	int val;
	if ((INT)format < 0 || (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
		return -EINVAL;
	if ((val = pcm_formats[(INT)format].phys) == 0)
		return -EINVAL;
	return val;
}

EXPORT_SYMBOL(snd_pcm_format_physical_width);

/**
 * snd_pcm_format_size - return the byte size of samples on the given format
 * @format: the format to check
 * @samples: sampling rate
 *
 * Return: The byte size of the given samples for the format, or a
 * negative error code if unknown format.
 */
ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples)
{
	int phys_width = snd_pcm_format_physical_width(format);
	if (phys_width < 0)
		return -EINVAL;
	return samples * phys_width / 8;
}

EXPORT_SYMBOL(snd_pcm_format_size);

/**
 * snd_pcm_format_silence_64 - return the silent data in 8 bytes array
 * @format: the format to check
 *
 * Return: The format pattern to fill or %NULL if error.
 */
const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format)
{
	if ((INT)format < 0 || (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
		return NULL;
	if (! pcm_formats[(INT)format].phys)
		return NULL;
	return pcm_formats[(INT)format].silence;
}

EXPORT_SYMBOL(snd_pcm_format_silence_64);

/**
 * snd_pcm_format_set_silence - set the silence data on the buffer
 * @format: the PCM format
 * @data: the buffer pointer
 * @samples: the number of samples to set silence
 *
 * Sets the silence data on the buffer for the given samples.
 *
 * Return: Zero if successful, or a negative error code on failure.
 */
int snd_pcm_format_set_silence(snd_pcm_format_t format, void *data, unsigned int samples)
{
	int width;
	unsigned char *dst, *pat;

	if ((INT)format < 0 || (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
		return -EINVAL;
	if (samples == 0)
		return 0;
	width = pcm_formats[(INT)format].phys; /* physical width */
	pat = pcm_formats[(INT)format].silence;
	if (! width)
		return -EINVAL;
	/* signed or 1 byte data */
	if (pcm_formats[(INT)format].signd == 1 || width <= 8) {
		unsigned int bytes = samples * width / 8;
		memset(data, *pat, bytes);
		return 0;
	}
	/* non-zero samples, fill using a loop */
	width /= 8;
	dst = data;
#if 0
	while (samples--) {
		memcpy(dst, pat, width);
		dst += width;
	}
#else
	/* a bit optimization for constant width */
	switch (width) {
	case 2:
		while (samples--) {
			memcpy(dst, pat, 2);
			dst += 2;
		}
		break;
	case 3:
		while (samples--) {
			memcpy(dst, pat, 3);
			dst += 3;
		}
		break;
	case 4:
		while (samples--) {
			memcpy(dst, pat, 4);
			dst += 4;
		}
		break;
	case 8:
		while (samples--) {
			memcpy(dst, pat, 8);
			dst += 8;
		}
		break;
	}
#endif
	return 0;
}

EXPORT_SYMBOL(snd_pcm_format_set_silence);

/**
 * snd_pcm_limit_hw_rates - determine rate_min/rate_max fields
 * @runtime: the runtime instance
 *
 * Determines the rate_min and rate_max fields from the rates bits of
 * the given runtime->hw.
 *
 * Return: Zero if successful.
 */
int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime)
{
	int i;
	for (i = 0; i < (int)snd_pcm_known_rates.count; i++) {
		if (runtime->hw.rates & (1 << i)) {
			runtime->hw.rate_min = snd_pcm_known_rates.list[i];
			break;
		}
	}
	for (i = (int)snd_pcm_known_rates.count - 1; i >= 0; i--) {
		if (runtime->hw.rates & (1 << i)) {
			runtime->hw.rate_max = snd_pcm_known_rates.list[i];
			break;
		}
	}
	return 0;
}

EXPORT_SYMBOL(snd_pcm_limit_hw_rates);

/**
 * snd_pcm_rate_to_rate_bit - converts sample rate to SNDRV_PCM_RATE_xxx bit
 * @rate: the sample rate to convert
 *
 * Return: The SNDRV_PCM_RATE_xxx flag that corresponds to the given rate, or
 * SNDRV_PCM_RATE_KNOT for an unknown rate.
 */
unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate)
{
	unsigned int i;

	for (i = 0; i < snd_pcm_known_rates.count; i++)
		if (snd_pcm_known_rates.list[i] == rate)
			return 1u << i;
	return SNDRV_PCM_RATE_KNOT;
}
EXPORT_SYMBOL(snd_pcm_rate_to_rate_bit);

/**
 * snd_pcm_rate_bit_to_rate - converts SNDRV_PCM_RATE_xxx bit to sample rate
 * @rate_bit: the rate bit to convert
 *
 * Return: The sample rate that corresponds to the given SNDRV_PCM_RATE_xxx flag
 * or 0 for an unknown rate bit.
 */
unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit)
{
	unsigned int i;

	for (i = 0; i < snd_pcm_known_rates.count; i++)
		if ((1u << i) == rate_bit)
			return snd_pcm_known_rates.list[i];
	return 0;
}
EXPORT_SYMBOL(snd_pcm_rate_bit_to_rate);

static unsigned int snd_pcm_rate_mask_sanitize(unsigned int rates)
{
	if (rates & SNDRV_PCM_RATE_CONTINUOUS)
		return SNDRV_PCM_RATE_CONTINUOUS;
	else if (rates & SNDRV_PCM_RATE_KNOT)
		return SNDRV_PCM_RATE_KNOT;
	return rates;
}

/**
 * snd_pcm_rate_mask_intersect - computes the intersection between two rate masks
 * @rates_a: The first rate mask
 * @rates_b: The second rate mask
 *
 * This function computes the rates that are supported by both rate masks passed
 * to the function. It will take care of the special handling of
 * SNDRV_PCM_RATE_CONTINUOUS and SNDRV_PCM_RATE_KNOT.
 *
 * Return: A rate mask containing the rates that are supported by both rates_a
 * and rates_b.
 */
unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
	unsigned int rates_b)
{
	rates_a = snd_pcm_rate_mask_sanitize(rates_a);
	rates_b = snd_pcm_rate_mask_sanitize(rates_b);

	if (rates_a & SNDRV_PCM_RATE_CONTINUOUS)
		return rates_b;
	else if (rates_b & SNDRV_PCM_RATE_CONTINUOUS)
		return rates_a;
	else if (rates_a & SNDRV_PCM_RATE_KNOT)
		return rates_b;
	else if (rates_b & SNDRV_PCM_RATE_KNOT)
		return rates_a;
	return rates_a & rates_b;
}
EXPORT_SYMBOL_GPL(snd_pcm_rate_mask_intersect);
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* PCM Interface - misc routines
c1017a4c	3	* Copyright (c) 1998 by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	4	*
	5	*
	6	* This library is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU Library General Public License as
	8	* published by the Free Software Foundation; either version 2 of
	9	* the License, or (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU Library General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU Library General Public
	17	* License along with this library; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*
	20	*/
	21
1da177e4	22	#include <linux/time.h>
d81a6d71	23	#include <linux/export.h>
1da177e4 LT	24	#include <sound/core.h>
	25	#include <sound/pcm.h>
	26	#define SND_PCM_FORMAT_UNKNOWN (-1)
	27
	28	/* NOTE: "signed" prefix must be given below since the default char is
	29	* unsigned on some architectures!
	30	*/
	31	struct pcm_format_data {
	32	unsigned char width; /* bit width */
	33	unsigned char phys; /* physical bit width */
	34	signed char le; /* 0 = big-endian, 1 = little-endian, -1 = others */
	35	signed char signd; /* 0 = unsigned, 1 = signed, -1 = others */
	36	unsigned char silence[8]; /* silence data to fill */
	37	};
	38
fea952e5 CL	39	/* we do lots of calculations on snd_pcm_format_t; shut up sparse */
	40	#define INT __force int
	41
	42	static struct pcm_format_data pcm_formats[(INT)SNDRV_PCM_FORMAT_LAST+1] = {
1da177e4 LT	43	[SNDRV_PCM_FORMAT_S8] = {
	44	.width = 8, .phys = 8, .le = -1, .signd = 1,
	45	.silence = {},
	46	},
	47	[SNDRV_PCM_FORMAT_U8] = {
	48	.width = 8, .phys = 8, .le = -1, .signd = 0,
	49	.silence = { 0x80 },
	50	},
	51	[SNDRV_PCM_FORMAT_S16_LE] = {
	52	.width = 16, .phys = 16, .le = 1, .signd = 1,
	53	.silence = {},
	54	},
	55	[SNDRV_PCM_FORMAT_S16_BE] = {
	56	.width = 16, .phys = 16, .le = 0, .signd = 1,
	57	.silence = {},
	58	},
	59	[SNDRV_PCM_FORMAT_U16_LE] = {
	60	.width = 16, .phys = 16, .le = 1, .signd = 0,
	61	.silence = { 0x00, 0x80 },
	62	},
	63	[SNDRV_PCM_FORMAT_U16_BE] = {
	64	.width = 16, .phys = 16, .le = 0, .signd = 0,
	65	.silence = { 0x80, 0x00 },
	66	},
	67	[SNDRV_PCM_FORMAT_S24_LE] = {
	68	.width = 24, .phys = 32, .le = 1, .signd = 1,
	69	.silence = {},
	70	},
	71	[SNDRV_PCM_FORMAT_S24_BE] = {
	72	.width = 24, .phys = 32, .le = 0, .signd = 1,
	73	.silence = {},
	74	},
	75	[SNDRV_PCM_FORMAT_U24_LE] = {
	76	.width = 24, .phys = 32, .le = 1, .signd = 0,
	77	.silence = { 0x00, 0x00, 0x80 },
	78	},
	79	[SNDRV_PCM_FORMAT_U24_BE] = {
	80	.width = 24, .phys = 32, .le = 0, .signd = 0,
67a7be7e	81	.silence = { 0x00, 0x80, 0x00, 0x00 },
1da177e4 LT	82	},
	83	[SNDRV_PCM_FORMAT_S32_LE] = {
	84	.width = 32, .phys = 32, .le = 1, .signd = 1,
	85	.silence = {},
	86	},
	87	[SNDRV_PCM_FORMAT_S32_BE] = {
	88	.width = 32, .phys = 32, .le = 0, .signd = 1,
	89	.silence = {},
	90	},
	91	[SNDRV_PCM_FORMAT_U32_LE] = {
	92	.width = 32, .phys = 32, .le = 1, .signd = 0,
	93	.silence = { 0x00, 0x00, 0x00, 0x80 },
	94	},
	95	[SNDRV_PCM_FORMAT_U32_BE] = {
	96	.width = 32, .phys = 32, .le = 0, .signd = 0,
	97	.silence = { 0x80, 0x00, 0x00, 0x00 },
	98	},
	99	[SNDRV_PCM_FORMAT_FLOAT_LE] = {
	100	.width = 32, .phys = 32, .le = 1, .signd = -1,
	101	.silence = {},
	102	},
	103	[SNDRV_PCM_FORMAT_FLOAT_BE] = {
	104	.width = 32, .phys = 32, .le = 0, .signd = -1,
	105	.silence = {},
	106	},
	107	[SNDRV_PCM_FORMAT_FLOAT64_LE] = {
	108	.width = 64, .phys = 64, .le = 1, .signd = -1,
	109	.silence = {},
	110	},
	111	[SNDRV_PCM_FORMAT_FLOAT64_BE] = {
	112	.width = 64, .phys = 64, .le = 0, .signd = -1,
	113	.silence = {},
	114	},
	115	[SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE] = {
	116	.width = 32, .phys = 32, .le = 1, .signd = -1,
	117	.silence = {},
	118	},
	119	[SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE] = {
	120	.width = 32, .phys = 32, .le = 0, .signd = -1,
	121	.silence = {},
	122	},
	123	[SNDRV_PCM_FORMAT_MU_LAW] = {
	124	.width = 8, .phys = 8, .le = -1, .signd = -1,
	125	.silence = { 0x7f },
	126	},
	127	[SNDRV_PCM_FORMAT_A_LAW] = {
	128	.width = 8, .phys = 8, .le = -1, .signd = -1,
	129	.silence = { 0x55 },
	130	},
	131	[SNDRV_PCM_FORMAT_IMA_ADPCM] = {
	132	.width = 4, .phys = 4, .le = -1, .signd = -1,
	133	.silence = {},
	134	},
15c0cee6 BC	135	[SNDRV_PCM_FORMAT_G723_24] = {
	136	.width = 3, .phys = 3, .le = -1, .signd = -1,
	137	.silence = {},
	138	},
	139	[SNDRV_PCM_FORMAT_G723_40] = {
	140	.width = 5, .phys = 5, .le = -1, .signd = -1,
	141	.silence = {},
	142	},
ef7a4f97 DM	143	[SNDRV_PCM_FORMAT_DSD_U8] = {
ef7a4f97 DM	144	.width = 8, .phys = 8, .le = 1, .signd = 0,
94a988a8	145	.silence = { 0x69 },
ef7a4f97 DM	146	},
	147	[SNDRV_PCM_FORMAT_DSD_U16_LE] = {
	148	.width = 16, .phys = 16, .le = 1, .signd = 0,
94a988a8	149	.silence = { 0x69, 0x69 },
ef7a4f97	150	},
d4288d3f JK	151	[SNDRV_PCM_FORMAT_DSD_U32_LE] = {
	152	.width = 32, .phys = 32, .le = 1, .signd = 0,
	153	.silence = { 0x69, 0x69, 0x69, 0x69 },
	154	},
1da177e4 LT	155	/* FIXME: the following three formats are not defined properly yet */
	156	[SNDRV_PCM_FORMAT_MPEG] = {
	157	.le = -1, .signd = -1,
	158	},
	159	[SNDRV_PCM_FORMAT_GSM] = {
	160	.le = -1, .signd = -1,
	161	},
	162	[SNDRV_PCM_FORMAT_SPECIAL] = {
	163	.le = -1, .signd = -1,
	164	},
	165	[SNDRV_PCM_FORMAT_S24_3LE] = {
	166	.width = 24, .phys = 24, .le = 1, .signd = 1,
	167	.silence = {},
	168	},
	169	[SNDRV_PCM_FORMAT_S24_3BE] = {
	170	.width = 24, .phys = 24, .le = 0, .signd = 1,
	171	.silence = {},
	172	},
	173	[SNDRV_PCM_FORMAT_U24_3LE] = {
	174	.width = 24, .phys = 24, .le = 1, .signd = 0,
	175	.silence = { 0x00, 0x00, 0x80 },
	176	},
	177	[SNDRV_PCM_FORMAT_U24_3BE] = {
	178	.width = 24, .phys = 24, .le = 0, .signd = 0,
	179	.silence = { 0x80, 0x00, 0x00 },
	180	},
	181	[SNDRV_PCM_FORMAT_S20_3LE] = {
	182	.width = 20, .phys = 24, .le = 1, .signd = 1,
	183	.silence = {},
	184	},
	185	[SNDRV_PCM_FORMAT_S20_3BE] = {
	186	.width = 20, .phys = 24, .le = 0, .signd = 1,
	187	.silence = {},
	188	},
	189	[SNDRV_PCM_FORMAT_U20_3LE] = {
	190	.width = 20, .phys = 24, .le = 1, .signd = 0,
	191	.silence = { 0x00, 0x00, 0x08 },
	192	},
	193	[SNDRV_PCM_FORMAT_U20_3BE] = {
	194	.width = 20, .phys = 24, .le = 0, .signd = 0,
	195	.silence = { 0x08, 0x00, 0x00 },
	196	},
	197	[SNDRV_PCM_FORMAT_S18_3LE] = {
	198	.width = 18, .phys = 24, .le = 1, .signd = 1,
	199	.silence = {},
	200	},
	201	[SNDRV_PCM_FORMAT_S18_3BE] = {
	202	.width = 18, .phys = 24, .le = 0, .signd = 1,
	203	.silence = {},
	204	},
	205	[SNDRV_PCM_FORMAT_U18_3LE] = {
	206	.width = 18, .phys = 24, .le = 1, .signd = 0,
	207	.silence = { 0x00, 0x00, 0x02 },
	208	},
	209	[SNDRV_PCM_FORMAT_U18_3BE] = {
	210	.width = 18, .phys = 24, .le = 0, .signd = 0,
	211	.silence = { 0x02, 0x00, 0x00 },
	212	},
15c0cee6 BC	213	[SNDRV_PCM_FORMAT_G723_24_1B] = {
	214	.width = 3, .phys = 8, .le = -1, .signd = -1,
	215	.silence = {},
	216	},
	217	[SNDRV_PCM_FORMAT_G723_40_1B] = {
	218	.width = 5, .phys = 8, .le = -1, .signd = -1,
	219	.silence = {},
	220	},
1da177e4 LT	221	};
	222
	223
	224	/**
	225	* snd_pcm_format_signed - Check the PCM format is signed linear
	226	* @format: the format to check
	227	*
eb7c06e8	228	* Return: 1 if the given PCM format is signed linear, 0 if unsigned
1da177e4 LT	229	* linear, and a negative error code for non-linear formats.
	230	*/
	231	int snd_pcm_format_signed(snd_pcm_format_t format)
	232	{
	233	int val;
fea952e5	234	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	235	return -EINVAL;
fea952e5	236	if ((val = pcm_formats[(INT)format].signd) < 0)
1da177e4 LT	237	return -EINVAL;
	238	return val;
	239	}
	240
e88e8ae6 TI	241	EXPORT_SYMBOL(snd_pcm_format_signed);
e88e8ae6 TI	242
1da177e4 LT	243	/**
	244	* snd_pcm_format_unsigned - Check the PCM format is unsigned linear
	245	* @format: the format to check
	246	*
eb7c06e8	247	* Return: 1 if the given PCM format is unsigned linear, 0 if signed
1da177e4 LT	248	* linear, and a negative error code for non-linear formats.
	249	*/
	250	int snd_pcm_format_unsigned(snd_pcm_format_t format)
	251	{
	252	int val;
	253
	254	val = snd_pcm_format_signed(format);
	255	if (val < 0)
	256	return val;
	257	return !val;
	258	}
	259
e88e8ae6 TI	260	EXPORT_SYMBOL(snd_pcm_format_unsigned);
e88e8ae6 TI	261
1da177e4 LT	262	/**
	263	* snd_pcm_format_linear - Check the PCM format is linear
	264	* @format: the format to check
	265	*
eb7c06e8	266	* Return: 1 if the given PCM format is linear, 0 if not.
1da177e4 LT	267	*/
	268	int snd_pcm_format_linear(snd_pcm_format_t format)
	269	{
	270	return snd_pcm_format_signed(format) >= 0;
	271	}
	272
e88e8ae6 TI	273	EXPORT_SYMBOL(snd_pcm_format_linear);
e88e8ae6 TI	274
1da177e4 LT	275	/**
	276	* snd_pcm_format_little_endian - Check the PCM format is little-endian
	277	* @format: the format to check
	278	*
eb7c06e8	279	* Return: 1 if the given PCM format is little-endian, 0 if
1da177e4 LT	280	* big-endian, or a negative error code if endian not specified.
	281	*/
	282	int snd_pcm_format_little_endian(snd_pcm_format_t format)
	283	{
	284	int val;
fea952e5	285	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	286	return -EINVAL;
fea952e5	287	if ((val = pcm_formats[(INT)format].le) < 0)
1da177e4 LT	288	return -EINVAL;
	289	return val;
	290	}
	291
e88e8ae6 TI	292	EXPORT_SYMBOL(snd_pcm_format_little_endian);
e88e8ae6 TI	293
1da177e4 LT	294	/**
	295	* snd_pcm_format_big_endian - Check the PCM format is big-endian
	296	* @format: the format to check
	297	*
eb7c06e8	298	* Return: 1 if the given PCM format is big-endian, 0 if
1da177e4 LT	299	* little-endian, or a negative error code if endian not specified.
	300	*/
	301	int snd_pcm_format_big_endian(snd_pcm_format_t format)
	302	{
	303	int val;
	304
	305	val = snd_pcm_format_little_endian(format);
	306	if (val < 0)
	307	return val;
	308	return !val;
	309	}
	310
e88e8ae6 TI	311	EXPORT_SYMBOL(snd_pcm_format_big_endian);
e88e8ae6 TI	312
1da177e4 LT	313	/**
	314	* snd_pcm_format_width - return the bit-width of the format
	315	* @format: the format to check
	316	*
eb7c06e8	317	* Return: The bit-width of the format, or a negative error code
1da177e4 LT	318	* if unknown format.
	319	*/
	320	int snd_pcm_format_width(snd_pcm_format_t format)
	321	{
	322	int val;
fea952e5	323	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	324	return -EINVAL;
fea952e5	325	if ((val = pcm_formats[(INT)format].width) == 0)
1da177e4 LT	326	return -EINVAL;
	327	return val;
	328	}
	329
e88e8ae6 TI	330	EXPORT_SYMBOL(snd_pcm_format_width);
e88e8ae6 TI	331
1da177e4 LT	332	/**
	333	* snd_pcm_format_physical_width - return the physical bit-width of the format
	334	* @format: the format to check
	335	*
eb7c06e8	336	* Return: The physical bit-width of the format, or a negative error code
1da177e4 LT	337	* if unknown format.
	338	*/
	339	int snd_pcm_format_physical_width(snd_pcm_format_t format)
	340	{
	341	int val;
fea952e5	342	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	343	return -EINVAL;
fea952e5	344	if ((val = pcm_formats[(INT)format].phys) == 0)
1da177e4 LT	345	return -EINVAL;
	346	return val;
	347	}
	348
e88e8ae6 TI	349	EXPORT_SYMBOL(snd_pcm_format_physical_width);
e88e8ae6 TI	350
1da177e4 LT	351	/**
	352	* snd_pcm_format_size - return the byte size of samples on the given format
	353	* @format: the format to check
a66547f3	354	* @samples: sampling rate
1da177e4	355	*
eb7c06e8	356	* Return: The byte size of the given samples for the format, or a
1da177e4 LT	357	* negative error code if unknown format.
	358	*/
	359	ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples)
	360	{
	361	int phys_width = snd_pcm_format_physical_width(format);
	362	if (phys_width < 0)
	363	return -EINVAL;
	364	return samples * phys_width / 8;
	365	}
	366
e88e8ae6 TI	367	EXPORT_SYMBOL(snd_pcm_format_size);
e88e8ae6 TI	368
1da177e4 LT	369	/**
	370	* snd_pcm_format_silence_64 - return the silent data in 8 bytes array
	371	* @format: the format to check
	372	*
eb7c06e8	373	* Return: The format pattern to fill or %NULL if error.
1da177e4 LT	374	*/
	375	const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format)
	376	{
fea952e5	377	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	378	return NULL;
fea952e5	379	if (! pcm_formats[(INT)format].phys)
1da177e4	380	return NULL;
fea952e5	381	return pcm_formats[(INT)format].silence;
1da177e4 LT	382	}
1da177e4 LT	383
e88e8ae6 TI	384	EXPORT_SYMBOL(snd_pcm_format_silence_64);
e88e8ae6 TI	385
1da177e4 LT	386	/**
	387	* snd_pcm_format_set_silence - set the silence data on the buffer
	388	* @format: the PCM format
	389	* @data: the buffer pointer
	390	* @samples: the number of samples to set silence
	391	*
	392	* Sets the silence data on the buffer for the given samples.
	393	*
eb7c06e8	394	* Return: Zero if successful, or a negative error code on failure.
1da177e4 LT	395	*/
	396	int snd_pcm_format_set_silence(snd_pcm_format_t format, void *data, unsigned int samples)
	397	{
	398	int width;
	399	unsigned char dst, pat;
	400
fea952e5	401	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4 LT	402	return -EINVAL;
	403	if (samples == 0)
	404	return 0;
fea952e5 CL	405	width = pcm_formats[(INT)format].phys; /* physical width */
fea952e5 CL	406	pat = pcm_formats[(INT)format].silence;
1da177e4 LT	407	if (! width)
	408	return -EINVAL;
	409	/* signed or 1 byte data */
fea952e5	410	if (pcm_formats[(INT)format].signd == 1 \|\| width <= 8) {
1da177e4 LT	411	unsigned int bytes = samples * width / 8;
	412	memset(data, *pat, bytes);
	413	return 0;
	414	}
	415	/* non-zero samples, fill using a loop */
	416	width /= 8;
	417	dst = data;
	418	#if 0
	419	while (samples--) {
	420	memcpy(dst, pat, width);
	421	dst += width;
	422	}
	423	#else
	424	/* a bit optimization for constant width */
	425	switch (width) {
	426	case 2:
	427	while (samples--) {
	428	memcpy(dst, pat, 2);
	429	dst += 2;
	430	}
	431	break;
	432	case 3:
	433	while (samples--) {
	434	memcpy(dst, pat, 3);
	435	dst += 3;
	436	}
	437	break;
	438	case 4:
	439	while (samples--) {
	440	memcpy(dst, pat, 4);
	441	dst += 4;
	442	}
	443	break;
	444	case 8:
	445	while (samples--) {
	446	memcpy(dst, pat, 8);
	447	dst += 8;
	448	}
	449	break;
	450	}
	451	#endif
	452	return 0;
	453	}
	454
e88e8ae6 TI	455	EXPORT_SYMBOL(snd_pcm_format_set_silence);
e88e8ae6 TI	456
1da177e4 LT	457	/**
	458	* snd_pcm_limit_hw_rates - determine rate_min/rate_max fields
	459	* @runtime: the runtime instance
	460	*
	461	* Determines the rate_min and rate_max fields from the rates bits of
	462	* the given runtime->hw.
	463	*
eb7c06e8	464	* Return: Zero if successful.
1da177e4	465	*/
877211f5	466	int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime)
1da177e4	467	{
1da177e4	468	int i;
7653d557	469	for (i = 0; i < (int)snd_pcm_known_rates.count; i++) {
1da177e4	470	if (runtime->hw.rates & (1 << i)) {
7653d557	471	runtime->hw.rate_min = snd_pcm_known_rates.list[i];
1da177e4 LT	472	break;
	473	}
	474	}
7653d557	475	for (i = (int)snd_pcm_known_rates.count - 1; i >= 0; i--) {
1da177e4	476	if (runtime->hw.rates & (1 << i)) {
7653d557	477	runtime->hw.rate_max = snd_pcm_known_rates.list[i];
1da177e4 LT	478	break;
	479	}
	480	}
	481	return 0;
	482	}
e88e8ae6 TI	483
e88e8ae6 TI	484	EXPORT_SYMBOL(snd_pcm_limit_hw_rates);
918f3a0e CL	485
	486	/**
	487	* snd_pcm_rate_to_rate_bit - converts sample rate to SNDRV_PCM_RATE_xxx bit
	488	* @rate: the sample rate to convert
	489	*
eb7c06e8	490	* Return: The SNDRV_PCM_RATE_xxx flag that corresponds to the given rate, or
918f3a0e CL	491	* SNDRV_PCM_RATE_KNOT for an unknown rate.
	492	*/
	493	unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate)
	494	{
	495	unsigned int i;
	496
	497	for (i = 0; i < snd_pcm_known_rates.count; i++)
	498	if (snd_pcm_known_rates.list[i] == rate)
	499	return 1u << i;
	500	return SNDRV_PCM_RATE_KNOT;
	501	}
	502	EXPORT_SYMBOL(snd_pcm_rate_to_rate_bit);
4be77a53 DP	503
	504	/**
	505	* snd_pcm_rate_bit_to_rate - converts SNDRV_PCM_RATE_xxx bit to sample rate
	506	* @rate_bit: the rate bit to convert
	507	*
eb7c06e8 YB	508	* Return: The sample rate that corresponds to the given SNDRV_PCM_RATE_xxx flag
eb7c06e8 YB	509	* or 0 for an unknown rate bit.
4be77a53 DP	510	*/
	511	unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit)
	512	{
	513	unsigned int i;
	514
	515	for (i = 0; i < snd_pcm_known_rates.count; i++)
	516	if ((1u << i) == rate_bit)
	517	return snd_pcm_known_rates.list[i];
	518	return 0;
	519	}
	520	EXPORT_SYMBOL(snd_pcm_rate_bit_to_rate);
e3a9269f LPC	521
	522	static unsigned int snd_pcm_rate_mask_sanitize(unsigned int rates)
	523	{
	524	if (rates & SNDRV_PCM_RATE_CONTINUOUS)
	525	return SNDRV_PCM_RATE_CONTINUOUS;
	526	else if (rates & SNDRV_PCM_RATE_KNOT)
	527	return SNDRV_PCM_RATE_KNOT;
	528	return rates;
	529	}
	530
	531	/**
	532	* snd_pcm_rate_mask_intersect - computes the intersection between two rate masks
	533	* @rates_a: The first rate mask
	534	* @rates_b: The second rate mask
	535	*
	536	* This function computes the rates that are supported by both rate masks passed
	537	* to the function. It will take care of the special handling of
	538	* SNDRV_PCM_RATE_CONTINUOUS and SNDRV_PCM_RATE_KNOT.
	539	*
	540	* Return: A rate mask containing the rates that are supported by both rates_a
	541	* and rates_b.
	542	*/
	543	unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
	544	unsigned int rates_b)
	545	{
	546	rates_a = snd_pcm_rate_mask_sanitize(rates_a);
	547	rates_b = snd_pcm_rate_mask_sanitize(rates_b);
	548
	549	if (rates_a & SNDRV_PCM_RATE_CONTINUOUS)
	550	return rates_b;
	551	else if (rates_b & SNDRV_PCM_RATE_CONTINUOUS)
	552	return rates_a;
	553	else if (rates_a & SNDRV_PCM_RATE_KNOT)
	554	return rates_b;
	555	else if (rates_b & SNDRV_PCM_RATE_KNOT)
	556	return rates_a;
	557	return rates_a & rates_b;
	558	}
	559	EXPORT_SYMBOL_GPL(snd_pcm_rate_mask_intersect);