codeccontext.h

Go to the documentation of this file.

#pragma once
 
#include "avconfig.h"
#include "avcompat.h"
 
#include "ffmpeg.h"
#include "stream.h"
#include "avutils.h"
#include "averror.h"
#include "pixelformat.h"
#include "sampleformat.h"
#include "avlog.h"
#include "frame.h"
#include "codec.h"
#include "channellayout.h"
 
extern "C" {
#include <libavcodec/avcodec.h>
}
 
namespace av {
 
namespace codec_context::audio {
void set_channels(AVCodecContext *obj, int channels);
void set_channel_layout_mask(AVCodecContext *obj, uint64_t mask);
int get_channels(const AVCodecContext *obj);
uint64_t get_channel_layout_mask(const AVCodecContext *obj);
}
 
namespace codec_context::internal {
const int *get_supported_samplerates(const struct AVCodec *codec);
}
 
class CodecContext2 : public FFWrapperPtr<AVCodecContext>, public noncopyable
{
protected:
    void swap(CodecContext2 &other);
 
    //
    // No directly created
    //
 
    using BaseWrapper = FFWrapperPtr<AVCodecContext>;
    using BaseWrapper::BaseWrapper;
 
    CodecContext2();
 
    // Stream decoding/encoding
#if AVCPP_HAS_AVFORMAT
    CodecContext2(const class Stream &st,
                  const class Codec& codec,
                  Direction direction,
                  AVMediaType type);
#endif // if AVCPP_HAS_AVFORMAT
 
    // Stream independ decoding/encoding
    CodecContext2(const class Codec &codec, Direction direction, AVMediaType type);
 
    ~CodecContext2();
 
    void setCodec(const class Codec &codec, bool resetDefaults, Direction direction, AVMediaType type, OptionalErrorCode ec = throws());
 
    AVMediaType codecType(AVMediaType contextType) const noexcept;
 
public:
 
    using BaseWrapper::_log;
 
    //
    // Common
    //
 
    void open(OptionalErrorCode ec = throws());
    void open(const Codec &codec, OptionalErrorCode ec = throws());
    void open(class Dictionary &options, OptionalErrorCode ec = throws());
    void open(class Dictionary &&options, OptionalErrorCode ec = throws());
    void open(class Dictionary &options, const Codec &codec, OptionalErrorCode ec = throws());
    void open(class Dictionary &&options, const Codec &codec, OptionalErrorCode ec = throws());
 
    [[deprecated("Start from FFmpeg 4.0 it is recommended to destroy and recreate codec context insted of close")]]
    void close(OptionalErrorCode ec = throws());
 
    bool isOpened() const noexcept;
    bool isValid() const noexcept;
 
    void copyContextFrom(const CodecContext2 &other, OptionalErrorCode ec = throws());
 
    Rational timeBase() const noexcept;
    void setTimeBase(const Rational &value) noexcept;
 
#if AVCPP_HAS_AVFORMAT
    const Stream& stream() const noexcept;
#endif // if AVCPP_HAS_AVFORMAT
    Codec codec() const noexcept;
 
    void setOption(const std::string &key, const std::string &val, OptionalErrorCode ec = throws());
    void setOption(const std::string &key, const std::string &val, int flags, OptionalErrorCode ec = throws());
 
    int frameSize() const noexcept;
    int64_t frameNumber() const noexcept;
 
    // Note, set ref counted to enable for multithreaded processing
    bool isRefCountedFrames() const noexcept;
    void setRefCountedFrames(bool refcounted) const noexcept;
 
    int strict() const noexcept;
    void setStrict(int strict) noexcept;
 
    int64_t bitRate() const noexcept;
    std::pair<int64_t, int64_t> bitRateRange() const noexcept;
    void setBitRate(int64_t bitRate) noexcept;
    void setBitRateRange(const std::pair<int64_t, int64_t> &bitRateRange) noexcept;
 
    // Flags
    void setFlags(int flags) noexcept;
    void addFlags(int flags) noexcept;
    void clearFlags(int flags) noexcept;
    int flags() noexcept;
    bool isFlags(int flags) noexcept;
 
    // Flags 2
    void setFlags2(int flags) noexcept;
    void addFlags2(int flags) noexcept;
    void clearFlags2(int flags) noexcept;
    int flags2() noexcept;
    bool isFlags2(int flags) noexcept;
 
 
protected:
 
