/***************************************************************************
    copyright           : (C) 2011 by Mathias Panzenböck
    email               : grosser.meister.morti@gmx.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_MODFILE_H
#define TAGLIB_MODFILE_H

#include "tfile.h"
#include "audioproperties.h"
#include "taglib_export.h"
#include "modfilebase.h"
#include "modtag.h"
#include "modproperties.h"

namespace Strawberry_TagLib {
namespace TagLib {
namespace Mod {

class TAGLIB_EXPORT File : public Strawberry_TagLib::TagLib::Mod::FileBase {
 public:
  /*!
   * Constructs a Protracker file from \a file.
   *
   * \note In the current implementation, both \a readProperties and \a propertiesStyle are ignored.
   * The audio properties are always read.
   */
  explicit File(FileName file, bool readProperties = true, AudioProperties::ReadStyle propertiesStyle = AudioProperties::Average);

  /*!
   * Constructs a Protracker file from \a stream.
   *
   * \note In the current implementation, both \a readProperties and \a propertiesStyle are ignored.
   * The audio properties are always read.
   *
   * \note TagLib will *not* take ownership of the stream, the caller is
   * responsible for deleting it after the File object.
   */
  explicit File(IOStream *stream, bool readProperties = true, AudioProperties::ReadStyle propertiesStyle = AudioProperties::Average);

  /*!
   * Destroys this instance of the File.
   */
  ~File() override;

  Mod::Tag *tag() const override;

  /*!
   * Returns the Mod::AudioProperties for this file. If no audio properties were read then this will return a null pointer.
   */
  Mod::AudioProperties *audioProperties() const override;

  /*!
   * Save the file.
   * This is the same as calling save(AllTags);
   *
   * \note Saving Protracker tags is not supported.
   */
  bool save() override;

 private:
  File(const File &);
  File &operator=(const File &);

  void read(bool readProperties);

  class FilePrivate;
  FilePrivate *d;
};

}  // namespace Mod
}  // namespace TagLib
}  // namespace Strawberry_TagLib

#endif