[mirror_ubuntu-bionic-kernel.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 = {},
	},
	/* 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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.
 *
 * Returns 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.
 *
 * Returns 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
 *
 * Returns 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
 *
 * Returns 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);
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	},
1da177e4 LT	143	/* FIXME: the following three formats are not defined properly yet */
	144	[SNDRV_PCM_FORMAT_MPEG] = {
	145	.le = -1, .signd = -1,
	146	},
	147	[SNDRV_PCM_FORMAT_GSM] = {
	148	.le = -1, .signd = -1,
	149	},
	150	[SNDRV_PCM_FORMAT_SPECIAL] = {
	151	.le = -1, .signd = -1,
	152	},
	153	[SNDRV_PCM_FORMAT_S24_3LE] = {
	154	.width = 24, .phys = 24, .le = 1, .signd = 1,
	155	.silence = {},
	156	},
	157	[SNDRV_PCM_FORMAT_S24_3BE] = {
	158	.width = 24, .phys = 24, .le = 0, .signd = 1,
	159	.silence = {},
	160	},
	161	[SNDRV_PCM_FORMAT_U24_3LE] = {
	162	.width = 24, .phys = 24, .le = 1, .signd = 0,
	163	.silence = { 0x00, 0x00, 0x80 },
	164	},
	165	[SNDRV_PCM_FORMAT_U24_3BE] = {
	166	.width = 24, .phys = 24, .le = 0, .signd = 0,
	167	.silence = { 0x80, 0x00, 0x00 },
	168	},
	169	[SNDRV_PCM_FORMAT_S20_3LE] = {
	170	.width = 20, .phys = 24, .le = 1, .signd = 1,
	171	.silence = {},
	172	},
	173	[SNDRV_PCM_FORMAT_S20_3BE] = {
	174	.width = 20, .phys = 24, .le = 0, .signd = 1,
	175	.silence = {},
	176	},
	177	[SNDRV_PCM_FORMAT_U20_3LE] = {
	178	.width = 20, .phys = 24, .le = 1, .signd = 0,
	179	.silence = { 0x00, 0x00, 0x08 },
	180	},
	181	[SNDRV_PCM_FORMAT_U20_3BE] = {
	182	.width = 20, .phys = 24, .le = 0, .signd = 0,
	183	.silence = { 0x08, 0x00, 0x00 },
	184	},
	185	[SNDRV_PCM_FORMAT_S18_3LE] = {
	186	.width = 18, .phys = 24, .le = 1, .signd = 1,
	187	.silence = {},
	188	},
	189	[SNDRV_PCM_FORMAT_S18_3BE] = {
	190	.width = 18, .phys = 24, .le = 0, .signd = 1,
	191	.silence = {},
	192	},
	193	[SNDRV_PCM_FORMAT_U18_3LE] = {
	194	.width = 18, .phys = 24, .le = 1, .signd = 0,
	195	.silence = { 0x00, 0x00, 0x02 },
	196	},
	197	[SNDRV_PCM_FORMAT_U18_3BE] = {
	198	.width = 18, .phys = 24, .le = 0, .signd = 0,
	199	.silence = { 0x02, 0x00, 0x00 },
	200	},
15c0cee6 BC	201	[SNDRV_PCM_FORMAT_G723_24_1B] = {
	202	.width = 3, .phys = 8, .le = -1, .signd = -1,
	203	.silence = {},
	204	},
	205	[SNDRV_PCM_FORMAT_G723_40_1B] = {
	206	.width = 5, .phys = 8, .le = -1, .signd = -1,
	207	.silence = {},
	208	},
1da177e4 LT	209	};
	210
	211
	212	/**
	213	* snd_pcm_format_signed - Check the PCM format is signed linear
	214	* @format: the format to check
	215	*
	216	* Returns 1 if the given PCM format is signed linear, 0 if unsigned
	217	* linear, and a negative error code for non-linear formats.
	218	*/
	219	int snd_pcm_format_signed(snd_pcm_format_t format)
	220	{
	221	int val;
fea952e5	222	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	223	return -EINVAL;
fea952e5	224	if ((val = pcm_formats[(INT)format].signd) < 0)
1da177e4 LT	225	return -EINVAL;
	226	return val;
	227	}
	228
e88e8ae6 TI	229	EXPORT_SYMBOL(snd_pcm_format_signed);
e88e8ae6 TI	230
1da177e4 LT	231	/**
	232	* snd_pcm_format_unsigned - Check the PCM format is unsigned linear
	233	* @format: the format to check
	234	*
	235	* Returns 1 if the given PCM format is unsigned linear, 0 if signed
	236	* linear, and a negative error code for non-linear formats.
	237	*/
	238	int snd_pcm_format_unsigned(snd_pcm_format_t format)
	239	{
	240	int val;
	241
	242	val = snd_pcm_format_signed(format);
	243	if (val < 0)
	244	return val;
	245	return !val;
	246	}
	247
