vad.h

Go to the documentation of this file.

/* -*- c-basic-offset:4; indent-tabs-mode: nil -*- */
/* ====================================================================
 * Copyright (c) 2022 David Huggins-Daines.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR 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.
 * ====================================================================
 */
#ifndef __PS_VAD_H__
#define __PS_VAD_H__
 
 
#include <pocketsphinx/prim_type.h>
#include <pocketsphinx/export.h>
 
#ifdef __cplusplus
extern "C" {
#endif
#if 0
}
#endif
 
typedef struct ps_vad_s ps_vad_t;
 
typedef enum ps_vad_mode_e {
    PS_VAD_LOOSE = 0,
    PS_VAD_MEDIUM_LOOSE = 1,
    PS_VAD_MEDIUM_STRICT = 2,
    PS_VAD_STRICT = 3
} ps_vad_mode_t;
 
typedef enum ps_vad_class_e {
    PS_VAD_ERROR = -1,
    PS_VAD_NOT_SPEECH = 0,
    PS_VAD_SPEECH = 1
} ps_vad_class_t;
 
#define PS_VAD_DEFAULT_SAMPLE_RATE 16000
 
#define PS_VAD_DEFAULT_FRAME_LENGTH 0.03
 
POCKETSPHINX_EXPORT
ps_vad_t *ps_vad_init(ps_vad_mode_t mode, int sample_rate, double frame_length);
 
POCKETSPHINX_EXPORT
ps_vad_t *ps_vad_retain(ps_vad_t *vad);
 
POCKETSPHINX_EXPORT
int ps_vad_free(ps_vad_t *vad);
 
POCKETSPHINX_EXPORT
int ps_vad_set_input_params(ps_vad_t *vad, int sample_rate, double frame_length);
 
POCKETSPHINX_EXPORT
int ps_vad_sample_rate(ps_vad_t *vad);
 
POCKETSPHINX_EXPORT
size_t ps_vad_frame_size(ps_vad_t *vad);
 
#define ps_vad_frame_length(vad) ((double)ps_vad_frame_size(vad) / ps_vad_sample_rate(vad))
 
POCKETSPHINX_EXPORT
ps_vad_class_t ps_vad_classify(ps_vad_t *vad, const int16 *frame);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PS_VAD_H__ */