hal/audio_extn/Gef.cpp

/*
 * Copyright (c) 2016-2021, The Linux Foundation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of The Linux Foundation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#define LOG_TAG "AHAL: audio_hw_generic_effect"
#define LOG_NDDEBUG 0

#include "AudioDevice.h"
#include "audio_extn.h"
#include "AudioCommon.h"

#include <errno.h>
#include <math.h>
#include <log/log.h>
#include <fcntl.h>
#include <dirent.h>
#include <sys/stat.h>
#include <stdlib.h>
#include <dlfcn.h>
#include <math.h>
#include <cutils/properties.h>

#ifdef DYNAMIC_LOG_ENABLED
#include <log_xml_parser.h>
#define LOG_MASK HAL_MOD_FILE_GEF
#include <log_utils.h>
#endif

#ifdef AUDIO_GENERIC_EFFECT_FRAMEWORK_ENABLED

#ifdef __LP64__
#define LIBS "/vendor/lib64/"
#else
#define LIBS "/vendor/lib/"
#endif

#if LINUX_ENABLED
#define GEF_LIBRARY "libqtigefar.so"
#else
#define GEF_LIBRARY LIBS"libqtigefar.so"
#endif

typedef int (*gef_get_pal_info)(void* adev,
                                    const audio_devices_t hal_device_id,
                                    pal_device_id_t *pal_device_id,
                                    audio_output_flags_t hal_stream_flag,
                                    pal_stream_type_t *pal_stream_type);
typedef void* (*gef_init_t)(void*, gef_get_pal_info);
typedef void (*gef_deinit_t)(void*);
typedef void (*gef_device_config_cb_t)(void*, audio_devices_t,
    audio_channel_mask_t, int, int);

typedef struct {
    void* handle;
    void* gef_ptr;
    gef_init_t init;
    gef_deinit_t deinit;
    gef_device_config_cb_t device_config_cb;
} gef_data;

static gef_data gef_hal_handle;

typedef enum {
    ASM = 0,
    ADM
} gef_calibration_type;

typedef enum {
    AUDIO_DEVICE_CAL_TYPE = 0,
    AUDIO_STREAM_CAL_TYPE,
} acdb_device_type;


void audio_extn_gef_init(std::shared_ptr<AudioDevice> adev)
{
    const char* error = NULL;
    gef_get_pal_info fp = audio_extn_get_pal_info;

    memset(&gef_hal_handle, 0, sizeof(gef_data));

    //: check error for dlopen
    gef_hal_handle.handle = dlopen(GEF_LIBRARY, RTLD_LAZY);
    if (gef_hal_handle.handle == NULL) {
        AHAL_ERR("DLOPEN failed for %s with error %s",
                 GEF_LIBRARY, dlerror());
        goto ERROR_RETURN;
    } else {
        AHAL_VERBOSE("DLOPEN successful for %s", GEF_LIBRARY);

        //call dlerror to clear the error
        dlerror();
        gef_hal_handle.init =
            (gef_init_t)dlsym(gef_hal_handle.handle, "gef_init");

        if (!gef_hal_handle.init)
            goto ERROR_RETURN;

        error = dlerror();

        if(error != NULL) {
            AHAL_ERR("dlsym of %s failed with error %s",
                     "gef_init", error);
            goto ERROR_RETURN;
        }

        //call dlerror to clear the error
        dlerror();
        gef_hal_handle.deinit =
            (gef_deinit_t)dlsym(gef_hal_handle.handle, "gef_deinit");
        error = dlerror();

        if(error != NULL) {
            AHAL_ERR("dlsym of %s failed with error %s",
                     "gef_deinit", error);
            goto ERROR_RETURN;
        }

        //call dlerror to clear the error
        error = dlerror();
        gef_hal_handle.device_config_cb =
            (gef_device_config_cb_t)dlsym(gef_hal_handle.handle,
             "gef_device_config_cb");
        error = dlerror();

        if(error != NULL) {
            AHAL_ERR("dlsym of %s failed with error %s",
                     "gef_device_config_cb", error);
            goto ERROR_RETURN;
        }

        gef_hal_handle.gef_ptr = gef_hal_handle.init((void *)(adev.get()), fp);
    }

ERROR_RETURN:
    AHAL_VERBOSE("Exit with error ");
    return;
}


//this will be called from GEF to exchange calibration using acdb
int audio_extn_gef_send_audio_cal(void* data, int length)
{
    int ret = 0;
    if (!data) {
        AHAL_ERR("GEF data is null");
        return -EINVAL;
    }

    std::shared_ptr<AudioDevice> adevice = AudioDevice::GetInstance();
    if (adevice) {
        ret = adevice->SetGEFParam(data, length);
    } else {
        AHAL_ERR("unable to get audio device");
        return -EINVAL;
    }

    AHAL_VERBOSE("Exit with error %d", ret);

    return ret;
}

//this will be called from GEF to exchange calibration using acdb
int audio_extn_gef_get_audio_cal(void* data, int *length)
{
    int ret = 0;
    if (!data) {
        AHAL_ERR("GEF data is null");
        return -EINVAL;
    }

    std::shared_ptr<AudioDevice> adevice = AudioDevice::GetInstance();
    if (adevice) {
        ret = adevice->GetGEFParam(data, length);
    } else {
        AHAL_ERR("unable to get audio device");
        return -EINVAL;
    }

    AHAL_VERBOSE("Exit with error %d", ret);

    return ret;

}

//this will be called from GEF to store into acdb
int audio_extn_gef_store_audio_cal(void* data __unused, int length __unused)
{
    AHAL_ERR("not supported by pal now.\n");

    return -ENOSYS;
}

//this will be called from GEF to retrieve calibration using acdb
int audio_extn_gef_retrieve_audio_cal(void* data __unused,
    int* length __unused)
{
    AHAL_ERR("not supported by pal now.\n");

    return -ENOSYS;
}

//this will be called from HAL to notify GEF of new device configuration
void audio_extn_gef_notify_device_config(audio_devices_t audio_device,
    audio_channel_mask_t channel_mask, int sample_rate, int stream_type)
{
    AHAL_VERBOSE("Enter");

    //call into GEF to share channel mask and device info
    if (gef_hal_handle.handle && gef_hal_handle.device_config_cb) {
        gef_hal_handle.device_config_cb(gef_hal_handle.gef_ptr, audio_device,
            channel_mask, sample_rate, stream_type);
    }

    AHAL_VERBOSE("Exit");

    return;
}

void audio_extn_gef_deinit(std::shared_ptr<AudioDevice> adev __unused)
{
    AHAL_VERBOSE("Enter");

    if (gef_hal_handle.handle) {
        if (gef_hal_handle.handle && gef_hal_handle.deinit)
            gef_hal_handle.deinit(gef_hal_handle.gef_ptr);
        dlclose(gef_hal_handle.handle);
    }

    memset(&gef_hal_handle, 0, sizeof(gef_data));

    AHAL_VERBOSE("Exit");
}

int audio_extn_get_pal_info(void *hal_data,
                                const audio_devices_t hal_device_id,
                                 pal_device_id_t *pal_device_id,
                                 audio_output_flags_t hal_stream_flag,
                                 pal_stream_type_t *pal_stream_type)
{
    int device_count = 0;
    AudioDevice *adev = nullptr;

    if (hal_data) {
        adev = (AudioDevice *)hal_data;
        device_count = adev->GetPalDeviceIds({hal_device_id}, pal_device_id);
        *pal_stream_type = StreamOutPrimary::GetPalStreamType(hal_stream_flag);
        return device_count;
    }

    return -EINVAL;
}
#endif