summaryrefslogtreecommitdiffstats
path: root/xbmc/music/tags/TagLibVFSStream.h
blob: 2302c04dd92bdac45b3e5798bfb320ced4a2908d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "filesystem/File.h"

#include <taglib/taglib.h>
#include <taglib/tiostream.h>

namespace MUSIC_INFO
{
  class TagLibVFSStream : public TagLib::IOStream
  {
  public:
    /*!
     * Construct a File object and opens the \a file.  \a file should be a
     * be an XBMC Vfile.
     */
    TagLibVFSStream(const std::string& strFileName, bool readOnly);

    /*!
     * Destroys this ByteVectorStream instance.
     */
    ~TagLibVFSStream() override;

    /*!
     * Returns the file name in the local file system encoding.
     */
    TagLib::FileName name() const override;

    /*!
     * Reads a block of size \a length at the current get pointer.
     */
#if (TAGLIB_MAJOR_VERSION >= 2)
    TagLib::ByteVector readBlock(unsigned long length) override;
#else
    TagLib::ByteVector readBlock(TagLib::ulong length) override;
#endif

    /*!
     * Attempts to write the block \a data at the current get pointer.  If the
     * file is currently only opened read only -- i.e. readOnly() returns true --
     * this attempts to reopen the file in read/write mode.
     *
     * \note This should be used instead of using the streaming output operator
     * for a ByteVector.  And even this function is significantly slower than
     * doing output with a char[].
     */
    void writeBlock(const TagLib::ByteVector &data) override;

    /*!
     * Insert \a data at position \a start in the file overwriting \a replace
     * bytes of the original content.
     *
     * \note This method is slow since it requires rewriting all of the file
     * after the insertion point.
     */
#if (TAGLIB_MAJOR_VERSION >= 2)
    void insert(const TagLib::ByteVector& data,
                TagLib::offset_t start = 0,
                size_t replace = 0) override;
#else
    void insert(const TagLib::ByteVector &data, TagLib::ulong start = 0, TagLib::ulong replace = 0) override;
#endif

    /*!
     * Removes a block of the file starting a \a start and continuing for
     * \a length bytes.
     *
     * \note This method is slow since it involves rewriting all of the file
     * after the removed portion.
     */
#if (TAGLIB_MAJOR_VERSION >= 2)
    void removeBlock(TagLib::offset_t start = 0, size_t length = 0) override;
#else
    void removeBlock(TagLib::ulong start = 0, TagLib::ulong length = 0) override;
#endif

    /*!
     * Returns true if the file is read only (or if the file can not be opened).
     */
    bool readOnly() const override;

    /*!
     * Since the file can currently only be opened as an argument to the
     * constructor (sort-of by design), this returns if that open succeeded.
     */
    bool isOpen() const override;

    /*!
     * Move the I/O pointer to \a offset in the file from position \a p.  This
     * defaults to seeking from the beginning of the file.
     *
     * \see Position
     */
    void seek(long offset, TagLib::IOStream::Position p = Beginning) override;

    /*!
     * Reset the end-of-file and error flags on the file.
     */
    void clear() override;

    /*!
     * Returns the current offset within the file.
     */
    long tell() const override;

    /*!
     * Returns the length of the file.
     */
    long length() override;

    /*!
     * Truncates the file to a \a length.
     */
    void truncate(long length) override;

  protected:
    /*!
     * Returns the buffer size that is used for internal buffering.
     */
#if (TAGLIB_MAJOR_VERSION >= 2)
    static unsigned int bufferSize() { return 1024; }
#else
    static TagLib::uint bufferSize() { return 1024; }
#endif

  private:
    std::string   m_strFileName;
    XFILE::CFile  m_file;
    bool          m_bIsReadOnly;
    bool          m_bIsOpen;
  };
}