synchronizedlyricsframe.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2014 by Urs Fleisch
    email                : ufleisch@users.sourceforge.net
 ***************************************************************************/

/***************************************************************************
 *   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_SYNCHRONIZEDLYRICSFRAME_H
#define TAGLIB_SYNCHRONIZEDLYRICSFRAME_H

#include "tlist.h"
#include "id3v2frame.h"

namespace TagLib {

  namespace ID3v2 {


    class TAGLIB_EXPORT SynchronizedLyricsFrame : public Frame
    {
      friend class FrameFactory;

    public:

      enum TimestampFormat {
        Unknown              = 0x00,
        AbsoluteMpegFrames   = 0x01,
        AbsoluteMilliseconds = 0x02
      };

      enum Type {
        Other             = 0x00,
        Lyrics            = 0x01,
        TextTranscription = 0x02,
        Movement          = 0x03,
        Events            = 0x04,
        Chord             = 0x05,
        Trivia            = 0x06,
        WebpageUrls       = 0x07,
        ImageUrls         = 0x08
      };

      struct SynchedText {
        SynchedText(unsigned int ms, const String &str) :
          time(ms), text(str) { }
        unsigned int time;
        String text;
      };

      using SynchedTextList = TagLib::List<SynchedText>;

      explicit SynchronizedLyricsFrame(String::Type encoding = String::Latin1);

      explicit SynchronizedLyricsFrame(const ByteVector &data);

      ~SynchronizedLyricsFrame() override;

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

      String toString() const override;

      String::Type textEncoding() const;

      ByteVector language() const;

      TimestampFormat timestampFormat() const;

      Type type() const;

      String description() const;

      SynchedTextList synchedText() const;

      void setTextEncoding(String::Type encoding);

      void setLanguage(const ByteVector &languageEncoding);

      void setTimestampFormat(TimestampFormat f);

      void setType(Type t);

      void setDescription(const String &s);

      void setSynchedText(const SynchedTextList &t);

    protected:
      // Reimplementations.

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

    private:
      SynchronizedLyricsFrame(const ByteVector &data, Header *h);

      class SynchronizedLyricsFramePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<SynchronizedLyricsFramePrivate> d;
    };

  }  // namespace ID3v2
}  // namespace TagLib
#endif