e88e8ae6 TI	248	EXPORT_SYMBOL(snd_pcm_format_unsigned);
e88e8ae6 TI	249
1da177e4 LT	250	/**
	251	* snd_pcm_format_linear - Check the PCM format is linear
	252	* @format: the format to check
	253	*
	254	* Returns 1 if the given PCM format is linear, 0 if not.
	255	*/
	256	int snd_pcm_format_linear(snd_pcm_format_t format)
	257	{
	258	return snd_pcm_format_signed(format) >= 0;
	259	}
	260
e88e8ae6 TI	261	EXPORT_SYMBOL(snd_pcm_format_linear);
e88e8ae6 TI	262
1da177e4 LT	263	/**
	264	* snd_pcm_format_little_endian - Check the PCM format is little-endian
	265	* @format: the format to check
	266	*
	267	* Returns 1 if the given PCM format is little-endian, 0 if
	268	* big-endian, or a negative error code if endian not specified.
	269	*/
	270	int snd_pcm_format_little_endian(snd_pcm_format_t format)
	271	{
	272	int val;
fea952e5	273	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	274	return -EINVAL;
fea952e5	275	if ((val = pcm_formats[(INT)format].le) < 0)
1da177e4 LT	276	return -EINVAL;
	277	return val;
	278	}
	279
e88e8ae6 TI	280	EXPORT_SYMBOL(snd_pcm_format_little_endian);
e88e8ae6 TI	281
1da177e4 LT	282	/**
	283	* snd_pcm_format_big_endian - Check the PCM format is big-endian
	284	* @format: the format to check
	285	*
	286	* Returns 1 if the given PCM format is big-endian, 0 if
	287	* little-endian, or a negative error code if endian not specified.
	288	*/
	289	int snd_pcm_format_big_endian(snd_pcm_format_t format)
	290	{
	291	int val;
	292
	293	val = snd_pcm_format_little_endian(format);
	294	if (val < 0)
	295	return val;
	296	return !val;
	297	}
	298
e88e8ae6 TI	299	EXPORT_SYMBOL(snd_pcm_format_big_endian);
e88e8ae6 TI	300
1da177e4 LT	301	/**
	302	* snd_pcm_format_width - return the bit-width of the format
	303	* @format: the format to check
	304	*
	305	* Returns the bit-width of the format, or a negative error code
	306	* if unknown format.
	307	*/
	308	int snd_pcm_format_width(snd_pcm_format_t format)
	309	{
	310	int val;
fea952e5	311	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	312	return -EINVAL;
fea952e5	313	if ((val = pcm_formats[(INT)format].width) == 0)
1da177e4 LT	314	return -EINVAL;
	315	return val;
	316	}
	317
e88e8ae6 TI	318	EXPORT_SYMBOL(snd_pcm_format_width);
e88e8ae6 TI	319
1da177e4 LT	320	/**
	321	* snd_pcm_format_physical_width - return the physical bit-width of the format
	322	* @format: the format to check
	323	*
	324	* Returns the physical bit-width of the format, or a negative error code
	325	* if unknown format.
	326	*/
	327	int snd_pcm_format_physical_width(snd_pcm_format_t format)
	328	{
	329	int val;
fea952e5	330	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	331	return -EINVAL;
fea952e5	332	if ((val = pcm_formats[(INT)format].phys) == 0)
1da177e4 LT	333	return -EINVAL;
	334	return val;
	335	}
	336
e88e8ae6 TI	337	EXPORT_SYMBOL(snd_pcm_format_physical_width);
e88e8ae6 TI	338
1da177e4 LT	339	/**
	340	* snd_pcm_format_size - return the byte size of samples on the given format
	341	* @format: the format to check
a66547f3	342	* @samples: sampling rate
1da177e4 LT	343	*
	344	* Returns the byte size of the given samples for the format, or a
	345	* negative error code if unknown format.
	346	*/
	347	ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples)
	348	{
	349	int phys_width = snd_pcm_format_physical_width(format);
	350	if (phys_width < 0)
	351	return -EINVAL;
	352	return samples * phys_width / 8;
	353	}
	354
