ALSA project - the C library reference
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
use-case.h
Go to the documentation of this file.
1 
10 /*
11  *
12  * This library is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU Lesser General Public License as
14  * published by the Free Software Foundation; either version 2.1 of
15  * the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Copyright (C) 2008-2010 SlimLogic Ltd
27  * Copyright (C) 2010 Wolfson Microelectronics PLC
28  * Copyright (C) 2010 Texas Instruments Inc.
29  *
30  * Support for the verb/device/modifier core logic and API,
31  * command line tool and file parser was kindly sponsored by
32  * Texas Instruments Inc.
33  * Support for multiple active modifiers and devices,
34  * transition sequences, multiple client access and user defined use
35  * cases was kindly sponsored by Wolfson Microelectronics PLC.
36  */
37 
38 #ifndef __ALSA_USE_CASE_H
39 #define __ALSA_USE_CASE_H
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
93 /*
94  * Use Case Verb.
95  *
96  * The use case verb is the main device audio action. e.g. the "HiFi" use
97  * case verb will configure the audio hardware for HiFi Music playback
98  * and capture.
99  */
100 #define SND_USE_CASE_VERB_INACTIVE "Inactive"
101 #define SND_USE_CASE_VERB_HIFI "HiFi"
102 #define SND_USE_CASE_VERB_HIFI_LOW_POWER "HiFi Low Power"
103 #define SND_USE_CASE_VERB_VOICE "Voice"
104 #define SND_USE_CASE_VERB_VOICE_LOW_POWER "Voice Low Power"
105 #define SND_USE_CASE_VERB_VOICECALL "Voice Call"
106 #define SND_USE_CASE_VERB_IP_VOICECALL "Voice Call IP"
107 #define SND_USE_CASE_VERB_ANALOG_RADIO "FM Analog Radio"
108 #define SND_USE_CASE_VERB_DIGITAL_RADIO "FM Digital Radio"
109 /* add new verbs to end of list */
110 
111 
112 /*
113  * Use Case Device.
114  *
115  * Physical system devices the render and capture audio. Devices can be OR'ed
116  * together to support audio on simultaneous devices.
117  */
118 #define SND_USE_CASE_DEV_NONE "None"
119 #define SND_USE_CASE_DEV_SPEAKER "Speaker"
120 #define SND_USE_CASE_DEV_LINE "Line"
121 #define SND_USE_CASE_DEV_HEADPHONES "Headphones"
122 #define SND_USE_CASE_DEV_HEADSET "Headset"
123 #define SND_USE_CASE_DEV_HANDSET "Handset"
124 #define SND_USE_CASE_DEV_BLUETOOTH "Bluetooth"
125 #define SND_USE_CASE_DEV_EARPIECE "Earpiece"
126 #define SND_USE_CASE_DEV_SPDIF "SPDIF"
127 #define SND_USE_CASE_DEV_HDMI "HDMI"
128 /* add new devices to end of list */
129 
130 
131 /*
132  * Use Case Modifiers.
133  *
134  * The use case modifier allows runtime configuration changes to deal with
135  * asynchronous events.
136  *
137  * e.g. to record a voice call :-
138  * 1. Set verb to SND_USE_CASE_VERB_VOICECALL (for voice call)
139  * 2. Set modifier SND_USE_CASE_MOD_CAPTURE_VOICE when capture required.
140  * 3. Call snd_use_case_get("CapturePCM") to get ALSA source PCM name
141  * with captured voice pcm data.
142  *
143  * e.g. to play a ring tone when listenin to MP3 Music :-
144  * 1. Set verb to SND_USE_CASE_VERB_HIFI (for MP3 playback)
145  * 2. Set modifier to SND_USE_CASE_MOD_PLAY_TONE when incoming call happens.
146  * 3. Call snd_use_case_get("PlaybackPCM") to get ALSA PCM sink name for
147  * ringtone pcm data.
148  */
149 #define SND_USE_CASE_MOD_CAPTURE_VOICE "Capture Voice"
150 #define SND_USE_CASE_MOD_CAPTURE_MUSIC "Capture Music"
151 #define SND_USE_CASE_MOD_PLAY_MUSIC "Play Music"
152 #define SND_USE_CASE_MOD_PLAY_VOICE "Play Voice"
153 #define SND_USE_CASE_MOD_PLAY_TONE "Play Tone"
154 #define SND_USE_CASE_MOD_ECHO_REF "Echo Reference"
155 /* add new modifiers to end of list */
156 
157 
166 #define SND_USE_CASE_TQ_MUSIC "Music"
167 #define SND_USE_CASE_TQ_VOICE "Voice"
168 #define SND_USE_CASE_TQ_TONES "Tones"
171 typedef struct snd_use_case_mgr snd_use_case_mgr_t;
172 
179 char *snd_use_case_identifier(const char *fmt, ...);
180 
187 int snd_use_case_free_list(const char *list[], int items);
188 
215 int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr,
216  const char *identifier,
217  const char **list[]);
218 
219 
273 int snd_use_case_get(snd_use_case_mgr_t *uc_mgr,
274  const char *identifier,
275  const char **value);
276 
288 int snd_use_case_geti(snd_use_case_mgr_t *uc_mgr,
289  const char *identifier,
290  long *value);
291 
314 int snd_use_case_set(snd_use_case_mgr_t *uc_mgr,
315  const char *identifier,
316  const char *value);
317 
324 int snd_use_case_mgr_open(snd_use_case_mgr_t **uc_mgr, const char *card_name);
325 
326 
332 int snd_use_case_mgr_reload(snd_use_case_mgr_t *uc_mgr);
333 
339 int snd_use_case_mgr_close(snd_use_case_mgr_t *uc_mgr);
340 
346 int snd_use_case_mgr_reset(snd_use_case_mgr_t *uc_mgr);
347 
348 /*
349  * helper functions
350  */
351 
357 static __inline__ int snd_use_case_card_list(const char **list[])
358 {
359  return snd_use_case_get_list(NULL, NULL, list);
360 }
361 
368 static __inline__ int snd_use_case_verb_list(snd_use_case_mgr_t *uc_mgr,
369  const char **list[])
370 {
371  return snd_use_case_get_list(uc_mgr, "_verbs", list);
372 }
373 
378 #ifdef __cplusplus
379 }
380 #endif
381 
382 #endif /* __ALSA_USE_CASE_H */