/**
* \file mixer/simple.c
* \brief Mixer Simple Element Class Interface
* \author Jaroslav Kysela <perex@perex.cz>
* \author Abramo Bagnara <abramo@alsa-project.org>
* \date 2001-2004
*
* Mixer simple element class interface.
*/
/*
* Mixer Interface - simple controls
* Copyright (c) 2000,2004 by Jaroslav Kysela <perex@perex.cz>
* Copyright (c) 2001 by Abramo Bagnara <abramo@alsa-project.org>
*
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <math.h>
#include "config.h"
#include "mixer_local.h"
#include "mixer_simple.h"
/**
* \brief Register mixer simple element class
* \param mixer Mixer handle
* \param options Options container
* \param classp Pointer to returned mixer simple element class handle (or NULL)
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_register(snd_mixer_t *mixer,
struct snd_mixer_selem_regopt *options,
snd_mixer_class_t **classp)
{
if (options && options->ver == 1) {
if (options->device != NULL &&
(options->playback_pcm != NULL ||
options->capture_pcm != NULL))
return -EINVAL;
if (options->device == NULL &&
options->playback_pcm == NULL &&
options->capture_pcm == NULL)
return -EINVAL;
}
if (options == NULL ||
(options->ver == 1 && options->abstract == SND_MIXER_SABSTRACT_NONE)) {
int err = snd_mixer_simple_none_register(mixer, options, classp);
if (err < 0)
return err;
if (options != NULL) {
err = snd_mixer_attach(mixer, options->device);
if (err < 0)
return err;
}
return 0;
} else if (options->ver == 1) {
if (options->abstract == SND_MIXER_SABSTRACT_BASIC)
return snd_mixer_simple_basic_register(mixer, options, classp);
}
return -ENXIO;
}
#ifndef DOC_HIDDEN
#define CHECK_BASIC(xelem) \
{ \
assert(xelem); \
assert((xelem)->type == SND_MIXER_ELEM_SIMPLE); \
}
#define CHECK_DIR(xelem, xwhat) \
{ \
unsigned int xcaps = ((sm_selem_t *)(elem)->private_data)->caps; \
if (! (xcaps & (xwhat))) \
return -EINVAL; \
}
#define CHECK_DIR_CHN(xelem, xwhat, xjoin, xchannel) \
{ \
unsigned int xcaps = ((sm_selem_t *)(elem)->private_data)->caps; \
if (! (xcaps & (xwhat))) \
return -EINVAL; \
if (xcaps & (xjoin)) \
xchannel = 0; \
}
#define CHECK_ENUM(xelem) \
if (!(((sm_selem_t *)(elem)->private_data)->caps & (SM_CAP_PENUM|SM_CAP_CENUM))) \
return -EINVAL;
#define COND_CAPS(xelem, what) \
!!(((sm_selem_t *)(elem)->private_data)->caps & (what))
#endif /* !DOC_HIDDEN */
#ifndef DOC_HIDDEN
int snd_mixer_selem_compare(const snd_mixer_elem_t *c1, const snd_mixer_elem_t *c2)
{
sm_selem_t *s1 = c1->private_data;
sm_selem_t *s2 = c2->private_data;
int res = strcmp(s1->id->name, s2->id->name);
if (res)
return res;
return s1->id->index - s2->id->index;
}
#endif
/**
* \brief Find a mixer simple element
* \param mixer Mixer handle
* \param id Mixer simple element identifier
* \return mixer simple element handle or NULL if not found
*/
snd_mixer_elem_t *snd_mixer_find_selem(snd_mixer_t *mixer,
const snd_mixer_selem_id_t *id)
{
struct list_head *list;
snd_mixer_elem_t *e;
sm_selem_t *s;
list_for_each(list, &mixer->elems) {
e = list_entry(list, snd_mixer_elem_t, list);
if (e->type != SND_MIXER_ELEM_SIMPLE)
continue;
s = e->private_data;
if (!strcmp(s->id->name, id->name) && s->id->index == id->index)
return e;
}
return NULL;
}
/**
* \brief Get mixer simple element identifier
* \param elem Mixer simple element handle
* \param id returned mixer simple element identifier
*/
void snd_mixer_selem_get_id(snd_mixer_elem_t *elem,
snd_mixer_selem_id_t *id)
{
sm_selem_t *s;
assert(id);
CHECK_BASIC(elem);
s = elem->private_data;
*id = *s->id;
}
/**
* \brief Get name part of mixer simple element identifier
* \param elem Mixer simple element handle
* \return name part of simple element identifier
*/
const char *snd_mixer_selem_get_name(snd_mixer_elem_t *elem)
{
sm_selem_t *s;
CHECK_BASIC(elem);
s = elem->private_data;
return s->id->name;
}
/**
* \brief Get index part of mixer simple element identifier
* \param elem Mixer simple element handle
* \return index part of simple element identifier
*/
unsigned int snd_mixer_selem_get_index(snd_mixer_elem_t *elem)
{
sm_selem_t *s;
CHECK_BASIC(elem);
s = elem->private_data;
return s->id->index;
}
/**
* \brief Return true if mixer simple element has only one volume control for both playback and capture
* \param elem Mixer simple element handle
* \return 0 separated control, 1 common control
*/
int snd_mixer_selem_has_common_volume(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_GVOLUME);
}
/**
* \brief Return true if mixer simple element has only one switch control for both playback and capture
* \param elem Mixer simple element handle
* \return 0 separated control, 1 common control
*/
int snd_mixer_selem_has_common_switch(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_GSWITCH);
}
/**
* \brief Return name of mixer simple element channel
* \param channel mixer simple element channel identifier
* \return channel name
*/
const char *snd_mixer_selem_channel_name(snd_mixer_selem_channel_id_t channel)
{
static const char *const array[SND_MIXER_SCHN_LAST + 1] = {
[SND_MIXER_SCHN_FRONT_LEFT] = "Front Left",
[SND_MIXER_SCHN_FRONT_RIGHT] = "Front Right",
[SND_MIXER_SCHN_REAR_LEFT] = "Rear Left",
[SND_MIXER_SCHN_REAR_RIGHT] = "Rear Right",
[SND_MIXER_SCHN_FRONT_CENTER] = "Front Center",
[SND_MIXER_SCHN_WOOFER] = "Woofer",
[SND_MIXER_SCHN_SIDE_LEFT] = "Side Left",
[SND_MIXER_SCHN_SIDE_RIGHT] = "Side Right",
[SND_MIXER_SCHN_REAR_CENTER] = "Rear Center"
};
const char *p;
assert(channel <= SND_MIXER_SCHN_LAST);
p = array[channel];
if (!p)
return "?";
return p;
}
/**
* \brief Get info about the active state of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if not active, 1 if active
*/
int snd_mixer_selem_is_active(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return sm_selem_ops(elem)->is(elem, SM_PLAY, SM_OPS_IS_ACTIVE, 0);
}
/**
* \brief Get info about channels of playback stream of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if not mono, 1 if mono
*/
int snd_mixer_selem_is_playback_mono(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return sm_selem_ops(elem)->is(elem, SM_PLAY, SM_OPS_IS_MONO, 0);
}
/**
* \brief Get info about channels of playback stream of a mixer simple element
* \param elem Mixer simple element handle
* \param channel Mixer simple element channel identifier
* \return 0 if channel is not present, 1 if present
*/
int snd_mixer_selem_has_playback_channel(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel)
{
CHECK_BASIC(elem);
return sm_selem_ops(elem)->is(elem, SM_PLAY, SM_OPS_IS_CHANNEL, (int)channel);
}
/**
* \brief Get range for playback volume of a mixer simple element
* \param elem Mixer simple element handle
* \param min Pointer to returned minimum
* \param max Pointer to returned maximum
*/
int snd_mixer_selem_get_playback_volume_range(snd_mixer_elem_t *elem,
long *min, long *max)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_PVOLUME);
return sm_selem_ops(elem)->get_range(elem, SM_PLAY, min, max);
}
/**
* \brief Get range in dB for playback volume of a mixer simple element
* \param elem Mixer simple element handle
* \param min Pointer to returned minimum (dB * 100)
* \param max Pointer to returned maximum (dB * 100)
*/
int snd_mixer_selem_get_playback_dB_range(snd_mixer_elem_t *elem,
long *min, long *max)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_PVOLUME);
return sm_selem_ops(elem)->get_dB_range(elem, SM_PLAY, min, max);
}
/**
* \brief Set range for playback volume of a mixer simple element
* \param elem Mixer simple element handle
* \param min minimum volume value
* \param max maximum volume value
*/
int snd_mixer_selem_set_playback_volume_range(snd_mixer_elem_t *elem,
long min, long max)
{
CHECK_BASIC(elem);
assert(min < max);
CHECK_DIR(elem, SM_CAP_PVOLUME);
return sm_selem_ops(elem)->set_range(elem, SM_PLAY, min, max);
}
/**
* \brief Return info about playback volume control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if no control is present, 1 if it's present
*/
int snd_mixer_selem_has_playback_volume(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_PVOLUME);
}
/**
* \brief Return info about playback volume control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if control is separated per channel, 1 if control acts on all channels together
*/
int snd_mixer_selem_has_playback_volume_joined(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_PVOLUME_JOIN);
}
/**
* \brief Return info about playback switch control existence of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if no control is present, 1 if it's present
*/
int snd_mixer_selem_has_playback_switch(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_PSWITCH);
}
/**
* \brief Return info about playback switch control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if control is separated per channel, 1 if control acts on all channels together
*/
int snd_mixer_selem_has_playback_switch_joined(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_PSWITCH_JOIN);
}
/**
* \brief Return corresponding dB value to an integer playback volume for a mixer simple element
* \param elem Mixer simple element handle
* \param value value to be converted to dB range
* \param dBvalue pointer to returned dB value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_ask_playback_vol_dB(snd_mixer_elem_t *elem, long value, long *dBvalue)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_PVOLUME);
return sm_selem_ops(elem)->ask_vol_dB(elem, SM_PLAY, value, dBvalue);
}
/**
* \brief Return corresponding integer playback volume for given dB value for a mixer simple element
* \param elem Mixer simple element handle
* \param value value to be converted to dB range
* \param dir rounding mode - rounds up if dir > 0, round to nearest if dir == 0,
* rounds down if dir < 0
* \param dBvalue pointer to returned dB value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_ask_playback_dB_vol(snd_mixer_elem_t *elem, long dBvalue, int dir, long *value)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_PVOLUME);
return sm_selem_ops(elem)->ask_dB_vol(elem, SM_PLAY, dBvalue, value, dir);
}
/**
* \brief Return value of playback volume control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value pointer to returned value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_get_playback_volume(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long *value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_PVOLUME, SM_CAP_PVOLUME_JOIN, channel);
return sm_selem_ops(elem)->get_volume(elem, SM_PLAY, channel, value);
}
/**
* \brief Return value of playback volume in dB control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value pointer to returned value (dB * 100)
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_get_playback_dB(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long *value)
{
unsigned int caps;
CHECK_BASIC(elem);
caps = ((sm_selem_t *)elem->private_data)->caps;
if (!(caps & SM_CAP_PVOLUME))
return -EINVAL;
if (caps & SM_CAP_PVOLUME_JOIN)
channel = 0;
return sm_selem_ops(elem)->get_dB(elem, SM_PLAY, channel, value);
}
/**
* \brief Return value of playback switch control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value pointer to returned value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_get_playback_switch(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, int *value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_PSWITCH, SM_CAP_PSWITCH_JOIN, channel);
return sm_selem_ops(elem)->get_switch(elem, SM_PLAY, channel, value);
}
/**
* \brief Set value of playback volume control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_playback_volume(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_PVOLUME, SM_CAP_PVOLUME_JOIN, channel);
return sm_selem_ops(elem)->set_volume(elem, SM_PLAY, channel, value);
}
/**
* \brief Set value in dB of playback volume control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value control value in dB * 100
* \param dir rounding mode - rounds up if dir > 0, round to nearest if dir == 0,
* rounds down if dir < 0
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_playback_dB(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long value, int dir)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_PVOLUME, SM_CAP_PVOLUME_JOIN, channel);
return sm_selem_ops(elem)->set_dB(elem, SM_PLAY, channel, value, dir);
}
/**
* \brief Set value of playback volume control for all channels of a mixer simple element
* \param elem Mixer simple element handle
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_playback_volume_all(snd_mixer_elem_t *elem, long value)
{
snd_mixer_selem_channel_id_t chn;
int err;
for (chn = 0; chn < 32; chn++) {
if (!snd_mixer_selem_has_playback_channel(elem, chn))
continue;
err = snd_mixer_selem_set_playback_volume(elem, chn, value);
if (err < 0)
return err;
if (chn == 0 && snd_mixer_selem_has_playback_volume_joined(elem))
return 0;
}
return 0;
}
/**
* \brief Set value in dB of playback volume control for all channels of a mixer simple element
* \param elem Mixer simple element handle
* \param value control value in dB * 100
* \param dir rounding mode - rounds up if dir > 0, round to nearest if dir == 0,
* rounds down if dir < 0
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_playback_dB_all(snd_mixer_elem_t *elem, long value, int dir)
{
snd_mixer_selem_channel_id_t chn;
int err;
for (chn = 0; chn < 32; chn++) {
if (!snd_mixer_selem_has_playback_channel(elem, chn))
continue;
err = snd_mixer_selem_set_playback_dB(elem, chn, value, dir);
if (err < 0)
return err;
if (chn == 0 && snd_mixer_selem_has_playback_volume_joined(elem))
return 0;
}
return 0;
}
/**
* \brief Set value of playback switch control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_playback_switch(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, int value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_PSWITCH, SM_CAP_PSWITCH_JOIN, channel);
return sm_selem_ops(elem)->set_switch(elem, SM_PLAY, channel, value);
}
/**
* \brief Set value of playback switch control for all channels of a mixer simple element
* \param elem Mixer simple element handle
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_playback_switch_all(snd_mixer_elem_t *elem, int value)
{
snd_mixer_selem_channel_id_t chn;
int err;
CHECK_BASIC(elem);
for (chn = 0; chn < 32; chn++) {
if (!snd_mixer_selem_has_playback_channel(elem, chn))
continue;
err = snd_mixer_selem_set_playback_switch(elem, chn, value);
if (err < 0)
return err;
if (chn == 0 && snd_mixer_selem_has_playback_switch_joined(elem))
return 0;
}
return 0;
}
/**
* \brief Get info about channels of capture stream of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if not mono, 1 if mono
*/
int snd_mixer_selem_is_capture_mono(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_CVOLUME|SM_CAP_CSWITCH);
return sm_selem_ops(elem)->is(elem, SM_CAPT, SM_OPS_IS_MONO, 0);
}
/**
* \brief Get info about channels of capture stream of a mixer simple element
* \param elem Mixer simple element handle
* \param channel Mixer simple element channel identifier
* \return 0 if channel is not present, 1 if present
*/
int snd_mixer_selem_has_capture_channel(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_CVOLUME|SM_CAP_CSWITCH);
return sm_selem_ops(elem)->is(elem, SM_CAPT, SM_OPS_IS_CHANNEL, channel);
}
/**
* \brief Get range for capture volume of a mixer simple element
* \param elem Mixer simple element handle
* \param min Pointer to returned minimum
* \param max Pointer to returned maximum
*/
int snd_mixer_selem_get_capture_volume_range(snd_mixer_elem_t *elem,
long *min, long *max)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_CVOLUME);
return sm_selem_ops(elem)->get_range(elem, SM_CAPT, min, max);
}
/**
* \brief Get range in dB for capture volume of a mixer simple element
* \param elem Mixer simple element handle
* \param min Pointer to returned minimum (dB * 100)
* \param max Pointer to returned maximum (dB * 100)
*/
int snd_mixer_selem_get_capture_dB_range(snd_mixer_elem_t *elem,
long *min, long *max)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_CVOLUME);
return sm_selem_ops(elem)->get_dB_range(elem, SM_CAPT, min, max);
}
/**
* \brief Set range for capture volume of a mixer simple element
* \param elem Mixer simple element handle
* \param min minimum volume value
* \param max maximum volume value
*/
int snd_mixer_selem_set_capture_volume_range(snd_mixer_elem_t *elem,
long min, long max)
{
CHECK_BASIC(elem);
assert(min < max);
CHECK_DIR(elem, SM_CAP_CVOLUME);
return sm_selem_ops(elem)->set_range(elem, SM_CAPT, min, max);
}
/**
* \brief Return info about capture volume control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if no control is present, 1 if it's present
*/
int snd_mixer_selem_has_capture_volume(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_CVOLUME);
}
/**
* \brief Return info about capture volume control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if control is separated per channel, 1 if control acts on all channels together
*/
int snd_mixer_selem_has_capture_volume_joined(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_CVOLUME_JOIN);
}
/**
* \brief Return info about capture switch control existence of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if no control is present, 1 if it's present
*/
int snd_mixer_selem_has_capture_switch(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_CSWITCH);
}
/**
* \brief Return info about capture switch control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if control is separated per channel, 1 if control acts on all channels together
*/
int snd_mixer_selem_has_capture_switch_joined(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_CSWITCH_JOIN);
}
/**
* \brief Return info about capture switch control of a mixer simple element
* \param elem Mixer simple element handle
* \return 0 if control is separated per element, 1 if control acts on other elements too (i.e. only one active at a time inside a group)
*/
int snd_mixer_selem_has_capture_switch_exclusive(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return COND_CAPS(elem, SM_CAP_CSWITCH_EXCL);
}
/**
* \brief Return info about capture switch control of a mixer simple element
* \param elem Mixer simple element handle
* \return group for switch exclusivity (see #snd_mixer_selem_has_capture_switch_exclusive)
*/
int snd_mixer_selem_get_capture_group(snd_mixer_elem_t *elem)
{
sm_selem_t *s;
CHECK_BASIC(elem);
s = elem->private_data;
if (! (s->caps & SM_CAP_CSWITCH_EXCL))
return -EINVAL;
return s->capture_group;
}
/**
* \brief Return corresponding dB value to an integer capture volume for a mixer simple element
* \param elem Mixer simple element handle
* \param value value to be converted to dB range
* \param dBvalue pointer to returned dB value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_ask_capture_vol_dB(snd_mixer_elem_t *elem, long value, long *dBvalue)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_CVOLUME);
return sm_selem_ops(elem)->ask_vol_dB(elem, SM_CAPT, value, dBvalue);
}
/**
* \brief Return corresponding integer capture volume for given dB value for a mixer simple element
* \param elem Mixer simple element handle
* \param dBvalue dB value to be converted to integer range
* \param value pointer to returned integer value
* \param dir rounding mode - rounds up if dir > 0, round to nearest if dir == 0,
* rounds down if dir < 0
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_ask_capture_dB_vol(snd_mixer_elem_t *elem, long dBvalue, int dir, long *value)
{
CHECK_BASIC(elem);
CHECK_DIR(elem, SM_CAP_CVOLUME);
return sm_selem_ops(elem)->ask_dB_vol(elem, SM_CAPT, dBvalue, value, dir);
}
/**
* \brief Return value of capture volume control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value pointer to returned value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_get_capture_volume(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long *value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_CVOLUME, SM_CAP_CVOLUME_JOIN, channel);
return sm_selem_ops(elem)->get_volume(elem, SM_CAPT, channel, value);
}
/**
* \brief Return value of capture volume in dB control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value pointer to returned value (dB * 100)
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_get_capture_dB(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long *value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_CVOLUME, SM_CAP_CVOLUME_JOIN, channel);
return sm_selem_ops(elem)->get_dB(elem, SM_CAPT, channel, value);
}
/**
* \brief Return value of capture switch control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value pointer to returned value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_get_capture_switch(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, int *value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_CSWITCH, SM_CAP_CSWITCH_JOIN, channel);
return sm_selem_ops(elem)->get_switch(elem, SM_CAPT, channel, value);
}
/**
* \brief Set value of capture volume control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_capture_volume(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_CVOLUME, SM_CAP_CVOLUME_JOIN, channel);
return sm_selem_ops(elem)->set_volume(elem, SM_CAPT, channel, value);
}
/**
* \brief Set value in dB of capture volume control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value control value in dB * 100
* \param dir rounding mode - rounds up if dir > 0, round to nearest if dir == 0,
* rounds down if dir < 0
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_capture_dB(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, long value, int dir)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_CVOLUME, SM_CAP_CVOLUME_JOIN, channel);
return sm_selem_ops(elem)->set_dB(elem, SM_CAPT, channel, value, dir);
}
/**
* \brief Set value of capture volume control for all channels of a mixer simple element
* \param elem Mixer simple element handle
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_capture_volume_all(snd_mixer_elem_t *elem, long value)
{
snd_mixer_selem_channel_id_t chn;
int err;
for (chn = 0; chn < 32; chn++) {
if (!snd_mixer_selem_has_capture_channel(elem, chn))
continue;
err = snd_mixer_selem_set_capture_volume(elem, chn, value);
if (err < 0)
return err;
if (chn == 0 && snd_mixer_selem_has_capture_volume_joined(elem))
return 0;
}
return 0;
}
/**
* \brief Set value in dB of capture volume control for all channels of a mixer simple element
* \param elem Mixer simple element handle
* \param value control value in dB * 100
* \param dir rounding mode - rounds up if dir > 0, round to nearest if dir == 0,
* rounds down if dir < 0
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_capture_dB_all(snd_mixer_elem_t *elem, long value, int dir)
{
snd_mixer_selem_channel_id_t chn;
int err;
for (chn = 0; chn < 32; chn++) {
if (!snd_mixer_selem_has_capture_channel(elem, chn))
continue;
err = snd_mixer_selem_set_capture_dB(elem, chn, value, dir);
if (err < 0)
return err;
if (chn == 0 && snd_mixer_selem_has_capture_volume_joined(elem))
return 0;
}
return 0;
}
/**
* \brief Set value of capture switch control of a mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_capture_switch(snd_mixer_elem_t *elem, snd_mixer_selem_channel_id_t channel, int value)
{
CHECK_BASIC(elem);
CHECK_DIR_CHN(elem, SM_CAP_CSWITCH, SM_CAP_CSWITCH_JOIN, channel);
return sm_selem_ops(elem)->set_switch(elem, SM_CAPT, channel, value);
}
/**
* \brief Set value of capture switch control for all channels of a mixer simple element
* \param elem Mixer simple element handle
* \param value control value
* \return 0 on success otherwise a negative error code
*/
int snd_mixer_selem_set_capture_switch_all(snd_mixer_elem_t *elem, int value)
{
snd_mixer_selem_channel_id_t chn;
int err;
for (chn = 0; chn < 32; chn++) {
if (!snd_mixer_selem_has_capture_channel(elem, chn))
continue;
err = snd_mixer_selem_set_capture_switch(elem, chn, value);
if (err < 0)
return err;
if (chn == 0 && snd_mixer_selem_has_capture_switch_joined(elem))
return 0;
}
return 0;
}
/**
* \brief Return true if mixer simple element is an enumerated control
* \param elem Mixer simple element handle
* \return 0 normal volume/switch control, 1 enumerated control
*/
int snd_mixer_selem_is_enumerated(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return sm_selem_ops(elem)->is(elem, SM_PLAY, SM_OPS_IS_ENUMERATED, 0);
}
/**
* \brief Return true if mixer simple enumerated element belongs to the playback direction
* \param elem Mixer simple element handle
* \return 0 no playback direction, 1 playback direction
*/
int snd_mixer_selem_is_enum_playback(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return sm_selem_ops(elem)->is(elem, SM_PLAY, SM_OPS_IS_ENUMERATED, 1);
}
/**
* \brief Return true if mixer simple enumerated element belongs to the capture direction
* \param elem Mixer simple element handle
* \return 0 no capture direction, 1 capture direction
*/
int snd_mixer_selem_is_enum_capture(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
return sm_selem_ops(elem)->is(elem, SM_CAPT, SM_OPS_IS_ENUMERATED, 1);
}
/**
* \brief Return the number of enumerated items of the given mixer simple element
* \param elem Mixer simple element handle
* \return the number of enumerated items, otherwise a negative error code
*/
int snd_mixer_selem_get_enum_items(snd_mixer_elem_t *elem)
{
CHECK_BASIC(elem);
CHECK_ENUM(elem);
return sm_selem_ops(elem)->is(elem, SM_PLAY, SM_OPS_IS_ENUMCNT, 0);
}
/**
* \brief get the enumerated item string for the given mixer simple element
* \param elem Mixer simple element handle
* \param item the index of the enumerated item to query
* \param maxlen the maximal length to be stored
* \param buf the buffer to store the name string
* \return 0 if successful, otherwise a negative error code
*/
int snd_mixer_selem_get_enum_item_name(snd_mixer_elem_t *elem,
unsigned int item,
size_t maxlen, char *buf)
{
CHECK_BASIC(elem);
CHECK_ENUM(elem);
return sm_selem_ops(elem)->enum_item_name(elem, item, maxlen, buf);
}
/**
* \brief get the current selected enumerated item for the given mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param itemp the pointer to store the index of the enumerated item
* \return 0 if successful, otherwise a negative error code
*/
int snd_mixer_selem_get_enum_item(snd_mixer_elem_t *elem,
snd_mixer_selem_channel_id_t channel,
unsigned int *itemp)
{
CHECK_BASIC(elem);
CHECK_ENUM(elem);
return sm_selem_ops(elem)->get_enum_item(elem, channel, itemp);
}
/**
* \brief set the current selected enumerated item for the given mixer simple element
* \param elem Mixer simple element handle
* \param channel mixer simple element channel identifier
* \param item the enumerated item index
* \return 0 if successful, otherwise a negative error code
*/
int snd_mixer_selem_set_enum_item(snd_mixer_elem_t *elem,
snd_mixer_selem_channel_id_t channel,
unsigned int item)
{
CHECK_BASIC(elem);
CHECK_ENUM(elem);
return sm_selem_ops(elem)->set_enum_item(elem, channel, item);
}
/**
* \brief get size of #snd_mixer_selem_id_t
* \return size in bytes
*/
size_t snd_mixer_selem_id_sizeof()
{
return sizeof(snd_mixer_selem_id_t);
}
/**
* \brief allocate an invalid #snd_mixer_selem_id_t using standard malloc
* \param ptr returned pointer
* \return 0 on success otherwise negative error code
*/
int snd_mixer_selem_id_malloc(snd_mixer_selem_id_t **ptr)
{
assert(ptr);
*ptr = calloc(1, sizeof(snd_mixer_selem_id_t));
if (!*ptr)
return -ENOMEM;
return 0;
}
/**
* \brief frees a previously allocated #snd_mixer_selem_id_t
* \param obj pointer to object to free
*/
void snd_mixer_selem_id_free(snd_mixer_selem_id_t *obj)
{
free(obj);
}
/**
* \brief copy one #snd_mixer_selem_id_t to another
* \param dst pointer to destination
* \param src pointer to source
*/
void snd_mixer_selem_id_copy(snd_mixer_selem_id_t *dst, const snd_mixer_selem_id_t *src)
{
assert(dst && src);
*dst = *src;
}
/**
* \brief Get name part of a mixer simple element identifier
* \param obj Mixer simple element identifier
* \return name part
*/
const char *snd_mixer_selem_id_get_name(const snd_mixer_selem_id_t *obj)
{
assert(obj);
return obj->name;
}
/**
* \brief Get index part of a mixer simple element identifier
* \param obj Mixer simple element identifier
* \return index part
*/
unsigned int snd_mixer_selem_id_get_index(const snd_mixer_selem_id_t *obj)
{
assert(obj);
return obj->index;
}
/**
* \brief Set name part of a mixer simple element identifier
* \param obj Mixer simple element identifier
* \param val name part
*/
void snd_mixer_selem_id_set_name(snd_mixer_selem_id_t *obj, const char *val)
{
assert(obj);
strncpy(obj->name, val, sizeof(obj->name));
obj->name[sizeof(obj->name)-1] = '\0';
}
/**
* \brief Set index part of a mixer simple element identifier
* \param obj Mixer simple element identifier
* \param val index part
*/
void snd_mixer_selem_id_set_index(snd_mixer_selem_id_t *obj, unsigned int val)
{
assert(obj);
obj->index = val;
}
/**
* \brief Parse ASCII simple mixer element identifier
* \param dst Parsed simple mixer element identifier
* \param str Mixer simple element ASCII representation
*/
int snd_mixer_selem_id_parse(snd_mixer_selem_id_t *dst, const char *str)
{
int c, size;
char buf[128];
char *ptr = buf;
memset(dst, 0, sizeof(*dst));
while (*str == ' ' || *str == '\t')
str++;
if (!(*str))
return -EINVAL;
size = 1; /* for '\0' */
if (*str != '"' && *str != '\'') {
while (*str && *str != ',') {
if (size < (int)sizeof(buf)) {
*ptr++ = *str;
size++;
}
str++;
}
} else {
c = *str++;
while (*str && *str != c) {
if (size < (int)sizeof(buf)) {
*ptr++ = *str;
size++;
}
str++;
}
if (*str == c)
str++;
}
if (*str == '\0') {
*ptr = 0;
goto _set;
}
if (*str != ',')
return -EINVAL;
*ptr = 0; /* terminate the string */
str++;
if (str[0] < '0' || str[1] > '9')
return -EINVAL;
dst->index = atoi(str);
_set:
snd_strlcpy(dst->name, buf, sizeof(dst->name));
return 0;
}