endpointer.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_ENDPOINTER_H__
#define __PS_ENDPOINTER_H__
 
 
#include <pocketsphinx/prim_type.h>
#include <pocketsphinx/export.h>
 
#ifdef __cplusplus
extern "C" {
#endif
#if 0
}
#endif
 
#include <pocketsphinx/prim_type.h>
#include <pocketsphinx/export.h>
#include <pocketsphinx/vad.h>
 
typedef struct ps_endpointer_s ps_endpointer_t;
 
typedef double (*ps_endpointer_timestamp_cb_t)(void *user_data);
 
#define PS_ENDPOINTER_DEFAULT_WINDOW 0.3
#define PS_ENDPOINTER_DEFAULT_RATIO 0.9
 
POCKETSPHINX_EXPORT
ps_endpointer_t *ps_endpointer_init(double window,
                                    double ratio,
                                    ps_vad_mode_t mode,
                                    int sample_rate, double frame_length);
 
POCKETSPHINX_EXPORT
ps_endpointer_t *ps_endpointer_retain(ps_endpointer_t *ep);
 
POCKETSPHINX_EXPORT
int ps_endpointer_free(ps_endpointer_t *ep);
 
POCKETSPHINX_EXPORT
ps_vad_t *ps_endpointer_vad(ps_endpointer_t *ep);
 
#define ps_endpointer_frame_size(ep) ps_vad_frame_size(ps_endpointer_vad(ep))
 
#define ps_endpointer_frame_length(ep) ps_vad_frame_length(ps_endpointer_vad(ep))
 
#define ps_endpointer_sample_rate(ep) ps_vad_sample_rate(ps_endpointer_vad(ep))
 
POCKETSPHINX_EXPORT
const int16 *ps_endpointer_process(ps_endpointer_t *ep,
                                   const int16 *frame);
 
POCKETSPHINX_EXPORT
const int16 *ps_endpointer_end_stream(ps_endpointer_t *ep,
                                      const int16 *frame,
                                      size_t nsamp,
                                      size_t *out_nsamp);
 
POCKETSPHINX_EXPORT
int ps_endpointer_in_speech(ps_endpointer_t *ep);
 
POCKETSPHINX_EXPORT
double ps_endpointer_speech_start(ps_endpointer_t *ep);
 
POCKETSPHINX_EXPORT
double ps_endpointer_speech_end(ps_endpointer_t *ep);
 
POCKETSPHINX_EXPORT
int ps_endpointer_set_timestamp_func(ps_endpointer_t *ep,
                                     ps_endpointer_timestamp_cb_t cb,
                                     void *user_data);
 
POCKETSPHINX_EXPORT
double ps_endpointer_timestamp(ps_endpointer_t *ep);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PS_ENDPOINTER_H__ */