/**************************************************************************
    copyright            : (C) 2005-2007 by Lukáš Lalinský
    email                : lalinsky@gmail.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_ASFFILE_H
#define TAGLIB_ASFFILE_H

#include "tag.h"
#include "tfile.h"
#include "taglib_export.h"
#include "asfproperties.h"
#include "asftag.h"

namespace Strawberry_TagLib {
namespace TagLib {

//! An implementation of ASF (WMA) metadata
namespace ASF {

/*!
 * This implements and provides an interface for ASF files to the
 * TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing
 * the abstract TagLib::File API as well as providing some additional
 * information specific to ASF files.
 */
class TAGLIB_EXPORT File : public Strawberry_TagLib::TagLib::File {
 public:
  /*!
   * Constructs an ASF 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 an ASF 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;

  /*!
   * Returns a pointer to the ASF tag of the file.
   *
   * ASF::Tag implements the tag interface, so this serves as the
   * reimplementation of TagLib::File::tag().
   *
   * \note The Tag <b>is still</b> owned by the ASF::File and should not be
   * deleted by the user.  It will be deleted when the file (object) is
   * destroyed.
   */
  Tag *tag() const override;

  /*!
   * Returns the ASF audio properties for this file.
   */
  AudioProperties *audioProperties() const override;

  /*!
   * Save the file.
   *
   * This returns true if the save was successful.
   */
  bool save() override;

  /*!
   * Returns whether or not the given \a stream can be opened as an ASF file.
   *
   * \note This method is designed to do a quick check.  The result may not necessarily be correct.
   */
  static bool isSupported(IOStream *stream);

 private:
  void read();

  class FilePrivate;
  FilePrivate *d;
};

}  // namespace ASF

}  // namespace TagLib
}  // namespace Strawberry_TagLib

#endif