MediaDescription.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_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIADESCRIPTION_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIADESCRIPTION_H_

#include <unordered_map>
#include <vector>

#include <AVSCommon/AVS/PlayBehavior.h>
#include <AVSCommon/SDKInterfaces/Audio/MixingBehavior.h>
#include <AVSCommon/Utils/AudioAnalyzer/AudioAnalyzerState.h>
#include <AVSCommon/Utils/Optional.h>
#include <Captions/CaptionData.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {
namespace mediaPlayer {

static std::string PLAY_BEHAVIOR = "playBehavior";

/*
 * An object that contains all playback related information needed from the media CA.
 */
struct MediaDescription {
    sdkInterfaces::audio::MixingBehavior mixingBehavior;

    std::string focusChannel;  // "Dialog", "Communications", "Alert", "Content", "Visual"

    std::string trackId;

    Optional<captions::CaptionData> caption;

    Optional<std::vector<audioAnalyzer::AudioAnalyzerState>> analyzers;

    std::unordered_map<std::string, std::string> additionalData;

    bool enabled;
};

inline MediaDescription emptyMediaDescription() {
    return MediaDescription{sdkInterfaces::audio::MixingBehavior(),
                            "",
                            "",
                            Optional<captions::CaptionData>(),
                            Optional<std::vector<audioAnalyzer::AudioAnalyzerState>>(),
                            std::unordered_map<std::string, std::string>(),
                            false};
}

inline std::ostream& operator<<(std::ostream& stream, const MediaDescription& mediaDescription) {
    stream << "MixingBehavior:";
    switch (mediaDescription.mixingBehavior) {
        case sdkInterfaces::audio::MixingBehavior::BEHAVIOR_PAUSE:
            stream << "BEHAVIOR_PAUSE";
            break;
        case sdkInterfaces::audio::MixingBehavior::BEHAVIOR_DUCK:
            stream << "BEHAVIOR_DUCK";
            break;
    }
    stream << ", Channel:" << mediaDescription.focusChannel << ", ";
    stream << ", TrackId:" << mediaDescription.trackId;
    if (mediaDescription.caption.hasValue()) {
        stream << ", CaptionData:{format:" << (mediaDescription.caption.value()).format;
        stream << ", content:" << (mediaDescription.caption.value()).content << "}";
    }
    if (mediaDescription.analyzers.hasValue()) {
        stream << ", Analyzers:{";
        const auto analyzersCopy = mediaDescription.analyzers.value();
        for (auto iter = analyzersCopy.begin(); iter != analyzersCopy.end(); iter++) {
            stream << "{name:" << (*iter).name;
            stream << ", enableState:" << (*iter).enableState << "}";
        }
        stream << "}";
    }
    stream << ", AdditionalData:{";
    const auto additionalDataCopy = mediaDescription.additionalData;
    for (auto iter = additionalDataCopy.begin(); iter != additionalDataCopy.end(); iter++) {
        stream << "{" << (*iter).first;
        stream << ":" << (*iter).second << "}";
    }
    stream << "}, enabled: " << (mediaDescription.enabled ? "true" : "false") << " }";
    return stream;
}

}  // namespace mediaPlayer
}  // namespace utils
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_MEDIADESCRIPTION_H_