ref: 3192dd937a71f737af84273806d91b306526cece
dir: /common/id3lib/include/id3/field.h/
// $Id: field.h,v 1.1 2002/01/21 08:16:20 menno Exp $
// id3lib: a C++ library for creating and manipulating id3v1/v2 tags
// Copyright 1999, 2000 Scott Thomas Haug
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Library General Public License as published by
// the Free Software Foundation; either version 2 of the License, or (at your
// option) any later version.
//
// 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 Library General Public
// License for more details.
//
// You should have received a copy of the GNU Library General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
// The id3lib authors encourage improvements and optimisations to be sent to
// the id3lib coordinator. Please see the README file for details on where to
// send such submissions. See the AUTHORS file for a list of people who have
// contributed to id3lib. See the ChangeLog file for a list of changes to
// id3lib. These files are distributed with id3lib at
// http://download.sourceforge.net/id3lib/
#ifndef __ID3LIB_FIELD_H__
#define __ID3LIB_FIELD_H__
#include <stdlib.h>
#include "error.h"
struct ID3_FieldDef
{
ID3_FieldID eID;
ID3_FieldType eType;
size_t ulFixedLength;
ID3_V2Spec eSpecBegin;
ID3_V2Spec eSpecEnd;
flags_t ulFlags;
ID3_FieldID eLinkedField;
static const ID3_FieldDef* DEFAULT;
};
class ID3_Frame;
class ID3_Tag;
// Structure used for defining how frames are defined internally.
struct ID3_FrameDef
{
ID3_FrameID eID;
char sShortTextID[3 + 1];
char sLongTextID[4 + 1];
bool bTagDiscard;
bool bFileDiscard;
ID3_FieldDef *aeFieldDefs;
const char * sDescription;
};
/** The representative class of an id3v2 field.
**
** As a general rule, you need never create an object of this type. id3lib
** uses them internally as part of the id3_frame class. You must know how to
** interact with these objects, though, and that's what this section is about.
**
** The ID3_Field contains many overloaded methods to provide these facilities
** for four different data types: integers, ASCII strings, Unicode strings,
** and binary data.
**
** An integer field supports the Get(), Set(uint32), and operator=(uint32)
** methods.
**
** Both types of strings support the GetNumTextItems() method.
**
** An ASCII string field supports the Get(char*, size_t, index_t)),
** Set(const char*), Add(const char*), and operator=(const char*) methods.
**
** A Unicode field also supports Get(unicode_t*, size_t, index_t),
** Set(const unicode_t*), Add(const unicode_t*), and
** operator=(const unicode_t*). Without elaborating, the Unicode
** methods behave exactly the same as their ASCII counterparts, taking
** \c unicode_t pointers in place of \c char pointers.
**
** All strings in id3lib are handled internally as Unicode. This means that
** when you set a field with an ASCII source type, it will be converted and
** stored internally as a Unicode string. id3lib will handle all necessary
** conversions when parsing, rendering, and retrieving. If you set a field as
** an ASCII string, then try to read the string into a \c unicode_t buffer,
** id3lib will automatically convert the string into Unicode so this will
** function as expected. The same holds true in reverse. Of course, when
** converting from Unicode to ASCII, you will experience problems when the
** Unicode string contains characters that don't map to ISO-8859-1.
**
** A binary field supports the Get(uchar *, size_t), Set(const uchar*, size_t),
** FromFile(const char*), and ToFile(const char*) methods. The binary field
** holds miscellaneous data that can't easily be described any other way, such
** as a JPEG image.
**
** As a general implementation note, you should be prepared to support all
** fields in an id3lib frame, even if all fields in the id3lib version of the
** frame aren't present in the id3v2 version. This is because of frames like
** the picture frame, which changed slightly from one version of the id3v2
** standard to the next (the IMAGEFORMAT format in 2.0 changed to a MIMETYPE
** in 3.0). If you support all id3lib fields in a given frame, id3lib can
** generate the correct id3v2 frame for the id3v2 version you wish to support.
** Alternatively, just support the fields you know will be used in, say, 3.0
** if you only plan to generate 3.0 tags.
**
** @author Dirk Mahoney
** @version $Id: field.h,v 1.1 2002/01/21 08:16:20 menno Exp $
** \sa ID3_Tag
** \sa ID3_Frame
** \sa ID3_Err
**/
class ID3_Field
{
friend ID3_Frame;
friend ID3_Tag;
public:
~ID3_Field();
/** Clears any data and frees any memory associated with the field
**
** \sa ID3_Tag::Clear()
** \sa ID3_Frame::Clear()
**/
void Clear();
/** Returns the size of a field.
**
** The value returned is dependent on the type of the field. For ASCII
** strings, this returns the number of characters in the field, no including
** any NULL-terminator. The same holds true for Unicode---it returns the
** number of characters in the field, not bytes, and this does not include
** the Unicode BOM, which isn't put in a Unicode string obtained by the
** Get(unicode_t*, size_t, index_t) method anyway. For binary and
** integer fields, this returns the number of bytes in the field.
**
** \code
** size_t howBig = myFrame.Field(ID3FN_DATA).Size();
** \endcode
**
** \return The size of the field, either in bytes (for binary or integer
** fields) or characters (for strings).
**/
size_t Size() const;
/** Returns the number of items in a text list.
**
** \code
** size_t numItems = myFrame.Field(ID3FN_TEXT).GetNumItems();
** \endcode
**
** \return The number of items in a text list.
**/
size_t GetNumTextItems() const;
// integer field functions
/** A shortcut for the Set method.
**
** \code
** myFrame.Field(ID3FN_PICTURETYPE) = 0x0B;
** \endcode
**
** \param data The data to assign to this field
** \sa Set
**/
ID3_Field& operator= (uint32);
/** Sets the value of the field to the specified integer.
**
** \param data The data to assign to this field
**/
void Set(uint32);
/** Returns the value of the integer field.
**
** \code
** uint32 picType = myFrame.Field(ID3FN_PICTURETYPE).Get();
** \endcode
**
** \return The value of the integer field
**/
uint32 Get() const;
// ASCII string field functions
/** Shortcut for the Set operator.
**
** \param data The string to assign to this field
** \sa Set(uint32)
**/
ID3_Field& operator= (const char*);
/** Copies the supplied string to the field.
**
** You may dispose of the source string after a call to this method.
**
** \code
** myFrame.Field(ID3FN_TEXT).Set("ID3Lib is very cool!");
** \endcode
**/
void Set(const char*);
/** Copies the contents of the field into the supplied buffer, up to the
** number of characters specified; for fields with multiple entries, the
** optional third parameter indicates which of the fields to retrieve.
**
** The third parameter is useful when using text lists (see ID3_Field::Add
** for more details). The default value for this third parameter is 1,
** which returns the entire string if the field contains only one item.
**
** It returns the number of characters (not bytes necessarily, and not
** including any NULL terminator) of the supplied buffer that are now used.
**
** \code
** char myBuffer[1024];
** size_t charsUsed = myFrame.Field(ID3FN_TEXT).Get(buffer, 1024);
** \endcode
**
** It fills the buffer with as much data from the field as is present in the
** field, or as large as the buffer, whichever is smaller.
**
** \code
** char myBuffer[1024];
** size_t charsUsed = myFrame.Field(ID3FN_TEXT).Get(buffer, 1024, 3);
** \endcode
**
** This fills the buffer with up to the first 1024 characters from the third
** element of the text list.
**
** \sa ID3_Field::Add
**/
size_t Get(char *buffer, ///< Where to copy the data
size_t, ///< Maximum number of characters to copy
index_t = 1 ///< The item number to retrieve
) const;
/** For fields which support this feature, adds a string to the list of
** strings currently in the field.
**
** This is useful for using id3v2 frames such as the involved people list,
** composer, and part of set. You can use the GetNumItems() method to find
** out how many such items are in a list.
**
** \code
** myFrame.Field(ID3FN_TEXT).Add("this is a test");
** \endcode
**
** \param string The string to add to the field
**/
void Add(const char*);
// Unicode string field functions
/** Shortcut for the Set operator.
**
** Peforms similarly as the ASCII assignment operator, taking a unicode_t
** string as a parameter rather than an ascii string.
**
** \sa Add(const char*)
** \param string The string to assign to the field
**/
ID3_Field &operator= (const unicode_t*);
/** Copies the supplied unicode string to the field.
**
** Peforms similarly as the ASCII <a href="#Set">Set</a> method, taking a
** unicode_t string as a parameter rather than an ascii string.
**
** \param string The unicode string to set this field to.
** \sa #Add
**/
void Set(const unicode_t *);
/** Copies the contents of the field into the supplied buffer, up to the
** number of characters specified; for fields with multiple entries, the
** optional third parameter indicates which of the fields to retrieve.
**
** Peforms similarly as the ASCII <a href="#Get">Get</a> method, taking a
** unicode_t string as a parameter rather than an ascii string. The
** maxChars parameter still represents the maximum number of characters, not
** bytes.
**
** \code
** unicode_t myBuffer[1024];
** size_t charsUsed = myFrame.Field(ID3FN_TEXT).Get(buffer, 1024);
** \endcode
**
** \param buffer Where the field's data is copied to
** \param maxChars The maximum number of characters to copy to the buffer.
** \param itemNum For fields with multiple items (such as the involved
** people frame, the item number to retrieve.
** \sa #Get
**/
size_t Get(unicode_t *buffer, size_t, index_t = 1) const;
/** For fields which support this feature, adds a string to the list of
** strings currently in the field.
**
** Peforms similarly as the ASCII <a href="#Add">Add</a> method, taking a
** unicode_t string as a parameter rather than an ascii string.
**/
void Add(const unicode_t *string);
// binary field functions
/** Copies the supplied unicode string to the field.
**
** Again, like the string types, the binary <a href="#Set">Set</a> function
** copies the data so you may dispose of the source data after a call to
** this method.
**
** \param newData The data to assign to this field.
** \param newSize The number of bytes to be copied from the data array.
**/
void Set(const uchar *newData, size_t newSize);
/** Copies the field's internal string to the buffer.
**
** It copies the data in the field into the buffer, for as many bytes as the
** field contains, or the size of buffer, whichever is smaller.
**
** \code
** uchar buffer[1024];
** myFrame.Field(ID3FN_DATA).Get(buffer, sizeof(buffer));
** \endcode
**
** \param buffer Where to copy the contents of the field.
** \param length The number of bytes in the buffer
**/
void Get(uchar *buffer, size_t length) const;
/** Copies binary data from the file specified to the field.
**
** \code
** myFrame.Field(ID3FN_DATA).FromFile("mypic.jpg");
** \endcode
**
** \param info The name of the file to read the data from.
**/
void FromFile(const char *info);
/** Copies binary data from the field to the specified file.
**
** \code
** myFrame.Field(ID3FN_DATA).ToFile("output.bin");
** \endcode
**
** \param info The name of the file to write the data to.
**/
void ToFile(const char *sInfo) const;
ID3_Field& operator=( const ID3_Field & );
const uchar* GetBinary() const { return __data; }
bool InScope(ID3_V2Spec spec) const
{ return __spec_begin <= spec && spec <= __spec_end; }
ID3_FieldID GetID() const { return __id; }
ID3_FieldType GetType() const { return __type; }
bool SetEncoding(ID3_TextEnc enc);
ID3_TextEnc GetEncoding() const { return __enc; }
bool IsEncodable() const { return (__flags & ID3FF_ENCODABLE) > 0; }
private:
size_t BinSize(bool withExtras = true) const;
bool HasChanged();
//void SetSpec(ID3_V2Spec);
size_t Render(uchar *buffer) const;
size_t Parse(const uchar *buffer, size_t buffSize);
private:
// To prevent public instantiation, the constructor is made private
ID3_Field();
ID3_FieldID __id; // the ID of this field
ID3_FieldType __type; // what type is this field or should be
size_t __length; // length of field (fixed if positive)
ID3_V2Spec __spec_begin; // spec end
ID3_V2Spec __spec_end; // spec begin
flags_t __flags; // special field flags
mutable bool __changed; // field changed since last parse/render?
uchar *__data;
size_t __size;
ID3_TextEnc __enc; // encoding
protected:
size_t RenderInteger(uchar *buffer) const;
size_t RenderASCIIString(uchar *buffer) const;
size_t RenderUnicodeString(uchar *buffer) const;
size_t RenderBinary(uchar *buffer) const;
size_t ParseInteger(const uchar *buffer, size_t);
size_t ParseASCIIString(const uchar *buffer, size_t);
size_t ParseUnicodeString(const uchar *buffer, size_t);
size_t ParseBinary(const uchar *buffer, size_t);
};
// Ack! Not for public use
ID3_FrameDef *ID3_FindFrameDef(const ID3_FrameID id);
ID3_FrameID ID3_FindFrameID(const char *id);
#endif /* __ID3LIB_FIELD_H__ */