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

Commit 848d1031 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] fix broken references on dvb/video*rst 



Trivially fix those broken references, by copying the structs
fron the header, just like other API documentation at the
DVB side.

This doesn't have the level of quality used at the V4L2 side
of the API, but, as this documents a deprecated API, used
only by av7110 driver, it doesn't make much sense to invest
time making it better.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 189d7243

Documentation/media/uapi/dvb/video-command.rst

+30 −0
Original line number Diff line number Diff line
@@ -59,6 +59,36 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the 
:ref:`VIDIOC_DECODER_CMD` documentation for

more information.



.. c:type:: struct video_command



.. code-block:: c



	/* The structure must be zeroed before use by the application

	This ensures it can be extended safely in the future. */

	struct video_command {

		__u32 cmd;

		__u32 flags;

		union {

			struct {

				__u64 pts;

			} stop;



			struct {

				/* 0 or 1000 specifies normal speed,

				1 specifies forward single stepping,

				-1 specifies backward single stepping,

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

				<-1: reverse playback at (-speed/1000) of the normal speed. */

				__s32 speed;

				__u32 format;

			} play;



			struct {

				__u32 data[16];

			} raw;

		};

	};





Return Value

------------

Documentation/media/uapi/dvb/video-get-event.rst

+17 −0
Original line number Diff line number Diff line
@@ -64,6 +64,23 @@ included in the exceptfds argument, and for poll(), POLLPRI should be 
specified as the wake-up condition. Read-only permissions are sufficient

for this ioctl call.



.. c:type:: video_event



.. code-block:: c



	struct video_event {

		__s32 type;

	#define VIDEO_EVENT_SIZE_CHANGED	1

	#define VIDEO_EVENT_FRAME_RATE_CHANGED	2

	#define VIDEO_EVENT_DECODER_STOPPED 	3

	#define VIDEO_EVENT_VSYNC 		4

		__kernel_time_t timestamp;

		union {

			video_size_t size;

			unsigned int frame_rate;	/* in frames per 1000sec */

			unsigned char vsync_field;	/* unknown/odd/even/progressive */

		} u;

	};



Return Value

------------

Documentation/media/uapi/dvb/video-get-navi.rst

+9 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ VIDEO_GET_NAVI 
Synopsis

--------



.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , video_navi_pack_t *navipack)

.. c:function:: int ioctl(fd, VIDEO_GET_NAVI , struct video_navi_pack *navipack)

    :name: VIDEO_GET_NAVI
@@ -54,6 +54,14 @@ This ioctl returns navigational information from the DVD stream. This is 
especially needed if an encoded stream has to be decoded by the

hardware.



.. c:type:: video_navi_pack



.. code-block::c



	typedef struct video_navi_pack {

		int length;          /* 0 ... 1024 */

		__u8 data[1024];

	} video_navi_pack_t;



Return Value

------------

Documentation/media/uapi/dvb/video-get-size.rst

+10 −0
Original line number Diff line number Diff line
@@ -52,6 +52,16 @@ Description 


This ioctl returns the size and aspect ratio.



.. c:type:: video_size_t



.. code-block::c



	typedef struct {

		int w;

		int h;

		video_format_t aspect_ratio;

	} video_size_t;





Return Value

------------

Documentation/media/uapi/dvb/video-get-status.rst

+11 −0
Original line number Diff line number Diff line
@@ -53,6 +53,17 @@ Description 
This ioctl call asks the Video Device to return the current status of

the device.



.. c:type:: video_status



.. code-block:: c



	struct video_status {

		int                   video_blank;   /* blank video on freeze? */

		video_play_state_t    play_state;    /* current state of playback */

		video_stream_source_t stream_source; /* current source (demux/memory) */

		video_format_t        video_format;  /* current aspect ratio of stream*/

		video_displayformat_t display_format;/* selected cropping mode */

	};



Return Value

------------