chapterframe.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2013 by Lukas Krejci
    email                : krejclu6@fel.cvut.cz
 ***************************************************************************/

/***************************************************************************
 *   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_CHAPTERFRAME
#define TAGLIB_CHAPTERFRAME

#include "taglib_export.h"
#include "id3v2tag.h"
#include "id3v2frame.h"

namespace TagLib {

  namespace ID3v2 {


    class TAGLIB_EXPORT ChapterFrame : public ID3v2::Frame
    {
      friend class FrameFactory;

    public:
      ChapterFrame(const ID3v2::Header *tagHeader, const ByteVector &data);

      ChapterFrame(const ByteVector &elementID,
                   unsigned int startTime, unsigned int endTime,
                   unsigned int startOffset, unsigned int endOffset,
                   const FrameList &embeddedFrames = FrameList());

      ~ChapterFrame() override;

      ChapterFrame(const ChapterFrame &) = delete;
      ChapterFrame &operator=(const ChapterFrame &) = delete;

      ByteVector elementID() const;

      unsigned int startTime() const;

      unsigned int endTime() const;

      unsigned int startOffset() const;

      unsigned int endOffset() const;

      void setElementID(const ByteVector &eID);

      void setStartTime(const unsigned int &sT);

      void setEndTime(const unsigned int &eT);

      void setStartOffset(const unsigned int &sO);

      void setEndOffset(const unsigned int &eO);

      const FrameListMap &embeddedFrameListMap() const;

      const FrameList &embeddedFrameList() const;

      const FrameList &embeddedFrameList(const ByteVector &frameID) const;

      void addEmbeddedFrame(Frame *frame);

      void removeEmbeddedFrame(Frame *frame, bool del = true);

      void removeEmbeddedFrames(const ByteVector &id);

      String toString() const override;

      PropertyMap asProperties() const override;

      static ChapterFrame *findByElementID(const Tag *tag, const ByteVector &eID);

    protected:
      void parseFields(const ByteVector &data) override;
      ByteVector renderFields() const override;

    private:
      ChapterFrame(const ID3v2::Header *tagHeader, const ByteVector &data, Header *h);

      class ChapterFramePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<ChapterFramePrivate> d;
    };
  }  // namespace ID3v2
}  // namespace TagLib

#endif