nugu_encoder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 SK Telecom Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 __NUGU_ENCODER_H__
#define __NUGU_ENCODER_H__
 
#include <nugu.h>
#include <base/nugu_pcm.h>
#include <base/nugu_buffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _nugu_encoder NuguEncoder;
 
typedef struct _nugu_encoder_driver NuguEncoderDriver;
 
NUGU_API NuguEncoder *nugu_encoder_new(NuguEncoderDriver *driver,
                                       NuguAudioProperty property);
 
NUGU_API int nugu_encoder_free(NuguEncoder *enc);
 
NUGU_API int nugu_encoder_set_driver_data(NuguEncoder *enc, void *data);
 
NUGU_API void *nugu_encoder_get_driver_data(NuguEncoder *enc);
 
NUGU_API void *nugu_encoder_encode(NuguEncoder *enc, int is_last,
                                   const void *data, size_t data_len,
                                   size_t *output_len);
 
NUGU_API const char *nugu_encoder_get_codec(NuguEncoder *enc);
 
NUGU_API const char *nugu_encoder_get_mime_type(NuguEncoder *enc);
 
enum nugu_encoder_type {
        NUGU_ENCODER_TYPE_SPEEX, 
        NUGU_ENCODER_TYPE_OPUS, 
        NUGU_ENCODER_TYPE_CUSTOM = 99 
};
 
struct nugu_encoder_driver_ops {
        int (*create)(NuguEncoderDriver *driver, NuguEncoder *enc,
                      NuguAudioProperty property);
 
        int (*encode)(NuguEncoderDriver *driver, NuguEncoder *enc, int is_last,
                      const void *data, size_t data_len, NuguBuffer *out_buf);
        int (*destroy)(NuguEncoderDriver *driver, NuguEncoder *enc);
};
 
NUGU_API NuguEncoderDriver *
nugu_encoder_driver_new(const char *name, enum nugu_encoder_type type,
                        struct nugu_encoder_driver_ops *ops);
 
NUGU_API int nugu_encoder_driver_free(NuguEncoderDriver *driver);
 
NUGU_API int nugu_encoder_driver_register(NuguEncoderDriver *driver);
 
NUGU_API int nugu_encoder_driver_remove(NuguEncoderDriver *driver);
 
NUGU_API NuguEncoderDriver *nugu_encoder_driver_find(const char *name);
 
NUGU_API NuguEncoderDriver *
nugu_encoder_driver_find_bytype(enum nugu_encoder_type type);
 
#ifdef __cplusplus
}
#endif
 
#endif