SensoryKeywordDetector.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. 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.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 ACSDKSENSORYADAPTER_SENSORY_SENSORYKEYWORDDETECTOR_H_
#define ACSDKSENSORYADAPTER_SENSORY_SENSORYKEYWORDDETECTOR_H_
 
#include <atomic>
#include <string>
#include <thread>
#include <unordered_set>
 
#include <acsdkKWDImplementations/AbstractKeywordDetector.h>
#include <acsdkKWDInterfaces/KeywordDetectorStateNotifierInterface.h>
#include <acsdkKWDInterfaces/KeywordNotifierInterface.h>
#include <AVSCommon/AVS/AudioInputStream.h>
#include <AVSCommon/SDKInterfaces/KeyWordDetectorStateObserverInterface.h>
#include <AVSCommon/SDKInterfaces/KeyWordObserverInterface.h>
#include <AVSCommon/Utils/AudioFormat.h>
 
#include "snsr.h"
 
namespace alexaClientSDK {
namespace kwd {
 
using namespace avsCommon;
using namespace avsCommon::avs;
using namespace avsCommon::sdkInterfaces;
 
class SensoryKeywordDetector : public acsdkKWDImplementations::AbstractKeywordDetector {
public:
    static std::unique_ptr<SensoryKeywordDetector> create(
        const std::shared_ptr<AudioInputStream> stream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        std::shared_ptr<acsdkKWDInterfaces::KeywordNotifierInterface> keyWordNotifier,
        std::shared_ptr<acsdkKWDInterfaces::KeywordDetectorStateNotifierInterface> KeyWordDetectorStateNotifier,
        const std::string& modelFilePath,
        std::chrono::milliseconds msToPushPerIteration = std::chrono::milliseconds(10));
 
    static std::unique_ptr<SensoryKeywordDetector> create(
        const std::shared_ptr<AudioInputStream> stream,
        avsCommon::utils::AudioFormat audioFormat,
        std::unordered_set<std::shared_ptr<KeyWordObserverInterface>> keyWordObservers,
        std::unordered_set<std::shared_ptr<KeyWordDetectorStateObserverInterface>> keyWordDetectorStateObservers,
        const std::string& modelFilePath,
        std::chrono::milliseconds msToPushPerIteration = std::chrono::milliseconds(10));
 
    ~SensoryKeywordDetector() override;
 
private:
    SensoryKeywordDetector(
        std::shared_ptr<AudioInputStream> stream,
        const std::shared_ptr<acsdkKWDInterfaces::KeywordNotifierInterface> keywordNotifier,
        const std::shared_ptr<acsdkKWDInterfaces::KeywordDetectorStateNotifierInterface> KeywordDetectorStateNotifier,
        avsCommon::utils::AudioFormat audioFormat,
        std::chrono::milliseconds msToPushPerIteration = std::chrono::milliseconds(10));
 
    bool init(const std::string& modelFilePath);
 
    bool setUpRuntimeSettings(SnsrSession* session);
 
    void detectionLoop();
 
    static SnsrRC keyWordDetectedCallback(SnsrSession s, const char* key, void* userData);
 
    std::atomic<bool> m_isShuttingDown;
 
    const std::shared_ptr<avsCommon::avs::AudioInputStream> m_stream;
 
    std::shared_ptr<avsCommon::avs::AudioInputStream::Reader> m_streamReader;
 
    avsCommon::avs::AudioInputStream::Index m_beginIndexOfStreamReader;
 
    std::thread m_detectionThread;
 
    SnsrSession m_session;
 
    const size_t m_maxSamplesPerPush;
};
 
}  // namespace kwd
}  // namespace alexaClientSDK
 
#endif  // ACSDKSENSORYADAPTER_SENSORY_SENSORYKEYWORDDETECTOR_H_