    bool isValidForEncode(Direction direction, AVMediaType type) const noexcept;
 
    bool checkCodec(const Codec& codec, Direction direction, AVMediaType type, OptionalErrorCode ec);
 
    void open(const Codec &codec, AVDictionary **options, OptionalErrorCode ec);
 
 
    std::pair<int, const std::error_category*>
    decodeCommon(AVFrame *outFrame, const class Packet &inPacket, size_t offset, int &frameFinished,
                 int (*decodeProc)(AVCodecContext*, AVFrame*,int *, const AVPacket *)) noexcept;
 
    std::pair<int, const std::error_category*>
    encodeCommon(class Packet &outPacket, const AVFrame *inFrame, int &gotPacket,
                         int (*encodeProc)(AVCodecContext*, AVPacket*,const AVFrame*, int*)) noexcept;
 
public:
    template<typename T>
    std::pair<int, const std::error_category*>
    decodeCommon(T &outFrame,
                 const class Packet &inPacket,
                 size_t offset,
                 int &frameFinished,
                 int (*decodeProc)(AVCodecContext *, AVFrame *, int *, const AVPacket *));
 
    template<typename T>
    std::pair<int, const std::error_category*>
    encodeCommon(class Packet &outPacket,
                 const T &inFrame,
                 int &gotPacket,
                 int (*encodeProc)(AVCodecContext *, AVPacket *, const AVFrame *, int *));
 
private:
#if AVCPP_HAS_AVFORMAT
    Stream m_stream;
#endif // if AVCPP_HAS_AVFORMAT
};
 
 
class GenericCodecContext : public CodecContext2
{
protected:
    using CodecContext2::codecType;
 
public:
    GenericCodecContext() = default;
 
#if AVCPP_HAS_AVFORMAT
    GenericCodecContext(Stream st);
#endif // if AVCPP_HAS_AVFORMAT
 
    GenericCodecContext(GenericCodecContext&& other);
 
    GenericCodecContext& operator=(GenericCodecContext&& rhs);
 
    AVMediaType codecType() const noexcept;
};
 
 
template<typename Clazz, Direction _direction, AVMediaType _type>
class CodecContextBase : public CodecContext2
{
protected:
    Clazz& moveOperator(Clazz &&rhs)
    {
        if (this == &rhs)
            return static_cast<Clazz&>(*this);
        Clazz(std::forward<Clazz>(rhs)).swap(static_cast<Clazz&>(*this));
        return static_cast<Clazz&>(*this);
    }
 
    using CodecContext2::setCodec;
 
public:
 
    using CodecContext2::_log;
 
    CodecContextBase()
        : CodecContext2()
    {
    }
 
    // Stream decoding/encoding
#if AVCPP_HAS_AVFORMAT
    explicit CodecContextBase(const class Stream &st, const class Codec& codec = Codec())
        : CodecContext2(st, codec, _direction, _type)
    {
    }
#endif // if AVCPP_HAS_AVFORMAT
 
    // Stream independ decoding/encoding
    explicit CodecContextBase(const Codec &codec)
        : CodecContext2(codec, _direction, _type)
    {
    }
 
    //
    // Disable copy/Activate move
    //
    CodecContextBase(CodecContextBase &&other)
        : CodecContextBase()
    {
        swap(other);
    }
    //
 
 
    void setCodec(const Codec &codec, OptionalErrorCode ec = throws())
    {
        setCodec(codec, false, _direction, _type, ec);
    }
 
    void setCodec(const Codec &codec, bool resetDefaults, OptionalErrorCode ec = throws())
    {
        setCodec(codec, resetDefaults, _direction, _type, ec);
    }
 
    AVMediaType codecType() const noexcept
    {
        return CodecContext2::codecType(_type);
    }
};
 
 
template<typename Clazz, Direction _direction>
class VideoCodecContext : public CodecContextBase<Clazz, _direction, AVMEDIA_TYPE_VIDEO>
{
public:
    using Parent = CodecContextBase<Clazz, _direction, AVMEDIA_TYPE_VIDEO>;
    using Parent::Parent;
    using Parent::isValid;
    using Parent::isOpened;
 
    int width() const
    {
        return RAW_GET2(isValid(), width, 0);
    }
 
