git.maemo.org Git - someplayer/blob - src/taglib/mpeg/id3v2/frames/uniquefileidentifierframe.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_UNIQUEFILEIDENTIFIERFRAME
  27 #define TAGLIB_UNIQUEFILEIDENTIFIERFRAME
  28
  29 #include "id3v2frame.h"
  30
  31 namespace TagLib {
  32
  33   namespace ID3v2 {
  34
  35     /*!
  36      * This is an implementation of ID3v2 unique file identifier frames.  This
  37      * frame is used to identify the file in an arbitrary database identified
  38      * by the owner field.
  39      */
  40
  41     //! An implementation of ID3v2 unique identifier frames
  42
  43     class TAGLIB_EXPORT UniqueFileIdentifierFrame : public ID3v2::Frame
  44     {
  45       friend class FrameFactory;
  46
  47     public:
  48       /*!
  49        * Creates a uniqe file identifier frame based on \a data.
  50        */
  51       UniqueFileIdentifierFrame(const ByteVector &data);
  52
  53       /*!
  54        * Creates a unique file identifier frame with the owner \a owner and
  55        * the identification \a id.
  56        */
  57       UniqueFileIdentifierFrame(const String &owner, const ByteVector &id);
  58
  59       /*!
  60        * Destroys the frame.
  61        */
  62       ~UniqueFileIdentifierFrame();
  63
  64       /*!
  65        * Returns the owner for the frame; essentially this is the key for
  66        * determining which identification scheme this key belongs to.  This
  67        * will usually either be an email address or URL for the person or tool
  68        * used to create the unique identifier.
  69        *
  70        * \see setOwner()
  71        */
  72       String owner() const;
  73
  74       /*!
  75        * Returns the unique identifier.  Though sometimes this is a text string
  76        * it also may be binary data and as much should be assumed when handling
  77        * it.
  78        */
  79       ByteVector identifier() const;
  80
  81       /*!
  82        * Sets the owner of the identification scheme to \a s.
  83        *
  84        * \see owner()
  85        */
  86       void setOwner(const String &s);
  87
  88       /*!
  89        * Sets the unique file identifier to \a v.
  90        *
  91        * \see identifier()
  92        */
  93       void setIdentifier(const ByteVector &v);
  94
  95       virtual String toString() const;
  96
  97     protected:
  98       virtual void parseFields(const ByteVector &data);
  99       virtual ByteVector renderFields() const;
 100
 101     private:
 102       UniqueFileIdentifierFrame(const UniqueFileIdentifierFrame &);
 103       UniqueFileIdentifierFrame &operator=(UniqueFileIdentifierFrame &);
 104
 105       UniqueFileIdentifierFrame(const ByteVector &data, Header *h);
 106
 107       class UniqueFileIdentifierFramePrivate;
 108       UniqueFileIdentifierFramePrivate *d;
 109     };
 110   }
 111 }
 112
 113 #endif