asr_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_ASR_INTERFACE_H__
#define __NUGU_ASR_INTERFACE_H__
 
#include <functional>
 
#include <clientkit/capability_interface.hh>
#include <nugu.h>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
#define NUGU_ASR_EPD_TYPE "CLIENT" 
#define NUGU_ASR_ENCODING "COMPLETE" 
#define NUGU_SERVER_RESPONSE_TIMEOUT_SEC 10 
enum class ASRState {
    IDLE, 
    EXPECTING_SPEECH, 
    LISTENING, 
    RECOGNIZING, 
    BUSY 
};
 
enum class ASRInitiator {
    WAKE_UP_WORD, 
    PRESS_AND_HOLD, 
    TAP, 
    EXPECT_SPEECH, 
    EARSET 
};
 
enum class ASRError {
    RESPONSE_TIMEOUT, 
    LISTEN_TIMEOUT, 
    LISTEN_FAILED, 
    RECOGNIZE_ERROR, 
    UNKNOWN 
};
 
typedef struct _ASRAttribute {
    std::string model_path; 
    std::string epd_type; 
    std::string asr_encoding; 
    int response_timeout; 
} ASRAttribute;
 
class NUGU_API IASRListener : virtual public ICapabilityListener {
public:
    virtual ~IASRListener() = default;
 
    virtual void onState(ASRState state, const std::string& dialog_id, ASRInitiator initiator) = 0;
 
    virtual void onNone(const std::string& dialog_id) = 0;
 
    virtual void onPartial(const std::string& text, const std::string& dialog_id) = 0;
 
    virtual void onComplete(const std::string& text, const std::string& dialog_id) = 0;
 
    virtual void onError(ASRError error, const std::string& dialog_id, bool listen_timeout_fail_beep = true) = 0;
 
    virtual void onCancel(const std::string& dialog_id) = 0;
};
 
class NUGU_API IASRHandler : virtual public ICapabilityInterface {
public:
    using AsrRecognizeCallback = std::function<void(const std::string& dialog_id)>;
 
public:
    virtual ~IASRHandler() = default;
 
    virtual void startRecognition(float power_noise, float power_speech, ASRInitiator initiator = ASRInitiator::TAP, AsrRecognizeCallback callback = nullptr) = 0;
 
    virtual void startRecognition(ASRInitiator initiator = ASRInitiator::TAP, AsrRecognizeCallback callback = nullptr) = 0;
 
    virtual void stopRecognition(bool cancel = false) = 0;
 
    virtual void finishRecognition() = 0;
 
    virtual void addListener(IASRListener* listener) = 0;
 
    virtual void removeListener(IASRListener* listener) = 0;
 
    virtual void setAttribute(ASRAttribute&& attribute) = 0;
 
    virtual void setEpdAttribute(EpdAttribute&& attribute) = 0;
 
    virtual EpdAttribute getEpdAttribute() = 0;
};
 
} // NuguCapability
 
#endif /* __NUGU_ASR_INTERFACE_H__ */