    int height() const
    {
        return RAW_GET2(isValid(), height, 0);
    }
 
    int codedWidth() const
    {
        return RAW_GET2(isValid(), coded_width, 0);
    }
 
    int codedHeight() const
    {
        return RAW_GET2(isValid(), coded_height, 0);
    }
 
    PixelFormat pixelFormat() const
    {
        return RAW_GET2(isValid(), pix_fmt, AV_PIX_FMT_NONE);
    }
 
    int32_t globalQuality() const
    {
        return RAW_GET2(isValid(), global_quality, FF_LAMBDA_MAX);
    }
 
    int32_t gopSize() const
    {
        return RAW_GET2(isValid(), gop_size, 0);
    }
 
    int bitRateTolerance() const
    {
        return RAW_GET2(isValid(), bit_rate_tolerance, 0);
    }
 
    int maxBFrames() const
    {
        return RAW_GET2(isValid(), max_b_frames, 0);
    }
 
    Rational sampleAspectRatio() const
    {
        return RAW_GET(sample_aspect_ratio, AVRational());
    }
 
    void setWidth(int w) // Note, it also sets coded_width
    {
        if (isValid() && !isOpened())
        {
            m_raw->width       = w;
            m_raw->coded_width = w;
        }
    }
 
    void setHeight(int h) // Note, it also sets coded_height
    {
        if (isValid() && !isOpened())
        {
            m_raw->height       = h;
            m_raw->coded_height = h;
        }
    }
 
    void setCodedWidth(int w)
    {
        RAW_SET2(isValid() && !isOpened(), coded_width, w);
    }
 
    void setCodedHeight(int h)
    {
        RAW_SET2(isValid() && !isOpened(), coded_height, h);
    }
 
    void setPixelFormat(PixelFormat pixelFormat)
    {
        RAW_SET2(isValid(), pix_fmt, pixelFormat);
    }
 
    void setGlobalQuality(int32_t quality)
    {
        if (quality < 0 || quality > FF_LAMBDA_MAX)
            quality = FF_LAMBDA_MAX;
 
        RAW_SET2(isValid(), global_quality, quality);
    }
 
    void setGopSize(int32_t size)
    {
        RAW_SET2(isValid(), gop_size, size);
    }
 
    void setBitRateTolerance(int bitRateTolerance)
    {
        RAW_SET2(isValid(), bit_rate_tolerance, bitRateTolerance);
    }
 
    void setMaxBFrames(int maxBFrames)
    {
        RAW_SET2(isValid(), max_b_frames, maxBFrames);
    }
 
    void setSampleAspectRatio(const Rational& sampleAspectRatio)
    {
        RAW_SET(sample_aspect_ratio, sampleAspectRatio);
    }
 
protected:
    using Parent::moveOperator;
    using Parent::m_raw;
};
 
 
class VideoDecoderContext : public VideoCodecContext<VideoDecoderContext, Direction::Decoding>
{
public:
    using Parent = VideoCodecContext<VideoDecoderContext, Direction::Decoding>;
    using Parent::Parent;
 
    VideoDecoderContext() = default;
    VideoDecoderContext(VideoDecoderContext&& other);
 
    VideoDecoderContext& operator=(VideoDecoderContext&& other);
 
    VideoFrame decode(const Packet    &packet,
                      OptionalErrorCode ec = throws(),
                      bool             autoAllocateFrame = true);
 
    VideoFrame decode(const Packet &packet,
                      size_t offset,
                      size_t &decodedBytes,
                      OptionalErrorCode ec = throws(),
                      bool    autoAllocateFrame = true);
 
 
private:
    VideoFrame decodeVideo(OptionalErrorCode ec,
                           const Packet &packet,
                           size_t offset,
                           size_t *decodedBytes,
                           bool    autoAllocateFrame);
 
};
 
 
class VideoEncoderContext : public VideoCodecContext<VideoEncoderContext, Direction::Encoding>
{
public:
    using Parent = VideoCodecContext<VideoEncoderContext, Direction::Encoding>;
    using Parent::Parent;
 
    VideoEncoderContext() = default;
    VideoEncoderContext(VideoEncoderContext&& other);
 
    VideoEncoderContext& operator=(VideoEncoderContext&& other);
 
    Packet encode(OptionalErrorCode ec = throws());
 
