path: root/alsa-binding/Alsa-AddCtl.c

/*
 * AlsaUseCase -- provide low level interface with ALSA lib (extracted from alsa-json-gateway code)
 * Copyright (C) 2015,2016,2017, Fulup Ar Foll fulup@iot.bzh
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * References:
 *  https://kernel.readthedocs.io/en/sphinx-samples/writing-an-alsa-driver.html#control-names
 *  https://01.org/linuxgraphics/gfx-docs/drm/sound/designs/control-names.html

 */
#define _GNU_SOURCE  // needed for vasprintf

#include <alsa/asoundlib.h>
#include <alsa/sound/tlv.h>
#include <systemd/sd-event.h>
#include <sys/ioctl.h>
#include <math.h>

#include <wrap-json.h>

#include "Alsa-ApiHat.h"

// Performs like a toggle switch for attenuation, because they're bool (ref:user-ctl-element-set.c)

#ifndef SNDRV_CTL_TLVD_DECLARE_DB_MINMAX
// taken from alsa-lib-1.1.3:include/sound/tlv.h

#define SNDRV_CTL_TLVD_LENGTH(...) \
    ((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))

#define SNDRV_CTL_TLVD_ITEM(type, ...) \
    (type), SNDRV_CTL_TLVD_LENGTH(__VA_ARGS__), __VA_ARGS__

#define SNDRV_CTL_TLVT_DB_MINMAX 4

#define SNDRV_CTL_TLVD_DB_MINMAX_ITEM(min_dB, max_dB) \
    SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))

#define SNDRV_CTL_TLVD_DECLARE_DB_MINMAX(name, min_dB, max_dB) \
    unsigned int name[] = { \
        SNDRV_CTL_TLVD_DB_MINMAX_ITEM(min_dB, max_dB) \
    }

#define SNDRV_CTL_TLVD_DB_SCALE_MASK    0xffff
#define SNDRV_CTL_TLVD_DB_SCALE_MUTE    0x10000

#endif

#define PRESET_MIN_DB                   -51.0
#define ZERO_DB                         0.0
#define PRESET_STEP                     1

static const unsigned int *allocate_bool_fake_tlv(void) {
    static const SNDRV_CTL_TLVD_DECLARE_DB_MINMAX(range, -10000, 0);
    unsigned int *tlv = malloc(sizeof (range));
    if (tlv == NULL) return NULL;
    memcpy(tlv, range, sizeof (range));
    return tlv;
}

static const unsigned int *allocate_int_dbscale_tlv(int min_dB, int max_dB, int resolution) {
    // SNDRV_CTL_TLVD_DECLARE_DB_SCALE(range, min, step, mute);
    size_t tlvSize = sizeof (4 * sizeof (unsigned int));
    unsigned int *tlv = malloc(tlvSize);
    tlv[0] = SND_CTL_TLVT_DB_SCALE;
    tlv[1] = 2 * sizeof(int);
    tlv[2] = (int)(min_dB * 100);
    tlv[3] = (int)((max_dB - min_dB) * 100 / resolution);
    return tlv;
}

