CaptionManager.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_CAPTIONS_IMPLEMENTATION_INCLUDE_CAPTIONS_CAPTIONMANAGER_H_
#define ALEXA_CLIENT_SDK_CAPTIONS_IMPLEMENTATION_INCLUDE_CAPTIONS_CAPTIONMANAGER_H_

#include <atomic>
#include <mutex>
#include <unordered_map>

#include <AVSCommon/AVS/FocusState.h>
#include <AVSCommon/Utils/RequiresShutdown.h>

#include <Captions/CaptionFrame.h>
#include <Captions/CaptionFrameParseListenerInterface.h>
#include <Captions/CaptionLine.h>
#include <Captions/CaptionManagerInterface.h>
#include <Captions/CaptionParserInterface.h>
#include <Captions/CaptionTimingAdapter.h>
#include <Captions/TimingAdapterFactory.h>

namespace alexaClientSDK {
namespace captions {

class CaptionManager
        : public CaptionManagerInterface
        , public CaptionFrameParseListenerInterface
        , public avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface
        , public avsCommon::utils::RequiresShutdown
        , public std::enable_shared_from_this<CaptionManager> {
public:
    static std::shared_ptr<CaptionManager> create(
        std::shared_ptr<CaptionParserInterface> parser,
        std::shared_ptr<TimingAdapterFactory> timingAdapterFactory = nullptr);

    void doShutdown() override;

    void onCaption(CaptionFrame::MediaPlayerSourceId sourceId, const CaptionData& captionData) override;
    void setCaptionPresenter(const std::shared_ptr<CaptionPresenterInterface>& presenter) override;
    void setMediaPlayers(
        const std::vector<std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>>& mediaPlayers) override;
    void addMediaPlayer(
        const std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>& mediaPlayer) override;
    void removeMediaPlayer(
        const std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>& mediaPlayer) override;
    bool isEnabled() const override;

    void onParsed(const CaptionFrame& captionFrame) override;

    void onPlaybackStarted(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackFinished(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackError(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::ErrorType& type,
        std::string error,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackPaused(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackResumed(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackStopped(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onFirstByteRead(
        CaptionFrame::MediaPlayerSourceId id,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override{};

private:
    CaptionManager(
        std::shared_ptr<CaptionParserInterface> parser,
        std::shared_ptr<TimingAdapterFactory> timingAdapterFactory);

    void logMediaStateNotHandled(
        const std::string& event,
        const std::string& reason,
        CaptionFrame::MediaPlayerSourceId id);

    std::unordered_map<CaptionFrame::MediaPlayerSourceId, std::shared_ptr<CaptionTimingAdapterInterface>>
        m_timingAdaptersBySourceIds;

    std::shared_ptr<CaptionPresenterInterface> m_presenter;

    std::shared_ptr<CaptionParserInterface> m_parser;

    std::shared_ptr<TimingAdapterFactory> m_timingFactory;

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

    std::mutex m_mutex;
};

}  // namespace captions
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_CAPTIONS_IMPLEMENTATION_INCLUDE_CAPTIONS_CAPTIONMANAGER_H_