Add explanatory comments to the #endif part of multiple inclusion guards.
[mplayer/greg.git] / stream / tv.h
blob7dc87c53f234fc28d37eb8ff18b9209992d029ff
1 #ifndef TV_H
2 #define TV_H
4 //#include "libao2/afmt.h"
5 //#include "libmpcodecs/img_format.h"
6 //#include "mp_msg.h"
8 typedef struct tv_param_s {
9 char *freq;
10 char *channel;
11 char *chanlist;
12 char *norm;
13 int automute;
14 int normid;
15 char *device;
16 char *driver;
17 int width;
18 int height;
19 int input;
20 int outfmt;
21 float fps;
22 char **channels;
23 int noaudio;
24 int immediate;
25 int audiorate;
26 int audio_id;
27 int amode;
28 int volume;
29 int bass;
30 int treble;
31 int balance;
32 int forcechan;
33 int force_audio;
34 int buffer_size;
35 int mjpeg;
36 int decimation;
37 int quality;
38 int alsa;
39 char* adevice;
40 int brightness;
41 int contrast;
42 int hue;
43 int saturation;
44 int gain;
45 char *tdevice; ///< teletext device
46 int tformat; ///< teletext display format
47 int tpage; ///< start teletext page
48 int tlang; ///< primary language code
50 int scan;
51 int scan_threshold;
52 float scan_period;
53 /**
54 Terminate stream with video renderer instead of Null renderer
55 Will help if video freezes but audio does not.
56 May not work with -vo directx and -vf crop combination.
58 int hidden_video_renderer;
59 /**
60 For VIVO cards VP pin have to be rendered too.
61 This tweak will cause VidePort pin stream to be terminated with video renderer
62 instead of removing it from graph.
63 Use if your card have vp pin and video is still choppy.
64 May not work with -vo directx and -vf crop combination.
66 int hidden_vp_renderer;
67 /**
68 Use system clock as sync source instead of default graph clock (usually the clock
69 from one of live sources in graph.
71 int system_clock;
72 /**
73 Some audio cards creates audio chunks with about 0.5 sec size.
74 This can cause choppy video when using mplayer with immediatemode=0
75 Use followingtweak to decrease audio chunk sizes.
76 It will create audio chunks with time length equal to one video frame time.
78 int normalize_audio_chunks;
79 } tv_param_t;
81 extern tv_param_t stream_tv_defaults;
83 typedef struct tvi_info_s
85 struct tvi_handle_s * (*tvi_init)(tv_param_t* tv_param);
86 const char *name;
87 const char *short_name;
88 const char *author;
89 const char *comment;
90 } tvi_info_t;
92 typedef struct tvi_functions_s
94 int (*init)();
95 int (*uninit)();
96 int (*control)();
97 int (*start)();
98 double (*grab_video_frame)();
99 int (*get_video_framesize)();
100 double (*grab_audio_frame)();
101 int (*get_audio_framesize)();
102 } tvi_functions_t;
104 typedef struct tvi_handle_s {
105 tvi_functions_t *functions;
106 void *priv;
107 int seq;
109 /* specific */
110 int norm;
111 int chanlist;
112 const struct CHANLIST *chanlist_s;
113 int channel;
114 tv_param_t * tv_param;
115 void * scan;
116 } tvi_handle_t;
118 typedef struct tv_channels_s {
119 int index;
120 char number[5];
121 char name[20];
122 int freq;
123 struct tv_channels_s *next;
124 struct tv_channels_s *prev;
125 } tv_channels_t;
127 extern tv_channels_t *tv_channel_list;
128 extern tv_channels_t *tv_channel_current, *tv_channel_last;
129 extern char *tv_channel_last_real;
131 typedef struct {
132 unsigned int scan_timer;
133 int channel_num;
134 int new_channels;
135 } tv_scan_t;
137 #define TVI_CONTROL_FALSE 0
138 #define TVI_CONTROL_TRUE 1
139 #define TVI_CONTROL_NA -1
140 #define TVI_CONTROL_UNKNOWN -2
142 /* ======================== CONTROLS =========================== */
144 /* GENERIC controls */
145 #define TVI_CONTROL_IS_AUDIO 0x1
146 #define TVI_CONTROL_IS_VIDEO 0x2
147 #define TVI_CONTROL_IS_TUNER 0x3
148 #define TVI_CONTROL_IMMEDIATE 0x4
150 /* VIDEO controls */
151 #define TVI_CONTROL_VID_GET_FPS 0x101
152 #define TVI_CONTROL_VID_GET_PLANES 0x102
153 #define TVI_CONTROL_VID_GET_BITS 0x103
154 #define TVI_CONTROL_VID_CHK_BITS 0x104
155 #define TVI_CONTROL_VID_SET_BITS 0x105
156 #define TVI_CONTROL_VID_GET_FORMAT 0x106
157 #define TVI_CONTROL_VID_CHK_FORMAT 0x107
158 #define TVI_CONTROL_VID_SET_FORMAT 0x108
159 #define TVI_CONTROL_VID_GET_WIDTH 0x109
160 #define TVI_CONTROL_VID_CHK_WIDTH 0x110
161 #define TVI_CONTROL_VID_SET_WIDTH 0x111
162 #define TVI_CONTROL_VID_GET_HEIGHT 0x112
163 #define TVI_CONTROL_VID_CHK_HEIGHT 0x113
164 #define TVI_CONTROL_VID_SET_HEIGHT 0x114
165 #define TVI_CONTROL_VID_GET_BRIGHTNESS 0x115
166 #define TVI_CONTROL_VID_SET_BRIGHTNESS 0x116
167 #define TVI_CONTROL_VID_GET_HUE 0x117
168 #define TVI_CONTROL_VID_SET_HUE 0x118
169 #define TVI_CONTROL_VID_GET_SATURATION 0x119
170 #define TVI_CONTROL_VID_SET_SATURATION 0x11a
171 #define TVI_CONTROL_VID_GET_CONTRAST 0x11b
172 #define TVI_CONTROL_VID_SET_CONTRAST 0x11c
173 #define TVI_CONTROL_VID_GET_PICTURE 0x11d
174 #define TVI_CONTROL_VID_SET_PICTURE 0x11e
175 #define TVI_CONTROL_VID_SET_GAIN 0x11f
176 #define TVI_CONTROL_VID_GET_GAIN 0x120
178 /* TUNER controls */
179 #define TVI_CONTROL_TUN_GET_FREQ 0x201
180 #define TVI_CONTROL_TUN_SET_FREQ 0x202
181 #define TVI_CONTROL_TUN_GET_TUNER 0x203 /* update priv->tuner struct for used input */
182 #define TVI_CONTROL_TUN_SET_TUNER 0x204 /* update priv->tuner struct for used input */
183 #define TVI_CONTROL_TUN_GET_NORM 0x205
184 #define TVI_CONTROL_TUN_SET_NORM 0x206
185 #define TVI_CONTROL_TUN_GET_SIGNAL 0x207
187 /* AUDIO controls */
188 #define TVI_CONTROL_AUD_GET_FORMAT 0x301
189 #define TVI_CONTROL_AUD_GET_SAMPLERATE 0x302
190 #define TVI_CONTROL_AUD_GET_SAMPLESIZE 0x303
191 #define TVI_CONTROL_AUD_GET_CHANNELS 0x304
192 #define TVI_CONTROL_AUD_SET_SAMPLERATE 0x305
194 /* SPECIFIC controls */
195 #define TVI_CONTROL_SPC_GET_INPUT 0x401 /* set input channel (tv,s-video,composite..) */
196 #define TVI_CONTROL_SPC_SET_INPUT 0x402 /* set input channel (tv,s-video,composite..) */
197 #define TVI_CONTROL_SPC_GET_NORMID 0x403 /* get normid from norm name */
199 //tvi_* ioctl (not tvi_vbi.c !!!)
200 #define TVI_CONTROL_VBI_INIT 0x501 ///< vbi init
203 TELETEXT controls (through tv_teletext_control() )
204 NOTE:
205 _SET_ should be _GET_ +1
206 _STEP_ should be _GET_ +2
208 #define TV_VBI_CONTROL_GET_MODE 0x510 ///< get current mode teletext
209 #define TV_VBI_CONTROL_SET_MODE 0x511 ///< on/off grab teletext
211 #define TV_VBI_CONTROL_GET_PAGE 0x513 ///< get grabbed teletext page
212 #define TV_VBI_CONTROL_SET_PAGE 0x514 ///< set grab teletext page number
213 #define TV_VBI_CONTROL_STEP_PAGE 0x515 ///< step grab teletext page number
215 #define TV_VBI_CONTROL_GET_SUBPAGE 0x516 ///< get grabbed teletext page
216 #define TV_VBI_CONTROL_SET_SUBPAGE 0x517 ///< set grab teletext page number
218 #define TV_VBI_CONTROL_GET_FORMAT 0x519 ///< get eletext format
219 #define TV_VBI_CONTROL_SET_FORMAT 0x51a ///< set teletext format
221 #define TV_VBI_CONTROL_GET_HALF_PAGE 0x51c ///< get current half page
222 #define TV_VBI_CONTROL_SET_HALF_PAGE 0x51d ///< switch half page
224 #define TV_VBI_CONTROL_IS_CHANGED 0x540 ///< teletext page is changed
225 #define TV_VBI_CONTROL_MARK_UNCHANGED 0x541 ///< teletext page is changed
227 #define TV_VBI_CONTROL_ADD_DEC 0x550 ///< add page number with dec
228 #define TV_VBI_CONTROL_GO_LINK 0x551 ///< go link (1..6) NYI
229 #define TV_VBI_CONTROL_GET_VBIPAGE 0x552 ///< get vbi_image for grabbed teletext page
230 #define TV_VBI_CONTROL_RESET 0x553 ///< vbi reset
231 #define TV_VBI_CONTROL_START 0x554 ///< vbi start
232 #define TV_VBI_CONTROL_STOP 0x555 ///< vbi stop
233 #define TV_VBI_CONTROL_DECODE_PAGE 0x556 ///< decode vbi page
234 #define TV_VBI_CONTROL_GET_NETWORKNAME 0x557 ///< get current network name
236 int tv_set_color_options(tvi_handle_t *tvh, int opt, int val);
237 int tv_get_color_options(tvi_handle_t *tvh, int opt, int* val);
238 #define TV_COLOR_BRIGHTNESS 1
239 #define TV_COLOR_HUE 2
240 #define TV_COLOR_SATURATION 3
241 #define TV_COLOR_CONTRAST 4
243 int tv_step_channel_real(tvi_handle_t *tvh, int direction);
244 int tv_step_channel(tvi_handle_t *tvh, int direction);
245 #define TV_CHANNEL_LOWER 1
246 #define TV_CHANNEL_HIGHER 2
248 int tv_last_channel(tvi_handle_t *tvh);
250 int tv_set_channel_real(tvi_handle_t *tvh, char *channel);
251 int tv_set_channel(tvi_handle_t *tvh, char *channel);
253 int tv_step_norm(tvi_handle_t *tvh);
254 int tv_step_chanlist(tvi_handle_t *tvh);
256 int tv_set_freq(tvi_handle_t *tvh, unsigned long freq);
257 int tv_get_freq(tvi_handle_t *tvh, unsigned long *freq);
258 int tv_get_signal(tvi_handle_t *tvh);
259 int tv_step_freq(tvi_handle_t *tvh, float step_interval);
261 int tv_set_norm(tvi_handle_t *tvh, char* norm);
263 void tv_start_scan(tvi_handle_t *tvh, int start);
265 #define TV_NORM_PAL 1
266 #define TV_NORM_NTSC 2
267 #define TV_NORM_SECAM 3
268 #define TV_NORM_PALNC 4
269 #define TV_NORM_PALM 5
270 #define TV_NORM_PALN 6
271 #define TV_NORM_NTSCJP 7
273 #define VBI_TFORMAT_TEXT 0 ///< text mode
274 #define VBI_TFORMAT_BW 1 ///< back&white mode
275 #define VBI_TFORMAT_GRAY 2 ///< grayscale mode
276 #define VBI_TFORMAT_COLOR 3 ///< color mode (require color_spu patch!)
278 #define VBI_MAX_PAGES 0x800 ///< max sub pages number
279 #define VBI_MAX_SUBPAGES 64 ///< max sub pages number
281 #define VBI_ROWS 25 ///< teletext page height in rows
282 #define VBI_COLUMNS 40 ///< teletext page width in chars
283 #define VBI_TIME_LINEPOS 26 ///< time line pos in page header
285 typedef
286 enum{
287 TT_FORMAT_OPAQUE=0, ///< opaque
288 TT_FORMAT_TRANSPARENT, ///< translarent
289 TT_FORMAT_OPAQUE_INV, ///< opaque with inverted colors
290 TT_FORMAT_TRANSPARENT_INV ///< translarent with inverted colors
291 } teletext_format;
293 typedef
294 enum{
295 TT_ZOOM_NORMAL=0,
296 TT_ZOOM_TOP_HALF,
297 TT_ZOOM_BOTTOM_HALF
298 } teletext_zoom;
300 typedef struct tt_char_s{
301 unsigned int unicode; ///< unicode (utf8) character
302 unsigned char fg; ///< foreground color
303 unsigned char bg; ///< background color
304 unsigned char gfx; ///< 0-no gfx, 1-solid gfx, 2-separated gfx
305 unsigned char flh; ///< 0-no flash, 1-flash
306 unsigned char hidden; ///< char is hidden (for subtitle pages)
307 unsigned char ctl; ///< control character
308 unsigned char lng; ///< lang: 0-secondary language,1-primary language
309 unsigned char raw; ///< raw character (as received from device)
310 } tt_char;
312 typedef struct tt_link_s{
313 int pagenum; ///< page number
314 int subpagenum; ///< subpage number
315 } tt_link_t;
317 typedef struct tt_page_s{
318 int pagenum; ///< page number
319 int subpagenum; ///< subpage number
320 unsigned char primary_lang; ///< primary language code
321 unsigned char secondary_lang; ///< secondary language code
322 unsigned char active; ///< page is complete and ready for rendering
323 unsigned char flags; ///< page flags
324 unsigned char raw[VBI_ROWS*VBI_COLUMNS]; ///< page data
325 struct tt_page_s* next_subpage;
326 struct tt_link_s links[6];
327 } tt_page;
329 #define TT_PGFL_SUPPRESS_HEADER 0x01
330 #define TT_PGFL_UPDATE_INDICATOR 0x02
331 #define TT_PGFL_INTERRUPTED_SEQ 0x04
332 #define TT_PGFL_INHIBIT_DISPLAY 0x08
333 #define TT_PGFL_NEWFLASH 0x10
334 #define TT_PGFL_SUBTITLE 0x20
335 #define TT_PGFL_ERASE_PAGE 0x40
336 #define TT_PGFL_MAGAZINE_SERIAL 0x80
338 typedef struct tt_stream_props_s{
339 int sampling_rate;
340 int samples_per_line;
341 int offset;
342 int count[2]; ///< number of lines in first and second fields
343 int interlaced; ///< vbi data are interlaced
344 int bufsize; ///< required buffer size
345 } tt_stream_props;
347 #endif /* TV_H */