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 QAUDIODECODER_H
41#define QAUDIODECODER_H
42
43#include <QtMultimedia/qmediaobject.h>
44#include <QtMultimedia/qmediaenumdebug.h>
45
46#include <QtMultimedia/qaudiobuffer.h>
47
48QT_BEGIN_NAMESPACE
49
50class QAudioDecoderPrivate;
51class Q_MULTIMEDIA_EXPORT QAudioDecoder : public QMediaObject
52{
53 Q_OBJECT
54 Q_PROPERTY(QString sourceFilename READ sourceFilename WRITE setSourceFilename NOTIFY sourceChanged)
55 Q_PROPERTY(State state READ state NOTIFY stateChanged)
56 Q_PROPERTY(QString error READ errorString)
57 Q_PROPERTY(bool bufferAvailable READ bufferAvailable NOTIFY bufferAvailableChanged)
58
59 Q_ENUMS(State)
60 Q_ENUMS(Error)
61
62public:
63 enum State
64 {
65 StoppedState,
66 DecodingState
67 };
68
69 enum Error
70 {
71 NoError,
72 ResourceError,
73 FormatError,
74 AccessDeniedError,
75 ServiceMissingError
76 };
77
78 explicit QAudioDecoder(QObject *parent = nullptr);
79 ~QAudioDecoder();
80
81 static QMultimedia::SupportEstimate hasSupport(const QString &mimeType, const QStringList& codecs = QStringList());
82
83 State state() const;
84
85 QString sourceFilename() const;
86 void setSourceFilename(const QString &fileName);
87
88 QIODevice* sourceDevice() const;
89 void setSourceDevice(QIODevice *device);
90
91 QAudioFormat audioFormat() const;
92 void setAudioFormat(const QAudioFormat &format);
93
94 Error error() const;
95 QString errorString() const;
96
97 QAudioBuffer read() const;
98 bool bufferAvailable() const;
99
100 qint64 position() const;
101 qint64 duration() const;
102
103public Q_SLOTS:
104 void start();
105 void stop();
106
107Q_SIGNALS:
108 void bufferAvailableChanged(bool);
109 void bufferReady();
110 void finished();
111
112 void stateChanged(QAudioDecoder::State newState);
113 void formatChanged(const QAudioFormat &format);
114
115 void error(QAudioDecoder::Error error);
116
117 void sourceChanged();
118
119 void positionChanged(qint64 position);
120 void durationChanged(qint64 duration);
121
122public:
123 bool bind(QObject *) override;
124 void unbind(QObject *) override;
125
126private:
127 Q_DISABLE_COPY(QAudioDecoder)
128 Q_DECLARE_PRIVATE(QAudioDecoder)
129 Q_PRIVATE_SLOT(d_func(), void _q_stateChanged(QAudioDecoder::State))
130 Q_PRIVATE_SLOT(d_func(), void _q_error(int, const QString &))
131};
132
133QT_END_NAMESPACE
134
135Q_DECLARE_METATYPE(QAudioDecoder::State)
136Q_DECLARE_METATYPE(QAudioDecoder::Error)
137
138Q_MEDIA_ENUM_DEBUG(QAudioDecoder, State)
139Q_MEDIA_ENUM_DEBUG(QAudioDecoder, Error)
140
141#endif // QAUDIODECODER_H
142

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