AVCodecContextWrapper Class Reference

#include <AVCodecContextWrapper.h>

Collaboration diagram for AVCodecContextWrapper:

Public Member Functions
	AVCodecContextWrapper (const AVCodecContextWrapper &)=delete
AVCodecContextWrapper &	operator= (AVCodecContextWrapper &)=delete
	AVCodecContextWrapper (AVCodecContextWrapper &&)=delete
AVCodecContextWrapper &	operator= (AVCodecContextWrapper &&)=delete
	AVCodecContextWrapper (const FFmpegFunctions &ffmpeg, std::unique_ptr< AVCodecWrapper > codec) noexcept
	AVCodecContextWrapper (const FFmpegFunctions &ffmpeg, AVCodecContext *wrapped) noexcept
AVCodecContext *	GetWrappedValue () noexcept
const AVCodecContext *	GetWrappedValue () const noexcept
virtual	~AVCodecContextWrapper ()
std::vector< uint8_t >	DecodeAudioPacket (const AVPacketWrapper *packet)
virtual sampleFormat	GetPreferredAudacitySampleFormat () const noexcept=0
virtual std::vector< int16_t >	DecodeAudioPacketInt16 (const AVPacketWrapper *packet)=0
virtual std::vector< float >	DecodeAudioPacketFloat (const AVPacketWrapper *packet)=0
virtual int	GetBitRate () const noexcept=0
virtual void	SetBitRate (int value) noexcept=0
virtual const AVChannelLayoutWrapper *	GetChannelLayout () const noexcept=0
virtual void	SetChannelLayout (const AVChannelLayoutWrapper *value) noexcept=0
virtual int	GetChannels () const noexcept=0
virtual const AVCodecWrapper *	GetCodec () const noexcept=0
virtual AVCodecIDFwd	GetCodecId () const noexcept=0
void	SetCodecTagFourCC (const char *fourCC) noexcept
virtual void	SetCodecTag (unsigned int tag) noexcept=0
virtual unsigned int	GetCodecTag () const noexcept=0
virtual AVMediaTypeFwd	GetCodecType () const noexcept=0
virtual int	GetCompressionLevel () const noexcept=0
virtual void	SetCompressionLevel (int value) noexcept=0
virtual int	GetCutoff () const noexcept=0
virtual void	SetCutoff (int value) noexcept=0
virtual int	GetFlags () const noexcept=0
virtual void	SetFlags (int value) noexcept=0
virtual int	GetFlags2 () const noexcept=0
virtual void	SetFlags2 (int value) noexcept=0
virtual int	GetFrameNumber () const noexcept=0
virtual int	GetFrameSize () const noexcept=0
virtual void	SetFrameSize (int value) noexcept=0
virtual int	GetGlobalQuality () const noexcept=0
virtual void	SetGlobalQuality (int value) noexcept=0
virtual int	GetProfile () const noexcept=0
virtual void	SetProfile (int value) noexcept=0
virtual AVSampleFormatFwd	GetSampleFmt () const noexcept=0
virtual void	SetSampleFmt (AVSampleFormatFwd value) noexcept=0
virtual int	GetSampleRate () const noexcept=0
virtual void	SetSampleRate (int value) noexcept=0
virtual int	GetStrictStdCompliance () const noexcept=0
virtual void	SetStrictStdCompliance (int value) noexcept=0
virtual struct AudacityAVRational	GetTimeBase () const noexcept=0
virtual void	SetTimeBase (struct AudacityAVRational value) noexcept=0
virtual int	Open (const AVCodecWrapper *codec, AVDictionaryWrapper *options=nullptr)=0

Protected Attributes
const FFmpegFunctions &	mFFmpeg
AVCodecContext *	mAVCodecContext { nullptr }
std::unique_ptr< AVCodecWrapper >	mAVCodec
bool	mIsOwned { false }

