Tags Class Reference

ID3 Tags (for MP3) More...

#include <Tags.h>

Inheritance diagram for Tags:

Collaboration diagram for Tags:

Public Types
using	Iterators = IteratorRange< TagMap::const_iterator >

Public Member Functions
	Tags ()
	Tags (const Tags &)=default
virtual	~Tags ()
std::shared_ptr< Tags >	Duplicate () const
void	Merge (const Tags &other)
Tags &	operator= (const Tags &src)
bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override
XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override
void	WriteXML (XMLWriter &xmlFile) const
void	LoadDefaultGenres ()
void	LoadGenres ()
void	LoadDefaults ()
int	GetNumUserGenres ()
wxString	GetUserGenre (int value)
wxString	GetGenre (int value)
int	GetGenre (const wxString &name)
bool	HasTag (const wxString &name) const
wxString	GetTag (const wxString &name) const
Iterators	GetRange () const
void	SetTag (const wxString &name, const wxString &value, const bool bSpecialTag=false)
void	SetTag (const wxString &name, const int &value)
bool	IsEmpty ()
void	Clear ()
size_t	Count () const
void	RestoreUndoRedoState (AudacityProject &) override
	Modify the project when undoing or redoing to some state in history. More...
Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()
virtual	~XMLTagHandler ()
virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0
virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))
virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))
virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0
void	ReadXMLEndTag (const char *tag)
void	ReadXMLContent (const char *s, int len)
XMLTagHandler *	ReadXMLChild (const char *tag)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from UndoStateExtension
virtual	~UndoStateExtension ()
virtual void	RestoreUndoRedoState (AudacityProject &project)=0
	Modify the project when undoing or redoing to some state in history. More...
virtual bool	CanUndoOrRedo (const AudacityProject &project)
	Whether undo or redo is now permitted; default returns true. More...

Static Public Member Functions
static Tags &	Get (AudacityProject &project)
static const Tags &	Get (const AudacityProject &project)
static Tags &	Set (AudacityProject &project, const std::shared_ptr< Tags > &tags)

Private Attributes
TagMap	mXref
TagMap	mMap
wxArrayString	mGenres

Friends
TAGS_API bool	operator== (const Tags &lhs, const Tags &rhs)

Detailed Description

ID3 Tags (for MP3)

This class started as an ID3 tag

This class holds a few informational tags, such as Title, Author, etc. that can be associated with a project or other audio file. It is modeled after the ID3 format for MP3 files, and it can both import and export ID3 tags from/to MP2, MP3, and AIFF files.

It can present the user with a dialog for editing this information.

Use of this functionality requires that libid3tag be compiled in with Audacity.

Definition at line 68 of file Tags.h.

Member Typedef Documentation

Iterators

using Tags::Iterators = IteratorRange<TagMap::const_iterator>

Definition at line 112 of file Tags.h.

Constructor & Destructor Documentation

Tags() [1/2]

Tags::Tags

(

)

Definition at line 231 of file Tags.cpp.

{
   LoadDefaults();
   LoadGenres();
}

References LoadDefaults(), and LoadGenres().

Here is the call graph for this function:

Tags() [2/2]

Tags::Tags ( const Tags &  )

default

~Tags()

Tags::~Tags ( )

virtual

Definition at line 237 of file Tags.cpp.

{
}

Member Function Documentation

Clear()

void Tags::Clear

(

)

Definition at line 293 of file Tags.cpp.

{
   mXref.clear();
   mMap.clear();
}

References mMap, and mXref.

Referenced by FLACImportFileHandle::Import(), OggImportFileHandle::Import(), and WavPackImportFileHandle::Import().

Here is the caller graph for this function:

Count()

size_t Tags::Count

(

)

const

Definition at line 299 of file Tags.cpp.

{
   return mMap.size();
}

References mMap.

Duplicate()

std::shared_ptr< Tags > Tags::Duplicate

(

)

const

Definition at line 241 of file Tags.cpp.

{
   return std::make_shared<Tags>(*this);
}

Get() [1/2]

Tags & Tags::Get ( AudacityProject &  project )

static

Definition at line 214 of file Tags.cpp.

{
   return project.AttachedObjects::Get< Tags >( key );
}

References key, and project.

