git.maemo.org Git - someplayer/blob - src/taglib/mpeg/id3v2/frames/unknownframe.h

   1 /***************************************************************************
   2     copyright            : (C) 2002 - 2008 by Scott Wheeler
   3     email                : wheeler@kde.org
   4  ***************************************************************************/
   5
   6 /***************************************************************************
   7  *   This library is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU Lesser General Public License version   *
   9  *   2.1 as published by the Free Software Foundation.                     *
  10  *                                                                         *
  11  *   This library is distributed in the hope that it will be useful, but   *
  12  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
  14  *   Lesser General Public License for more details.                       *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU Lesser General Public      *
  17  *   License along with this library; if not, write to the Free Software   *
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
  19  *   USA                                                                   *
  20  *                                                                         *
  21  *   Alternatively, this file is available under the Mozilla Public        *
  22  *   License Version 1.1.  You may obtain a copy of the License at         *
  23  *   http://www.mozilla.org/MPL/                                           *
  24  ***************************************************************************/
  25
  26 #ifndef TAGLIB_UNKNOWNFRAME_H
  27 #define TAGLIB_UNKNOWNFRAME_H
  28
  29 #include "id3v2frame.h"
  30 #include "taglib_export.h"
  31
  32 namespace TagLib {
  33
  34   namespace ID3v2 {
  35
  36     //! A frame type \e unknown to TagLib.
  37
  38     /*!
  39      * This class represents a frame type not known (or more often simply
  40      * unimplemented) in TagLib.  This is here provide a basic API for
  41      * manipulating the binary data of unknown frames and to provide a means
  42      * of rendering such \e unknown frames.
  43      *
  44      * Please note that a cleaner way of handling frame types that TagLib
  45      * does not understand is to subclass ID3v2::Frame and ID3v2::FrameFactory
  46      * to have your frame type supported through the standard ID3v2 mechanism.
  47      */
  48
  49     class TAGLIB_EXPORT UnknownFrame : public Frame
  50     {
  51       friend class FrameFactory;
  52
  53     public:
  54       UnknownFrame(const ByteVector &data);
  55       virtual ~UnknownFrame();
  56
  57       virtual String toString() const;
  58
  59       /*!
  60        * Returns the field data (everything but the header) for this frame.
  61        */
  62       ByteVector data() const;
  63
  64     protected:
  65       virtual void parseFields(const ByteVector &data);
  66       virtual ByteVector renderFields() const;
  67
  68     private:
  69       UnknownFrame(const ByteVector &data, Header *h);
  70       UnknownFrame(const UnknownFrame &);
  71       UnknownFrame &operator=(const UnknownFrame &);
  72
  73       class UnknownFramePrivate;
  74       UnknownFramePrivate *d;
  75     };
  76
  77   }
  78 }
  79 #endif