git.maemo.org Git - someplayer/blob - src/taglib/riff/rifffile.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_RIFFFILE_H
  27 #define TAGLIB_RIFFFILE_H
  28
  29 #include "taglib_export.h"
  30 #include "tfile.h"
  31
  32 namespace TagLib {
  33
  34   //! An implementation of TagLib::File with RIFF specific methods
  35
  36   namespace RIFF {
  37
  38     //! An RIFF file class with some useful methods specific to RIFF
  39
  40     /*!
  41      * This implements the generic TagLib::File API and additionally provides
  42      * access to properties that are distinct to RIFF files, notably access
  43      * to the different ID3 tags.
  44      */
  45
  46     class TAGLIB_EXPORT File : public TagLib::File
  47     {
  48     public:
  49       /*!
  50        * Destroys this instance of the File.
  51        */
  52       virtual ~File();
  53
  54     protected:
  55
  56       enum Endianness { BigEndian, LittleEndian };
  57
  58       File(FileName file, Endianness endianness);
  59
  60       /*!
  61        * \return The number of chunks in the file.
  62        */
  63       uint chunkCount() const;
  64
  65       /*!
  66        * \return The offset within the file for the selected chunk number.
  67        */
  68       uint chunkOffset(uint i) const;
  69
  70       /*!
  71        * \return The name of the specified chunk, for instance, "COMM" or "ID3 "
  72        */
  73       ByteVector chunkName(uint i) const;
  74
  75       /*!
  76        * Reads the chunk data from the file and returns it.
  77        *
  78        * \note This \e will move the read pointer for the file.
  79        */
  80       ByteVector chunkData(uint i);
  81
  82       /*!
  83        * Sets the data for the chunk \a name to \a data.  If a chunk with the
  84        * given name already exists it will be overwritten, otherwise it will be
  85        * created after the existing chunks.
  86        *
  87        * \warning This will update the file immediately.
  88        */
  89       void setChunkData(const ByteVector &name, const ByteVector &data);
  90
  91     private:
  92       File(const File &);
  93       File &operator=(const File &);
  94
  95       void read();
  96       void writeChunk(const ByteVector &name, const ByteVector &data,
  97                       ulong offset, ulong replace = 0);
  98
  99       class FilePrivate;
 100       FilePrivate *d;
 101     };
 102   }
 103 }
 104
 105 #endif