speaker_interface.hh

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_SPEAKER_INTERFACE_H__
#define __NUGU_SPEAKER_INTERFACE_H__
 
#include <base/nugu_audio.h>
#include <clientkit/capability_interface.hh>
#include <nugu.h>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
#define NUGU_SPEAKER_NUGU_STRING "NUGU"
#define NUGU_SPEAKER_MUSIC_STRING NUGU_AUDIO_ATTRIBUTE_MUSIC_DEFAULT_STRING
#define NUGU_SPEAKER_RINGTONE_STRING NUGU_AUDIO_ATTRIBUTE_RINGTONE_DEFAULT_STRING
#define NUGU_SPEAKER_CALL_STRING NUGU_AUDIO_ATTRIBUTE_CALL_DEFAULT_STRING
#define NUGU_SPEAKER_NOTIFICATION_STRING NUGU_AUDIO_ATTRIBUTE_NOTIFICATION_DEFAULT_STRING
#define NUGU_SPEAKER_ALARM_STRING NUGU_AUDIO_ATTRIBUTE_ALARM_DEFAULT_STRING
#define NUGU_SPEAKER_VOICE_COMMAND_STRING NUGU_AUDIO_ATTRIBUTE_VOICE_COMMAND_DEFAULT_STRING
#define NUGU_SPEAKER_NAVIGATION_STRING NUGU_AUDIO_ATTRIBUTE_NAVIGATION_DEFAULT_STRING
#define NUGU_SPEAKER_SYSTEM_SOUND_STRING NUGU_AUDIO_ATTRIBUTE_SYSTEM_SOUND_DEFAULT_STRING
 
#define NUGU_SPEAKER_MIN_VOLUME 0 
#define NUGU_SPEAKER_MAX_VOLUME 100 
#define NUGU_SPEAKER_DEFAULT_VOLUME 50 
#define NUGU_SPEAKER_DEFAULT_STEP 10 
#define NUGU_SPEAKER_UNABLE_CONTROL -1 
enum class SpeakerType {
    NUGU = 0, 
    MUSIC = NUGU_AUDIO_ATTRIBUTE_MUSIC, 
    RINGTONE = NUGU_AUDIO_ATTRIBUTE_RINGTONE, 
    CALL = NUGU_AUDIO_ATTRIBUTE_CALL, 
    NOTIFICATION = NUGU_AUDIO_ATTRIBUTE_NOTIFICATION, 
    ALARM = NUGU_AUDIO_ATTRIBUTE_ALARM, 
    VOICE_COMMAND = NUGU_AUDIO_ATTRIBUTE_VOICE_COMMAND,
    NAVIGATION = NUGU_AUDIO_ATTRIBUTE_NAVIGATION, 
    SYSTEM_SOUND = NUGU_AUDIO_ATTRIBUTE_SYSTEM_SOUND 
};
 
class NUGU_API SpeakerInfo {
public:
    SpeakerInfo() = default;
    ~SpeakerInfo() = default;
 
    SpeakerType type = SpeakerType::NUGU; 
    std::string group; 
    int min = NUGU_SPEAKER_MIN_VOLUME; 
    int max = NUGU_SPEAKER_MAX_VOLUME; 
    int volume = NUGU_SPEAKER_DEFAULT_VOLUME; 
    int step = NUGU_SPEAKER_DEFAULT_STEP; 
    int level = NUGU_SPEAKER_DEFAULT_VOLUME; 
    int mute = NUGU_SPEAKER_UNABLE_CONTROL; 
    bool can_control = false; 
};
 
class NUGU_API ISpeakerListener : virtual public ICapabilityListener {
public:
    virtual ~ISpeakerListener() = default;
 
    virtual void requestSetVolume(const std::string& ps_id, SpeakerType type, int volume, bool linear) = 0;
 
    virtual void requestSetMute(const std::string& ps_id, SpeakerType type, bool mute) = 0;
};
 
class NUGU_API ISpeakerHandler : virtual public ICapabilityInterface {
public:
    virtual ~ISpeakerHandler() = default;
 
    virtual void setSpeakerInfo(const std::map<SpeakerType, SpeakerInfo>& info) = 0;
    virtual void informVolumeChanged(SpeakerType type, int volume) = 0;
    virtual void informMuteChanged(SpeakerType type, bool mute) = 0;
    virtual void sendEventVolumeChanged(const std::string& ps_id, bool result) = 0;
 
    virtual void sendEventMuteChanged(const std::string& ps_id, bool result) = 0;
 
    virtual std::string getSpeakerName(const SpeakerType& type) = 0;
 
    virtual bool getSpeakerType(const std::string& name, SpeakerType& type) = 0;
};
 
} // NuguInterface
 
#endif /* __NUGU_SPEAKER_INTERFACE_H__ */