diff options
Diffstat (limited to 'src/multimedia/audio')
39 files changed, 1495 insertions, 1610 deletions
diff --git a/src/multimedia/audio/qaudio.h b/src/multimedia/audio/qaudio.h index 868ef2f6a..5ae994b9f 100644 --- a/src/multimedia/audio/qaudio.h +++ b/src/multimedia/audio/qaudio.h @@ -1,46 +1,13 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIO_H #define QAUDIO_H +#if 0 +#pragma qt_class(QAudio) +#endif + #include <QtMultimedia/qtmultimediaglobal.h> #include <QtCore/qmetatype.h> @@ -51,7 +18,12 @@ QT_BEGIN_NAMESPACE // Class forward declaration required for QDoc bug class QString; + +#if defined(Q_QDOC) +namespace QtAudio +#else namespace QAudio +#endif { enum Error { NoError, OpenError, IOError, UnderrunError, FatalError }; enum State { ActiveState, SuspendedState, StoppedState, IdleState }; @@ -66,10 +38,14 @@ namespace QAudio Q_MULTIMEDIA_EXPORT float convertVolume(float volume, VolumeScale from, VolumeScale to); } +#if !defined(Q_QDOC) +namespace QtAudio = QAudio; +#endif + #ifndef QT_NO_DEBUG_STREAM -Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::Error error); -Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::State state); -Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QAudio::VolumeScale role); +Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QtAudio::Error error); +Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QtAudio::State state); +Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug dbg, QtAudio::VolumeScale role); #endif QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiobuffer.cpp b/src/multimedia/audio/qaudiobuffer.cpp index f839dc68b..69adcc5b7 100644 --- a/src/multimedia/audio/qaudiobuffer.cpp +++ b/src/multimedia/audio/qaudiobuffer.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qaudiobuffer.h" @@ -48,9 +12,7 @@ class QAudioBufferPrivate : public QSharedData { public: QAudioBufferPrivate(const QAudioFormat &f, const QByteArray &d, qint64 start) - : format(f), - data(d), - startTime(start) + : format(f), data(d), startTime(start) { } @@ -71,11 +33,12 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QAudioBufferPrivate); \inmodule QtMultimedia \ingroup multimedia \ingroup multimedia_audio - \brief The QAudioBuffer class represents a collection of audio samples with a specific format and sample rate. + \brief The QAudioBuffer class represents a collection of audio samples with a specific format + and sample rate. - QAudioBuffer is used by the QAudioDecoder class to hand decoded audio data over to the application. An audio buffer - contains data in a certain QAudioFormat that can be queried using format(). It is also tagged with timing and duration - information. + QAudioBuffer is used by the QAudioDecoder class to hand decoded audio data over to the + application. An audio buffer contains data in a certain QAudioFormat that can be queried using + format(). It is also tagged with timing and duration information. To access the data stored inside the buffer, use the data() or constData() methods. @@ -140,6 +103,12 @@ QAudioBuffer::QAudioBuffer(int numFrames, const QAudioFormat &format, qint64 sta */ /*! + \fn void QAudioBuffer::swap(QAudioBuffer &other) noexcept + + Swaps the audio buffer with \a other. +*/ + +/*! \fn QAudioBuffer &QAudioBuffer::operator=(QAudioBuffer &&other) Moves \a other into this QAudioBuffer. @@ -148,7 +117,7 @@ QAudioBuffer::QAudioBuffer(int numFrames, const QAudioFormat &format, qint64 sta /*! Assigns the \a other buffer to this. */ -QAudioBuffer &QAudioBuffer::operator =(const QAudioBuffer &other) = default; +QAudioBuffer &QAudioBuffer::operator=(const QAudioBuffer &other) = default; /*! Destroys this audio buffer. @@ -245,15 +214,15 @@ qint64 QAudioBuffer::startTime() const noexcept } /*! + \fn template <typename T> const T* QAudioBuffer::constData() const + Returns a pointer to this buffer's data. You can only read it. This method is preferred over the const version of \l data() to prevent unnecessary copying. - There is also a templatized version of this constData() function that - allows you to retrieve a specific type of read-only pointer to - the data. Note that there is no checking done on the format of - the audio buffer - this is simply a convenience function. + Note that there is no checking done on the format of the audio + buffer - this is simply a convenience function. \code // With a 16bit sample buffer: @@ -261,7 +230,8 @@ qint64 QAudioBuffer::startTime() const noexcept \endcode */ -const void* QAudioBuffer::constData() const noexcept + +const void *QAudioBuffer::constData() const noexcept { if (!d) return nullptr; @@ -269,14 +239,14 @@ const void* QAudioBuffer::constData() const noexcept } /*! + \fn template <typename T> const T* QAudioBuffer::data() const + Returns a pointer to this buffer's data. You can only read it. You should use the \l constData() function rather than this to prevent accidental deep copying. - There is also a templatized version of this data() function that - allows you to retrieve a specific type of read-only pointer to - the data. Note that there is no checking done on the format of + Note that there is no checking done on the format of the audio buffer - this is simply a convenience function. \code @@ -284,36 +254,32 @@ const void* QAudioBuffer::constData() const noexcept const quint16 *data = buffer->data<quint16>(); \endcode */ -const void* QAudioBuffer::data() const noexcept + +const void *QAudioBuffer::data() const noexcept { if (!d) return nullptr; return d->data.constData(); } - -/* - Template data/constData functions caused override problems with qdoc, - so moved their docs into the non template versions. -*/ - /*! + \fn template <typename T> T* QAudioBuffer::data() + Returns a pointer to this buffer's data. You can modify the data through the returned pointer. Since QAudioBuffer objects are explicitly shared, you should usually call detach() before modifying the data through this function. - There is also a templatized version of data() allows you to retrieve - a specific type of pointer to the data. Note that there is no - checking done on the format of the audio buffer - this is - simply a convenience function. + Note that there is no checking done on the format of the audio + buffer - this is simply a convenience function. \code // With a 16bit sample buffer: quint16 *data = buffer->data<quint16>(); // May cause deep copy \endcode */ + void *QAudioBuffer::data() { if (!d) @@ -328,4 +294,33 @@ void *QAudioBuffer::data() channel is a \e {signed short}. */ +/*! + \typedef QAudioBuffer::U8M + + This is a predefined specialization for an unsigned 8 bit mono sample. +*/ +/*! + \typedef QAudioBuffer::S16M + This is a predefined specialization for a signed 16 bit mono sample. +i*/ +/*! + \typedef QAudioBuffer::S32M + This is a predefined specialization for a signed 32 bit mono sample. +*/ +/*! + \typedef QAudioBuffer::F32M + This is a predefined specialization for a 32 bit float mono sample. +*/ +/*! + \typedef QAudioBuffer::U8S + This is a predifined specialization for an unsiged 8 bit stereo sample. +*/ +/*! + \typedef QAudioBuffer::S32S + This is a predifined specialization for a siged 32 bit stereo sample. +*/ +/*! + \typedef QAudioBuffer::F32S + This is a predifined specialization for a 32 bit float stereo sample. +*/ QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiobuffer.h b/src/multimedia/audio/qaudiobuffer.h index 624c8aabe..822619f31 100644 --- a/src/multimedia/audio/qaudiobuffer.h +++ b/src/multimedia/audio/qaudiobuffer.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOBUFFER_H #define QAUDIOBUFFER_H @@ -44,7 +8,7 @@ #include <QtMultimedia/qtmultimediaglobal.h> -#include <QtMultimedia/qaudio.h> +#include <QtMultimedia/qtaudio.h> #include <QtMultimedia/qaudioformat.h> QT_BEGIN_NAMESPACE diff --git a/src/multimedia/audio/qaudiobufferinput.cpp b/src/multimedia/audio/qaudiobufferinput.cpp new file mode 100644 index 000000000..e43066f10 --- /dev/null +++ b/src/multimedia/audio/qaudiobufferinput.cpp @@ -0,0 +1,184 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#include "qaudiobufferinput.h" +#include "qplatformaudiobufferinput_p.h" +#include "qmediainputencoderinterface_p.h" +#include "qmediaframeinput_p.h" + +QT_BEGIN_NAMESPACE + +class QAudioBufferInputPrivate : public QMediaFrameInputPrivate +{ +public: + QAudioBufferInputPrivate(QAudioBufferInput *q) : q(q) { } + + bool sendAudioBuffer(const QAudioBuffer &audioBuffer) + { + return sendMediaFrame( + [&]() { emit m_platfromAudioBufferInput->newAudioBuffer(audioBuffer); }); + } + + void initialize(const QAudioFormat &format = {}) + { + m_platfromAudioBufferInput = std::make_unique<QPlatformAudioBufferInput>(format); + addUpdateSignal(m_platfromAudioBufferInput.get(), + &QPlatformAudioBufferInput::encoderUpdated); + } + + void uninitialize() + { + m_platfromAudioBufferInput.reset(); + + if (captureSession()) + captureSession()->setAudioBufferInput(nullptr); + } + + QMediaCaptureSession *session() const { return m_captureSession; } + + QPlatformAudioBufferInput *platfromAudioBufferInput() const + { + return m_platfromAudioBufferInput.get(); + } + +private: + void updateCaptureSessionConnections(QMediaCaptureSession *prevSession, + QMediaCaptureSession *newSession) override + { + if (prevSession) + removeUpdateSignal(prevSession, &QMediaCaptureSession::audioOutputChanged); + + if (newSession) + addUpdateSignal(newSession, &QMediaCaptureSession::audioOutputChanged); + } + + bool checkIfCanSendMediaFrame() const override + { + if (auto encoderInterface = m_platfromAudioBufferInput->encoderInterface()) + return encoderInterface->canPushFrame(); + + // Not implemented yet + // return captureSession()->audioOutput() != nullptr; + return false; + } + + void emitReadyToSendMediaFrame() override { emit q->readyToSendAudioBuffer(); } + +private: + QAudioBufferInput *q = nullptr; + QMediaCaptureSession *m_captureSession = nullptr; + std::unique_ptr<QPlatformAudioBufferInput> m_platfromAudioBufferInput; +}; + +/*! + \class QAudioBufferInput + \inmodule QtMultimedia + \ingroup multimedia + \ingroup multimedia_audio + \since 6.8 + + \brief The QAudioBufferInput class is used for providing custom audio buffers + to \l QMediaRecorder through \l QMediaCaptureSession. + + \sa QMediaRecorder, QMediaCaptureSession +*/ + +/*! + Constructs a new QAudioBufferInput object with \a parent. +*/ +QAudioBufferInput::QAudioBufferInput(QObject *parent) : QAudioBufferInput({}, parent) { } + +/*! + Constructs a new QAudioBufferInput object with audio \a format and \a parent. + + The specified \a format will work as a hint for the initialization of the matching + audio encoder upon invoking \l QMediaRecorder::record(). + If the format is not specified or not valid, the audio encoder will be initialized + upon sending the first audio buffer. + + We recommend specifying the format if you know in advance what kind of audio buffers + you're going to send. +*/ +QAudioBufferInput::QAudioBufferInput(const QAudioFormat &format, QObject *parent) + : QObject(*new QAudioBufferInputPrivate(this), parent) +{ + Q_D(QAudioBufferInput); + d->initialize(format); +} + +/*! + Destroys the object. + */ +QAudioBufferInput::~QAudioBufferInput() +{ + Q_D(QAudioBufferInput); + d->uninitialize(); +} + +/*! + Sends \l QAudioBuffer to \l QMediaRecorder through \l QMediaCaptureSession. + + Returns \c true if the specified \a audioBuffer has been sent successfully + to the destination. Returns \c false, if the buffer hasn't been sent, + which can happen if the instance is not assigned to + \l QMediaCaptureSession, the session doesn't have a media recorder, + the media recorder is not started or its queue is full. + The \l readyToSendAudioBuffer() signal will be emitted as soon as + the destination is able to handle a new audio buffer. + + Sending of an empty audio buffer is treated by \l QMediaRecorder + as an end of the input stream. QMediaRecorder stops the recording + automatically if \l QMediaRecorder::autoStop is \c true and + all the inputs have reported the end of the stream. +*/ +bool QAudioBufferInput::sendAudioBuffer(const QAudioBuffer &audioBuffer) +{ + Q_D(QAudioBufferInput); + return d->sendAudioBuffer(audioBuffer); +} + +/*! + Returns the audio format that was specified upon construction of the audio buffer input. +*/ +QAudioFormat QAudioBufferInput::format() const +{ + Q_D(const QAudioBufferInput); + return d->platfromAudioBufferInput()->audioFormat(); +} + +/*! + Returns the capture session this audio buffer input is connected to, or + a \c nullptr if the audio buffer input is not connected to a capture session. + + Use QMediaCaptureSession::setAudioBufferInput() to connect + the audio buffer input to a session. +*/ +QMediaCaptureSession *QAudioBufferInput::captureSession() const +{ + Q_D(const QAudioBufferInput); + return d->captureSession(); +} + +void QAudioBufferInput::setCaptureSession(QMediaCaptureSession *captureSession) +{ + Q_D(QAudioBufferInput); + d->setCaptureSession(captureSession); +} + +QPlatformAudioBufferInput *QAudioBufferInput::platformAudioBufferInput() const +{ + Q_D(const QAudioBufferInput); + return d->platfromAudioBufferInput(); +} + +/*! + \fn void QAudioBufferInput::readyToSendAudioBuffer() + + Signals that a new audio buffer can be sent to the audio buffer input. + After receiving the signal, if you have audio date to be sent, invoke \l sendAudioBuffer + once or in a loop until it returns \c false. + + \sa sendAudioBuffer() +*/ + +QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiobufferinput.h b/src/multimedia/audio/qaudiobufferinput.h new file mode 100644 index 000000000..f48db186a --- /dev/null +++ b/src/multimedia/audio/qaudiobufferinput.h @@ -0,0 +1,48 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QAUDIOBUFFERINPUT_H +#define QAUDIOBUFFERINPUT_H + +#include <QtMultimedia/qtmultimediaexports.h> +#include <QtMultimedia/qaudiobuffer.h> +#include <QtCore/qobject.h> + +QT_BEGIN_NAMESPACE + +class QPlatformAudioBufferInput; +class QAudioBufferInputPrivate; +class QMediaCaptureSession; + +class Q_MULTIMEDIA_EXPORT QAudioBufferInput : public QObject +{ + Q_OBJECT +public: + explicit QAudioBufferInput(QObject *parent = nullptr); + + explicit QAudioBufferInput(const QAudioFormat &format, QObject *parent = nullptr); + + ~QAudioBufferInput() override; + + bool sendAudioBuffer(const QAudioBuffer &audioBuffer); + + QAudioFormat format() const; + + QMediaCaptureSession *captureSession() const; + +Q_SIGNALS: + void readyToSendAudioBuffer(); + +private: + void setCaptureSession(QMediaCaptureSession *captureSession); + + QPlatformAudioBufferInput *platformAudioBufferInput() const; + + friend class QMediaCaptureSession; + Q_DISABLE_COPY(QAudioBufferInput) + Q_DECLARE_PRIVATE(QAudioBufferInput) +}; + +QT_END_NAMESPACE + +#endif // QAUDIOBUFFERINPUT_H diff --git a/src/multimedia/audio/qaudiobufferoutput.cpp b/src/multimedia/audio/qaudiobufferoutput.cpp new file mode 100644 index 000000000..50389c49a --- /dev/null +++ b/src/multimedia/audio/qaudiobufferoutput.cpp @@ -0,0 +1,78 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#include "qaudiobufferoutput_p.h" +#include "qmediaplayer.h" + +QT_BEGIN_NAMESPACE + +/*! + \class QAudioBufferOutput + \inmodule QtMultimedia + \ingroup multimedia + \ingroup multimedia_audio + \since 6.8 + + \brief The QAudioBufferOutput class is used for capturing audio data provided by \l QMediaPlayer. + + QAudioBufferOutput can be set to QMediaPlayer in order to receive audio buffers + decoded by the media player. The received audio data can be used for any + processing or visualization. + + \sa QMediaPlayer, QMediaPlayer::setAudioBufferOutput, QAudioBuffer +*/ + +/*! + Constructs a new QAudioBufferOutput object with \a parent. + + The audio format of output audio buffers will depend on + the source media file and the inner audio decoder in \l QMediaPlayer. +*/ +QAudioBufferOutput::QAudioBufferOutput(QObject *parent) + : QObject(*new QAudioBufferOutputPrivate, parent) +{ +} + +/*! + Constructs a new QAudioBufferOutput object with audio \a format and \a parent. + + If the specified \a format is valid, it will be the format of output + audio buffers. Otherwise, the format of output audio buffers + will depend on the source media file and the inner audio decoder in \l QMediaPlayer. +*/ +QAudioBufferOutput::QAudioBufferOutput(const QAudioFormat &format, QObject *parent) + : QObject(*new QAudioBufferOutputPrivate(format), parent) +{ +} + +/*! + Destroys the audio buffer output object. +*/ +QAudioBufferOutput::~QAudioBufferOutput() +{ + Q_D(QAudioBufferOutput); + + if (d->mediaPlayer) + d->mediaPlayer->setAudioBufferOutput(nullptr); +} + +/*! + Gets the audio format specified in the constructor. + + If the format is valid, it specifies the format of output oudio buffers. +*/ +QAudioFormat QAudioBufferOutput::format() const +{ + Q_D(const QAudioBufferOutput); + return d->format; +} + +/*! + \fn void QAudioBufferOutput::audioBufferReceived(const QAudioBuffer &buffer) + + Signals that a new audio \a buffer has been received from \l QMediaPlayer. +*/ + +QT_END_NAMESPACE + +#include "moc_qaudiobufferoutput.cpp" diff --git a/src/multimedia/audio/qaudiobufferoutput.h b/src/multimedia/audio/qaudiobufferoutput.h new file mode 100644 index 000000000..2e4fab1a4 --- /dev/null +++ b/src/multimedia/audio/qaudiobufferoutput.h @@ -0,0 +1,37 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QAUDIOBUFFEROUTPUT_H +#define QAUDIOBUFFEROUTPUT_H + +#include <QtMultimedia/qtmultimediaexports.h> +#include <QtMultimedia/qaudiobuffer.h> +#include <QtCore/qobject.h> + +QT_BEGIN_NAMESPACE + +class QAudioBufferOutputPrivate; + +class Q_MULTIMEDIA_EXPORT QAudioBufferOutput : public QObject +{ + Q_OBJECT +public: + explicit QAudioBufferOutput(QObject *parent = nullptr); + + explicit QAudioBufferOutput(const QAudioFormat &format, QObject *parent = nullptr); + + ~QAudioBufferOutput() override; + + QAudioFormat format() const; + +Q_SIGNALS: + void audioBufferReceived(const QAudioBuffer &buffer); + +private: + Q_DISABLE_COPY(QAudioBufferOutput) + Q_DECLARE_PRIVATE(QAudioBufferOutput) +}; + +QT_END_NAMESPACE + +#endif // QAUDIOBUFFEROUTPUT_H diff --git a/src/multimedia/audio/qaudiobufferoutput_p.h b/src/multimedia/audio/qaudiobufferoutput_p.h new file mode 100644 index 000000000..2f9c11bd1 --- /dev/null +++ b/src/multimedia/audio/qaudiobufferoutput_p.h @@ -0,0 +1,42 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QAUDIOBUFFEROUTPUT_P_H +#define QAUDIOBUFFEROUTPUT_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include <QtCore/private/qobject_p.h> +#include "qaudiobufferoutput.h" + +QT_BEGIN_NAMESPACE + +class QMediaPlayer; + +class QAudioBufferOutputPrivate : public QObjectPrivate +{ +public: + QAudioBufferOutputPrivate(const QAudioFormat &format = {}) : format(std::move(format)) { } + + static QMediaPlayer *exchangeMediaPlayer(QAudioBufferOutput &output, QMediaPlayer *player) + { + auto outputPrivate = static_cast<QAudioBufferOutputPrivate *>(output.d_func()); + return std::exchange(outputPrivate->mediaPlayer, player); + } + + QAudioFormat format; + QMediaPlayer *mediaPlayer = nullptr; +}; + +QT_END_NAMESPACE + +#endif // QAUDIOBUFFEROUTPUT_P_H diff --git a/src/multimedia/audio/qaudiodecoder.cpp b/src/multimedia/audio/qaudiodecoder.cpp index e0587d31a..f555f46ed 100644 --- a/src/multimedia/audio/qaudiodecoder.cpp +++ b/src/multimedia/audio/qaudiodecoder.cpp @@ -1,56 +1,19 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include "qtmultimediaglobal_p.h" -#include "qaudiodecoder.h" +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only -#include "private/qplatformaudiodecoder_p.h" +#include "qaudiodecoder.h" +#include <private/qaudiodecoder_p.h> +#include <private/qmultimediautils_p.h> +#include <private/qplatformaudiodecoder_p.h> #include <private/qplatformmediaintegration_p.h> -#include <private/qobject_p.h> #include <QtCore/qcoreevent.h> +#include <QtCore/qdebug.h> #include <QtCore/qmetaobject.h> +#include <QtCore/qpointer.h> #include <QtCore/qtimer.h> #include <QtCore/qurl.h> -#include <QtCore/qdebug.h> -#include <QtCore/qpointer.h> QT_BEGIN_NAMESPACE @@ -74,12 +37,19 @@ QT_BEGIN_NAMESPACE /*! Construct an QAudioDecoder instance with \a parent. */ -QAudioDecoder::QAudioDecoder(QObject *parent) - : QObject(parent) +QAudioDecoder::QAudioDecoder(QObject *parent) : QObject{ *new QAudioDecoderPrivate, parent } { - decoder = QPlatformMediaIntegration::instance()->createAudioDecoder(this); -} + QT6_ONLY(Q_UNUSED(unused)) + + Q_D(QAudioDecoder); + auto maybeDecoder = QPlatformMediaIntegration::instance()->createAudioDecoder(this); + if (maybeDecoder) { + d->decoder.reset(maybeDecoder.value()); + } else { + qWarning() << "Failed to initialize QAudioDecoder" << maybeDecoder.error(); + } +} /*! Destroys the audio decoder object. @@ -91,7 +61,9 @@ QAudioDecoder::~QAudioDecoder() = default; */ bool QAudioDecoder::isSupported() const { - return decoder != nullptr; + Q_D(const QAudioDecoder); + + return bool(d->decoder); } /*! @@ -100,29 +72,33 @@ bool QAudioDecoder::isSupported() const */ bool QAudioDecoder::isDecoding() const { - return decoder && decoder->isDecoding(); + Q_D(const QAudioDecoder); + + return d->decoder && d->decoder->isDecoding(); } /*! - \property QAudioDecoder::error - \brief The current error state. + + Returns the current error state of the QAudioDecoder. */ QAudioDecoder::Error QAudioDecoder::error() const { - if (!decoder) - return NotSupportedError; - return decoder->error(); + Q_D(const QAudioDecoder); + return d->decoder ? d->decoder->error() : NotSupportedError; } /*! + \property QAudioDecoder::error + Returns a human readable description of the current error, or an empty string is there is no error. */ QString QAudioDecoder::errorString() const { - if (!decoder) + Q_D(const QAudioDecoder); + if (!d->decoder) return tr("QAudioDecoder not supported."); - return decoder->errorString(); + return d->decoder->errorString(); } /*! @@ -139,13 +115,14 @@ QString QAudioDecoder::errorString() const */ void QAudioDecoder::start() { - if (decoder == nullptr) + Q_D(QAudioDecoder); + + if (!d->decoder) return; // Reset error conditions - decoder->clearError(); - - decoder->start(); + d->decoder->clearError(); + d->decoder->start(); } /*! @@ -153,10 +130,10 @@ void QAudioDecoder::start() */ void QAudioDecoder::stop() { - if (!decoder) - return; + Q_D(QAudioDecoder); - decoder->stop(); + if (d->decoder) + d->decoder->stop(); } /*! @@ -166,9 +143,8 @@ void QAudioDecoder::stop() */ QUrl QAudioDecoder::source() const { - if (decoder) - return decoder->source(); - return QString(); + Q_D(const QAudioDecoder); + return d->unresolvedUrl; } /*! @@ -182,11 +158,16 @@ QUrl QAudioDecoder::source() const */ void QAudioDecoder::setSource(const QUrl &fileName) { - if (!decoder) + Q_D(QAudioDecoder); + + if (!d->decoder) return; - decoder->clearError(); - decoder->setSource(fileName); + d->decoder->clearError(); + d->unresolvedUrl = fileName; + d->decoder->setSourceDevice(nullptr); + QUrl url = qMediaFromUserInput(fileName); + d->decoder->setSource(url); } /*! @@ -195,9 +176,8 @@ void QAudioDecoder::setSource(const QUrl &fileName) */ QIODevice *QAudioDecoder::sourceDevice() const { - if (decoder) - return decoder->sourceDevice(); - return nullptr; + Q_D(const QAudioDecoder); + return d->decoder ? d->decoder->sourceDevice() : nullptr; } /*! @@ -211,9 +191,11 @@ QIODevice *QAudioDecoder::sourceDevice() const */ void QAudioDecoder::setSourceDevice(QIODevice *device) { - if (!decoder) - return; - decoder->setSourceDevice(device); + Q_D(QAudioDecoder); + if (d->decoder) { + d->unresolvedUrl = QUrl{}; + d->decoder->setSourceDevice(device); + } } /*! @@ -226,9 +208,8 @@ void QAudioDecoder::setSourceDevice(QIODevice *device) */ QAudioFormat QAudioDecoder::audioFormat() const { - if (decoder) - return decoder->audioFormat(); - return QAudioFormat(); + Q_D(const QAudioDecoder); + return d->decoder ? d->decoder->audioFormat() : QAudioFormat{}; } /*! @@ -248,15 +229,18 @@ QAudioFormat QAudioDecoder::audioFormat() const audio file, you can specify an invalid \a format. \warning Setting a desired audio format is not yet supported - on Android. + on the Android backend. It does work with the default FFMPEG + backend. */ void QAudioDecoder::setAudioFormat(const QAudioFormat &format) { if (isDecoding()) return; - if (decoder != nullptr) - decoder->setAudioFormat(format); + Q_D(QAudioDecoder); + + if (d->decoder) + d->decoder->setAudioFormat(format); } /*! @@ -266,9 +250,8 @@ void QAudioDecoder::setAudioFormat(const QAudioFormat &format) */ bool QAudioDecoder::bufferAvailable() const { - if (decoder) - return decoder->bufferAvailable(); - return false; + Q_D(const QAudioDecoder); + return d->decoder && d->decoder->bufferAvailable(); } /*! @@ -278,9 +261,8 @@ bool QAudioDecoder::bufferAvailable() const qint64 QAudioDecoder::position() const { - if (decoder) - return decoder->position(); - return -1; + Q_D(const QAudioDecoder); + return d->decoder ? d->decoder->position() : -1; } /*! @@ -290,9 +272,8 @@ qint64 QAudioDecoder::position() const qint64 QAudioDecoder::duration() const { - if (decoder) - return decoder->duration(); - return -1; + Q_D(const QAudioDecoder); + return d->decoder ? d->decoder->duration() : -1; } /*! @@ -307,10 +288,8 @@ qint64 QAudioDecoder::duration() const QAudioBuffer QAudioDecoder::read() const { - if (decoder) - return decoder->read(); - - return QAudioBuffer(); + Q_D(const QAudioDecoder); + return d->decoder ? d->decoder->read() : QAudioBuffer{}; } // Enums @@ -328,7 +307,7 @@ QAudioBuffer QAudioDecoder::read() const // Signals /*! - \fn QAudioDecoder::error(QAudioDecoder::Error error) + \fn void QAudioDecoder::error(QAudioDecoder::Error error) Signals that an \a error condition has occurred. @@ -394,7 +373,6 @@ QAudioBuffer QAudioDecoder::read() const \sa positionChanged() */ - // Properties /*! \property QAudioDecoder::source diff --git a/src/multimedia/audio/qaudiodecoder.h b/src/multimedia/audio/qaudiodecoder.h index 451c3a657..9044b6617 100644 --- a/src/multimedia/audio/qaudiodecoder.h +++ b/src/multimedia/audio/qaudiodecoder.h @@ -1,53 +1,16 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIODECODER_H #define QAUDIODECODER_H #include <QtCore/qobject.h> #include <QtMultimedia/qmediaenumdebug.h> - #include <QtMultimedia/qaudiobuffer.h> QT_BEGIN_NAMESPACE -class QPlatformAudioDecoder; +class QAudioDecoderPrivate; class Q_MULTIMEDIA_EXPORT QAudioDecoder : public QObject { Q_OBJECT @@ -112,7 +75,10 @@ Q_SIGNALS: private: Q_DISABLE_COPY(QAudioDecoder) - QPlatformAudioDecoder *decoder; + Q_DECLARE_PRIVATE(QAudioDecoder) + + // ### Qt7: remove unused member + QT6_ONLY(void *unused = nullptr;) // for ABI compatibility }; QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiodecoder_p.h b/src/multimedia/audio/qaudiodecoder_p.h new file mode 100644 index 000000000..fa7311457 --- /dev/null +++ b/src/multimedia/audio/qaudiodecoder_p.h @@ -0,0 +1,40 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QAUDIODECODER_P_H +#define QAUDIODECODER_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include <QtCore/private/qobject_p.h> +#include <QtMultimedia/private/qplatformaudiodecoder_p.h> + +#include <memory.h> + +QT_BEGIN_NAMESPACE + +class QAudioDecoder; + +class QAudioDecoderPrivate : public QObjectPrivate +{ + Q_DECLARE_PUBLIC(QAudioDecoder) + +public: + QAudioDecoderPrivate() = default; + + QUrl unresolvedUrl; + std::unique_ptr<QPlatformAudioDecoder> decoder; +}; + +QT_END_NAMESPACE + +#endif // QAUDIODECODER_P_H diff --git a/src/multimedia/audio/qaudiodevice.cpp b/src/multimedia/audio/qaudiodevice.cpp index 5d06cdbe0..4b1e182cb 100644 --- a/src/multimedia/audio/qaudiodevice.cpp +++ b/src/multimedia/audio/qaudiodevice.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qaudiosystem_p.h" #include "qaudiodevice_p.h" @@ -52,12 +16,14 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QAudioDevicePrivate); /*! \class QAudioDevice - \brief The QAudioDevice class provides an information about audio devices and their functionality. + \brief The QAudioDevice class provides an information about audio devices and their + functionality. \inmodule QtMultimedia \ingroup multimedia \ingroup multimedia_audio - QAudioDevice describes an audio device available in the system, either for input or for playback. + QAudioDevice describes an audio device available in the system, either for input or for + playback. A QAudioDevice is used by Qt to construct classes that communicate with the device -- such as @@ -87,7 +53,7 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QAudioDevicePrivate); sound, i.e., play an audio stream in a supported format. For each device we find, we simply print the deviceName(). - \sa QAudioSink, QAudioSource QAudioFormat + \sa QAudioSink, QAudioSource, QAudioFormat */ /*! @@ -127,14 +93,18 @@ QAudioDevice::QAudioDevice() = default; /*! Constructs a copy of \a other. */ -QAudioDevice::QAudioDevice(const QAudioDevice& other) = default; +QAudioDevice::QAudioDevice(const QAudioDevice &other) = default; /*! \fn QAudioDevice::QAudioDevice(QAudioDevice &&other) Move constructs from \a other. */ +/*! + \fn void QAudioDevice::swap(QAudioDevice &other) noexcept + Swaps the audio device with the \a other. +*/ /*! Destroy this audio device info. */ @@ -143,7 +113,7 @@ QAudioDevice::~QAudioDevice() = default; /*! Sets the QAudioDevice object to be equal to \a other. */ -QAudioDevice& QAudioDevice::operator=(const QAudioDevice &other) = default; +QAudioDevice &QAudioDevice::operator=(const QAudioDevice &other) = default; /*! \fn QAudioDevice& QAudioDevice::operator=(QAudioDevice &&other) @@ -155,13 +125,13 @@ QAudioDevice& QAudioDevice::operator=(const QAudioDevice &other) = default; Returns true if this QAudioDevice class represents the same audio device as \a other. */ -bool QAudioDevice::operator ==(const QAudioDevice &other) const +bool QAudioDevice::operator==(const QAudioDevice &other) const { if (d == other.d) return true; if (!d || !other.d) return false; - if (d->mode == other.d->mode && d->id == other.d->id) + if (d->mode == other.d->mode && d->id == other.d->id && d->isDefault == other.d->isDefault) return true; return false; } @@ -170,7 +140,7 @@ bool QAudioDevice::operator ==(const QAudioDevice &other) const Returns true if this QAudioDevice class represents a different audio device than \a other */ -bool QAudioDevice::operator !=(const QAudioDevice &other) const +bool QAudioDevice::operator!=(const QAudioDevice &other) const { return !operator==(other); } @@ -194,6 +164,8 @@ bool QAudioDevice::isNull() const */ /*! + \property QAudioDevice::id + Returns an identifier for the audio device. Device names vary depending on the platform/audio plugin being used. @@ -214,6 +186,8 @@ QByteArray QAudioDevice::id() const */ /*! + \property QAudioDevice::description + Returns a human readable name of the audio device. Use this string to present the device to the user. @@ -230,6 +204,8 @@ QString QAudioDevice::description() const */ /*! + \property QAudioDevice::isDefault + Returns true if this is the default audio device. */ bool QAudioDevice::isDefault() const @@ -245,9 +221,11 @@ bool QAudioDevice::isFormatSupported(const QAudioFormat &settings) const { if (isNull()) return false; - if (settings.sampleRate() < d->minimumSampleRate || settings.sampleRate() > d->maximumSampleRate) + if (settings.sampleRate() < d->minimumSampleRate + || settings.sampleRate() > d->maximumSampleRate) return false; - if (settings.channelCount() < d->minimumChannelCount || settings.channelCount() > d->maximumChannelCount) + if (settings.channelCount() < d->minimumChannelCount + || settings.channelCount() > d->maximumChannelCount) return false; if (!d->supportedSampleFormats.contains(settings.sampleFormat())) return false; @@ -259,7 +237,7 @@ bool QAudioDevice::isFormatSupported(const QAudioFormat &settings) const These settings are provided by the platform/audio plugin being used. - They are also dependent on the \l {QAudio}::Mode being used. + They are also dependent on the \l {QtAudio}::Mode being used. A typical audio system would provide something like: \list @@ -325,16 +303,18 @@ QAudioFormat::ChannelConfig QAudioDevice::channelConfiguration() const } /*! + \fn QAudioDevicePrivate QAudioDevice::handle() const \internal */ -QAudioDevice::QAudioDevice(QAudioDevicePrivate *p) - : d(p) -{} +/*! + \internal +*/ +QAudioDevice::QAudioDevice(QAudioDevicePrivate *p) : d(p) { } /*! \enum QAudioDevice::Mode - Describes the mode of a QAudioDevice + Describes the mode of this device. \value Null A null device. @@ -359,7 +339,9 @@ QAudioDevice::QAudioDevice(QAudioDevicePrivate *p) */ /*! - returns whether this device is an input or output device. + \property QAudioDevice::mode + + Returns whether this device is an input or output device. */ QAudioDevice::Mode QAudioDevice::mode() const { @@ -387,3 +369,5 @@ QDebug operator<<(QDebug dbg, QAudioDevice::Mode mode) #endif QT_END_NAMESPACE + +#include "moc_qaudiodevice.cpp" diff --git a/src/multimedia/audio/qaudiodevice.h b/src/multimedia/audio/qaudiodevice.h index 3098c6df1..abd1b654c 100644 --- a/src/multimedia/audio/qaudiodevice.h +++ b/src/multimedia/audio/qaudiodevice.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIODEVICEINFO_H @@ -49,7 +13,7 @@ #include <QtMultimedia/qtmultimediaglobal.h> -#include <QtMultimedia/qaudio.h> +#include <QtMultimedia/qtaudio.h> #include <QtMultimedia/qaudioformat.h> QT_BEGIN_NAMESPACE diff --git a/src/multimedia/audio/qaudiodevice_p.h b/src/multimedia/audio/qaudiodevice_p.h index 3348e89e4..c59856d72 100644 --- a/src/multimedia/audio/qaudiodevice_p.h +++ b/src/multimedia/audio/qaudiodevice_p.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2022 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIODEVICEINFO_P_H @@ -65,7 +29,7 @@ public: mode(m) {} virtual ~QAudioDevicePrivate(); - QByteArray id; + QByteArray id; QAudioDevice::Mode mode = QAudioDevice::Output; bool isDefault = false; @@ -76,7 +40,19 @@ public: int minimumChannelCount = 0; int maximumChannelCount = 0; QList<QAudioFormat::SampleFormat> supportedSampleFormats; - QAudioFormat::ChannelConfig channelConfiguration; + QAudioFormat::ChannelConfig channelConfiguration = QAudioFormat::ChannelConfigUnknown; + + bool operator == (const QAudioDevicePrivate &other) const + { + return id == other.id && mode == other.mode && isDefault == other.isDefault + && preferredFormat == other.preferredFormat && description == other.description + && minimumSampleRate == other.minimumSampleRate + && maximumSampleRate == other.maximumSampleRate + && minimumChannelCount == other.minimumChannelCount + && maximumChannelCount == other.maximumChannelCount + && supportedSampleFormats == other.supportedSampleFormats + && channelConfiguration == other.channelConfiguration; + } QAudioDevice create() { return QAudioDevice(this); } }; diff --git a/src/multimedia/audio/qaudioformat.cpp b/src/multimedia/audio/qaudioformat.cpp index ecc1de1ff..9f51759b5 100644 --- a/src/multimedia/audio/qaudioformat.cpp +++ b/src/multimedia/audio/qaudioformat.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include <QDebug> #include <qaudioformat.h> #include <qalgorithms.h> @@ -117,9 +81,15 @@ QT_BEGIN_NAMESPACE */ /*! - \fn QAudioFormat& QAudioFormat::operator=(const QAudioFormat &other) + \fn bool QAudioFormat::operator==(const QAudioFormat &a, const QAudioFormat &b) - Assigns \a other to this QAudioFormat implementation. + Returns \c true if audio format \a a is equal to \a b, otherwise returns \c false. +*/ + +/*! + \fn bool QAudioFormat::operator!=(const QAudioFormat &a, const QAudioFormat &b) + + Returns \c true if audio format \a a is not equal to \a b, otherwise returns \c false. */ /*! @@ -172,7 +142,10 @@ QT_BEGIN_NAMESPACE \value BottomFrontLeft \value BottomFrontRight */ - +/*! + \variable QAudioFormat::NChannelPositions + \internal +*/ /*! \enum QAudioFormat::ChannelConfig @@ -182,13 +155,22 @@ QT_BEGIN_NAMESPACE and 7.1 surround configurations. \value ChannelConfigUnknown The channel configuration is not known. - \value ChannelConfigMono The audio has one Center channel - \value ChannelConfigStereo The audio has two channels, Left and Right - \value ChannelConfig2Dot1 The audio has three channels, Left, Right and LFE (low frequency effect) - \value ChannelConfigSurround5Dot0 The audio has five channels, Left, Right, Center, BackLeft, BackRight - \value ChannelConfigSurround5Dot1 The audio has 6 channels, Left, Right, Center, LFE, BackLeft and BackRight - \value ChannelConfigSurround7Dot0 The audio has 7 channels, Left, Right, Center, BackLeft, BackRight, SideLeft and SideRight - \value ChannelConfigSurround7Dot1 The audio has 8 channels, Left, Right, Center, LFE, BackLeft, BackRight, SideLeft and SideRight + \value ChannelConfigMono The audio has one Center channel. + \value ChannelConfigStereo The audio has two channels, Left and Right. + \value ChannelConfig2Dot1 The audio has three channels, Left, Right and + LFE (low frequency effect). + \value ChannelConfig3Dot0 The audio has three channels, Left, Right, and + Center. + \value ChannelConfig3Dot1 The audio has four channels, Left, Right, Center, + and LFE (low frequency effect). + \value ChannelConfigSurround5Dot0 The audio has five channels, Left, Right, + Center, BackLeft, and BackRight. + \value ChannelConfigSurround5Dot1 The audio has 6 channels, Left, Right, + Center, LFE, BackLeft, and BackRight. + \value ChannelConfigSurround7Dot0 The audio has 7 channels, Left, Right, + Center, BackLeft, BackRight, SideLeft, and SideRight. + \value ChannelConfigSurround7Dot1 The audio has 8 channels, Left, Right, + Center, LFE, BackLeft, BackRight, SideLeft, and SideRight. */ /*! @@ -228,7 +210,11 @@ int QAudioFormat::channelOffset(AudioChannelPosition channel) const noexcept config to ChannelConfigUnknown. */ +/*! + \fn template <typename... Args> QAudioFormat::ChannelConfig QAudioFormat::channelConfig(Args... channels) + Returns the current channel configuration for the given \a channels. +*/ /*! \fn QAudioFormat::ChannelConfig QAudioFormat::channelConfig() const noexcept @@ -374,11 +360,15 @@ float QAudioFormat::normalizedSampleValue(const void *sample) const { switch (m_sampleFormat) { case UInt8: - return ((float)*reinterpret_cast<const quint8 *>(sample))/(float)std::numeric_limits<qint8>::max() - 1.; + return ((float)*reinterpret_cast<const quint8 *>(sample)) + / (float)std::numeric_limits<qint8>::max() + - 1.; case Int16: - return ((float)*reinterpret_cast<const qint16 *>(sample))/(float)std::numeric_limits<qint16>::max(); + return ((float)*reinterpret_cast<const qint16 *>(sample)) + / (float)std::numeric_limits<qint16>::max(); case Int32: - return ((float)*reinterpret_cast<const qint32 *>(sample))/(float)std::numeric_limits<qint32>::max(); + return ((float)*reinterpret_cast<const qint32 *>(sample)) + / (float)std::numeric_limits<qint32>::max(); case Float: return *reinterpret_cast<const float *>(sample); case Unknown: @@ -401,6 +391,9 @@ QAudioFormat::ChannelConfig QAudioFormat::defaultChannelConfigForChannelCount(in { QAudioFormat::ChannelConfig config; switch (channelCount) { + case 0: + config = QAudioFormat::ChannelConfigUnknown; + break; case 1: config = QAudioFormat::ChannelConfigMono; break; @@ -442,7 +435,7 @@ QAudioFormat::ChannelConfig QAudioFormat::defaultChannelConfigForChannelCount(in QAudioBuffer. \value Unknown Not Set - \value UInt8 Samples are unsigned 8 bit signed integers + \value UInt8 Samples are 8 bit unsigned integers \value Int16 Samples are 16 bit signed integers \value Int32 Samples are 32 bit signed integers \value Float Samples are floats @@ -476,12 +469,10 @@ QDebug operator<<(QDebug dbg, QAudioFormat::SampleFormat type) QDebug operator<<(QDebug dbg, const QAudioFormat &f) { - dbg << "QAudioFormat(" << f.sampleRate() << "Hz, " << f.channelCount() << "Channels, " << f.sampleFormat() << "Format )"; + dbg << "QAudioFormat(" << f.sampleRate() << "Hz, " << f.channelCount() << "Channels, " + << f.sampleFormat() << "Format )"; return dbg; } #endif - - QT_END_NAMESPACE - diff --git a/src/multimedia/audio/qaudioformat.h b/src/multimedia/audio/qaudioformat.h index b4cbb6428..a04ab6e1a 100644 --- a/src/multimedia/audio/qaudioformat.h +++ b/src/multimedia/audio/qaudioformat.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOFORMAT_H @@ -104,6 +68,8 @@ public: ChannelConfigMono = QtPrivate::channelConfig(FrontCenter), ChannelConfigStereo = QtPrivate::channelConfig(FrontLeft, FrontRight), ChannelConfig2Dot1 = QtPrivate::channelConfig(FrontLeft, FrontRight, LFE), + ChannelConfig3Dot0 = QtPrivate::channelConfig(FrontLeft, FrontRight, FrontCenter), + ChannelConfig3Dot1 = QtPrivate::channelConfig(FrontLeft, FrontRight, FrontCenter, LFE), ChannelConfigSurround5Dot0 = QtPrivate::channelConfig(FrontLeft, FrontRight, FrontCenter, BackLeft, BackRight), ChannelConfigSurround5Dot1 = QtPrivate::channelConfig(FrontLeft, FrontRight, FrontCenter, LFE, BackLeft, BackRight), ChannelConfigSurround7Dot0 = QtPrivate::channelConfig(FrontLeft, FrontRight, FrontCenter, BackLeft, BackRight, SideLeft, SideRight), diff --git a/src/multimedia/audio/qaudiohelpers.cpp b/src/multimedia/audio/qaudiohelpers.cpp index 1e7c4ac81..c2d8681c6 100644 --- a/src/multimedia/audio/qaudiohelpers.cpp +++ b/src/multimedia/audio/qaudiohelpers.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qaudiohelpers_p.h" @@ -60,7 +24,7 @@ template<class T> struct signedVersion {}; template<> struct signedVersion<quint8> { using TS = qint8; - enum {offset = 0x80}; + static constexpr int offset = 0x80; }; template<class T> void adjustUnsignedSamples(qreal factor, const void *src, void *dst, int samples) diff --git a/src/multimedia/audio/qaudiohelpers_p.h b/src/multimedia/audio/qaudiohelpers_p.h index 04896a2c3..81e6c6382 100644 --- a/src/multimedia/audio/qaudiohelpers_p.h +++ b/src/multimedia/audio/qaudiohelpers_p.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2022 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOHELPERS_H #define QAUDIOHELPERS_H diff --git a/src/multimedia/audio/qaudioinput.cpp b/src/multimedia/audio/qaudioinput.cpp index 8472ceb6c..dc7d7335f 100644 --- a/src/multimedia/audio/qaudioinput.cpp +++ b/src/multimedia/audio/qaudioinput.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include <qaudioinput.h> #include <qaudiodevice.h> @@ -69,10 +33,10 @@ } \endqml - You can use AudioInput together with a QtMultiMedia::CaptureSession to capture audio from an audio - input device. + You can use AudioInput together with a QtMultiMedia::CaptureSession to capture audio from an + audio input device. - \sa Camera AudioOutput + \sa Camera, AudioOutput */ /*! @@ -87,16 +51,22 @@ to be used, muting the channel, and changing the channel's volume. */ -QAudioInput::QAudioInput(QObject *parent) - : QAudioInput(QMediaDevices::defaultAudioInput(), parent) -{} +QAudioInput::QAudioInput(QObject *parent) : QAudioInput(QMediaDevices::defaultAudioInput(), parent) +{ +} QAudioInput::QAudioInput(const QAudioDevice &device, QObject *parent) - : QObject(parent), - d(QPlatformMediaIntegration::instance()->createAudioInput(this)) + : QObject(parent) { - d->device = device.mode() == QAudioDevice::Input ? device : QMediaDevices::defaultAudioInput(); - d->setAudioDevice(d->device); + auto maybeAudioInput = QPlatformMediaIntegration::instance()->createAudioInput(this); + if (maybeAudioInput) { + d = maybeAudioInput.value(); + d->device = device.mode() == QAudioDevice::Input ? device : QMediaDevices::defaultAudioInput(); + d->setAudioDevice(d->device); + } else { + d = new QPlatformAudioInput(nullptr); + qWarning() << "Failed to initialize QAudioInput" << maybeAudioInput.error(); + } } QAudioInput::~QAudioInput() @@ -116,7 +86,12 @@ QAudioInput::~QAudioInput() UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control. - \sa QAudio::convertVolume() + \sa QtAudio::convertVolume() +*/ +/*! + \property QAudioInput::volume + + The property returns the volume of the audio input. */ float QAudioInput::volume() const { diff --git a/src/multimedia/audio/qaudioinput.h b/src/multimedia/audio/qaudioinput.h index 95e337fe2..6f4f6b099 100644 --- a/src/multimedia/audio/qaudioinput.h +++ b/src/multimedia/audio/qaudioinput.h @@ -1,48 +1,12 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOINPUTDEVICE_H #define QAUDIOINPUTDEVICE_H #include <QtCore/qobject.h> #include <QtMultimedia/qtmultimediaglobal.h> -#include <QtMultimedia/qaudio.h> +#include <QtMultimedia/qtaudio.h> #include <functional> diff --git a/src/multimedia/audio/qaudiooutput.cpp b/src/multimedia/audio/qaudiooutput.cpp index 209ed63ca..3bb52a4d2 100644 --- a/src/multimedia/audio/qaudiooutput.cpp +++ b/src/multimedia/audio/qaudiooutput.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include <qaudiooutput.h> #include <qaudiodevice.h> @@ -67,10 +31,11 @@ } \endqml - You can use AudioOutput together with a QtMultiMedia::MediaPlayer to play audio content, or you can use it - in conjunction with a MultiMedia::CaptureSession to monitor the audio processed by the capture session. + You can use AudioOutput together with a QtMultiMedia::MediaPlayer to play audio content, or you + can use it in conjunction with a MultiMedia::CaptureSession to monitor the audio processed by the + capture session. - \sa VideoOutput AudioInput + \sa VideoOutput, AudioInput */ /*! @@ -88,14 +53,21 @@ */ QAudioOutput::QAudioOutput(QObject *parent) : QAudioOutput(QMediaDevices::defaultAudioOutput(), parent) -{} +{ +} QAudioOutput::QAudioOutput(const QAudioDevice &device, QObject *parent) - : QObject(parent), - d(QPlatformMediaIntegration::instance()->createAudioOutput(this)) + : QObject(parent) { - d->device = device.mode() == QAudioDevice::Output ? device : QMediaDevices::defaultAudioOutput(); - d->setAudioDevice(d->device); + auto maybeAudioOutput = QPlatformMediaIntegration::instance()->createAudioOutput(this); + if (maybeAudioOutput) { + d = maybeAudioOutput.value(); + d->device = device.mode() == QAudioDevice::Output ? device : QMediaDevices::defaultAudioOutput(); + d->setAudioDevice(d->device); + } else { + d = new QPlatformAudioOutput(nullptr); + qWarning() << "Failed to initialize QAudioOutput" << maybeAudioOutput.error(); + } } QAudioOutput::~QAudioOutput() @@ -104,7 +76,6 @@ QAudioOutput::~QAudioOutput() delete d; } - /*! \qmlproperty real QtMultimedia::AudioOutput::volume @@ -120,7 +91,7 @@ QAudioOutput::~QAudioOutput() using a logarithmic scale will produce linear changes in perceived \l{loudness}, which is what a user would normally expect from a volume control. - See \l {QAudio::convertVolume()}{QtMultimedia.convertVolume()} + See \l {QtAudio::convertVolume()}{QtMultimedia.convertVolume()} for more details. */ @@ -138,7 +109,7 @@ QAudioOutput::~QAudioOutput() using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control. - \sa QAudio::convertVolume() + \sa QtAudio::convertVolume() */ float QAudioOutput::volume() const { @@ -235,5 +206,4 @@ void QAudioOutput::setDisconnectFunction(std::function<void()> disconnectFunctio d->disconnectFunction = std::move(disconnectFunction); } - #include "moc_qaudiooutput.cpp" diff --git a/src/multimedia/audio/qaudiooutput.h b/src/multimedia/audio/qaudiooutput.h index cfb3d65d2..643d19f94 100644 --- a/src/multimedia/audio/qaudiooutput.h +++ b/src/multimedia/audio/qaudiooutput.h @@ -1,48 +1,12 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOOUTPUTDEVICE_H #define QAUDIOOUTPUTDEVICE_H #include <QtCore/qobject.h> #include <QtMultimedia/qtmultimediaglobal.h> -#include <QtMultimedia/qaudio.h> +#include <QtMultimedia/qtaudio.h> #include <functional> diff --git a/src/multimedia/audio/qaudiosink.cpp b/src/multimedia/audio/qaudiosink.cpp index 15d865996..12263d32a 100644 --- a/src/multimedia/audio/qaudiosink.cpp +++ b/src/multimedia/audio/qaudiosink.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qaudio.h" @@ -81,21 +45,22 @@ QT_BEGIN_NAMESPACE After the file has finished playing, we need to stop the device: - \snippet multimedia-snippets/audio.cpp Audio output state changed + \snippet multimedia-snippets/audio.cpp Audio output stop At any given time, the QAudioSink will be in one of four states: active, suspended, stopped, or idle. These states are described - by the QAudio::State enum. + by the QtAudio::State enum. State changes are reported through the stateChanged() signal. You can use this signal to, for instance, update the GUI of the application; the mundane example here being changing the state of a \c { play/pause } button. You request a state change directly with suspend(), stop(), reset(), resume(), and start(). - If an error occurs, you can fetch the \l{QAudio::Error}{error - type} with the error() function. Please see the QAudio::Error enum - for a description of the possible errors that are reported. When - an error is encountered, the state changes to QAudio::StoppedState. + If an error occurs, you can fetch the \l{QtAudio::Error}{error + type} with the error() function. Please see the QtAudio::Error enum + for a description of the possible errors that are reported. When + QtAudio::UnderrunError is encountered, the state changes to QtAudio::IdleState, + when another error is encountered, the state changes to QtAudio::StoppedState. You can check for errors by connecting to the stateChanged() signal: @@ -122,14 +87,26 @@ QAudioSink::QAudioSink(const QAudioFormat &format, QObject *parent) QAudioSink::QAudioSink(const QAudioDevice &audioDevice, const QAudioFormat &format, QObject *parent): QObject(parent) { - d = QPlatformMediaDevices::instance()->audioOutputDevice(format, audioDevice); + d = QPlatformMediaIntegration::instance()->mediaDevices()->audioOutputDevice(format, audioDevice, parent); if (d) - connect(d, SIGNAL(stateChanged(QAudio::State)), SIGNAL(stateChanged(QAudio::State))); + connect(d, &QPlatformAudioSink::stateChanged, this, [this](QAudio::State state) { + // if the signal has been emitted from another thread, + // the state may be already changed by main one + if (state == d->state()) + emit stateChanged(state); + }); else qWarning() << ("No audio device detected"); } /*! + \fn bool QAudioSink::isNull() const + + Returns \c true is the QAudioSink instance is \c null, otherwise returns + \c false. +*/ + +/*! Destroys this audio output. This will release any system resources used and free any buffers. @@ -154,11 +131,11 @@ QAudioFormat QAudioSink::format() const \l{QIODevice::ReadWrite}{ReadWrite} modes. If the QAudioSink is able to successfully output audio data, state() returns - QAudio::ActiveState, error() returns QAudio::NoError + QtAudio::ActiveState, error() returns QtAudio::NoError and the stateChanged() signal is emitted. - If a problem occurs during this process, error() returns QAudio::OpenError, - state() returns QAudio::StoppedState and the stateChanged() signal is emitted. + If a problem occurs during this process, error() returns QtAudio::OpenError, + state() returns QtAudio::StoppedState and the stateChanged() signal is emitted. \sa QIODevice */ @@ -179,11 +156,11 @@ void QAudioSink::start(QIODevice* device) if you start another stream. If the QAudioSink is able to access the system's audio device, state() returns - QAudio::IdleState, error() returns QAudio::NoError + QtAudio::IdleState, error() returns QtAudio::NoError and the stateChanged() signal is emitted. - If a problem occurs during this process, error() returns QAudio::OpenError, - state() returns QAudio::StoppedState and the stateChanged() signal is emitted. + If a problem occurs during this process, error() returns QtAudio::OpenError, + state() returns QtAudio::StoppedState and the stateChanged() signal is emitted. \sa QIODevice */ @@ -198,7 +175,7 @@ QIODevice* QAudioSink::start() /*! Stops the audio output, detaching from the system resource. - Sets error() to QAudio::NoError, state() to QAudio::StoppedState and + Sets error() to QtAudio::NoError, state() to QtAudio::StoppedState and emit stateChanged() signal. */ void QAudioSink::stop() @@ -220,7 +197,7 @@ void QAudioSink::reset() /*! Stops processing audio data, preserving buffered audio data. - Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and + Sets error() to QtAudio::NoError, state() to QtAudio::SuspendedState and emits stateChanged() signal. */ void QAudioSink::suspend() @@ -232,10 +209,9 @@ void QAudioSink::suspend() /*! Resumes processing audio data after a suspend(). - Sets error() to QAudio::NoError. - Sets state() to QAudio::ActiveState if you previously called start(QIODevice*). - Sets state() to QAudio::IdleState if you previously called start(). - emits stateChanged() signal. + Sets state() to the state the sink had when suspend() was called, and sets + error() to QAudioError::NoError. This function does nothing if the audio sink's + state is not QtAudio::SuspendedState. */ void QAudioSink::resume() { @@ -246,7 +222,7 @@ void QAudioSink::resume() /*! Returns the number of free bytes available in the audio buffer. - \note The returned value is only valid while in QAudio::ActiveState or QAudio::IdleState + \note The returned value is only valid while in QtAudio::ActiveState or QtAudio::IdleState state, otherwise returns zero. */ qsizetype QAudioSink::bytesFree() const @@ -303,7 +279,7 @@ qint64 QAudioSink::elapsedUSecs() const /*! Returns the error state. */ -QAudio::Error QAudioSink::error() const +QtAudio::Error QAudioSink::error() const { return d ? d->error() : QAudio::OpenError; } @@ -311,7 +287,7 @@ QAudio::Error QAudioSink::error() const /*! Returns the state of audio processing. */ -QAudio::State QAudioSink::state() const +QtAudio::State QAudioSink::state() const { return d ? d->state() : QAudio::StoppedState; } @@ -330,7 +306,7 @@ QAudio::State QAudioSink::state() const UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control. See - QAudio::convertVolume() for more details. + QtAudio::convertVolume() for more details. */ void QAudioSink::setVolume(qreal volume) { @@ -349,9 +325,13 @@ qreal QAudioSink::volume() const } /*! - \fn QAudioSink::stateChanged(QAudio::State state) + \fn QAudioSink::stateChanged(QtAudio::State state) This signal is emitted when the device \a state has changed. This is the current state of the audio output. + + \note The QtAudio namespace was named QAudio up to and including Qt 6.6. + String-based connections to this signal have to use \c{QAudio::State} as + the parameter type: \c{connect(source, SIGNAL(stateChanged(QAudio::State)), ...);} */ QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiosink.h b/src/multimedia/audio/qaudiosink.h index 049011e98..e071e6fbc 100644 --- a/src/multimedia/audio/qaudiosink.h +++ b/src/multimedia/audio/qaudiosink.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOOUTPUT_H @@ -45,7 +9,7 @@ #include <QtMultimedia/qtmultimediaglobal.h> -#include <QtMultimedia/qaudio.h> +#include <QtMultimedia/qtaudio.h> #include <QtMultimedia/qaudioformat.h> #include <QtMultimedia/qaudiodevice.h> @@ -85,14 +49,19 @@ public: qint64 processedUSecs() const; qint64 elapsedUSecs() const; - QAudio::Error error() const; - QAudio::State state() const; + QtAudio::Error error() const; + QtAudio::State state() const; void setVolume(qreal); qreal volume() const; Q_SIGNALS: +#if defined(Q_QDOC) + void stateChanged(QtAudio::State state); +#else + // use QAudio here to keep string-based connections working void stateChanged(QAudio::State state); +#endif private: Q_DISABLE_COPY(QAudioSink) diff --git a/src/multimedia/audio/qaudiosource.cpp b/src/multimedia/audio/qaudiosource.cpp index 57af98b39..1ed5e82bc 100644 --- a/src/multimedia/audio/qaudiosource.cpp +++ b/src/multimedia/audio/qaudiosource.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qaudio.h" @@ -89,7 +53,7 @@ QT_BEGIN_NAMESPACE At any point in time, QAudioSource will be in one of four states: active, suspended, stopped, or idle. These states are specified by - the QAudio::State enum. You can request a state change directly through + the QtAudio::State enum. You can request a state change directly through suspend(), resume(), stop(), reset(), and start(). The current state is reported by state(). QAudioSink will also signal you when the state changes (stateChanged()). @@ -102,8 +66,8 @@ QT_BEGIN_NAMESPACE which states the QAudioSource has been in. If an error should occur, you can fetch its reason with error(). - The possible error reasons are described by the QAudio::Error - enum. The QAudioSource will enter the \l{QAudio::}{StoppedState} when + The possible error reasons are described by the QtAudio::Error + enum. The QAudioSource will enter the \l{QtAudio::}{StoppedState} when an error is encountered. Connect to the stateChanged() signal to handle the error: @@ -132,15 +96,27 @@ QAudioSource::QAudioSource(const QAudioFormat &format, QObject *parent) QAudioSource::QAudioSource(const QAudioDevice &audioDevice, const QAudioFormat &format, QObject *parent): QObject(parent) { - d = QPlatformMediaDevices::instance()->audioInputDevice(format, audioDevice); - if (d) - connect(d, SIGNAL(stateChanged(QAudio::State)), SIGNAL(stateChanged(QAudio::State))); + d = QPlatformMediaIntegration::instance()->mediaDevices()->audioInputDevice(format, audioDevice, parent); + if (d) { + connect(d, &QPlatformAudioSource::stateChanged, this, [this](QAudio::State state) { + // if the signal has been emitted from another thread, + // the state may be already changed by main one + if (state == d->state()) + emit stateChanged(state); + }); + } else qWarning() << ("No audio device detected"); } /*! + \fn bool QAudioSource::isNull() const + + Returns \c true if the audio source is \c null, otherwise returns \c false. +*/ + +/*! Destroy this audio input. */ @@ -155,11 +131,11 @@ QAudioSource::~QAudioSource() \l{QIODevice::Append}{Append} or \l{QIODevice::ReadWrite}{ReadWrite} modes. If the QAudioSource is able to successfully get audio data, state() returns - either QAudio::ActiveState or QAudio::IdleState, error() returns QAudio::NoError + either QtAudio::ActiveState or QtAudio::IdleState, error() returns QtAudio::NoError and the stateChanged() signal is emitted. - If a problem occurs during this process, error() returns QAudio::OpenError, - state() returns QAudio::StoppedState and the stateChanged() signal is emitted. + If a problem occurs during this process, error() returns QtAudio::OpenError, + state() returns QtAudio::StoppedState and the stateChanged() signal is emitted. \sa QIODevice */ @@ -181,11 +157,11 @@ void QAudioSource::start(QIODevice* device) if you start another stream. If the QAudioSource is able to access the system's audio device, state() returns - QAudio::IdleState, error() returns QAudio::NoError + QtAudio::IdleState, error() returns QtAudio::NoError and the stateChanged() signal is emitted. - If a problem occurs during this process, error() returns QAudio::OpenError, - state() returns QAudio::StoppedState and the stateChanged() signal is emitted. + If a problem occurs during this process, error() returns QtAudio::OpenError, + state() returns QtAudio::StoppedState and the stateChanged() signal is emitted. \sa QIODevice */ @@ -210,7 +186,7 @@ QAudioFormat QAudioSource::format() const /*! Stops the audio input, detaching from the system resource. - Sets error() to QAudio::NoError, state() to QAudio::StoppedState and + Sets error() to QtAudio::NoError, state() to QtAudio::StoppedState and emit stateChanged() signal. */ @@ -233,7 +209,7 @@ void QAudioSource::reset() /*! Stops processing audio data, preserving buffered audio data. - Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and + Sets error() to QtAudio::NoError, state() to QtAudio::SuspendedState and emit stateChanged() signal. */ @@ -246,9 +222,9 @@ void QAudioSource::suspend() /*! Resumes processing audio data after a suspend(). - Sets error() to QAudio::NoError. - Sets state() to QAudio::ActiveState if you previously called start(QIODevice*). - Sets state() to QAudio::IdleState if you previously called start(). + Sets error() to QtAudio::NoError. + Sets state() to QtAudio::ActiveState if you previously called start(QIODevice*). + Sets state() to QtAudio::IdleState if you previously called start(). emits stateChanged() signal. */ @@ -292,7 +268,7 @@ qsizetype QAudioSource::bufferSize() const /*! Returns the amount of audio data available to read in bytes. - Note: returned value is only valid while in QAudio::ActiveState or QAudio::IdleState + Note: returned value is only valid while in QtAudio::ActiveState or QtAudio::IdleState state, otherwise returns zero. */ @@ -364,7 +340,7 @@ qint64 QAudioSource::elapsedUSecs() const Returns the error state. */ -QAudio::Error QAudioSource::error() const +QtAudio::Error QAudioSource::error() const { return d ? d->error() : QAudio::OpenError; } @@ -373,14 +349,18 @@ QAudio::Error QAudioSource::error() const Returns the state of audio processing. */ -QAudio::State QAudioSource::state() const +QtAudio::State QAudioSource::state() const { return d ? d->state() : QAudio::StoppedState; } /*! - \fn QAudioSource::stateChanged(QAudio::State state) + \fn QAudioSource::stateChanged(QtAudio::State state) This signal is emitted when the device \a state has changed. + + \note The QtAudio namespace was named QAudio up to and including Qt 6.6. + String-based connections to this signal have to use \c{QAudio::State} as + the parameter type: \c{connect(source, SIGNAL(stateChanged(QAudio::State)), ...);} */ QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiosource.h b/src/multimedia/audio/qaudiosource.h index 9c11b85d3..f0ad0ceb5 100644 --- a/src/multimedia/audio/qaudiosource.h +++ b/src/multimedia/audio/qaudiosource.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOINPUT_H @@ -45,7 +9,7 @@ #include <QtMultimedia/qtmultimediaglobal.h> -#include <QtMultimedia/qaudio.h> +#include <QtMultimedia/qtaudio.h> #include <QtMultimedia/qaudioformat.h> #include <QtMultimedia/qaudiodevice.h> @@ -86,11 +50,16 @@ public: qint64 processedUSecs() const; qint64 elapsedUSecs() const; - QAudio::Error error() const; - QAudio::State state() const; + QtAudio::Error error() const; + QtAudio::State state() const; Q_SIGNALS: +#if defined(Q_QDOC) + void stateChanged(QtAudio::State state); +#else + // use QAudio here to keep string-based connections working void stateChanged(QAudio::State state); +#endif private: Q_DISABLE_COPY(QAudioSource) diff --git a/src/multimedia/audio/qaudiostatemachine.cpp b/src/multimedia/audio/qaudiostatemachine.cpp new file mode 100644 index 000000000..2d42200e6 --- /dev/null +++ b/src/multimedia/audio/qaudiostatemachine.cpp @@ -0,0 +1,150 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#include "qaudiostatemachine_p.h" +#include "qaudiosystem_p.h" +#include <qpointer.h> +#include <qdebug.h> + +QT_BEGIN_NAMESPACE + +using Notifier = QAudioStateMachine::Notifier; +using namespace AudioStateMachineUtils; + +QAudioStateMachine::QAudioStateMachine(QAudioStateChangeNotifier ¬ifier) : m_notifier(¬ifier) +{ +} + +QAudioStateMachine::~QAudioStateMachine() = default; + +QAudio::State QAudioStateMachine::state() const +{ + return toAudioState(m_state.load(std::memory_order_acquire)); +} + +QAudio::Error QAudioStateMachine::error() const +{ + return toAudioError(m_state.load(std::memory_order_acquire)); +} + +template <typename StatesChecker, typename NewState> +Notifier QAudioStateMachine::changeState(const StatesChecker &checker, const NewState &newState) +{ + if constexpr (std::is_same_v<RawState, NewState>) + return changeState(checker, [newState](RawState) { return newState; }); + else { + RawState prevState = m_state.load(std::memory_order_relaxed); + const auto exchanged = multipleCompareExchange(m_state, prevState, checker, newState); + + if (Q_LIKELY(exchanged)) + return { this, newState(prevState), prevState }; + + return {}; + } +} + +Notifier QAudioStateMachine::stop(QAudio::Error error, bool shouldDrain, bool forceUpdateError) +{ + auto statesChecker = + makeStatesChecker(QAudio::ActiveState, QAudio::IdleState, QAudio::SuspendedState, + forceUpdateError ? QAudio::StoppedState : QAudio::ActiveState); + + const auto state = toRawState(QAudio::StoppedState, error); + auto getNewState = [&](RawState prevState) { + const bool shouldAddFlag = shouldDrain && toAudioState(prevState) == QAudio::ActiveState; + return shouldAddFlag ? addDrainingFlag(state) : state; + }; + + return changeState(statesChecker, getNewState); +} + +Notifier QAudioStateMachine::start(bool active) +{ + return changeState(makeStatesChecker(QAudio::StoppedState), + toRawState(active ? QAudio::ActiveState : QAudio::IdleState)); +} + +bool QAudioStateMachine::isActiveOrIdle() const +{ + const auto state = this->state(); + return state == QAudio::ActiveState || state == QAudio::IdleState; +} + +bool QAudioStateMachine::onDrained() +{ + return changeState(isDrainingState, removeDrainingFlag); +} + +bool QAudioStateMachine::isDraining() const +{ + return isDrainingState(m_state.load(std::memory_order_acquire)); +} + +std::pair<bool, bool> QAudioStateMachine::getDrainedAndStopped() const +{ + const auto state = m_state.load(std::memory_order_acquire); + return { !isDrainingState(state), toAudioState(state) == QAudio::StoppedState }; +} + +Notifier QAudioStateMachine::suspend() +{ + // Due to the current documentation, we set QAudio::NoError. + // TBD: leave the previous error should be more reasonable (IgnoreError) + const auto error = QAudio::NoError; + auto result = changeState(makeStatesChecker(QAudio::ActiveState, QAudio::IdleState), + toRawState(QAudio::SuspendedState, error)); + + if (result) + m_suspendedInState = result.prevAudioState(); + + return result; +} + +Notifier QAudioStateMachine::resume() +{ + // Due to the current documentation, we set QAudio::NoError. + // TBD: leave the previous error should be more reasonable (IgnoreError) + const auto error = QAudio::NoError; + return changeState(makeStatesChecker(QAudio::SuspendedState), + toRawState(m_suspendedInState, error)); +} + +Notifier QAudioStateMachine::activateFromIdle() +{ + return changeState(makeStatesChecker(QAudio::IdleState), toRawState(QAudio::ActiveState)); +} + +Notifier QAudioStateMachine::updateActiveOrIdle(bool isActive, QAudio::Error error) +{ + const auto state = isActive ? QAudio::ActiveState : QAudio::IdleState; + return changeState(makeStatesChecker(QAudio::ActiveState, QAudio::IdleState), + toRawState(state, error)); +} + +Notifier QAudioStateMachine::setError(QAudio::Error error) +{ + auto fixState = [error](RawState prevState) { return setStateError(prevState, error); }; + return changeState([](RawState) { return true; }, fixState); +} + +Notifier QAudioStateMachine::forceSetState(QAudio::State state, QAudio::Error error) +{ + return changeState([](RawState) { return true; }, toRawState(state, error)); +} + +void QAudioStateMachine::reset(RawState state, RawState prevState) +{ + auto notifier = m_notifier; + + const auto audioState = toAudioState(state); + const auto audioError = toAudioError(state); + + if (toAudioState(prevState) != audioState && notifier) + emit notifier->stateChanged(audioState); + + // check the notifier in case the object was deleted in + if (toAudioError(prevState) != audioError && notifier) + emit notifier->errorChanged(audioError); +} + +QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiostatemachine_p.h b/src/multimedia/audio/qaudiostatemachine_p.h new file mode 100644 index 000000000..385453020 --- /dev/null +++ b/src/multimedia/audio/qaudiostatemachine_p.h @@ -0,0 +1,149 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QAUDIOSTATEMACHINE_P_H +#define QAUDIOSTATEMACHINE_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include "qaudiostatemachineutils_p.h" + +#include <qpointer.h> +#include <atomic> + +QT_BEGIN_NAMESPACE + +class QAudioStateChangeNotifier; + +/* QAudioStateMachine provides an opportunity to + * toggle QAudio::State with QAudio::Error in + * a thread-safe manner. + * The toggling functions return a notifier, + * which notifies about the change via + * QAudioStateChangeNotifier::stateChanged and errorChanged. + * + * The state machine is supposed to be used mostly in + * QAudioSink and QAudioSource implementations. + */ +class Q_MULTIMEDIA_EXPORT QAudioStateMachine +{ +public: + using RawState = AudioStateMachineUtils::RawState; + class Notifier + { + public: + void reset() + { + if (auto stateMachine = std::exchange(m_stateMachine, nullptr)) + stateMachine->reset(m_state, m_prevState); + } + + ~Notifier() { reset(); } + + Notifier(const Notifier &) = delete; + Notifier(Notifier &&other) noexcept + : m_stateMachine(std::exchange(other.m_stateMachine, nullptr)), + m_state(other.m_state), + m_prevState(other.m_prevState) + { + } + + operator bool() const { return m_stateMachine != nullptr; } + + QAudio::State prevAudioState() const { return AudioStateMachineUtils::toAudioState(m_prevState); } + + QAudio::State audioState() const { return AudioStateMachineUtils::toAudioState(m_state); } + + bool isDraining() const { return AudioStateMachineUtils::isDrainingState(m_state); } + + bool isStateChanged() const { return prevAudioState() != audioState(); } + + private: + Notifier(QAudioStateMachine *stateMachine = nullptr, RawState state = QAudio::StoppedState, + RawState prevState = QAudio::StoppedState) + : m_stateMachine(stateMachine), m_state(state), m_prevState(prevState) + { + } + + private: + QAudioStateMachine *m_stateMachine; + RawState m_state; + const RawState m_prevState; + + friend class QAudioStateMachine; + }; + + QAudioStateMachine(QAudioStateChangeNotifier ¬ifier); + + ~QAudioStateMachine(); + + QAudio::State state() const; + + QAudio::Error error() const; + + bool isActiveOrIdle() const; + + bool isDraining() const; + + // atomicaly checks if the state is stopped and marked as drained + std::pair<bool, bool> getDrainedAndStopped() const; + + // Stopped[draining] -> Stopped + bool onDrained(); + + // Active/Idle/Suspended -> Stopped + // or Active -> Stopped[draining] for shouldDrain = true + Notifier stop(QAudio::Error error = QAudio::NoError, bool shouldDrain = false, + bool forceUpdateError = false); + + // Active/Idle/Suspended -> Stopped + Notifier stopOrUpdateError(QAudio::Error error = QAudio::NoError) + { + return stop(error, false, true); + } + + // Stopped -> Active/Idle + Notifier start(bool isActive = true); + + // Active/Idle -> Suspended + saves the exchanged state + Notifier suspend(); + + // Suspended -> saved state (Active/Idle) + Notifier resume(); + + // Idle -> Active + Notifier activateFromIdle(); + + // Active/Idle -> Active/Idle + updateError + Notifier updateActiveOrIdle(bool isActive, QAudio::Error error = QAudio::NoError); + + // Any -> Any; better use more strict methods + Notifier forceSetState(QAudio::State state, QAudio::Error error = QAudio::NoError); + + // force set the error + Notifier setError(QAudio::Error error); + +private: + template <typename StatesChecker, typename NewState> + Notifier changeState(const StatesChecker &statesChecker, const NewState &newState); + + void reset(RawState state, RawState prevState); + +private: + QPointer<QAudioStateChangeNotifier> m_notifier; + std::atomic<RawState> m_state = QAudio::StoppedState; + QAudio::State m_suspendedInState = QAudio::SuspendedState; +}; + +QT_END_NAMESPACE + +#endif // QAUDIOSTATEMACHINE_P_H diff --git a/src/multimedia/audio/qaudiostatemachineutils_p.h b/src/multimedia/audio/qaudiostatemachineutils_p.h new file mode 100644 index 000000000..f80517f77 --- /dev/null +++ b/src/multimedia/audio/qaudiostatemachineutils_p.h @@ -0,0 +1,96 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + +#ifndef QAUDIOSTATEMACHINEUTILS_P_H +#define QAUDIOSTATEMACHINEUTILS_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include "qaudio.h" + +QT_BEGIN_NAMESPACE + +namespace AudioStateMachineUtils { + +using RawState = int; + +constexpr uint32_t AudioStateBitsCount = 8; +constexpr RawState AudioStateMask = 0xFF; +constexpr RawState AudioErrorMask = 0xFF00; +constexpr RawState DrainingFlag = 0x10000; + +static_assert(!(AudioStateMask & DrainingFlag) && !(AudioStateMask & AudioErrorMask) + && !(AudioErrorMask & DrainingFlag), + "Invalid masks"); + +constexpr bool isDrainingState(RawState state) +{ + return (state & DrainingFlag) != 0; +} + +constexpr RawState addDrainingFlag(RawState state) +{ + return state | DrainingFlag; +} + +constexpr RawState removeDrainingFlag(RawState state) +{ + return state & ~DrainingFlag; +} + +constexpr QAudio::State toAudioState(RawState state) +{ + return QAudio::State(state & AudioStateMask); +} + +constexpr QAudio::Error toAudioError(RawState state) +{ + return QAudio::Error((state & AudioErrorMask) >> AudioStateBitsCount); +} + +constexpr RawState toRawState(QAudio::State state, QAudio::Error error = QAudio::NoError) +{ + return state | (error << AudioStateBitsCount); +} + +constexpr RawState setStateError(RawState state, QAudio::Error error) +{ + return (error << AudioStateBitsCount) | (state & ~AudioErrorMask); +} + +template <typename... States> +constexpr auto makeStatesChecker(States... states) +{ + return [=](RawState state) { + state &= (AudioStateMask | DrainingFlag); + return (... || (state == states)); + }; +} + +// ensures compareExchange (testAndSet) operation with opportunity +// to check several states, can be considered as atomic +template <typename T, typename Predicate, typename NewValueGetter> +bool multipleCompareExchange(std::atomic<T> &target, T &prevValue, Predicate predicate, + NewValueGetter newValueGetter) +{ + while (predicate(prevValue)) + if (target.compare_exchange_strong(prevValue, newValueGetter(prevValue), + std::memory_order_acq_rel)) + return true; + + return false; +} +} // namespace AudioStateMachineUtils + +QT_END_NAMESPACE + +#endif // QAUDIOSTATEMACHINEUTILS_P_H diff --git a/src/multimedia/audio/qaudiosystem.cpp b/src/multimedia/audio/qaudiosystem.cpp index f1fd5bb30..355771f6b 100644 --- a/src/multimedia/audio/qaudiosystem.cpp +++ b/src/multimedia/audio/qaudiosystem.cpp @@ -1,254 +1,22 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only -#include <private/qtmultimediaglobal_p.h> #include "qaudiosystem_p.h" -QT_BEGIN_NAMESPACE - -/*! - \class QPlatformAudioSink - \brief The QPlatformAudioSink class is a base class for audio backends. - - \ingroup multimedia - \inmodule QtMultimedia - - QPlatformAudioSink implements audio functionality for - QAudioSink, i.e., QAudioSink routes function calls to - QPlatformAudioSink. For a description of the functionality that - is implemented, see the QAudioSink class and function - descriptions. - - \sa QAudioSink -*/ - -/*! - \fn void QPlatformAudioSink::start(QIODevice* device) - Uses the \a device as the QIODevice to transfer data. -*/ - -/*! - \fn QIODevice* QPlatformAudioSink::start() - Returns a pointer to the QIODevice being used to handle - the data transfer. This QIODevice can be used to write() audio data directly. -*/ - -/*! - \fn void QPlatformAudioSink::stop() - Stops the audio output. -*/ - -/*! - \fn void QPlatformAudioSink::reset() - Drops all audio data in the buffers, resets buffers to zero. -*/ - -/*! - \fn void QPlatformAudioSink::suspend() - Stops processing audio data, preserving buffered audio data. -*/ - -/*! - \fn void QPlatformAudioSink::resume() - Resumes processing audio data after a suspend() -*/ - -/*! - \fn qsizetype QPlatformAudioSink::bytesFree() const - Returns the free space available in bytes in the audio buffer. -*/ - -/*! - \fn void QPlatformAudioSink::setBufferSize(qsizetype value) - Sets the audio buffer size to \a value in bytes. -*/ - -/*! - \fn qsizetype QPlatformAudioSink::bufferSize() const - Returns the audio buffer size in bytes. -*/ - -/*! - \fn qint64 QPlatformAudioSink::processedUSecs() const - Returns the amount of audio data processed since start() was called in milliseconds. -*/ - -/*! - \fn QAudio::Error QPlatformAudioSink::error() const - Returns the error state. -*/ - -/*! - \fn QAudio::State QPlatformAudioSink::state() const - Returns the state of audio processing. -*/ - -/*! - \fn void QPlatformAudioSink::setFormat(const QAudioFormat& fmt) - Set the QAudioFormat to use to \a fmt. - Setting the format is only allowable while in QAudio::StoppedState. -*/ - -/*! - \fn QAudioFormat QPlatformAudioSink::format() const - Returns the QAudioFormat being used. -*/ - -/*! - \fn void QPlatformAudioSink::setVolume(qreal volume) - Sets the volume. - Where \a volume is between 0.0 and 1.0. -*/ +#include <private/qplatformmediadevices_p.h> -/*! - \fn qreal QPlatformAudioSink::volume() const - Returns the volume in the range 0.0 and 1.0. -*/ - -/*! - \fn QPlatformAudioSink::errorChanged(QAudio::Error error) - This signal is emitted when the \a error state has changed. -*/ - -/*! - \fn QPlatformAudioSink::stateChanged(QAudio::State state) - This signal is emitted when the device \a state has changed. -*/ - -/*! - \class QPlatformAudioSource - \brief The QPlatformAudioSource class provides access for QAudioSource to access the audio - device provided by the plugin. - - \ingroup multimedia - \inmodule QtMultimedia - - QAudioDeviceInput keeps an instance of QPlatformAudioSource and - routes calls to functions of the same name to QPlatformAudioSource. - This means that it is QPlatformAudioSource that implements the - audio functionality. For a description of the functionality, see - the QAudioSource class description. - - \sa QAudioSource -*/ - -/*! - \fn void QPlatformAudioSource::start(QIODevice* device) - Uses the \a device as the QIODevice to transfer data. -*/ - -/*! - \fn QIODevice* QPlatformAudioSource::start() - Returns a pointer to the QIODevice being used to handle - the data transfer. This QIODevice can be used to read() audio data directly. -*/ - -/*! - \fn void QPlatformAudioSource::stop() - Stops the audio input. -*/ - -/*! - \fn void QPlatformAudioSource::reset() - Drops all audio data in the buffers, resets buffers to zero. -*/ - -/*! - \fn void QPlatformAudioSource::suspend() - Stops processing audio data, preserving buffered audio data. -*/ - -/*! - \fn void QPlatformAudioSource::resume() - Resumes processing audio data after a suspend(). -*/ - -/*! - \fn qsizetype QPlatformAudioSource::bytesReady() const - Returns the amount of audio data available to read in bytes. -*/ - -/*! - \fn void QPlatformAudioSource::setBufferSize(qsizetype value) - Sets the audio buffer size to \a value in milliseconds. -*/ - -/*! - \fn qsizetype QPlatformAudioSource::bufferSize() const - Returns the audio buffer size in milliseconds. -*/ - -/*! - \fn qint64 QPlatformAudioSource::processedUSecs() const - Returns the amount of audio data processed since start() was called in milliseconds. -*/ - -/*! - \fn QAudio::Error QPlatformAudioSource::error() const - Returns the error state. -*/ - -/*! - \fn QAudio::State QPlatformAudioSource::state() const - Returns the state of audio processing. -*/ +QT_BEGIN_NAMESPACE -/*! - \fn void QPlatformAudioSource::setFormat(const QAudioFormat& fmt) - Set the QAudioFormat to use to \a fmt. - Setting the format is only allowable while in QAudio::StoppedState. -*/ +QAudioStateChangeNotifier::QAudioStateChangeNotifier(QObject *parent) : QObject(parent) { } -/*! - \fn QAudioFormat QPlatformAudioSource::format() const - Returns the QAudioFormat being used -*/ +QPlatformAudioSink::QPlatformAudioSink(QObject *parent) : QAudioStateChangeNotifier(parent) { } -/*! - \fn QPlatformAudioSource::errorChanged(QAudio::Error error) - This signal is emitted when the \a error state has changed. -*/ +qreal QPlatformAudioSink::volume() const +{ + return 1.0; +} -/*! - \fn QPlatformAudioSource::stateChanged(QAudio::State state) - This signal is emitted when the device \a state has changed. -*/ +QPlatformAudioSource::QPlatformAudioSource(QObject *parent) : QAudioStateChangeNotifier(parent) { } QT_END_NAMESPACE diff --git a/src/multimedia/audio/qaudiosystem_p.h b/src/multimedia/audio/qaudiosystem_p.h index a01d5f8ca..4a0650e80 100644 --- a/src/multimedia/audio/qaudiosystem_p.h +++ b/src/multimedia/audio/qaudiosystem_p.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2022 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QAUDIOSYSTEM_H #define QAUDIOSYSTEM_H @@ -64,11 +28,23 @@ QT_BEGIN_NAMESPACE class QIODevice; -class Q_MULTIMEDIA_EXPORT QPlatformAudioSink : public QObject +class Q_MULTIMEDIA_EXPORT QAudioStateChangeNotifier : public QObject +{ + Q_OBJECT +public: + QAudioStateChangeNotifier(QObject *parent = nullptr); + +signals: + void errorChanged(QAudio::Error error); + void stateChanged(QAudio::State state); +}; + +class Q_MULTIMEDIA_EXPORT QPlatformAudioSink : public QAudioStateChangeNotifier { Q_OBJECT public: + QPlatformAudioSink(QObject *parent); virtual void start(QIODevice *device) = 0; virtual QIODevice* start() = 0; virtual void stop() = 0; @@ -84,20 +60,17 @@ public: virtual void setFormat(const QAudioFormat& fmt) = 0; virtual QAudioFormat format() const = 0; virtual void setVolume(qreal) {} - virtual qreal volume() const { return 1.0; } + virtual qreal volume() const; QElapsedTimer elapsedTime; - -Q_SIGNALS: - void errorChanged(QAudio::Error error); - void stateChanged(QAudio::State state); }; -class Q_MULTIMEDIA_EXPORT QPlatformAudioSource : public QObject +class Q_MULTIMEDIA_EXPORT QPlatformAudioSource : public QAudioStateChangeNotifier { Q_OBJECT public: + QPlatformAudioSource(QObject *parent); virtual void start(QIODevice *device) = 0; virtual QIODevice* start() = 0; virtual void stop() = 0; @@ -116,10 +89,6 @@ public: virtual qreal volume() const = 0; QElapsedTimer elapsedTime; - -Q_SIGNALS: - void errorChanged(QAudio::Error error); - void stateChanged(QAudio::State state); }; QT_END_NAMESPACE diff --git a/src/multimedia/audio/qsamplecache_p.cpp b/src/multimedia/audio/qsamplecache_p.cpp index 7a069ff66..805ab534e 100644 --- a/src/multimedia/audio/qsamplecache_p.cpp +++ b/src/multimedia/audio/qsamplecache_p.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qsamplecache_p.h" #include "qwavedecoder.h" @@ -47,7 +11,7 @@ #include <QtCore/QDebug> #include <QtCore/qloggingcategory.h> -Q_LOGGING_CATEGORY(qLcSampleCache, "qt.multimedia.samplecache") +Q_STATIC_LOGGING_CATEGORY(qLcSampleCache, "qt.multimedia.samplecache") #include <mutex> @@ -166,6 +130,7 @@ QSample* QSampleCache::requestSample(const QUrl& url) { //lock and add first to make sure live loadingThread will not be killed during this function call m_loadingMutex.lock(); + const bool needsThreadStart = m_loadingRefCount == 0; m_loadingRefCount++; m_loadingMutex.unlock(); @@ -174,11 +139,16 @@ QSample* QSampleCache::requestSample(const QUrl& url) QMap<QUrl, QSample*>::iterator it = m_samples.find(url); QSample* sample; if (it == m_samples.end()) { - if (!m_loadingThread.isRunning()) + if (needsThreadStart) { + // Previous thread might be finishing, need to wait for it. If not, this is a no-op. + m_loadingThread.wait(); m_loadingThread.start(); + } sample = new QSample(url, this); m_samples.insert(url, sample); +#if QT_CONFIG(thread) sample->moveToThread(&m_loadingThread); +#endif } else { sample = *it; } @@ -336,7 +306,9 @@ void QSample::addRef() // Called in loading thread void QSample::readSample() { +#if QT_CONFIG(thread) Q_ASSERT(QThread::currentThread()->objectName() == QLatin1String("QSampleCache::LoadingThread")); +#endif QMutexLocker m(&m_mutex); qint64 read = m_waveDecoder->read(m_soundData.data() + m_sampleReadLength, qMin(m_waveDecoder->bytesAvailable(), @@ -353,7 +325,9 @@ void QSample::readSample() // Called in loading thread void QSample::decoderReady() { +#if QT_CONFIG(thread) Q_ASSERT(QThread::currentThread()->objectName() == QLatin1String("QSampleCache::LoadingThread")); +#endif QMutexLocker m(&m_mutex); qCDebug(qLcSampleCache) << "QSample: decoder ready"; m_parent->refresh(m_waveDecoder->size()); @@ -379,21 +353,26 @@ QSample::State QSample::state() const // Essentially a second ctor, doesn't need locks (?) void QSample::load() { +#if QT_CONFIG(thread) Q_ASSERT(QThread::currentThread()->objectName() == QLatin1String("QSampleCache::LoadingThread")); +#endif qCDebug(qLcSampleCache) << "QSample: load [" << m_url << "]"; - m_stream = m_parent->networkAccessManager().get(QNetworkRequest(m_url)); - connect(m_stream, SIGNAL(errorOccurred(QNetworkReply::NetworkError)), SLOT(loadingError(QNetworkReply::NetworkError))); + QNetworkReply *reply = m_parent->networkAccessManager().get(QNetworkRequest(m_url)); + m_stream = reply; + connect(reply, &QNetworkReply::errorOccurred, this, &QSample::loadingError); m_waveDecoder = new QWaveDecoder(m_stream); - connect(m_waveDecoder, SIGNAL(formatKnown()), SLOT(decoderReady())); - connect(m_waveDecoder, SIGNAL(parsingError()), SLOT(decoderError())); - connect(m_waveDecoder, SIGNAL(readyRead()), SLOT(readSample())); + connect(m_waveDecoder, &QWaveDecoder::formatKnown, this, &QSample::decoderReady); + connect(m_waveDecoder, &QWaveDecoder::parsingError, this, &QSample::decoderError); + connect(m_waveDecoder, &QIODevice::readyRead, this, &QSample::readSample); m_waveDecoder->open(QIODevice::ReadOnly); } void QSample::loadingError(QNetworkReply::NetworkError errorCode) { +#if QT_CONFIG(thread) Q_ASSERT(QThread::currentThread()->objectName() == QLatin1String("QSampleCache::LoadingThread")); +#endif QMutexLocker m(&m_mutex); qCDebug(qLcSampleCache) << "QSample: loading error" << errorCode; cleanup(); @@ -405,7 +384,9 @@ void QSample::loadingError(QNetworkReply::NetworkError errorCode) // Called in loading thread void QSample::decoderError() { +#if QT_CONFIG(thread) Q_ASSERT(QThread::currentThread()->objectName() == QLatin1String("QSampleCache::LoadingThread")); +#endif QMutexLocker m(&m_mutex); qCDebug(qLcSampleCache) << "QSample: decoder error"; cleanup(); @@ -417,7 +398,9 @@ void QSample::decoderError() // Called in loading thread from decoder when sample is done. Locked already. void QSample::onReady() { +#if QT_CONFIG(thread) Q_ASSERT(QThread::currentThread()->objectName() == QLatin1String("QSampleCache::LoadingThread")); +#endif m_audioFormat = m_waveDecoder->audioFormat(); qCDebug(qLcSampleCache) << "QSample: load ready format:" << m_audioFormat; cleanup(); diff --git a/src/multimedia/audio/qsamplecache_p.h b/src/multimedia/audio/qsamplecache_p.h index 2bebf5b3b..3ba0c420c 100644 --- a/src/multimedia/audio/qsamplecache_p.h +++ b/src/multimedia/audio/qsamplecache_p.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QSAMPLECACHE_P_H #define QSAMPLECACHE_P_H diff --git a/src/multimedia/audio/qsoundeffect.cpp b/src/multimedia/audio/qsoundeffect.cpp index f0bc57520..c403648f9 100644 --- a/src/multimedia/audio/qsoundeffect.cpp +++ b/src/multimedia/audio/qsoundeffect.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include <QtMultimedia/private/qtmultimediaglobal_p.h> #include "qsoundeffect.h" @@ -43,14 +7,39 @@ #include "qaudiodevice.h" #include "qaudiosink.h" #include "qmediadevices.h" +#include "qaudiobuffer.h" #include <QtCore/qloggingcategory.h> +#include <private/qplatformmediadevices_p.h> +#include <private/qplatformmediaintegration_p.h> +#include <private/qplatformaudioresampler_p.h> -Q_LOGGING_CATEGORY(qLcSoundEffect, "qt.multimedia.soundeffect") +Q_STATIC_LOGGING_CATEGORY(qLcSoundEffect, "qt.multimedia.soundeffect") QT_BEGIN_NAMESPACE Q_GLOBAL_STATIC(QSampleCache, sampleCache) +namespace +{ +struct AudioSinkDeleter +{ + void operator ()(QAudioSink* sink) const + { + sink->stop(); + // Investigate:should we just delete? + sink->deleteLater(); + } +}; + +struct SampleDeleter +{ + void operator ()(QSample* sample) const + { + sample->release(); + } +}; +} + class QSoundEffectPrivate : public QIODevice { public: @@ -62,13 +51,14 @@ public: qint64 size() const override { if (m_sample->state() != QSample::Ready) return 0; - return m_loopCount == QSoundEffect::Infinite ? 0 : m_loopCount * m_sample->data().size(); + return m_loopCount == QSoundEffect::Infinite ? 0 : m_loopCount * m_audioBuffer.byteCount(); } qint64 bytesAvailable() const override { if (m_sample->state() != QSample::Ready) return 0; - return m_loopCount == QSoundEffect::Infinite - ? std::numeric_limits<qint64>::max() : m_runningCount * m_sample->data().size() - m_offset; + if (m_loopCount == QSoundEffect::Infinite) + return std::numeric_limits<qint64>::max(); + return m_runningCount * m_audioBuffer.byteCount() - m_offset; } bool isSequential() const override { return m_loopCount == QSoundEffect::Infinite; @@ -92,9 +82,10 @@ public: int m_loopCount = 1; int m_runningCount = 0; bool m_playing = false; - QSoundEffect::Status m_status = QSoundEffect::Null; - QAudioSink *m_audioOutput = nullptr; - QSample *m_sample = nullptr; + QSoundEffect::Status m_status = QSoundEffect::Null; + std::unique_ptr<QAudioSink, AudioSinkDeleter> m_audioSink; + std::unique_ptr<QSample, SampleDeleter> m_sample; + QAudioBuffer m_audioBuffer; bool m_muted = false; float m_volume = 1.0; bool m_sampleReady = false; @@ -108,6 +99,8 @@ QSoundEffectPrivate::QSoundEffectPrivate(QSoundEffect *q, const QAudioDevice &au , m_audioDevice(audioDevice) { open(QIODevice::ReadOnly); + + QPlatformMediaIntegration::instance()->mediaDevices()->prepareAudio(); } void QSoundEffectPrivate::sampleReady() @@ -116,30 +109,67 @@ void QSoundEffectPrivate::sampleReady() return; qCDebug(qLcSoundEffect) << this << "sampleReady: sample size:" << m_sample->data().size(); - disconnect(m_sample, &QSample::error, this, &QSoundEffectPrivate::decoderError); - disconnect(m_sample, &QSample::ready, this, &QSoundEffectPrivate::sampleReady); - if (!m_audioOutput) { - m_audioOutput = new QAudioSink(m_audioDevice, m_sample->format()); - connect(m_audioOutput, &QAudioSink::stateChanged, this, &QSoundEffectPrivate::stateChanged); + disconnect(m_sample.get(), &QSample::error, this, &QSoundEffectPrivate::decoderError); + disconnect(m_sample.get(), &QSample::ready, this, &QSoundEffectPrivate::sampleReady); + if (!m_audioSink) { + const auto audioDevice = + m_audioDevice.isNull() ? QMediaDevices::defaultAudioOutput() : m_audioDevice; + + if (audioDevice.isNull()) { + // We are likely on a virtual machine, for example in CI + qCCritical(qLcSoundEffect) << "Failed to play sound. No audio devices present."; + setStatus(QSoundEffect::Error); + return; + } + + const auto &sampleFormat = m_sample->format(); + const auto sampleChannelConfig = + sampleFormat.channelConfig() == QAudioFormat::ChannelConfigUnknown + ? QAudioFormat::defaultChannelConfigForChannelCount(sampleFormat.channelCount()) + : sampleFormat.channelConfig(); + + if (sampleChannelConfig != audioDevice.channelConfiguration() + && audioDevice.channelConfiguration() != QAudioFormat::ChannelConfigUnknown) { + qCDebug(qLcSoundEffect) << "Create resampler for channels mapping: config" + << sampleFormat.channelConfig() << "=> config" + << audioDevice.channelConfiguration(); + auto outputFormat = sampleFormat; + outputFormat.setChannelConfig(audioDevice.channelConfiguration()); + + const auto resampler = QPlatformMediaIntegration::instance()->createAudioResampler( + m_sample->format(), outputFormat); + if (resampler) + m_audioBuffer = resampler.value()->resample(m_sample->data().constData(), + m_sample->data().size()); + else + qCDebug(qLcSoundEffect) << "Cannot create resampler for channels mapping"; + } + + if (!m_audioBuffer.isValid()) + m_audioBuffer = QAudioBuffer(m_sample->data(), m_sample->format()); + + m_audioSink.reset(new QAudioSink(audioDevice, m_audioBuffer.format())); + + connect(m_audioSink.get(), &QAudioSink::stateChanged, this, &QSoundEffectPrivate::stateChanged); if (!m_muted) - m_audioOutput->setVolume(m_volume); + m_audioSink->setVolume(m_volume); else - m_audioOutput->setVolume(0); + m_audioSink->setVolume(0); } m_sampleReady = true; setStatus(QSoundEffect::Ready); - if (m_playing && m_audioOutput->state() == QAudio::StoppedState) { + if (m_playing && m_audioSink->state() == QAudio::StoppedState) { qCDebug(qLcSoundEffect) << this << "starting playback on audiooutput"; - m_audioOutput->start(this); + m_audioSink->start(this); } } void QSoundEffectPrivate::decoderError() { qWarning("QSoundEffect(qaudio): Error decoding source %ls", qUtf16Printable(m_url.toString())); - disconnect(m_sample, &QSample::ready, this, &QSoundEffectPrivate::sampleReady); - disconnect(m_sample, &QSample::error, this, &QSoundEffectPrivate::decoderError); + disconnect(m_sample.get(), &QSample::ready, this, &QSoundEffectPrivate::sampleReady); + disconnect(m_sample.get(), &QSample::error, this, &QSoundEffectPrivate::decoderError); m_playing = false; setStatus(QSoundEffect::Error); } @@ -148,7 +178,7 @@ void QSoundEffectPrivate::stateChanged(QAudio::State state) { qCDebug(qLcSoundEffect) << this << "stateChanged " << state; if ((state == QAudio::IdleState && m_runningCount == 0) || state == QAudio::StoppedState) - emit q_ptr->stop(); + q_ptr->stop(); } qint64 QSoundEffectPrivate::readData(char *data, qint64 len) @@ -163,8 +193,8 @@ qint64 QSoundEffectPrivate::readData(char *data, qint64 len) qint64 bytesWritten = 0; - const int sampleSize = m_sample->data().size(); - const char* sampleData = m_sample->data().constData(); + const int sampleSize = m_audioBuffer.byteCount(); + const char *sampleData = m_audioBuffer.constData<char>(); while (len && m_runningCount) { int toWrite = qMin(sampleSize - m_offset, len); @@ -214,8 +244,8 @@ void QSoundEffectPrivate::setStatus(QSoundEffect::Status status) void QSoundEffectPrivate::setPlaying(bool playing) { qCDebug(qLcSoundEffect) << this << "setPlaying(" << playing << ")" << m_playing; - if (m_audioOutput) { - m_audioOutput->stop(); + if (m_audioSink) { + m_audioSink->stop(); if (playing && !m_sampleReady) return; } @@ -224,8 +254,8 @@ void QSoundEffectPrivate::setPlaying(bool playing) return; m_playing = playing; - if (m_audioOutput && playing) - m_audioOutput->start(this); + if (m_audioSink && playing) + m_audioSink->start(this); emit q_ptr->playingChanged(); } @@ -316,11 +346,8 @@ QSoundEffect::QSoundEffect(const QAudioDevice &audioDevice, QObject *parent) QSoundEffect::~QSoundEffect() { stop(); - if (d->m_audioOutput) { - d->m_audioOutput->stop(); - d->m_audioOutput->deleteLater(); - d->m_sample->release(); - } + d->m_audioSink.reset(); + d->m_sample.reset(); delete d; } @@ -391,24 +418,21 @@ void QSoundEffect::setSource(const QUrl &url) if (d->m_sample) { if (!d->m_sampleReady) { - QObject::disconnect(d->m_sample, &QSample::error, d, &QSoundEffectPrivate::decoderError); - QObject::disconnect(d->m_sample, &QSample::ready, d, &QSoundEffectPrivate::sampleReady); + disconnect(d->m_sample.get(), &QSample::error, d, &QSoundEffectPrivate::decoderError); + disconnect(d->m_sample.get(), &QSample::ready, d, &QSoundEffectPrivate::sampleReady); } - d->m_sample->release(); - d->m_sample = nullptr; + d->m_sample.reset(); } - if (d->m_audioOutput) { - QObject::disconnect(d->m_audioOutput, &QAudioSink::stateChanged, d, &QSoundEffectPrivate::stateChanged); - d->m_audioOutput->stop(); - d->m_audioOutput->deleteLater(); - d->m_audioOutput = nullptr; + if (d->m_audioSink) { + disconnect(d->m_audioSink.get(), &QAudioSink::stateChanged, d, &QSoundEffectPrivate::stateChanged); + d->m_audioSink.reset(); } d->setStatus(QSoundEffect::Loading); - d->m_sample = sampleCache()->requestSample(url); - QObject::connect(d->m_sample, &QSample::error, d, &QSoundEffectPrivate::decoderError); - QObject::connect(d->m_sample, &QSample::ready, d, &QSoundEffectPrivate::sampleReady); + d->m_sample.reset(sampleCache()->requestSample(url)); + connect(d->m_sample.get(), &QSample::error, d, &QSoundEffectPrivate::decoderError); + connect(d->m_sample.get(), &QSample::ready, d, &QSoundEffectPrivate::sampleReady); switch (d->m_sample->state()) { case QSample::Ready: @@ -486,6 +510,11 @@ void QSoundEffect::setLoopCount(int loopCount) emit loopCountChanged(); } +/*! + \property QSoundEffect::audioDevice + + Returns the QAudioDevice instance. +*/ QAudioDevice QSoundEffect::audioDevice() { return d->m_audioDevice; @@ -530,7 +559,7 @@ int QSoundEffect::loopsRemaining() const UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect - from a volume control. See \l {QAudio::convertVolume()}{convertVolume()} + from a volume control. See \l {QtAudio::convertVolume()}{convertVolume()} for more details. */ /*! @@ -544,8 +573,8 @@ int QSoundEffect::loopsRemaining() const */ float QSoundEffect::volume() const { - if (d->m_audioOutput && !d->m_muted) - return d->m_audioOutput->volume(); + if (d->m_audioSink && !d->m_muted) + return d->m_audioSink->volume(); return d->m_volume; } @@ -560,7 +589,7 @@ float QSoundEffect::volume() const UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect - from a volume control. See QAudio::convertVolume() for more details. + from a volume control. See QtAudio::convertVolume() for more details. */ void QSoundEffect::setVolume(float volume) { @@ -570,8 +599,8 @@ void QSoundEffect::setVolume(float volume) d->m_volume = volume; - if (d->m_audioOutput && !d->m_muted) - d->m_audioOutput->setVolume(volume); + if (d->m_audioSink && !d->m_muted) + d->m_audioSink->setVolume(volume); emit volumeChanged(); } @@ -606,10 +635,10 @@ void QSoundEffect::setMuted(bool muted) if (d->m_muted == muted) return; - if (muted && d->m_audioOutput) - d->m_audioOutput->setVolume(0); - else if (!muted && d->m_audioOutput && d->m_muted) - d->m_audioOutput->setVolume(d->m_volume); + if (muted && d->m_audioSink) + d->m_audioSink->setVolume(0); + else if (!muted && d->m_audioSink && d->m_muted) + d->m_audioSink->setVolume(d->m_volume); d->m_muted = muted; emit mutedChanged(); diff --git a/src/multimedia/audio/qsoundeffect.h b/src/multimedia/audio/qsoundeffect.h index 5b806b382..eeafc4c9f 100644 --- a/src/multimedia/audio/qsoundeffect.h +++ b/src/multimedia/audio/qsoundeffect.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef QSOUNDEFFECT_H #define QSOUNDEFFECT_H diff --git a/src/multimedia/audio/qaudio.cpp b/src/multimedia/audio/qtaudio.cpp index 2898868a9..fb14e5093 100644 --- a/src/multimedia/audio/qaudio.cpp +++ b/src/multimedia/audio/qtaudio.cpp @@ -1,44 +1,8 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only -#include <qaudio.h> +#include <qtaudio.h> #include <qmath.h> #include <QDebug> @@ -47,16 +11,16 @@ QT_BEGIN_NAMESPACE #define LOG100 4.60517018599 /*! - \namespace QAudio + \namespace QtAudio \ingroup multimedia-namespaces - \brief The QAudio namespace contains enums used by the audio classes. + \brief The QtAudio namespace contains enums used by the audio classes. \inmodule QtMultimedia \ingroup multimedia \ingroup multimedia_audio */ /*! - \enum QAudio::Error + \enum QtAudio::Error \value NoError No errors have occurred \value OpenError An error occurred opening the audio device @@ -66,7 +30,7 @@ QT_BEGIN_NAMESPACE */ /*! - \enum QAudio::State + \enum QtAudio::State \value ActiveState Audio data is being processed, this state is set after start() is called and while audio data is available to be processed. @@ -80,7 +44,7 @@ QT_BEGIN_NAMESPACE */ /*! - \enum QAudio::VolumeScale + \enum QtAudio::VolumeScale This enum defines the different audio volume scales. @@ -95,11 +59,14 @@ QT_BEGIN_NAMESPACE \value DecibelVolumeScale Decibel (dB, amplitude) logarithmic scale. \c -200 is silence and \c 0 is full volume. - \since 5.8 - \sa QAudio::convertVolume() + \sa QtAudio::convertVolume() */ +#if defined(Q_QDOC) +namespace QtAudio +#else namespace QAudio +#endif { /*! @@ -120,7 +87,6 @@ namespace QAudio \snippet multimedia-snippets/audio.cpp Volume conversion - \since 5.8 \sa VolumeScale, QAudioSink::setVolume(), QAudioSource::setVolume(), QSoundEffect::setVolume() */ diff --git a/src/multimedia/audio/qtaudio.h b/src/multimedia/audio/qtaudio.h new file mode 100644 index 000000000..6f6e0e668 --- /dev/null +++ b/src/multimedia/audio/qtaudio.h @@ -0,0 +1,18 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only + + +#ifndef QTAUDIO_H +#define QTAUDIO_H + +#if 0 +#pragma qt_class(QtAudio) +#endif + +#include <QtMultimedia/qaudio.h> + +QT_BEGIN_NAMESPACE + +QT_END_NAMESPACE + +#endif // QTAUDIO_H diff --git a/src/multimedia/audio/qwavedecoder.cpp b/src/multimedia/audio/qwavedecoder.cpp index 8d6173443..452363ddc 100644 --- a/src/multimedia/audio/qwavedecoder.cpp +++ b/src/multimedia/audio/qwavedecoder.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2021 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qwavedecoder.h" @@ -92,7 +56,7 @@ bool QWaveDecoder::open(QIODevice::OpenMode mode) if (canOpen && enoughDataAvailable()) handleData(); else - connect(device, SIGNAL(readyRead()), SLOT(handleData())); + connect(device, &QIODevice::readyRead, this, &QWaveDecoder::handleData); return canOpen; } @@ -127,6 +91,10 @@ qint64 QWaveDecoder::pos() const return device->pos(); } +void QWaveDecoder::setIODevice(QIODevice * /* device */) +{ +} + QAudioFormat QWaveDecoder::audioFormat() const { return format; @@ -175,7 +143,8 @@ qint64 QWaveDecoder::headerLength() qint64 QWaveDecoder::readData(char *data, qint64 maxlen) { - if (!haveFormat || format.bytesPerSample() == 0) + const int bytesPerSample = format.bytesPerSample(); + if (!haveFormat || bytesPerSample == 0) return 0; if (bps == 24) { @@ -199,15 +168,15 @@ qint64 QWaveDecoder::readData(char *data, qint64 maxlen) return l; } - qint64 nSamples = maxlen / format.bytesPerSample(); - maxlen = nSamples * format.bytesPerSample(); + qint64 nSamples = maxlen / bytesPerSample; + maxlen = nSamples * bytesPerSample; int read = device->read(data, maxlen); if (!byteSwap || format.bytesPerFrame() == 1) return read; - nSamples = read / format.bytesPerSample(); - switch (format.bytesPerSample()) { + nSamples = read / bytesPerSample; + switch (bytesPerSample) { case 2: bswap2(data, nSamples); break; @@ -305,7 +274,7 @@ bool QWaveDecoder::writeDataLength() void QWaveDecoder::parsingFailed() { Q_ASSERT(device); - device->disconnect(SIGNAL(readyRead()), this, SLOT(handleData())); + disconnect(device, &QIODevice::readyRead, this, &QWaveDecoder::handleData); emit parsingError(); } @@ -408,8 +377,8 @@ void QWaveDecoder::handleData() } format.setSampleFormat(fmt); - format.setSampleRate(/*qFromBigEndian<quint32>*/(wave.sampleRate)); - format.setChannelCount(/*qFromBigEndian<quint16>*/(wave.numChannels)); + format.setSampleRate(rate); + format.setChannelCount(channels); state = QWaveDecoder::WaitingForDataState; } @@ -417,7 +386,7 @@ void QWaveDecoder::handleData() if (state == QWaveDecoder::WaitingForDataState) { if (findChunk("data")) { - device->disconnect(SIGNAL(readyRead()), this, SLOT(handleData())); + disconnect(device, &QIODevice::readyRead, this, &QWaveDecoder::handleData); chunk descriptor; device->read(reinterpret_cast<char *>(&descriptor), sizeof(chunk)); @@ -431,7 +400,7 @@ void QWaveDecoder::handleData() dataSize = device->size() - headerLength(); haveFormat = true; - connect(device, SIGNAL(readyRead()), SIGNAL(readyRead())); + connect(device, &QIODevice::readyRead, this, &QIODevice::readyRead); emit formatKnown(); return; @@ -474,9 +443,15 @@ bool QWaveDecoder::findChunk(const char *chunkId) if (qstrncmp(descriptor.id, chunkId, 4) == 0) return true; + // A program reading a RIFF file can skip over any chunk whose chunk + // ID it doesn't recognize; it simply skips the number of bytes specified + // by ckSize plus the pad byte, if present. See Multimedia Programming + // Interface and Data Specifications 1.0. IBM / Microsoft. August 1991. pp. 10-11. + const quint32 sizeWithPad = descriptor.size + (descriptor.size & 1); + // It's possible that bytes->available() is less than the chunk size // if it's corrupt. - junkToSkip = qint64(sizeof(chunk) + descriptor.size); + junkToSkip = qint64(sizeof(chunk) + sizeWithPad); // Skip the current amount if (junkToSkip > 0) diff --git a/src/multimedia/audio/qwavedecoder.h b/src/multimedia/audio/qwavedecoder.h index ab6e49ab8..a96e731db 100644 --- a/src/multimedia/audio/qwavedecoder.h +++ b/src/multimedia/audio/qwavedecoder.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #ifndef WAVEDECODER_H #define WAVEDECODER_H @@ -98,9 +62,11 @@ private: struct chunk { - char id[4]; - quint32 size; + char id[4]; // A four-character code that identifies the representation of the chunk data + // padded on the right with blank characters (ASCII 32) + quint32 size; // Does not include the size of the id or size fields or the pad byte at the end of payload }; + bool peekChunk(chunk* pChunk, bool handleEndianness = true); struct RIFFHeader |