wavfile.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 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_WAVFILE_H
#define TAGLIB_WAVFILE_H

#include "rifffile.h"
#include "id3v2tag.h"
#include "infotag.h"
#include "wavproperties.h"

namespace TagLib {

  namespace RIFF {


    namespace WAV {


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

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

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

        ~File() override;

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

        TagLib::Tag *tag() const override;

        ID3v2::Tag *ID3v2Tag() const;

        Info::Tag *InfoTag() const;

        void strip(TagTypes tags = AllTags);

        PropertyMap properties() const override;

        void removeUnsupportedProperties(const StringList &unsupported) override;

        PropertyMap setProperties(const PropertyMap &) override;

        Properties *audioProperties() const override;

        bool save() override;

        bool save(TagTypes tags, StripTags strip = StripOthers,
                  ID3v2::Version version = ID3v2::v4);

        bool hasID3v2Tag() const;

        bool hasInfoTag() const;

        static bool isSupported(IOStream *stream);

      private:
        void read(bool readProperties);
        void removeTagChunks(TagTypes tags);

        friend class Properties;

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

#endif