[alsa-devel] [PATCH 0/3] alsa-lib: UCM - Use Case Manager
This patch series follows on from the RFC and adds sound card hardware Use Case Management support to alsa-lib.
The main features of UCM are :-
o Abstraction of sound card hardware routing and controls into high level use case verbs, devices and modifiers. o Discovery of source/sink PCMs for each use case. o Discovery of hardware master volume controls for each use case.
It's intended UCM will provide clients (like pulseaudio) complete control over hardware signal routing within a sound card without any knowledge of the sound card hardware.
Use case definintions are stored in text files (per sound card) and are now divided into three components as descibed in the RFC.
A working use case definition file can be found here :-
http://git.slimlogic.co.uk/cgi-bin/cgit.cgi/alsa-ucm-conf.git/tree/cards/SDP...
The three components of a use case are now :-
1) Verb (or action). This is mandatory and describes (in terms of ALSA control settings) the system use case action. e.g "Phone Call", "Music Playback".
2) Device. This is also mandatory and describes the audio playback or capture device. e.g. "Handset", "Bluetooth", "Headset".
3) Modifier. This is optional and is used to modify the current use case verb. i.e. The user could be listening to music when an incoming phone call requires that a ring tone is played. In this case the use case verb would be set to "Music Playback" when the music playback started and then the "Tone Playback" modifier could be enabled to play the ring tone. The use case verb would then be changed to "Voice Call" if the call was accepted.
Patch 2/3 is a little on the large side so, I've included a link if it gets bounced by the list.
http://git.slimlogic.co.uk/cgi-bin/cgit.cgi/alsa-lib.git/commit/?h=ucm-upstr...
Liam Girdwood (3): ucm: header - ALSA Use Case Manager ucm: core - Add initial Use Case Manager support. ucm: build - add build support for Use Case Manager
doc/doxygen.cfg.in | 1 + include/Makefile.am | 2 +- include/use-case.h | 427 +++++++ src/Makefile.am | 2 +- src/use-case.c | 3515 +++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 3945 insertions(+), 2 deletions(-) create mode 100644 include/use-case.h create mode 100644 src/use-case.c
This patch adds the API header for alsa-lib Use Case Management support.
This file defines the public interface exported by UCM to client applications.
UCM development has been kindly sponsored by Texas Instruments Inc, Wolfson Microelectronics PLC and Slimlogic Ltd.
CC: Mark Brown broonie@opensource.wolfsonmicro.com Signed-off-by: Stefan Schmidt stefan@slimlogic.co.uk Signed-off-by: Jaroslav Kysela perex@perex.cz Signed-off-by: Justin Xu justinx@slimlogic.co.uk Signed-off-by: Liam Girdwood lrg@slimlogic.co.uk --- include/use-case.h | 427 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 427 insertions(+), 0 deletions(-) create mode 100644 include/use-case.h
diff --git a/include/use-case.h b/include/use-case.h new file mode 100644 index 0000000..18fe4d6 --- /dev/null +++ b/include/use-case.h @@ -0,0 +1,427 @@ +/** + * \file include/use-case.h + * \brief use case interface for the ALSA driver + * \author Liam Girdwood lrg@slimlogic.co.uk + * \author Stefan Schmidt stefan@slimlogic.co.uk + * \author Jaroslav Kysela perex@perex.cz + * \author Justin Xu justinx@slimlogic.co.uk + * \date 2008-2010 + */ +/* + * + * This library is free software; you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser 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 + * + * Copyright (C) 2008-2010 SlimLogic Ltd + * Copyright (C) 2010 Wolfson Microelectronics PLC + * Copyright (C) 2010 Texas Instruments Inc. + * + * Support for the verb/device/modifier core logic and API, + * command line tool and file parser was kindly sponsored by + * Texas Instruments Inc. + * Support for multiple active modifiers and devices, + * transition sequences, multiple client access and user defined use + * cases was kindly sponsored by Wolfson Microelectronics PLC. + */ + +#ifndef __ALSA_USE_CASE_H +#define __ALSA_USE_CASE_H + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * \defgroup Use Case Interface + * The ALSA Use Case manager interface. + * See \ref Usecase page for more details. + * { + */ + +/** + * ALSA Use Case Interface + * + * The use case manager works by configuring the sound card ALSA kcontrols to + * change the hardware digital and analog audio routing to match the requested + * device use case. The use case manager kcontrol configurations are stored in + * easy to modify text files. + * + * An audio use case can be defined by a verb and device parameter. The verb + * describes the use case action i.e. a phone call, listening to music, recording + * a conversation etc. The device describes the physical audio capture and playback + * hardware i.e. headphones, phone handset, bluetooth headset, etc. + * + * It's intended clients will mostly only need to set the use case verb and + * device for each system use case change (as the verb and device parameters + * cover most audio use cases). + * + * However there are times when a use case has to be modified at runtime. e.g. + * + * o Incoming phone call when the device is playing music + * o Recording sections of a phone call + * o Playing tones during a call. + * + * In order to allow asynchronous runtime use case adaptations, we have a third + * optional modifier parameter that can be used to further configure + * the use case during live audio runtime. + * + * This interface allows clients to :- + * + * o Query the supported use case verbs, devices and modifiers for the machine. + * o Set and Get use case verbs, devices and modifiers for the machine. + * o Get the ALSA PCM playback and capture device PCMs for use case verb and + * modifier. + * o Get the QoS parameter for each use case verb and modifier. + * o Get the ALSA master playback and capture volume/switch kcontrols + * for each use case. + */ + + +/* + * Use Case Verb. + * + * The use case verb is the main device audio action. e.g. the "HiFi" use + * case verb will configure the audio hardware for HiFi Music playback + * and capture. + */ +#define SND_USE_CASE_VERB_INACTIVE "Inactive" +#define SND_USE_CASE_VERB_HIFI "HiFi" +#define SND_USE_CASE_VERB_HIFI_LOW_POWER "HiFi Low Power" +#define SND_USE_CASE_VERB_VOICE "Voice" +#define SND_USE_CASE_VERB_VOICE_LOW_POWER "Voice Low Power" +#define SND_USE_CASE_VERB_VOICECALL "Voice Call" +#define SND_USE_CASE_VERB_IP_VOICECALL "Voice Call IP" +#define SND_USE_CASE_VERB_ANALOG_RADIO "FM Analog Radio" +#define SND_USE_CASE_VERB_DIGITAL_RADIO "FM Digital Radio" +/* add new verbs to end of list */ + + +/* + * Use Case Device. + * + * Physical system devices the render and capture audio. Devices can be OR'ed + * together to support audio on similtanious devices. + */ +#define SND_USE_CASE_DEV_NONE "None" +#define SND_USE_CASE_DEV_SPEAKER "Speaker" +#define SND_USE_CASE_DEV_LINE "Line" +#define SND_USE_CASE_DEV_HEADPHONES "Headphones" +#define SND_USE_CASE_DEV_HEADSET "Headset" +#define SND_USE_CASE_DEV_HANDSET "Handset" +#define SND_USE_CASE_DEV_BLUETOOTH "Bluetooth" +#define SND_USE_CASE_DEV_EARPIECE "Earpiece" +#define SND_USE_CASE_DEV_SPDIF "SPDIF" +#define SND_USE_CASE_DEV_HDMI "HDMI" +/* add new devices to end of list */ + + +/* + * Use Case Modifiers. + * + * The use case modifier allows runtime configuration changes to deal with + * asynchronous events. + * + * e.g. to record a voice call :- + * 1. Set verb to SND_USE_CASE_VERB_VOICECALL (for voice call) + * 2. Set modifier SND_USE_CASE_MOD_CAPTURE_VOICE when capture required. + * 3. Call snd_use_case_get_verb_capture_pcm() to get ALSA source PCM + * with captured voice pcm data. + * + * e.g. to play a ring tone when listenin to MP3 Music :- + * 1. Set verb to SND_USE_CASE_VERB_HIFI (for MP3 playback) + * 2. Set modifier to SND_USE_CASE_MOD_PLAY_TONE when incoming call happens. + * 3. Call snd_use_case_get_verb_playback_pcm() to get ALSA PCM sink for + * ringtone pcm data. + */ +#define SND_USE_CASE_MOD_CAPTURE_VOICE "Capture Voice" +#define SND_USE_CASE_MOD_CAPTURE_MUSIC "Capture Music" +#define SND_USE_CASE_MOD_PLAY_MUSIC "Play Music" +#define SND_USE_CASE_MOD_PLAY_VOICE "Play Voice" +#define SND_USE_CASE_MOD_PLAY_TONE "Play Tone" +#define SND_USE_CASE_MOD_ECHO_REF "Echo Reference" +/* add new modifiers to end of list */ + + +/** + * QoS - Quality of Service + * + * The interface allows clients to determine the audio QoS required for each + * use case verb and modifier. It's intended as an optional hint to the + * audio driver in order to lower power consumption. + * + */ +enum snd_use_case_qos { + SND_USE_CASE_QOS_UNKNOWN, + SND_USE_CASE_QOS_MUSIC, + SND_USE_CASE_QOS_VOICE, + SND_USE_CASE_QOS_TONES, +}; + +/* + * Use Case Control Aliases. + * + * Use cases often use different internal hardware paths to route digital and + * analog audio. This can mean different controls are used to change volumes + * depending on the particular use case. This interface allows clients to + * find out the hardware controls associated with each use case. + */ +enum snd_use_case_control_alias { + SND_USE_CASE_ALIAS_PLAYBACK_VOLUME = 0, + SND_USE_CASE_ALIAS_PLAYBACK_SWITCH, + SND_USE_CASE_ALIAS_CAPTURE_VOLUME, + SND_USE_CASE_ALIAS_CAPTURE_SWITCH, +}; + +/** use case container */ +typedef struct snd_use_case_mgr snd_use_case_mgr_t; + +/** + * \brief List supported use case verbs for given soundcard + * \param uc_mgr Use case manager + * \param verb Returned list of supported use case verbs + * \return Number of use case verbs if success, otherwise a negative error code + */ +int snd_use_case_get_verb_list(snd_use_case_mgr_t *uc_mgr, const char **verb[]); + +/** + * \brief List supported use case devices for given use case verb + * \param uc_mgr Use case manager + * \param verb Verb name. + * \param device Returned list of supported use case devices + * \return Number of use case devices if success, otherwise a negative error code + */ +int snd_use_case_get_device_list(snd_use_case_mgr_t *uc_mgr, + const char *verb, const char **device[]); + +/** + * \brief List supported use case verb modifiers for given verb + * \param uc_mgr use case manager + * \param verb verb id. + * \param mod returned list of supported use case modifier id and names + * \return number of use case modifiers if success, otherwise a negative error code + */ +int snd_use_case_get_mod_list(snd_use_case_mgr_t *uc_mgr, + const char *verb, const char **mod[]); + +/** + * \brief Get current use case verb for sound card + * \param uc_mgr Use case manager + * \return Verb if success, otherwise NULL + */ +const char *snd_use_case_get_verb(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Set new use case verb for sound card + * \param uc_mgr Use case manager + * \param verb Verb + * \return Zero if success, otherwise a negative error code + */ +int snd_use_case_set_verb(snd_use_case_mgr_t *uc_mgr, const char *verb); + +/** + * \brief Enable use case device for current use case verb + * \param uc_mgr Use case manager + * \param device Device + * \return Zero if success, otherwise a negative error code + */ +int snd_use_case_enable_device(snd_use_case_mgr_t *uc_mgr, const char *device); + +/** + * \brief Disable use case device for current use case verb + * \param uc_mgr Use case manager + * \param device Device + * \return Zero if success, otherwise a negative error code + */ +int snd_use_case_disable_device(snd_use_case_mgr_t *uc_mgr, const char *device); + +/** + * \brief Disable old_device and then enable new_device. + * If from_device is not enabled just return. + * Check transmit sequence firstly. + * \param uc_mgr Use case manager + * \param old the device to be closed + * \param new the device to be opened + * \return 0 = successful negative = error + */ +int snd_use_case_switch_device(snd_use_case_mgr_t *uc_mgr, + const char *old, const char *new); + + +/** + * \brief Enable use case modifier for current use case verb + * \param uc_mgr Use case manager + * \param modifier Modifier + * \return Zero if success, otherwise a negative error code + */ +int snd_use_case_enable_modifier(snd_use_case_mgr_t *uc_mgr, + const char *modifier); + +/** + * \brief Disable use case modifier for curent use case verb + * \param uc_mgr Use case manager + * \param modifier Modifier + * \return Zero if success, otherwise a negative error code + */ +int snd_use_case_disable_modifier(snd_use_case_mgr_t *uc_mgr, + const char *modifier); + +/** + * \brief Disable old_modifier and then enable new_modifier. + * If old_modifier is not enabled just return. + * Check transmit sequence firstly. + * \param uc_mgr Use case manager + * \param old the modifier to be closed + * \param new the modifier to be opened + * \return 0 = successful negative = error + */ +int snd_use_case_switch_modifier(snd_use_case_mgr_t *uc_mgr, + const char *old, const char *new); + +/** + * \brief Get device status for current use case verb + * \param uc_mgr Use case manager + * \param device_name The device we are interested in. + * \return - 1 = enabled, 0 = disabled, negative = error + */ +int snd_use_case_get_device_status(snd_use_case_mgr_t *uc_mgr, + const char *device_name); + +/** + * \brief Get modifier status for current use case verb + * \param uc_mgr Use case manager + * \param device_name The device we are interested in. + * \return - 1 = enabled, 0 = disabled, negative = error + */ +int snd_use_case_get_modifier_status(snd_use_case_mgr_t *uc_mgr, + const char *modifier_name); + +/** + * \brief Get the current use case verb QoS + * \param uc_mgr Use case manager + * \return QoS level + */ +enum snd_use_case_qos snd_use_case_get_verb_qos(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Get use case modifier QoS + * \param uc_mgr use case manager + * \param modifier Modifier + * \return QoS level + */ +enum snd_use_case_qos snd_use_case_get_mod_qos(snd_use_case_mgr_t *uc_mgr, + const char *modifier); + +/** + * \brief Get the current use case verb playback PCM sink ID. + * \param uc_mgr use case manager + * \return PCM number if success, otherwise negative + */ +int snd_use_case_get_verb_playback_pcm(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Get the current use case verb capture PCM source ID + * \param uc_mgr Use case manager + * \return PCM number if success, otherwise negative + */ +int snd_use_case_get_verb_capture_pcm(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Get use case modifier playback PCM sink ID + * \param uc_mgr Use case manager + * \param modifier Modifier + * \return PCM number if success, otherwise negative + */ +int snd_use_case_get_mod_playback_pcm(snd_use_case_mgr_t *uc_mgr, + const char *modifier); + +/** + * \brief Get use case modifier capture PCM source ID + * \param uc_mgr Use case manager + * \param modifier Modifier + * \return PCM number if success, otherwise negative + */ +int snd_use_case_get_mod_capture_pcm(snd_use_case_mgr_t *uc_mgr, + const char *modifier); + +/** + * \brief Get ALSA volume/mute control names depending on use case device. + * \param uc_mgr Use case manager + * \param type The control type we are looking for + * \param device The device we are interested in. + * \return name if success, otherwise NULL + * + * Get the control name for common volume and mute controls that are aliased + * in the current use case verb. + */ +const char *snd_use_case_get_device_ctl_elem_id(snd_use_case_mgr_t *uc_mgr, + enum snd_use_case_control_alias type, const char *device); + +/** + * \brief Get ALSA volume/mute control names depending on use case modifier. + * \param uc_mgr Use case manager + * \param type The control type we are looking for + * \param modifier The modifier we are interested in. + * \return name if success, otherwise NULL + * + * Get the control name for common volume and mute controls that are aliased + * in the current use case modifier. + */ +const char *snd_use_case_get_modifier_ctl_elem_id(snd_use_case_mgr_t *uc_mgr, + enum snd_use_case_control_alias type, const char *modifier); + +/** + * \brief Open and initialise use case core for sound card + * \param card_name Sound card name. + * \return Use case handle if success, otherwise NULL + */ +snd_use_case_mgr_t *snd_use_case_mgr_open(const char *card_name); + + +/** + * \brief Reload and re-parse use case configuration files for sound card. + * \param uc_mgr Use case manager + * \return zero if success, otherwise a negative error code + */ +int snd_use_case_mgr_reload(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Close use case manager + * \param uc_mgr Use case manager + * \return zero if success, otherwise a negative error code + */ +int snd_use_case_mgr_close(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Reset use case manager verb, device, modifier to deafult settings. + * \param uc_mgr Use case manager + * \return zero if success, otherwise a negative error code + */ +int snd_use_case_mgr_reset(snd_use_case_mgr_t *uc_mgr); + +/** + * \brief Dump current sound card use case control settings + * \param card_name Sound card name + * \return zero if success, otherwise a negative error code + */ +int snd_use_case_dump(const char *card_name); + +/** + * } + */ + +#ifdef __cplusplus +} +#endif + +#endif /* __ALSA_USE_CASE_H */
Hi Liam,
On Mon, Aug 23, 2010 at 11:17 AM, Liam Girdwood lrg@slimlogic.co.uk wrote:
This patch adds the API header for alsa-lib Use Case Management support.
This file defines the public interface exported by UCM to client applications.
UCM development has been kindly sponsored by Texas Instruments Inc, Wolfson Microelectronics PLC and Slimlogic Ltd.
CC: Mark Brown broonie@opensource.wolfsonmicro.com Signed-off-by: Stefan Schmidt stefan@slimlogic.co.uk Signed-off-by: Jaroslav Kysela perex@perex.cz Signed-off-by: Justin Xu justinx@slimlogic.co.uk Signed-off-by: Liam Girdwood lrg@slimlogic.co.uk
include/use-case.h | 427 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 427 insertions(+), 0 deletions(-) create mode 100644 include/use-case.h
[...]
+/**
- \brief Get ALSA volume/mute control names depending on use case device.
- \param uc_mgr Use case manager
- \param type The control type we are looking for
- \param device The device we are interested in.
- \return name if success, otherwise NULL
- Get the control name for common volume and mute controls that are aliased
- in the current use case verb.
- */
+const char *snd_use_case_get_device_ctl_elem_id(snd_use_case_mgr_t *uc_mgr,
- enum snd_use_case_control_alias type, const char *device);
+/**
- \brief Get ALSA volume/mute control names depending on use case modifier.
- \param uc_mgr Use case manager
- \param type The control type we are looking for
- \param modifier The modifier we are interested in.
- \return name if success, otherwise NULL
- Get the control name for common volume and mute controls that are aliased
- in the current use case modifier.
- */
+const char *snd_use_case_get_modifier_ctl_elem_id(snd_use_case_mgr_t *uc_mgr,
- enum snd_use_case_control_alias type, const char *modifier);
It would appear that the implementations of the above two functions are named differently in src/use-case.c:
const char *snd_use_case_get_device_ctl_elem_name(...) const char *snd_use_case_get_modifier_ctl_elem_name(...)
Regards,
Chris
On Tue, 2010-08-24 at 14:09 -0500, Chris Winter wrote:
Hi Liam,
On Mon, Aug 23, 2010 at 11:17 AM, Liam Girdwood lrg@slimlogic.co.uk wrote:
This patch adds the API header for alsa-lib Use Case Management support.
This file defines the public interface exported by UCM to client applications.
UCM development has been kindly sponsored by Texas Instruments Inc, Wolfson Microelectronics PLC and Slimlogic Ltd.
CC: Mark Brown broonie@opensource.wolfsonmicro.com Signed-off-by: Stefan Schmidt stefan@slimlogic.co.uk Signed-off-by: Jaroslav Kysela perex@perex.cz Signed-off-by: Justin Xu justinx@slimlogic.co.uk Signed-off-by: Liam Girdwood lrg@slimlogic.co.uk
include/use-case.h | 427 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 427 insertions(+), 0 deletions(-) create mode 100644 include/use-case.h
[...]
+/**
- \brief Get ALSA volume/mute control names depending on use case device.
- \param uc_mgr Use case manager
- \param type The control type we are looking for
- \param device The device we are interested in.
- \return name if success, otherwise NULL
- Get the control name for common volume and mute controls that are aliased
- in the current use case verb.
- */
+const char *snd_use_case_get_device_ctl_elem_id(snd_use_case_mgr_t *uc_mgr,
enum snd_use_case_control_alias type, const char *device);+/**
- \brief Get ALSA volume/mute control names depending on use case modifier.
- \param uc_mgr Use case manager
- \param type The control type we are looking for
- \param modifier The modifier we are interested in.
- \return name if success, otherwise NULL
- Get the control name for common volume and mute controls that are aliased
- in the current use case modifier.
- */
+const char *snd_use_case_get_modifier_ctl_elem_id(snd_use_case_mgr_t *uc_mgr,
enum snd_use_case_control_alias type, const char *modifier);It would appear that the implementations of the above two functions are named differently in src/use-case.c:
const char *snd_use_case_get_device_ctl_elem_name(...) const char *snd_use_case_get_modifier_ctl_elem_name(...)
Ah, they are indeed. I'll fix up.
Thanks !
Liam
Add doxygen and make support for UCM.
CC: Mark Brown broonie@opensource.wolfsonmicro.com Signed-off-by: Justin Xu justinx@slimlogic.co.uk Signed-off-by: Stefan Schmidt stefan@slimlogic.co.uk Signed-off-by: Liam Girdwood lrg@slimlogic.co.uk --- doc/doxygen.cfg.in | 1 + include/Makefile.am | 2 +- src/Makefile.am | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in index 8606c48..3929772 100644 --- a/doc/doxygen.cfg.in +++ b/doc/doxygen.cfg.in @@ -28,6 +28,7 @@ INPUT = @top_srcdir@/doc/index.doxygen \ @top_srcdir@/include/pcm_ioplug.h \ @top_srcdir@/include/control_external.h \ @top_srcdir@/include/mixer.h \ + @top_srcdir@/include/use-case.h \ @top_srcdir@/src/error.c \ @top_srcdir@/src/dlmisc.c \ @top_srcdir@/src/async.c \ diff --git a/include/Makefile.am b/include/Makefile.am index a291503..de37f2c 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -5,7 +5,7 @@ alsaincludedir = ${includedir}/alsa
alsainclude_HEADERS = asoundlib.h asoundef.h \ version.h global.h input.h output.h error.h \ - conf.h control.h iatomic.h + conf.h control.h iatomic.h use-case.h
if BUILD_CTL_PLUGIN_EXT alsainclude_HEADERS += control_external.h diff --git a/src/Makefile.am b/src/Makefile.am index 3204fe4..7206dbd 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -14,7 +14,7 @@ SYMFUNCS = endif
lib_LTLIBRARIES = libasound.la -libasound_la_SOURCES = conf.c confmisc.c input.c output.c async.c error.c dlmisc.c socket.c shmarea.c userfile.c names.c +libasound_la_SOURCES = conf.c confmisc.c input.c output.c async.c error.c dlmisc.c socket.c shmarea.c userfile.c names.c use-case.c
SUBDIRS=control libasound_la_LIBADD = control/libcontrol.la
On Mon, 23 Aug 2010, Liam Girdwood wrote:
This patch series follows on from the RFC and adds sound card hardware Use Case Management support to alsa-lib.
Liam, can you give a URL for anonymous GIT repository with these patches?
Unfortunately, I have many ideas to improve the API before I can approve or recommend the inclusion to the alsa-lib's tree.
Jaroslav
----- Jaroslav Kysela perex@perex.cz Linux Kernel Sound Maintainer ALSA Project, Red Hat, Inc.
On Mon, Aug 23, 2010 at 06:50:07PM +0100, Mark Brown wrote:
On Mon, Aug 23, 2010 at 07:47:37PM +0200, Jaroslav Kysela wrote:
Liam, can you give a URL for anonymous GIT repository with these patches?
git://git.slimlogic.co.uk/alsa-ucm-conf.git
is in the root of the cgit repo (this is standard for both cgit and gitweb).
Sorry, wrong repo. You want git://git.slimlogic.co.uk/alsa-lib.git instead.
On Mon, 2010-08-23 at 19:47 +0200, Jaroslav Kysela wrote:
On Mon, 23 Aug 2010, Liam Girdwood wrote:
This patch series follows on from the RFC and adds sound card hardware Use Case Management support to alsa-lib.
Liam, can you give a URL for anonymous GIT repository with these patches?
There is also a testing tool called alsaucm in the ucm-upstream branch of the alsa-utils git repo here :-
git://git.slimlogic.co.uk/alsa-utils.git
This will probably be useful if you are testing your ideas.
There are also some initial configuration files here :-
git://git.slimlogic.co.uk/alsa-ucm-conf.git
Unfortunately, I have many ideas to improve the API before I can approve or recommend the inclusion to the alsa-lib's tree.
I wish you had shared your API ideas with us at the time of the RFC. A lot of time and effort has since went into UCM development :-/
Can you share your ideas atm, or do you have some patches planned ?
Thanks
Liam
On Tue, 24 Aug 2010, Liam Girdwood wrote:
On Mon, 2010-08-23 at 19:47 +0200, Jaroslav Kysela wrote:
Unfortunately, I have many ideas to improve the API before I can approve or recommend the inclusion to the alsa-lib's tree.
I wish you had shared your API ideas with us at the time of the RFC. A lot of time and effort has since went into UCM development :-/
I too. My big problem is the lack of time.
I tried to rethink the API to be more universal for future extensions (but the implementation will not dramatically change and the mechanisms you want to expose are not touched at all). I just wanted to add the possibility to create the virtual cards combining resources from any PCM/control/mixer device available in system. The proper device evaluation and mixer control assignments is something which is wanted by PulseAudio developers.
My proposed header file with reduced function set but not reduced functionality is available at:
http://git.alsa-project.org/?p=alsa-lib.git;a=blob;f=include/use-case.h;h=33...
The syntax of your proposed files is very close to the other alsa-lib's syntax. For example:
SectionModifier Name "Capture Voice" EnableSequence seq1 1 EndSequence QoS Voice EndSection
Can be written in alsa-lib's syntax:
SectionModifier."Capture Voice" [ EnableSequence [ seq1 1 ] QoS Voice ]
So I'm thinking to recode all parsers to use the alsa-lib configuration parsers. As bonus, the alsa-lib configuration routines give us some runtime evaluation and possibility to reference (include) other files.
Next step may be to support the 'amixer' like syntax for the control and mixer element handling.
Jaroslav
----- Jaroslav Kysela perex@perex.cz Linux Kernel Sound Maintainer ALSA Project, Red Hat, Inc.
On Wed, 2010-08-25 at 10:28 +0200, Jaroslav Kysela wrote:
On Tue, 24 Aug 2010, Liam Girdwood wrote:
On Mon, 2010-08-23 at 19:47 +0200, Jaroslav Kysela wrote:
Unfortunately, I have many ideas to improve the API before I can approve or recommend the inclusion to the alsa-lib's tree.
I wish you had shared your API ideas with us at the time of the RFC. A lot of time and effort has since went into UCM development :-/
I too. My big problem is the lack of time.
Same here, not enough hours in the day.
I tried to rethink the API to be more universal for future extensions (but the implementation will not dramatically change and the mechanisms you want to expose are not touched at all). I just wanted to add the possibility to create the virtual cards combining resources from any PCM/control/mixer device available in system. The proper device evaluation and mixer control assignments is something which is wanted by PulseAudio developers.
My proposed header file with reduced function set but not reduced functionality is available at:
http://git.alsa-project.org/?p=alsa-lib.git;a=blob;f=include/use-case.h;h=33...
ok, that looks good.
The syntax of your proposed files is very close to the other alsa-lib's syntax. For example:
SectionModifier Name "Capture Voice" EnableSequence seq1 1 EndSequence QoS Voice EndSection
Can be written in alsa-lib's syntax:
SectionModifier."Capture Voice" [ EnableSequence [ seq1 1 ] QoS Voice ]
So I'm thinking to recode all parsers to use the alsa-lib configuration parsers. As bonus, the alsa-lib configuration routines give us some runtime evaluation and possibility to reference (include) other files.
ok, I agree here too.
Next step may be to support the 'amixer' like syntax for the control and mixer element handling.
Btw, we need to try and avoid using the control ID in any mixer syntax. I found that minor driver changes could change ID numbering meaning major updates to config files. The mixer names are pretty constant and using them has been quite painless.
Thanks
Liam
On Wed, 25 Aug 2010, Liam Girdwood wrote:
Next step may be to support the 'amixer' like syntax for the control and mixer element handling.
Btw, we need to try and avoid using the control ID in any mixer syntax. I found that minor driver changes could change ID numbering meaning major updates to config files. The mixer names are pretty constant and using them has been quite painless.
Definitely. I meant the full control identifier (not just numid).
Jaroslav
----- Jaroslav Kysela perex@perex.cz Linux Kernel Sound Maintainer ALSA Project, Red Hat, Inc.
On Wed, 2010-08-25 at 11:35 +0200, Jaroslav Kysela wrote:
On Wed, 25 Aug 2010, Liam Girdwood wrote:
Next step may be to support the 'amixer' like syntax for the control and mixer element handling.
Btw, we need to try and avoid using the control ID in any mixer syntax. I found that minor driver changes could change ID numbering meaning major updates to config files. The mixer names are pretty constant and using them has been quite painless.
Definitely. I meant the full control identifier (not just numid).
btw, have started any of the other API changes in use-case.c yet ?
I could make changes to the parser .....
Thanks
Liam
On Wed, 25 Aug 2010, Liam Girdwood wrote:
On Wed, 2010-08-25 at 11:35 +0200, Jaroslav Kysela wrote:
On Wed, 25 Aug 2010, Liam Girdwood wrote:
Next step may be to support the 'amixer' like syntax for the control and mixer element handling.
Btw, we need to try and avoid using the control ID in any mixer syntax. I found that minor driver changes could change ID numbering meaning major updates to config files. The mixer names are pretty constant and using them has been quite painless.
Definitely. I meant the full control identifier (not just numid).
btw, have started any of the other API changes in use-case.c yet ?
I could make changes to the parser .....
I am working on it slowly. I think that it would be fair to come with a functional code from my side. I will appreciate review and testing, of course. Please, give me few days.
Jaroslav
----- Jaroslav Kysela perex@perex.cz Linux Kernel Sound Maintainer ALSA Project, Red Hat, Inc.
2010/8/24 Liam Girdwood lrg@slimlogic.co.uk
This patch series follows on from the RFC and adds sound card hardware Use Case Management support to alsa-lib.
The main features of UCM are :-
o Abstraction of sound card hardware routing and controls into high level use case verbs, devices and modifiers. o Discovery of source/sink PCMs for each use case. o Discovery of hardware master volume controls for each use case.
It's intended UCM will provide clients (like pulseaudio) complete control over hardware signal routing within a sound card without any knowledge of the sound card hardware.
Use case definintions are stored in text files (per sound card) and are now divided into three components as descibed in the RFC.
A working use case definition file can be found here :-
http://git.slimlogic.co.uk/cgi-bin/cgit.cgi/alsa-ucm-conf.git/tree/cards/SDP...
The three components of a use case are now :-
- Verb (or action). This is mandatory and describes (in terms of ALSA
control settings) the system use case action. e.g "Phone Call", "Music Playback".
- Device. This is also mandatory and describes the audio playback or
capture device. e.g. "Handset", "Bluetooth", "Headset".
- Modifier. This is optional and is used to modify the current use case
verb. i.e. The user could be listening to music when an incoming phone call requires that a ring tone is played. In this case the use case verb would be set to "Music Playback" when the music playback started and then the "Tone Playback" modifier could be enabled to play the ring tone. The use case verb would then be changed to "Voice Call" if the call was accepted.
Patch 2/3 is a little on the large side so, I've included a link if it gets bounced by the list.
http://git.slimlogic.co.uk/cgi-bin/cgit.cgi/alsa-lib.git/commit/?h=ucm-upstr...
Liam Girdwood (3): ucm: header - ALSA Use Case Manager ucm: core - Add initial Use Case Manager support. ucm: build - add build support for Use Case Manager
doc/doxygen.cfg.in | 1 + include/Makefile.am | 2 +- include/use-case.h | 427 +++++++ src/Makefile.am | 2 +- src/use-case.c | 3515 +++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 3945 insertions(+), 2 deletions(-) create mode 100644 include/use-case.h create mode 100644 src/use-case.c
Can the use case manager discover whether the green/pink jack in front panel can be used independent of those audio jacks in rear panel for HDA-Intel in desktop pc ?
How about those hardware mixing sound card ? e.g. emu10k1 allow the user to output stereo to the selected jacks (front , rear, .... )
On Tue, Aug 24, 2010 at 09:23:14AM +0800, Raymond Yau wrote:
Can the use case manager discover whether the green/pink jack in front panel can be used independent of those audio jacks in rear panel for HDA-Intel in desktop pc ?
How about those hardware mixing sound card ? e.g. emu10k1 allow the user to output stereo to the selected jacks (front , rear, .... )
These are all orthogonal problems. UCM just provides a way of managing configurations exposed by the drivers, it doesn't add any new features for the drivers.
participants (5)
-
Chris Winter -
Jaroslav Kysela -
Liam Girdwood -
Mark Brown -
Raymond Yau