Skip to content

File ns_audio_mfcc.h

FileList > includes-api > ns_audio_mfcc.h

Go to the source code of this file

Confifurable MFCC Calculator. More...

  • #include "arm_math.h"
  • #include "ns_audio_features_common.h"
  • #include "ns_core.h"
  • #include "string.h"

Classes

Type Name
struct ns_mfcc_cfg_t
Config and state for MFCC calculator.

Public Attributes

Type Name
const ns_core_api_t ns_mfcc_V0_0_1
const ns_core_api_t ns_mfcc_V1_0_0
const ns_core_api_t ns_mfcc_current_version
const ns_core_api_t ns_mfcc_oldest_supported_version

Public Functions

Type Name
uint32_t ns_mfcc_compute (ns_mfcc_cfg_t * c, const int16_t * audio_data, float * mfcc_out)
Computes MFCC based on audio data.
uint32_t ns_mfcc_init (ns_mfcc_cfg_t * c)
Initializes the MFCC calculator based on desired configuration.

Macros

Type Name
define M_2PI 6.283185307179586476925286766559005
define M_PI 3.14159265358979323846264338328
define NS_MFCC_API_ID 0xCA0005
define NS_MFCC_CURRENT_VERSION NS_MFCC_V1_0_0
define NS_MFCC_OLDEST_SUPPORTED_VERSION NS_MFCC_V0_0_1
define NS_MFCC_SIZEBINS 53
define NS_MFCC_V0_0_1 { .major = 0, .minor = 0, .revision = 1 }
define NS_MFCC_V1_0_0 { .major = 1, .minor = 0, .revision = 0 }

Detailed Description

Author:

Carlos Morales

Version:

0.1

Date:

2022-08-12

This MFCC utility is adapted from Arm's example C++ implementation. It can be configured via DEFINES, but better config support is planned.

Copyright:

Copyright (c) 2022

Public Attributes Documentation

variable ns_mfcc_V0_0_1

const ns_core_api_t ns_mfcc_V0_0_1;

variable ns_mfcc_V1_0_0

const ns_core_api_t ns_mfcc_V1_0_0;

variable ns_mfcc_current_version

const ns_core_api_t ns_mfcc_current_version;

variable ns_mfcc_oldest_supported_version

const ns_core_api_t ns_mfcc_oldest_supported_version;

Public Functions Documentation

function ns_mfcc_compute

Computes MFCC based on audio data. 

uint32_t ns_mfcc_compute (
    ns_mfcc_cfg_t * c,
    const int16_t * audio_data,
    float * mfcc_out
)

Parameters:

  • c - configuration struct (see ns_mfcc_cfg_t) from ns_mfcc_init
  • audio_data - pointer to audio data (int16_t)
  • mfcc_out - pointer to output buffer (float)

Returns:

uint32_t

function ns_mfcc_init

Initializes the MFCC calculator based on desired configuration. 

uint32_t ns_mfcc_init (
    ns_mfcc_cfg_t * c
)

Parameters:

Returns:

uint32_t status

Macro Definition Documentation

define M_2PI

#define M_2PI 6.283185307179586476925286766559005

define M_PI

#define M_PI 3.14159265358979323846264338328

define NS_MFCC_API_ID

#define NS_MFCC_API_ID 0xCA0005

define NS_MFCC_CURRENT_VERSION

#define NS_MFCC_CURRENT_VERSION NS_MFCC_V1_0_0

define NS_MFCC_OLDEST_SUPPORTED_VERSION

#define NS_MFCC_OLDEST_SUPPORTED_VERSION NS_MFCC_V0_0_1

define NS_MFCC_SIZEBINS

#define NS_MFCC_SIZEBINS 53

define NS_MFCC_V0_0_1

#define NS_MFCC_V0_0_1 { .major = 0, .minor = 0, .revision = 1 }

define NS_MFCC_V1_0_0

#define NS_MFCC_V1_0_0 { .major = 1, .minor = 0, .revision = 0 }

The documentation for this class was generated from the following file neuralSPOT/neuralspot/ns-audio/includes-api/ns_audio_mfcc.h