nugu_audio.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_AUDIO_H__
#define __NUGU_AUDIO_H__
 
#include <nugu.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define NUGU_AUDIO_ATTRIBUTE_MUSIC_DEFAULT_STRING "MUSIC"
#define NUGU_AUDIO_ATTRIBUTE_RINGTONE_DEFAULT_STRING "RINGTONE"
#define NUGU_AUDIO_ATTRIBUTE_CALL_DEFAULT_STRING "CALL"
#define NUGU_AUDIO_ATTRIBUTE_NOTIFICATION_DEFAULT_STRING "NOTIFICATION"
#define NUGU_AUDIO_ATTRIBUTE_ALARM_DEFAULT_STRING "ALARM"
#define NUGU_AUDIO_ATTRIBUTE_VOICE_COMMAND_DEFAULT_STRING "VOICE_COMMAND"
#define NUGU_AUDIO_ATTRIBUTE_NAVIGATION_DEFAULT_STRING "NAVIGATION"
#define NUGU_AUDIO_ATTRIBUTE_SYSTEM_SOUND_DEFAULT_STRING "SYSTEM_SOUND"
 
enum nugu_audio_sample_rate {
        NUGU_AUDIO_SAMPLE_RATE_8K, 
        NUGU_AUDIO_SAMPLE_RATE_16K, 
        NUGU_AUDIO_SAMPLE_RATE_32K, 
        NUGU_AUDIO_SAMPLE_RATE_22K, 
        NUGU_AUDIO_SAMPLE_RATE_44K, 
        NUGU_AUDIO_SAMPLE_RATE_MAX
};
 
enum nugu_audio_format {
        NUGU_AUDIO_FORMAT_S8, 
        NUGU_AUDIO_FORMAT_U8, 
        NUGU_AUDIO_FORMAT_S16_LE, 
        NUGU_AUDIO_FORMAT_S16_BE, 
        NUGU_AUDIO_FORMAT_U16_LE, 
        NUGU_AUDIO_FORMAT_U16_BE, 
        NUGU_AUDIO_FORMAT_S24_LE, 
        NUGU_AUDIO_FORMAT_S24_BE, 
        NUGU_AUDIO_FORMAT_U24_LE, 
        NUGU_AUDIO_FORMAT_U24_BE, 
        NUGU_AUDIO_FORMAT_S32_LE, 
        NUGU_AUDIO_FORMAT_S32_BE, 
        NUGU_AUDIO_FORMAT_U32_LE, 
        NUGU_AUDIO_FORMAT_U32_BE, 
        NUGU_AUDIO_FORMAT_MAX
};
 
enum nugu_audio_attribute {
        NUGU_AUDIO_ATTRIBUTE_MUSIC = 1, 
        NUGU_AUDIO_ATTRIBUTE_RINGTONE, 
        NUGU_AUDIO_ATTRIBUTE_CALL, 
        NUGU_AUDIO_ATTRIBUTE_NOTIFICATION,
        NUGU_AUDIO_ATTRIBUTE_ALARM, 
        NUGU_AUDIO_ATTRIBUTE_VOICE_COMMAND,
        NUGU_AUDIO_ATTRIBUTE_NAVIGATION, 
        NUGU_AUDIO_ATTRIBUTE_SYSTEM_SOUND
};
 
struct nugu_audio_property {
        enum nugu_audio_sample_rate samplerate;
        enum nugu_audio_format format;
        int channel;
};
 
typedef enum nugu_audio_attribute NuguAudioAttribute;
 
typedef struct nugu_audio_property NuguAudioProperty;
 
NUGU_API void nugu_audio_set_attribute_str(const NuguAudioAttribute attribute,
                                           const char *str);
 
NUGU_API const char *
nugu_audio_get_attribute_str(const NuguAudioAttribute attribute);
 
NUGU_API NuguAudioAttribute nugu_audio_get_attribute(const char *str);
 
#ifdef __cplusplus
}
#endif
 
#endif