You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
179 lines
6.2 KiB
179 lines
6.2 KiB
/***************************************************************************
|
|
copyright : (C) 2006 by Lukáš Lalinský
|
|
email : lalinsky@gmail.com
|
|
|
|
copyright : (C) 2004 by Allan Sandfeld Jensen
|
|
email : kde@carewolf.org
|
|
(original MPC implementation)
|
|
***************************************************************************/
|
|
|
|
/***************************************************************************
|
|
* 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 *
|
|
***************************************************************************/
|
|
|
|
#ifndef TAGLIB_TTAFILE_H
|
|
#define TAGLIB_TTAFILE_H
|
|
|
|
#include "tfile.h"
|
|
|
|
#include "ttaproperties.h"
|
|
|
|
namespace TagLib {
|
|
|
|
class Tag;
|
|
|
|
namespace ID3v2 { class Tag; class FrameFactory; }
|
|
namespace ID3v1 { class Tag; }
|
|
|
|
//! An implementation of TTA metadata
|
|
|
|
/*!
|
|
* This is implementation of TTA metadata.
|
|
*
|
|
* This supports ID3v1 and ID3v2 tags as well as reading stream
|
|
* properties from the file.
|
|
*/
|
|
|
|
namespace TTA {
|
|
|
|
//! An implementation of TagLib::File with TTA specific methods
|
|
|
|
/*!
|
|
* This implements and provides an interface for TTA files to the
|
|
* TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing
|
|
* the abstract TagLib::File API as well as providing some additional
|
|
* information specific to TTA files.
|
|
*/
|
|
|
|
class File : public TagLib::File
|
|
{
|
|
public:
|
|
/*!
|
|
* This set of flags is used for various operations and is suitable for
|
|
* being OR-ed together.
|
|
*/
|
|
enum TagTypes {
|
|
//! Empty set. Matches no tag types.
|
|
NoTags = 0x0000,
|
|
//! Matches ID3v1 tags.
|
|
ID3v1 = 0x0001,
|
|
//! Matches ID3v2 tags.
|
|
ID3v2 = 0x0002,
|
|
//! Matches all tag types.
|
|
AllTags = 0xffff
|
|
};
|
|
|
|
/*!
|
|
* Contructs an MPC file from \a file. If \a readProperties is true the
|
|
* file's audio properties will also be read using \a propertiesStyle. If
|
|
* false, \a propertiesStyle is ignored.
|
|
*/
|
|
File(const char *file, bool readProperties = true,
|
|
Properties::ReadStyle propertiesStyle = Properties::Average);
|
|
|
|
/*!
|
|
* Contructs an MPC file from \a file. If \a readProperties is true the
|
|
* file's audio properties will also be read using \a propertiesStyle. If
|
|
* false, \a propertiesStyle is ignored. The frames will be created using
|
|
* \a frameFactory.
|
|
*/
|
|
File(const char *file, ID3v2::FrameFactory *frameFactory,
|
|
bool readProperties = true,
|
|
Properties::ReadStyle propertiesStyle = Properties::Average);
|
|
|
|
/*!
|
|
* Destroys this instance of the File.
|
|
*/
|
|
virtual ~File();
|
|
|
|
/*!
|
|
* Returns the Tag for this file. This will be an APE tag, an ID3v1 tag
|
|
* or a combination of the two.
|
|
*/
|
|
virtual TagLib::Tag *tag() const;
|
|
|
|
/*!
|
|
* Returns the MPC::Properties for this file. If no audio properties
|
|
* were read then this will return a null pointer.
|
|
*/
|
|
virtual Properties *audioProperties() const;
|
|
|
|
/*!
|
|
* Set the ID3v2::FrameFactory to something other than the default.
|
|
*
|
|
* \see ID3v2FrameFactory
|
|
*/
|
|
void setID3v2FrameFactory(const ID3v2::FrameFactory *factory);
|
|
|
|
/*!
|
|
* Saves the file.
|
|
*/
|
|
virtual bool save();
|
|
|
|
/*!
|
|
* Returns a pointer to the ID3v2 tag of the file.
|
|
*
|
|
* If \a create is false (the default) this will return a null pointer
|
|
* if there is no valid ID3v2 tag. If \a create is true it will create
|
|
* an ID3v1 tag if one does not exist. If there is already an APE tag, the
|
|
* new ID3v1 tag will be placed after it.
|
|
*
|
|
* \note The Tag <b>is still</b> owned by the TTA::File and should not be
|
|
* deleted by the user. It will be deleted when the file (object) is
|
|
* destroyed.
|
|
*/
|
|
ID3v1::Tag *ID3v1Tag(bool create = false);
|
|
|
|
/*!
|
|
* Returns a pointer to the ID3v1 tag of the file.
|
|
*
|
|
* If \a create is false (the default) this will return a null pointer
|
|
* if there is no valid ID3v1 tag. If \a create is true it will create
|
|
* an ID3v1 tag if one does not exist. If there is already an APE tag, the
|
|
* new ID3v1 tag will be placed after it.
|
|
*
|
|
* \note The Tag <b>is still</b> owned by the TTA::File and should not be
|
|
* deleted by the user. It will be deleted when the file (object) is
|
|
* destroyed.
|
|
*/
|
|
ID3v2::Tag *ID3v2Tag(bool create = false);
|
|
|
|
/*!
|
|
* This will remove the tags that match the OR-ed together TagTypes from the
|
|
* file. By default it removes all tags.
|
|
*
|
|
* \note This will also invalidate pointers to the tags
|
|
* as their memory will be freed.
|
|
* \note In order to make the removal permanent save() still needs to be called
|
|
*/
|
|
void remove(int tags = AllTags);
|
|
|
|
private:
|
|
File(const File &);
|
|
File &operator=(const File &);
|
|
|
|
void read(bool readProperties, Properties::ReadStyle propertiesStyle);
|
|
void scan();
|
|
long findID3v1();
|
|
long findID3v2();
|
|
|
|
class FilePrivate;
|
|
FilePrivate *d;
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif
|