mpegfile.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_MPEGFILE_H
#define TAGLIB_MPEGFILE_H

#include "tfile.h"
#include "taglib_export.h"
#include "tag.h"
#include "mpegproperties.h"
#include "id3v2.h"

namespace TagLib {

  namespace ID3v2 { class Tag; class FrameFactory; }
  namespace ID3v1 { class Tag; }
  namespace APE { class Tag; }


  namespace MPEG {


    class TAGLIB_EXPORT File : public TagLib::File
    {
    public:
      enum TagTypes {
        NoTags  = 0x0000,
        ID3v1   = 0x0001,
        ID3v2   = 0x0002,
        APE     = 0x0004,
        AllTags = 0xffff
      };

      File(FileName file, bool readProperties = true,
           Properties::ReadStyle readStyle = Properties::Average,
           ID3v2::FrameFactory *frameFactory = nullptr);

      TAGLIB_DEPRECATED
      File(FileName file, ID3v2::FrameFactory *frameFactory,
           bool readProperties = true,
           Properties::ReadStyle readStyle = Properties::Average);

      File(IOStream *stream, bool readProperties = true,
           Properties::ReadStyle readStyle = Properties::Average,
           ID3v2::FrameFactory *frameFactory = nullptr);

      TAGLIB_DEPRECATED
      File(IOStream *stream, ID3v2::FrameFactory *frameFactory,
           bool readProperties = true,
           Properties::ReadStyle readStyle = Properties::Average);

      ~File() override;

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

      Tag *tag() const override;

      PropertyMap properties() const override;

      void removeUnsupportedProperties(const StringList &properties) override;

      PropertyMap setProperties(const PropertyMap &) override;

      Properties *audioProperties() const override;

      bool save() override;

      bool save(int tags, StripTags strip = StripOthers,
                ID3v2::Version version = ID3v2::v4,
                DuplicateTags duplicate = Duplicate);

      ID3v2::Tag *ID3v2Tag(bool create = false);

      ID3v1::Tag *ID3v1Tag(bool create = false);

      APE::Tag *APETag(bool create = false);

      bool strip(int tags = AllTags, bool freeMemory = true);

      offset_t firstFrameOffset();

      offset_t nextFrameOffset(offset_t position);

      offset_t previousFrameOffset(offset_t position);

      offset_t lastFrameOffset();

      bool hasID3v1Tag() const;

      bool hasID3v2Tag() const;

      bool hasAPETag() const;

      static bool isSupported(IOStream *stream);

    private:
      void read(bool readProperties, Properties::ReadStyle readStyle);
      offset_t findID3v2(Properties::ReadStyle readStyle);

      class FilePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<FilePrivate> d;
    };
  }  // namespace MPEG
}  // namespace TagLib

#endif