tfile.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_FILE_H
#define TAGLIB_FILE_H

#include "tbytevector.h"
#include "tiostream.h"
#include "taglib_export.h"
#include "taglib.h"
#include "tag.h"

namespace TagLib {

  class String;
  class Tag;
  class AudioProperties;
  class PropertyMap;


  class TAGLIB_EXPORT File
  {
  public:
    enum Position {
      Beginning,
      Current,
      End
    };

    enum StripTags {
      StripNone,  
      StripOthers 
    };

    enum DuplicateTags {
      Duplicate,     
      DoNotDuplicate 
    };

    virtual ~File();

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

    FileName name() const;

    virtual Tag *tag() const = 0;

    virtual PropertyMap properties() const;

    virtual void removeUnsupportedProperties(const StringList& properties);

    virtual PropertyMap setProperties(const PropertyMap &properties);

    virtual StringList complexPropertyKeys() const;

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

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

    virtual AudioProperties *audioProperties() const = 0;

    virtual bool save() = 0;

    ByteVector readBlock(size_t length);

    void writeBlock(const ByteVector &data);

    offset_t find(const ByteVector &pattern,
              offset_t fromOffset = 0,
              const ByteVector &before = ByteVector());

    offset_t rfind(const ByteVector &pattern,
               offset_t fromOffset = 0,
               const ByteVector &before = ByteVector());

    void insert(const ByteVector &data, offset_t start = 0, size_t replace = 0);

    void removeBlock(offset_t start = 0, size_t length = 0);

    bool readOnly() const;

    bool isOpen() const;

    bool isValid() const;

    void seek(offset_t offset, Position p = Beginning);

    void clear();

    offset_t tell() const;

    offset_t length();

  protected:
    File(FileName fileName);

    File(IOStream *stream);

    void setValid(bool valid);

    void truncate(offset_t length);

    static unsigned int bufferSize();

  private:
    class FilePrivate;
    TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
    std::unique_ptr<FilePrivate> d;
  };

}  // namespace TagLib

#endif