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

[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
...@@ -59,6 +59,36 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the ...@@ -59,6 +59,36 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
:ref:`VIDIOC_DECODER_CMD` documentation for :ref:`VIDIOC_DECODER_CMD` documentation for
more information. 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 Return Value
------------ ------------
......
...@@ -64,6 +64,23 @@ included in the exceptfds argument, and for poll(), POLLPRI should be ...@@ -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 specified as the wake-up condition. Read-only permissions are sufficient
for this ioctl call. 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 Return Value
------------ ------------
......
...@@ -16,7 +16,7 @@ VIDEO_GET_NAVI ...@@ -16,7 +16,7 @@ VIDEO_GET_NAVI
Synopsis 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 :name: VIDEO_GET_NAVI
...@@ -54,6 +54,14 @@ This ioctl returns navigational information from the DVD stream. This is ...@@ -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 especially needed if an encoded stream has to be decoded by the
hardware. 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 Return Value
------------ ------------
......
...@@ -52,6 +52,16 @@ Description ...@@ -52,6 +52,16 @@ Description
This ioctl returns the size and aspect ratio. 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 Return Value
------------ ------------
......
...@@ -53,6 +53,17 @@ Description ...@@ -53,6 +53,17 @@ Description
This ioctl call asks the Video Device to return the current status of This ioctl call asks the Video Device to return the current status of
the device. 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 Return Value
------------ ------------
......
...@@ -58,6 +58,16 @@ This ioctl call informs the video device which source shall be used for ...@@ -58,6 +58,16 @@ This ioctl call informs the video device which source shall be used for
the input data. The possible sources are demux or memory. If memory is the input data. The possible sources are demux or memory. If memory is
selected, the data is fed to the video device through the write command. selected, the data is fed to the video device through the write command.
.. c:type:: video_stream_source_t
.. code-block:: c
typedef enum {
VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
comes from the user through the write
system call */
} video_stream_source_t;
Return Value Return Value
------------ ------------
......
...@@ -55,6 +55,22 @@ information about the stream. Some hardware may not need this ...@@ -55,6 +55,22 @@ information about the stream. Some hardware may not need this
information, but the call also tells the hardware to prepare for DVD information, but the call also tells the hardware to prepare for DVD
playback. playback.
.. c:type:: video_attributes_t
.. code-block::c
typedef __u16 video_attributes_t;
/* bits: descr. */
/* 15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
/* 13-12 TV system (0=525/60, 1=625/50) */
/* 11-10 Aspect ratio (0=4:3, 3=16:9) */
/* 9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
/* 7 line 21-1 data present in GOP (1=yes, 0=no) */
/* 6 line 21-2 data present in GOP (1=yes, 0=no) */
/* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
/* 2 source letterboxed (1=yes, 0=no) */
/* 0 film/camera mode (0=camera, 1=film (625/50 only)) */
Return Value Return Value
------------ ------------
......
...@@ -16,7 +16,7 @@ VIDEO_SET_DISPLAY_FORMAT ...@@ -16,7 +16,7 @@ VIDEO_SET_DISPLAY_FORMAT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format) .. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT)
:name: VIDEO_SET_DISPLAY_FORMAT :name: VIDEO_SET_DISPLAY_FORMAT
......
...@@ -54,6 +54,15 @@ This ioctl sets the screen format (aspect ratio) of the connected output ...@@ -54,6 +54,15 @@ This ioctl sets the screen format (aspect ratio) of the connected output
device (TV) so that the output of the decoder can be adjusted device (TV) so that the output of the decoder can be adjusted
accordingly. accordingly.
.. c:type:: video_format_t
.. code-block:: c
typedef enum {
VIDEO_FORMAT_4_3, /* Select 4:3 format */
VIDEO_FORMAT_16_9, /* Select 16:9 format. */
VIDEO_FORMAT_221_1 /* 2.21:1 */
} video_format_t;
Return Value Return Value
------------ ------------
......
...@@ -16,7 +16,7 @@ VIDEO_SET_HIGHLIGHT ...@@ -16,7 +16,7 @@ VIDEO_SET_HIGHLIGHT
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite) .. c:function:: int ioctl(fd, VIDEO_SET_HIGHLIGHT, struct video_highlight *vhilite)
:name: VIDEO_SET_HIGHLIGHT :name: VIDEO_SET_HIGHLIGHT
...@@ -53,6 +53,30 @@ Description ...@@ -53,6 +53,30 @@ Description
This ioctl sets the SPU highlight information for the menu access of a This ioctl sets the SPU highlight information for the menu access of a
DVD. DVD.
.. c:type:: video_highlight
.. code-block:: c
typedef
struct video_highlight {
int active; /* 1=show highlight, 0=hide highlight */
__u8 contrast1; /* 7- 4 Pattern pixel contrast */
/* 3- 0 Background pixel contrast */
__u8 contrast2; /* 7- 4 Emphasis pixel-2 contrast */
/* 3- 0 Emphasis pixel-1 contrast */
__u8 color1; /* 7- 4 Pattern pixel color */
/* 3- 0 Background pixel color */
__u8 color2; /* 7- 4 Emphasis pixel-2 color */
/* 3- 0 Emphasis pixel-1 color */
__u32 ypos; /* 23-22 auto action mode */
/* 21-12 start y */
/* 9- 0 end y */
__u32 xpos; /* 23-22 button color number */
/* 21-12 start x */
/* 9- 0 end x */
} video_highlight_t;
Return Value Return Value
------------ ------------
......
...@@ -16,7 +16,7 @@ VIDEO_SET_SPU_PALETTE ...@@ -16,7 +16,7 @@ VIDEO_SET_SPU_PALETTE
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette ) .. c:function:: int ioctl(fd, VIDEO_SET_SPU_PALETTE, struct video_spu_palette *palette )
:name: VIDEO_SET_SPU_PALETTE :name: VIDEO_SET_SPU_PALETTE
...@@ -52,6 +52,14 @@ Description ...@@ -52,6 +52,14 @@ Description
This ioctl sets the SPU color palette. This ioctl sets the SPU color palette.
.. c:type:: video_spu_palette
.. code-block::c
typedef struct video_spu_palette { /* SPU Palette information */
int length;
__u8 __user *palette;
} video_spu_palette_t;
Return Value Return Value
------------ ------------
......
...@@ -16,7 +16,7 @@ VIDEO_SET_SPU ...@@ -16,7 +16,7 @@ VIDEO_SET_SPU
Synopsis Synopsis
-------- --------
.. c:function:: int ioctl(fd, VIDEO_SET_SPU , video_spu_t *spu) .. c:function:: int ioctl(fd, VIDEO_SET_SPU , struct video_spu *spu)
:name: VIDEO_SET_SPU :name: VIDEO_SET_SPU
...@@ -54,6 +54,15 @@ Description ...@@ -54,6 +54,15 @@ Description
This ioctl activates or deactivates SPU decoding in a DVD input stream. This ioctl activates or deactivates SPU decoding in a DVD input stream.
It can only be used, if the driver is able to handle a DVD stream. It can only be used, if the driver is able to handle a DVD stream.
.. c:type:: struct video_spu
.. code-block:: c
typedef struct video_spu {
int active;
int stream_id;
} video_spu_t;
Return Value Return Value
------------ ------------
......
...@@ -206,7 +206,8 @@ typedef __u16 video_attributes_t; ...@@ -206,7 +206,8 @@ typedef __u16 video_attributes_t;
/* 6 line 21-2 data present in GOP (1=yes, 0=no) */ /* 6 line 21-2 data present in GOP (1=yes, 0=no) */
/* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */ /* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
/* 2 source letterboxed (1=yes, 0=no) */ /* 2 source letterboxed (1=yes, 0=no) */
/* 0 film/camera mode (0=camera, 1=film (625/50 only)) */ /* 0 film/camera mode (0=
*camera, 1=film (625/50 only)) */
/* bit definitions for capabilities: */ /* bit definitions for capabilities: */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment