id3lib 3.8.3
header_frame.h
Go to the documentation of this file.
1// -*- C++ -*-
2// $Id: header_frame.h,v 1.2 2002/07/05 12:31:15 t1mpy Exp $
3
4// id3lib: a C++ library for creating and manipulating id3v1/v2 tags
5// Copyright 1999, 2000 Scott Thomas Haug
6
7// This library is free software; you can redistribute it and/or modify it
8// under the terms of the GNU Library General Public License as published by
9// the Free Software Foundation; either version 2 of the License, or (at your
10// option) any later version.
11//
12// This library is distributed in the hope that it will be useful, but WITHOUT
13// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
15// License for more details.
16//
17// You should have received a copy of the GNU Library General Public License
18// along with this library; if not, write to the Free Software Foundation,
19// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20
21// The id3lib authors encourage improvements and optimisations to be sent to
22// the id3lib coordinator. Please see the README file for details on where to
23// send such submissions. See the AUTHORS file for a list of people who have
24// contributed to id3lib. See the ChangeLog file for a list of changes to
25// id3lib. These files are distributed with id3lib at
26// http://download.sourceforge.net/id3lib/
27
28#ifndef _ID3LIB_HEADER_FRAME_H_
29#define _ID3LIB_HEADER_FRAME_H_
30
31#include "header.h"
32#include "field.h"
33
34struct ID3_FrameDef;
35
37{
38public:
39
40 enum
41 {
42 TAGALTER = 1 << 15,
43 FILEALTER = 1 << 14,
44 READONLY = 1 << 13,
45 COMPRESSION = 1 << 7,
46 ENCRYPTION = 1 << 6,
47 GROUPING = 1 << 5
48 };
49
50 ID3_FrameHeader() : _frame_def(NULL), _dyn_frame_def(false) { ; }
51 virtual ~ID3_FrameHeader() { this->Clear(); }
52
53 /* */ size_t Size() const;
54 /* */ bool Parse(ID3_Reader&);
55 /* */ void Render(ID3_Writer&) const;
56 /* */ bool SetFrameID(ID3_FrameID id);
57 /* */ ID3_FrameID GetFrameID() const;
58 const char* GetTextID() const;
59 const ID3_FrameDef* GetFrameDef() const;
60 /* */ bool Clear();
62
63 bool SetCompression(bool b) { return this->SetFlags(COMPRESSION, b); }
64 bool SetEncryption(bool b) { return this->SetFlags(ENCRYPTION, b); }
65 bool SetGrouping(bool b) { return this->SetFlags(GROUPING, b); }
66
67 bool GetCompression() const { return _flags.test(COMPRESSION); }
68 bool GetEncryption() const { return _flags.test(ENCRYPTION); }
69 bool GetGrouping() const { return _flags.test(GROUPING); }
70 bool GetReadOnly() const { return _flags.test(READONLY); }
71 void SetUnknownFrame(const char*);
72
73protected:
74 bool SetFlags(uint16 f, bool b)
75 {
76 bool changed = _flags.set(f, b);
77 _changed = _changed || changed;
78 return changed;
79 }
80// following is moved to public due to bug unknownframes corrupting a tag
81// void SetUnknownFrame(const char*);
82
83private:
84 ID3_FrameDef* _frame_def;
85 bool _dyn_frame_def;
86}
87;
88
89#endif /* _ID3LIB_HEADER_FRAME_ */
bool test(TYPE f) const
Definition flags.h:42
bool set(TYPE f)
Definition flags.h:43
const ID3_FrameDef * GetFrameDef() const
void Render(ID3_Writer &) const
bool GetGrouping() const
void SetUnknownFrame(const char *)
virtual ~ID3_FrameHeader()
bool GetEncryption() const
size_t Size() const
ID3_FrameID GetFrameID() const
const char * GetTextID() const
bool SetEncryption(bool b)
bool SetFrameID(ID3_FrameID id)
ID3_FrameHeader & operator=(const ID3_FrameHeader &)
bool SetCompression(bool b)
bool GetReadOnly() const
bool Parse(ID3_Reader &)
bool GetCompression() const
bool SetGrouping(bool b)
bool SetFlags(uint16 f, bool b)
bool _changed
Definition header.h:106
ID3_Flags _flags
Definition header.h:104
#define NULL
Definition globals.h:743
ID3_FrameID
Enumeration of the different types of frames recognized by id3lib.
Definition globals.h:230

Generated for id3lib by doxygen 1.10.0