Referenced by ProjectFileManager::DoImport(), TagsEditorDialog::EditProjectMetadata(), OGGExportProcessor::FillComment(), Get(), anonymous_namespace{ProjectFileManager.cpp}::ImportProject(), FFmpegExporter::Init(), CLExportProcessor::Initialize(), MP2ExportProcessor::Initialize(), MP3ExportProcessor::Initialize(), OpusExportProcessor::Initialize(), PCMExportProcessor::Initialize(), WavPackExportProcessor::Initialize(), FLACExportProcessor::MakeMetadata(), ExportAudioDialog::UpdateLabelExportSettings(), and ExportAudioDialog::UpdateTrackExportSettings().

Here is the caller graph for this function:

Get() [2/2]

const Tags & Tags::Get ( const AudacityProject &  project )

static

Definition at line 219 of file Tags.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get(), and project.

Here is the call graph for this function:

GetGenre() [1/2]

int Tags::GetGenre

(

const wxString &

name

)

Definition at line 384 of file Tags.cpp.

{
   int cnt = WXSIZEOF(DefaultGenres);
 
   for (int i = 0; i < cnt; i++) {
      if (name.CmpNoCase(DefaultGenres[i])) {
         return i;
      }
   }
 
   return 255;
}

References DefaultGenres, and name.

GetGenre() [2/2]

wxString Tags::GetGenre

(

int

value

)

Definition at line 373 of file Tags.cpp.

{
   int cnt = WXSIZEOF(DefaultGenres);
 
   if (i >= 0 && i < cnt) {
      return DefaultGenres[i];
   }
 
   return wxT("");
}

References DefaultGenres, and wxT().

Referenced by anonymous_namespace{ImportMP3_MPG123.cpp}::GetId3v2Genre(), PCMImportFileHandle::Import(), and anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::ReadTags().

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumUserGenres()

int Tags::GetNumUserGenres

(

)

Definition at line 333 of file Tags.cpp.

{
   return mGenres.size();
}

References mGenres.

Referenced by GetUserGenre().

Here is the caller graph for this function:

GetRange()

Tags::Iterators Tags::GetRange

(

)

const

Definition at line 426 of file Tags.cpp.

{
   return { mMap.begin(), mMap.end() };
}

References mMap.

Referenced by PCMExportProcessor::AddID3Chunk(), MP2ExportProcessor::AddTags(), MP3ExportProcessor::AddTags(), OGGExportProcessor::FillComment(), CLExportProcessor::GetMetaChunk(), and FLACExportProcessor::MakeMetadata().

Here is the caller graph for this function:

GetTag()

wxString Tags::GetTag

(

const wxString &

name

)

const

Definition at line 406 of file Tags.cpp.

{
   wxString key = name;
   key.UpperCase();
 
   auto iter = mXref.find(key);
 
   if (iter == mXref.end()) {
      return wxEmptyString;
   }
 
   auto iter2 = mMap.find(iter->second);
   if (iter2 == mMap.end()) {
      wxASSERT(false);
      return wxEmptyString;
   }
   else
      return iter2->second;
}

References key, mMap, mXref, and name.

Referenced by PCMExportProcessor::AddStrings(), PCMImportFileHandle::Import(), and FFmpegExporter::SetMetadata().

Here is the caller graph for this function:

GetUserGenre()

wxString Tags::GetUserGenre

(

int

value

)

Definition at line 364 of file Tags.cpp.

{
   if (i >= 0 && i < GetNumUserGenres()) {
      return mGenres[i];
   }
 
   return wxT("");
}

References GetNumUserGenres(), mGenres, and wxT().

Here is the call graph for this function:

HandleXMLChild()

XMLTagHandler * Tags::HandleXMLChild ( const std::string_view &  tag )

overridevirtual

Implements XMLTagHandler.

Definition at line 526 of file Tags.cpp.

{
   if (tag == "tags") {
      return this;
   }
 
   if (tag == "tag") {
      return this;
   }
 
   return NULL;
}

HandleXMLTag()

bool Tags::HandleXMLTag ( const std::string_view &  tag, const AttributesList &  attrs  )

overridevirtual

Implements XMLTagHandler.

Definition at line 491 of file Tags.cpp.

{
   if (tag == "tags") {
      return true;
   }
 
   if (tag == "tag") {
      wxString n, v;
 
      for (auto pair : attrs)
      {
         auto attr = pair.first;
         auto value = pair.second;
 
         if (attr == "name") {
            n = value.ToWString();
         }
         else if (attr == "value") {
            v = value.ToWString();
         }
      }
 
      if (n == wxT("id3v2")) {
         // LLL:  This is obsolete, but it must be handled and ignored.
      }
      else {
         SetTag(n, v);
      }
 
      return true;
   }
 
   return false;
}

