iadk_module_adapter.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2022 Intel Corporation. All rights reserved.
 *
 * Author: Jaroslaw Stelter <jaroslaw.stelter@intel.com>
 *
 */
 
#ifndef _IADK_MODULE_ADAPTER_H
#define _IADK_MODULE_ADAPTER_H
 
#ifdef __cplusplus
 
#include <processing_module_interface.h>
#include <module_initial_settings.h>
#include <adsp_stddef.h>
#include <system_error.h>
#include <sof/common.h>
#include <api_version.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <sof/audio/module_adapter/module/module_interface.h>
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
extern "C" {
namespace dsp_fw
{
    class IadkModuleAdapter
    {
    public:
        IadkModuleAdapter(intel_adsp::ProcessingModuleInterface &processing_module,
                          void *comp_dev_instance,
                          uint32_t module_id,
                          uint32_t instance_id,
                          uint32_t core_id,
                          size_t module_size);
 
        int IadkModuleAdapter_Init(void);
 
        int IadkModuleAdapter_Prepare(void);
 
        int IadkModuleAdapter_Process(struct sof_source **sources,
                          int num_of_sources,
                          struct sof_sink **sinks,
                          int num_of_sinks);
 
        AdspErrorCode
        IadkModuleAdapter_SetConfiguration(uint32_t config_id,
                                       enum module_cfg_fragment_position fragment_position,
                                       uint32_t data_offset_size,
                                       const uint8_t *fragment_buffer,
                                       size_t fragment_size,
                                       uint8_t *response,
                                       size_t &response_size) /*override*/;
 
        AdspErrorCode
        IadkModuleAdapter_GetConfiguration(uint32_t config_id,
                                       enum module_cfg_fragment_position fragment_position,
                                       uint32_t &data_offset_size,
                                       uint8_t *fragment_buffer,
                                       size_t &fragment_size);
        void IadkModuleAdapter_Reset(void);
        int IadkModuleAdapter_Free(void);
        void IadkModuleAdapter_SetProcessingMode(enum module_processing_mode sof_mode);
 
        enum module_processing_mode IadkModuleAdapter_GetProcessingMode(void);
 
    private:
 
        intel_adsp::ProcessingModuleInterface &processing_module_;
    };
 
STATIC_ASSERT(sizeof(IadkModuleAdapter) <= IADK_MODULE_PASS_BUFFER_SIZE, IadkModuleAdapter_too_big);
 
} /* namespace dsp_fw */
 
} /* extern "C" */
 
void *operator new(size_t size, intel_adsp::InputStreamBuffer *placeholder) throw();
void *operator new(size_t size, intel_adsp::OutputStreamBuffer *placeholder) throw();
 
#else /* __cplusplus */
 
/* C wrappers for C++  ProcessingModuleInterface() methods. */
int iadk_wrapper_init(void *md);
 
int iadk_wrapper_prepare(void *md);
 
int iadk_wrapper_set_processing_mode(void *md, enum module_processing_mode mode);
 
enum module_processing_mode iadk_wrapper_get_processing_mode(void *md);
 
int iadk_wrapper_reset(void *md);
 
int iadk_wrapper_free(void *md);
 
int iadk_wrapper_set_configuration(void *md, uint32_t config_id,
                   enum module_cfg_fragment_position pos,
                   uint32_t data_offset_size,
                   const uint8_t *fragment, size_t fragment_size,
                   uint8_t *response, size_t response_size);
 
/*
 * \brief Retrieve module configuration
 * \param[in] md - struct IadkModuleAdapter pointer
 * \param[in] config_id - Configuration ID
 * \param[in] pos - position of the fragment in the large message
 * \param[in] data_offset_size: size of the whole configuration if it is the first fragment or the
 *        only fragment. Otherwise, it is the offset of the fragment in the whole configuration.
 * \param[in] fragment: configuration fragment buffer
 * \param[in,out] fragment_size: size of @fragment
 *
 * \return: 0 upon success or error upon failure
 */
int iadk_wrapper_get_configuration(void *md, uint32_t config_id,
                   enum module_cfg_fragment_position pos,
                   uint32_t *data_offset_size,
                   uint8_t *fragment, size_t *fragment_size);
 
int iadk_wrapper_process(void *md,
             struct sof_source **sources, int num_of_sources,
             struct sof_sink **sinks, int num_of_sinks);
 
#endif /* __cplusplus */
 
#endif /*_IADK_MODULE_ADAPTER_H */