227 lines
6.6 KiB
C++
227 lines
6.6 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/ *
|
|
***************************************************************************/
|
|
|
|
#ifndef TAGLIB_ATTACHEDPICTUREFRAME_H
|
|
#define TAGLIB_ATTACHEDPICTUREFRAME_H
|
|
|
|
#include "id3v2frame.h"
|
|
#include "id3v2header.h"
|
|
#include "taglib_export.h"
|
|
|
|
namespace Strawberry_TagLib {
|
|
namespace TagLib {
|
|
namespace ID3v2 {
|
|
|
|
//! An ID3v2 attached picture frame implementation
|
|
|
|
/*!
|
|
* This is an implementation of ID3v2 attached pictures.
|
|
* Pictures may be included in tags, one per APIC frame (but there may be multiple APIC frames in a single tag).
|
|
* These pictures are usually in either JPEG or PNG format.
|
|
*/
|
|
|
|
class TAGLIB_EXPORT AttachedPictureFrame : public Frame {
|
|
friend class FrameFactory;
|
|
|
|
public:
|
|
/*!
|
|
* This describes the function or content of the picture.
|
|
*/
|
|
enum Type {
|
|
//! A type not enumerated below
|
|
Other = 0x00,
|
|
//! 32x32 PNG image that should be used as the file icon
|
|
FileIcon = 0x01,
|
|
//! File icon of a different size or format
|
|
OtherFileIcon = 0x02,
|
|
//! Front cover image of the album
|
|
FrontCover = 0x03,
|
|
//! Back cover image of the album
|
|
BackCover = 0x04,
|
|
//! Inside leaflet page of the album
|
|
LeafletPage = 0x05,
|
|
//! Image from the album itself
|
|
Media = 0x06,
|
|
//! Picture of the lead artist or soloist
|
|
LeadArtist = 0x07,
|
|
//! Picture of the artist or performer
|
|
Artist = 0x08,
|
|
//! Picture of the conductor
|
|
Conductor = 0x09,
|
|
//! Picture of the band or orchestra
|
|
Band = 0x0A,
|
|
//! Picture of the composer
|
|
Composer = 0x0B,
|
|
//! Picture of the lyricist or text writer
|
|
Lyricist = 0x0C,
|
|
//! Picture of the recording location or studio
|
|
RecordingLocation = 0x0D,
|
|
//! Picture of the artists during recording
|
|
DuringRecording = 0x0E,
|
|
//! Picture of the artists during performance
|
|
DuringPerformance = 0x0F,
|
|
//! Picture from a movie or video related to the track
|
|
MovieScreenCapture = 0x10,
|
|
//! Picture of a large, coloured fish
|
|
ColouredFish = 0x11,
|
|
//! Illustration related to the track
|
|
Illustration = 0x12,
|
|
//! Logo of the band or performer
|
|
BandLogo = 0x13,
|
|
//! Logo of the publisher (record company)
|
|
PublisherLogo = 0x14
|
|
};
|
|
|
|
/*!
|
|
* Constructs an empty picture frame.
|
|
* The description, content and text encoding should be set manually.
|
|
*/
|
|
explicit AttachedPictureFrame();
|
|
|
|
/*!
|
|
* Constructs an AttachedPicture frame based on \a data.
|
|
*/
|
|
explicit AttachedPictureFrame(const ByteVector &data);
|
|
|
|
/*!
|
|
* Destroys the AttahcedPictureFrame instance.
|
|
*/
|
|
~AttachedPictureFrame() override;
|
|
|
|
/*!
|
|
* Returns a string containing the description and mime-type
|
|
*/
|
|
String toString() const override;
|
|
|
|
/*!
|
|
* Returns the text encoding used for the description.
|
|
*
|
|
* \see setTextEncoding()
|
|
* \see description()
|
|
*/
|
|
String::Type textEncoding() const;
|
|
|
|
/*!
|
|
* Set the text encoding used for the description.
|
|
*
|
|
* \see description()
|
|
*/
|
|
void setTextEncoding(String::Type t);
|
|
|
|
/*!
|
|
* Returns the mime type of the image.
|
|
* This should in most cases be "image/png" or "image/jpeg".
|
|
*/
|
|
String mimeType() const;
|
|
|
|
/*!
|
|
* Sets the mime type of the image.
|
|
* This should in most cases be "image/png" or "image/jpeg".
|
|
*/
|
|
void setMimeType(const String &m);
|
|
|
|
/*!
|
|
* Returns the type of the image.
|
|
*
|
|
* \see Type
|
|
* \see setType()
|
|
*/
|
|
Type type() const;
|
|
|
|
/*!
|
|
* Sets the type for the image.
|
|
*
|
|
* \see Type
|
|
* \see type()
|
|
*/
|
|
void setType(Type t);
|
|
|
|
/*!
|
|
* Returns a text description of the image.
|
|
*
|
|
* \see setDescription()
|
|
* \see textEncoding()
|
|
* \see setTextEncoding()
|
|
*/
|
|
|
|
String description() const;
|
|
|
|
/*!
|
|
* Sets a textual description of the image to \a desc.
|
|
*
|
|
* \see description()
|
|
* \see textEncoding()
|
|
* \see setTextEncoding()
|
|
*/
|
|
|
|
void setDescription(const String &desc);
|
|
|
|
/*!
|
|
* Returns the image data as a ByteVector.
|
|
*
|
|
* \note ByteVector has a data() method that returns a const char * which should make it easy to export this data to external programs.
|
|
*
|
|
* \see setPicture()
|
|
* \see mimeType()
|
|
*/
|
|
ByteVector picture() const;
|
|
|
|
/*!
|
|
* Sets the image data to \a p. \a p should be of the type specified in this frame's mime-type specification.
|
|
*
|
|
* \see picture()
|
|
* \see mimeType()
|
|
* \see setMimeType()
|
|
*/
|
|
void setPicture(const ByteVector &p);
|
|
|
|
protected:
|
|
void parseFields(const ByteVector &data) override;
|
|
ByteVector renderFields() const override;
|
|
class AttachedPictureFramePrivate;
|
|
AttachedPictureFramePrivate *d;
|
|
|
|
private:
|
|
AttachedPictureFrame(const AttachedPictureFrame&);
|
|
AttachedPictureFrame &operator=(const AttachedPictureFrame&);
|
|
explicit AttachedPictureFrame(const ByteVector &data, Header *h);
|
|
};
|
|
|
|
//! support for ID3v2.2 PIC frames
|
|
class TAGLIB_EXPORT AttachedPictureFrameV22 : public AttachedPictureFrame {
|
|
protected:
|
|
void parseFields(const ByteVector &data) override;
|
|
|
|
private:
|
|
explicit AttachedPictureFrameV22(const ByteVector &data, Header *h);
|
|
friend class FrameFactory;
|
|
};
|
|
|
|
} // namespace ID3v2
|
|
} // namespace TagLib
|
|
} // namespace Strawberry_TagLib
|
|
|
|
#endif
|