943 lines
26 KiB
C++
943 lines
26 KiB
C++
/***************************************************************************
|
|
copyright : (C) 2002 - 2008 by Scott Wheeler
|
|
email : wheeler@kde.org
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* This library is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU Lesser General Public License version *
|
|
* 2.1 as published by the Free Software Foundation. *
|
|
* *
|
|
* This library 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 along with this library; if not, write to the Free Software *
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
|
|
* 02110-1301 USA *
|
|
* *
|
|
* Alternatively, this file is available under the Mozilla Public *
|
|
* License Version 1.1. You may obtain a copy of the License at *
|
|
* http://www.mozilla.org/MPL/ *
|
|
***************************************************************************/
|
|
|
|
#include <algorithm>
|
|
|
|
#include <tfile.h>
|
|
#include <tbytevector.h>
|
|
#include <tpropertymap.h>
|
|
#include <tdebug.h>
|
|
|
|
#include "id3v2tag.h"
|
|
#include "id3v2header.h"
|
|
#include "id3v2extendedheader.h"
|
|
#include "id3v2footer.h"
|
|
#include "id3v2synchdata.h"
|
|
#include "id3v1genres.h"
|
|
|
|
#include "frames/textidentificationframe.h"
|
|
#include "frames/commentsframe.h"
|
|
#include "frames/urllinkframe.h"
|
|
#include "frames/uniquefileidentifierframe.h"
|
|
#include "frames/unsynchronizedlyricsframe.h"
|
|
#include "frames/unknownframe.h"
|
|
|
|
using namespace TagLib;
|
|
using namespace ID3v2;
|
|
|
|
namespace
|
|
{
|
|
const ID3v2::Latin1StringHandler defaultStringHandler;
|
|
const ID3v2::Latin1StringHandler *stringHandler = &defaultStringHandler;
|
|
|
|
const long MinPaddingSize = 1024;
|
|
const long MaxPaddingSize = 1024 * 1024;
|
|
|
|
bool contains(const char **a, const ByteVector &v)
|
|
{
|
|
for(int i = 0; a[i]; i++)
|
|
{
|
|
if(v == a[i])
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
class ID3v2::Tag::TagPrivate
|
|
{
|
|
public:
|
|
TagPrivate() :
|
|
factory(0),
|
|
file(0),
|
|
tagOffset(0),
|
|
extendedHeader(0),
|
|
footer(0)
|
|
{
|
|
frameList.setAutoDelete(true);
|
|
}
|
|
|
|
~TagPrivate()
|
|
{
|
|
delete extendedHeader;
|
|
delete footer;
|
|
}
|
|
|
|
const FrameFactory *factory;
|
|
|
|
File *file;
|
|
long tagOffset;
|
|
|
|
Header header;
|
|
ExtendedHeader *extendedHeader;
|
|
Footer *footer;
|
|
|
|
FrameListMap frameListMap;
|
|
FrameList frameList;
|
|
};
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// StringHandler implementation
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
Latin1StringHandler::Latin1StringHandler()
|
|
{
|
|
}
|
|
|
|
Latin1StringHandler::~Latin1StringHandler()
|
|
{
|
|
}
|
|
|
|
String Latin1StringHandler::parse(const ByteVector &data) const
|
|
{
|
|
return String(data, String::Latin1);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// public members
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
ID3v2::Tag::Tag() :
|
|
TagLib::Tag(),
|
|
d(new TagPrivate())
|
|
{
|
|
d->factory = FrameFactory::instance();
|
|
}
|
|
|
|
ID3v2::Tag::Tag(File *file, long tagOffset, const FrameFactory *factory) :
|
|
TagLib::Tag(),
|
|
d(new TagPrivate())
|
|
{
|
|
d->factory = factory;
|
|
d->file = file;
|
|
d->tagOffset = tagOffset;
|
|
|
|
read();
|
|
}
|
|
|
|
ID3v2::Tag::~Tag()
|
|
{
|
|
delete d;
|
|
}
|
|
|
|
String ID3v2::Tag::title() const
|
|
{
|
|
if(!d->frameListMap["TIT2"].isEmpty())
|
|
return d->frameListMap["TIT2"].front()->toString();
|
|
return String();
|
|
}
|
|
|
|
String ID3v2::Tag::artist() const
|
|
{
|
|
if(!d->frameListMap["TPE1"].isEmpty())
|
|
return d->frameListMap["TPE1"].front()->toString();
|
|
return String();
|
|
}
|
|
|
|
String ID3v2::Tag::albumartist() const
|
|
{
|
|
if(!d->frameListMap["TPE2"].isEmpty())
|
|
return d->frameListMap["TPE2"].front()->toString();
|
|
return String();
|
|
}
|
|
|
|
String ID3v2::Tag::album() const
|
|
{
|
|
if(!d->frameListMap["TALB"].isEmpty())
|
|
return d->frameListMap["TALB"].front()->toString();
|
|
return String();
|
|
}
|
|
|
|
String ID3v2::Tag::comment() const
|
|
{
|
|
const FrameList &comments = d->frameListMap["COMM"];
|
|
|
|
if(comments.isEmpty())
|
|
return String();
|
|
|
|
for(FrameList::ConstIterator it = comments.begin(); it != comments.end(); ++it)
|
|
{
|
|
CommentsFrame *frame = dynamic_cast<CommentsFrame *>(*it);
|
|
|
|
if(frame && frame->description().isEmpty())
|
|
return (*it)->toString();
|
|
}
|
|
|
|
return comments.front()->toString();
|
|
}
|
|
|
|
String ID3v2::Tag::genre() const
|
|
{
|
|
// TODO: In the next major version (TagLib 2.0) a list of multiple genres
|
|
// should be separated by " / " instead of " ". For the moment to keep
|
|
// the behavior the same as released versions it is being left with " ".
|
|
|
|
if(d->frameListMap["TCON"].isEmpty() ||
|
|
!dynamic_cast<TextIdentificationFrame *>(d->frameListMap["TCON"].front()))
|
|
{
|
|
return String();
|
|
}
|
|
|
|
// ID3v2.4 lists genres as the fields in its frames field list. If the field
|
|
// is simply a number it can be assumed that it is an ID3v1 genre number.
|
|
// Here was assume that if an ID3v1 string is present that it should be
|
|
// appended to the genre string. Multiple fields will be appended as the
|
|
// string is built.
|
|
|
|
TextIdentificationFrame *f = static_cast<TextIdentificationFrame *>(
|
|
d->frameListMap["TCON"].front());
|
|
|
|
StringList fields = f->fieldList();
|
|
|
|
StringList genres;
|
|
|
|
for(StringList::Iterator it = fields.begin(); it != fields.end(); ++it) {
|
|
|
|
if((*it).isEmpty())
|
|
continue;
|
|
|
|
bool ok;
|
|
int number = (*it).toInt(&ok);
|
|
if(ok && number >= 0 && number <= 255) {
|
|
*it = ID3v1::genre(number);
|
|
}
|
|
|
|
if(std::find(genres.begin(), genres.end(), *it) == genres.end())
|
|
genres.append(*it);
|
|
}
|
|
|
|
return genres.toString();
|
|
}
|
|
|
|
unsigned int ID3v2::Tag::year() const
|
|
{
|
|
if(!d->frameListMap["TDRC"].isEmpty())
|
|
return d->frameListMap["TDRC"].front()->toString().substr(0, 4).toInt();
|
|
return 0;
|
|
}
|
|
|
|
unsigned int ID3v2::Tag::track() const
|
|
{
|
|
if(!d->frameListMap["TRCK"].isEmpty())
|
|
return d->frameListMap["TRCK"].front()->toString().toInt();
|
|
return 0;
|
|
}
|
|
|
|
float ID3v2::Tag::rg(const String &type) const
|
|
{
|
|
const FrameList &list = d->frameListMap["TXXX"];
|
|
if (!list.isEmpty()) {
|
|
for (FrameList::ConstIterator it = list.begin(); it != list.end(); ++it) {
|
|
UserTextIdentificationFrame const* frame = static_cast<UserTextIdentificationFrame *>(*it);
|
|
if (!frame->description().isNull() && frame->description() == type) {
|
|
return frame->toString().toFloat();
|
|
}
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
float ID3v2::Tag::rgAlbumGain() const
|
|
{
|
|
return rg("replaygain_album_gain");
|
|
}
|
|
|
|
float ID3v2::Tag::rgAlbumPeak() const
|
|
{
|
|
return rg("replaygain_album_peak");
|
|
}
|
|
|
|
float ID3v2::Tag::rgTrackGain() const
|
|
{
|
|
return rg("replaygain_track_gain");
|
|
}
|
|
|
|
float ID3v2::Tag::rgTrackPeak() const
|
|
{
|
|
return rg("replaygain_track_peak");
|
|
}
|
|
|
|
void ID3v2::Tag::setTitle(const String &s)
|
|
{
|
|
setTextFrame("TIT2", s);
|
|
}
|
|
|
|
void ID3v2::Tag::setArtist(const String &s)
|
|
{
|
|
setTextFrame("TPE1", s);
|
|
}
|
|
|
|
void ID3v2::Tag::setAlbumArtist(const String &s)
|
|
{
|
|
setTextFrame("TPE2", s);
|
|
}
|
|
|
|
void ID3v2::Tag::setAlbum(const String &s)
|
|
{
|
|
setTextFrame("TALB", s);
|
|
}
|
|
|
|
void ID3v2::Tag::setComment(const String &s)
|
|
{
|
|
if(s.isEmpty()) {
|
|
removeFrames("COMM");
|
|
return;
|
|
}
|
|
|
|
const FrameList &comments = d->frameListMap["COMM"];
|
|
|
|
if(!comments.isEmpty()) {
|
|
for(FrameList::ConstIterator it = comments.begin(); it != comments.end(); ++it) {
|
|
CommentsFrame *frame = dynamic_cast<CommentsFrame *>(*it);
|
|
if(frame && frame->description().isEmpty()) {
|
|
(*it)->setText(s);
|
|
return;
|
|
}
|
|
}
|
|
|
|
comments.front()->setText(s);
|
|
return;
|
|
}
|
|
|
|
CommentsFrame *f = new CommentsFrame(d->factory->defaultTextEncoding());
|
|
addFrame(f);
|
|
f->setText(s);
|
|
}
|
|
|
|
void ID3v2::Tag::setGenre(const String &s)
|
|
{
|
|
if(s.isEmpty()) {
|
|
removeFrames("TCON");
|
|
return;
|
|
}
|
|
|
|
// iTunes can't handle correctly encoded ID3v2.4 numerical genres. Just use
|
|
// strings until iTunes sucks less.
|
|
|
|
#ifdef NO_ITUNES_HACKS
|
|
|
|
int index = ID3v1::genreIndex(s);
|
|
|
|
if(index != 255)
|
|
setTextFrame("TCON", String::number(index));
|
|
else
|
|
setTextFrame("TCON", s);
|
|
|
|
#else
|
|
|
|
setTextFrame("TCON", s);
|
|
|
|
#endif
|
|
}
|
|
|
|
void ID3v2::Tag::setYear(unsigned int i)
|
|
{
|
|
if(i == 0) {
|
|
removeFrames("TDRC");
|
|
return;
|
|
}
|
|
setTextFrame("TDRC", String::number(i));
|
|
}
|
|
|
|
void ID3v2::Tag::setTrack(unsigned int i)
|
|
{
|
|
if(i == 0) {
|
|
removeFrames("TRCK");
|
|
return;
|
|
}
|
|
setTextFrame("TRCK", String::number(i));
|
|
}
|
|
|
|
void ID3v2::Tag::setRG(const String &type, float f, bool peak)
|
|
{
|
|
bool createdFrame = false;
|
|
UserTextIdentificationFrame * frame = NULL;
|
|
FrameList &list = d->frameListMap["TXXX"];
|
|
for (FrameList::Iterator it = list.begin(); it != list.end(); ++it) {
|
|
if (static_cast<UserTextIdentificationFrame *>(*it)->description() == type) {
|
|
frame = static_cast<UserTextIdentificationFrame*>(*it);
|
|
break;
|
|
}
|
|
}
|
|
if (f == 0) {
|
|
if (frame)
|
|
removeFrame(frame);
|
|
return;
|
|
}
|
|
if (frame == NULL) {
|
|
frame = new UserTextIdentificationFrame;
|
|
frame->setDescription(type);
|
|
createdFrame = true;
|
|
}
|
|
frame->setText(String::number(f) + (peak ? "" : " dB"));
|
|
if (createdFrame)
|
|
addFrame(frame);
|
|
}
|
|
|
|
void ID3v2::Tag::setRGAlbumGain(float f)
|
|
{
|
|
setRG("replaygain_album_gain", f, false);
|
|
}
|
|
|
|
void ID3v2::Tag::setRGAlbumPeak(float f)
|
|
{
|
|
setRG("replaygain_album_peak", f, true);
|
|
}
|
|
|
|
void ID3v2::Tag::setRGTrackGain(float f)
|
|
{
|
|
setRG("replaygain_track_gain", f, false);
|
|
}
|
|
|
|
void ID3v2::Tag::setRGTrackPeak(float f)
|
|
{
|
|
setRG("replaygain_track_peak", f, true);
|
|
}
|
|
|
|
bool ID3v2::Tag::isEmpty() const
|
|
{
|
|
return d->frameList.isEmpty();
|
|
}
|
|
|
|
Header *ID3v2::Tag::header() const
|
|
{
|
|
return &(d->header);
|
|
}
|
|
|
|
ExtendedHeader *ID3v2::Tag::extendedHeader() const
|
|
{
|
|
return d->extendedHeader;
|
|
}
|
|
|
|
Footer *ID3v2::Tag::footer() const
|
|
{
|
|
return d->footer;
|
|
}
|
|
|
|
const FrameListMap &ID3v2::Tag::frameListMap() const
|
|
{
|
|
return d->frameListMap;
|
|
}
|
|
|
|
const FrameList &ID3v2::Tag::frameList() const
|
|
{
|
|
return d->frameList;
|
|
}
|
|
|
|
const FrameList &ID3v2::Tag::frameList(const ByteVector &frameID) const
|
|
{
|
|
return d->frameListMap[frameID];
|
|
}
|
|
|
|
void ID3v2::Tag::addFrame(Frame *frame)
|
|
{
|
|
d->frameList.append(frame);
|
|
d->frameListMap[frame->frameID()].append(frame);
|
|
}
|
|
|
|
void ID3v2::Tag::removeFrame(Frame *frame, bool del)
|
|
{
|
|
// remove the frame from the frame list
|
|
FrameList::Iterator it = d->frameList.find(frame);
|
|
d->frameList.erase(it);
|
|
|
|
// ...and from the frame list map
|
|
it = d->frameListMap[frame->frameID()].find(frame);
|
|
d->frameListMap[frame->frameID()].erase(it);
|
|
|
|
// ...and delete as desired
|
|
if(del)
|
|
delete frame;
|
|
}
|
|
|
|
void ID3v2::Tag::removeFrames(const ByteVector &id)
|
|
{
|
|
FrameList l = d->frameListMap[id];
|
|
for(FrameList::ConstIterator it = l.begin(); it != l.end(); ++it)
|
|
removeFrame(*it, true);
|
|
}
|
|
|
|
PropertyMap ID3v2::Tag::properties() const
|
|
{
|
|
PropertyMap properties;
|
|
for(FrameList::ConstIterator it = frameList().begin(); it != frameList().end(); ++it) {
|
|
PropertyMap props = (*it)->asProperties();
|
|
properties.merge(props);
|
|
}
|
|
return properties;
|
|
}
|
|
|
|
void ID3v2::Tag::removeUnsupportedProperties(const StringList &properties)
|
|
{
|
|
for(StringList::ConstIterator it = properties.begin(); it != properties.end(); ++it){
|
|
if(it->startsWith("UNKNOWN/")) {
|
|
String frameID = it->substr(String("UNKNOWN/").size());
|
|
if(frameID.size() != 4)
|
|
continue; // invalid specification
|
|
ByteVector id = frameID.data(String::Latin1);
|
|
// delete all unknown frames of given type
|
|
FrameList l = frameList(id);
|
|
for(FrameList::ConstIterator fit = l.begin(); fit != l.end(); fit++)
|
|
if (dynamic_cast<const UnknownFrame *>(*fit) != 0)
|
|
removeFrame(*fit);
|
|
}
|
|
else if(it->size() == 4){
|
|
ByteVector id = it->data(String::Latin1);
|
|
removeFrames(id);
|
|
}
|
|
else {
|
|
ByteVector id = it->substr(0,4).data(String::Latin1);
|
|
if(it->size() <= 5)
|
|
continue; // invalid specification
|
|
String description = it->substr(5);
|
|
Frame *frame = 0;
|
|
if(id == "TXXX")
|
|
frame = UserTextIdentificationFrame::find(this, description);
|
|
else if(id == "WXXX")
|
|
frame = UserUrlLinkFrame::find(this, description);
|
|
else if(id == "COMM")
|
|
frame = CommentsFrame::findByDescription(this, description);
|
|
else if(id == "USLT")
|
|
frame = UnsynchronizedLyricsFrame::findByDescription(this, description);
|
|
else if(id == "UFID")
|
|
frame = UniqueFileIdentifierFrame::findByOwner(this, description);
|
|
if(frame)
|
|
removeFrame(frame);
|
|
}
|
|
}
|
|
}
|
|
|
|
PropertyMap ID3v2::Tag::setProperties(const PropertyMap &origProps)
|
|
{
|
|
FrameList framesToDelete;
|
|
// we split up the PropertyMap into the "normal" keys and the "complicated" ones,
|
|
// which are those according to TIPL or TMCL frames.
|
|
PropertyMap properties;
|
|
PropertyMap tiplProperties;
|
|
PropertyMap tmclProperties;
|
|
Frame::splitProperties(origProps, properties, tiplProperties, tmclProperties);
|
|
for(FrameListMap::ConstIterator it = frameListMap().begin(); it != frameListMap().end(); ++it){
|
|
for(FrameList::ConstIterator lit = it->second.begin(); lit != it->second.end(); ++lit){
|
|
PropertyMap frameProperties = (*lit)->asProperties();
|
|
if(it->first == "TIPL") {
|
|
if (tiplProperties != frameProperties)
|
|
framesToDelete.append(*lit);
|
|
else
|
|
tiplProperties.erase(frameProperties);
|
|
} else if(it->first == "TMCL") {
|
|
if (tmclProperties != frameProperties)
|
|
framesToDelete.append(*lit);
|
|
else
|
|
tmclProperties.erase(frameProperties);
|
|
} else if(!properties.contains(frameProperties))
|
|
framesToDelete.append(*lit);
|
|
else
|
|
properties.erase(frameProperties);
|
|
}
|
|
}
|
|
for(FrameList::ConstIterator it = framesToDelete.begin(); it != framesToDelete.end(); ++it)
|
|
removeFrame(*it);
|
|
|
|
// now create remaining frames:
|
|
// start with the involved people list (TIPL)
|
|
if(!tiplProperties.isEmpty())
|
|
addFrame(TextIdentificationFrame::createTIPLFrame(tiplProperties));
|
|
// proceed with the musician credit list (TMCL)
|
|
if(!tmclProperties.isEmpty())
|
|
addFrame(TextIdentificationFrame::createTMCLFrame(tmclProperties));
|
|
// now create the "one key per frame" frames
|
|
for(PropertyMap::ConstIterator it = properties.begin(); it != properties.end(); ++it)
|
|
addFrame(Frame::createTextualFrame(it->first, it->second));
|
|
return PropertyMap(); // ID3 implements the complete PropertyMap interface, so an empty map is returned
|
|
}
|
|
|
|
ByteVector ID3v2::Tag::render() const
|
|
{
|
|
return render(ID3v2::v4);
|
|
}
|
|
|
|
void ID3v2::Tag::downgradeFrames(FrameList *frames, FrameList *newFrames) const
|
|
{
|
|
#ifdef NO_ITUNES_HACKS
|
|
static const char *unsupportedFrames[] = {
|
|
"ASPI", "EQU2", "RVA2", "SEEK", "SIGN", "TDRL", "TDTG",
|
|
"TMOO", "TPRO", "TSOA", "TSOT", "TSST", "TSOP", 0
|
|
};
|
|
#else
|
|
// iTunes writes and reads TSOA, TSOT, TSOP to ID3v2.3.
|
|
static const char *unsupportedFrames[] = {
|
|
"ASPI", "EQU2", "RVA2", "SEEK", "SIGN", "TDRL", "TDTG",
|
|
"TMOO", "TPRO", "TSST", 0
|
|
};
|
|
#endif
|
|
ID3v2::TextIdentificationFrame *frameTDOR = 0;
|
|
ID3v2::TextIdentificationFrame *frameTDRC = 0;
|
|
ID3v2::TextIdentificationFrame *frameTIPL = 0;
|
|
ID3v2::TextIdentificationFrame *frameTMCL = 0;
|
|
ID3v2::TextIdentificationFrame *frameTCON = 0;
|
|
|
|
for(FrameList::ConstIterator it = d->frameList.begin(); it != d->frameList.end(); it++) {
|
|
ID3v2::Frame *frame = *it;
|
|
ByteVector frameID = frame->header()->frameID();
|
|
|
|
if(contains(unsupportedFrames, frameID))
|
|
{
|
|
debug("A frame that is not supported in ID3v2.3 \'" + String(frameID) +
|
|
"\' has been discarded");
|
|
continue;
|
|
}
|
|
|
|
if(frameID == "TDOR")
|
|
frameTDOR = dynamic_cast<ID3v2::TextIdentificationFrame *>(frame);
|
|
else if(frameID == "TDRC")
|
|
frameTDRC = dynamic_cast<ID3v2::TextIdentificationFrame *>(frame);
|
|
else if(frameID == "TIPL")
|
|
frameTIPL = dynamic_cast<ID3v2::TextIdentificationFrame *>(frame);
|
|
else if(frameID == "TMCL")
|
|
frameTMCL = dynamic_cast<ID3v2::TextIdentificationFrame *>(frame);
|
|
else if(frame && frameID == "TCON")
|
|
frameTCON = dynamic_cast<ID3v2::TextIdentificationFrame *>(frame);
|
|
else
|
|
frames->append(frame);
|
|
}
|
|
|
|
if(frameTDOR) {
|
|
String content = frameTDOR->toString();
|
|
|
|
if(content.size() >= 4) {
|
|
ID3v2::TextIdentificationFrame *frameTORY =
|
|
new ID3v2::TextIdentificationFrame("TORY", String::Latin1);
|
|
frameTORY->setText(content.substr(0, 4));
|
|
frames->append(frameTORY);
|
|
newFrames->append(frameTORY);
|
|
}
|
|
}
|
|
|
|
if(frameTDRC) {
|
|
String content = frameTDRC->toString();
|
|
if(content.size() >= 4) {
|
|
ID3v2::TextIdentificationFrame *frameTYER =
|
|
new ID3v2::TextIdentificationFrame("TYER", String::Latin1);
|
|
frameTYER->setText(content.substr(0, 4));
|
|
frames->append(frameTYER);
|
|
newFrames->append(frameTYER);
|
|
if(content.size() >= 10 && content[4] == '-' && content[7] == '-') {
|
|
ID3v2::TextIdentificationFrame *frameTDAT =
|
|
new ID3v2::TextIdentificationFrame("TDAT", String::Latin1);
|
|
frameTDAT->setText(content.substr(8, 2) + content.substr(5, 2));
|
|
frames->append(frameTDAT);
|
|
newFrames->append(frameTDAT);
|
|
if(content.size() >= 16 && content[10] == 'T' && content[13] == ':') {
|
|
ID3v2::TextIdentificationFrame *frameTIME =
|
|
new ID3v2::TextIdentificationFrame("TIME", String::Latin1);
|
|
frameTIME->setText(content.substr(11, 2) + content.substr(14, 2));
|
|
frames->append(frameTIME);
|
|
newFrames->append(frameTIME);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if(frameTIPL || frameTMCL) {
|
|
ID3v2::TextIdentificationFrame *frameIPLS =
|
|
new ID3v2::TextIdentificationFrame("IPLS", String::Latin1);
|
|
|
|
StringList people;
|
|
|
|
if(frameTMCL) {
|
|
StringList v24People = frameTMCL->fieldList();
|
|
for(unsigned int i = 0; i + 1 < v24People.size(); i += 2) {
|
|
people.append(v24People[i]);
|
|
people.append(v24People[i+1]);
|
|
}
|
|
}
|
|
if(frameTIPL) {
|
|
StringList v24People = frameTIPL->fieldList();
|
|
for(unsigned int i = 0; i + 1 < v24People.size(); i += 2) {
|
|
people.append(v24People[i]);
|
|
people.append(v24People[i+1]);
|
|
}
|
|
}
|
|
|
|
frameIPLS->setText(people);
|
|
frames->append(frameIPLS);
|
|
newFrames->append(frameIPLS);
|
|
}
|
|
|
|
if(frameTCON) {
|
|
StringList genres = frameTCON->fieldList();
|
|
String combined;
|
|
String genreText;
|
|
const bool hasMultipleGenres = genres.size() > 1;
|
|
|
|
// If there are multiple genres, add them as multiple references to ID3v1
|
|
// genres if such a reference exists. The first genre for which no ID3v1
|
|
// genre number exists can be finally added as a refinement.
|
|
for(StringList::ConstIterator it = genres.begin(); it != genres.end(); ++it) {
|
|
bool ok = false;
|
|
int number = it->toInt(&ok);
|
|
if((ok && number >= 0 && number <= 255) || *it == "RX" || *it == "CR")
|
|
combined += '(' + *it + ')';
|
|
else if(hasMultipleGenres && (number = ID3v1::genreIndex(*it)) != 255)
|
|
combined += '(' + String::number(number) + ')';
|
|
else if(genreText.isEmpty())
|
|
genreText = *it;
|
|
}
|
|
if(!genreText.isEmpty())
|
|
combined += genreText;
|
|
|
|
frameTCON = new ID3v2::TextIdentificationFrame("TCON", String::Latin1);
|
|
frameTCON->setText(combined);
|
|
frames->append(frameTCON);
|
|
newFrames->append(frameTCON);
|
|
}
|
|
}
|
|
|
|
ByteVector ID3v2::Tag::render(int version) const
|
|
{
|
|
return render(version == 3 ? v3 : v4);
|
|
}
|
|
|
|
ByteVector ID3v2::Tag::render(Version version) const
|
|
{
|
|
// We need to render the "tag data" first so that we have to correct size to
|
|
// render in the tag's header. The "tag data" -- everything that is included
|
|
// in ID3v2::Header::tagSize() -- includes the extended header, frames and
|
|
// padding, but does not include the tag's header or footer.
|
|
|
|
// TODO: Render the extended header.
|
|
|
|
// Downgrade the frames that ID3v2.3 doesn't support.
|
|
|
|
FrameList newFrames;
|
|
newFrames.setAutoDelete(true);
|
|
|
|
FrameList frameList;
|
|
if(version == v4) {
|
|
frameList = d->frameList;
|
|
}
|
|
else {
|
|
downgradeFrames(&frameList, &newFrames);
|
|
}
|
|
|
|
// Reserve a 10-byte blank space for an ID3v2 tag header.
|
|
|
|
ByteVector tagData(Header::size(), '\0');
|
|
|
|
// Loop through the frames rendering them and adding them to the tagData.
|
|
|
|
for(FrameList::ConstIterator it = frameList.begin(); it != frameList.end(); it++) {
|
|
(*it)->header()->setVersion(version == v3 ? 3 : 4);
|
|
if((*it)->header()->frameID().size() != 4) {
|
|
debug("An ID3v2 frame of unsupported or unknown type \'"
|
|
+ String((*it)->header()->frameID()) + "\' has been discarded");
|
|
continue;
|
|
}
|
|
if(!(*it)->header()->tagAlterPreservation()) {
|
|
const ByteVector frameData = (*it)->render();
|
|
if(frameData.size() == Frame::headerSize((*it)->header()->version())) {
|
|
debug("An empty ID3v2 frame \'"
|
|
+ String((*it)->header()->frameID()) + "\' has been discarded");
|
|
continue;
|
|
}
|
|
tagData.append(frameData);
|
|
}
|
|
}
|
|
|
|
// Compute the amount of padding, and append that to tagData.
|
|
|
|
long originalSize = d->header.tagSize();
|
|
long paddingSize = originalSize - (tagData.size() - Header::size());
|
|
|
|
if(paddingSize <= 0) {
|
|
paddingSize = MinPaddingSize;
|
|
}
|
|
else {
|
|
// Padding won't increase beyond 1% of the file size or 1MB.
|
|
|
|
long threshold = d->file ? d->file->length() / 100 : 0;
|
|
threshold = std::max(threshold, MinPaddingSize);
|
|
threshold = std::min(threshold, MaxPaddingSize);
|
|
|
|
if(paddingSize > threshold)
|
|
paddingSize = MinPaddingSize;
|
|
}
|
|
|
|
tagData.resize(static_cast<unsigned int>(tagData.size() + paddingSize), '\0');
|
|
|
|
// Set the version and data size.
|
|
d->header.setMajorVersion(version);
|
|
d->header.setTagSize(tagData.size() - Header::size());
|
|
|
|
// TODO: This should eventually include d->footer->render().
|
|
const ByteVector headerData = d->header.render();
|
|
std::copy(headerData.begin(), headerData.end(), tagData.begin());
|
|
|
|
return tagData;
|
|
}
|
|
|
|
Latin1StringHandler const *ID3v2::Tag::latin1StringHandler()
|
|
{
|
|
return stringHandler;
|
|
}
|
|
|
|
void ID3v2::Tag::setLatin1StringHandler(const Latin1StringHandler *handler)
|
|
{
|
|
if(handler)
|
|
stringHandler = handler;
|
|
else
|
|
stringHandler = &defaultStringHandler;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
// protected members
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void ID3v2::Tag::read()
|
|
{
|
|
if(!d->file)
|
|
return;
|
|
|
|
if(!d->file->isOpen())
|
|
return;
|
|
|
|
d->file->seek(d->tagOffset);
|
|
d->header.setData(d->file->readBlock(Header::size()));
|
|
|
|
// If the tag size is 0, then this is an invalid tag (tags must contain at
|
|
// least one frame)
|
|
|
|
if(d->header.tagSize() != 0)
|
|
parse(d->file->readBlock(d->header.tagSize()));
|
|
|
|
// Look for duplicate ID3v2 tags and treat them as an extra blank of this one.
|
|
// It leads to overwriting them with zero when saving the tag.
|
|
|
|
// This is a workaround for some faulty files that have duplicate ID3v2 tags.
|
|
// Unfortunately, TagLib itself may write such duplicate tags until v1.10.
|
|
|
|
unsigned int extraSize = 0;
|
|
|
|
while(true) {
|
|
|
|
d->file->seek(d->tagOffset + d->header.completeTagSize() + extraSize);
|
|
|
|
const ByteVector data = d->file->readBlock(Header::size());
|
|
if(data.size() < Header::size() || !data.startsWith(Header::fileIdentifier()))
|
|
break;
|
|
|
|
extraSize += Header(data).completeTagSize();
|
|
}
|
|
|
|
if(extraSize != 0) {
|
|
debug("ID3v2::Tag::read() - Duplicate ID3v2 tags found.");
|
|
d->header.setTagSize(d->header.tagSize() + extraSize);
|
|
}
|
|
}
|
|
|
|
void ID3v2::Tag::parse(const ByteVector &origData)
|
|
{
|
|
ByteVector data = origData;
|
|
|
|
if(d->header.unsynchronisation() && d->header.majorVersion() <= 3)
|
|
data = SynchData::decode(data);
|
|
|
|
unsigned int frameDataPosition = 0;
|
|
unsigned int frameDataLength = data.size();
|
|
|
|
// check for extended header
|
|
|
|
if(d->header.extendedHeader()) {
|
|
if(!d->extendedHeader)
|
|
d->extendedHeader = new ExtendedHeader();
|
|
d->extendedHeader->setData(data);
|
|
if(d->extendedHeader->size() <= data.size()) {
|
|
frameDataPosition += d->extendedHeader->size();
|
|
frameDataLength -= d->extendedHeader->size();
|
|
}
|
|
}
|
|
|
|
// check for footer -- we don't actually need to parse it, as it *must*
|
|
// contain the same data as the header, but we do need to account for its
|
|
// size.
|
|
|
|
if(d->header.footerPresent() && Footer::size() <= frameDataLength)
|
|
frameDataLength -= Footer::size();
|
|
|
|
// parse frames
|
|
|
|
// Make sure that there is at least enough room in the remaining frame data for
|
|
// a frame header.
|
|
|
|
while(frameDataPosition < frameDataLength - Frame::headerSize(d->header.majorVersion())) {
|
|
|
|
// If the next data is position is 0, assume that we've hit the padding
|
|
// portion of the frame data.
|
|
|
|
if(data.at(frameDataPosition) == 0) {
|
|
if(d->header.footerPresent()) {
|
|
debug("Padding *and* a footer found. This is not allowed by the spec.");
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
Frame *frame = d->factory->createFrame(data.mid(frameDataPosition),
|
|
&d->header);
|
|
|
|
if(!frame)
|
|
return;
|
|
|
|
// Checks to make sure that frame parsed correctly.
|
|
|
|
if(frame->size() <= 0) {
|
|
delete frame;
|
|
return;
|
|
}
|
|
|
|
frameDataPosition += frame->size() + Frame::headerSize(d->header.majorVersion());
|
|
addFrame(frame);
|
|
}
|
|
|
|
d->factory->rebuildAggregateFrames(this);
|
|
}
|
|
|
|
void ID3v2::Tag::setTextFrame(const ByteVector &id, const String &value)
|
|
{
|
|
if(value.isEmpty()) {
|
|
removeFrames(id);
|
|
return;
|
|
}
|
|
|
|
if(!d->frameListMap[id].isEmpty())
|
|
d->frameListMap[id].front()->setText(value);
|
|
else {
|
|
const String::Type encoding = d->factory->defaultTextEncoding();
|
|
TextIdentificationFrame *f = new TextIdentificationFrame(id, encoding);
|
|
addFrame(f);
|
|
f->setText(value);
|
|
}
|
|
}
|