Private Member Functions
void	ConsumeFrame (std::vector< uint8_t > &data, AVFrameWrapper &frame)

Detailed Description

Definition at line 30 of file AVCodecContextWrapper.h.

Constructor & Destructor Documentation

AVCodecContextWrapper() [1/4]

AVCodecContextWrapper::AVCodecContextWrapper ( const AVCodecContextWrapper &  )

delete

AVCodecContextWrapper() [2/4]

AVCodecContextWrapper::AVCodecContextWrapper ( AVCodecContextWrapper &&  )

delete

AVCodecContextWrapper() [3/4]

AVCodecContextWrapper::AVCodecContextWrapper ( const FFmpegFunctions &  ffmpeg, std::unique_ptr< AVCodecWrapper >  codec  )

noexcept

Definition at line 18 of file AVCodecContextWrapper.cpp.

    : mFFmpeg(ffmpeg)
    , mAVCodec(std::move(codec))
    , mIsOwned(true)
{
   mAVCodecContext =
      mFFmpeg.avcodec_alloc_context3(mAVCodec->GetWrappedValue());
}

AVCodecContextWrapper() [4/4]

AVCodecContextWrapper::AVCodecContextWrapper ( const FFmpegFunctions &  ffmpeg, AVCodecContext *  wrapped  )

noexcept

Definition at line 28 of file AVCodecContextWrapper.cpp.

    : mFFmpeg(ffmpeg)
    , mAVCodecContext(wrapped)
    , mIsOwned(false)
{
 
}

~AVCodecContextWrapper()

AVCodecContextWrapper::~AVCodecContextWrapper ( )

virtual

Definition at line 47 of file AVCodecContextWrapper.cpp.

{
   if (mIsOwned && mAVCodecContext != nullptr)
   {
      // avcodec_free_context, complementary to avcodec_alloc_context3, is
      // not necessarily loaded
      if (mFFmpeg.avcodec_free_context != nullptr)
      {
         mFFmpeg.avcodec_free_context(&mAVCodecContext);
      }
      else
      {
         // Its not clear how to avoid the leak here, but let's close
         // the codec at least
         if (mFFmpeg.avcodec_is_open(mAVCodecContext))
            mFFmpeg.avcodec_close(mAVCodecContext);
      }
   }
}

References AVCodecFunctions::avcodec_close, AVCodecFunctions::avcodec_free_context, AVCodecFunctions::avcodec_is_open, mAVCodecContext, mFFmpeg, and mIsOwned.

Member Function Documentation

ConsumeFrame()

void AVCodecContextWrapper::ConsumeFrame ( std::vector< uint8_t > &  data, AVFrameWrapper &  frame  )

private

Definition at line 150 of file AVCodecContextWrapper.cpp.

{
   const int channels = GetChannels();
 
   const auto sampleSize = static_cast<size_t>(mFFmpeg.av_get_bytes_per_sample(
      static_cast<AVSampleFormatFwd>(frame.GetFormat())));
 
   const auto samplesCount = frame.GetSamplesCount();
   const auto frameSize = channels * sampleSize * samplesCount;
 
   auto oldSize = data.size();
   data.resize(oldSize + frameSize);
   auto pData = &data[oldSize];
 
   if (frame.GetData(1) != nullptr)
   {
      // We return interleaved buffer
      for (int channel = 0; channel < channels; channel++)
      {
         for (int sample = 0; sample < samplesCount; sample++)
         {
            const uint8_t* channelData =
               frame.GetExtendedData(channel) + sampleSize * sample;
 
            uint8_t* output =
               pData + sampleSize * (channels * sample + channel);
 
            std::copy(channelData, channelData + sampleSize, output);
         }
      }
   }
   else
   {
      uint8_t* frameData = frame.GetData(0);
      std::copy(frameData, frameData + frameSize, pData);
   }
}

