LocaleAssetsManager.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 SAMPLEAPP_LOCALEASSETSMANAGER_H_
#define SAMPLEAPP_LOCALEASSETSMANAGER_H_

#include <map>
#include <memory>
#include <mutex>
#include <set>
#include <unordered_set>

#include <acsdkShutdownManagerInterfaces/ShutdownNotifierInterface.h>
#include <AVSCommon/SDKInterfaces/LocaleAssetsManagerInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

#ifdef KWD
#ifdef ASSET_MANAGER
#include <acsdkAssetManager/AssetManager.h>
#endif
#include <acsdkKWDImplementations/AbstractKeywordDetector.h>
#include <AVSCommon/AVS/AudioInputStream.h>
#include <AVSCommon/Utils/AudioFormat.h>
#include <DefaultClient/DefaultClient.h>
#endif

namespace alexaClientSDK {
namespace sampleApp {

#if defined(KWD) && defined(ASSET_MANAGER)
using namespace acsdkAssets::manager;
#endif

class LocaleAssetsManager
        : public avsCommon::sdkInterfaces::LocaleAssetsManagerInterface
        , public avsCommon::utils::RequiresShutdown {
public:
    static std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> createLocaleAssetsManagerInterface(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode,
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier);

    static std::shared_ptr<LocaleAssetsManager> createLocaleAssetsManager(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode);

    static std::shared_ptr<LocaleAssetsManager> create(bool enableWakeWord);

    bool changeAssets(const Locales& locales, const WakeWords& wakeWords) override;
    void cancelOngoingChange() override;
    WakeWordsSets getDefaultSupportedWakeWords() const override;
    std::map<LanguageTag, WakeWordsSets> getLanguageSpecificWakeWords() const override;
    std::map<Locale, WakeWordsSets> getLocaleSpecificWakeWords() const override;
    WakeWordsSets getSupportedWakeWords(const Locale& locale) const override;
    std::set<Locale> getSupportedLocales() const override;
    LocaleCombinations getSupportedLocaleCombinations() const override;
    Locale getDefaultLocale() const override;
    Locales getDefaultLocales() const override;
    void addLocaleAssetsObserver(
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsObserverInterface>& observer)
        override;
    void removeLocaleAssetsObserver(
        const std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsObserverInterface>& observer)
        override;
    void onConfigurationChanged(const alexaClientSDK::avsCommon::avs::CapabilityConfiguration& configuration) override;
    void setEndpointRegistrationManager(
        const std::shared_ptr<
            alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface>& manager)
        override;

    void doShutdown() override;

#ifdef KWD
#ifdef ASSET_MANAGER

    static std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>
    createLocaleAssetsManagerInterfaceWithKwdAndDavs(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode,
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier,
        const std::shared_ptr<avsCommon::avs::AudioInputStream>& audioInputStream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        const std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector>& keywordDetector,
        const std::shared_ptr<AssetManager>& assetManager);

    static std::shared_ptr<LocaleAssetsManager> createLocaleAssetsManagerWithKwdAndDavs(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode,
        const std::shared_ptr<avsCommon::avs::AudioInputStream>& audioInputStream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        const std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector>& keywordDetector,
        const std::shared_ptr<AssetManager>& assetManager);
#else

    static std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>
    createLocaleAssetsManagerInterfaceWithKwd(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode,
        const std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface>& shutdownNotifier,
        const std::shared_ptr<avsCommon::avs::AudioInputStream>& audioInputStream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        const std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector>& keywordDetector);

    static std::shared_ptr<LocaleAssetsManager> createLocaleAssetsManagerWithKwd(
        const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode,
        const std::shared_ptr<avsCommon::avs::AudioInputStream>& audioInputStream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        const std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector>& keywordDetector);
#endif
    void setDefaultClient(const std::shared_ptr<defaultClient::DefaultClient>& defaultClient);
#endif
private:
    LocaleAssetsManager();

#ifdef KWD
#ifdef ASSET_MANAGER

    LocaleAssetsManager(
        const std::shared_ptr<avsCommon::avs::AudioInputStream>& audioInputStream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        const std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector>& keywordDetector,
        const std::shared_ptr<AssetManager>& assetManager);
#else

    LocaleAssetsManager(
        const std::shared_ptr<avsCommon::avs::AudioInputStream>& audioInputStream,
        const std::shared_ptr<avsCommon::utils::AudioFormat>& audioFormat,
        const std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector>& keywordDetector);
#endif
#endif

    bool initialize(const std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>& configurationNode);

    bool initialize(bool enableWakeWord, const avsCommon::utils::configuration::ConfigurationNode& configurationNode);

    WakeWordsSets m_supportedWakeWords;

    std::set<Locale> m_supportedLocales;

    LocaleCombinations m_supportedLocalesCombinations;

    Locale m_defaultLocale;

    Locales m_defaultLocales;

#ifdef KWD
    const std::shared_ptr<avsCommon::avs::AudioInputStream> m_audioInputStream;
    const std::shared_ptr<avsCommon::utils::AudioFormat> m_audioFormat;

    std::mutex m_defaultClientMutex;

    std::mutex m_keywordDetectorMutex;


    std::shared_ptr<defaultClient::DefaultClient> m_DefaultClient;

    std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector> m_keywordDetector;
#ifdef ASSET_MANAGER
    std::shared_ptr<AssetManager> m_assetManager;
#endif
#endif

    mutable std::mutex m_observersMutex;

    std::mutex m_ermMutex;


    std::unordered_set<std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::LocaleAssetsObserverInterface>>
        m_observers;

    std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface>
        m_endpointRegistrationManager;
};

}  // namespace sampleApp
}  // namespace alexaClientSDK

#endif  // SAMPLEAPP_LOCALEASSETSMANAGER_H_