slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Rename QtMultimediaKit to QtMultimedia.

Browse Source 
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
2011-10-06 14:31:58 +10:00
committed by Qt by Nokia
parent 55bc4f2b46
commit 03f22bcdaf
395 changed files with 1393 additions and 3088 deletions
Download Patch File Download Diff File Expand all files Collapse all files

402
src/multimedia/audio/qaudioinput.cpp Normal file
View File

@@ -0,0 +1,402 @@
/****************************************************************************
**
** 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 "qaudio.h"
#include "qaudiodeviceinfo.h"
#include "qaudiosystem.h"
#include "qaudioinput.h"
#include "qaudiodevicefactory_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QAudioInput
\brief The QAudioInput class provides an interface for receiving audio data from an audio input device.
\inmodule QtMultimedia
\ingroup multimedia
\since 1.0
You can construct an audio input with the system's
\l{QAudioDeviceInfo::defaultInputDevice()}{default audio input
device}. It is also possible to create QAudioInput with a
specific QAudioDeviceInfo. When you create the audio input, you
should also send in the QAudioFormat to be used for the recording
(see the QAudioFormat class description for details).
To record to a file:
QAudioInput lets you record audio with an audio input device. The
default constructor of this class will use the systems default
audio device, but you can also specify a QAudioDeviceInfo for a
specific device. You also need to pass in the QAudioFormat in
which you wish to record.
Starting up the QAudioInput is simply a matter of calling start()
with a QIODevice opened for writing. For instance, to record to a
file, you can:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input class members
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input setup
This will start recording if the format specified is supported by
the input device (you can check this with
QAudioDeviceInfo::isFormatSupported(). In case there are any
snags, use the error() function to check what went wrong. We stop
recording in the \c stopRecording() slot.
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input stop recording
At any point in time, QAudioInput 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
suspend(), resume(), stop(), reset(), and start(). The current
state is reported by state(). QAudioOutput will also signal you
when the state changes (stateChanged()).
QAudioInput provides several ways of measuring the time that has
passed since the start() of the recording. The \c processedUSecs()
function returns the length of the stream in microseconds written,
i.e., it leaves out the times the audio input was suspended or idle.
The elapsedUSecs() function returns the time elapsed since start() was called regardless of
which states the QAudioInput 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 QAudioInput will enter the \l{QAudio::}{StoppedState} when
an error is encountered. Connect to the stateChanged() signal to
handle the error:
\snippet doc/src/snippets/multimedia-snippets/audio.cpp Audio input state changed
\sa QAudioOutput, QAudioDeviceInfo
*/
/*!
Construct a new audio input and attach it to \a parent.
The default audio input device is used with the output
\a format parameters.
\since 1.0
*/
QAudioInput::QAudioInput(const QAudioFormat &format, QObject *parent):
QObject(parent)
{
d = QAudioDeviceFactory::createDefaultInputDevice(format);
connect(d, SIGNAL(notify()), SIGNAL(notify()));
connect(d, SIGNAL(stateChanged(QAudio::State)), SIGNAL(stateChanged(QAudio::State)));
}
/*!
Construct a new audio input and attach it to \a parent.
The device referenced by \a audioDevice is used with the input
\a format parameters.
\since 1.0
*/
QAudioInput::QAudioInput(const QAudioDeviceInfo &audioDevice, const QAudioFormat &format, QObject *parent):
QObject(parent)
{
d = QAudioDeviceFactory::createInputDevice(audioDevice, format);
connect(d, SIGNAL(notify()), SIGNAL(notify()));
connect(d, SIGNAL(stateChanged(QAudio::State)), SIGNAL(stateChanged(QAudio::State)));
}
/*!
Destroy this audio input.
*/
QAudioInput::~QAudioInput()
{
delete d;
}
/*!
Uses the \a device as the QIODevice to transfer data.
Passing a QIODevice allows the data to be transferred without any extra code.
All that is required is to open the QIODevice.
If able to successfully get audio data from the systems audio device the
state() is set to either QAudio::ActiveState or QAudio::IdleState,
error() is set to QAudio::NoError and the stateChanged() signal is emitted.
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
\since 1.0
\sa QIODevice
*/
void QAudioInput::start(QIODevice* device)
{
d->start(device);
}
/*!
Returns a pointer to the QIODevice being used to handle the data
transfer. This QIODevice can be used to read() audio data
directly.
If able to access the systems audio device the state() is set to
QAudio::IdleState, error() is set to QAudio::NoError
and the stateChanged() signal is emitted.
If a problem occurs during this process the error() is set to QAudio::OpenError,
state() is set to QAudio::StoppedState and stateChanged() signal is emitted.
\since 1.0
\sa QIODevice
*/
QIODevice* QAudioInput::start()
{
return d->start();
}
/*!
Returns the QAudioFormat being used.
\since 1.0
*/
QAudioFormat QAudioInput::format() const
{
return d->format();
}
/*!
Stops the audio input, detaching from the system resource.
Sets error() to QAudio::NoError, state() to QAudio::StoppedState and
emit stateChanged() signal.
\since 1.0
*/
void QAudioInput::stop()
{
d->stop();
}
/*!
Drops all audio data in the buffers, resets buffers to zero.
\since 1.0
*/
void QAudioInput::reset()
{
d->reset();
}
/*!
Stops processing audio data, preserving buffered audio data.
Sets error() to QAudio::NoError, state() to QAudio::SuspendedState and
emit stateChanged() signal.
\since 1.0
*/
void QAudioInput::suspend()
{
d->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.
\since 1.0
*/
void QAudioInput::resume()
{
d->resume();
}
/*!
Sets the audio buffer size to \a value milliseconds.
Note: This function can be called anytime before start(), calls to this
are ignored after start(). It should not be assumed that the buffer size
set is the actual buffer size used, calling bufferSize() anytime after start()
will return the actual buffer size being used.
\since 1.0
*/
void QAudioInput::setBufferSize(int value)
{
d->setBufferSize(value);
}
/*!
Returns the audio buffer size in milliseconds.
If called before start(), returns platform default value.
If called before start() but setBufferSize() was called prior, returns value set by setBufferSize().
If called after start(), returns the actual buffer size being used. This may not be what was set previously
by setBufferSize().
\since 1.0
*/
int QAudioInput::bufferSize() const
{
return d->bufferSize();
}
/*!
Returns the amount of audio data available to read in bytes.
NOTE: returned value is only valid while in QAudio::ActiveState or QAudio::IdleState
state, otherwise returns zero.
\since 1.0
*/
int QAudioInput::bytesReady() const
{
/*
-If not ActiveState|IdleState, return 0
-return amount of audio data available to read
*/
return d->bytesReady();
}
/*!
Returns the period size in bytes.
Note: This is the recommended read size in bytes.
\since 1.0
*/
int QAudioInput::periodSize() const
{
return d->periodSize();
}
/*!
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 minimum resolution of the timer is platform specific and values
should be checked with notifyInterval() to confirm actual value
being used.
\since 1.0
*/
void QAudioInput::setNotifyInterval(int ms)
{
d->setNotifyInterval(ms);
}
/*!
Returns the notify interval in milliseconds.
\since 1.0
*/
int QAudioInput::notifyInterval() const
{
return d->notifyInterval();
}
/*!
Returns the amount of audio data processed since start()
was called in microseconds.
\since 1.0
*/
qint64 QAudioInput::processedUSecs() const
{
return d->processedUSecs();
}
/*!
Returns the microseconds since start() was called, including time in Idle and
Suspend states.
\since 1.0
*/
qint64 QAudioInput::elapsedUSecs() const
{
return d->elapsedUSecs();
}
/*!
Returns the error state.
\since 1.0
*/
QAudio::Error QAudioInput::error() const
{
return d->error();
}
/*!
Returns the state of audio processing.
\since 1.0
*/
QAudio::State QAudioInput::state() const
{
return d->state();
}
/*!
\fn QAudioInput::stateChanged(QAudio::State state)
This signal is emitted when the device \a state has changed.
\since 1.0
*/
/*!
\fn QAudioInput::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_qaudioinput.cpp"