AudioFormat.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_AUDIOFORMAT_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_AUDIOFORMAT_H_

#include <ostream>

namespace alexaClientSDK {
namespace avsCommon {
namespace utils {

struct AudioFormat {
    enum class Encoding {
        LPCM,

        OPUS
    };

    enum class Layout {
        NON_INTERLEAVED,

        INTERLEAVED
    };

    enum class Endianness {
        LITTLE,

        BIG
    };

    Encoding encoding;

    Endianness endianness;

    unsigned int sampleRateHz;

    unsigned int sampleSizeInBits;

    unsigned int numChannels;

    bool dataSigned;

    Layout layout;
};

inline std::ostream& operator<<(std::ostream& stream, const AudioFormat::Encoding& encoding) {
    switch (encoding) {
        case AudioFormat::Encoding::LPCM:
            stream << "LPCM";
            break;
        case AudioFormat::Encoding::OPUS:
            stream << "OPUS";
            break;
    }
    return stream;
}

inline std::ostream& operator<<(std::ostream& stream, const AudioFormat::Endianness& endianness) {
    switch (endianness) {
        case AudioFormat::Endianness::LITTLE:
            stream << "LITTLE";
            break;
        case AudioFormat::Endianness::BIG:
            stream << "BIG";
            break;
    }
    return stream;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_UTILS_INCLUDE_AVSCOMMON_UTILS_AUDIOFORMAT_H_