[libvirt] [PATCH 0/3]add usb-audio support
This set of patches is trying to add qemu usb-audio virtual device support. usb-audio XML example: <devices> <sound model='usb-audio'> <buffer>1536</buffer> <address type='usb' bus='0' port='1'/> </sound> </devices> qemu ${other_vm_args} \ -device usb-audio,id=sound0,buffer=1536,bus=usb.0,port=1 There is an optional sub-element <buffer> to customize the buffer size of usb audio device, if missing, the default size is 1536(defined in qemu code). Special size of value 0 means no buffer will be used, so we use bool 'customized_buffer'to differentiate user-defined 0 from being using default buffer value 1536. Guannan Ren(3) [PATCH 1/3] qemu: add usb-audio caps flag [PATCH 2/3] qemu: parse usb-audio audio device XML and docs [PATCH 3/3] test: add usb-audio testcase docs/formatdomain.html.in | 10 ++++++++-- docs/schemas/basictypes.rng | 11 +++++++++++ docs/schemas/domaincommon.rng | 9 +++++++++ docs/schemas/nwfilter.rng | 15 --------------- src/conf/domain_conf.c | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- src/conf/domain_conf.h | 5 +++++ src/qemu/qemu_capabilities.c | 2 ++ src/qemu/qemu_capabilities.h | 1 + src/qemu/qemu_command.c | 19 ++++++++++++++++++- tests/qemuhelptest.c | 9 ++++++--- tests/qemuxml2argvdata/qemuxml2argv-usb-audio.args | 7 +++++++ tests/qemuxml2argvdata/qemuxml2argv-usb-audio.xml | 31 +++++++++++++++++++++++++++++++ tests/qemuxml2argvtest.c | 3 +++ 13 files changed, 149 insertions(+), 22 deletions(-)
QEMU_CAPS_DEVICE_USB_AUDIO /* -device usb-audio */ --- src/qemu/qemu_capabilities.c | 2 ++ src/qemu/qemu_capabilities.h | 1 + tests/qemuhelptest.c | 9 ++++++--- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index 17e6679..3b6ce50 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -199,6 +199,7 @@ VIR_ENUM_IMPL(qemuCaps, QEMU_CAPS_LAST, "cirrus-vga", "vmware-svga", "device-video-primary", + "usb-audio", ); struct _qemuCaps { @@ -1343,6 +1344,7 @@ struct qemuCapsStringFlags qemuCapsObjectTypes[] = { { "VGA", QEMU_CAPS_DEVICE_VGA }, { "cirrus-vga", QEMU_CAPS_DEVICE_CIRRUS_VGA }, { "vmware-svga", QEMU_CAPS_DEVICE_VMWARE_SVGA }, + { "usb-audio", QEMU_CAPS_DEVICE_USB_AUDIO}, }; diff --git a/src/qemu/qemu_capabilities.h b/src/qemu/qemu_capabilities.h index 3457852..ed56b9a 100644 --- a/src/qemu/qemu_capabilities.h +++ b/src/qemu/qemu_capabilities.h @@ -162,6 +162,7 @@ enum qemuCapsFlags { QEMU_CAPS_DEVICE_VMWARE_SVGA = 122, /* -device vmware-svga */ QEMU_CAPS_DEVICE_VIDEO_PRIMARY = 123, /* safe to use -device XXX for primary video device */ + QEMU_CAPS_DEVICE_USB_AUDIO = 124, /* -device usb-audio */ QEMU_CAPS_LAST, /* this must always be the last item */ }; diff --git a/tests/qemuhelptest.c b/tests/qemuhelptest.c index 252ad3a..7576258 100644 --- a/tests/qemuhelptest.c +++ b/tests/qemuhelptest.c @@ -801,7 +801,8 @@ mymain(void) QEMU_CAPS_DEVICE_QXL, QEMU_CAPS_DEVICE_VGA, QEMU_CAPS_DEVICE_CIRRUS_VGA, - QEMU_CAPS_DEVICE_VMWARE_SVGA); + QEMU_CAPS_DEVICE_VMWARE_SVGA, + QEMU_CAPS_DEVICE_USB_AUDIO); DO_TEST("qemu-1.2.0", 1002000, 0, 0, QEMU_CAPS_VNC_COLON, QEMU_CAPS_NO_REBOOT, @@ -898,7 +899,8 @@ mymain(void) QEMU_CAPS_DEVICE_VGA, QEMU_CAPS_DEVICE_CIRRUS_VGA, QEMU_CAPS_DEVICE_VMWARE_SVGA, - QEMU_CAPS_DEVICE_VIDEO_PRIMARY); + QEMU_CAPS_DEVICE_VIDEO_PRIMARY, + QEMU_CAPS_DEVICE_USB_AUDIO); DO_TEST("qemu-kvm-1.2.0", 1002000, 1, 0, QEMU_CAPS_VNC_COLON, QEMU_CAPS_NO_REBOOT, @@ -1000,7 +1002,8 @@ mymain(void) QEMU_CAPS_DEVICE_VGA, QEMU_CAPS_DEVICE_CIRRUS_VGA, QEMU_CAPS_DEVICE_VMWARE_SVGA, - QEMU_CAPS_DEVICE_VIDEO_PRIMARY); + QEMU_CAPS_DEVICE_VIDEO_PRIMARY, + QEMU_CAPS_DEVICE_USB_AUDIO); return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE; } -- 1.7.11.4
usb-audio XML example: <devices> <sound model='usb-audio'> <buffer>1536</buffer> <address type='usb' bus='0' port='1'/> </sound> </devices> qemu ${other_vm_args} \ -device usb-audio,id=sound0,buffer=1536,bus=usb.0,port=1 there is an optional sub-element <buffer> to customize the buffer size of usb audio device, if missing, the default size is 1536(defined in qemu code). Special size of value 0 means no buffer will be used, so we use bool 'customized_buffer'to differentiate user-defined 0 from being using default buffer value 1536. --- docs/formatdomain.html.in | 10 +++++++-- docs/schemas/basictypes.rng | 11 ++++++++++ docs/schemas/domaincommon.rng | 9 ++++++++ docs/schemas/nwfilter.rng | 15 ------------- src/conf/domain_conf.c | 49 ++++++++++++++++++++++++++++++++++++++++++- src/conf/domain_conf.h | 5 +++++ src/qemu/qemu_command.c | 19 ++++++++++++++++- 7 files changed, 99 insertions(+), 19 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 94df6f8..354d4f6 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -4056,9 +4056,15 @@ qemu-kvm -net nic,model=? /dev/null The <code>sound</code> element has one mandatory attribute, <code>model</code>, which specifies what real sound device is emulated. Valid values are specific to the underlying hypervisor, though typical - choices are 'es1370', 'sb16', 'ac97', and 'ich6' + choices are 'es1370', 'sb16', 'ac97', 'ich6' and 'usb-audio' (<span class="since"> - 'ac97' only since 0.6.0, 'ich6' only since 0.8.8</span>) + 'ac97' only since 0.6.0, 'ich6' only since 0.8.8, + 'usb-audio' only since 1.0.2</span>) + For the 'usb-audio' model, there is an optional sub-element <code><buffer></code> + to customize the buffer size of the audio device, if missing, the default size is 1536. + The goal of setting a buffer size is to reduce it as much as possible without + hearing any clicks, pops, or other glitches. Special size of value 0 means no buffer + will be used, e.g. <code><buffer>3072</buffer></code>. </dd> </dl> diff --git a/docs/schemas/basictypes.rng b/docs/schemas/basictypes.rng index 38cab16..4e8d4b8 100644 --- a/docs/schemas/basictypes.rng +++ b/docs/schemas/basictypes.rng @@ -42,6 +42,17 @@ </data> </choice> </define> + <define name="uint32range"> + <choice> + <data type="string"> + <param name="pattern">0x[0-9a-fA-F]{1,8}</param> + </data> + <data type="long"> + <param name="minInclusive">0</param> + <param name="maxInclusive">4294967295</param> + </data> + </choice> + </define> <define name="UUID"> <choice> diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng index 0529d62..55c1219 100644 --- a/docs/schemas/domaincommon.rng +++ b/docs/schemas/domaincommon.rng @@ -2599,6 +2599,11 @@ </attribute> </element> </define> + <define name="audiobuffer"> + <element name='buffer'> + <ref name="uint32range"/> + </element> + </define> <define name="sound"> <element name="sound"> <attribute name="model"> @@ -2608,6 +2613,7 @@ <value>pcspk</value> <value>ac97</value> <value>ich6</value> + <value>usb-audio</value> </choice> </attribute> <interleave> @@ -2622,6 +2628,9 @@ <ref name="codec"/> </choice> </zeroOrMore> + <optional> + <ref name ="audiobuffer"/> + </optional> </interleave> </element> </define> diff --git a/docs/schemas/nwfilter.rng b/docs/schemas/nwfilter.rng index cfd9ba5..5681083 100644 --- a/docs/schemas/nwfilter.rng +++ b/docs/schemas/nwfilter.rng @@ -942,21 +942,6 @@ </choice> </define> - <define name="uint32range"> - <choice> - <ref name="variable-name-type"/> - - <data type="string"> - <param name="pattern">0x[0-9a-fA-F]{1,8}</param> - </data> - - <data type="int"> - <param name="minInclusive">0</param> - <param name="maxInclusive">4294967295</param> - </data> - </choice> - </define> - <define name="boolean"> <choice> <value>yes</value> diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index 79af087..955e089 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -395,7 +395,8 @@ VIR_ENUM_IMPL(virDomainSoundModel, VIR_DOMAIN_SOUND_MODEL_LAST, "es1370", "pcspk", "ac97", - "ich6") + "ich6", + "usb-audio") VIR_ENUM_IMPL(virDomainMemDump, VIR_DOMAIN_MEM_DUMP_LAST, "default", @@ -7009,6 +7010,38 @@ error: goto cleanup; } +static int +virDomainSoundUSBAudioBufferParseXML(const xmlNodePtr node, + xmlXPathContextPtr ctxt, + virDomainSoundDefPtr def) +{ + int ret; + unsigned long value; + + if (!node || !ctxt) + return -1; + + ret = virXPathULong("string(./buffer[1])", ctxt, &value); + if (ret < 0) { + if (ret == -2) { + virReportError(VIR_ERR_XML_ERROR, + "%s", _("could not parse usb-audio buffer element")); + return -1; + } else { + def->customized_buffer = false; + } + } else if (value > UINT32_MAX) { + virReportError(VIR_ERR_CONFIG_UNSUPPORTED, + "%s", _("usb-audio buffer is too big, " + "no more than 4294967295")); + return -1; + } else { + def->buf_value = value; + def->customized_buffer = true; + } + + return 0; +} static virDomainSoundDefPtr virDomainSoundDefParseXML(const xmlNodePtr node, @@ -7063,6 +7096,11 @@ virDomainSoundDefParseXML(const xmlNodePtr node, } } + if (def->model == VIR_DOMAIN_SOUND_MODEL_USB_AUDIO) { + if (virDomainSoundUSBAudioBufferParseXML(node, ctxt, def) < 0) + goto error; + } + if (virDomainDeviceInfoParseXML(node, NULL, &def->info, flags) < 0) goto error; @@ -13204,6 +13242,15 @@ virDomainSoundDefFormat(virBufferPtr buf, virDomainSoundCodecDefFormat(buf, def->codecs[i]); } + if (def->customized_buffer) { + if (!children) { + virBufferAddLit(buf, ">\n"); + children = true; + } + virBufferAsprintf(buf, " <buffer>%lu</buffer>\n", + (unsigned long)def->buf_value); + } + if (virDomainDeviceInfoIsSet(&def->info, flags)) { if (!children) { virBufferAddLit(buf, ">\n"); diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h index a975a63..6493443 100644 --- a/src/conf/domain_conf.h +++ b/src/conf/domain_conf.h @@ -1073,6 +1073,7 @@ enum virDomainSoundModel { VIR_DOMAIN_SOUND_MODEL_PCSPK, VIR_DOMAIN_SOUND_MODEL_AC97, VIR_DOMAIN_SOUND_MODEL_ICH6, + VIR_DOMAIN_SOUND_MODEL_USB_AUDIO, VIR_DOMAIN_SOUND_MODEL_LAST }; @@ -1088,6 +1089,10 @@ struct _virDomainSoundDef { size_t ncodecs; virDomainSoundCodecDefPtr *codecs; + + /* for usb-audio only */ + bool customized_buffer; + uint32_t buf_value; }; enum virDomainWatchdogModel { diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index 8a3de09..31b0d89 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -1571,7 +1571,8 @@ qemuAssignDevicePCISlots(virDomainDefPtr def, continue; /* Skip ISA sound card, and PCSPK */ if (def->sounds[i]->model == VIR_DOMAIN_SOUND_MODEL_SB16 || - def->sounds[i]->model == VIR_DOMAIN_SOUND_MODEL_PCSPK) + def->sounds[i]->model == VIR_DOMAIN_SOUND_MODEL_PCSPK || + def->sounds[i]->model == VIR_DOMAIN_SOUND_MODEL_USB_AUDIO) continue; if (qemuDomainPCIAddressSetNextAddr(addrs, &def->sounds[i]->info) < 0) @@ -3462,7 +3463,23 @@ qemuBuildSoundDevStr(virDomainSoundDefPtr sound, else if (STREQ(model, "ich6")) model = "intel-hda"; + if (STREQ(model, "usb-audio")) { + if (!qemuCapsGet(caps, QEMU_CAPS_DEVICE_USB_AUDIO)) { + virReportError(VIR_ERR_CONFIG_UNSUPPORTED, + "%s", _("usb-audio is not supported" + " by this version of QEMU")); + goto error; + } else { + model = "usb-audio"; + } + } + virBufferAsprintf(&buf, "%s,id=%s", model, sound->info.alias); + + if (sound->customized_buffer) + virBufferAsprintf(&buf, ",buffer=%lu", + (unsigned long)sound->buf_value); + if (qemuBuildDeviceAddressStr(&buf, &sound->info, caps) < 0) goto error; -- 1.7.11.4
--- tests/qemuxml2argvdata/qemuxml2argv-usb-audio.args | 7 +++++ tests/qemuxml2argvdata/qemuxml2argv-usb-audio.xml | 31 ++++++++++++++++++++++ tests/qemuxml2argvtest.c | 3 +++ 3 files changed, 41 insertions(+) create mode 100644 tests/qemuxml2argvdata/qemuxml2argv-usb-audio.args create mode 100644 tests/qemuxml2argvdata/qemuxml2argv-usb-audio.xml diff --git a/tests/qemuxml2argvdata/qemuxml2argv-usb-audio.args b/tests/qemuxml2argvdata/qemuxml2argv-usb-audio.args new file mode 100644 index 0000000..fe2551f --- /dev/null +++ b/tests/qemuxml2argvdata/qemuxml2argv-usb-audio.args @@ -0,0 +1,7 @@ +LC_ALL=C PATH=/bin HOME=/home/test USER=test LOGNAME=test /usr/bin/qemu \ +-S -M pc-0.15 -m 1024 -smp 1 -nographic -nodefaults \ +-monitor unix:/tmp/test-monitor,server,nowait -no-acpi -boot c \ +-device piix3-usb-uhci,id=usb,bus=pci.0,addr=0x1.0x2 \ +-hda /var/lib/libvirt/images/QEMUGuest1 \ +-device usb-audio,id=sound0,buffer=1536,bus=usb.0,port=1 \ +-device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x3 diff --git a/tests/qemuxml2argvdata/qemuxml2argv-usb-audio.xml b/tests/qemuxml2argvdata/qemuxml2argv-usb-audio.xml new file mode 100644 index 0000000..037d71a --- /dev/null +++ b/tests/qemuxml2argvdata/qemuxml2argv-usb-audio.xml @@ -0,0 +1,31 @@ +<domain type='qemu'> + <name>QEMUGuest1</name> + <uuid>cdbebdfa-1d6d-65c3-be0f-fd74b978a773</uuid> + <memory unit='KiB'>1048576</memory> + <currentMemory unit='KiB'>1048576</currentMemory> + <vcpu placement='static'>1</vcpu> + <os> + <type arch='x86_64' machine='pc-0.15'>hvm</type> + <boot dev='hd'/> + </os> + <clock offset='utc'/> + <on_poweroff>destroy</on_poweroff> + <on_reboot>restart</on_reboot> + <on_crash>restart</on_crash> + <devices> + <emulator>/usr/bin/qemu</emulator> + <disk type='file' device='disk'> + <driver name='qemu' type='qcow2' cache='none'/> + <source file='/var/lib/libvirt/images/QEMUGuest1'/> + <target dev='hda' bus='ide'/> + <address type='drive' controller='0' bus='0' target='0' unit='0'/> + </disk> + <controller type='usb' index='0' model='piix3-uhci'/> + <controller type='ide' index='0'> + </controller> + <sound model='usb-audio'> + <buffer>1536</buffer> + <address type='usb' bus='0' port='1'/> + </sound> + </devices> +</domain> diff --git a/tests/qemuxml2argvtest.c b/tests/qemuxml2argvtest.c index 9e2c4e4..7405583 100644 --- a/tests/qemuxml2argvtest.c +++ b/tests/qemuxml2argvtest.c @@ -767,6 +767,9 @@ mymain(void) DO_TEST("sound-device", QEMU_CAPS_DEVICE, QEMU_CAPS_NODEFCONFIG, QEMU_CAPS_HDA_DUPLEX, QEMU_CAPS_HDA_MICRO); + DO_TEST("usb-audio", + QEMU_CAPS_DEVICE, QEMU_CAPS_PIIX3_USB_UHCI, + QEMU_CAPS_DEVICE_USB_AUDIO, QEMU_CAPS_PCI_MULTIFUNCTION); DO_TEST("fs9p", QEMU_CAPS_DEVICE, QEMU_CAPS_NODEFCONFIG, QEMU_CAPS_FSDEV, QEMU_CAPS_FSDEV_WRITEOUT); -- 1.7.11.4
participants (1)
-
Guannan Ren