SampleApplication.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 ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_SAMPLEAPPLICATION_H_
#define ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_SAMPLEAPPLICATION_H_

#include <fstream>
#include <map>
#include <memory>
#include <tuple>
#include <unordered_map>
#include <utility>
#include <vector>

#include <acsdkAuthorization/AuthorizationManager.h>
#include <acsdkAuthorization/LWA/LWAAuthorizationAdapter.h>
#include <acsdk/SDKClient/SDKClientRegistry.h>
#include <AVSCommon/AVS/Initialization/AlexaClientSDKInit.h>
#include <AVSCommon/SDKInterfaces/ApplicationMediaInterfaces.h>
#include <AVSCommon/SDKInterfaces/ChannelVolumeInterface.h>
#include <AVSCommon/SDKInterfaces/Diagnostics/DiagnosticsInterface.h>
#include <AVSCommon/Utils/MediaPlayer/PooledMediaPlayerFactory.h>
#include <CapabilitiesDelegate/CapabilitiesDelegate.h>
#include <acsdkExternalMediaPlayer/ExternalMediaPlayer.h>

#include "ConsolePrinter.h"
#include <DefaultClient/EqualizerRuntimeSetup.h>

#include "SampleApplicationReturnCodes.h"

#ifdef KWD
#include <acsdkKWDImplementations/AbstractKeywordDetector.h>
#endif

#ifdef GSTREAMER_MEDIA_PLAYER
#include <MediaPlayer/MediaPlayer.h>
#elif defined(UWP_BUILD)
#include <SSSDKCommon/TestMediaPlayer.h>
#endif  // GSTREAMER_MEDIA_PLAYER

#include <acsdk/Sample/InteractionManager/InteractionManager.h>

#include "GUI/GUIActivityEventNotifier.h"
#include "GUI/GUIClient.h"
#include "GUI/GUIManager.h"
#include "IPC/Components/AlexaCaptionsHandler.h"
#include "IPC/Components/TemplateRuntimeHandler.h"

namespace alexaClientSDK {
namespace sampleApplications {
namespace ipcServerSampleApp {

class SampleApplication {
public:
    static std::unique_ptr<SampleApplication> create(
        const std::vector<std::string>& configFiles,
        const std::string& logLevel = "",
        std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface> diagnostics = nullptr);

    SampleAppReturnCode run();

    ~SampleApplication();
#ifdef UWP_BUILD
    std::shared_ptr<gui::GUIClient> getGUIClient() {
        return m_guiClient;
    }

    std::shared_ptr<gui::GUIManager> getGUIManager() {
        return m_guiManager;
    }
#endif

    bool createMediaPlayersForAdapters(
        const std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>&
            httpContentFetcherFactory,
        const std::shared_ptr<defaultClient::EqualizerRuntimeSetup> equalizerRuntimeSetup);

    class AdapterRegistration {
    public:
        AdapterRegistration(
            const std::string& playerId,
            acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreateFunction createFunction);
    };

    class MediaPlayerRegistration {
    public:
        MediaPlayerRegistration(
            const std::string& playerId,
            avsCommon::sdkInterfaces::ChannelVolumeInterface::Type speakerType);
    };

private:
    bool initialize(
        const std::vector<std::string>& configFiles,
        const std::string& logLevel,
        std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface> diagnostics);

    std::shared_ptr<avsCommon::sdkInterfaces::ApplicationMediaInterfaces> createApplicationMediaPlayer(
        const std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>&
            httpContentFetcherFactory,
        bool enableEqualizer,
        const std::string& name,
        bool enableLiveMode = false);

    std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> m_shutdownManager;

    std::shared_ptr<avsCommon::avs::initialization::AlexaClientSDKInit> m_sdkInit;

    std::shared_ptr<sdkClient::SDKClientRegistry> m_clientRegistry;

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

    std::shared_ptr<common::InteractionManager> m_interactionManager;

    std::shared_ptr<gui::GUIClient> m_guiClient;

    std::shared_ptr<gui::GUIManager> m_guiManager;

    std::shared_ptr<AplClientBridge> m_aplClientBridge;

    std::shared_ptr<gui::GUIActivityEventNotifier> m_activityEventNotifier;

    std::shared_ptr<ipc::TemplateRuntimeHandler> m_templateRuntimeIPCHandler;

    std::shared_ptr<ipc::AlexaCaptionsHandler> m_alexaCaptionIPCHandler;

    std::unordered_map<std::string, std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>>
        m_externalMusicProviderMediaPlayersMap;

    std::unordered_map<std::string, std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface>>
        m_externalMusicProviderSpeakersMap;

    std::vector<std::shared_ptr<avsCommon::utils::RequiresShutdown>> m_shutdownRequiredList;

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_speakMediaPlayer;

    std::vector<std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>> m_audioMediaPlayerPool;

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_alertsMediaPlayer;

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_notificationsMediaPlayer;

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_bluetoothMediaPlayer;

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_systemSoundMediaPlayer;

#ifdef ENABLE_COMMS_AUDIO_PROXY
    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_commsMediaPlayer;
#endif

    std::shared_ptr<capabilitiesDelegate::CapabilitiesDelegate> m_capabilitiesDelegate;

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_ringtoneMediaPlayer;

    static std::unordered_map<std::string, avsCommon::sdkInterfaces::ChannelVolumeInterface::Type>
        m_playerToSpeakerTypeMap;

    static acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap m_adapterToCreateFuncMap;

#ifdef KWD
    std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector> m_keywordDetector;
#endif

    std::shared_ptr<acsdkAuthorization::AuthorizationManager> m_authManager;

    std::shared_ptr<acsdkAuthorization::lwa::LWAAuthorizationAdapter> m_lwaAdapter;

    std::string decodeHexToAscii(const std::string hexString);
};

}  // namespace ipcServerSampleApp
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_LIBIPCSERVERSAMPLEAPP_INCLUDE_IPCSERVERSAMPLEAPP_SAMPLEAPPLICATION_H_