Skip to contentSkip to conversation

audio: -audiodev documentation tweaks

PATCH Superseded Stefan Hajnoczi 3 participants 8 messages Sep 11, 2019 – Sep 18, 2019

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover audio: -audiodev documentation tweaks

Small fixes to the -audiodev documentation.

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

 qemu-options.hx | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
Signature · 1 line
2.21.0
#1 lore raw

PATCH 1/2 audio: fix buffer-length typo in documentation

Fixes f0b3d811529 ("audio: -audiodev command line option: documentation")
---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
qemu-options.hx +2 -2
index bbfd936d29..a4f9f74f52 100644
@@ -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
Signature · 1 line
2.21.0
#2 lore raw

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

Quoted 21 lines · Stefan Hajnoczi
Fixes f0b3d811529 ("audio: -audiodev command line option: documentation")
---
  qemu-options.hx | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
qemu-options.hx +1 -1
index bbfd936d29..a4f9f74f52 100644
@@ -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

qemu-options.hx Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8}, · line 530

Quoted 8 lines
qemu-options.hx +1 -1
@@ -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

Double checking it's indeed "buffer-length" in qapi. Also I spot a different bug: the alsa documentation qemu-options.hx has "period-len" but according to qapi it should be "period-length". Care to fix it or should I submit a different patch?

Regards,
Zoltan

#3 lore raw

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

Quoted 25 lines · Zoltán Kővágó
Quoted 24 lines · Stefan Hajnoczi
Fixes f0b3d811529 ("audio: -audiodev command line option: documentation")
---
  qemu-options.hx | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
qemu-options.hx +2 -2
index bbfd936d29..a4f9f74f52 100644
@@ -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}
Quoted 8 lines

qemu-options.hx Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},

Quoted 3 lines
qemu-options.hx +0 -0
  Sets the size of the buffer in microseconds.
  @end table
 

Double checking it's indeed "buffer-length" in qapi. Also I spot a different bug: the alsa documentation qemu-options.hx has "period-len" but according to qapi it should be "period-length". Care to fix it or should I submit a different patch?

Thanks. I will send another revision.

Stefan

#4 lore raw

PATCH 2/2 audio: add -audiodev pa, in|out.latency= to documentation

In reply to Stefan Hajnoczi

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

---
How is this parameter related to buffer-length?

---
 qemu-options.hx | 4 ++++
 1 file changed, 4 insertions(+)
qemu-options.hx +4 -0
index a4f9f74f52..82154cecf8 100644
@@ -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,9 @@ 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.
+
 @end table
 
 @item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]]
Signature · 1 line
2.21.0
Reviewed-by on v1 2/2
#5 lore raw

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

Quoted 3 lines · Stefan Hajnoczi

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

Quoted 2 lines

---
How is this parameter related to buffer-length?

Pulseaudio being a client-server architecture is a bit different than the other backends, plus it also has to mix multiple streams. buffer-length corresponds to the buffer inside qemu, while latency corresponds to pulseaudio. For playback, the latency should be "maximum latency that the application can deal with", if a different client request a lower latency, our latency will decrease too. It's up to the server to figure out an optimal buffer size on the server side of the things. For recording it's the size of the buffer we will read at a time from pulseaudio.

Quoted 27 lines
---
  qemu-options.hx | 4 ++++
  1 file changed, 4 insertions(+)
qemu-options.hx +4 -0
index a4f9f74f52..82154cecf8 100644
@@ -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,9 @@ 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.
+
  @end table
 
  @item -audiodev sdl,id=@var{id}[,@var{prop}[=@var{value}][,...]]
#6 lore raw

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

Quoted 8 lines · Zoltán Kővágó
Quoted 3 lines · Stefan Hajnoczi

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

Quoted 2 lines

---
How is this parameter related to buffer-length?

Quoted 9 lines

Pulseaudio being a client-server architecture is a bit different than the other backends, plus it also has to mix multiple streams. buffer-length corresponds to the buffer inside qemu, while latency corresponds to pulseaudio. For playback, the latency should be "maximum latency that the application can deal with", if a different client request a lower latency, our latency will decrease too. It's up to the server to figure out an optimal buffer size on the server side of the things.
For recording it's the size of the buffer we will read at a time from pulseaudio.

Thanks for explaining. I will expand the help text in v2.

Stefan

#7 lore raw
In reply to Stefan Hajnoczi
Quoted 8 lines · Stefan Hajnoczi

Small fixes to the -audiodev documentation.

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

 qemu-options.hx | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Ping

Stefan