STATIC json_object * addOneSndCtl(afb_req_t request, snd_ctl_t *ctlDev, json_object *ctlJ, queryModeE queryMode) {
    int err, ctlNumid = CTL_UNKNOWN, shouldCreate;
    int ctlValue = 0, ctlMax = 100, ctlMin = 0, ctlStep = 1, ctlCount = 1, ctlSubDev = 0, ctlSndDev = 0;
    const unsigned int *elemTlv = NULL;

    char *ctlName = NULL;

    snd_ctl_elem_type_t ctlType = SND_CTL_ELEM_TYPE_NONE;
    snd_ctl_elem_info_t *elemInfo;
    snd_ctl_elem_id_t *elemId;
    snd_ctl_elem_value_t *elemValue;

    json_object *tmpJ;

    ctlRequestT ctlRequest;

    // parse json ctl object
    if(wrap_json_unpack(ctlJ, "{s?:s, s?:i}", "name", &ctlName, "ctl", &ctlNumid) ||
       ((ctlNumid == CTL_UNKNOWN) && ! ctlName)) {
        afb_req_fail_f(request, "ctl-invalid", "crl=%s name or numid missing", json_object_get_string(ctlJ));
        goto OnErrorExit;
    }

    // We are facing a software ctl
    if (ctlNumid == CTL_AUTO) {
        wrap_json_unpack(ctlJ,
                         "{s?:i, s?:i, s?:i, s?:i, s?:i}",
                         "type", &ctlType,
                         "count", &ctlCount,
                         "val", &ctlValue,
                         "snddev", &ctlSndDev,
                         "subdev", &ctlSubDev);

        switch(ctlType) {
            case SND_CTL_ELEM_TYPE_INTEGER:
                // default for json_object_get_int is zero
                wrap_json_unpack(ctlJ,
                                 "{s?:i, s?:i, s?:i}",
                                 "min", &ctlMin,
                                 "max", &ctlMax,
                                 "step", &ctlStep);
                break;

            case SND_CTL_ELEM_TYPE_BOOLEAN:
            case SND_CTL_ELEM_TYPE_ENUMERATED:
                AFB_NOTICE("addOneSndCtl: Requesting creation of a none INTEGER control. 'min', 'max, and 'step' won't be used");
                break;

            // Long Term Waiting ToDoList
            case SND_CTL_ELEM_TYPE_INTEGER64:
            case SND_CTL_ELEM_TYPE_BYTES:
            default:
                afb_req_fail_f(request, "ctl-invalid-type", "crl=%s unsupported type type=%d", json_object_get_string(ctlJ), ctlType);
                goto OnErrorExit;
        }
    }

    // Assert that this ctls is not used
    snd_ctl_elem_info_alloca(&elemInfo);
    if (ctlName) snd_ctl_elem_info_set_name(elemInfo, ctlName);
    if (ctlNumid > 0)snd_ctl_elem_info_set_numid(elemInfo, ctlNumid);
    snd_ctl_elem_info_set_interface(elemInfo, SND_CTL_ELEM_IFACE_MIXER);

    // If control exist try to reuse it
    err = snd_ctl_elem_info(ctlDev, elemInfo);
    if (err) {
        shouldCreate = 1;
    } else {
        int count, min, max, sndDev, subDev;
        snd_ctl_elem_type_t type;

        // ctl exit let's get associated elemID
        snd_ctl_elem_id_alloca(&elemId);
        snd_ctl_elem_info_get_id(elemInfo, elemId);

        // If this is a hardware ctl only update value
        if (ctlNumid != CTL_AUTO) {
            json_object_object_get_ex(ctlJ, "val", &tmpJ);
            ctlValue = json_object_get_int(tmpJ);
            goto UpdateDefaultVal;
        }

        count = snd_ctl_elem_info_get_count(elemInfo);
        type = snd_ctl_elem_info_get_type(elemInfo);
        sndDev = (int) snd_ctl_elem_info_get_device(elemInfo);
        subDev = (int) snd_ctl_elem_info_get_subdevice(elemInfo);

        switch(type) {
            case SND_CTL_ELEM_TYPE_INTEGER:
                min = (int) snd_ctl_elem_info_get_min(elemInfo);
                max = (int) snd_ctl_elem_info_get_max(elemInfo);
                if (count == ctlCount && min == ctlMin && max == ctlMax && type == ctlType && sndDev == ctlSndDev && subDev == ctlSubDev)
                    shouldCreate = 0;                       // Adjust value to best fit request
                else
                    shouldCreate = 1;
                break;

            case SND_CTL_ELEM_TYPE_BOOLEAN:
                if (count == ctlCount && type == ctlType && sndDev == ctlSndDev && subDev == ctlSubDev)
                    shouldCreate = 0;                       // Adjust value to best fit request
                else
                    shouldCreate = 1;
                break;

            case SND_CTL_ELEM_TYPE_ENUMERATED:
                shouldCreate = 1;
                break;

            default:
                AFB_WARNING("addOneSndCtl: Removing an unmanaged control type, type=%i, ctlName=%s, numid=%d", (int) type, snd_ctl_elem_info_get_name(elemInfo), snd_ctl_elem_info_get_numid(elemInfo));
                shouldCreate = 1;
                break;
        }

        if(shouldCreate) {
            if(! snd_ctl_elem_info_is_user(elemInfo)) {
                afb_req_fail_f(request, "ctl-invalid", "ctrl=%s is not a user created control, impossible to modify it", json_object_get_string(ctlJ));
                goto OnErrorExit;
            }

            err = snd_ctl_elem_remove(ctlDev, elemId);
            if (err < 0) {
                AFB_ERROR("addOneSndCtl: ctlName=%s ctlNumid=%d fail to reset", snd_ctl_elem_info_get_name(elemInfo), snd_ctl_elem_info_get_numid(elemInfo));
                afb_req_fail_f(request, "ctl-reset-fail", "ctlName=%s ctlNumid=%d fail to reset", snd_ctl_elem_info_get_name(elemInfo), snd_ctl_elem_info_get_numid(elemInfo));
                goto DoNotUpdate;
            };

            // Control was deleted need to refresh elemInfo
            snd_ctl_elem_info_alloca(&elemInfo);
            if (ctlName) snd_ctl_elem_info_set_name(elemInfo, ctlName);
            snd_ctl_elem_info_set_interface(elemInfo, SND_CTL_ELEM_IFACE_MIXER);
            snd_ctl_elem_info(ctlDev, elemInfo);
        }
    }

    // Add requested ID into elemInfo
    snd_ctl_elem_info_set_device(elemInfo, ctlSndDev);
    snd_ctl_elem_info_set_subdevice(elemInfo, ctlSubDev);

    switch (ctlType) {
        case SND_CTL_ELEM_TYPE_BOOLEAN:
            if (shouldCreate) {
                err = snd_ctl_add_boolean_elem_set(ctlDev, elemInfo, 1, ctlCount);
                if (err) {
                    AFB_ERROR("AddOntSndCtl Boolean: devid='%s' name='%s' count=%d", snd_ctl_name(ctlDev), ctlName, ctlCount);
                    afb_req_fail_f(request, "ctl-invalid-bool", "devid='%s' name='%s' count=%d", snd_ctl_name(ctlDev), ctlName, ctlCount);
                    goto OnErrorExit;
                }
            }

            // Create a dummy TLV
            elemTlv = allocate_bool_fake_tlv();

            break;

        case SND_CTL_ELEM_TYPE_INTEGER:
            if (shouldCreate) {
                err = snd_ctl_add_integer_elem_set(ctlDev, elemInfo, 1, ctlCount, ctlMin, ctlMax, ctlStep);
                if (err) {
                    AFB_ERROR("AddOntSndCtl Integer: devid='%s' name='%s' count=%d min=%d max=%d step=%d", snd_ctl_name(ctlDev), ctlName, ctlCount, ctlMin, ctlMax, ctlStep);
                    afb_req_fail_f(request, "ctl-invalid-bool", "devid='%s' name='%s' count=%d min=%d max=%d step=%d", snd_ctl_name(ctlDev), ctlName, ctlCount, ctlMin, ctlMax, ctlStep);
                    goto OnErrorExit;
                }
            }

            // Prepare fake dbscale TLV values
            int min = PRESET_MIN_DB, max = ZERO_DB, step = PRESET_STEP;

            // Fulup needed to be tested with some dB expert !!!
            json_object *dbscaleJ;
            if (json_object_object_get_ex(ctlJ, "dbscale", &dbscaleJ)) {

                if (json_object_get_type(dbscaleJ) != json_type_object) {
                    afb_req_fail_f(request, "ctl-invalid-dbscale", "devid=%s crl=%s invalid json in integer control", snd_ctl_name(ctlDev), json_object_get_string(ctlJ));
                    goto OnErrorExit;

                    json_object_object_get_ex(ctlJ, "min", &tmpJ);
                    min = json_object_get_int(tmpJ);
                    if (min >= 0) {
                        afb_req_fail_f(request, "ctl-invalid-dbscale", "devid=%s crl=%s min should be a negative number", snd_ctl_name(ctlDev), json_object_get_string(ctlJ));
                        goto OnErrorExit;
                    }

                    // default value 0=mute
                    json_object_object_get_ex(ctlJ, "max", &tmpJ);
                    max = json_object_get_int(tmpJ);

                    // default value 1dB
                    json_object_object_get_ex(ctlJ, "step", &tmpJ);
                    step = json_object_get_int(tmpJ);
                    if (step <= 0) step = 1;
                }
            }

            elemTlv = allocate_int_dbscale_tlv(min, max, (ctlMax - ctlMin));

            break;

        case SND_CTL_ELEM_TYPE_ENUMERATED:

            if (shouldCreate) {
                json_object *enumsJ;
                json_object_object_get_ex(ctlJ, "enums", &enumsJ);
                if (json_object_get_type(enumsJ) != json_type_array) {
                    afb_req_fail_f(request, "ctl-missing-enums", "devid=%s crl=%s mandatory enum=xxx missing in enumerated control", snd_ctl_name(ctlDev), json_object_get_string(ctlJ));
                    goto OnErrorExit;
                }

                size_t length = json_object_array_length(enumsJ);
                const char **enumlabels = malloc(length * sizeof (char*));

                for (int jdx = 0; jdx < length; jdx++) {
                    tmpJ = json_object_array_get_idx(enumsJ, jdx);
                    enumlabels[jdx] = json_object_get_string(tmpJ);
                }

                err = snd_ctl_add_enumerated_elem_set(ctlDev, elemInfo, 1, ctlCount, (int) length, enumlabels);
                if (err) {
                    afb_req_fail_f(request, "ctl-invalid-bool", "devid=%s crl=%s invalid enumerated control", snd_ctl_name(ctlDev), json_object_get_string(ctlJ));
                    goto OnErrorExit;
                }

                // Fulup should be an empty container
                elemTlv = allocate_bool_fake_tlv();
            }
            break;

        default:
            break;
    }

UpdateDefaultVal:

    // Set Value to default
    snd_ctl_elem_value_alloca(&elemValue);
    for (int idx = 0; idx < snd_ctl_elem_info_get_count(elemInfo); idx++) {
        
        // initial default value should be a percentage for integer
        if (snd_ctl_elem_info_get_type(elemInfo) == SND_CTL_ELEM_TYPE_INTEGER) {
            double min = (double)snd_ctl_elem_info_get_min(elemInfo);
            double max = (double)snd_ctl_elem_info_get_max(elemInfo);
            double normValue = ceil((ctlValue) * (max - min) * 0.01 + min);
            snd_ctl_elem_value_set_integer(elemValue, idx, (int)normValue);

        } else {    
            snd_ctl_elem_value_set_integer(elemValue, idx, ctlValue);
        }
    }

    // write default values in newly created control
    snd_ctl_elem_id_alloca(&elemId);
    snd_ctl_elem_info(ctlDev, elemInfo);
    snd_ctl_elem_info_get_id(elemInfo, elemId);
    snd_ctl_elem_value_set_id(elemValue, elemId);
    err = snd_ctl_elem_write(ctlDev, elemValue);
    if (err < 0) {
        AFB_WARNING("addOneSndCtl: crl=%s numid=%d fail to write Values error=%s", json_object_get_string(ctlJ), snd_ctl_elem_info_get_numid(elemInfo), snd_strerror(err));
        goto DoNotUpdate;
    }

    // write a default null TLV (if usefull should be implemented for every ctl type)
    if (elemTlv) {
        err = snd_ctl_elem_tlv_write(ctlDev, elemId, elemTlv);
        if (err < 0) {
            AFB_WARNING("addOneSndCtl: crl=%s numid=%d fail to write TLV error=%s", json_object_get_string(ctlJ), snd_ctl_elem_info_get_numid(elemInfo), snd_strerror(err));
            goto DoNotUpdate;
        }
    }

DoNotUpdate:
    // return newly created as a JSON object
    alsaGetSingleCtl(ctlDev, elemId, &ctlRequest, queryMode);
    if (ctlRequest.used < 0) {
        AFB_WARNING("addOneSndCtl: crl=%s numid=%d Fail to get value", json_object_get_string(ctlJ), snd_ctl_elem_info_get_numid(elemInfo));
    }

    return ctlRequest.valuesJ;

OnErrorExit:
    return NULL;
}

