diff mbox

[3/3] media-doc: Fix MFC display delay control doc

Message ID 1418677859-31440-4-git-send-email-nicolas.dufresne@collabora.com (mailing list archive)
State New, archived
Headers show

Commit Message

Nicolas Dufresne Dec. 15, 2014, 9:10 p.m. UTC
The V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE control
is a boolean but was documented as a integer. The documentation was
also slightly miss-leading.

Signed-off-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>
---
 Documentation/DocBook/media/v4l/controls.xml | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

Comments

Kamil Debski Jan. 8, 2015, 12:51 p.m. UTC | #1
> -----Original Message-----
> From: Nicolas Dufresne [mailto:nicolas.dufresne@collabora.com]
> Sent: Monday, December 15, 2014 10:11 PM
> To: linux-media@vger.kernel.org
> Cc: Kamil Debski; Arun Kumar K; Nicolas Dufresne
> Subject: [PATCH 3/3] media-doc: Fix MFC display delay control doc
> 
> The V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE control
> is a boolean but was documented as a integer. The documentation was
> also slightly miss-leading.
> 
> Signed-off-by: Nicolas Dufresne <nicolas.dufresne@collabora.com>

Acked-by: Kamil Debski <k.debski@samsung.com>

> ---
>  Documentation/DocBook/media/v4l/controls.xml | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/DocBook/media/v4l/controls.xml
> b/Documentation/DocBook/media/v4l/controls.xml
> index e013e4b..4e9462f 100644
> --- a/Documentation/DocBook/media/v4l/controls.xml
> +++ b/Documentation/DocBook/media/v4l/controls.xml
> @@ -2692,12 +2692,11 @@ in the S5P family of SoCs by Samsung.
>  	      <row><entry></entry></row>
>  	      <row>
>  		<entry
> spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_
> DELAY_ENABLE</constant>&nbsp;</entry>
> -		<entry>integer</entry>
> -	      </row><row><entry spanname="descr">If the display delay is
> enabled then the decoder has to return a
> -CAPTURE buffer after processing a certain number of OUTPUT buffers. If
> this number is low, then it may result in -buffers not being dequeued
> in display order. In addition hardware may still use those buffers as
> reference, thus -application should not write to those buffers. This
> feature can be used for example for generating thumbnails of videos.
> -Applicable to the H264 decoder.
> +		<entry>boolean</entry>
> +	      </row><row><entry spanname="descr">If the display delay is
> +enabled then the decoder is forced to return a CAPTURE buffer (decoded
> +frame) after processing a certain number of OUTPUT buffers. The delay
> +can be set through
> <constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constan
> t>. This feature can be used for example for generating thumbnails of
> videos. Applicable to the H264 decoder.
>  	      </entry>
>  	      </row>
>  	      <row><entry></entry></row>
> --
> 2.1.0

--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
index e013e4b..4e9462f 100644
--- a/Documentation/DocBook/media/v4l/controls.xml
+++ b/Documentation/DocBook/media/v4l/controls.xml
@@ -2692,12 +2692,11 @@  in the S5P family of SoCs by Samsung.
 	      <row><entry></entry></row>
 	      <row>
 		<entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE</constant>&nbsp;</entry>
-		<entry>integer</entry>
-	      </row><row><entry spanname="descr">If the display delay is enabled then the decoder has to return a
-CAPTURE buffer after processing a certain number of OUTPUT buffers. If this number is low, then it may result in
-buffers not being dequeued in display order. In addition hardware may still use those buffers as reference, thus
-application should not write to those buffers. This feature can be used for example for generating thumbnails of videos.
-Applicable to the H264 decoder.
+		<entry>boolean</entry>
+	      </row><row><entry spanname="descr">If the display delay is enabled then the decoder is forced to return a
+CAPTURE buffer (decoded frame) after processing a certain number of OUTPUT buffers. The delay can be set through
+<constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant>. This feature can be used for example
+for generating thumbnails of videos. Applicable to the H264 decoder.
 	      </entry>
 	      </row>
 	      <row><entry></entry></row>