summaryrefslogtreecommitdiffstats
path: root/src/multimedia/audio/qaudiooutput.cpp
blob: 2f03f78b25f69dbc62229836f0e1e723feb9d00c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/****************************************************************************
**
** 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$
**
****************************************************************************/

#include <qaudiooutput.h>
#include <qaudiodevice.h>
#include <qmediadevices.h>
#include <private/qplatformaudiooutput_p.h>
#include <private/qplatformmediaintegration_p.h>

/*!
    \class QAudioOutput
    \brief The QAudioOutput class represents an output channel for audio.
    \inmodule QtMultimedia
    \ingroup multimedia
    \ingroup multimedia_audio
    \since 6.0

    QAudioOutput represents an output channel that can be used together with QMediaPlayer or
    QMediaCaptureSession. It allows selecting the physical output device to be used, muting the channel
    or changing its volume.
*/

/*!
    \property QAudioOutput::volume
    \brief the current volume.

    The volume is scaled linearly, ranging from \c 0 (silence) to \c 1 (full volume).
    Values outside this range will be clamped.

    By default the volume is \c 1.

    UI volume controls should usually be scaled nonlinearly. 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.
*/

/*!
    \property QAudioOutput::muted
    \brief the muted state of the current media.

    The value will be true if the output is muted; otherwise false.
*/

/*!
    \property QAudioOutput::device
    \brief the audio device connected to this output.

    The device property represents the audio device connected to this output. A default constructed
    QAudioOutput object will be connected to the systems default audio output at construction time.

    This property can be used to select any other output device listed by QMediaDevices::audioOutputs().
*/

/*!
    \property QAudioOutput::audioRole
    \brief the role of the audio played by this output.

    It can be set to specify the type of audio being played, allowing the system to make
    appropriate decisions when it comes to volume, routing or post-processing.

    \sa supportedAudioRoles()
*/

QAudioOutput::QAudioOutput(QObject *parent)
    : QAudioOutput(QMediaDevices::defaultAudioOutput(), parent)
{}

QAudioOutput::QAudioOutput(const QAudioDevice &device, QObject *parent)
    : QObject(parent),
    d(QPlatformMediaIntegration::instance()->createAudioOutput(this))
{
    d->device = device;
    if (!d->device.isNull() && d->device.mode() != QAudioDevice::Output)
        d->device = QMediaDevices::defaultAudioOutput();
    d->setAudioDevice(d->device);
}

QAudioOutput::~QAudioOutput()
{
    delete d;
}

QAudioDevice QAudioOutput::device() const
{
    return d->device;
}

void QAudioOutput::setDevice(const QAudioDevice &device)
{
    if (!device.isNull() && device.mode() != QAudioDevice::Output)
        return;
    if (d->device == device)
        return;
    d->device = device;
    d->setAudioDevice(device);
    emit deviceChanged();
}

float QAudioOutput::volume() const
{
    return d->volume;
}

void QAudioOutput::setVolume(float volume)
{
    volume = qBound(0., volume, 1.);
    if (d->volume == volume)
        return;
    d->volume = volume;
    d->setVolume(volume);
    emit volumeChanged(volume);
}

bool QAudioOutput::isMuted() const
{
    return d->muted;
}

QAudio::Role QAudioOutput::audioRole() const
{
    return d->role;
}

/*!
    Returns a list of supported audio roles.

    If setting the audio role is not supported, an empty list is returned.

    \sa audioRole
*/
QList<QAudio::Role> QAudioOutput::supportedAudioRoles() const
{
    return d->supportedAudioRoles();
}

void QAudioOutput::setMuted(bool muted)
{
    if (d->muted == muted)
        return;
    d->muted = muted;
    d->setMuted(muted);
    emit mutedChanged(muted);
}

void QAudioOutput::setAudioRole(QAudio::Role audioRole)
{
    if (d->role == audioRole)
        return;
    if (!d->supportedAudioRoles().contains(audioRole))
        return;
    d->role = audioRole;
    d->setAudioRole(d->role);
    emit audioRoleChanged(d->role);
}

#include "moc_qaudiooutput.cpp"