AVDictionaryWrapper Class Reference

#include <AVDictionaryWrapper.h>

Collaboration diagram for AVDictionaryWrapper:

Public Member Functions
	AVDictionaryWrapper (const AVDictionaryWrapper &rhs) noexcept
	Unlike the other FFmpeg wrapper classes, this one is copyable. More...
	AVDictionaryWrapper (AVDictionaryWrapper &&rhs) noexcept
AVDictionaryWrapper &	operator= (const AVDictionaryWrapper &rhs) noexcept
AVDictionaryWrapper &	operator= (AVDictionaryWrapper &&rhs) noexcept
	AVDictionaryWrapper (const FFmpegFunctions &ffmpeg) noexcept
	AVDictionaryWrapper (const FFmpegFunctions &ffmpeg, AVDictionary *rhs) noexcept
AVDictionary *	GetWrappedValue () noexcept
const AVDictionary *	GetWrappedValue () const noexcept
virtual	~AVDictionaryWrapper ()
void	Set (const std::string_view &key, const std::string &value, int flags=0) noexcept
void	Set (const std::string_view &key, const wxString &value, int flags=0) noexcept
void	Set (const std::string_view &key, const char *value, int flags=0) noexcept
template<typename T >
void	Set (const std::string_view &key, const T &value, int flags=0) noexcept
std::string_view	Get (const std::string_view &key, const std::string_view &defaultValue, int flags=0) const
bool	HasValue (const std::string_view &key, int flags=0) const noexcept
AVDictionary *	Release () noexcept

Protected Attributes
const FFmpegFunctions &	mFFmpeg
AVDictionary *	mAVDictionary { nullptr }

Detailed Description

Definition at line 23 of file AVDictionaryWrapper.h.

Constructor & Destructor Documentation

AVDictionaryWrapper() [1/4]

AVDictionaryWrapper::AVDictionaryWrapper ( const AVDictionaryWrapper &  rhs )

noexcept

Unlike the other FFmpeg wrapper classes, this one is copyable.

Definition at line 32 of file AVDictionaryWrapper.cpp.

    : AVDictionaryWrapper(rhs.mFFmpeg, rhs.mAVDictionary)
{
}

AVDictionaryWrapper() [2/4]

AVDictionaryWrapper::AVDictionaryWrapper ( AVDictionaryWrapper &&  rhs )

noexcept

Definition at line 38 of file AVDictionaryWrapper.cpp.

    : mFFmpeg(rhs.mFFmpeg)
{
   *this = std::move(rhs);
}

AVDictionaryWrapper() [3/4]

AVDictionaryWrapper::AVDictionaryWrapper ( const FFmpegFunctions &  ffmpeg )

explicitnoexcept

Definition at line 18 of file AVDictionaryWrapper.cpp.

    : mFFmpeg(ffmpeg)
{
}

AVDictionaryWrapper() [4/4]

AVDictionaryWrapper::AVDictionaryWrapper ( const FFmpegFunctions &  ffmpeg, AVDictionary *  rhs  )

explicitnoexcept

Definition at line 24 of file AVDictionaryWrapper.cpp.

    : mFFmpeg(ffmpeg)
{
   if (rhs != nullptr)
      mFFmpeg.av_dict_copy(&mAVDictionary, rhs, 0);
}

~AVDictionaryWrapper()

AVDictionaryWrapper::~AVDictionaryWrapper ( )

virtual

Definition at line 76 of file AVDictionaryWrapper.cpp.

{
   mFFmpeg.av_dict_free(&mAVDictionary);
}

References AVUtilFunctions::av_dict_free, mAVDictionary, and mFFmpeg.

Member Function Documentation

Get()

std::string_view AVDictionaryWrapper::Get	(	const std::string_view &	key,
		const std::string_view &	defaultValue,
		int	flags = 0
	)		const

Definition at line 101 of file AVDictionaryWrapper.cpp.

{
   if (mAVDictionary == nullptr)
      return defaultValue;
 
   AudacityAVDictionaryEntry* entry =
      mFFmpeg.av_dict_get(mAVDictionary, key.data(), nullptr, flags);
 
   if (entry != nullptr)
      return entry->value;
 
   return defaultValue;
}

References AVUtilFunctions::av_dict_get, entry, key, mAVDictionary, and mFFmpeg.

Referenced by FFmpegImportFileHandle::InitCodecs().