References SetTag(), and wxT().

Here is the call graph for this function:

HasTag()

bool Tags::HasTag

(

const wxString &

name

)

const

Definition at line 397 of file Tags.cpp.

{
   wxString key = name;
   key.UpperCase();
 
   auto iter = mXref.find(key);
   return (iter != mXref.end());
}

References key, mXref, and name.

Referenced by PCMExportProcessor::AddStrings(), FLACImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), WavPackImportFileHandle::Import(), IsEmpty(), and FFmpegExporter::SetMetadata().

Here is the caller graph for this function:

IsEmpty()

bool Tags::IsEmpty

(

)

Definition at line 282 of file Tags.cpp.

{
   // At least one of these should be filled in, otherwise
   // it's assumed that the tags have not been set...
   if (HasTag(TAG_TITLE) || HasTag(TAG_ARTIST) || HasTag(TAG_ALBUM)) {
      return false;
   }
 
   return true;
}

References HasTag(), TAG_ALBUM, TAG_ARTIST, and TAG_TITLE.

Referenced by FFmpegImportFileHandle::WriteMetadata().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadDefaultGenres()

void Tags::LoadDefaultGenres

(

)

Definition at line 338 of file Tags.cpp.

{
   mGenres.clear();
   for (size_t i = 0; i < WXSIZEOF(DefaultGenres); i++) {
      mGenres.push_back(DefaultGenres[i]);
   }
}

References DefaultGenres, and mGenres.

Referenced by LoadGenres().

Here is the caller graph for this function:

LoadDefaults()

void Tags::LoadDefaults

(

)

Definition at line 266 of file Tags.cpp.

{
   wxString value;
   auto tagsGroup = gPrefs->BeginGroup("/Tags");
   for(const auto& key : gPrefs->GetChildKeys())
   {
      gPrefs->Read(key, &value, {});
      if(key == wxT("ID3V2")) {
         // LLL:  This is obsolute, but it must be handled and ignored.
      }
      else {
         SetTag(key, value);
      }
   }
}

References audacity::BasicSettings::BeginGroup(), audacity::BasicSettings::GetChildKeys(), gPrefs, key, audacity::BasicSettings::Read(), SetTag(), and wxT().

Referenced by Tags(), ExportAudioDialog::UpdateLabelExportSettings(), and ExportAudioDialog::UpdateTrackExportSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadGenres()

void Tags::LoadGenres

(

)

Definition at line 346 of file Tags.cpp.

{
   wxFileName fn(FileNames::DataDir(), wxT("genres.txt"));
   wxTextFile tf(fn.GetFullPath());
 
   if (!tf.Exists() || !tf.Open()) {
      LoadDefaultGenres();
      return;
   }
 
   mGenres.clear();
 
   int cnt = tf.GetLineCount();
   for (int i = 0; i < cnt; i++) {
      mGenres.push_back(tf.GetLine(i));
   }
}

References FileNames::DataDir(), fn, LoadDefaultGenres(), mGenres, and wxT().

Referenced by Tags().

Here is the call graph for this function:

Here is the caller graph for this function:

Merge()

void Tags::Merge

(

const Tags &

other

)

Definition at line 246 of file Tags.cpp.

{
   for ( auto &pair : other.mMap ) {
      SetTag( pair.first, pair.second );
   }
}

References mMap, and SetTag().

Referenced by anonymous_namespace{ProjectFileManager.cpp}::ImportProject().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

Tags & Tags::operator=

(

const Tags &

src

)

Definition at line 253 of file Tags.cpp.

{
   mXref.clear();
   mXref = src.mXref;
   mMap.clear();
   mMap = src.mMap;
 
   mGenres.clear();
   mGenres = src.mGenres;
 
   return *this;
}

References mGenres, mMap, and mXref.

RestoreUndoRedoState()

void Tags::RestoreUndoRedoState ( AudacityProject &  project )

overridevirtual

Modify the project when undoing or redoing to some state in history.

Implements UndoStateExtension.

Definition at line 569 of file Tags.cpp.

{
   // Restore tags
   Tags::Set( project, shared_from_this() );
}

References project, and Set().

Here is the call graph for this function:

Set()

Tags & Tags::Set ( AudacityProject &  project, const std::shared_ptr< Tags > &  tags  )

static