e88e8ae6 TI	355	EXPORT_SYMBOL(snd_pcm_format_size);
e88e8ae6 TI	356
1da177e4 LT	357	/**
	358	* snd_pcm_format_silence_64 - return the silent data in 8 bytes array
	359	* @format: the format to check
	360	*
	361	* Returns the format pattern to fill or NULL if error.
	362	*/
	363	const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format)
	364	{
fea952e5	365	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4	366	return NULL;
fea952e5	367	if (! pcm_formats[(INT)format].phys)
1da177e4	368	return NULL;
fea952e5	369	return pcm_formats[(INT)format].silence;
1da177e4 LT	370	}
1da177e4 LT	371
e88e8ae6 TI	372	EXPORT_SYMBOL(snd_pcm_format_silence_64);
e88e8ae6 TI	373
1da177e4 LT	374	/**
	375	* snd_pcm_format_set_silence - set the silence data on the buffer
	376	* @format: the PCM format
	377	* @data: the buffer pointer
	378	* @samples: the number of samples to set silence
	379	*
	380	* Sets the silence data on the buffer for the given samples.
	381	*
	382	* Returns zero if successful, or a negative error code on failure.
	383	*/
	384	int snd_pcm_format_set_silence(snd_pcm_format_t format, void *data, unsigned int samples)
	385	{
	386	int width;
	387	unsigned char dst, pat;
	388
fea952e5	389	if ((INT)format < 0 \|\| (INT)format > (INT)SNDRV_PCM_FORMAT_LAST)
1da177e4 LT	390	return -EINVAL;
	391	if (samples == 0)
	392	return 0;
fea952e5 CL	393	width = pcm_formats[(INT)format].phys; /* physical width */
fea952e5 CL	394	pat = pcm_formats[(INT)format].silence;
1da177e4 LT	395	if (! width)
	396	return -EINVAL;
	397	/* signed or 1 byte data */
fea952e5	398	if (pcm_formats[(INT)format].signd == 1 \|\| width <= 8) {
1da177e4 LT	399	unsigned int bytes = samples * width / 8;
	400	memset(data, *pat, bytes);
	401	return 0;
	402	}
	403	/* non-zero samples, fill using a loop */
	404	width /= 8;
	405	dst = data;
	406	#if 0
	407	while (samples--) {
	408	memcpy(dst, pat, width);
	409	dst += width;
	410	}
	411	#else
	412	/* a bit optimization for constant width */
	413	switch (width) {
	414	case 2:
	415	while (samples--) {
	416	memcpy(dst, pat, 2);
	417	dst += 2;
	418	}
	419	break;
	420	case 3:
	421	while (samples--) {
	422	memcpy(dst, pat, 3);
	423	dst += 3;
	424	}
	425	break;
	426	case 4:
	427	while (samples--) {
	428	memcpy(dst, pat, 4);
	429	dst += 4;
	430	}
	431	break;
	432	case 8:
	433	while (samples--) {
	434	memcpy(dst, pat, 8);
	435	dst += 8;
	436	}
	437	break;
	438	}
	439	#endif
	440	return 0;
	441	}
	442
e88e8ae6 TI	443	EXPORT_SYMBOL(snd_pcm_format_set_silence);
e88e8ae6 TI	444
1da177e4 LT	445	/**
	446	* snd_pcm_limit_hw_rates - determine rate_min/rate_max fields
	447	* @runtime: the runtime instance
	448	*
	449	* Determines the rate_min and rate_max fields from the rates bits of
	450	* the given runtime->hw.
	451	*
	452	* Returns zero if successful.
	453	*/
877211f5	454	int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime)
1da177e4	455	{
1da177e4	456	int i;
7653d557	457	for (i = 0; i < (int)snd_pcm_known_rates.count; i++) {
1da177e4	458	if (runtime->hw.rates & (1 << i)) {
7653d557	459	runtime->hw.rate_min = snd_pcm_known_rates.list[i];
1da177e4 LT	460	break;
	461	}
	462	}
7653d557	463	for (i = (int)snd_pcm_known_rates.count - 1; i >= 0; i--) {
1da177e4	464	if (runtime->hw.rates & (1 << i)) {
7653d557	465	runtime->hw.rate_max = snd_pcm_known_rates.list[i];
1da177e4 LT	466	break;
	467	}
	468	}
	469	return 0;
	470	}
e88e8ae6 TI	471
e88e8ae6 TI	472	EXPORT_SYMBOL(snd_pcm_limit_hw_rates);
918f3a0e CL	473
	474	/**
	475	* snd_pcm_rate_to_rate_bit - converts sample rate to SNDRV_PCM_RATE_xxx bit
	476	* @rate: the sample rate to convert
	477	*
	478	* Returns the SNDRV_PCM_RATE_xxx flag that corresponds to the given rate, or
	479	* SNDRV_PCM_RATE_KNOT for an unknown rate.
	480	*/
	481	unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate)
	482	{
	483	unsigned int i;
	484
	485	for (i = 0; i < snd_pcm_known_rates.count; i++)
	486	if (snd_pcm_known_rates.list[i] == rate)
	487	return 1u << i;
	488	return SNDRV_PCM_RATE_KNOT;
	489	}
	490	EXPORT_SYMBOL(snd_pcm_rate_to_rate_bit);
4be77a53 DP	491
	492	/**
	493	* snd_pcm_rate_bit_to_rate - converts SNDRV_PCM_RATE_xxx bit to sample rate
	494	* @rate_bit: the rate bit to convert
	495	*
	496	* Returns the sample rate that corresponds to the given SNDRV_PCM_RATE_xxx flag
	497	* or 0 for an unknown rate bit
	498	*/
	499	unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit)
	500	{
	501	unsigned int i;
	502
	503	for (i = 0; i < snd_pcm_known_rates.count; i++)
	504	if ((1u << i) == rate_bit)
	505	return snd_pcm_known_rates.list[i];
	506	return 0;
	507	}
	508	EXPORT_SYMBOL(snd_pcm_rate_bit_to_rate);