nugu_pcm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 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_PCM_H__
#define __NUGU_PCM_H__
 
#include <stddef.h>
#include <nugu.h>
#include <base/nugu_audio.h>
#include <base/nugu_media.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _nugu_pcm NuguPcm;
 
typedef struct _nugu_pcm_driver NuguPcmDriver;
 
NUGU_API NuguPcm *nugu_pcm_new(const char *name, NuguPcmDriver *driver,
                               NuguAudioProperty property);
 
NUGU_API void nugu_pcm_free(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_add(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_remove(NuguPcm *pcm);
 
NUGU_API NuguPcm *nugu_pcm_find(const char *name);
 
NUGU_API int nugu_pcm_set_audio_attribute(NuguPcm *pcm,
                                          NuguAudioAttribute attr);
 
NUGU_API int nugu_pcm_get_audio_attribute(NuguPcm *pcm);
 
NUGU_API const char *nugu_pcm_get_audio_attribute_str(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_start(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_stop(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_pause(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_resume(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_set_volume(NuguPcm *pcm, int volume);
 
NUGU_API int nugu_pcm_get_volume(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_get_duration(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_get_position(NuguPcm *pcm);
 
NUGU_API enum nugu_media_status nugu_pcm_get_status(NuguPcm *pcm);
 
NUGU_API void nugu_pcm_set_status_callback(NuguPcm *pcm,
                                           NuguMediaStatusCallback cb,
                                           void *userdata);
 
NUGU_API void nugu_pcm_emit_status(NuguPcm *pcm, enum nugu_media_status status);
 
NUGU_API void nugu_pcm_set_event_callback(NuguPcm *pcm,
                                          NuguMediaEventCallback cb,
                                          void *userdata);
 
NUGU_API void nugu_pcm_emit_event(NuguPcm *pcm, enum nugu_media_event event);
 
NUGU_API int nugu_pcm_set_driver_data(NuguPcm *pcm, void *data);
 
NUGU_API void *nugu_pcm_get_driver_data(NuguPcm *pcm);
 
NUGU_API void nugu_pcm_clear_buffer(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_push_data(NuguPcm *pcm, const char *data, size_t size,
                                int is_last);
 
NUGU_API int nugu_pcm_push_data_done(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_get_data(NuguPcm *pcm, char *data, size_t size);
 
NUGU_API size_t nugu_pcm_get_data_size(NuguPcm *pcm);
 
NUGU_API int nugu_pcm_receive_is_last_data(NuguPcm *pcm);
 
struct nugu_pcm_driver_ops {
        int (*create)(NuguPcmDriver *driver, NuguPcm *pcm,
                      NuguAudioProperty property);
 
        void (*destroy)(NuguPcmDriver *driver, NuguPcm *pcm);
 
        int (*start)(NuguPcmDriver *driver, NuguPcm *pcm);
 
        int (*push_data)(NuguPcmDriver *driver, NuguPcm *pcm, const char *data,
                         size_t size, int is_last);
 
        int (*stop)(NuguPcmDriver *driver, NuguPcm *pcm);
 
        int (*pause)(NuguPcmDriver *driver, NuguPcm *pcm);
 
        int (*resume)(NuguPcmDriver *driver, NuguPcm *pcm);
 
        int (*set_volume)(NuguPcmDriver *driver, NuguPcm *pcm, int volume);
 
        int (*get_position)(NuguPcmDriver *driver, NuguPcm *pcm);
};
 
NUGU_API NuguPcmDriver *nugu_pcm_driver_new(const char *name,
                                            struct nugu_pcm_driver_ops *ops);
 
NUGU_API int nugu_pcm_driver_free(NuguPcmDriver *driver);
 
NUGU_API int nugu_pcm_driver_register(NuguPcmDriver *driver);
 
NUGU_API int nugu_pcm_driver_remove(NuguPcmDriver *driver);
 
NUGU_API int nugu_pcm_driver_set_default(NuguPcmDriver *driver);
 
NUGU_API NuguPcmDriver *nugu_pcm_driver_get_default(void);
 
NUGU_API NuguPcmDriver *nugu_pcm_driver_find(const char *name);
 
#ifdef __cplusplus
}
#endif
 
#endif