1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QSAMPLECACHE_P_H
41#define QSAMPLECACHE_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/qobject.h>
55#include <QtCore/qthread.h>
56#include <QtCore/qurl.h>
57#include <QtCore/qmutex.h>
58#include <QtCore/qmap.h>
59#include <QtCore/qset.h>
60#include <qaudioformat.h>
61
62
63QT_BEGIN_NAMESPACE
64
65class QIODevice;
66class QNetworkAccessManager;
67class QSampleCache;
68class QWaveDecoder;
69
70// Lives in application thread
71class Q_MULTIMEDIA_EXPORT QSample : public QObject
72{
73 Q_OBJECT
74public:
75 friend class QSampleCache;
76 enum State
77 {
78 Creating,
79 Loading,
80 Error,
81 Ready,
82 };
83
84 State state() const;
85 // These are not (currently) locked because they are only meant to be called after these
86 // variables are updated to their final states
87 const QByteArray& data() const { Q_ASSERT(state() == Ready); return m_soundData; }
88 const QAudioFormat& format() const { Q_ASSERT(state() == Ready); return m_audioFormat; }
89 void release();
90
91Q_SIGNALS:
92 void error();
93 void ready();
94
95protected:
96 QSample(const QUrl& url, QSampleCache *parent);
97
98private Q_SLOTS:
99 void load();
100 void decoderError();
101 void readSample();
102 void decoderReady();
103
104private:
105 void onReady();
106 void cleanup();
107 void addRef();
108 void loadIfNecessary();
109 QSample();
110 ~QSample();
111
112 mutable QMutex m_mutex;
113 QSampleCache *m_parent;
114 QByteArray m_soundData;
115 QAudioFormat m_audioFormat;
116 QIODevice *m_stream;
117 QWaveDecoder *m_waveDecoder;
118 QUrl m_url;
119 qint64 m_sampleReadLength;
120 State m_state;
121 int m_ref;
122};
123
124class Q_MULTIMEDIA_EXPORT QSampleCache : public QObject
125{
126 Q_OBJECT
127public:
128 friend class QSample;
129
130 QSampleCache(QObject *parent = nullptr);
131 ~QSampleCache();
132
133 QSample* requestSample(const QUrl& url);
134 void setCapacity(qint64 capacity);
135
136 bool isLoading() const;
137 bool isCached(const QUrl& url) const;
138
139Q_SIGNALS:
140 void isLoadingChanged();
141
142private:
143 QMap<QUrl, QSample*> m_samples;
144 QSet<QSample*> m_staleSamples;
145 QNetworkAccessManager *m_networkAccessManager;
146 mutable QRecursiveMutex m_mutex;
147 qint64 m_capacity;
148 qint64 m_usage;
149 QThread m_loadingThread;
150
151 QNetworkAccessManager& networkAccessManager();
152 void refresh(qint64 usageChange);
153 bool notifyUnreferencedSample(QSample* sample);
154 void removeUnreferencedSample(QSample* sample);
155 void unloadSample(QSample* sample);
156
157 void loadingRelease();
158 int m_loadingRefCount;
159 QMutex m_loadingMutex;
160};
161
162QT_END_NAMESPACE
163
164#endif // QSAMPLECACHE_P_H
165

source code of qtmultimedia/src/multimedia/audio/qsamplecache_p.h