<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>id3lib: include/id3/tag.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="id3lib.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>include/id3/tag.h</h1><a href="tag_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- C++ -*-</span>
<a name="l00002"></a>00002 <span class="comment">// $Id: tag.h,v 1.63 2003/03/02 13:35:59 t1mpy Exp $</span>
<a name="l00003"></a>00003
<a name="l00004"></a>00004 <span class="comment">// id3lib: a software library for creating and manipulating id3v1/v2 tags</span>
<a name="l00005"></a>00005 <span class="comment">// Copyright 1999, 2000 Scott Thomas Haug</span>
<a name="l00006"></a>00006 <span class="comment">// Copyright 2002 Thijmen Klok (thijmen@id3lib.org)</span>
<a name="l00007"></a>00007
<a name="l00008"></a>00008 <span class="comment">// This library is free software; you can redistribute it and/or modify it</span>
<a name="l00009"></a>00009 <span class="comment">// under the terms of the GNU Library General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</span>
<a name="l00011"></a>00011 <span class="comment">// option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00014"></a>00014 <span class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00015"></a>00015 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">// License for more details.</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// You should have received a copy of the GNU Library General Public License</span>
<a name="l00019"></a>00019 <span class="comment">// along with this library; if not, write to the Free Software Foundation,</span>
<a name="l00020"></a>00020 <span class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</span>
<a name="l00023"></a>00023 <span class="comment">// the id3lib coordinator. Please see the README file for details on where to</span>
<a name="l00024"></a>00024 <span class="comment">// send such submissions. See the AUTHORS file for a list of people who have</span>
<a name="l00025"></a>00025 <span class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</span>
<a name="l00026"></a>00026 <span class="comment">// id3lib. These files are distributed with id3lib at</span>
<a name="l00027"></a>00027 <span class="comment">// http://download.sourceforge.net/id3lib/</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef _ID3LIB_TAG_H_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define _ID3LIB_TAG_H_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <id3/id3lib_frame.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="field_8h.html">id3/field.h</a>></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <id3/utils.h></span><span class="comment">//for ID3_PATH_LENGTH</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="class_i_d3___reader.html">ID3_Reader</a>;
<a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="class_i_d3___writer.html">ID3_Writer</a>;
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>;
<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>;
<a name="l00040"></a>00040
<a name="l00041"></a><a class="code" href="class_i_d3___tag.html">00041</a> <span class="keyword">class </span><a class="code" href="globals_8h.html#aa7668e1ebc5c8b89aef71dd98e547f77">ID3_CPP_EXPORT</a> <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <a class="code" href="class_i_d3___tag_impl.html">ID3_TagImpl</a>* _impl;
<a name="l00044"></a>00044 <span class="keywordtype">char</span> _tmp_filename[ID3_PATH_LENGTH];
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046
<a name="l00047"></a><a class="code" href="class_i_d3___tag_1_1_iterator.html">00047</a> <span class="keyword">class </span><a class="code" href="class_i_d3___tag_1_1_iterator.html">Iterator</a>
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <span class="keyword">virtual</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* GetNext() = 0;
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="class_i_d3___tag_1_1_const_iterator.html">00053</a> <span class="keyword">class </span><a class="code" href="class_i_d3___tag_1_1_const_iterator.html">ConstIterator</a>
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* GetNext() = 0;
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">public</span>:
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name = <a class="code" href="globals_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>);
<a name="l00062"></a>00062 <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>(<span class="keyword">const</span> <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a> &tag);
<a name="l00063"></a>00063 <span class="keyword">virtual</span> ~<a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>();
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">void</span> Clear();
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> HasChanged() <span class="keyword">const</span>;
<a name="l00067"></a>00067 <span class="keywordtype">size_t</span> Size() <span class="keyword">const</span>;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">bool</span> SetUnsync(<span class="keywordtype">bool</span>);
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> SetExtendedHeader(<span class="keywordtype">bool</span>);
<a name="l00071"></a>00071 <span class="keywordtype">bool</span> SetExperimental(<span class="keywordtype">bool</span>);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> GetUnsync() <span class="keyword">const</span>;
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> GetExtendedHeader() <span class="keyword">const</span>;
<a name="l00075"></a>00075 <span class="keywordtype">bool</span> GetExperimental() <span class="keyword">const</span>;
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">bool</span> SetPadding(<span class="keywordtype">bool</span>);
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keywordtype">void</span> AddFrame(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>&);
<a name="l00080"></a>00080 <span class="keywordtype">void</span> AddFrame(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>*);
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> AttachFrame(<a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>*);
<a name="l00082"></a>00082 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* RemoveFrame(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a> *);
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordtype">size_t</span> Parse(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>*, <span class="keywordtype">size_t</span>);
<a name="l00085"></a>00085 <span class="keywordtype">bool</span> Parse(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>& reader);
<a name="l00086"></a>00086 <span class="keywordtype">size_t</span> Render(<a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>*, <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348" title="The various types of tags that id3lib can handle.">ID3_TagType</a> = <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348a4ff91179fcf70ae9d26c87d7a34bd42a" title="Represents an id3v2 tag.">ID3TT_ID3V2</a>) <span class="keyword">const</span>;
<a name="l00087"></a>00087 <span class="keywordtype">size_t</span> Render(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>&, <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348" title="The various types of tags that id3lib can handle.">ID3_TagType</a> = <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348a4ff91179fcf70ae9d26c87d7a34bd42a" title="Represents an id3v2 tag.">ID3TT_ID3V2</a>) <span class="keyword">const</span>;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keywordtype">size_t</span> Link(<span class="keyword">const</span> <span class="keywordtype">char</span> *fileInfo, <a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> = (<a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a>) <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348af63e5cee4d160eb5bef2b0f4e18c4481" title="Represents all possible types of tags.">ID3TT_ALL</a>);
<a name="l00090"></a>00090 <span class="keywordtype">size_t</span> Link(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a> &reader, <a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> = (<a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a>) <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348af63e5cee4d160eb5bef2b0f4e18c4481" title="Represents all possible types of tags.">ID3TT_ALL</a>);
<a name="l00091"></a>00091 <a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> Update(<a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> = (<a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a>) <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348af63e5cee4d160eb5bef2b0f4e18c4481" title="Represents all possible types of tags.">ID3TT_ALL</a>);
<a name="l00092"></a>00092 <a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> Strip(<a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> = (<a class="code" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a>) <a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348af63e5cee4d160eb5bef2b0f4e18c4481" title="Represents all possible types of tags.">ID3TT_ALL</a>);
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keywordtype">size_t</span> GetPrependedBytes() <span class="keyword">const</span>;
<a name="l00095"></a>00095 <span class="keywordtype">size_t</span> GetAppendedBytes() <span class="keyword">const</span>;
<a name="l00096"></a>00096 <span class="keywordtype">size_t</span> GetFileSize() <span class="keyword">const</span>;
<a name="l00097"></a>00097 <span class="keyword">const</span> <span class="keywordtype">char</span>* GetFileName() <span class="keyword">const</span>;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* Find(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>) <span class="keyword">const</span>;
<a name="l00100"></a>00100 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* Find(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>, <a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a>, uint32) <span class="keyword">const</span>;
<a name="l00101"></a>00101 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* Find(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>, <a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>*) <span class="keyword">const</span>;
<a name="l00102"></a>00102 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* Find(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>, <a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a>, <span class="keyword">const</span> <a class="code" href="globals_8h.html#a781c2cce7ea2af8192d5f83427044add">unicode_t</a>*) <span class="keyword">const</span>;
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keywordtype">size_t</span> NumFrames() <span class="keyword">const</span>;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">const</span> <a class="code" href="struct_mp3___headerinfo.html">Mp3_Headerinfo</a>* GetMp3HeaderInfo() <span class="keyword">const</span>;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <a class="code" href="class_i_d3___tag_1_1_iterator.html">Iterator</a>* CreateIterator();
<a name="l00109"></a>00109 <a class="code" href="class_i_d3___tag_1_1_const_iterator.html">ConstIterator</a>* CreateIterator() <span class="keyword">const</span>;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>& operator=( <span class="keyword">const</span> <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a> & );
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordtype">bool</span> HasTagType(<a class="code" href="globals_8h.html#a2d783dffbb1bb13e23080984b277b348" title="The various types of tags that id3lib can handle.">ID3_TagType</a> tt) <span class="keyword">const</span>;
<a name="l00114"></a>00114 <a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> GetSpec() <span class="keyword">const</span>;
<a name="l00115"></a>00115 <span class="keywordtype">bool</span> SetSpec(<a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a>);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">static</span> <span class="keywordtype">size_t</span> IsV2Tag(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>*);
<a name="l00118"></a>00118 <span class="keyword">static</span> <span class="keywordtype">size_t</span> IsV2Tag(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&);
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">/* Deprecated! */</span>
<a name="l00121"></a>00121 <span class="keywordtype">void</span> AddNewFrame(<a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>* f);
<a name="l00122"></a>00122 <span class="keywordtype">size_t</span> Link(<span class="keyword">const</span> <span class="keywordtype">char</span> *fileInfo, <span class="keywordtype">bool</span> parseID3v1, <span class="keywordtype">bool</span> parseLyrics3);
<a name="l00123"></a>00123 <span class="keywordtype">void</span> SetCompression(<span class="keywordtype">bool</span>);
<a name="l00124"></a>00124 <span class="keywordtype">void</span> AddFrames(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a> *, <span class="keywordtype">size_t</span>);
<a name="l00125"></a>00125 <span class="keywordtype">bool</span> HasLyrics() <span class="keyword">const</span>;
<a name="l00126"></a>00126 <span class="keywordtype">bool</span> HasV2Tag() <span class="keyword">const</span>;
<a name="l00127"></a>00127 <span class="keywordtype">bool</span> HasV1Tag() <span class="keyword">const</span>;
<a name="l00128"></a>00128 <span class="keywordtype">size_t</span> Parse(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> header[<a class="code" href="globals_8h.html#ab868d84472615bfe3b84411ae816334a">ID3_TAGHEADERSIZE</a>], <span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> *buffer);
<a name="l00129"></a>00129 <span class="comment">//ID3_Frame* operator[](size_t) const;</span>
<a name="l00130"></a>00130 <span class="comment">//ID3_Frame* GetFrameNum(size_t) const;</span>
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>& operator<<(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a> &);
<a name="l00133"></a>00133 <a class="code" href="class_i_d3___tag.html" title="The representative class of an id3 tag.">ID3_Tag</a>& operator<<(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a> *);
<a name="l00134"></a>00134 };
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="comment">// deprecated!</span>
<a name="l00137"></a>00137 int32 <a class="code" href="globals_8h.html#a4300c4c2ac79b2857458dcd2e9c108f4" title="This file defines common macros, types, constants, and enums used throughout id3lib...">ID3_C_EXPORT</a> <a class="code" href="tag_8cpp.html#ab6d324d77a1d4aef5eca866d7efce5a1">ID3_IsTagHeader</a>(<span class="keyword">const</span> <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> header[<a class="code" href="globals_8h.html#ab868d84472615bfe3b84411ae816334a">ID3_TAGHEADERSIZE</a>]);
<a name="l00138"></a>00138
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="preprocessor">#endif </span><span class="comment">/* _ID3LIB_TAG_H_ */</span>
<a name="l00141"></a>00141
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Jan 12 23:46:35 2011 for id3lib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mageia
>
1
>
i586
>
media
>
core-release
>
by-pkgid
>
1b812d1b0e765bcc0430721ff58676d2
>
files
>
302
