AVFrame.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/buffer/typedefs.hxx>
#include <StormByte/multimedia/ffmpeg/AVChannelLayout.hxx>
#include <StormByte/multimedia/ffmpeg/AVPointer.hxx>
#include <StormByte/multimedia/ffmpeg/AVRational.hxx>
#include <StormByte/multimedia/ffmpeg/fwd.hxx>
#include <StormByte/multimedia/pipeline/side_data.hxx>
#include <StormByte/multimedia/property/hdr10.hxx>
 
#include <cstddef>
#include <cstdint>
#include <string_view>
#include <vector>

namespace StormByte::Multimedia::Pipeline {
    namespace Filter {
        class FFmpeg;
    }
}

namespace StormByte::Multimedia::Backend::Pipeline {
    class Frame;
}

namespace StormByte::Multimedia::FFmpeg {
    class AVDecoder;
    class AVEncoder;
    class AVFilterGraph;
    class Swr;
    class Sws;

    class STORMBYTE_MULTIMEDIA_PUBLIC AVFrame: public AVPointer<::AVFrame> {
        friend class AVDecoder;
        friend class AVEncoder;
        friend class AVFilterGraph;
        friend class StormByte::Multimedia::Backend::Pipeline::Frame;
        friend class StormByte::Multimedia::Pipeline::Filter::FFmpeg;
        friend class Swr;
        friend class Sws;
        public:
            AVFrame() noexcept;

            AVFrame(const AVFrame& other) noexcept;

            AVFrame(AVFrame&& other) noexcept = default;

            ~AVFrame() noexcept override;

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

            AVFrame& operator=(AVFrame&& other) noexcept = default;

            explicit operator bool() const noexcept;

            AVFrame Clone() const noexcept;

            bool Ref(const AVFrame& other) noexcept;

            bool Copy(const AVFrame& other) noexcept;

            bool CopyProps(const AVFrame& other) noexcept;

            bool GetBuffer(int align = 0) noexcept;

            bool AllocVideo(int width, int height, int format, int align = 0) noexcept;

            bool AllocAudio(int nb_samples, int format, const AVChannelLayout& layout, int sample_rate) noexcept;

            void Unref() noexcept;

            int Width() const noexcept;

            void Width(int width) noexcept;

            int Height() const noexcept;

            void Height(int height) noexcept;

            int Format() const noexcept;

            void Format(int format) noexcept;

            bool Hardware() const noexcept;

            static int FormatNone() noexcept;

            static int FormatGray8() noexcept;

            static int FormatRgba() noexcept;

            static int FormatYUV420P() noexcept;

            enum class VideoLayout: std::uint8_t {
                Unknown,    
                Gray,       
                Yuv420,     
                Yuv422,     
                Yuv444      
            };

            enum class Scaler: std::uint8_t {
                Zimg,       
                Sws         
            };

            enum class Resample: std::uint8_t {
                Default,    
                Point,      
                Bilinear,   
                Bicubic,    
                Spline,     
                Lanczos     
            };

            VideoLayout Layout() const noexcept;

            static AVFrame DecodeImage(const std::uint8_t* data, std::size_t size,
                std::string_view hint = {}) noexcept;

            std::int64_t Pts() const noexcept;

            void Pts(std::int64_t pts) noexcept;

            std::int64_t BestEffortTimestamp() const noexcept;

            void BestEffortTimestamp(std::int64_t ts) noexcept;

            std::int64_t DurationTicks() const noexcept;

            void DurationTicks(std::int64_t duration) noexcept;

            int ColorRange() const noexcept;

            void ColorRange(int range) noexcept;

            int ColorSpace() const noexcept;

            void ColorSpace(int space) noexcept;

            int ColorPrimaries() const noexcept;

            void ColorPrimaries(int primaries) noexcept;

            int ColorTransfer() const noexcept;

            void ColorTransfer(int transfer) noexcept;

            int ChromaLocation() const noexcept;

            void ChromaLocation(int location) noexcept;

            AVRational SampleAspectRatio() const noexcept;

            void SampleAspectRatio(AVRational sar) noexcept;

            int PictType() const noexcept;

            void PictType(int type) noexcept;

            bool KeyFrame() const noexcept;

            void KeyFrame(bool key) noexcept;

            int RepeatPict() const noexcept;

            void RepeatPict(int repeat) noexcept;

            bool Interlaced() const noexcept;

            void Interlaced(bool interlaced, bool top_first) noexcept;

            bool TopFieldFirst() const noexcept;

            int CropLeft() const noexcept;

            int CropRight() const noexcept;

            int CropTop() const noexcept;

            int CropBottom() const noexcept;

            void Crop(int left, int right, int top, int bottom) noexcept;

            bool ApplyCropping(int flags = 0) noexcept;

            int PlaneCount() const noexcept;

            int PlaneWidth(int plane) const noexcept;

            int PlaneHeight(int plane) const noexcept;

            int BitsPerComponent() const noexcept;

            const char* FormatName() const noexcept;

            const uint8_t* Data(int plane) const noexcept;

            uint8_t* Data(int plane) noexcept;

            int Linesize(int plane) const noexcept;

            int NbSamples() const noexcept;

            void NbSamples(int samples) noexcept;

            int SampleRate() const noexcept;

            void SampleRate(int rate) noexcept;

            int Channels() const noexcept;

            AVChannelLayout ChannelLayout() const noexcept;

            bool CopyChannelLayout(const AVChannelLayout& layout) noexcept;

            uint8_t** ExtendedData() noexcept;

            const uint8_t* const* ExtendedData() const noexcept;

            const AVFrameSideData* SideData(int type) const noexcept;

            AVFrameSideData* SideData(int type) noexcept;

            void RemoveSideData(int type) noexcept;

            int SideDataCount() const noexcept;

            const AVFrameSideData* SideDataAt(int index) const noexcept;

            uint8_t* NewSideData(int type, int size) noexcept;

            void CopyPrimaryBuffer(StormByte::Buffer::DataType& out) const noexcept;

            void WriteHdr10(const StormByte::Multimedia::Property::HDR10& hdr10) noexcept;

            void WriteSideData(const std::vector<StormByte::Multimedia::Pipeline::SideData>& attachments) noexcept;

            bool ScaleTo(AVFrame& dst, int dst_w, int dst_h,
                Resample filter = Resample::Default,
                Scaler scaler = Scaler::Zimg) const noexcept;

            void Reset(::AVFrame* raw) noexcept;
 
        private:
            void Free() noexcept override;
 
            using AVPointer<::AVFrame>::Get;
            using AVPointer<::AVFrame>::Detach;
    };
 
    extern template class STORMBYTE_MULTIMEDIA_PUBLIC AVPointer<::AVFrame>;
}