fileref.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_FILEREF_H
#define TAGLIB_FILEREF_H

#include "tfile.h"
#include "tstringlist.h"

#include "taglib_export.h"
#include "audioproperties.h"

namespace TagLib {

  class Tag;


  class TAGLIB_EXPORT FileRef
  {
  public:


    class TAGLIB_EXPORT FileTypeResolver
    {
    public:
      FileTypeResolver();
      virtual ~FileTypeResolver() = 0;

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

      virtual File *createFile(FileName fileName,
                               bool readAudioProperties = true,
                               AudioProperties::ReadStyle
                               audioPropertiesStyle = AudioProperties::Average) const = 0;
    private:
      class FileTypeResolverPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<FileTypeResolverPrivate> d;
    };


    class TAGLIB_EXPORT StreamTypeResolver : public FileTypeResolver
    {
    public:
      StreamTypeResolver();
      virtual ~StreamTypeResolver() override = 0; // virtual is needed by SWIG

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

      virtual File *createFileFromStream(IOStream *stream,
                               bool readAudioProperties = true,
                               AudioProperties::ReadStyle
                               audioPropertiesStyle = AudioProperties::Average) const = 0;
    private:
      class StreamTypeResolverPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<StreamTypeResolverPrivate> d;
    };

    FileRef();

    explicit FileRef(FileName fileName,
                     bool readAudioProperties = true,
                     AudioProperties::ReadStyle
                     audioPropertiesStyle = AudioProperties::Average);

    explicit FileRef(IOStream* stream,
                     bool readAudioProperties = true,
                     AudioProperties::ReadStyle
                     audioPropertiesStyle = AudioProperties::Average);

    explicit FileRef(File *file);

    FileRef(const FileRef &ref);

    ~FileRef();

    Tag *tag() const;

    PropertyMap properties() const;

    void removeUnsupportedProperties(const StringList& properties);

    PropertyMap setProperties(const PropertyMap &properties);

    StringList complexPropertyKeys() const;

    List<VariantMap> complexProperties(const String &key) const;

    bool setComplexProperties(const String &key, const List<VariantMap> &value);

    AudioProperties *audioProperties() const;

    File *file() const;

    bool save();

    static const FileTypeResolver *addFileTypeResolver(const FileTypeResolver *resolver);

    static void clearFileTypeResolvers();

    static StringList defaultFileExtensions();

    bool isNull() const;

    FileRef &operator=(const FileRef &ref);

    void swap(FileRef &ref) noexcept;

    bool operator==(const FileRef &ref) const;

    bool operator!=(const FileRef &ref) const;

  private:
    void parse(FileName fileName, bool readAudioProperties, AudioProperties::ReadStyle audioPropertiesStyle);
    void parse(IOStream *stream, bool readAudioProperties, AudioProperties::ReadStyle audioPropertiesStyle);

    class FileRefPrivate;
    TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
    std::shared_ptr<FileRefPrivate> d;
  };

} // namespace TagLib

#endif