Clementine-audio-player-Mac.../3rdparty/taglib/fileref.cpp

492 lines
16 KiB
C++
Raw Permalink Normal View History

2012-10-28 02:12:18 +02:00
/***************************************************************************
copyright : (C) 2002 - 2008 by Scott Wheeler
email : wheeler@kde.org
copyright : (C) 2010 by Alex Novichkov
email : novichko@atnet.ru
(added APE file support)
***************************************************************************/
/***************************************************************************
* 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 <tfile.h>
2018-06-06 22:47:08 +02:00
#include <tfilestream.h>
2012-10-28 02:12:18 +02:00
#include <tstring.h>
#include <tdebug.h>
2016-07-19 16:58:52 +02:00
#include <trefcounter.h>
2012-10-28 02:12:18 +02:00
#include "fileref.h"
#include "asffile.h"
#include "mpegfile.h"
#include "vorbisfile.h"
#include "flacfile.h"
#include "oggflacfile.h"
#include "mpcfile.h"
#include "mp4file.h"
#include "wavpackfile.h"
#include "speexfile.h"
#include "opusfile.h"
2012-10-28 02:12:18 +02:00
#include "trueaudiofile.h"
#include "aifffile.h"
#include "wavfile.h"
#include "apefile.h"
#include "modfile.h"
#include "s3mfile.h"
#include "itfile.h"
#include "xmfile.h"
2019-11-14 00:33:13 +01:00
#include "dsffile.h"
#include "dsdifffile.h"
2012-10-28 02:12:18 +02:00
using namespace TagLib;
2016-07-19 16:58:52 +02:00
namespace
{
typedef List<const FileRef::FileTypeResolver *> ResolverList;
ResolverList fileTypeResolvers;
2018-06-06 22:47:08 +02:00
// Detect the file type by user-defined resolvers.
2016-07-19 16:58:52 +02:00
2018-06-06 22:47:08 +02:00
File *detectByResolvers(FileName fileName, bool readAudioProperties,
AudioProperties::ReadStyle audioPropertiesStyle)
2016-07-19 16:58:52 +02:00
{
2018-06-06 22:47:08 +02:00
ResolverList::ConstIterator it = fileTypeResolvers.begin();
for(; it != fileTypeResolvers.end(); ++it) {
File *file = (*it)->createFile(fileName, readAudioProperties, audioPropertiesStyle);
if(file)
return file;
}
2016-07-19 16:58:52 +02:00
2018-06-06 22:47:08 +02:00
return 0;
2016-07-19 16:58:52 +02:00
}
2018-06-06 22:47:08 +02:00
// Detect the file type based on the file extension.
2016-07-19 16:58:52 +02:00
2018-06-06 22:47:08 +02:00
File* detectByExtension(IOStream *stream, bool readAudioProperties,
AudioProperties::ReadStyle audioPropertiesStyle)
2016-07-19 16:58:52 +02:00
{
2018-06-06 22:47:08 +02:00
#ifdef _WIN32
const String s = stream->name().toString();
#else
const String s(stream->name());
#endif
String ext;
const int pos = s.rfind(".");
if(pos != -1)
ext = s.substr(pos + 1).upper();
// If this list is updated, the method defaultFileExtensions() should also be
// updated. However at some point that list should be created at the same time
// that a default file type resolver is created.
if(ext.isEmpty())
return 0;
// .oga can be any audio in the Ogg container. So leave it to content-based detection.
if(ext == "MP3")
return new MPEG::File(stream, ID3v2::FrameFactory::instance(), readAudioProperties, audioPropertiesStyle);
if(ext == "OGG")
return new Ogg::Vorbis::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "FLAC")
return new FLAC::File(stream, ID3v2::FrameFactory::instance(), readAudioProperties, audioPropertiesStyle);
if(ext == "MPC")
return new MPC::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "WV")
return new WavPack::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "SPX")
return new Ogg::Speex::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "OPUS")
return new Ogg::Opus::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "TTA")
return new TrueAudio::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "M4A" || ext == "M4R" || ext == "M4B" || ext == "M4P" || ext == "MP4" || ext == "3G2" || ext == "M4V")
return new MP4::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "WMA" || ext == "ASF")
return new ASF::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "AIF" || ext == "AIFF" || ext == "AFC" || ext == "AIFC")
return new RIFF::AIFF::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "WAV")
return new RIFF::WAV::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "APE")
return new APE::File(stream, readAudioProperties, audioPropertiesStyle);
// module, nst and wow are possible but uncommon extensions
if(ext == "MOD" || ext == "MODULE" || ext == "NST" || ext == "WOW")
return new Mod::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "S3M")
return new S3M::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "IT")
return new IT::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "XM")
return new XM::File(stream, readAudioProperties, audioPropertiesStyle);
2019-11-14 00:33:13 +01:00
if(ext == "DFF" || ext == "DSDIFF")
return new DSDIFF::File(stream, readAudioProperties, audioPropertiesStyle);
if(ext == "DSF")
return new DSF::File(stream, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
return 0;
}
2018-06-06 22:47:08 +02:00
// Detect the file type based on the actual content of the stream.
File *detectByContent(IOStream *stream, bool readAudioProperties,
AudioProperties::ReadStyle audioPropertiesStyle)
2016-07-19 16:58:52 +02:00
{
2018-06-06 22:47:08 +02:00
File *file = 0;
if(MPEG::File::isSupported(stream))
file = new MPEG::File(stream, ID3v2::FrameFactory::instance(), readAudioProperties, audioPropertiesStyle);
else if(Ogg::Vorbis::File::isSupported(stream))
file = new Ogg::Vorbis::File(stream, readAudioProperties, audioPropertiesStyle);
else if(Ogg::FLAC::File::isSupported(stream))
file = new Ogg::FLAC::File(stream, readAudioProperties, audioPropertiesStyle);
else if(FLAC::File::isSupported(stream))
file = new FLAC::File(stream, ID3v2::FrameFactory::instance(), readAudioProperties, audioPropertiesStyle);
else if(MPC::File::isSupported(stream))
file = new MPC::File(stream, readAudioProperties, audioPropertiesStyle);
else if(WavPack::File::isSupported(stream))
file = new WavPack::File(stream, readAudioProperties, audioPropertiesStyle);
else if(Ogg::Speex::File::isSupported(stream))
file = new Ogg::Speex::File(stream, readAudioProperties, audioPropertiesStyle);
else if(Ogg::Opus::File::isSupported(stream))
file = new Ogg::Opus::File(stream, readAudioProperties, audioPropertiesStyle);
else if(TrueAudio::File::isSupported(stream))
file = new TrueAudio::File(stream, readAudioProperties, audioPropertiesStyle);
else if(MP4::File::isSupported(stream))
file = new MP4::File(stream, readAudioProperties, audioPropertiesStyle);
else if(ASF::File::isSupported(stream))
file = new ASF::File(stream, readAudioProperties, audioPropertiesStyle);
else if(RIFF::AIFF::File::isSupported(stream))
file = new RIFF::AIFF::File(stream, readAudioProperties, audioPropertiesStyle);
else if(RIFF::WAV::File::isSupported(stream))
file = new RIFF::WAV::File(stream, readAudioProperties, audioPropertiesStyle);
else if(APE::File::isSupported(stream))
file = new APE::File(stream, readAudioProperties, audioPropertiesStyle);
2019-11-14 00:33:13 +01:00
else if(DSDIFF::File::isSupported(stream))
file = new DSDIFF::File(stream, readAudioProperties, audioPropertiesStyle);
else if(DSF::File::isSupported(stream))
file = new DSF::File(stream, readAudioProperties, audioPropertiesStyle);
2018-06-06 22:47:08 +02:00
// isSupported() only does a quick check, so double check the file here.
if(file) {
if(file->isValid())
2016-07-19 16:58:52 +02:00
return file;
2018-06-06 22:47:08 +02:00
else
delete file;
2016-07-19 16:58:52 +02:00
}
return 0;
}
2018-06-06 22:47:08 +02:00
// Internal function that supports FileRef::create().
// This looks redundant, but necessary in order not to change the previous
// behavior of FileRef::create().
File* createInternal(FileName fileName, bool readAudioProperties,
2016-07-19 16:58:52 +02:00
AudioProperties::ReadStyle audioPropertiesStyle)
{
2018-06-06 22:47:08 +02:00
File *file = detectByResolvers(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(file)
return file;
#ifdef _WIN32
2018-06-06 22:47:08 +02:00
const String s = fileName.toString();
2016-07-19 16:58:52 +02:00
#else
2018-06-06 22:47:08 +02:00
const String s(fileName);
2016-07-19 16:58:52 +02:00
#endif
String ext;
const int pos = s.rfind(".");
if(pos != -1)
ext = s.substr(pos + 1).upper();
if(ext.isEmpty())
return 0;
if(ext == "MP3")
2018-06-06 22:47:08 +02:00
return new MPEG::File(fileName, ID3v2::FrameFactory::instance(), readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "OGG")
2018-06-06 22:47:08 +02:00
return new Ogg::Vorbis::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "OGA") {
/* .oga can be any audio in the Ogg container. First try FLAC, then Vorbis. */
2018-06-06 22:47:08 +02:00
File *file = new Ogg::FLAC::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(file->isValid())
return file;
delete file;
2018-06-06 22:47:08 +02:00
return new Ogg::Vorbis::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
}
if(ext == "FLAC")
2018-06-06 22:47:08 +02:00
return new FLAC::File(fileName, ID3v2::FrameFactory::instance(), readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "MPC")
2018-06-06 22:47:08 +02:00
return new MPC::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "WV")
2018-06-06 22:47:08 +02:00
return new WavPack::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "SPX")
2018-06-06 22:47:08 +02:00
return new Ogg::Speex::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "OPUS")
2018-06-06 22:47:08 +02:00
return new Ogg::Opus::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "TTA")
2018-06-06 22:47:08 +02:00
return new TrueAudio::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "M4A" || ext == "M4R" || ext == "M4B" || ext == "M4P" || ext == "MP4" || ext == "3G2" || ext == "M4V")
2018-06-06 22:47:08 +02:00
return new MP4::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "WMA" || ext == "ASF")
2018-06-06 22:47:08 +02:00
return new ASF::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "AIF" || ext == "AIFF" || ext == "AFC" || ext == "AIFC")
2018-06-06 22:47:08 +02:00
return new RIFF::AIFF::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "WAV")
2018-06-06 22:47:08 +02:00
return new RIFF::WAV::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "APE")
2018-06-06 22:47:08 +02:00
return new APE::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
// module, nst and wow are possible but uncommon extensions
if(ext == "MOD" || ext == "MODULE" || ext == "NST" || ext == "WOW")
2018-06-06 22:47:08 +02:00
return new Mod::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "S3M")
2018-06-06 22:47:08 +02:00
return new S3M::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "IT")
2018-06-06 22:47:08 +02:00
return new IT::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
if(ext == "XM")
2018-06-06 22:47:08 +02:00
return new XM::File(fileName, readAudioProperties, audioPropertiesStyle);
2019-11-14 00:33:13 +01:00
if(ext == "DFF" || ext == "DSDIFF")
return new DSDIFF::File(fileName, readAudioProperties, audioPropertiesStyle);
if(ext == "DSF")
return new DSF::File(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
return 0;
}
}
2012-10-28 02:12:18 +02:00
class FileRef::FileRefPrivate : public RefCounter
{
public:
2018-06-06 22:47:08 +02:00
FileRefPrivate() :
2016-07-19 16:58:52 +02:00
RefCounter(),
2018-06-06 22:47:08 +02:00
file(0),
stream(0) {}
2016-07-19 16:58:52 +02:00
2012-10-28 02:12:18 +02:00
~FileRefPrivate() {
delete file;
2018-06-06 22:47:08 +02:00
delete stream;
2012-10-28 02:12:18 +02:00
}
2018-06-06 22:47:08 +02:00
File *file;
IOStream *stream;
2012-10-28 02:12:18 +02:00
};
////////////////////////////////////////////////////////////////////////////////
// public members
////////////////////////////////////////////////////////////////////////////////
2016-07-19 16:58:52 +02:00
FileRef::FileRef() :
2018-06-06 22:47:08 +02:00
d(new FileRefPrivate())
2012-10-28 02:12:18 +02:00
{
}
FileRef::FileRef(FileName fileName, bool readAudioProperties,
2016-07-19 16:58:52 +02:00
AudioProperties::ReadStyle audioPropertiesStyle) :
2018-06-06 22:47:08 +02:00
d(new FileRefPrivate())
2016-07-19 16:58:52 +02:00
{
2018-06-06 22:47:08 +02:00
parse(fileName, readAudioProperties, audioPropertiesStyle);
2016-07-19 16:58:52 +02:00
}
FileRef::FileRef(IOStream* stream, bool readAudioProperties, AudioProperties::ReadStyle audioPropertiesStyle) :
2018-06-06 22:47:08 +02:00
d(new FileRefPrivate())
2012-10-28 02:12:18 +02:00
{
2018-06-06 22:47:08 +02:00
parse(stream, readAudioProperties, audioPropertiesStyle);
2012-10-28 02:12:18 +02:00
}
2016-07-19 16:58:52 +02:00
FileRef::FileRef(File *file) :
2018-06-06 22:47:08 +02:00
d(new FileRefPrivate())
2012-10-28 02:12:18 +02:00
{
2018-06-06 22:47:08 +02:00
d->file = file;
2012-10-28 02:12:18 +02:00
}
2016-07-19 16:58:52 +02:00
FileRef::FileRef(const FileRef &ref) :
d(ref.d)
2012-10-28 02:12:18 +02:00
{
d->ref();
}
FileRef::~FileRef()
{
if(d->deref())
delete d;
}
Tag *FileRef::tag() const
{
if(isNull()) {
debug("FileRef::tag() - Called without a valid file.");
return 0;
}
return d->file->tag();
}
AudioProperties *FileRef::audioProperties() const
{
if(isNull()) {
debug("FileRef::audioProperties() - Called without a valid file.");
return 0;
}
return d->file->audioProperties();
}
File *FileRef::file() const
{
return d->file;
}
bool FileRef::save()
{
if(isNull()) {
debug("FileRef::save() - Called without a valid file.");
return false;
}
return d->file->save();
}
const FileRef::FileTypeResolver *FileRef::addFileTypeResolver(const FileRef::FileTypeResolver *resolver) // static
{
2016-07-19 16:58:52 +02:00
fileTypeResolvers.prepend(resolver);
2012-10-28 02:12:18 +02:00
return resolver;
}
StringList FileRef::defaultFileExtensions()
{
StringList l;
l.append("ogg");
l.append("flac");
l.append("oga");
l.append("mp3");
l.append("mpc");
l.append("wv");
l.append("spx");
l.append("tta");
l.append("m4a");
l.append("m4r");
l.append("m4b");
l.append("m4p");
l.append("3g2");
l.append("mp4");
2016-07-19 16:58:52 +02:00
l.append("m4v");
2012-10-28 02:12:18 +02:00
l.append("wma");
l.append("asf");
l.append("aif");
l.append("aiff");
l.append("wav");
l.append("ape");
l.append("mod");
l.append("module"); // alias for "mod"
l.append("nst"); // alias for "mod"
l.append("wow"); // alias for "mod"
l.append("s3m");
l.append("it");
l.append("xm");
2019-11-14 00:33:13 +01:00
l.append("dsf");
l.append("dff");
l.append("dsdiff"); // alias for "dff"
2012-10-28 02:12:18 +02:00
return l;
}
bool FileRef::isNull() const
{
2016-07-19 16:58:52 +02:00
return (!d->file || !d->file->isValid());
2012-10-28 02:12:18 +02:00
}
FileRef &FileRef::operator=(const FileRef &ref)
{
2016-07-19 16:58:52 +02:00
FileRef(ref).swap(*this);
return *this;
}
2012-10-28 02:12:18 +02:00
2016-07-19 16:58:52 +02:00
void FileRef::swap(FileRef &ref)
{
using std::swap;
2012-10-28 02:12:18 +02:00
2016-07-19 16:58:52 +02:00
swap(d, ref.d);
2012-10-28 02:12:18 +02:00
}
bool FileRef::operator==(const FileRef &ref) const
{
2016-07-19 16:58:52 +02:00
return (ref.d->file == d->file);
2012-10-28 02:12:18 +02:00
}
bool FileRef::operator!=(const FileRef &ref) const
{
2016-07-19 16:58:52 +02:00
return (ref.d->file != d->file);
2012-10-28 02:12:18 +02:00
}
File *FileRef::create(FileName fileName, bool readAudioProperties,
AudioProperties::ReadStyle audioPropertiesStyle) // static
{
2016-07-19 16:58:52 +02:00
return createInternal(fileName, readAudioProperties, audioPropertiesStyle);
2012-10-28 02:12:18 +02:00
}
2018-06-06 22:47:08 +02:00
////////////////////////////////////////////////////////////////////////////////
// private members
////////////////////////////////////////////////////////////////////////////////
void FileRef::parse(FileName fileName, bool readAudioProperties,
AudioProperties::ReadStyle audioPropertiesStyle)
{
// Try user-defined resolvers.
d->file = detectByResolvers(fileName, readAudioProperties, audioPropertiesStyle);
if(d->file)
return;
// Try to resolve file types based on the file extension.
d->stream = new FileStream(fileName);
d->file = detectByExtension(d->stream, readAudioProperties, audioPropertiesStyle);
if(d->file)
return;
// At last, try to resolve file types based on the actual content.
d->file = detectByContent(d->stream, readAudioProperties, audioPropertiesStyle);
if(d->file)
return;
// Stream have to be closed here if failed to resolve file types.
delete d->stream;
d->stream = 0;
}
void FileRef::parse(IOStream *stream, bool readAudioProperties,
AudioProperties::ReadStyle audioPropertiesStyle)
{
// User-defined resolvers won't work with a stream.
// Try to resolve file types based on the file extension.
d->file = detectByExtension(stream, readAudioProperties, audioPropertiesStyle);
if(d->file)
return;
// At last, try to resolve file types based on the actual content of the file.
d->file = detectByContent(stream, readAudioProperties, audioPropertiesStyle);
}