2012-10-28 02:12:18 +02:00
|
|
|
/***************************************************************************
|
|
|
|
copyright : (C) 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/ *
|
|
|
|
***************************************************************************/
|
|
|
|
|
|
|
|
#ifndef TAGLIB_WAVFILE_H
|
|
|
|
#define TAGLIB_WAVFILE_H
|
|
|
|
|
|
|
|
#include "rifffile.h"
|
|
|
|
#include "id3v2tag.h"
|
2013-08-18 04:39:33 +02:00
|
|
|
#include "infotag.h"
|
2012-10-28 02:12:18 +02:00
|
|
|
#include "wavproperties.h"
|
|
|
|
|
|
|
|
namespace TagLib {
|
|
|
|
|
|
|
|
namespace RIFF {
|
|
|
|
|
|
|
|
//! An implementation of WAV metadata
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* This is implementation of WAV metadata.
|
|
|
|
*
|
|
|
|
* This supports an ID3v2 tag as well as reading stream from the ID3 RIFF
|
|
|
|
* chunk as well as properties from the file.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace WAV {
|
|
|
|
|
|
|
|
//! An implementation of TagLib::File with WAV specific methods
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* This implements and provides an interface for WAV 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 WAV files.
|
|
|
|
*/
|
|
|
|
|
|
|
|
class TAGLIB_EXPORT File : public TagLib::RIFF::File
|
|
|
|
{
|
|
|
|
public:
|
2013-08-18 04:39:33 +02:00
|
|
|
enum TagTypes {
|
|
|
|
//! Empty set. Matches no tag types.
|
|
|
|
NoTags = 0x0000,
|
|
|
|
//! Matches ID3v2 tags.
|
|
|
|
ID3v2 = 0x0001,
|
2015-11-24 19:36:24 +01:00
|
|
|
//! Matches INFO tags.
|
2013-08-18 04:39:33 +02:00
|
|
|
Info = 0x0002,
|
|
|
|
//! Matches all tag types.
|
|
|
|
AllTags = 0xffff
|
|
|
|
};
|
|
|
|
|
2012-10-28 02:12:18 +02:00
|
|
|
/*!
|
2013-08-18 04:39:33 +02:00
|
|
|
* Constructs a WAV file from \a file. If \a readProperties is true the
|
|
|
|
* file's audio properties will also be read.
|
|
|
|
*
|
|
|
|
* \note In the current implementation, \a propertiesStyle is ignored.
|
2012-10-28 02:12:18 +02:00
|
|
|
*/
|
|
|
|
File(FileName file, bool readProperties = true,
|
|
|
|
Properties::ReadStyle propertiesStyle = Properties::Average);
|
|
|
|
|
|
|
|
/*!
|
2013-08-18 04:39:33 +02:00
|
|
|
* Constructs a WAV file from \a stream. If \a readProperties is true the
|
|
|
|
* file's audio properties will also be read.
|
2012-10-28 02:12:18 +02:00
|
|
|
*
|
|
|
|
* \note TagLib will *not* take ownership of the stream, the caller is
|
|
|
|
* responsible for deleting it after the File object.
|
2013-08-18 04:39:33 +02:00
|
|
|
*
|
|
|
|
* \note In the current implementation, \a propertiesStyle is ignored.
|
2012-10-28 02:12:18 +02:00
|
|
|
*/
|
|
|
|
File(IOStream *stream, bool readProperties = true,
|
|
|
|
Properties::ReadStyle propertiesStyle = Properties::Average);
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Destroys this instance of the File.
|
|
|
|
*/
|
|
|
|
virtual ~File();
|
|
|
|
|
|
|
|
/*!
|
2013-08-18 04:39:33 +02:00
|
|
|
* Returns the ID3v2 Tag for this file.
|
2015-11-24 19:36:24 +01:00
|
|
|
*
|
|
|
|
* \note This method does not return all the tags for this file for
|
2013-08-18 04:39:33 +02:00
|
|
|
* backward compatibility. Will be fixed in TagLib 2.0.
|
|
|
|
*/
|
|
|
|
ID3v2::Tag *tag() const;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Returns the ID3v2 Tag for this file.
|
|
|
|
*
|
2015-11-24 19:36:24 +01:00
|
|
|
* \note This always returns a valid pointer regardless of whether or not
|
|
|
|
* the file on disk has an ID3v2 tag. Use hasID3v2Tag() to check if the
|
2013-08-18 04:39:33 +02:00
|
|
|
* file on disk actually has an ID3v2 tag.
|
|
|
|
*
|
|
|
|
* \see hasID3v2Tag()
|
|
|
|
*/
|
|
|
|
ID3v2::Tag *ID3v2Tag() const;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Returns the RIFF INFO Tag for this file.
|
|
|
|
*
|
2015-11-24 19:36:24 +01:00
|
|
|
* \note This always returns a valid pointer regardless of whether or not
|
|
|
|
* the file on disk has a RIFF INFO tag. Use hasInfoTag() to check if the
|
2013-08-18 04:39:33 +02:00
|
|
|
* file on disk actually has a RIFF INFO tag.
|
|
|
|
*
|
|
|
|
* \see hasInfoTag()
|
2012-10-28 02:12:18 +02:00
|
|
|
*/
|
2013-08-18 04:39:33 +02:00
|
|
|
Info::Tag *InfoTag() const;
|
2012-10-28 02:12:18 +02:00
|
|
|
|
2016-07-19 16:58:52 +02:00
|
|
|
/*!
|
|
|
|
* This will strip the tags that match the OR-ed together TagTypes from the
|
|
|
|
* file. By default it strips all tags. It returns true if the tags are
|
|
|
|
* successfully stripped.
|
|
|
|
*
|
|
|
|
* \note This will update the file immediately.
|
|
|
|
*/
|
|
|
|
void strip(TagTypes tags = AllTags);
|
|
|
|
|
2012-10-28 02:12:18 +02:00
|
|
|
/*!
|
|
|
|
* Implements the unified property interface -- export function.
|
|
|
|
* This method forwards to ID3v2::Tag::properties().
|
|
|
|
*/
|
|
|
|
PropertyMap properties() const;
|
|
|
|
|
2013-08-18 04:39:33 +02:00
|
|
|
void removeUnsupportedProperties(const StringList &properties);
|
|
|
|
|
2012-10-28 02:12:18 +02:00
|
|
|
/*!
|
|
|
|
* Implements the unified property interface -- import function.
|
|
|
|
* This method forwards to ID3v2::Tag::setProperties().
|
|
|
|
*/
|
|
|
|
PropertyMap setProperties(const PropertyMap &);
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Returns the WAV::Properties for this file. If no audio properties
|
|
|
|
* were read then this will return a null pointer.
|
|
|
|
*/
|
|
|
|
virtual Properties *audioProperties() const;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Saves the file.
|
|
|
|
*/
|
|
|
|
virtual bool save();
|
|
|
|
|
2013-08-18 04:39:33 +02:00
|
|
|
bool save(TagTypes tags, bool stripOthers = true, int id3v2Version = 4);
|
2015-11-24 19:36:24 +01:00
|
|
|
|
2013-08-18 04:39:33 +02:00
|
|
|
/*!
|
|
|
|
* Returns whether or not the file on disk actually has an ID3v2 tag.
|
|
|
|
*
|
|
|
|
* \see ID3v2Tag()
|
|
|
|
*/
|
|
|
|
bool hasID3v2Tag() const;
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Returns whether or not the file on disk actually has a RIFF INFO tag.
|
|
|
|
*
|
|
|
|
* \see InfoTag()
|
|
|
|
*/
|
|
|
|
bool hasInfoTag() const;
|
|
|
|
|
2018-06-06 22:47:08 +02:00
|
|
|
/*!
|
|
|
|
* Returns whether or not the given \a stream can be opened as a WAV
|
|
|
|
* file.
|
|
|
|
*
|
|
|
|
* \note This method is designed to do a quick check. The result may
|
|
|
|
* not necessarily be correct.
|
|
|
|
*/
|
|
|
|
static bool isSupported(IOStream *stream);
|
|
|
|
|
2012-10-28 02:12:18 +02:00
|
|
|
private:
|
|
|
|
File(const File &);
|
|
|
|
File &operator=(const File &);
|
|
|
|
|
2015-11-24 19:36:24 +01:00
|
|
|
void read(bool readProperties);
|
2016-07-19 16:58:52 +02:00
|
|
|
void removeTagChunks(TagTypes tags);
|
2013-08-18 04:39:33 +02:00
|
|
|
|
2015-11-24 19:36:24 +01:00
|
|
|
friend class Properties;
|
|
|
|
|
2012-10-28 02:12:18 +02:00
|
|
|
class FilePrivate;
|
|
|
|
FilePrivate *d;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|