git.maemo.org Git - someplayer/blob - src/taglib/mpeg/id3v2/id3v2footer.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_ID3V2FOOTER_H
  27 #define TAGLIB_ID3V2FOOTER_H
  28
  29 #include "taglib_export.h"
  30 #include "tbytevector.h"
  31
  32 namespace TagLib {
  33
  34   namespace ID3v2 {
  35
  36     class Header;
  37
  38     //! ID3v2 footer implementation
  39
  40     /*!
  41      * Per the ID3v2 specification, the tag's footer is just a copy of the
  42      * information in the header.  As such there is no API for reading the
  43      * data from the header, it can just as easily be done from the header.
  44      *
  45      * In fact, at this point, TagLib does not even parse the footer since
  46      * it is not useful internally.  However, if the flag to include a footer
  47      * has been set in the ID3v2::Tag, TagLib will render a footer.
  48      */
  49
  50     class TAGLIB_EXPORT Footer
  51     {
  52     public:
  53       /*!
  54        * Constructs an empty ID3v2 footer.
  55        */
  56       Footer();
  57       /*!
  58        * Destroys the footer.
  59        */
  60       virtual ~Footer();
  61
  62       /*!
  63        * Returns the size of the footer.  Presently this is always 10 bytes.
  64        */
  65       static uint size();
  66
  67       /*!
  68        * Renders the footer based on the data in \a header.
  69        */
  70       ByteVector render(const Header *header) const;
  71
  72     private:
  73       Footer(const Footer &);
  74       Footer &operator=(const Footer &);
  75
  76       class FooterPrivate;
  77       FooterPrivate *d;
  78     };
  79
  80   }
  81 }
  82 #endif