1# -*- mode: python -*- 2# 3# Copyright (C) 2015-2019 Zoltán Kővágó <DirtY.iCE.hu@gmail.com> 4# 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. 7 8## 9# @AudiodevPerDirectionOptions: 10# 11# General audio backend options that are used for both playback and 12# recording. 13# 14# @fixed-settings: use fixed settings for host input/output. When off, 15# frequency, channels and format must not be 16# specified (default true) 17# 18# @frequency: frequency to use when using fixed settings 19# (default 44100) 20# 21# @channels: number of channels when using fixed settings (default 2) 22# 23# @voices: number of voices to use (default 1) 24# 25# @format: sample format to use when using fixed settings 26# (default s16) 27# 28# @buffer-length: the buffer length in microseconds 29# 30# Since: 4.0 31## 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' } } 40 41## 42# @AudiodevGenericOptions: 43# 44# Generic driver-specific options. 45# 46# @in: options of the capture stream 47# 48# @out: options of the playback stream 49# 50# Since: 4.0 51## 52{ 'struct': 'AudiodevGenericOptions', 53 'data': { 54 '*in': 'AudiodevPerDirectionOptions', 55 '*out': 'AudiodevPerDirectionOptions' } } 56 57## 58# @AudiodevAlsaPerDirectionOptions: 59# 60# Options of the ALSA backend that are used for both playback and 61# recording. 62# 63# @dev: the name of the ALSA device to use (default 'default') 64# 65# @period-length: the period length in microseconds 66# 67# @try-poll: attempt to use poll mode, falling back to non-polling 68# access on failure (default true) 69# 70# Since: 4.0 71## 72{ 'struct': 'AudiodevAlsaPerDirectionOptions', 73 'base': 'AudiodevPerDirectionOptions', 74 'data': { 75 '*dev': 'str', 76 '*period-length': 'uint32', 77 '*try-poll': 'bool' } } 78 79## 80# @AudiodevAlsaOptions: 81# 82# Options of the ALSA audio backend. 83# 84# @in: options of the capture stream 85# 86# @out: options of the playback stream 87# 88# @threshold: set the threshold (in microseconds) when playback starts 89# 90# Since: 4.0 91## 92{ 'struct': 'AudiodevAlsaOptions', 93 'data': { 94 '*in': 'AudiodevAlsaPerDirectionOptions', 95 '*out': 'AudiodevAlsaPerDirectionOptions', 96 '*threshold': 'uint32' } } 97 98## 99# @AudiodevCoreaudioPerDirectionOptions: 100# 101# Options of the Core Audio backend that are used for both playback and 102# recording. 103# 104# @buffer-count: number of buffers 105# 106# Since: 4.0 107## 108{ 'struct': 'AudiodevCoreaudioPerDirectionOptions', 109 'base': 'AudiodevPerDirectionOptions', 110 'data': { 111 '*buffer-count': 'uint32' } } 112 113## 114# @AudiodevCoreaudioOptions: 115# 116# Options of the coreaudio audio backend. 117# 118# @in: options of the capture stream 119# 120# @out: options of the playback stream 121# 122# Since: 4.0 123## 124{ 'struct': 'AudiodevCoreaudioOptions', 125 'data': { 126 '*in': 'AudiodevCoreaudioPerDirectionOptions', 127 '*out': 'AudiodevCoreaudioPerDirectionOptions' } } 128 129## 130# @AudiodevDsoundOptions: 131# 132# Options of the DirectSound audio backend. 133# 134# @in: options of the capture stream 135# 136# @out: options of the playback stream 137# 138# @latency: add extra latency to playback in microseconds 139# (default 10000) 140# 141# Since: 4.0 142## 143{ 'struct': 'AudiodevDsoundOptions', 144 'data': { 145 '*in': 'AudiodevPerDirectionOptions', 146 '*out': 'AudiodevPerDirectionOptions', 147 '*latency': 'uint32' } } 148 149## 150# @AudiodevOssPerDirectionOptions: 151# 152# Options of the OSS backend that are used for both playback and 153# recording. 154# 155# @dev: file name of the OSS device (default '/dev/dsp') 156# 157# @buffer-count: number of buffers 158# 159# @try-poll: attempt to use poll mode, falling back to non-polling 160# access on failure (default true) 161# 162# Since: 4.0 163## 164{ 'struct': 'AudiodevOssPerDirectionOptions', 165 'base': 'AudiodevPerDirectionOptions', 166 'data': { 167 '*dev': 'str', 168 '*buffer-count': 'uint32', 169 '*try-poll': 'bool' } } 170 171## 172# @AudiodevOssOptions: 173# 174# Options of the OSS audio backend. 175# 176# @in: options of the capture stream 177# 178# @out: options of the playback stream 179# 180# @try-mmap: try using memory-mapped access, falling back to 181# non-memory-mapped access on failure (default true) 182# 183# @exclusive: open device in exclusive mode (vmix won't work) 184# (default false) 185# 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) 190# 191# Since: 4.0 192## 193{ 'struct': 'AudiodevOssOptions', 194 'data': { 195 '*in': 'AudiodevOssPerDirectionOptions', 196 '*out': 'AudiodevOssPerDirectionOptions', 197 '*try-mmap': 'bool', 198 '*exclusive': 'bool', 199 '*dsp-policy': 'uint32' } } 200 201## 202# @AudiodevPaPerDirectionOptions: 203# 204# Options of the Pulseaudio backend that are used for both playback and 205# recording. 206# 207# @name: name of the sink/source to use 208# 209# @latency: latency you want PulseAudio to achieve in microseconds 210# (default 15000) 211# 212# Since: 4.0 213## 214{ 'struct': 'AudiodevPaPerDirectionOptions', 215 'base': 'AudiodevPerDirectionOptions', 216 'data': { 217 '*name': 'str', 218 '*latency': 'uint32' } } 219 220## 221# @AudiodevPaOptions: 222# 223# Options of the PulseAudio audio backend. 224# 225# @in: options of the capture stream 226# 227# @out: options of the playback stream 228# 229# @server: PulseAudio server address (default: let PulseAudio choose) 230# 231# Since: 4.0 232## 233{ 'struct': 'AudiodevPaOptions', 234 'data': { 235 '*in': 'AudiodevPaPerDirectionOptions', 236 '*out': 'AudiodevPaPerDirectionOptions', 237 '*server': 'str' } } 238 239## 240# @AudiodevWavOptions: 241# 242# Options of the wav audio backend. 243# 244# @in: options of the capture stream 245# 246# @out: options of the playback stream 247# 248# @path: name of the wav file to record (default 'qemu.wav') 249# 250# Since: 4.0 251## 252{ 'struct': 'AudiodevWavOptions', 253 'data': { 254 '*in': 'AudiodevPerDirectionOptions', 255 '*out': 'AudiodevPerDirectionOptions', 256 '*path': 'str' } } 257 258 259## 260# @AudioFormat: 261# 262# An enumeration of possible audio formats. 263# 264# Since: 4.0 265## 266{ 'enum': 'AudioFormat', 267 'data': [ 'u8', 's8', 'u16', 's16', 'u32', 's32' ] } 268 269## 270# @AudiodevDriver: 271# 272# An enumeration of possible audio backend drivers. 273# 274# Since: 4.0 275## 276{ 'enum': 'AudiodevDriver', 277 'data': [ 'none', 'alsa', 'coreaudio', 'dsound', 'oss', 'pa', 'sdl', 278 'spice', 'wav' ] } 279 280## 281# @Audiodev: 282# 283# Options of an audio backend. 284# 285# @id: identifier of the backend 286# 287# @driver: the backend driver to use 288# 289# @timer-period: timer period (in microseconds, 0: use lowest possible) 290# 291# Since: 4.0 292## 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' } } 309