porcupine/demo/c/pvrecorder/include/pv_circular_buffer.h

Go to the documentation of this file.

/*
    Copyright 2021 Picovoice Inc.
 
    You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
    file accompanying this source.
 
    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
    an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
    specific language governing permissions and limitations under the License.
*/
 
#ifndef PV_CIRCULAR_BUFFER_H
#define PV_CIRCULAR_BUFFER_H
 
#include <stdbool.h>
#include <stdint.h>
 
typedef struct pv_circular_buffer pv_circular_buffer_t;
 
typedef enum {
    PV_CIRCULAR_BUFFER_STATUS_SUCCESS = 0,
    PV_CIRCULAR_BUFFER_STATUS_OUT_OF_MEMORY,
    PV_CIRCULAR_BUFFER_STATUS_INVALID_ARGUMENT,
    PV_CIRCULAR_BUFFER_STATUS_WRITE_OVERFLOW,
} pv_circular_buffer_status_t;
 
pv_circular_buffer_status_t pv_circular_buffer_init(
        int32_t capacity,
        int32_t element_size,
        pv_circular_buffer_t **object);
 
void pv_circular_buffer_delete(pv_circular_buffer_t *object);
 
int32_t pv_circular_buffer_read(pv_circular_buffer_t *object, void *buffer, int32_t length);
 
pv_circular_buffer_status_t pv_circular_buffer_write(pv_circular_buffer_t *object, const void *buffer, int32_t length);
 
void pv_circular_buffer_reset(pv_circular_buffer_t *object);
 
const char *pv_circular_buffer_status_to_string(pv_circular_buffer_status_t status);
 
#endif //PV_CIRCULAR_BUFFER_H