Root/include/sound/tlv.h

1#ifndef __SOUND_TLV_H
2#define __SOUND_TLV_H
3
4/*
5 * Advanced Linux Sound Architecture - ALSA - Driver
6 * Copyright (c) 2006 by Jaroslav Kysela <perex@perex.cz>
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/*
26 * TLV structure is right behind the struct snd_ctl_tlv:
27 * unsigned int type - see SNDRV_CTL_TLVT_*
28 * unsigned int length
29 * .... data aligned to sizeof(unsigned int), use
30 * block_length = (length + (sizeof(unsigned int) - 1)) &
31 * ~(sizeof(unsigned int) - 1)) ....
32 */
33
34#define SNDRV_CTL_TLVT_CONTAINER 0 /* one level down - group of TLVs */
35#define SNDRV_CTL_TLVT_DB_SCALE 1 /* dB scale */
36#define SNDRV_CTL_TLVT_DB_LINEAR 2 /* linear volume */
37#define SNDRV_CTL_TLVT_DB_RANGE 3 /* dB range container */
38#define SNDRV_CTL_TLVT_DB_MINMAX 4 /* dB scale with min/max */
39#define SNDRV_CTL_TLVT_DB_MINMAX_MUTE 5 /* dB scale with min/max with mute */
40
41#define TLV_ITEM(type, ...) \
42    (type), TLV_LENGTH(__VA_ARGS__), __VA_ARGS__
43#define TLV_LENGTH(...) \
44    ((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))
45
46#define TLV_CONTAINER_ITEM(...) \
47    TLV_ITEM(SNDRV_CTL_TLVT_CONTAINER, __VA_ARGS__)
48#define DECLARE_TLV_CONTAINER(name, ...) \
49    unsigned int name[] = { TLV_CONTAINER_ITEM(__VA_ARGS__) }
50
51#define TLV_DB_SCALE_MASK 0xffff
52#define TLV_DB_SCALE_MUTE 0x10000
53#define TLV_DB_SCALE_ITEM(min, step, mute) \
54    TLV_ITEM(SNDRV_CTL_TLVT_DB_SCALE, \
55         (min), \
56         ((step) & TLV_DB_SCALE_MASK) | \
57            ((mute) ? TLV_DB_SCALE_MUTE : 0))
58#define DECLARE_TLV_DB_SCALE(name, min, step, mute) \
59    unsigned int name[] = { TLV_DB_SCALE_ITEM(min, step, mute) }
60
61/* dB scale specified with min/max values instead of step */
62#define TLV_DB_MINMAX_ITEM(min_dB, max_dB) \
63    TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
64#define TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
65    TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
66#define DECLARE_TLV_DB_MINMAX(name, min_dB, max_dB) \
67    unsigned int name[] = { TLV_DB_MINMAX_ITEM(min_dB, max_dB) }
68#define DECLARE_TLV_DB_MINMAX_MUTE(name, min_dB, max_dB) \
69    unsigned int name[] = { TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) }
70
71/* linear volume between min_dB and max_dB (.01dB unit) */
72#define TLV_DB_LINEAR_ITEM(min_dB, max_dB) \
73    TLV_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
74#define DECLARE_TLV_DB_LINEAR(name, min_dB, max_dB) \
75    unsigned int name[] = { TLV_DB_LINEAR_ITEM(min_dB, max_dB) }
76
77/* dB range container:
78 * Items in dB range container must be ordered by their values and by their
79 * dB values. This implies that larger values must correspond with larger
80 * dB values (which is also required for all other mixer controls).
81 */
82/* Each item is: <min> <max> <TLV> */
83#define TLV_DB_RANGE_ITEM(...) \
84    TLV_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
85#define DECLARE_TLV_DB_RANGE(name, ...) \
86    unsigned int name[] = { TLV_DB_RANGE_ITEM(__VA_ARGS__) }
87/* The below assumes that each item TLV is 4 words like DB_SCALE or LINEAR */
88#define TLV_DB_RANGE_HEAD(num) \
89    SNDRV_CTL_TLVT_DB_RANGE, 6 * (num) * sizeof(unsigned int)
90
91#define TLV_DB_GAIN_MUTE -9999999
92
93/*
94 * channel-mapping TLV items
95 * TLV length must match with num_channels
96 */
97#define SNDRV_CTL_TLVT_CHMAP_FIXED 0x101 /* fixed channel position */
98#define SNDRV_CTL_TLVT_CHMAP_VAR 0x102 /* channels freely swappable */
99#define SNDRV_CTL_TLVT_CHMAP_PAIRED 0x103 /* pair-wise swappable */
100
101#endif /* __SOUND_TLV_H */
102

Archive Download this file



interactive