SystemSoundPlayer.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_APPLICATIONUTILITIES_SYSTEMSOUNDPLAYER_INCLUDE_SYSTEMSOUNDPLAYER_SYSTEMSOUNDPLAYER_H_
#define ALEXA_CLIENT_SDK_APPLICATIONUTILITIES_SYSTEMSOUNDPLAYER_INCLUDE_SYSTEMSOUNDPLAYER_SYSTEMSOUNDPLAYER_H_

#include <future>
#include <memory>

#include <acsdkApplicationAudioPipelineFactoryInterfaces/ApplicationAudioPipelineFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/Audio/AudioFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/Audio/SystemSoundAudioFactoryInterface.h>
#include <AVSCommon/SDKInterfaces/SystemSoundPlayerInterface.h>
#include <AVSCommon/Utils/MediaPlayer/MediaPlayerInterface.h>
#include <AVSCommon/Utils/MediaPlayer/MediaPlayerObserverInterface.h>
#include <AVSCommon/Utils/MediaType.h>

namespace alexaClientSDK {
namespace applicationUtilities {
namespace systemSoundPlayer {

static const constexpr char* SYSTEM_SOUND_MEDIA_PLAYER_NAME = "SystemSoundMediaPlayer";

class SystemSoundPlayer
        : public avsCommon::sdkInterfaces::SystemSoundPlayerInterface
        , public avsCommon::utils::mediaPlayer::MediaPlayerObserverInterface {
public:
    static std::shared_ptr<SystemSoundPlayerInterface> createSystemSoundPlayerInterface(
        std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface>
            audioPipelineFactory,
        std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface> audioFactory);

    static std::shared_ptr<SystemSoundPlayer> create(
        std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> mediaPlayer,
        std::shared_ptr<avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface> soundPlayerAudioFactory);

    std::shared_future<bool> playTone(Tone tone) override;

    void onPlaybackFinished(SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackError(
        SourceId id,
        const avsCommon::utils::mediaPlayer::ErrorType& type,
        std::string error,
        const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onPlaybackStarted(SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;
    void onFirstByteRead(SourceId id, const avsCommon::utils::mediaPlayer::MediaPlayerState& state) override;

private:
    SystemSoundPlayer(
        std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> mediaPlayer,
        std::shared_ptr<avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface> soundPlayerAudioFactory);

    void finishPlayTone(bool result);

    std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> m_mediaPlayer;
    std::shared_ptr<avsCommon::sdkInterfaces::audio::SystemSoundAudioFactoryInterface> m_soundPlayerAudioFactory;
    std::shared_future<bool> m_sharedFuture;
    std::promise<bool> m_playTonePromise;
    std::mutex m_mutex;
    SourceId m_sourceId;
};

}  // namespace systemSoundPlayer
}  // namespace applicationUtilities
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_APPLICATIONUTILITIES_SYSTEMSOUNDPLAYER_INCLUDE_SYSTEMSOUNDPLAYER_SYSTEMSOUNDPLAYER_H_