[PATCH v2] RFC: audio: deprecate HMP audio commands
From: Marc-André Lureau <marcandre.lureau@redhat.com> The command is niche and better served by the host audio system. There is no QMP equivalent, fortunately. You can capture the audio stream via remote desktop protocols too (dbus, vnc, spice). Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> --- docs/about/deprecated.rst | 20 ++++++++++++++++++++ meson.build | 4 ++++ audio/audio-hmp-cmds.c | 7 +++++++ audio/meson.build | 5 +++-- hmp-commands-info.hx | 2 ++ hmp-commands.hx | 2 ++ 6 files changed, 38 insertions(+), 2 deletions(-) diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst index 98361f5832..a357f207cf 100644 --- a/docs/about/deprecated.rst +++ b/docs/about/deprecated.rst @@ -169,6 +169,26 @@ Use ``job-finalize`` instead. This argument has always been ignored. +Human Machine Protocol (HMP) commands +------------------------------------- + +``wavcapture`` (since 10.2) +'''''''''''''''''''''''''''' + +The ``wavcapture`` command is deprecated and will be removed in a future release. + +Use ``-audiodev wav`` or your host audio system to capture audio. + +``stopcapture`` (since 10.2) +'''''''''''''''''''''''''''' + +The ``stopcapture`` command is deprecated and will be removed in a future release. + +``info`` argument ``capture`` (since 10.2) +'''''''''''''''''''''''''''''''''''''''''' + +The ``info capture`` command is deprecated and will be removed in a future release. + Host Architectures ------------------ diff --git a/meson.build b/meson.build index afaefa0172..a4d8e33132 100644 --- a/meson.build +++ b/meson.build @@ -2354,6 +2354,10 @@ endif config_host_data = configuration_data() config_host_data.set('CONFIG_HAVE_RUST', have_rust) + +# HMP code deprecated since v10.2, to be removed +config_host_data.set('CONFIG_AUDIO_HMP', true) + audio_drivers_selected = [] if have_system audio_drivers_available = { diff --git a/audio/audio-hmp-cmds.c b/audio/audio-hmp-cmds.c index 8774c09f18..9129a02331 100644 --- a/audio/audio-hmp-cmds.c +++ b/audio/audio-hmp-cmds.c @@ -28,6 +28,7 @@ #include "monitor/monitor.h" #include "qapi/error.h" #include "qobject/qdict.h" +#include "qemu/error-report.h" static QLIST_HEAD (capture_list_head, CaptureState) capture_head; @@ -36,6 +37,8 @@ void hmp_info_capture(Monitor *mon, const QDict *qdict) int i; CaptureState *s; + warn_report_once("'info capture' is deprecated since v10.2, to be removed"); + for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) { monitor_printf(mon, "[%d]: ", i); s->ops.info (s->opaque); @@ -48,6 +51,8 @@ void hmp_stopcapture(Monitor *mon, const QDict *qdict) int n = qdict_get_int(qdict, "n"); CaptureState *s; + warn_report_once("'stopcapture' is deprecated since v10.2, to be removed"); + for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) { if (i == n) { s->ops.destroy (s->opaque); @@ -69,6 +74,8 @@ void hmp_wavcapture(Monitor *mon, const QDict *qdict) Error *local_err = NULL; AudioState *as = audio_state_by_name(audiodev, &local_err); + warn_report_once("'wavcapture' is deprecated since v10.2, to be removed"); + if (!as) { error_report_err(local_err); return; diff --git a/audio/meson.build b/audio/meson.build index 59f0a431d5..f0c97e5223 100644 --- a/audio/meson.build +++ b/audio/meson.build @@ -1,12 +1,13 @@ system_ss.add([spice_headers, files('audio.c')]) system_ss.add(files( - 'audio-hmp-cmds.c', 'mixeng.c', 'noaudio.c', 'wavaudio.c', - 'wavcapture.c', )) +# deprecated since v10.2, to be removed +system_ss.add(files('audio-hmp-cmds.c', 'wavcapture.c')) + system_ss.add(when: coreaudio, if_true: files('coreaudio.m')) system_ss.add(when: dsound, if_true: files('dsoundaudio.c', 'audio_win_int.c')) diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx index 25b4aed51f..59f3446224 100644 --- a/hmp-commands-info.hx +++ b/hmp-commands-info.hx @@ -363,6 +363,7 @@ SRST Show host USB devices. ERST +#ifdef CONFIG_AUDIO_HMP { .name = "capture", .args_type = "", @@ -375,6 +376,7 @@ SRST ``info capture`` Show capture information. ERST +#endif { .name = "snapshots", diff --git a/hmp-commands.hx b/hmp-commands.hx index 15f6082596..6d59bc8f18 100644 --- a/hmp-commands.hx +++ b/hmp-commands.hx @@ -764,6 +764,7 @@ SRST ERST +#ifdef CONFIG_AUDIO_HMP { .name = "wavcapture", .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?", @@ -798,6 +799,7 @@ SRST info capture ERST +#endif { .name = "memsave", -- 2.51.0
On Wed, Oct 15, 2025 at 01:28:51PM +0400, marcandre.lureau@redhat.com wrote:
From: Marc-André Lureau <marcandre.lureau@redhat.com>
The command is niche and better served by the host audio system. There is no QMP equivalent, fortunately. You can capture the audio stream via remote desktop protocols too (dbus, vnc, spice).
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> --- docs/about/deprecated.rst | 20 ++++++++++++++++++++ meson.build | 4 ++++ audio/audio-hmp-cmds.c | 7 +++++++ audio/meson.build | 5 +++-- hmp-commands-info.hx | 2 ++ hmp-commands.hx | 2 ++ 6 files changed, 38 insertions(+), 2 deletions(-)
Please remove the build system changes, as that is not something that is done with deprecation. With regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Hi Daniel On Wed, Oct 15, 2025 at 1:33 PM Daniel P. Berrangé <berrange@redhat.com> wrote:
On Wed, Oct 15, 2025 at 01:28:51PM +0400, marcandre.lureau@redhat.com wrote:
From: Marc-André Lureau <marcandre.lureau@redhat.com>
The command is niche and better served by the host audio system. There is no QMP equivalent, fortunately. You can capture the audio stream via remote desktop protocols too (dbus, vnc, spice).
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> --- docs/about/deprecated.rst | 20 ++++++++++++++++++++ meson.build | 4 ++++ audio/audio-hmp-cmds.c | 7 +++++++ audio/meson.build | 5 +++-- hmp-commands-info.hx | 2 ++ hmp-commands.hx | 2 ++ 6 files changed, 38 insertions(+), 2 deletions(-)
Please remove the build system changes, as that is not something that is done with deprecation.
The reason I'd like to have those build system changes is to be able to build a version of QEMU without those commands. Furthermore, we can already clearly isolate the parts to be removed. With regards,
Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On Wed, Oct 15, 2025 at 01:43:29PM +0400, Marc-André Lureau wrote:
Hi Daniel
On Wed, Oct 15, 2025 at 1:33 PM Daniel P. Berrangé <berrange@redhat.com> wrote:
On Wed, Oct 15, 2025 at 01:28:51PM +0400, marcandre.lureau@redhat.com wrote:
From: Marc-André Lureau <marcandre.lureau@redhat.com>
The command is niche and better served by the host audio system. There is no QMP equivalent, fortunately. You can capture the audio stream via remote desktop protocols too (dbus, vnc, spice).
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> --- docs/about/deprecated.rst | 20 ++++++++++++++++++++ meson.build | 4 ++++ audio/audio-hmp-cmds.c | 7 +++++++ audio/meson.build | 5 +++-- hmp-commands-info.hx | 2 ++ hmp-commands.hx | 2 ++ 6 files changed, 38 insertions(+), 2 deletions(-)
Please remove the build system changes, as that is not something that is done with deprecation.
The reason I'd like to have those build system changes is to be able to build a version of QEMU without those commands. Furthermore, we can already clearly isolate the parts to be removed.
What's the reason to want to build without the commands ? Anyone doing so will be breaking compatibility which undermines the deprecation process. We've had these commands for decades, and waiting until the deprecatino process has run its course looks sufficient. With regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
* marcandre.lureau@redhat.com (marcandre.lureau@redhat.com) wrote:
From: Marc-André Lureau <marcandre.lureau@redhat.com>
The command is niche and better served by the host audio system. There is no QMP equivalent, fortunately. You can capture the audio stream via remote desktop protocols too (dbus, vnc, spice).
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
From the HMP side I'm happy with the deprecation, you're right it's pretty obscure and it's easy enough to do from the host. Acked-by: Dr. David Alan Gilbert <dave@treblig.org> Dave
--- docs/about/deprecated.rst | 20 ++++++++++++++++++++ meson.build | 4 ++++ audio/audio-hmp-cmds.c | 7 +++++++ audio/meson.build | 5 +++-- hmp-commands-info.hx | 2 ++ hmp-commands.hx | 2 ++ 6 files changed, 38 insertions(+), 2 deletions(-)
diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst index 98361f5832..a357f207cf 100644 --- a/docs/about/deprecated.rst +++ b/docs/about/deprecated.rst @@ -169,6 +169,26 @@ Use ``job-finalize`` instead.
This argument has always been ignored.
+Human Machine Protocol (HMP) commands +------------------------------------- + +``wavcapture`` (since 10.2) +'''''''''''''''''''''''''''' + +The ``wavcapture`` command is deprecated and will be removed in a future release. + +Use ``-audiodev wav`` or your host audio system to capture audio. + +``stopcapture`` (since 10.2) +'''''''''''''''''''''''''''' + +The ``stopcapture`` command is deprecated and will be removed in a future release. + +``info`` argument ``capture`` (since 10.2) +'''''''''''''''''''''''''''''''''''''''''' + +The ``info capture`` command is deprecated and will be removed in a future release. + Host Architectures ------------------
diff --git a/meson.build b/meson.build index afaefa0172..a4d8e33132 100644 --- a/meson.build +++ b/meson.build @@ -2354,6 +2354,10 @@ endif config_host_data = configuration_data()
config_host_data.set('CONFIG_HAVE_RUST', have_rust) + +# HMP code deprecated since v10.2, to be removed +config_host_data.set('CONFIG_AUDIO_HMP', true) + audio_drivers_selected = [] if have_system audio_drivers_available = { diff --git a/audio/audio-hmp-cmds.c b/audio/audio-hmp-cmds.c index 8774c09f18..9129a02331 100644 --- a/audio/audio-hmp-cmds.c +++ b/audio/audio-hmp-cmds.c @@ -28,6 +28,7 @@ #include "monitor/monitor.h" #include "qapi/error.h" #include "qobject/qdict.h" +#include "qemu/error-report.h"
static QLIST_HEAD (capture_list_head, CaptureState) capture_head;
@@ -36,6 +37,8 @@ void hmp_info_capture(Monitor *mon, const QDict *qdict) int i; CaptureState *s;
+ warn_report_once("'info capture' is deprecated since v10.2, to be removed"); + for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) { monitor_printf(mon, "[%d]: ", i); s->ops.info (s->opaque); @@ -48,6 +51,8 @@ void hmp_stopcapture(Monitor *mon, const QDict *qdict) int n = qdict_get_int(qdict, "n"); CaptureState *s;
+ warn_report_once("'stopcapture' is deprecated since v10.2, to be removed"); + for (s = capture_head.lh_first, i = 0; s; s = s->entries.le_next, ++i) { if (i == n) { s->ops.destroy (s->opaque); @@ -69,6 +74,8 @@ void hmp_wavcapture(Monitor *mon, const QDict *qdict) Error *local_err = NULL; AudioState *as = audio_state_by_name(audiodev, &local_err);
+ warn_report_once("'wavcapture' is deprecated since v10.2, to be removed"); + if (!as) { error_report_err(local_err); return; diff --git a/audio/meson.build b/audio/meson.build index 59f0a431d5..f0c97e5223 100644 --- a/audio/meson.build +++ b/audio/meson.build @@ -1,12 +1,13 @@ system_ss.add([spice_headers, files('audio.c')]) system_ss.add(files( - 'audio-hmp-cmds.c', 'mixeng.c', 'noaudio.c', 'wavaudio.c', - 'wavcapture.c', ))
+# deprecated since v10.2, to be removed +system_ss.add(files('audio-hmp-cmds.c', 'wavcapture.c')) + system_ss.add(when: coreaudio, if_true: files('coreaudio.m')) system_ss.add(when: dsound, if_true: files('dsoundaudio.c', 'audio_win_int.c'))
diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx index 25b4aed51f..59f3446224 100644 --- a/hmp-commands-info.hx +++ b/hmp-commands-info.hx @@ -363,6 +363,7 @@ SRST Show host USB devices. ERST
+#ifdef CONFIG_AUDIO_HMP { .name = "capture", .args_type = "", @@ -375,6 +376,7 @@ SRST ``info capture`` Show capture information. ERST +#endif
{ .name = "snapshots", diff --git a/hmp-commands.hx b/hmp-commands.hx index 15f6082596..6d59bc8f18 100644 --- a/hmp-commands.hx +++ b/hmp-commands.hx @@ -764,6 +764,7 @@ SRST
ERST
+#ifdef CONFIG_AUDIO_HMP { .name = "wavcapture", .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?", @@ -798,6 +799,7 @@ SRST info capture
ERST +#endif
{ .name = "memsave", -- 2.51.0
-- -----Open up your eyes, open up your mind, open up your code ------- / Dr. David Alan Gilbert | Running GNU/Linux | Happy \ \ dave @ treblig.org | | In Hex / \ _________________________|_____ http://www.treblig.org |_______/
participants (4)
-
Daniel P. Berrangé -
Dr. David Alan Gilbert -
Marc-André Lureau -
marcandre.lureau＠redhat.com