speech_recognizer_aggregator_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 __SPEECH_RECOGNIZER_AGGREGATOR_INTERFACE_H__
#define __SPEECH_RECOGNIZER_AGGREGATOR_INTERFACE_H__
 
#include <memory>
 
#include <capability/asr_interface.hh>
#include <clientkit/wakeup_interface.hh>
#include <nugu.h>
 
namespace NuguClientKit {
 
using namespace NuguCapability;
 
typedef struct _RecognitionResult {
    enum class Status {
        None, 
        Partial, 
        Complete, 
        Cancel, 
        Error 
    };
 
    Status status; 
    std::string recognized_text; 
    ASRError error; 
    bool listen_timeout_fail_beep; 
} RecognitionResult;
 
class NUGU_API ISpeechRecognizerAggregatorListener {
public:
    virtual ~ISpeechRecognizerAggregatorListener() = default;
 
    virtual void onWakeupState(WakeupDetectState state, float power_noise, float power_speech) = 0;
 
    virtual void onASRState(ASRState state, const std::string& dialog_id, ASRInitiator initiator) = 0;
 
    virtual void onResult(const RecognitionResult& result, const std::string& dialog_id) = 0;
};
 
class NUGU_API ISpeechRecognizerAggregator {
public:
    virtual ~ISpeechRecognizerAggregator() = default;
 
    virtual void addListener(ISpeechRecognizerAggregatorListener* listener) = 0;
 
    virtual void removeListener(ISpeechRecognizerAggregatorListener* listener) = 0;
 
    virtual void setWakeupHandler(const std::shared_ptr<IWakeupHandler>& wakeup_handler) = 0;
 
    virtual bool setWakeupModel(const WakeupModelFile& model_file) = 0;
 
    virtual void startListeningWithTrigger() = 0;
 
    virtual void startListening(float power_noise = 0, float power_speech = 0, ASRInitiator initiator = ASRInitiator::TAP) = 0;
 
    virtual void stopListening(bool cancel = false) = 0;
 
    virtual void finishListening() = 0;
};
 
} // NuguClientKit
 
#endif /* __SPEECH_RECOGNIZER_AGGREGATOR_INTERFACE_H__ */