# General audio backend options that are used for both playback and
# recording.
#
-# @mixing-engine: use QEMU's mixing engine to mix all streams inside QEMU and
-# convert audio formats when not supported by the backend. When
-# set to off, fixed-settings must be also off (default on,
-# since 4.2)
+# @mixing-engine: use QEMU's mixing engine to mix all streams inside
+# QEMU and convert audio formats when not supported by the
+# backend. When set to off, fixed-settings must be also off
+# (default on, since 4.2)
#
-# @fixed-settings: use fixed settings for host input/output. When off,
-# frequency, channels and format must not be
-# specified (default true)
+# @fixed-settings: use fixed settings for host input/output. When
+# off, frequency, channels and format must not be specified
+# (default true)
#
-# @frequency: frequency to use when using fixed settings
-# (default 44100)
+# @frequency: frequency to use when using fixed settings (default
+# 44100)
#
# @channels: number of channels when using fixed settings (default 2)
#
# @voices: number of voices to use (default 1)
#
-# @format: sample format to use when using fixed settings
-# (default s16)
+# @format: sample format to use when using fixed settings (default
+# s16)
#
# @buffer-length: the buffer length in microseconds
#
# @period-length: the period length in microseconds
#
# @try-poll: attempt to use poll mode, falling back to non-polling
-# access on failure (default true)
+# access on failure (default true)
#
# Since: 4.0
##
##
# @AudiodevCoreaudioPerDirectionOptions:
#
-# Options of the Core Audio backend that are used for both playback and
-# recording.
+# Options of the Core Audio backend that are used for both playback
+# and recording.
#
# @buffer-count: number of buffers
#
#
# @out: options of the playback stream
#
-# @latency: add extra latency to playback in microseconds
-# (default 10000)
+# @latency: add extra latency to playback in microseconds (default
+# 10000)
#
# Since: 4.0
##
# Options of the JACK backend that are used for both playback and
# recording.
#
-# @server-name: select from among several possible concurrent server instances
-# (default: environment variable $JACK_DEFAULT_SERVER if set, else "default")
+# @server-name: select from among several possible concurrent server
+# instances (default: environment variable $JACK_DEFAULT_SERVER if
+# set, else "default")
#
-# @client-name: the client name to use. The server will modify this name to
-# create a unique variant, if needed unless @exact-name is true (default: the
-# guest's name)
+# @client-name: the client name to use. The server will modify this
+# name to create a unique variant, if needed unless @exact-name is
+# true (default: the guest's name)
#
-# @connect-ports: if set, a regular expression of JACK client port name(s) to
-# monitor for and automatically connect to
+# @connect-ports: if set, a regular expression of JACK client port
+# name(s) to monitor for and automatically connect to
#
-# @start-server: start a jack server process if one is not already present
-# (default: false)
+# @start-server: start a jack server process if one is not already
+# present (default: false)
#
-# @exact-name: use the exact name requested otherwise JACK automatically
-# generates a unique one, if needed (default: false)
+# @exact-name: use the exact name requested otherwise JACK
+# automatically generates a unique one, if needed (default: false)
#
# Since: 5.1
##
# @buffer-count: number of buffers
#
# @try-poll: attempt to use poll mode, falling back to non-polling
-# access on failure (default true)
+# access on failure (default true)
#
# Since: 4.0
##
# @out: options of the playback stream
#
# @try-mmap: try using memory-mapped access, falling back to
-# non-memory-mapped access on failure (default true)
+# non-memory-mapped access on failure (default true)
#
-# @exclusive: open device in exclusive mode (vmix won't work)
-# (default false)
+# @exclusive: open device in exclusive mode (vmix won't work) (default
+# false)
#
# @dsp-policy: set the timing policy of the device (between 0 and 10,
-# where smaller number means smaller latency but higher
-# CPU usage) or -1 to use fragment mode (option ignored
-# on some platforms) (default 5)
+# where smaller number means smaller latency but higher CPU usage)
+# or -1 to use fragment mode (option ignored on some platforms)
+# (default 5)
#
# Since: 4.0
##
##
# @AudiodevPaPerDirectionOptions:
#
-# Options of the Pulseaudio backend that are used for both playback and
-# recording.
+# Options of the Pulseaudio backend that are used for both playback
+# and recording.
#
# @name: name of the sink/source to use
#
# @stream-name: name of the PulseAudio stream created by qemu. Can be
-# used to identify the stream in PulseAudio when you
-# create multiple PulseAudio devices or run multiple qemu
-# instances (default: audiodev's id, since 4.2)
+# used to identify the stream in PulseAudio when you create
+# multiple PulseAudio devices or run multiple qemu instances
+# (default: audiodev's id, since 4.2)
#
# @latency: latency you want PulseAudio to achieve in microseconds
-# (default 15000)
+# (default 15000)
#
# Since: 4.0
##
'*out': 'AudiodevPaPerDirectionOptions',
'*server': 'str' } }
+##
+# @AudiodevPipewirePerDirectionOptions:
+#
+# Options of the PipeWire backend that are used for both playback and
+# recording.
+#
+# @name: name of the sink/source to use
+#
+# @stream-name: name of the PipeWire stream created by qemu. Can be
+# used to identify the stream in PipeWire when you create multiple
+# PipeWire devices or run multiple qemu instances (default:
+# audiodev's id)
+#
+# @latency: latency you want PipeWire to achieve in microseconds
+# (default 46000)
+#
+# Since: 8.1
+##
+{ 'struct': 'AudiodevPipewirePerDirectionOptions',
+ 'base': 'AudiodevPerDirectionOptions',
+ 'data': {
+ '*name': 'str',
+ '*stream-name': 'str',
+ '*latency': 'uint32' } }
+
+##
+# @AudiodevPipewireOptions:
+#
+# Options of the PipeWire audio backend.
+#
+# @in: options of the capture stream
+#
+# @out: options of the playback stream
+#
+# Since: 8.1
+##
+{ 'struct': 'AudiodevPipewireOptions',
+ 'data': {
+ '*in': 'AudiodevPipewirePerDirectionOptions',
+ '*out': 'AudiodevPipewirePerDirectionOptions' } }
+
##
# @AudiodevSdlPerDirectionOptions:
#
# Since: 4.0
##
{ 'enum': 'AudiodevDriver',
- 'data': [ 'none', 'alsa', 'coreaudio', 'dbus', 'dsound', 'jack', 'oss', 'pa',
- 'sdl', 'sndio', 'spice', 'wav' ] }
+ 'data': [ 'none',
+ { 'name': 'alsa', 'if': 'CONFIG_AUDIO_ALSA' },
+ { 'name': 'coreaudio', 'if': 'CONFIG_AUDIO_COREAUDIO' },
+ { 'name': 'dbus', 'if': 'CONFIG_DBUS_DISPLAY' },
+ { 'name': 'dsound', 'if': 'CONFIG_AUDIO_DSOUND' },
+ { 'name': 'jack', 'if': 'CONFIG_AUDIO_JACK' },
+ { 'name': 'oss', 'if': 'CONFIG_AUDIO_OSS' },
+ { 'name': 'pa', 'if': 'CONFIG_AUDIO_PA' },
+ { 'name': 'pipewire', 'if': 'CONFIG_AUDIO_PIPEWIRE' },
+ { 'name': 'sdl', 'if': 'CONFIG_AUDIO_SDL' },
+ { 'name': 'sndio', 'if': 'CONFIG_AUDIO_SNDIO' },
+ { 'name': 'spice', 'if': 'CONFIG_SPICE' },
+ 'wav' ] }
##
# @Audiodev:
#
# @driver: the backend driver to use
#
-# @timer-period: timer period (in microseconds, 0: use lowest possible)
+# @timer-period: timer period (in microseconds, 0: use lowest
+# possible)
#
# Since: 4.0
##
'discriminator': 'driver',
'data': {
'none': 'AudiodevGenericOptions',
- 'alsa': 'AudiodevAlsaOptions',
- 'coreaudio': 'AudiodevCoreaudioOptions',
- 'dbus': 'AudiodevGenericOptions',
- 'dsound': 'AudiodevDsoundOptions',
- 'jack': 'AudiodevJackOptions',
- 'oss': 'AudiodevOssOptions',
- 'pa': 'AudiodevPaOptions',
- 'sdl': 'AudiodevSdlOptions',
- 'sndio': 'AudiodevSndioOptions',
- 'spice': 'AudiodevGenericOptions',
+ 'alsa': { 'type': 'AudiodevAlsaOptions',
+ 'if': 'CONFIG_AUDIO_ALSA' },
+ 'coreaudio': { 'type': 'AudiodevCoreaudioOptions',
+ 'if': 'CONFIG_AUDIO_COREAUDIO' },
+ 'dbus': { 'type': 'AudiodevGenericOptions',
+ 'if': 'CONFIG_DBUS_DISPLAY' },
+ 'dsound': { 'type': 'AudiodevDsoundOptions',
+ 'if': 'CONFIG_AUDIO_DSOUND' },
+ 'jack': { 'type': 'AudiodevJackOptions',
+ 'if': 'CONFIG_AUDIO_JACK' },
+ 'oss': { 'type': 'AudiodevOssOptions',
+ 'if': 'CONFIG_AUDIO_OSS' },
+ 'pa': { 'type': 'AudiodevPaOptions',
+ 'if': 'CONFIG_AUDIO_PA' },
+ 'pipewire': { 'type': 'AudiodevPipewireOptions',
+ 'if': 'CONFIG_AUDIO_PIPEWIRE' },
+ 'sdl': { 'type': 'AudiodevSdlOptions',
+ 'if': 'CONFIG_AUDIO_SDL' },
+ 'sndio': { 'type': 'AudiodevSndioOptions',
+ 'if': 'CONFIG_AUDIO_SNDIO' },
+ 'spice': { 'type': 'AudiodevGenericOptions',
+ 'if': 'CONFIG_SPICE' },
'wav': 'AudiodevWavOptions' } }
+
+##
+# @query-audiodevs:
+#
+# Returns information about audiodev configuration
+#
+# Returns: array of @Audiodev
+#
+# Since: 8.0
+##
+{ 'command': 'query-audiodevs',
+ 'returns': ['Audiodev'] }
projects / mirror_qemu.git / blobdiff