References AVUtilFunctions::av_get_bytes_per_sample, staffpad::vo::copy(), GetChannels(), AVFrameWrapper::GetData(), AVFrameWrapper::GetExtendedData(), AVFrameWrapper::GetFormat(), AVFrameWrapper::GetSamplesCount(), and mFFmpeg.

Referenced by DecodeAudioPacket().

Here is the call graph for this function:

Here is the caller graph for this function:

DecodeAudioPacket()

std::vector< uint8_t > AVCodecContextWrapper::DecodeAudioPacket

(

const AVPacketWrapper *

packet

)

Definition at line 68 of file AVCodecContextWrapper.cpp.

{
   auto frame = mFFmpeg.CreateAVFrameWrapper();
   std::vector<uint8_t> data;
 
   if (mFFmpeg.avcodec_send_packet == nullptr)
   {
      std::unique_ptr<AVPacketWrapper> packetCopy =
         packet ? packet->Clone() : mFFmpeg.CreateAVPacketWrapper();
 
      /*
       "Flushing is done by calling this function [avcodec_decode_audio4]
       with packets with avpkt->data set to NULL and avpkt->size set to 0
       until it stops returning samples."
       (That implies, not necessarily just one loop pass to flush)
       */
      bool flushing = packet
         ? (packetCopy->GetSize() == 0 && packetCopy->GetData() == nullptr)
         : true;
      if (!flushing && packetCopy->GetData() == nullptr)
         return {};
 
      int bytesDecoded = 0;
 
      do
      {
         int gotFrame;
         // Deprecated?  https://ffmpeg.org/doxygen/3.3/group__lavc__decoding.html#gaaa1fbe477c04455cdc7a994090100db4
         bytesDecoded = mFFmpeg.avcodec_decode_audio4(
            mAVCodecContext, frame->GetWrappedValue(), &gotFrame,
            packetCopy->GetWrappedValue());
 
         if (bytesDecoded < 0)
            return data; // Packet decoding has failed
 
         if (gotFrame == 0)
         {
            /*
             "Note that this field being set to zero does not mean that an
             error has occurred. For decoders with AV_CODEC_CAP_DELAY set, no
             given decode call is guaranteed to produce a frame."
             */
            // (Let's assume this doesn't happen when flushing)
            // Still, the data was consumed by the decoder, so we need to
            // offset the packet
            packetCopy->OffsetPacket(bytesDecoded);
            continue;
         }
         
         ConsumeFrame(data, *frame);
         
         packetCopy->OffsetPacket(bytesDecoded);
      }
      while ( flushing ? bytesDecoded > 0 : packetCopy->GetSize() > 0 );
   }
   else
   {
      auto ret = mFFmpeg.avcodec_send_packet(
         mAVCodecContext,
         packet != nullptr ? packet->GetWrappedValue() : nullptr);
 
      if (ret < 0)
         // send_packet has failed
         return data;
 
      while (ret >= 0)
      {
         ret = mFFmpeg.avcodec_receive_frame(mAVCodecContext, frame->GetWrappedValue());
         if (ret == AUDACITY_AVERROR(EAGAIN) || ret == AUDACITY_AVERROR_EOF)
            // The packet is fully consumed OR more data is needed
            break;
         else if (ret < 0)
            // Decoding has failed
            return data;
 
         ConsumeFrame(data, *frame);
      }
   }
 
   return data;
}

References AUDACITY_AVERROR, AUDACITY_AVERROR_EOF, AVCodecFunctions::avcodec_decode_audio4, AVCodecFunctions::avcodec_receive_frame, AVCodecFunctions::avcodec_send_packet, AVPacketWrapper::Clone(), ConsumeFrame(), FFmpegFunctions::CreateAVFrameWrapper(), FFmpegFunctions::CreateAVPacketWrapper(), AVPacketWrapper::GetWrappedValue(), mAVCodecContext, and mFFmpeg.

Here is the call graph for this function:

DecodeAudioPacketFloat()

