1 /* SPDX-License-Identifier: LGPL-2.1+ WITH Linux-syscall-note */
2 /*
3  * video.h - DEPRECATED MPEG-TS video decoder API
4  *
5  * NOTE: should not be used on future drivers
6  *
7  * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
8  *                  & Ralph  Metzler <ralph@convergence.de>
9  *                    for convergence integrated media GmbH
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  */
26 
27 #ifndef _UAPI_DVBVIDEO_H_
28 #define _UAPI_DVBVIDEO_H_
29 
30 #include <linux/types.h>
31 #ifndef __KERNEL__
32 #include <time.h>
33 #endif
34 
35 typedef enum {
36 	VIDEO_FORMAT_4_3,     /* Select 4:3 format */
37 	VIDEO_FORMAT_16_9,    /* Select 16:9 format. */
38 	VIDEO_FORMAT_221_1    /* 2.21:1 */
39 } video_format_t;
40 
41 
42 typedef enum {
43 	VIDEO_PAN_SCAN,       /* use pan and scan format */
44 	VIDEO_LETTER_BOX,     /* use letterbox format */
45 	VIDEO_CENTER_CUT_OUT  /* use center cut out format */
46 } video_displayformat_t;
47 
48 typedef struct {
49 	int w;
50 	int h;
51 	video_format_t aspect_ratio;
52 } video_size_t;
53 
54 typedef enum {
55 	VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
56 	VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
57 			       comes from the user through the write
58 			       system call */
59 } video_stream_source_t;
60 
61 
62 typedef enum {
63 	VIDEO_STOPPED, /* Video is stopped */
64 	VIDEO_PLAYING, /* Video is currently playing */
65 	VIDEO_FREEZED  /* Video is freezed */
66 } video_play_state_t;
67 
68 
69 /* Decoder commands */
70 #define VIDEO_CMD_PLAY        (0)
71 #define VIDEO_CMD_STOP        (1)
72 #define VIDEO_CMD_FREEZE      (2)
73 #define VIDEO_CMD_CONTINUE    (3)
74 
75 /* Flags for VIDEO_CMD_FREEZE */
76 #define VIDEO_CMD_FREEZE_TO_BLACK	(1 << 0)
77 
78 /* Flags for VIDEO_CMD_STOP */
79 #define VIDEO_CMD_STOP_TO_BLACK		(1 << 0)
80 #define VIDEO_CMD_STOP_IMMEDIATELY	(1 << 1)
81 
82 /* Play input formats: */
83 /* The decoder has no special format requirements */
84 #define VIDEO_PLAY_FMT_NONE         (0)
85 /* The decoder requires full GOPs */
86 #define VIDEO_PLAY_FMT_GOP          (1)
87 
88 /* The structure must be zeroed before use by the application
89    This ensures it can be extended safely in the future. */
90 struct video_command {
91 	__u32 cmd;
92 	__u32 flags;
93 	union {
94 		struct {
95 			__u64 pts;
96 		} stop;
97 
98 		struct {
99 			/* 0 or 1000 specifies normal speed,
100 			   1 specifies forward single stepping,
101 			   -1 specifies backward single stepping,
102 			   >1: playback at speed/1000 of the normal speed,
103 			   <-1: reverse playback at (-speed/1000) of the normal speed. */
104 			__s32 speed;
105 			__u32 format;
106 		} play;
107 
108 		struct {
109 			__u32 data[16];
110 		} raw;
111 	};
112 };
113 
114 /* FIELD_UNKNOWN can be used if the hardware does not know whether
115    the Vsync is for an odd, even or progressive (i.e. non-interlaced)
116    field. */
117 #define VIDEO_VSYNC_FIELD_UNKNOWN	(0)
118 #define VIDEO_VSYNC_FIELD_ODD		(1)
119 #define VIDEO_VSYNC_FIELD_EVEN		(2)
120 #define VIDEO_VSYNC_FIELD_PROGRESSIVE	(3)
121 
122 struct video_event {
123 	__s32 type;
124 #define VIDEO_EVENT_SIZE_CHANGED	1
125 #define VIDEO_EVENT_FRAME_RATE_CHANGED	2
126 #define VIDEO_EVENT_DECODER_STOPPED	3
127 #define VIDEO_EVENT_VSYNC		4
128 	/* unused, make sure to use atomic time for y2038 if it ever gets used */
129 	long timestamp;
130 	union {
131 		video_size_t size;
132 		unsigned int frame_rate;	/* in frames per 1000sec */
133 		unsigned char vsync_field;	/* unknown/odd/even/progressive */
134 	} u;
135 };
136 
137 
138 struct video_status {
139 	int                   video_blank;   /* blank video on freeze? */
140 	video_play_state_t    play_state;    /* current state of playback */
141 	video_stream_source_t stream_source; /* current source (demux/memory) */
142 	video_format_t        video_format;  /* current aspect ratio of stream*/
143 	video_displayformat_t display_format;/* selected cropping mode */
144 };
145 
146 
147 struct video_still_picture {
148 	char __user *iFrame;        /* pointer to a single iframe in memory */
149 	__s32 size;
150 };
151 
152 
153 typedef __u16 video_attributes_t;
154 /*   bits: descr. */
155 /*   15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
156 /*   13-12 TV system (0=525/60, 1=625/50) */
157 /*   11-10 Aspect ratio (0=4:3, 3=16:9) */
158 /*    9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
159 /*    7    line 21-1 data present in GOP (1=yes, 0=no) */
160 /*    6    line 21-2 data present in GOP (1=yes, 0=no) */
161 /*    5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
162 /*    2    source letterboxed (1=yes, 0=no) */
163 /*    0    film/camera mode (0=
164  *camera, 1=film (625/50 only)) */
165 
166 
167 /* bit definitions for capabilities: */
168 /* can the hardware decode MPEG1 and/or MPEG2? */
169 #define VIDEO_CAP_MPEG1   1
170 #define VIDEO_CAP_MPEG2   2
171 /* can you send a system and/or program stream to video device?
172    (you still have to open the video and the audio device but only
173     send the stream to the video device) */
174 #define VIDEO_CAP_SYS     4
175 #define VIDEO_CAP_PROG    8
176 /* can the driver also handle SPU, NAVI and CSS encoded data?
177    (CSS API is not present yet) */
178 #define VIDEO_CAP_SPU    16
179 #define VIDEO_CAP_NAVI   32
180 #define VIDEO_CAP_CSS    64
181 
182 
183 #define VIDEO_STOP                 _IO('o', 21)
184 #define VIDEO_PLAY                 _IO('o', 22)
185 #define VIDEO_FREEZE               _IO('o', 23)
186 #define VIDEO_CONTINUE             _IO('o', 24)
187 #define VIDEO_SELECT_SOURCE        _IO('o', 25)
188 #define VIDEO_SET_BLANK            _IO('o', 26)
189 #define VIDEO_GET_STATUS           _IOR('o', 27, struct video_status)
190 #define VIDEO_GET_EVENT            _IOR('o', 28, struct video_event)
191 #define VIDEO_SET_DISPLAY_FORMAT   _IO('o', 29)
192 #define VIDEO_STILLPICTURE         _IOW('o', 30, struct video_still_picture)
193 #define VIDEO_FAST_FORWARD         _IO('o', 31)
194 #define VIDEO_SLOWMOTION           _IO('o', 32)
195 #define VIDEO_GET_CAPABILITIES     _IOR('o', 33, unsigned int)
196 #define VIDEO_CLEAR_BUFFER         _IO('o',  34)
197 #define VIDEO_SET_STREAMTYPE       _IO('o', 36)
198 #define VIDEO_SET_FORMAT           _IO('o', 37)
199 #define VIDEO_GET_SIZE             _IOR('o', 55, video_size_t)
200 
201 /**
202  * VIDEO_GET_PTS
203  *
204  * Read the 33 bit presentation time stamp as defined
205  * in ITU T-REC-H.222.0 / ISO/IEC 13818-1.
206  *
207  * The PTS should belong to the currently played
208  * frame if possible, but may also be a value close to it
209  * like the PTS of the last decoded frame or the last PTS
210  * extracted by the PES parser.
211  */
212 #define VIDEO_GET_PTS              _IOR('o', 57, __u64)
213 
214 /* Read the number of displayed frames since the decoder was started */
215 #define VIDEO_GET_FRAME_COUNT	   _IOR('o', 58, __u64)
216 
217 #define VIDEO_COMMAND		   _IOWR('o', 59, struct video_command)
218 #define VIDEO_TRY_COMMAND	   _IOWR('o', 60, struct video_command)
219 
220 #endif /* _UAPI_DVBVIDEO_H_ */
221