dsdifffile.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2016 by Damien Plisson, Audirvana
    email                : damien78@audirvana.com
 ***************************************************************************/

/***************************************************************************
 *   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_DSDIFFFILE_H
#define TAGLIB_DSDIFFFILE_H

#include "tfile.h"
#include "id3v2tag.h"
#include "dsdiffproperties.h"
#include "dsdiffdiintag.h"

namespace TagLib {


  namespace DSDIFF {


    class TAGLIB_EXPORT File : public TagLib::File
    {
    public:

      enum TagTypes {
        NoTags  = 0x0000,
        DIIN    = 0x0001,
        ID3v2   = 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;

      Tag *tag() const override;

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

      DSDIFF::DIIN::Tag *DIINTag(bool create = false) const;

      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);

      void strip(int tags = AllTags);

      bool hasID3v2Tag() const;

      bool hasDIINTag() const;

       static bool isSupported(IOStream *stream);

    protected:
      enum Endianness { BigEndian, LittleEndian };

    private:
      void removeRootChunk(const ByteVector &id);
      void removeRootChunk(unsigned int i);
      void removeChildChunk(const ByteVector &id, unsigned int childChunkNum);
      void removeChildChunk(unsigned int i, unsigned int childChunkNum);

      void setRootChunkData(unsigned int i, const ByteVector &data);

      void setRootChunkData(const ByteVector &name, const ByteVector &data);

      void setChildChunkData(unsigned int i, const ByteVector &data,
                             unsigned int childChunkNum);

      void setChildChunkData(const ByteVector &name, const ByteVector &data,
                             unsigned int childChunkNum);

      void updateRootChunksStructure(unsigned int startingChunk);

      void read(bool readProperties, Properties::ReadStyle propertiesStyle);
      void writeChunk(const ByteVector &name, const ByteVector &data,
                      unsigned long long offset, unsigned long replace = 0,
                      unsigned int leadingPadding = 0);

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

#endif