STATIC json_object * removeOneSndCtl(afb_req_t request, snd_ctl_t *ctlDev, json_object *ctlJ, queryModeE queryMode) {
    int err, ctlNumid = CTL_UNKNOWN;

    const char *ctlName = NULL;

    snd_ctl_elem_info_t *elemInfo;
    snd_ctl_elem_id_t *elemId;

    json_object *responseJ;

    if(wrap_json_unpack(ctlJ, "{s?:s, s?:i}", "name", &ctlName, "ctl", &ctlNumid) ||
       ((ctlNumid == CTL_UNKNOWN) && ! ctlName)) {
        afb_req_fail_f(request, "ctl-invalid", "crl=%s name or numid missing", json_object_get_string(ctlJ));
        goto OnErrorExit;
    }

    snd_ctl_elem_info_alloca(&elemInfo);

    if(ctlName)
        snd_ctl_elem_info_set_name(elemInfo, ctlName);
    if(ctlNumid > 0)
        snd_ctl_elem_info_set_numid(elemInfo, ctlNumid);

    snd_ctl_elem_info_set_interface(elemInfo, SND_CTL_ELEM_IFACE_MIXER);

    if(snd_ctl_elem_info(ctlDev, elemInfo)) {
        afb_req_fail_f(request, "ctl-invalid", "ctrl=%s does not exist", json_object_get_string(ctlJ));
        goto OnErrorExit;
    }

    if(! snd_ctl_elem_info_is_user(elemInfo)) {
        afb_req_fail_f(request, "ctl-invalid", "ctrl=%s is not a user created control, impossible to delete it", json_object_get_string(ctlJ));
        goto OnErrorExit;
    }

    if(! ctlName)
        ctlName = snd_ctl_elem_info_get_name(elemInfo);

    if(ctlNumid == CTL_UNKNOWN)
        ctlNumid = snd_ctl_elem_info_get_numid(elemInfo);

    snd_ctl_elem_id_alloca(&elemId);
    snd_ctl_elem_info_get_id(elemInfo, elemId);

    if(snd_ctl_elem_remove(ctlDev, elemId) < 0) {
        afb_req_fail_f(request,
                       "ctl-remove-fail",
                       "ctlName=%s ctlNumid=%d fail to remove",
                       ctlName,
                       ctlNumid);
        goto OnErrorExit;
    }

    err = wrap_json_pack(&responseJ,
                         "{s:{s:s, s:i}}",
                         "removed",
                         "ctlName", ctlName,
                         "ctlId", ctlNumid);
    if(err) {
        afb_req_fail_f(request,
                       "ctl-remove-json",
                       "Did nor succeed to allocate response json for removed control with name=%s id=%d",
                       ctlName,
                       ctlNumid);
        goto OnErrorExit;
    }

    return responseJ;

OnErrorExit:
    return NULL;
}

