[Qemu-devel] [PATCH v2 0/3] audio: -audiodev documentation tweaks

[Qemu-devel] [PATCH v2 0/3] audio: -audiodev documentation tweaks

[Stefan Hajnoczi]

v2:
 * Added ALSA period-length fix [Zoltán]
 * Expanded PulseAudio latency documentation [Zoltán]

Small fixes to the -audiodev documentation.

Stefan Hajnoczi (3):
  audio: fix buffer-length typo in documentation
  audio: add -audiodev pa,in|out.latency= to documentation
  audio: fix ALSA period-length typo in documentation

 qemu-options.hx | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

-- 
2.21.0

[Qemu-devel] [PATCH v2 1/3] audio: fix buffer-length typo in documentation

[Stefan Hajnoczi]

Fixes: f0b3d811529 ("audio: -audiodev command line option: documentation")
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index bbfd936d29..a4f9f74f52 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -439,7 +439,7 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
     "                in|out.format= sample format to use with fixed settings\n"
     "                valid values: s8, s16, s32, u8, u16, u32\n"
     "                in|out.voices= number of voices to use\n"
-    "                in|out.buffer-len= length of buffer in microseconds\n"
+    "                in|out.buffer-length= length of buffer in microseconds\n"
     "-audiodev none,id=id,[,prop[=value][,...]]\n"
     "                dummy driver that discards all output\n"
 #ifdef CONFIG_AUDIO_ALSA
@@ -524,7 +524,7 @@ Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},
 @item in|out.voices=@var{voices}
 Specify the number of @var{voices} to use.  Default is 1.
 
-@item in|out.buffer=@var{usecs}
+@item in|out.buffer-length=@var{usecs}
 Sets the size of the buffer in microseconds.
 
 @end table
-- 
2.21.0

[Qemu-devel] [PATCH v2 2/3] audio: add -audiodev pa, in|out.latency= to documentation

[Stefan Hajnoczi]

The "latency" parameter wasn't covered by the documentation.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 qemu-options.hx | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/qemu-options.hx b/qemu-options.hx
index a4f9f74f52..6d7fe57dd4 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -470,6 +470,7 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
     "-audiodev pa,id=id[,prop[=value][,...]]\n"
     "                server= PulseAudio server address\n"
     "                in|out.name= source/sink device name\n"
+    "                in|out.latency= desired latency in microseconds\n"
 #endif
 #ifdef CONFIG_AUDIO_SDL
     "-audiodev sdl,id=id[,prop[=value][,...]]\n"
@@ -630,6 +631,10 @@ Sets the PulseAudio @var{server} to connect to.
 @item in|out.name=@var{sink}
 Use the specified source/sink for recording/playback.
 
+@item in|out.latency=@var{usecs}
+Desired latency in microseconds.  The PulseAudio server will try to honor this
+value but actual latencies may be lower or higher.
+
 @end table
 
 @item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]]
-- 
2.21.0

[Qemu-devel] [PATCH v2 3/3] audio: fix ALSA period-length typo in documentation

[Stefan Hajnoczi]

Fixes: f0b3d811529 ("audio: -audiodev command line option: documentation")
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 6d7fe57dd4..0f79c70c37 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -445,7 +445,7 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
 #ifdef CONFIG_AUDIO_ALSA
     "-audiodev alsa,id=id[,prop[=value][,...]]\n"
     "                in|out.dev= name of the audio device to use\n"
-    "                in|out.period-len= length of period in microseconds\n"
+    "                in|out.period-length= length of period in microseconds\n"
     "                in|out.try-poll= attempt to use poll mode\n"
     "                threshold= threshold (in microseconds) when playback starts\n"
 #endif
@@ -546,7 +546,7 @@ ALSA specific options are:
 Specify the ALSA @var{device} to use for input and/or output.  Default
 is @code{default}.
 
-@item in|out.period-len=@var{usecs}
+@item in|out.period-length=@var{usecs}
 Sets the period length in microseconds.
 
 @item in|out.try-poll=on|off
-- 
2.21.0

Re: [Qemu-devel] [PATCH v2 2/3] audio: add -audiodev pa, in|out.latency= to documentation

[Gerd Hoffmann]

On Wed, Sep 18, 2019 at 10:53:34AM +0100, Stefan Hajnoczi wrote:
> The "latency" parameter wasn't covered by the documentation.

Doesn't apply cleanly (on top of the surround sound patch series).
Picked the other two into the pull request.
Please rebase & resend once this is merged.

thanks,
  Gerd

> 
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
>  qemu-options.hx | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index a4f9f74f52..6d7fe57dd4 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -470,6 +470,7 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
>      "-audiodev pa,id=id[,prop[=value][,...]]\n"
>      "                server= PulseAudio server address\n"
>      "                in|out.name= source/sink device name\n"
> +    "                in|out.latency= desired latency in microseconds\n"
>  #endif
>  #ifdef CONFIG_AUDIO_SDL
>      "-audiodev sdl,id=id[,prop[=value][,...]]\n"
> @@ -630,6 +631,10 @@ Sets the PulseAudio @var{server} to connect to.
>  @item in|out.name=@var{sink}
>  Use the specified source/sink for recording/playback.
>  
> +@item in|out.latency=@var{usecs}
> +Desired latency in microseconds.  The PulseAudio server will try to honor this
> +value but actual latencies may be lower or higher.
> +
>  @end table
>  
>  @item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]]
> -- 
> 2.21.0
>