mfcc.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2022 Intel Corporation. All rights reserved.
 *
 * Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 */
 
#ifndef __USER_MFCC_H__
#define __USER_MFCC_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#define MFCC_BLACKMAN_A0 Q_CONVERT_FLOAT(0.42, 15) /* For MFCC */
 
#define SOF_MFCC_CONFIG_MAX_SIZE    256 /* Max size for configuration data in bytes */
 
enum sof_mfcc_fft_pad_type {
    MFCC_PAD_END = 0,
    MFCC_PAD_CENTER = 1,
    MFCC_PAD_START = 2,
};
 
enum sof_mfcc_fft_window_type {
    MFCC_RECTANGULAR_WINDOW = 0,
    MFCC_BLACKMAN_WINDOW = 1,
    MFCC_HAMMING_WINDOW = 2,
    MFCC_HANN_WINDOW = 3,
    MFCC_POVEY_WINDOW = 4,
};
 
enum sof_mfcc_mel_log_type {
    MEL_LOG_IS_LOG = 0,
    MEL_LOG_IS_LOG10 = 1,
    MEL_LOG_IS_DB = 2
};
 
enum sof_mfcc_mel_norm_type {
    MFCC_MEL_NORM_NONE = 0,
    MFCC_MEL_NORM_SLANEY = 1,
};
 
enum sof_mfcc_dct_type {
    MFCC_DCT_I = 0,
    MFCC_DCT_II = 1,
};
 
/*
 * Configuration blob
 */
struct sof_mfcc_config {
    uint32_t size; 
    int16_t mel_offset; 
    int16_t mel_scale; 
    int16_t mmax_init; 
    int16_t mmax_coef; 
    uint16_t dtx_trailing_silence_hops; 
    uint16_t dtx_silence_hops_interval; 
    uint32_t reserved[5];
    int32_t sample_frequency; 
    int32_t pmin; 
    enum sof_mfcc_mel_log_type mel_log; 
    enum sof_mfcc_mel_norm_type norm; 
    enum sof_mfcc_fft_pad_type pad; 
    enum sof_mfcc_fft_window_type window; 
    enum sof_mfcc_dct_type dct; 
    int16_t blackman_coef; 
    int16_t cepstral_lifter; 
    int16_t channel; 
    int16_t dither; 
    int16_t frame_length; 
    int16_t frame_shift; 
    int16_t high_freq;  
    int16_t low_freq; 
    int16_t num_ceps; 
    int16_t num_mel_bins; 
    int16_t preemphasis_coefficient; 
    int16_t top_db; 
    int16_t vtln_high; 
    int16_t vtln_low; 
    int16_t vtln_warp; 
    int16_t reserved16[3]; 
    bool htk_compat; 
    bool raw_energy; 
    bool remove_dc_offset; 
    bool round_to_power_of_two; 
    bool snip_edges; 
    bool subtract_mean; 
    bool use_energy; 
    bool dynamic_mmax; 
    bool enable_vad; 
    bool enable_dtx; 
    bool update_controls; 
    bool compress_output; 
    bool reserved_bool[4]; /* Reserved for future boolean flags, set to false (0) */
} __attribute__((packed));
 
#endif /* __USER_MFCC_H__ */