STATIC void alsaAddRemoveCustomCtls(afb_req_t request, ControlAddRemoveT controlAction) {
    int err;

    queryModeE queryMode;

    const char *devid;

    snd_ctl_t *ctlDev = NULL;

    json_object *queryJ, *ctlsJ, *ctlsValues = NULL, *ctlValues = NULL;

    queryJ = afb_req_json(request);

    devid = alsaGetDevIdFromQuery(queryJ);
    if (!devid) {
        afb_req_fail_f(request, "devid-missing", "devid MUST be defined for alsaAddRemoveCustomCtls");
        goto OnErrorExit;
    }

    // open control interface for devid
    err = snd_ctl_open(&ctlDev, devid, 0);
    if (err < 0) {
        afb_req_fail_f(request, "devid-unknown", "SndCard devid=[%s] Not Found err=%s", devid, snd_strerror(err));
        goto OnErrorExit;
    }

    // get verbosity level
    queryMode = alsaGetModeFromQuery(queryJ);

    // extract sound controls and parse json
    ctlsJ = json_tokener_parse(afb_req_value(request, "ctl"));
    if (!ctlsJ) {
        afb_req_fail_f(request, "ctls-missing", "ctls MUST be defined as a JSON array for alsaAddRemoveCustomCtls");
        goto OnErrorExit;
    }

    switch (json_object_get_type(ctlsJ)) {
        case json_type_object:
            if(controlAction == CONTROL_ADD)
                ctlsValues = addOneSndCtl(request, ctlDev, ctlsJ, queryMode);
            else if(controlAction == CONTROL_REMOVE)
                ctlsValues = removeOneSndCtl(request, ctlDev, ctlsJ, queryMode);
            if (!ctlsValues) goto OnErrorExit;
            break;

        case json_type_array:
            ctlsValues = json_object_new_array();
            for (int idx = 0; idx < json_object_array_length(ctlsJ); idx++) {
                json_object *ctlJ = json_object_array_get_idx(ctlsJ, idx);
                if(controlAction == CONTROL_ADD)
                    ctlsValues = addOneSndCtl(request, ctlDev, ctlJ, queryMode);
                else if(controlAction == CONTROL_REMOVE)
                    ctlsValues = removeOneSndCtl(request, ctlDev, ctlJ, queryMode);
                if (ctlValues) json_object_array_add(ctlsValues, ctlValues);
                else goto OnErrorExit;
            }
            break;

        default:
            afb_req_fail_f(request, "ctls-invalid", "ctls=%s not valid JSON array", json_object_get_string(ctlsJ));
            goto OnErrorExit;
    }

    // get ctl as a json response
    afb_req_success(request, ctlsValues, NULL);

OnErrorExit:
    if (ctlDev) snd_ctl_close(ctlDev);
    return;
}

PUBLIC void alsaAddCustomCtls(afb_req_t request) {
    alsaAddRemoveCustomCtls(request, CONTROL_ADD);
}

PUBLIC void alsaRemoveCustomCtls(afb_req_t request) {
    alsaAddRemoveCustomCtls(request, CONTROL_REMOVE);
}