TemplateRuntimePresentationAdapter.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 ACSDK_SAMPLE_TEMPLATERUNTIME_TEMPLATERUNTIMEPRESENTATIONADAPTER_H_
#define ACSDK_SAMPLE_TEMPLATERUNTIME_TEMPLATERUNTIMEPRESENTATIONADAPTER_H_

#include <string>
#include <utility>

#include <rapidjson/document.h>
#include <rapidjson/writer.h>

#include <acsdkAudioPlayerInterfaces/AudioPlayerObserverInterface.h>
#include <acsdk/Notifier/Notifier.h>
#include <acsdk/PresentationOrchestratorInterfaces/PresentationOrchestratorClientInterface.h>
#include <acsdk/PresentationOrchestratorInterfaces/PresentationTypes.h>
#include <acsdk/TemplateRuntimeInterfaces/TemplateRuntimeObserverInterface.h>
#include <AVSCommon/AVS/PlayerActivity.h>
#include <AVSCommon/Utils/Threading/Executor.h>

#include "TemplateRuntimePresentationAdapterObserverInterface.h"

namespace alexaClientSDK {
namespace sampleApplications {
namespace common {

class TemplateRuntimePresentationAdapter
        : public presentationOrchestratorInterfaces::PresentationObserverInterface
        , public templateRuntimeInterfaces::TemplateRuntimeObserverInterface
        , public acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
        , public std::enable_shared_from_this<TemplateRuntimePresentationAdapter> {
public:
    static std::shared_ptr<TemplateRuntimePresentationAdapter> create();

    virtual ~TemplateRuntimePresentationAdapter() = default;

    void onPresentationAvailable(
        presentationOrchestratorInterfaces::PresentationRequestToken id,
        std::shared_ptr<presentationOrchestratorInterfaces::PresentationInterface> presentation) override;
    void onPresentationStateChanged(
        presentationOrchestratorInterfaces::PresentationRequestToken id,
        presentationOrchestratorInterfaces::PresentationState newState) override;
    bool onNavigateBack(presentationOrchestratorInterfaces::PresentationRequestToken id) override;

    void renderTemplateCard(const std::string& jsonPayload) override;

    void renderPlayerInfoCard(
        const std::string& jsonPayload,
        templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) override;


    void onPlayerActivityChanged(
        avsCommon::avs::PlayerActivity state,
        const acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface::Context& context) override;

    void setExecutor(std::shared_ptr<avsCommon::utils::threading::Executor> executor);

    void addTemplateRuntimePresentationAdapterObserver(
        const std::weak_ptr<TemplateRuntimePresentationAdapterObserverInterface>& observer);

    void removeTemplateRuntimePresentationAdapterObserver(
        const std::weak_ptr<TemplateRuntimePresentationAdapterObserverInterface>& observer);

    void setRenderTemplateWindowId(const std::string& renderTemplateWindowId);

    void setRenderPlayerInfoWindowId(const std::string& renderPlayerInfoWindowId);

    void setPresentationOrchestrator(
        std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorClientInterface> poClient);

private:
    explicit TemplateRuntimePresentationAdapter();

    bool initialize();

    using TemplateRuntimePresentationAdapterNotifier =
        notifier::Notifier<TemplateRuntimePresentationAdapterObserverInterface>;

    struct DisplayCardSession {
        DisplayCardSession() = default;

        explicit DisplayCardSession(std::string jsonPayload) :
                jsonPayload{std::move(jsonPayload)},
                presentation{nullptr},
                presentationState{presentationOrchestratorInterfaces::PresentationState::NONE} {};

        std::string jsonPayload;

        std::shared_ptr<presentationOrchestratorInterfaces::PresentationInterface> presentation;

        presentationOrchestratorInterfaces::PresentationState presentationState;
    };

    using DisplayCardSessionPtr = std::shared_ptr<DisplayCardSession>;

    struct PlayerInfoCardSession : DisplayCardSession {
        PlayerInfoCardSession() = default;

        PlayerInfoCardSession(
            std::string jsonPayload,
            templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo) :
                jsonPayload{std::move(jsonPayload)},
                audioPlayerInfo{std::move(audioPlayerInfo)} {};

        std::string jsonPayload;

        templateRuntimeInterfaces::TemplateRuntimeObserverInterface::AudioPlayerInfo audioPlayerInfo;
    };

    using PlayerInfoCardSessionPtr = std::shared_ptr<PlayerInfoCardSession>;

    void executeOnPlayerActivityChanged(alexaClientSDK::avsCommon::avs::PlayerActivity state);

    std::shared_ptr<TemplateRuntimePresentationAdapterNotifier> m_templateRuntimePresentationAdapterNotifier;

    std::shared_ptr<presentationOrchestratorInterfaces::PresentationOrchestratorClientInterface>
        m_presentationOrchestratorClient;

    presentationOrchestratorInterfaces::PresentationRequestToken m_renderTemplateRequestToken;

    presentationOrchestratorInterfaces::PresentationRequestToken m_playerInfoRequestToken;

    DisplayCardSessionPtr m_displayCardSession;

    PlayerInfoCardSessionPtr m_playerInfoCardSession;

    std::chrono::milliseconds m_audioPlaybackFinishedTimeout;

    std::chrono::milliseconds m_audioPlaybackStoppedPausedTimeout;

    std::string m_renderTemplateWindowId;

    std::string m_renderPlayerInfoWindowId;

    std::shared_ptr<avsCommon::utils::threading::Executor> m_executor;
};

}  // namespace common
}  // namespace sampleApplications
}  // namespace alexaClientSDK
#endif  // ACSDK_SAMPLE_TEMPLATERUNTIME_TEMPLATERUNTIMEPRESENTATIONADAPTER_H_