Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 84b01c16 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook/video.xml: Document the remaining data structures 



Now, all data structures are commented. A few ioctls remain undocumented:

Error: no ID for constraint linkend: VIDEO_GET_SIZE.
Error: no ID for constraint linkend: VIDEO_GET_FRAME_RATE.
Error: no ID for constraint linkend: VIDEO_GET_PTS.
Error: no ID for constraint linkend: VIDEO_GET_FRAME_COUNT.
Error: no ID for constraint linkend: VIDEO_COMMAND.
Error: no ID for constraint linkend: VIDEO_TRY_COMMAND.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent dc05e571

Documentation/DocBook/media/dvb/video.xml

+45 −2
Original line number Original line Diff line number Diff line
@@ -37,8 +37,8 @@ stream. 
</para>

</para>

</section>

</section>





<section id="video-display-format-t">

<section id="video-displayformat-t">

<title>video_display_format_t</title>

<title>video_displayformat_t</title>

<para>In case the display format of the video stream and of the display hardware differ the

<para>In case the display format of the video stream and of the display hardware differ the

application has to specify how to handle the cropping of the picture. This can be done using

application has to specify how to handle the cropping of the picture. This can be done using

the VIDEO_SET_DISPLAY_FORMAT call (??) which accepts

the VIDEO_SET_DISPLAY_FORMAT call (??) which accepts
@@ -89,6 +89,49 @@ typedef enum { 
</programlisting>

</programlisting>

</section>

</section>





<section id="video-command">

<para>The structure must be zeroed before use by the application

This ensures it can be extended safely in the future.</para>

<title>struct video-command</title>

<programlisting>

struct video_command {

	__u32 cmd;

	__u32 flags;

	union {

		struct {

			__u64 pts;

		} stop;



		struct {

			/&#x22C6; 0 or 1000 specifies normal speed,

			   1 specifies forward single stepping,

			   -1 specifies backward single stepping,

			   &gt;>1: playback at speed/1000 of the normal speed,

			   &lt;-1: reverse playback at (-speed/1000) of the normal speed. &#x22C6;/

			__s32 speed;

			__u32 format;

		} play;



		struct {

			__u32 data[16];

		} raw;

	};

};

</programlisting>

</section>



<section id="video-size-t">

<title>struct video_size-t</title>

<programlisting>

typedef struct {

	int w;

	int h;

	video_format_t aspect_ratio;

} video_size_t;

</programlisting>

</section>





<section id="video-event">

<section id="video-event">

<title>struct video_event</title>

<title>struct video_event</title>

<para>The following is the structure of a video event as it is returned by the VIDEO_GET_EVENT

<para>The following is the structure of a video event as it is returned by the VIDEO_GET_EVENT