id3v2frame.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2002 - 2008 by Scott Wheeler
    email                : wheeler@kde.org
 ***************************************************************************/
 
/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful, but   *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/
 
#ifndef TAGLIB_ID3V2FRAME_H
#define TAGLIB_ID3V2FRAME_H
 
#include "tstring.h"
#include "tbytevector.h"
#include "taglib_export.h"
 
namespace TagLib {
 
  class StringList;
  class PropertyMap;
 
  namespace ID3v2 {
 
    class Tag;
    class FrameFactory;
 
 
    class TAGLIB_EXPORT Frame
    {
      friend class Tag;
      friend class FrameFactory;
 
    public:
 
      static Frame *createTextualFrame(const String &key, const StringList &values);
 
      virtual ~Frame();
 
      ByteVector frameID() const;
 
      unsigned int size() const;
 
      static unsigned int headerSize(); // BIC: remove and make non-static
 
      static unsigned int headerSize(unsigned int version); // BIC: remove and make non-static
 
      void setData(const ByteVector &data);
 
      virtual void setText(const String &text);
 
      virtual String toString() const = 0;
 
      ByteVector render() const;
 
      static ByteVector textDelimiter(String::Type t);
 
      static const String instrumentPrefix;
      static const String commentPrefix;
      static const String lyricsPrefix;
      static const String urlPrefix;
 
    protected:
      class Header;
 
      explicit Frame(const ByteVector &data);
 
      Frame(Header *h);
 
      Header *header() const;
 
      void setHeader(Header *h, bool deleteCurrent = true);
 
      void parse(const ByteVector &data);
 
      virtual void parseFields(const ByteVector &data) = 0;
 
      virtual ByteVector renderFields() const = 0;
 
      ByteVector fieldData(const ByteVector &frameData) const;
 
      String readStringField(const ByteVector &data, String::Type encoding,
                             int *positon = 0);
 
      // BIC: remove and make non-static
      static String::Type checkEncoding(const StringList &fields,
                                        String::Type encoding);
 
      // BIC: remove and make non-static
      static String::Type checkEncoding(const StringList &fields,
                                        String::Type encoding, unsigned int version);
 
      String::Type checkTextEncoding(const StringList &fields,
                                     String::Type encoding) const;
 
 
      PropertyMap asProperties() const;
 
      static ByteVector keyToFrameID(const String &);
 
      static String frameIDToKey(const ByteVector &);
 
      static String keyToTXXX(const String &);
 
      static String txxxToKey(const String &);
 
      static void splitProperties(const PropertyMap &original, PropertyMap &singleFrameProperties,
          PropertyMap &tiplProperties, PropertyMap &tmclProperties);
 
    private:
      Frame(const Frame &);
      Frame &operator=(const Frame &);
 
      class FramePrivate;
      friend class FramePrivate;
      FramePrivate *d;
    };
 
 
    class TAGLIB_EXPORT Frame::Header
    {
    public:
      Header(const ByteVector &data, bool synchSafeInts);
 
      explicit Header(const ByteVector &data, unsigned int version = 4);
 
      virtual ~Header();
 
      void setData(const ByteVector &data, bool synchSafeInts);
 
      void setData(const ByteVector &data, unsigned int version = 4);
 
      ByteVector frameID() const;
 
      void setFrameID(const ByteVector &id);
 
      unsigned int frameSize() const;
 
      void setFrameSize(unsigned int size);
 
      unsigned int version() const;
 
      void setVersion(unsigned int version);
 
      static unsigned int size();
 
      static unsigned int size(unsigned int version);
 
      bool tagAlterPreservation() const;
 
      void setTagAlterPreservation(bool discard);
 
      bool fileAlterPreservation() const;
 
      bool readOnly() const;
 
      bool groupingIdentity() const;
 
      bool compression() const;
 
      bool encryption() const;
 
#ifndef DO_NOT_DOCUMENT
      bool unsycronisation() const;
#endif
 
      bool unsynchronisation() const;
 
      bool dataLengthIndicator() const;
 
      ByteVector render() const;
 
      bool frameAlterPreservation() const;
 
    private:
      Header(const Header &);
      Header &operator=(const Header &);
 
      class HeaderPrivate;
      HeaderPrivate *d;
    };
 
  }
}
 
#endif