Here is the caller graph for this function:

GetWrappedValue() [1/2]

const AVDictionary * AVDictionaryWrapper::GetWrappedValue ( ) const

noexcept

Definition at line 71 of file AVDictionaryWrapper.cpp.

{
   return mAVDictionary;
}

References mAVDictionary.

GetWrappedValue() [2/2]

AVDictionary * AVDictionaryWrapper::GetWrappedValue ( )

noexcept

Definition at line 66 of file AVDictionaryWrapper.cpp.

{
   return mAVDictionary;
}

References mAVDictionary.

HasValue()

bool AVDictionaryWrapper::HasValue ( const std::string_view &  key, int  flags = 0  ) const

noexcept

Definition at line 117 of file AVDictionaryWrapper.cpp.

{
   if (mAVDictionary == nullptr)
      return false;
 
   AudacityAVDictionaryEntry* entry =
      mFFmpeg.av_dict_get(mAVDictionary, key.data(), nullptr, flags);
 
   return entry != nullptr;
}

References entry, and key.

operator=() [1/2]

AVDictionaryWrapper & AVDictionaryWrapper::operator= ( AVDictionaryWrapper &&  rhs )

noexcept

Definition at line 57 of file AVDictionaryWrapper.cpp.

{
   assert(&mFFmpeg == &rhs.mFFmpeg);
 
   std::swap(mAVDictionary, rhs.mAVDictionary);
 
   return *this;
}

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

operator=() [2/2]

AVDictionaryWrapper & AVDictionaryWrapper::operator= ( const AVDictionaryWrapper &  rhs )

noexcept

Definition at line 46 of file AVDictionaryWrapper.cpp.

{
   assert(&mFFmpeg == &rhs.mFFmpeg);
 
   if (rhs.mAVDictionary != nullptr)
      mFFmpeg.av_dict_copy(&mAVDictionary, rhs.mAVDictionary, 0);
 
   return *this;
}

Release()

AVDictionary * AVDictionaryWrapper::Release ( )

noexcept

Definition at line 129 of file AVDictionaryWrapper.cpp.

{
   auto temp = mAVDictionary;
   mAVDictionary = nullptr;
 
   return temp;
}

References mAVDictionary.

Referenced by AVFormatContextWrapper::OpenInputContext().

Here is the caller graph for this function:

Set() [1/4]

void AVDictionaryWrapper::Set ( const std::string_view &  key, const char *  value, int  flags = 0  )

noexcept

Definition at line 94 of file AVDictionaryWrapper.cpp.

{
   mFFmpeg.av_dict_set(
      &mAVDictionary, key.data(), value, flags);
}

References key.

Set() [2/4]

void AVDictionaryWrapper::Set ( const std::string_view &  key, const std::string &  value, int  flags = 0  )

noexcept

Definition at line 81 of file AVDictionaryWrapper.cpp.

{
   mFFmpeg.av_dict_set(&mAVDictionary, key.data(), value.data(), flags);
}

References key.

Referenced by FFmpegExporter::InitCodecs(), and FFmpegExporter::SetMetadata().

Here is the caller graph for this function:

Set() [3/4]

template<typename T >

void AVDictionaryWrapper::Set ( const std::string_view &  key, const T &  value, int  flags = 0  )

inlinenoexcept

Definition at line 47 of file AVDictionaryWrapper.h.

   {
      Set(key, std::to_string(value), flags);
   }

References key.

Set() [4/4]

void AVDictionaryWrapper::Set ( const std::string_view &  key, const wxString &  value, int  flags = 0  )

noexcept

Definition at line 88 of file AVDictionaryWrapper.cpp.

{
   mFFmpeg.av_dict_set(&mAVDictionary, key.data(), value.ToUTF8().data(), flags);
}

References key.

Member Data Documentation

mAVDictionary

AVDictionary* AVDictionaryWrapper::mAVDictionary { nullptr }

protected

Definition at line 58 of file AVDictionaryWrapper.h.

Referenced by Get(), GetWrappedValue(), Release(), and ~AVDictionaryWrapper().

mFFmpeg

const FFmpegFunctions& AVDictionaryWrapper::mFFmpeg

protected

Definition at line 57 of file AVDictionaryWrapper.h.

Referenced by Get(), and ~AVDictionaryWrapper().

---

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

• AVDictionaryWrapper.h
• AVDictionaryWrapper.cpp