virtual std::vector< float > AVCodecContextWrapper::DecodeAudioPacketFloat ( const AVPacketWrapper *  packet )

pure virtual

DecodeAudioPacketInt16()

virtual std::vector< int16_t > AVCodecContextWrapper::DecodeAudioPacketInt16 ( const AVPacketWrapper *  packet )

pure virtual

GetBitRate()

virtual int AVCodecContextWrapper::GetBitRate ( ) const

pure virtualnoexcept

GetChannelLayout()

virtual const AVChannelLayoutWrapper * AVCodecContextWrapper::GetChannelLayout ( ) const

pure virtualnoexcept

GetChannels()

virtual int AVCodecContextWrapper::GetChannels ( ) const

pure virtualnoexcept

Referenced by ConsumeFrame().

Here is the caller graph for this function:

GetCodec()

virtual const AVCodecWrapper * AVCodecContextWrapper::GetCodec ( ) const

pure virtualnoexcept

GetCodecId()

virtual AVCodecIDFwd AVCodecContextWrapper::GetCodecId ( ) const

pure virtualnoexcept

GetCodecTag()

virtual unsigned int AVCodecContextWrapper::GetCodecTag ( ) const

pure virtualnoexcept

GetCodecType()

virtual AVMediaTypeFwd AVCodecContextWrapper::GetCodecType ( ) const

pure virtualnoexcept

GetCompressionLevel()

virtual int AVCodecContextWrapper::GetCompressionLevel ( ) const

pure virtualnoexcept

GetCutoff()

virtual int AVCodecContextWrapper::GetCutoff ( ) const

pure virtualnoexcept

GetFlags()

virtual int AVCodecContextWrapper::GetFlags ( ) const

pure virtualnoexcept

GetFlags2()

virtual int AVCodecContextWrapper::GetFlags2 ( ) const

pure virtualnoexcept

GetFrameNumber()

virtual int AVCodecContextWrapper::GetFrameNumber ( ) const

pure virtualnoexcept

GetFrameSize()

virtual int AVCodecContextWrapper::GetFrameSize ( ) const

pure virtualnoexcept

GetGlobalQuality()

virtual int AVCodecContextWrapper::GetGlobalQuality ( ) const

pure virtualnoexcept

GetPreferredAudacitySampleFormat()

virtual sampleFormat AVCodecContextWrapper::GetPreferredAudacitySampleFormat ( ) const

pure virtualnoexcept

GetProfile()

virtual int AVCodecContextWrapper::GetProfile ( ) const

pure virtualnoexcept

GetSampleFmt()

virtual AVSampleFormatFwd AVCodecContextWrapper::GetSampleFmt ( ) const

pure virtualnoexcept

GetSampleRate()

virtual int AVCodecContextWrapper::GetSampleRate ( ) const

pure virtualnoexcept

GetStrictStdCompliance()

virtual int AVCodecContextWrapper::GetStrictStdCompliance ( ) const

pure virtualnoexcept

GetTimeBase()

virtual struct AudacityAVRational AVCodecContextWrapper::GetTimeBase ( ) const

pure virtualnoexcept

GetWrappedValue() [1/2]

const AVCodecContext * AVCodecContextWrapper::GetWrappedValue ( ) const

noexcept

Definition at line 42 of file AVCodecContextWrapper.cpp.

{
   return mAVCodecContext;
}

References mAVCodecContext.

GetWrappedValue() [2/2]

AVCodecContext * AVCodecContextWrapper::GetWrappedValue ( )

noexcept

Definition at line 37 of file AVCodecContextWrapper.cpp.

{
    return mAVCodecContext;
}

References mAVCodecContext.

Open()

virtual int AVCodecContextWrapper::Open ( const AVCodecWrapper *  codec, AVDictionaryWrapper *  options = nullptr  )

pure virtual

Parameters

options

A dictionary filled with AVCodecContext and codec-private options. On return this object will be filled with options that were not found.

