diff options
Diffstat (limited to 'src/multimedia/audio/qaudiobuffer.cpp')
| -rw-r--r-- | src/multimedia/audio/qaudiobuffer.cpp | 125 |
1 files changed, 60 insertions, 65 deletions
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 |