    Packet encode(const VideoFrame &inFrame, OptionalErrorCode ec = throws());
 
};
 
 
template<typename Clazz, Direction _direction>
class AudioCodecContext : public CodecContextBase<Clazz, _direction, AVMEDIA_TYPE_AUDIO>
{
public:
    using Parent = CodecContextBase<Clazz, _direction, AVMEDIA_TYPE_AUDIO>;
    using Parent::Parent;
    using Parent::isValid;
    using Parent::isOpened;
    using Parent::_log;
 
    int sampleRate() const noexcept
    {
        return RAW_GET2(isValid(), sample_rate, 0);
    }
 
    int channels() const noexcept
    {
        if (!isValid())
            return 0;
        return codec_context::audio::get_channels(m_raw);
    }
 
    SampleFormat sampleFormat() const noexcept
    {
        return RAW_GET2(isValid(), sample_fmt, AV_SAMPLE_FMT_NONE);
    }
 
    uint64_t channelLayout() const noexcept
    {
        if (!isValid())
            return 0;
        return codec_context::audio::get_channel_layout_mask(m_raw);
    }
 
#if AVCPP_API_NEW_CHANNEL_LAYOUT
    ChannelLayoutView channelLayout2() const noexcept
    {
        if (!isValid())
            return ChannelLayoutView{};
        return ChannelLayoutView{m_raw->ch_layout};
    }
#endif
 
    void setSampleRate(int sampleRate) noexcept
    {
        if (!isValid())
            return;
#if AVCPP_CXX_STANDARD >= 20
        int sr = guessValue(sampleRate, make_array_view_until<const int>(codec_context::internal::get_supported_samplerates(m_raw->codec), 0));
#else
        int sr = guessValue(sampleRate, codec_context::internal::get_supported_samplerates(m_raw->codec), EqualComparator<int>(0));
#endif
        if (sr != sampleRate)
        {
            fflog(AV_LOG_INFO, "Guess sample rate %d instead unsupported %d\n", sr, sampleRate);
        }
        if (sr > 0)
            m_raw->sample_rate = sr;
    }
 
    void setChannels(int channels) noexcept
    {
        if (!isValid() || channels <= 0)
            return;
        codec_context::audio::set_channels(m_raw, channels);
    }
 
    void setSampleFormat(SampleFormat sampleFormat) noexcept
    {
        RAW_SET2(isValid(), sample_fmt, sampleFormat);
    }
 
    void setChannelLayout(uint64_t layout) noexcept
    {
        if (!isValid() || layout == 0)
            return;
        codec_context::audio::set_channel_layout_mask(m_raw, layout);
    }
 
#if AVCPP_API_NEW_CHANNEL_LAYOUT
    void setChannelLayout(ChannelLayout layout) noexcept
    {
        if (!isValid() || !layout.isValid())
            return;
        m_raw->ch_layout = *layout.raw();
        layout.release(); // is controlled by the CodecContext
    }
#endif
 
protected:
    using Parent::moveOperator;
    using Parent::m_raw;
};
 
 
class AudioDecoderContext : public AudioCodecContext<AudioDecoderContext, Direction::Decoding>
{
public:
    using Parent = AudioCodecContext<AudioDecoderContext, Direction::Decoding>;
    using Parent::Parent;
 
    AudioDecoderContext() = default;
    AudioDecoderContext(AudioDecoderContext&& other);
 
    AudioDecoderContext& operator=(AudioDecoderContext&& other);
 
    AudioSamples decode(const Packet &inPacket, OptionalErrorCode ec = throws());
    AudioSamples decode(const Packet &inPacket, size_t offset, OptionalErrorCode ec = throws());
 
};
 
 
class AudioEncoderContext : public AudioCodecContext<AudioEncoderContext, Direction::Encoding>
{
public:
    using Parent = AudioCodecContext<AudioEncoderContext, Direction::Encoding>;
    using Parent::Parent;
 
    AudioEncoderContext() = default;
    AudioEncoderContext(AudioEncoderContext&& other);
 
    AudioEncoderContext& operator=(AudioEncoderContext&& other);
 
    Packet encode(OptionalErrorCode ec = throws());
    Packet encode(const AudioSamples &inSamples, OptionalErrorCode ec = throws());
 
};
 
 
} // namespace av