Returns

zero if success, negative if error

operator=() [1/2]

AVCodecContextWrapper & AVCodecContextWrapper::operator= ( AVCodecContextWrapper &&  )

delete

operator=() [2/2]

AVCodecContextWrapper & AVCodecContextWrapper::operator= ( AVCodecContextWrapper &  )

delete

SetBitRate()

virtual void AVCodecContextWrapper::SetBitRate ( int  value )

pure virtualnoexcept

SetChannelLayout()

virtual void AVCodecContextWrapper::SetChannelLayout ( const AVChannelLayoutWrapper *  value )

pure virtualnoexcept

SetCodecTag()

virtual void AVCodecContextWrapper::SetCodecTag ( unsigned int  tag )

pure virtualnoexcept

SetCodecTagFourCC()

void AVCodecContextWrapper::SetCodecTagFourCC ( const char *  fourCC )

noexcept

Definition at line 199 of file AVCodecContextWrapper.cpp.

{
   if (fourCC == nullptr || std::strlen(fourCC) != 4)
      return;
 
   SetCodecTag(MakeTag(fourCC[0], fourCC[1], fourCC[2], fourCC[3]));
}

References anonymous_namespace{AVCodecContextWrapper.cpp}::MakeTag().

Here is the call graph for this function:

SetCompressionLevel()

virtual void AVCodecContextWrapper::SetCompressionLevel ( int  value )

pure virtualnoexcept

SetCutoff()

virtual void AVCodecContextWrapper::SetCutoff ( int  value )

pure virtualnoexcept

SetFlags()

virtual void AVCodecContextWrapper::SetFlags ( int  value )

pure virtualnoexcept

SetFlags2()

virtual void AVCodecContextWrapper::SetFlags2 ( int  value )

pure virtualnoexcept

SetFrameSize()

virtual void AVCodecContextWrapper::SetFrameSize ( int  value )

pure virtualnoexcept

SetGlobalQuality()

virtual void AVCodecContextWrapper::SetGlobalQuality ( int  value )

pure virtualnoexcept

SetProfile()

virtual void AVCodecContextWrapper::SetProfile ( int  value )

pure virtualnoexcept

SetSampleFmt()

virtual void AVCodecContextWrapper::SetSampleFmt ( AVSampleFormatFwd  value )

pure virtualnoexcept

SetSampleRate()

virtual void AVCodecContextWrapper::SetSampleRate ( int  value )

pure virtualnoexcept

SetStrictStdCompliance()

virtual void AVCodecContextWrapper::SetStrictStdCompliance ( int  value )

pure virtualnoexcept

SetTimeBase()

virtual void AVCodecContextWrapper::SetTimeBase ( struct AudacityAVRational  value )

pure virtualnoexcept

Member Data Documentation

mAVCodec

std::unique_ptr<AVCodecWrapper> AVCodecContextWrapper::mAVCodec

mutableprotected

Definition at line 125 of file AVCodecContextWrapper.h.

mAVCodecContext

AVCodecContext* AVCodecContextWrapper::mAVCodecContext { nullptr }

protected

Definition at line 123 of file AVCodecContextWrapper.h.

Referenced by DecodeAudioPacket(), GetWrappedValue(), and ~AVCodecContextWrapper().

mFFmpeg

const FFmpegFunctions& AVCodecContextWrapper::mFFmpeg

protected

Definition at line 122 of file AVCodecContextWrapper.h.

Referenced by ConsumeFrame(), DecodeAudioPacket(), and ~AVCodecContextWrapper().

mIsOwned

bool AVCodecContextWrapper::mIsOwned { false }

protected

Definition at line 127 of file AVCodecContextWrapper.h.

Referenced by ~AVCodecContextWrapper().

---

The documentation for this class was generated from the following files:

• AVCodecContextWrapper.h
• AVCodecContextWrapper.cpp