<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>id3lib: src/header_frame.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="id3lib.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">id3lib  <span id="projectnumber">3.8.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">header_frame.h</div> </div> </div><!--header--> <div class="contents"> <a href="header__frame_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- C++ -*-</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// $Id: header_frame.h,v 1.2 2002/07/05 12:31:15 t1mpy Exp $</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// id3lib: a C++ library for creating and manipulating id3v1/v2 tags</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Copyright 1999, 2000 Scott Thomas Haug</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This library is free software; you can redistribute it and/or modify it</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// under the terms of the GNU Library General Public License as published by</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// option) any later version.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// License for more details.</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">//</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// You should have received a copy of the GNU Library General Public License</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// along with this library; if not, write to the Free Software Foundation,</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// the id3lib coordinator. Please see the README file for details on where to</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// send such submissions. See the AUTHORS file for a list of people who have</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// id3lib. These files are distributed with id3lib at</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// http://download.sourceforge.net/id3lib/</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef _ID3LIB_HEADER_FRAME_H_</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="preprocessor">#define _ID3LIB_HEADER_FRAME_H_</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="header_8h.html">header.h</a>"</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="field_8h.html">field.h</a>"</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">struct </span><a class="code" href="struct_i_d3___frame_def.html">ID3_FrameDef</a>;</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="class_i_d3___frame_header.html">ID3_FrameHeader</a> : <span class="keyword">public</span> <a class="code" href="class_i_d3___header.html">ID3_Header</a></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">enum</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div> <div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ab19f4a1a07dbffc3341a10ec86ef75da"> 42</a></span>  <a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ab19f4a1a07dbffc3341a10ec86ef75da">TAGALTER</a> = 1 << 15,</div> <div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ae311d4f477c7bb5f470e6623e7b1a523"> 43</a></span>  <a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ae311d4f477c7bb5f470e6623e7b1a523">FILEALTER</a> = 1 << 14,</div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a194e61c438997f2d0fe91694d9198556"> 44</a></span>  <a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a194e61c438997f2d0fe91694d9198556">READONLY</a> = 1 << 13,</div> <div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a73e372da50a03ec0bdcee0af600dc063"> 45</a></span>  <a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a73e372da50a03ec0bdcee0af600dc063">COMPRESSION</a> = 1 << 7,</div> <div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ac46b8df431748bd99c1038d401902109"> 46</a></span>  <a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ac46b8df431748bd99c1038d401902109">ENCRYPTION</a> = 1 << 6,</div> <div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a148e86e8d9dd323545c97ca80bbe5141"> 47</a></span>  <a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a148e86e8d9dd323545c97ca80bbe5141">GROUPING</a> = 1 << 5</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  };</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#a901d72670fc3fdab034bf5cbc7d7ef99"> 50</a></span>  <a class="code" href="class_i_d3___frame_header.html#a901d72670fc3fdab034bf5cbc7d7ef99">ID3_FrameHeader</a>() : _frame_def(<a class="code" href="globals_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>), _dyn_frame_def(false) { ; }</div> <div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#a32a38dc0f55397f409c725ac43d0c446"> 51</a></span>  <span class="keyword">virtual</span> <a class="code" href="class_i_d3___frame_header.html#a32a38dc0f55397f409c725ac43d0c446">~ID3_FrameHeader</a>() { this-><a class="code" href="class_i_d3___frame_header.html#a4a59ba0534c0f5c76bdf707f1ce6dea1">Clear</a>(); }</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">/* */</span> <span class="keywordtype">size_t</span> <a class="code" href="class_i_d3___frame_header.html#a60f80f634d7af97a8f7497a4ec7f2ac8">Size</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">/* */</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#ad7390aa97bca331159c72aac61bd36f8">Parse</a>(<a class="code" href="class_i_d3___reader.html">ID3_Reader</a>&);</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">/* */</span> <span class="keywordtype">void</span> <a class="code" href="class_i_d3___frame_header.html#ae15d17fff119357add7efa812f6e08f6">Render</a>(<a class="code" href="class_i_d3___writer.html">ID3_Writer</a>&) <span class="keyword">const</span>;</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">/* */</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#a89ec0d7950b719b7ddd5a83044f002fa">SetFrameID</a>(<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>);</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">/* */</span> <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="class_i_d3___frame_header.html#aa5067d517830abcf1ca6bfe27eca8bee">GetFrameID</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_i_d3___frame_header.html#af536921b0d4f7d7b0f709d6a7f3c7f9e">GetTextID</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <a class="code" href="struct_i_d3___frame_def.html">ID3_FrameDef</a>* <a class="code" href="class_i_d3___frame_header.html#ab6dade0d9c9538849501beb55e48a5d6">GetFrameDef</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">/* */</span> <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#a4a59ba0534c0f5c76bdf707f1ce6dea1">Clear</a>();</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="class_i_d3___frame_header.html">ID3_FrameHeader</a>& <a class="code" href="class_i_d3___frame_header.html#ab16b55a34bfbaf523a3460afb9109be3">operator=</a>(<span class="keyword">const</span> <a class="code" href="class_i_d3___frame_header.html">ID3_FrameHeader</a>&);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#ab4231b74a46663d7ae992aa1b10bb405"> 63</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#ab4231b74a46663d7ae992aa1b10bb405">SetCompression</a>(<span class="keywordtype">bool</span> b) { <span class="keywordflow">return</span> this-><a class="code" href="class_i_d3___frame_header.html#aebe582e726e9d7b2e04a55f66d47a2b6">SetFlags</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a73e372da50a03ec0bdcee0af600dc063">COMPRESSION</a>, b); }</div> <div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#a70c2a2939dac7a9897b45d6407f91ca3"> 64</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#a70c2a2939dac7a9897b45d6407f91ca3">SetEncryption</a>(<span class="keywordtype">bool</span> b) { <span class="keywordflow">return</span> this-><a class="code" href="class_i_d3___frame_header.html#aebe582e726e9d7b2e04a55f66d47a2b6">SetFlags</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ac46b8df431748bd99c1038d401902109">ENCRYPTION</a>, b); }</div> <div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#ae4a1868fbefaaaf8456315c5c7a34cc2"> 65</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#ae4a1868fbefaaaf8456315c5c7a34cc2">SetGrouping</a>(<span class="keywordtype">bool</span> b) { <span class="keywordflow">return</span> this-><a class="code" href="class_i_d3___frame_header.html#aebe582e726e9d7b2e04a55f66d47a2b6">SetFlags</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a148e86e8d9dd323545c97ca80bbe5141">GROUPING</a>, b); }</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> <div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aef256ecfd63ac9aed0a4c85a0b6fd003"> 67</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#aef256ecfd63ac9aed0a4c85a0b6fd003">GetCompression</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_i_d3___header.html#af566de5a6ab82c06c60a8a339efd99cb">_flags</a>.<a class="code" href="class_i_d3___flags.html#a8619935f1b6dc6bbb9806be12fc3eac5">test</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a73e372da50a03ec0bdcee0af600dc063">COMPRESSION</a>); }</div> <div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#adc722dfdf29e6c19fb170c8bad011463"> 68</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#adc722dfdf29e6c19fb170c8bad011463">GetEncryption</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_i_d3___header.html#af566de5a6ab82c06c60a8a339efd99cb">_flags</a>.<a class="code" href="class_i_d3___flags.html#a8619935f1b6dc6bbb9806be12fc3eac5">test</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175ac46b8df431748bd99c1038d401902109">ENCRYPTION</a>); }</div> <div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#ace80a9ca6fd851658dd344f7b2028bb0"> 69</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#ace80a9ca6fd851658dd344f7b2028bb0">GetGrouping</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_i_d3___header.html#af566de5a6ab82c06c60a8a339efd99cb">_flags</a>.<a class="code" href="class_i_d3___flags.html#a8619935f1b6dc6bbb9806be12fc3eac5">test</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a148e86e8d9dd323545c97ca80bbe5141">GROUPING</a>); }</div> <div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#a5dfb5b60cbd93b767fb58ba723c2aa01"> 70</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#a5dfb5b60cbd93b767fb58ba723c2aa01">GetReadOnly</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_i_d3___header.html#af566de5a6ab82c06c60a8a339efd99cb">_flags</a>.<a class="code" href="class_i_d3___flags.html#a8619935f1b6dc6bbb9806be12fc3eac5">test</a>(<a class="code" href="class_i_d3___frame_header.html#aa9d35b51228fa16723474d5d9b983175a194e61c438997f2d0fe91694d9198556">READONLY</a>); }</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordtype">void</span> <a class="code" href="class_i_d3___frame_header.html#a2362d5a31497768a9e9e350aeb9666d2">SetUnknownFrame</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*);</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="class_i_d3___frame_header.html#aebe582e726e9d7b2e04a55f66d47a2b6"> 74</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_i_d3___frame_header.html#aebe582e726e9d7b2e04a55f66d47a2b6">SetFlags</a>(uint16 f, <span class="keywordtype">bool</span> b)</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> changed = <a class="code" href="class_i_d3___header.html#af566de5a6ab82c06c60a8a339efd99cb">_flags</a>.<a class="code" href="class_i_d3___flags.html#a6aa5d0be84c92c189c777c6b77fdda06">set</a>(f, b);</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="class_i_d3___header.html#a31b9c5422408071d2f063a4130861de3">_changed</a> = <a class="code" href="class_i_d3___header.html#a31b9c5422408071d2f063a4130861de3">_changed</a> || changed;</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> changed;</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// following is moved to public due to bug unknownframes corrupting a tag</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">// void SetUnknownFrame(const char*);</span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="struct_i_d3___frame_def.html">ID3_FrameDef</a>* _frame_def;</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">bool</span> _dyn_frame_def;</div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> ;</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#endif </span><span class="comment">/* _ID3LIB_HEADER_FRAME_ */</span><span class="preprocessor"></span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Apr 5 2013 19:40:29 for id3lib by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3 </small></address> </body> </html>