AVChannelLayout.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Multimedia.
 *
 * StormByte-Multimedia original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Multimedia source in this
 * file. Third-party components — including FFmpeg and embedded trained data —
 * remain under their own licenses and are not covered by the commercial grant.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Multimedia is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Multimedia. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/multimedia/ffmpeg/fwd.hxx>
#include <StormByte/multimedia/visibility.h>
 
#include <cstdint>
#include <string>

namespace StormByte::Multimedia::FFmpeg {
    struct Convert;
    class AVCodecParameters;
    class AVDecoder;
    class AVEncoder;
    class AVFrame;
    class Swr;

    class STORMBYTE_MULTIMEDIA_PUBLIC AVChannelLayout {
        friend struct Convert;
        friend class AVCodecParameters;
        friend class AVDecoder;
        friend class AVEncoder;
        friend class AVFrame;
        friend class Swr;
        public:
            AVChannelLayout() noexcept;

            explicit AVChannelLayout(int channels) noexcept;

            AVChannelLayout(const AVChannelLayout& other) noexcept;

            AVChannelLayout(AVChannelLayout&& other) noexcept;

            ~AVChannelLayout() noexcept;

            AVChannelLayout& operator=(const AVChannelLayout& other) noexcept;

            AVChannelLayout& operator=(AVChannelLayout&& other) noexcept;

            static AVChannelLayout Default(int channels) noexcept;

            explicit operator bool() const noexcept;

            int NbChannels() const noexcept;

            std::uint64_t Mask() const noexcept;

            int Order() const noexcept;

            std::string Describe() const noexcept;

            bool operator==(const AVChannelLayout& other) const noexcept;

            bool operator!=(const AVChannelLayout& other) const noexcept;
 
        private:
            ::AVChannelLayout* m_raw = nullptr; 

            void Ensure() noexcept;

            void Free() noexcept;

            const ::AVChannelLayout* Get() const noexcept;

            ::AVChannelLayout* Get() noexcept;
    };
}