<!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: src/frame.cpp 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>src/frame.cpp</h1><a href="frame_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// $Id: frame.cpp,v 1.35 2002/08/10 10:42:42 t1mpy Exp $</span> <a name="l00002"></a>00002 <a name="l00003"></a>00003 <span class="comment">// id3lib: a C++ library for creating and manipulating id3v1/v2 tags</span> <a name="l00004"></a>00004 <span class="comment">// Copyright 1999, 2000 Scott Thomas Haug</span> <a name="l00005"></a>00005 <span class="comment">// Copyright 2002 Thijmen Klok (thijmen@id3lib.org)</span> <a name="l00006"></a>00006 <a name="l00007"></a>00007 <span class="comment">// This library is free software; you can redistribute it and/or modify it</span> <a name="l00008"></a>00008 <span class="comment">// under the terms of the GNU Library General Public License as published by</span> <a name="l00009"></a>00009 <span class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</span> <a name="l00010"></a>00010 <span class="comment">// option) any later version.</span> <a name="l00011"></a>00011 <span class="comment">//</span> <a name="l00012"></a>00012 <span class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</span> <a name="l00013"></a>00013 <span class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span> <a name="l00014"></a>00014 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</span> <a name="l00015"></a>00015 <span class="comment">// License for more details.</span> <a name="l00016"></a>00016 <span class="comment">//</span> <a name="l00017"></a>00017 <span class="comment">// You should have received a copy of the GNU Library General Public License</span> <a name="l00018"></a>00018 <span class="comment">// along with this library; if not, write to the Free Software Foundation,</span> <a name="l00019"></a>00019 <span class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</span> <a name="l00022"></a>00022 <span class="comment">// the id3lib coordinator. Please see the README file for details on where to</span> <a name="l00023"></a>00023 <span class="comment">// send such submissions. See the AUTHORS file for a list of people who have</span> <a name="l00024"></a>00024 <span class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</span> <a name="l00025"></a>00025 <span class="comment">// id3lib. These files are distributed with id3lib at</span> <a name="l00026"></a>00026 <span class="comment">// http://download.sourceforge.net/id3lib/</span> <a name="l00027"></a>00027 <a name="l00028"></a>00028 <span class="preprocessor">#if defined HAVE_CONFIG_H</span> <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include <config.h></span> <a name="l00030"></a>00030 <span class="preprocessor">#endif</span> <a name="l00031"></a>00031 <span class="preprocessor"></span> <a name="l00032"></a>00032 <span class="comment">//#include "frame.h"</span> <a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="readers_8h.html">readers.h</a>"</span> <a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="frame__impl_8h.html">frame_impl.h</a>"</span> <a name="l00035"></a>00035 <a name="l00062"></a>00062 ID3_Frame::ID3_Frame(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> <span class="keywordtype">id</span>) <a name="l00063"></a>00063 : _impl(new <a class="code" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a>(id)) <a name="l00064"></a>00064 { <a name="l00065"></a>00065 } <a name="l00066"></a>00066 <a name="l00067"></a>00067 ID3_Frame::ID3_Frame(<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>& frame) <a name="l00068"></a>00068 : _impl(new <a class="code" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a>(frame)) <a name="l00069"></a>00069 { <a name="l00070"></a>00070 } <a name="l00071"></a>00071 <a name="l00072"></a>00072 ID3_Frame::~ID3_Frame() <a name="l00073"></a>00073 { <a name="l00074"></a>00074 <span class="keyword">delete</span> _impl; <a name="l00075"></a>00075 } <a name="l00076"></a>00076 <a name="l00082"></a>00082 <span class="keywordtype">void</span> ID3_Frame::Clear() <a name="l00083"></a>00083 { <a name="l00084"></a>00084 _impl->Clear(); <a name="l00085"></a>00085 } <a name="l00086"></a>00086 <a name="l00094"></a>00094 <a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> ID3_Frame::GetID()<span class="keyword"> const</span> <a name="l00095"></a>00095 <span class="keyword"></span>{ <a name="l00096"></a>00096 <span class="keywordflow">return</span> _impl->GetID(); <a name="l00097"></a>00097 } <a name="l00098"></a>00098 <a name="l00116"></a>00116 <span class="keywordtype">bool</span> ID3_Frame::SetID(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> <span class="keywordtype">id</span>) <a name="l00117"></a>00117 { <a name="l00118"></a>00118 <span class="keywordflow">return</span> _impl->SetID(<span class="keywordtype">id</span>); <a name="l00119"></a>00119 } <a name="l00120"></a>00120 <a name="l00121"></a>00121 <span class="keywordtype">bool</span> ID3_Frame::SetSpec(<a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> spec) <a name="l00122"></a>00122 { <a name="l00123"></a>00123 <span class="keywordflow">return</span> _impl->SetSpec(spec); <a name="l00124"></a>00124 } <a name="l00125"></a>00125 <a name="l00126"></a>00126 <a class="code" href="globals_8h.html#a48b13eb6cb3c520195901516dee1e612">ID3_V2Spec</a> ID3_Frame::GetSpec()<span class="keyword"> const</span> <a name="l00127"></a>00127 <span class="keyword"></span>{ <a name="l00128"></a>00128 <span class="keywordflow">return</span> _impl->GetSpec(); <a name="l00129"></a>00129 } <a name="l00130"></a>00130 <a name="l00142"></a>00142 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>& ID3_Frame::Field(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> fieldName)<span class="keyword"> const</span> <a name="l00143"></a>00143 <span class="keyword"></span>{ <a name="l00144"></a>00144 <span class="keywordflow">return</span> *this->GetField(fieldName); <a name="l00145"></a>00145 } <a name="l00146"></a>00146 <a name="l00147"></a>00147 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* ID3_Frame::GetField(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> fieldName)<span class="keyword"> const</span> <a name="l00148"></a>00148 <span class="keyword"></span>{ <a name="l00149"></a>00149 <span class="keywordflow">return</span> _impl->GetField(fieldName); <a name="l00150"></a>00150 } <a name="l00151"></a>00151 <a name="l00152"></a>00152 <span class="keywordtype">size_t</span> ID3_Frame::NumFields()<span class="keyword"> const</span> <a name="l00153"></a>00153 <span class="keyword"></span>{ <a name="l00154"></a>00154 <span class="keywordflow">return</span> _impl->NumFields(); <a name="l00155"></a>00155 } <a name="l00156"></a>00156 <a name="l00157"></a>00157 <span class="comment">/*</span> <a name="l00158"></a>00158 <span class="comment">ID3_Field* ID3_Frame::GetFieldNum(size_t index) const</span> <a name="l00159"></a>00159 <span class="comment">{</span> <a name="l00160"></a>00160 <span class="comment"> return _impl->GetFieldNum(index);</span> <a name="l00161"></a>00161 <span class="comment">}</span> <a name="l00162"></a>00162 <span class="comment">*/</span> <a name="l00163"></a>00163 <a name="l00164"></a>00164 <span class="keywordtype">size_t</span> ID3_Frame::Size() <a name="l00165"></a>00165 { <a name="l00166"></a>00166 <span class="keywordflow">return</span> _impl->Size(); <a name="l00167"></a>00167 } <a name="l00168"></a>00168 <a name="l00169"></a>00169 <a name="l00170"></a>00170 <span class="keywordtype">bool</span> ID3_Frame::HasChanged()<span class="keyword"> const</span> <a name="l00171"></a>00171 <span class="keyword"></span>{ <a name="l00172"></a>00172 <span class="keywordflow">return</span> _impl->HasChanged(); <a name="l00173"></a>00173 } <a name="l00174"></a>00174 <a name="l00175"></a>00175 <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>& ID3_Frame::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> &rFrame ) <a name="l00176"></a>00176 { <a name="l00177"></a>00177 <span class="keywordflow">if</span> (<span class="keyword">this</span> != &rFrame) <a name="l00178"></a>00178 { <a name="l00179"></a>00179 *_impl = rFrame; <a name="l00180"></a>00180 } <a name="l00181"></a>00181 <span class="keywordflow">return</span> *<span class="keyword">this</span>; <a name="l00182"></a>00182 } <a name="l00183"></a>00183 <a name="l00184"></a>00184 <span class="keyword">const</span> <span class="keywordtype">char</span>* ID3_Frame::GetDescription(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a> <span class="keywordtype">id</span>) <a name="l00185"></a>00185 { <a name="l00186"></a>00186 <span class="keywordflow">return</span> <a class="code" href="class_i_d3___frame_impl.html#a67eb21dda8f934b2698e58216cc8077e">ID3_FrameImpl::GetDescription</a>(<span class="keywordtype">id</span>); <a name="l00187"></a>00187 } <a name="l00188"></a>00188 <a name="l00189"></a>00189 <span class="keyword">const</span> <span class="keywordtype">char</span>* ID3_Frame::GetDescription()<span class="keyword"> const</span> <a name="l00190"></a>00190 <span class="keyword"></span>{ <a name="l00191"></a>00191 <span class="keywordflow">return</span> _impl->GetDescription(); <a name="l00192"></a>00192 } <a name="l00193"></a>00193 <a name="l00194"></a>00194 <span class="keyword">const</span> <span class="keywordtype">char</span>* ID3_Frame::GetTextID()<span class="keyword"> const</span> <a name="l00195"></a>00195 <span class="keyword"></span>{ <a name="l00196"></a>00196 <span class="keywordflow">return</span> _impl->GetTextID(); <a name="l00197"></a>00197 } <a name="l00198"></a>00198 <a name="l00199"></a>00199 <span class="keywordtype">bool</span> ID3_Frame::Parse(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>& reader) <a name="l00200"></a>00200 { <a name="l00201"></a>00201 <span class="keywordflow">return</span> _impl->Parse(reader); <a name="l00202"></a>00202 } <a name="l00203"></a>00203 <a name="l00204"></a>00204 <span class="keywordtype">void</span> ID3_Frame::Render(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>& writer)<span class="keyword"> const</span> <a name="l00205"></a>00205 <span class="keyword"></span>{ <a name="l00206"></a>00206 _impl->Render(writer); <a name="l00207"></a>00207 } <a name="l00208"></a>00208 <a name="l00209"></a>00209 <span class="keywordtype">bool</span> ID3_Frame::Contains(<a class="code" href="globals_8h.html#a23cab982426a968437cd731900cfeb2c" title="Enumeration of the different types of fields in a frame.">ID3_FieldID</a> <span class="keywordtype">id</span>)<span class="keyword"> const</span> <a name="l00210"></a>00210 <span class="keyword"></span>{ <a name="l00211"></a>00211 <span class="keywordflow">return</span> _impl->Contains(<span class="keywordtype">id</span>); <a name="l00212"></a>00212 } <a name="l00213"></a>00213 <a name="l00219"></a>00219 <span class="keywordtype">bool</span> ID3_Frame::SetCompression(<span class="keywordtype">bool</span> b) <a name="l00220"></a>00220 { <a name="l00221"></a>00221 <span class="keywordflow">return</span> _impl->SetCompression(b); <a name="l00222"></a>00222 } <a name="l00223"></a>00223 <a name="l00232"></a>00232 <span class="keywordtype">bool</span> ID3_Frame::GetCompression()<span class="keyword"> const</span> <a name="l00233"></a>00233 <span class="keyword"></span>{ <a name="l00234"></a>00234 <span class="keywordflow">return</span> _impl->GetCompression(); <a name="l00235"></a>00235 } <a name="l00236"></a>00236 <a name="l00237"></a>00237 <span class="keywordtype">size_t</span> ID3_Frame::GetDataSize()<span class="keyword"> const</span> <a name="l00238"></a>00238 <span class="keyword"></span>{ <a name="l00239"></a>00239 <span class="keywordflow">return</span> _impl->GetDataSize(); <a name="l00240"></a>00240 } <a name="l00241"></a>00241 <a name="l00242"></a>00242 <span class="keywordtype">bool</span> ID3_Frame::SetEncryptionID(<a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> <span class="keywordtype">id</span>) <a name="l00243"></a>00243 { <a name="l00244"></a>00244 <span class="keywordflow">return</span> _impl->SetEncryptionID(<span class="keywordtype">id</span>); <a name="l00245"></a>00245 } <a name="l00246"></a>00246 <a name="l00247"></a>00247 <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> ID3_Frame::GetEncryptionID()<span class="keyword"> const</span> <a name="l00248"></a>00248 <span class="keyword"></span>{ <a name="l00249"></a>00249 <span class="keywordflow">return</span> _impl->GetEncryptionID(); <a name="l00250"></a>00250 } <a name="l00251"></a>00251 <a name="l00252"></a>00252 <span class="keywordtype">bool</span> ID3_Frame::SetGroupingID(<a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> <span class="keywordtype">id</span>) <a name="l00253"></a>00253 { <a name="l00254"></a>00254 <span class="keywordflow">return</span> _impl->SetGroupingID(<span class="keywordtype">id</span>); <a name="l00255"></a>00255 } <a name="l00256"></a>00256 <a name="l00257"></a>00257 <a class="code" href="globals_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> ID3_Frame::GetGroupingID()<span class="keyword"> const</span> <a name="l00258"></a>00258 <span class="keyword"></span>{ <a name="l00259"></a>00259 <span class="keywordflow">return</span> _impl->GetGroupingID(); <a name="l00260"></a>00260 } <a name="l00261"></a>00261 <a name="l00262"></a>00262 <span class="keyword">namespace</span> <a name="l00263"></a>00263 { <a name="l00264"></a>00264 <span class="keyword">class </span>IteratorImpl : <span class="keyword">public</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>::Iterator <a name="l00265"></a>00265 { <a name="l00266"></a>00266 <a class="code" href="class_i_d3___frame_impl.html#a80495c05f7130edef63f8d8744c7b52e">ID3_FrameImpl::iterator</a> _cur; <a name="l00267"></a>00267 <a class="code" href="class_i_d3___frame_impl.html#a80495c05f7130edef63f8d8744c7b52e">ID3_FrameImpl::iterator</a> _end; <a name="l00268"></a>00268 <span class="keyword">public</span>: <a name="l00269"></a>00269 IteratorImpl(<a class="code" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a>& frame) <a name="l00270"></a>00270 : _cur(frame.begin()), _end(frame.end()) <a name="l00271"></a>00271 { <a name="l00272"></a>00272 } <a name="l00273"></a>00273 <a name="l00274"></a>00274 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* GetNext() <a name="l00275"></a>00275 { <a name="l00276"></a>00276 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* next = <a class="code" href="globals_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>; <a name="l00277"></a>00277 <span class="keywordflow">while</span> (next == <a class="code" href="globals_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> && _cur != _end) <a name="l00278"></a>00278 { <a name="l00279"></a>00279 next = *_cur; <a name="l00280"></a>00280 ++_cur; <a name="l00281"></a>00281 } <a name="l00282"></a>00282 <span class="keywordflow">return</span> next; <a name="l00283"></a>00283 } <a name="l00284"></a>00284 }; <a name="l00285"></a>00285 <a name="l00286"></a>00286 <a name="l00287"></a>00287 <span class="keyword">class </span>ConstIteratorImpl : <span class="keyword">public</span> <a class="code" href="class_i_d3___frame.html" title="The representative class of an id3v2 frame.">ID3_Frame</a>::ConstIterator <a name="l00288"></a>00288 { <a name="l00289"></a>00289 <a class="code" href="class_i_d3___frame_impl.html#adc61cf92dc24bb5cda53f141d28349a9">ID3_FrameImpl::const_iterator</a> _cur; <a name="l00290"></a>00290 <a class="code" href="class_i_d3___frame_impl.html#adc61cf92dc24bb5cda53f141d28349a9">ID3_FrameImpl::const_iterator</a> _end; <a name="l00291"></a>00291 <span class="keyword">public</span>: <a name="l00292"></a>00292 ConstIteratorImpl(<a class="code" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a>& frame) <a name="l00293"></a>00293 : _cur(frame.begin()), _end(frame.end()) <a name="l00294"></a>00294 { <a name="l00295"></a>00295 } <a name="l00296"></a>00296 <span class="keyword">const</span> <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* GetNext() <a name="l00297"></a>00297 { <a name="l00298"></a>00298 <a class="code" href="class_i_d3___field.html" title="The representative class of an ID3v2 field.">ID3_Field</a>* next = <a class="code" href="globals_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>; <a name="l00299"></a>00299 <span class="keywordflow">while</span> (next == <a class="code" href="globals_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a> && _cur != _end) <a name="l00300"></a>00300 { <a name="l00301"></a>00301 next = *_cur; <a name="l00302"></a>00302 ++_cur; <a name="l00303"></a>00303 } <a name="l00304"></a>00304 <span class="keywordflow">return</span> next; <a name="l00305"></a>00305 } <a name="l00306"></a>00306 }; <a name="l00307"></a>00307 } <a name="l00308"></a>00308 <a name="l00309"></a>00309 ID3_Frame::Iterator* <a name="l00310"></a>00310 ID3_Frame::CreateIterator() <a name="l00311"></a>00311 { <a name="l00312"></a>00312 <span class="keywordflow">return</span> <span class="keyword">new</span> IteratorImpl(*_impl); <a name="l00313"></a>00313 } <a name="l00314"></a>00314 <a name="l00315"></a>00315 ID3_Frame::ConstIterator* <a name="l00316"></a>00316 ID3_Frame::CreateIterator()<span class="keyword"> const</span> <a name="l00317"></a>00317 <span class="keyword"></span>{ <a name="l00318"></a>00318 <span class="keywordflow">return</span> <span class="keyword">new</span> ConstIteratorImpl(*_impl); <a name="l00319"></a>00319 } <a name="l00320"></a>00320 </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>