pl031: Correctly migrate state when using -rtc clock=host
[qemu/ar7.git] / qapi / audio.json
blob9fefdf5186dd48f8e4ad5e52ad86a4dfce354296
1 # -*- mode: python -*-
3 # Copyright (C) 2015-2019 Zoltán Kővágó <DirtY.iCE.hu@gmail.com>
5 # This work is licensed under the terms of the GNU GPL, version 2 or later.
6 # See the COPYING file in the top-level directory.
8 ##
9 # @AudiodevPerDirectionOptions:
11 # General audio backend options that are used for both playback and
12 # recording.
14 # @fixed-settings: use fixed settings for host input/output. When off,
15 #                  frequency, channels and format must not be
16 #                  specified (default true)
18 # @frequency: frequency to use when using fixed settings
19 #             (default 44100)
21 # @channels: number of channels when using fixed settings (default 2)
23 # @voices: number of voices to use (default 1)
25 # @format: sample format to use when using fixed settings
26 #          (default s16)
28 # @buffer-length: the buffer length in microseconds
30 # Since: 4.0
32 { 'struct': 'AudiodevPerDirectionOptions',
33   'data': {
34     '*fixed-settings': 'bool',
35     '*frequency':      'uint32',
36     '*channels':       'uint32',
37     '*voices':         'uint32',
38     '*format':         'AudioFormat',
39     '*buffer-length':  'uint32' } }
42 # @AudiodevGenericOptions:
44 # Generic driver-specific options.
46 # @in: options of the capture stream
48 # @out: options of the playback stream
50 # Since: 4.0
52 { 'struct': 'AudiodevGenericOptions',
53   'data': {
54     '*in':  'AudiodevPerDirectionOptions',
55     '*out': 'AudiodevPerDirectionOptions' } }
58 # @AudiodevAlsaPerDirectionOptions:
60 # Options of the ALSA backend that are used for both playback and
61 # recording.
63 # @dev: the name of the ALSA device to use (default 'default')
65 # @period-length: the period length in microseconds
67 # @try-poll: attempt to use poll mode, falling back to non-polling
68 #            access on failure (default true)
70 # Since: 4.0
72 { 'struct': 'AudiodevAlsaPerDirectionOptions',
73   'base': 'AudiodevPerDirectionOptions',
74   'data': {
75     '*dev':           'str',
76     '*period-length': 'uint32',
77     '*try-poll':      'bool' } }
80 # @AudiodevAlsaOptions:
82 # Options of the ALSA audio backend.
84 # @in: options of the capture stream
86 # @out: options of the playback stream
88 # @threshold: set the threshold (in microseconds) when playback starts
90 # Since: 4.0
92 { 'struct': 'AudiodevAlsaOptions',
93   'data': {
94     '*in':        'AudiodevAlsaPerDirectionOptions',
95     '*out':       'AudiodevAlsaPerDirectionOptions',
96     '*threshold': 'uint32' } }
99 # @AudiodevCoreaudioPerDirectionOptions:
101 # Options of the Core Audio backend that are used for both playback and
102 # recording.
104 # @buffer-count: number of buffers
106 # Since: 4.0
108 { 'struct': 'AudiodevCoreaudioPerDirectionOptions',
109   'base': 'AudiodevPerDirectionOptions',
110   'data': {
111     '*buffer-count': 'uint32' } }
114 # @AudiodevCoreaudioOptions:
116 # Options of the coreaudio audio backend.
118 # @in: options of the capture stream
120 # @out: options of the playback stream
122 # Since: 4.0
124 { 'struct': 'AudiodevCoreaudioOptions',
125   'data': {
126     '*in':  'AudiodevCoreaudioPerDirectionOptions',
127     '*out': 'AudiodevCoreaudioPerDirectionOptions' } }
130 # @AudiodevDsoundOptions:
132 # Options of the DirectSound audio backend.
134 # @in: options of the capture stream
136 # @out: options of the playback stream
138 # @latency: add extra latency to playback in microseconds
139 #           (default 10000)
141 # Since: 4.0
143 { 'struct': 'AudiodevDsoundOptions',
144   'data': {
145     '*in':      'AudiodevPerDirectionOptions',
146     '*out':     'AudiodevPerDirectionOptions',
147     '*latency': 'uint32' } }
150 # @AudiodevOssPerDirectionOptions:
152 # Options of the OSS backend that are used for both playback and
153 # recording.
155 # @dev: file name of the OSS device (default '/dev/dsp')
157 # @buffer-count: number of buffers
159 # @try-poll: attempt to use poll mode, falling back to non-polling
160 #            access on failure (default true)
162 # Since: 4.0
164 { 'struct': 'AudiodevOssPerDirectionOptions',
165   'base': 'AudiodevPerDirectionOptions',
166   'data': {
167     '*dev':          'str',
168     '*buffer-count': 'uint32',
169     '*try-poll':     'bool' } }
172 # @AudiodevOssOptions:
174 # Options of the OSS audio backend.
176 # @in: options of the capture stream
178 # @out: options of the playback stream
180 # @try-mmap: try using memory-mapped access, falling back to
181 #            non-memory-mapped access on failure (default true)
183 # @exclusive: open device in exclusive mode (vmix won't work)
184 #             (default false)
186 # @dsp-policy: set the timing policy of the device (between 0 and 10,
187 #              where smaller number means smaller latency but higher
188 #              CPU usage) or -1 to use fragment mode (option ignored
189 #              on some platforms) (default 5)
191 # Since: 4.0
193 { 'struct': 'AudiodevOssOptions',
194   'data': {
195     '*in':         'AudiodevOssPerDirectionOptions',
196     '*out':        'AudiodevOssPerDirectionOptions',
197     '*try-mmap':   'bool',
198     '*exclusive':  'bool',
199     '*dsp-policy': 'uint32' } }
202 # @AudiodevPaPerDirectionOptions:
204 # Options of the Pulseaudio backend that are used for both playback and
205 # recording.
207 # @name: name of the sink/source to use
209 # @latency: latency you want PulseAudio to achieve in microseconds
210 #           (default 15000)
212 # Since: 4.0
214 { 'struct': 'AudiodevPaPerDirectionOptions',
215   'base': 'AudiodevPerDirectionOptions',
216   'data': {
217     '*name': 'str',
218     '*latency': 'uint32' } }
221 # @AudiodevPaOptions:
223 # Options of the PulseAudio audio backend.
225 # @in: options of the capture stream
227 # @out: options of the playback stream
229 # @server: PulseAudio server address (default: let PulseAudio choose)
231 # Since: 4.0
233 { 'struct': 'AudiodevPaOptions',
234   'data': {
235     '*in':     'AudiodevPaPerDirectionOptions',
236     '*out':    'AudiodevPaPerDirectionOptions',
237     '*server': 'str' } }
240 # @AudiodevWavOptions:
242 # Options of the wav audio backend.
244 # @in: options of the capture stream
246 # @out: options of the playback stream
248 # @path: name of the wav file to record (default 'qemu.wav')
250 # Since: 4.0
252 { 'struct': 'AudiodevWavOptions',
253   'data': {
254     '*in':   'AudiodevPerDirectionOptions',
255     '*out':  'AudiodevPerDirectionOptions',
256     '*path': 'str' } }
260 # @AudioFormat:
262 # An enumeration of possible audio formats.
264 # Since: 4.0
266 { 'enum': 'AudioFormat',
267   'data': [ 'u8', 's8', 'u16', 's16', 'u32', 's32' ] }
270 # @AudiodevDriver:
272 # An enumeration of possible audio backend drivers.
274 # Since: 4.0
276 { 'enum': 'AudiodevDriver',
277   'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa', 'sdl',
278             'spice', 'wav' ] }
281 # @Audiodev:
283 # Options of an audio backend.
285 # @id: identifier of the backend
287 # @driver: the backend driver to use
289 # @timer-period: timer period (in microseconds, 0: use lowest possible)
291 # Since: 4.0
293 { 'union': 'Audiodev',
294   'base': {
295     'id':            'str',
296     'driver':        'AudiodevDriver',
297     '*timer-period': 'uint32' },
298   'discriminator': 'driver',
299   'data': {
300     'none':      'AudiodevGenericOptions',
301     'alsa':      'AudiodevAlsaOptions',
302     'coreaudio': 'AudiodevCoreaudioOptions',
303     'dsound':    'AudiodevDsoundOptions',
304     'oss':       'AudiodevOssOptions',
305     'pa':        'AudiodevPaOptions',
306     'sdl':       'AudiodevGenericOptions',
307     'spice':     'AudiodevGenericOptions',
308     'wav':       'AudiodevWavOptions' } }