Definition at line 224 of file Tags.cpp.

{
   auto &result = *tags;
   project.AttachedObjects::Assign( key, tags );
   return result;
}

References key, and project.

Referenced by ProjectFileManager::DoImport(), TagsEditorDialog::EditProjectMetadata(), and RestoreUndoRedoState().

Here is the caller graph for this function:

SetTag() [1/2]

void Tags::SetTag	(	const wxString &	name,
		const int &	value
	)

Definition at line 486 of file Tags.cpp.

{
   SetTag(name, wxString::Format(wxT("%d"), value));
}

References name, SetTag(), and wxT().

Here is the call graph for this function:

SetTag() [2/2]

void Tags::SetTag	(	const wxString &	name,
		const wxString &	value,
		const bool	bSpecialTag = false
	)

Definition at line 431 of file Tags.cpp.

{
   // We don't like empty names
   if (name.empty()) {
      return;
   }
 
   // Tag name must be ascii
   if (!name.IsAscii()) {
      wxLogError("Tag rejected (Non-ascii character in name)");
      return;
   }
 
   // All keys are uppercase
   wxString key = name;
   key.UpperCase();
 
   // Look it up
   TagMap::iterator iter = mXref.find(key);
 
   // The special tags, if empty, should not exist.
   // However it is allowable for a custom tag to be empty.
   // See Bug 440 and Bug 1382 
   if (value.empty() && bSpecialTag) {
      // Erase the tag
      if (iter == mXref.end())
         // nothing to do
         ;
      else {
         mMap.erase(iter->second);
         mXref.erase(iter);
      }
   }
   else 
   {
      if (iter == mXref.end()) {
         // Didn't find the tag
 
         // Add a NEW tag
         mXref[key] = name;
         mMap[name] = value;
      }
      else if (iter->second != name) {
         // Watch out for case differences!
         mMap[name] = value;
         mMap.erase(iter->second);
         iter->second = name;
      }
      else {
         // Update the value
         mMap[iter->second] = value;
      }
   }
}

References key, mMap, mXref, and name.

Referenced by FFmpegImportFileHandle::GetMetadata(), AUPImportFileHandle::HandleTag(), AUPImportFileHandle::HandleTags(), HandleXMLTag(), FLACImportFileHandle::Import(), OggImportFileHandle::Import(), OpusImportFileHandle::Import(), PCMImportFileHandle::Import(), WavPackImportFileHandle::Import(), LoadDefaults(), Merge(), TagsEditorDialog::OnLoad(), anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportFileHandle::ReadTags(), SetTag(), ExportAudioDialog::UpdateLabelExportSettings(), and ExportAudioDialog::UpdateTrackExportSettings().

Here is the caller graph for this function:

WriteXML()

void Tags::WriteXML

(

XMLWriter &

xmlFile

)

const

Definition at line 539 of file Tags.cpp.

{
   xmlFile.StartTag(wxT("tags"));
 
   for (const auto &pair : GetRange()) {
      const auto &n = pair.first;
      const auto &v = pair.second;
      xmlFile.StartTag(wxT("tag"));
      xmlFile.WriteAttr(wxT("name"), n);
      xmlFile.WriteAttr(wxT("value"), v);
      xmlFile.EndTag(wxT("tag"));
   }
 
   xmlFile.EndTag(wxT("tags"));
}

References wxT().

Here is the call graph for this function:

Friends And Related Function Documentation

operator==

TAGS_API bool operator== ( const Tags &  lhs, const Tags &  rhs  )

friend

Definition at line 322 of file Tags.cpp.

{
   if (!EqualMaps(lhs.mXref, rhs.mXref))
      return false;
 
   if (!EqualMaps(lhs.mMap, rhs.mMap))
      return false;
 
   return lhs.mGenres == rhs.mGenres;
}

Member Data Documentation

mGenres

wxArrayString Tags::mGenres

private

Definition at line 132 of file Tags.h.

Referenced by GetNumUserGenres(), GetUserGenre(), LoadDefaultGenres(), LoadGenres(), and operator=().

mMap

TagMap Tags::mMap

private

Definition at line 130 of file Tags.h.

Referenced by Clear(), Count(), GetRange(), GetTag(), Merge(), operator=(), and SetTag().

mXref

TagMap Tags::mXref

private

Definition at line 129 of file Tags.h.

Referenced by Clear(), GetTag(), HasTag(), operator=(), and SetTag().

---

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

• Tags.h
• Tags.cpp