Rename QtMultimediaKit to QtMultimedia.
There are a few legacy bits left in place so it passes CI, and then qt5.git etc can be updated. Change-Id: I6b082e50e6958c72fdabc2974992e16d90dafa3a Reviewed-on: http://codereview.qt-project.org/5368 Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com> Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
committed by
Qt by Nokia
Qt by Nokia
parent
55bc4f2b46
commit
03f22bcdaf
436
src/multimedia/audio/qaudiosystem.cpp
Normal file
436
src/multimedia/audio/qaudiosystem.cpp
Normal file
@@ -0,0 +1,436 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
||||
** All rights reserved.
|
||||
** Contact: Nokia Corporation (qt-info@nokia.com)
|
||||
**
|
||||
** This file is part of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:LGPL$
|
||||
** GNU Lesser General Public License Usage
|
||||
** This file may be used under the terms of the GNU Lesser General Public
|
||||
** License version 2.1 as published by the Free Software Foundation and
|
||||
** appearing in the file LICENSE.LGPL included in the packaging of this
|
||||
** file. Please review the following information to ensure the GNU Lesser
|
||||
** General Public License version 2.1 requirements will be met:
|
||||
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
||||
**
|
||||
** In addition, as a special exception, Nokia gives you certain additional
|
||||
** rights. These rights are described in the Nokia Qt LGPL Exception
|
||||
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
||||
**
|
||||
** GNU General Public License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU General
|
||||
** Public License version 3.0 as published by the Free Software Foundation
|
||||
** and appearing in the file LICENSE.GPL included in the packaging of this
|
||||
** file. Please review the following information to ensure the GNU General
|
||||
** Public License version 3.0 requirements will be met:
|
||||
** http://www.gnu.org/copyleft/gpl.html.
|
||||
**
|
||||
** Other Usage
|
||||
** Alternatively, this file may be used in accordance with the terms and
|
||||
** conditions contained in a signed written agreement between you and Nokia.
|
||||
**
|
||||
**
|
||||
**
|
||||
**
|
||||
**
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
#include "qaudiosystem.h"
|
||||
|
||||
QT_BEGIN_NAMESPACE
|
||||
|
||||
/*!
|
||||
\class QAbstractAudioDeviceInfo
|
||||
\brief The QAbstractAudioDeviceInfo class is a base class for audio backends.
|
||||
|
||||
\ingroup multimedia
|
||||
\inmodule QtMultimedia
|
||||
\internal
|
||||
\since 1.0
|
||||
|
||||
This class implements the audio functionality for
|
||||
QAudioDeviceInfo, i.e., QAudioDeviceInfo keeps a
|
||||
QAbstractAudioDeviceInfo and routes function calls to it. For a
|
||||
description of the functionality that QAbstractAudioDeviceInfo
|
||||
implements, you can read the class and functions documentation of
|
||||
QAudioDeviceInfo.
|
||||
|
||||
\sa QAudioDeviceInfo
|
||||
\sa QAbstractAudioOutput, QAbstractAudioInput
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudioFormat QAbstractAudioDeviceInfo::preferredFormat() const
|
||||
Returns the recommended settings to use.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat& format) const
|
||||
Returns true if \a format is available from audio device.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QString QAbstractAudioDeviceInfo::deviceName() const
|
||||
Returns the audio device name.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QStringList QAbstractAudioDeviceInfo::supportedCodecs()
|
||||
Returns the list of currently available codecs.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedSampleRates()
|
||||
Returns the list of currently available sample rates.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedChannelCounts()
|
||||
Returns the list of currently available channels.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QList<int> QAbstractAudioDeviceInfo::supportedSampleSizes()
|
||||
Returns the list of currently available sample sizes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QList<QAudioFormat::Endian> QAbstractAudioDeviceInfo::supportedByteOrders()
|
||||
Returns the list of currently available byte orders.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QList<QAudioFormat::SampleType> QAbstractAudioDeviceInfo::supportedSampleTypes()
|
||||
Returns the list of currently available sample types.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\class QAbstractAudioOutput
|
||||
\brief The QAbstractAudioOutput class is a base class for audio backends.
|
||||
\since 1.0
|
||||
|
||||
\ingroup multimedia
|
||||
\inmodule QtMultimedia
|
||||
\internal
|
||||
|
||||
QAbstractAudioOutput implements audio functionality for
|
||||
QAudioOutput, i.e., QAudioOutput routes function calls to
|
||||
QAbstractAudioOutput. For a description of the functionality that
|
||||
is implemented, see the QAudioOutput class and function
|
||||
descriptions.
|
||||
|
||||
\sa QAudioOutput
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::start(QIODevice* device)
|
||||
Uses the \a device as the QIODevice to transfer data.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QIODevice* QAbstractAudioOutput::start()
|
||||
Returns a pointer to the QIODevice being used to handle
|
||||
the data transfer. This QIODevice can be used to write() audio data directly.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::stop()
|
||||
Stops the audio output.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::reset()
|
||||
Drops all audio data in the buffers, resets buffers to zero.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::suspend()
|
||||
Stops processing audio data, preserving buffered audio data.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::resume()
|
||||
Resumes processing audio data after a suspend()
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioOutput::bytesFree() const
|
||||
Returns the free space available in bytes in the audio buffer.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioOutput::periodSize() const
|
||||
Returns the period size in bytes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::setBufferSize(int value)
|
||||
Sets the audio buffer size to \a value in bytes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioOutput::bufferSize() const
|
||||
Returns the audio buffer size in bytes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::setNotifyInterval(int ms)
|
||||
Sets the interval for notify() signal to be emitted. This is based on the \a ms
|
||||
of audio data processed not on actual real-time. The resolution of the timer
|
||||
is platform specific.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioOutput::notifyInterval() const
|
||||
Returns the notify interval in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual qint64 QAbstractAudioOutput::processedUSecs() const
|
||||
Returns the amount of audio data processed since start() was called in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual qint64 QAbstractAudioOutput::elapsedUSecs() const
|
||||
Returns the milliseconds since start() was called, including time in Idle and suspend states.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudio::Error QAbstractAudioOutput::error() const
|
||||
Returns the error state.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudio::State QAbstractAudioOutput::state() const
|
||||
Returns the state of audio processing.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::setFormat(const QAudioFormat& fmt)
|
||||
Set the QAudioFormat to use to \a fmt.
|
||||
Setting the format is only allowable while in QAudio::StoppedState.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudioFormat QAbstractAudioOutput::format() const
|
||||
Returns the QAudioFormat being used.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioOutput::setVolume(qreal volume)
|
||||
Sets the volume.
|
||||
Where \a volume is between 0.0 and 1.0.
|
||||
\since 5.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual qreal QAbstractAudioOutput::volume() const
|
||||
Returns the volume in the range 0.0 and 1.0.
|
||||
\since 5.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAbstractAudioOutput::errorChanged(QAudio::Error error)
|
||||
This signal is emitted when the \a error state has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAbstractAudioOutput::stateChanged(QAudio::State state)
|
||||
This signal is emitted when the device \a state has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAbstractAudioOutput::notify()
|
||||
This signal is emitted when x ms of audio data has been processed
|
||||
the interval set by setNotifyInterval(x).
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\class QAbstractAudioInput
|
||||
\brief The QAbstractAudioInput class provides access for QAudioInput to access the audio
|
||||
device provided by the plugin.
|
||||
\since 1.0
|
||||
|
||||
\ingroup multimedia
|
||||
\inmodule QtMultimedia
|
||||
\internal
|
||||
|
||||
QAudioDeviceInput keeps an instance of QAbstractAudioInput and
|
||||
routes calls to functions of the same name to QAbstractAudioInput.
|
||||
This means that it is QAbstractAudioInput that implements the
|
||||
audio functionality. For a description of the functionality, see
|
||||
the QAudioInput class description.
|
||||
|
||||
\sa QAudioInput
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::start(QIODevice* device)
|
||||
Uses the \a device as the QIODevice to transfer data.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QIODevice* QAbstractAudioInput::start()
|
||||
Returns a pointer to the QIODevice being used to handle
|
||||
the data transfer. This QIODevice can be used to read() audio data directly.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::stop()
|
||||
Stops the audio input.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::reset()
|
||||
Drops all audio data in the buffers, resets buffers to zero.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::suspend()
|
||||
Stops processing audio data, preserving buffered audio data.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::resume()
|
||||
Resumes processing audio data after a suspend().
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioInput::bytesReady() const
|
||||
Returns the amount of audio data available to read in bytes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioInput::periodSize() const
|
||||
Returns the period size in bytes.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::setBufferSize(int value)
|
||||
Sets the audio buffer size to \a value in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioInput::bufferSize() const
|
||||
Returns the audio buffer size in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::setNotifyInterval(int ms)
|
||||
Sets the interval for notify() signal to be emitted. This is based
|
||||
on the \a ms of audio data processed not on actual real-time.
|
||||
The resolution of the timer is platform specific.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual int QAbstractAudioInput::notifyInterval() const
|
||||
Returns the notify interval in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual qint64 QAbstractAudioInput::processedUSecs() const
|
||||
Returns the amount of audio data processed since start() was called in milliseconds.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual qint64 QAbstractAudioInput::elapsedUSecs() const
|
||||
Returns the milliseconds since start() was called, including time in Idle and suspend states.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudio::Error QAbstractAudioInput::error() const
|
||||
Returns the error state.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudio::State QAbstractAudioInput::state() const
|
||||
Returns the state of audio processing.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual void QAbstractAudioInput::setFormat(const QAudioFormat& fmt)
|
||||
Set the QAudioFormat to use to \a fmt.
|
||||
Setting the format is only allowable while in QAudio::StoppedState.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn virtual QAudioFormat QAbstractAudioInput::format() const
|
||||
Returns the QAudioFormat being used
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAbstractAudioInput::errorChanged(QAudio::Error error)
|
||||
This signal is emitted when the \a error state has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAbstractAudioInput::stateChanged(QAudio::State state)
|
||||
This signal is emitted when the device \a state has changed.
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn QAbstractAudioInput::notify()
|
||||
This signal is emitted when x ms of audio data has been processed
|
||||
the interval set by setNotifyInterval(x).
|
||||
\since 1.0
|
||||
*/
|
||||
|
||||
|
||||
QT_END_NAMESPACE
|
||||
|
||||
#include "moc_qaudiosystem.cpp"
|
||||
Reference in New Issue
Block a user