SourceConfig.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_SOURCECONFIG_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_SOURCECONFIG_H_

#include <algorithm>
#include <chrono>
#include <ostream>

#include <AVSCommon/Utils/MediaPlayer/MediaDescription.h>

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

static constexpr short MAX_GAIN = 100;

static constexpr short MIN_GAIN = 0;

/*
 * An object that contains configuration for a source media.
 */
struct SourceConfig {
    /*
     * Object that contains Fade-In configuration.
     */
    struct FadeInConfig {
        short startGain;

        short endGain;

        std::chrono::milliseconds duration;

        bool enabled;
    };

    /*
     * Object that contains audio normalization configuration
     */
    struct AudioNormalizationConfig {
        /*
         * Enable audio normalization.
         * This is an optional feature and could be safely ignored
         * if not supported by MediaPlayer implementation.
         */
        bool enabled;
    };

    FadeInConfig fadeInConfig;

    AudioNormalizationConfig audioNormalizationConfig;

    std::chrono::milliseconds endOffset;

    MediaDescription mediaDescription;

    static inline SourceConfig createWithFadeIn(
        short startGain,
        short endGain,
        const std::chrono::milliseconds& duration);
};

inline SourceConfig emptySourceConfig() {
    return SourceConfig{{100, 100, std::chrono::milliseconds::zero(), false},
                        {false},
                        std::chrono::milliseconds::zero(),
                        emptyMediaDescription()};
}

inline SourceConfig SourceConfig::createWithFadeIn(
    short startGain,
    short endGain,
    const std::chrono::milliseconds& duration) {
    short validStartGain = std::max(MIN_GAIN, std::min(MAX_GAIN, startGain));
    short validEndGain = std::max(MIN_GAIN, std::min(MAX_GAIN, endGain));
    return SourceConfig{{validStartGain, validEndGain, duration, true},
                        {false},
                        std::chrono::milliseconds::zero(),
                        emptyMediaDescription()};
}

inline std::ostream& operator<<(std::ostream& stream, const SourceConfig& config) {
    return stream << "fadeIn{"
                  << " enabled:" << config.fadeInConfig.enabled << ", start:" << config.fadeInConfig.startGain
                  << ", end:" << config.fadeInConfig.endGain
                  << ", duration(ms):" << config.fadeInConfig.duration.count() << "}"
                  << ", normalization{"
                  << " enabled: " << config.audioNormalizationConfig.enabled << "}"
                  << ", endOffset(ms): " << config.endOffset.count()
                  << ", MediaDescription: " << config.mediaDescription;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_MEDIAPLAYER_SOURCECONFIG_H_