On Thu, Feb 24, 2022 at 11:59:08AM +0000, Kshitij Suri wrote:
> Currently screendump only supports PPM format, which is un-compressed and not
> standard. Added a "format" parameter to qemu monitor screendump capabilites
> to support PNG image capture using libpng. The param was added in QAPI schema
> of screendump present in ui.json along with png_save() function which converts
> pixman_image to PNG. HMP command equivalent was also modified to support the
> feature.
>
> Example usage:
> { "execute": "screendump", "arguments": { "filename": "/tmp/image",
> "format":"png" } }
>
> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/718
>
> Signed-off-by: Kshitij Suri <kshitij.s...@nutanix.com>
> ---
> diff to v1:
> - Removed repeated alpha conversion operation.
> - Modified logic to mirror png conversion in vnc-enc-tight.c file.
> - Added a new CONFIG_PNG parameter for libpng support.
> - Changed input format to enum instead of string.
>
> +++ b/qapi/ui.json
> @@ -73,12 +73,27 @@
> ##
> { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
>
> +##
> +# @ImageFormat:
> +#
> +# Available list of supported types.
> +#
> +# @png: PNG format
> +#
> +# @ppm: PPM format
> +#
> +# Since: 6.3
The next release is 7.0, not 6.3.
> +#
> +##
> +{ 'enum': 'ImageFormat',
> + 'data': ['ppm', 'png'] }
> +
> ##
> # @screendump:
> #
> -# Write a PPM of the VGA screen to a file.
> +# Write a screenshot of the VGA screen to a file.
> #
> -# @filename: the path of a new PPM file to store the image
> +# @filename: the path of a new file to store the image
> #
> # @device: ID of the display device that should be dumped. If this parameter
> # is missing, the primary display will be used. (Since 2.12)
> @@ -87,6 +102,9 @@
> # parameter is missing, head #0 will be used. Also note that the head
> # can only be specified in conjunction with the device ID. (Since
> 2.12)
> #
> +# @format: image format for screendump is specified. Currently only PNG and
> +# PPM are supported.
The second sentence is no longer necessary, as the documentation for
the enum type covers that information now. Missing a '(since 7.0)' tag.
> +#
> # Returns: Nothing on success
> #
> # Since: 0.14
> @@ -99,7 +117,7 @@
> #
> ##
> { 'command': 'screendump',
> - 'data': {'filename': 'str', '*device': 'str', '*head': 'int'},
> + 'data': {'filename': 'str', '*device': 'str', '*head': 'int', '*format':
> 'ImageFormat'},
Please wrap the long line.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3266
Virtualization: qemu.org | libvirt.org
