igo_lib.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2021 Intelligo Technology Inc. All rights reserved.
 *
 * Author: Fu-Yun TSUO <fy.tsuo@intelli-go.com>
 */
 
/*******************************************************************************
 * [2017] - [2021] Copyright (c) Intelligo Technology Inc.
 *
 * This unpublished material is proprietary to Intelligo Technology Inc.
 * All rights reserved. The methods and techniques described herein are
 * considered trade secrets and/or confidential. Reproduction or
 * distribution, in whole or in part, is forbidden except by express written
 * permission of Intelligo Technology Inc.
 *
 *******************************************************************************/
 
#ifndef _IGO_LIB_H_
#define _IGO_LIB_H_
 
#include <stdint.h>
 
enum IgoRet {
    IGO_RET_OK = 0,
    IGO_RET_ERR,
    IGO_RET_NO_SERVICE,
    IGO_RET_INVL_ARG,
    IGO_RET_NO_MEMORY,
    IGO_RET_NOT_SUPPORT,
    IGO_RET_ALGO_NAME_NOT_FOUND,
    IGO_RET_CH_NUM_ERR,
    IGO_RET_SAMPLING_RATE_NOT_SUPPORT,
    IGO_RET_IN_DATA_ERR,
    IGO_RET_REF_DATA_ERR,
    IGO_RET_OUT_DATA_ERR,
    IGO_RET_PARAM_NOT_FOUND,
    IGO_RET_PARAM_READ_ONLY,
    IGO_RET_PARAM_WRITE_ONLY,
    IGO_RET_PARAM_INVALID_VAL,
    IGO_RET_LAST
};
 
enum IgoDataWidth {
    IGO_DATA_16BIT = 0,
    IGO_DATA_24BIT,
    IGO_DATA_LAST
};

struct IgoLibInfo {
    uint32_t major_version; /* Major version */
    uint32_t minor_version; /* Minor version */
    uint32_t build_version; /* Build version */
    uint32_t ext_version;   /* Extension version */
    uint32_t handle_size;   /* Size of handle structure */
};

struct IgoStreamData {
    void *data;              /* Data array */
    enum IgoDataWidth data_width; /* Specify audio data bit width */
    uint16_t sample_num;     /* Sample number in this data bulk */
    uint16_t sampling_rate;  /* Sampling rate for the data stream */
};

struct IgoLibConfig {
    const char *algo_name; /* Algorithm name */
    uint8_t in_ch_num;     /* Input channel number for the algo instance */
    uint8_t ref_ch_num;    /* Reference channel number for the algo instance */
    uint8_t out_ch_num;    /* Output channel number for the algo instance */
};
 
#ifdef __cplusplus
extern "C" {
#endif

enum IgoRet IgoLibGetInfo(struct IgoLibInfo *info);

enum IgoRet IgoLibInit(void *handle,
               const struct IgoLibConfig *config,
               void *param);

enum IgoRet IgoLibProcess(void *handle,
              const struct IgoStreamData *in,
              const struct IgoStreamData *ref,
              const struct IgoStreamData *out);
 
#ifdef __cplusplus
}
#endif
 
#endif