AndroidSLESMediaPlayer.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_MEDIAPLAYER_ANDROIDSLESMEDIAPLAYER_INCLUDE_ANDROIDSLESMEDIAPLAYER_ANDROIDSLESMEDIAPLAYER_H_
#define ALEXA_CLIENT_SDK_MEDIAPLAYER_ANDROIDSLESMEDIAPLAYER_INCLUDE_ANDROIDSLESMEDIAPLAYER_ANDROIDSLESMEDIAPLAYER_H_

#include <unordered_set>
#include <vector>

#include <SLES/OpenSLES.h>

#include <acsdkEqualizerImplementations/EqualizerBandMapperInterface.h>
#include <acsdkEqualizerInterfaces/EqualizerInterface.h>
#include <AndroidUtilities/AndroidSLESEngine.h>
#include <AndroidUtilities/AndroidSLESObject.h>
#include <AVSCommon/SDKInterfaces/ChannelVolumeInterface.h>
#include <AVSCommon/SDKInterfaces/HTTPContentFetcherInterfaceFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/SpeakerInterface.h>
#include <AVSCommon/Utils/MediaPlayer/MediaPlayerInterface.h>
#include <AVSCommon/Utils/MediaPlayer/SourceConfig.h>
#include <AVSCommon/Utils/MediaType.h>
#include <AVSCommon/Utils/PlaylistParser/IterativePlaylistParserInterface.h>
#include <AVSCommon/Utils/RequiresShutdown.h>
#include <PlaylistParser/UrlContentToAttachmentConverter.h>

#include "AndroidSLESMediaPlayer/AndroidSLESMediaQueue.h"
#include "AndroidSLESMediaPlayer/FFmpegDecoder.h"
#include "AndroidSLESMediaPlayer/PlaybackConfiguration.h"

namespace alexaClientSDK {
namespace mediaPlayer {
namespace android {

class AndroidSLESMediaPlayer
        : public avsCommon::utils::mediaPlayer::MediaPlayerInterface
        , public acsdkEqualizerInterfaces::EqualizerInterface
        , public avsCommon::utils::RequiresShutdown {
public:
    static std::unique_ptr<AndroidSLESMediaPlayer> create(
        std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface> contentFetcherFactory,
        std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESEngine> engine,
        bool enableEqualizer,
        const PlaybackConfiguration& config = PlaybackConfiguration(),
        const std::string& name = "AndroidMediaPlayer");

    void setEqualizerBandLevels(acsdkEqualizerInterfaces::EqualizerBandLevelMap bandLevelMap) override;

    int getMinimumBandLevel() override;

    int getMaximumBandLevel() override;

    SourceId setSource(
        std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> attachmentReader,
        const avsCommon::utils::AudioFormat* format = nullptr,
        const avsCommon::utils::mediaPlayer::SourceConfig& config =
            avsCommon::utils::mediaPlayer::emptySourceConfig()) override;
    SourceId setSource(
        std::shared_ptr<avsCommon::avs::attachment::AttachmentReader> attachmentReader,
        std::chrono::milliseconds offsetAdjustment,
        const avsCommon::utils::AudioFormat* format = nullptr,
        const avsCommon::utils::mediaPlayer::SourceConfig& config =
            avsCommon::utils::mediaPlayer::emptySourceConfig()) override;
    SourceId setSource(
        const std::string& url,
        std::chrono::milliseconds offset,
        const avsCommon::utils::mediaPlayer::SourceConfig& config = avsCommon::utils::mediaPlayer::emptySourceConfig(),
        bool repeat = false,
        const avsCommon::utils::mediaPlayer::PlaybackContext& playbackContext =
            avsCommon::utils::mediaPlayer::PlaybackContext()) override;

    SourceId setSource(
        std::shared_ptr<std::istream> stream,
        bool repeat = false,
        const avsCommon::utils::mediaPlayer::SourceConfig& config = avsCommon::utils::mediaPlayer::emptySourceConfig(),
        avsCommon::utils::MediaType format = avsCommon::utils::MediaType::UNKNOWN) override;
    bool play(SourceId id) override;
    bool stop(SourceId id) override;
    bool pause(SourceId id) override;
    bool resume(SourceId id) override;
    std::chrono::milliseconds getOffset(SourceId id) override;
    uint64_t getNumBytesBuffered() override;
    avsCommon::utils::Optional<avsCommon::utils::mediaPlayer::MediaPlayerState> getMediaPlayerState(
        SourceId id) override;
    void addObserver(
        std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface> playerObserver) override;
    void removeObserver(
        std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface> playerObserver) override;

    void onPrefetchStatusChange(SLuint32 event);

    ~AndroidSLESMediaPlayer();

    std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> getSpeaker();

protected:
    void doShutdown() override;

private:
    AndroidSLESMediaPlayer(
        std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface> contentFetcherFactory,
        std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> speaker,
        std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESEngine> engine,
        std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESObject> outputMixObject,
        std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESObject> playerObject,
        SLEqualizerItf equalizer,
        SLPlayItf playerInterface,
        const PlaybackConfiguration& config,
        const std::string& name);

    void onQueueEvent(AndroidSLESMediaQueue::QueueEvent event, const std::string& reason, const SourceId& id);

    bool registerPrefetchStatusCallback();

    SourceId configureNewRequest(
        std::unique_ptr<FFmpegInputControllerInterface> inputController,
        const avsCommon::utils::mediaPlayer::SourceConfig& config = avsCommon::utils::mediaPlayer::emptySourceConfig(),
        std::shared_ptr<avsCommon::utils::playlistParser::IterativePlaylistParserInterface> playlistParser = nullptr,
        std::chrono::milliseconds offset = std::chrono::milliseconds(0));

    bool stopLocked();

    bool initializeEqualizer();

    std::chrono::milliseconds getOffsetLocked(SourceId id);

    static std::chrono::milliseconds computeDuration(size_t sizeBytes);

    avsCommon::utils::mediaPlayer::MediaPlayerState createMediaPlayerState(SourceId id);

    std::mutex m_requestMutex;

    std::mutex m_operationMutex;

    std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface> m_contentFetcherFactory;

    SourceId m_sourceId;

    std::chrono::milliseconds m_initialOffset;

    std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> m_speaker;

    std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESEngine> m_engine;

    std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESObject> m_outputMixObject;

    std::shared_ptr<applicationUtilities::androidUtilities::AndroidSLESObject> m_playerObject;

    std::unordered_set<std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface>> m_observers;

    SLEqualizerItf m_equalizer;

    std::vector<int> m_growingFrequenceBandMap;

    std::shared_ptr<acsdkEqualizer::EqualizerBandMapperInterface> m_bandMapper;

    int m_numberOfEqualizerBands;

    int m_minBandLevel;

    int m_maxBandLevel;

    SLPlayItf m_player;

    // The android media player configuration.
    PlaybackConfiguration m_config;

    SLPrefetchStatusItf m_prefetchStatus;

    std::shared_ptr<AndroidSLESMediaQueue> m_mediaQueue;

    std::shared_ptr<avsCommon::utils::playlistParser::IterativePlaylistParserInterface> m_playlistParser;

    bool m_almostDone;

    bool m_hasShutdown;
};

}  // namespace android
}  // namespace mediaPlayer
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_MEDIAPLAYER_ANDROIDSLESMEDIAPLAYER_INCLUDE_ANDROIDSLESMEDIAPLAYER_ANDROIDSLESMEDIAPLAYER_H_