source/vcap_osd.h File Reference
This file provides the capture OSD and Mask related function calls or IOCTLs. More...
Go to the source code of this file.
Data Structures | |
struct | fiosd_win |
This structure defines for setting OSD window postion and size. More... | |
struct | fiosd_font_info |
This structure defines for setting OSD font feature. If width and height smaller than fonts in OSD ram, the display font will be cut. For example: If the fonts size is 12x16 in sram, we set the fiosd_font_info as 6x8. The OSD will display the quarter font from top-left. More... | |
struct | fiosd_palette |
This structure defines for setting palette color. More... | |
struct | fiosd_char |
This structure defines for add or replace a character in OSD ram. The index 0 is special for FIOSDS_RMCHAR. More... | |
struct | fiosd_string |
This structure defines for setting display string. The OSD will display string from fiosd_string->start to fiosd_string->start + strlen(fiosd_string->string) in OSD display array. The string[128] is string index that depend on char bit map. While using multiple OSD windows at the same time, user has to manager string length in the common string buffer. More... | |
struct | fiosd_transparent |
This structure defines for setting transparent level. More... | |
struct | fiosd_charmap |
This structure defines for getting the bit map of characters. More... | |
struct | fiosdmask_win |
This structure defines for setting mask window postion and size. More... | |
struct | fiosd_hw_info |
This structure defines for getting OSD hardware information. More... | |
Defines | |
#define | MAX_TARGET 10000 |
#define | X2OFFSET(base_w, x) (MAX_TARGET * x / base_w) |
#define | Y2OFFSET(base_h, y) (MAX_TARGET * y / base_h) |
#define | W2OFFSET(base_w, w) (MAX_TARGET * w / base_w) |
#define | H2OFFSET(base_h, h) (MAX_TARGET * h / base_h) |
#define | OFFSET2X(base_w, off_x) (off_x * base_w / MAX_TARGET) |
#define | OFFSET2Y(base_h, off_y) (off_y * base_h / MAX_TARGET) |
#define | OFFSET2W(base_w, off_w) (off_w * base_w / MAX_TARGET) |
#define | OFFSET2H(base_h, off_h) (off_h * base_h / MAX_TARGET) |
#define | FOSD_TRANSPARENT_0PERCENT 0 |
#define | FOSD_TRANSPARENT_50PERCENT 1 |
#define | FOSD_TRANSPARENT_75PERCENT 2 |
#define | FOSD_TRANSPARENT_100PERCENT 3 |
#define | VCAP_IOC_MAGIC 'f' |
#define | FIOSDS_ON _IOW(VCAP_IOC_MAGIC, 1, int) |
#define | FIOSDS_OFF _IOW(VCAP_IOC_MAGIC, 2, int) |
#define | FIOSDS_WIN _IOW(VCAP_IOC_MAGIC, 3, fiosd_win_t) |
#define | FIOSDS_FONTSETTING _IOW(VCAP_IOC_MAGIC, 4, fiosd_font_info_t) |
#define | FIOSDS_TRANSPARENT _IOW(VCAP_IOC_MAGIC, 5, fiosd_transparent_t) |
#define | FIOSDS_CHAR _IOW(VCAP_IOC_MAGIC, 6, fiosd_char_t) |
#define | FIOSDS_STRING _IOW(VCAP_IOC_MAGIC, 7, fiosd_string_t) |
#define | FIOSDS_PALTCOLOR _IOW(VCAP_IOC_MAGIC, 8, fiosd_palette_t) |
#define | FIOSDS_RMCHAR _IOW(VCAP_IOC_MAGIC, 9, char) |
#define | FIOSDG_CHARMAP _IOR(VCAP_IOC_MAGIC, 10, fiosd_charmap_t) |
#define | FIOSDG_HWINFO _IOR(VCAP_IOC_MAGIC, 11, fiosd_hw_info_t) |
#define | FIOSDS_BWINOFFSET _IOR(VCAP_IOC_MAGIC, 12, int) |
#define | FIOSDS_FRAMEMODE _IOR(VCAP_IOC_MAGIC, 13, int) |
#define | FIOSDMASKS_ON _IOW(VCAP_IOC_MAGIC, 30, int) |
#define | FIOSDMASKS_OFF _IOW(VCAP_IOC_MAGIC, 31, int) |
#define | FIOSDMASKS_TRANSPARENT _IOW(VCAP_IOC_MAGIC, 32, fiosd_transparent_t) |
#define | FIOSDMASKS_WIN _IOW(VCAP_IOC_MAGIC, 33, fiosdmask_win_t) |
#define | FIOSDMASKS_BWINOFFSET _IOW(VCAP_IOC_MAGIC, 34, int) |
Typedefs | |
typedef struct fiosd_win | fiosd_win_t |
typedef struct fiosd_font_info | fiosd_font_info_t |
typedef struct fiosd_palette | fiosd_palette_t |
typedef struct fiosd_char | fiosd_char_t |
typedef struct fiosd_string | fiosd_string_t |
typedef struct fiosd_transparent | fiosd_transparent_t |
typedef struct fiosd_charmap | fiosd_charmap_t |
typedef struct fiosdmask_win | fiosdmask_win_t |
typedef struct fiosd_hw_info | fiosd_hw_info_t |
Detailed Description
This file provides the capture OSD and Mask related function calls or IOCTLs.
- Author:
- Francis Huang
- Version:
- 0.1.0
- Date:
- 2010/09/28
Definition in file vcap_osd.h.
Define Documentation
#define MAX_TARGET 10000 |
Definition at line 30 of file vcap_osd.h.
#define X2OFFSET | ( | base_w, | ||
x | ||||
) | (MAX_TARGET * x / base_w) |
Definition at line 32 of file vcap_osd.h.
#define Y2OFFSET | ( | base_h, | ||
y | ||||
) | (MAX_TARGET * y / base_h) |
Definition at line 33 of file vcap_osd.h.
#define W2OFFSET | ( | base_w, | ||
w | ||||
) | (MAX_TARGET * w / base_w) |
Definition at line 34 of file vcap_osd.h.
#define H2OFFSET | ( | base_h, | ||
h | ||||
) | (MAX_TARGET * h / base_h) |
Definition at line 35 of file vcap_osd.h.
#define OFFSET2X | ( | base_w, | ||
off_x | ||||
) | (off_x * base_w / MAX_TARGET) |
Definition at line 37 of file vcap_osd.h.
#define OFFSET2Y | ( | base_h, | ||
off_y | ||||
) | (off_y * base_h / MAX_TARGET) |
Definition at line 38 of file vcap_osd.h.
#define OFFSET2W | ( | base_w, | ||
off_w | ||||
) | (off_w * base_w / MAX_TARGET) |
Definition at line 39 of file vcap_osd.h.
#define OFFSET2H | ( | base_h, | ||
off_h | ||||
) | (off_h * base_h / MAX_TARGET) |
Definition at line 40 of file vcap_osd.h.
#define FOSD_TRANSPARENT_0PERCENT 0 |
Definition at line 111 of file vcap_osd.h.
#define FOSD_TRANSPARENT_50PERCENT 1 |
Definition at line 112 of file vcap_osd.h.
#define FOSD_TRANSPARENT_75PERCENT 2 |
Definition at line 113 of file vcap_osd.h.
#define FOSD_TRANSPARENT_100PERCENT 3 |
Definition at line 114 of file vcap_osd.h.
#define VCAP_IOC_MAGIC 'f' |
Definition at line 145 of file vcap_osd.h.
#define FIOSDS_ON _IOW(VCAP_IOC_MAGIC, 1, int) |
Use to enable OSD window
ioctl(osd_fd, FIOSDS_ON, &windex).
- parameter :
osd_fd : OSD device handler
windex : specify to enable which OSD window, from 0~3
- Examples:
- cap_osd_string.c.
Definition at line 159 of file vcap_osd.h.
#define FIOSDS_OFF _IOW(VCAP_IOC_MAGIC, 2, int) |
Use to disable OSD window
ioctl(osd_fd, FIOSDS_OFF, &windex).
- parameter :
osd_fd : OSD device handler
windex : specify to disable which OSD window, from 0~3
- Examples:
- cap_osd_string.c.
Definition at line 169 of file vcap_osd.h.
#define FIOSDS_WIN _IOW(VCAP_IOC_MAGIC, 3, fiosd_win_t) |
Use to setup OSD window size and position
ioctl(osd_fd, FIOSDS_WIN, &win).
- parameter :
osd_fd : OSD device handler
win : reference to fiosd_win_t structure
- Examples:
- cap_osd_string.c.
Definition at line 179 of file vcap_osd.h.
#define FIOSDS_FONTSETTING _IOW(VCAP_IOC_MAGIC, 4, fiosd_font_info_t) |
Use to setup OSD font feature
ioctl(osd_fd, FIOSDS_FONTSETTING, &font_info).
- parameter :
osd_fd : OSD device handler
font_info : reference to fiosd_font_info_t structure
Definition at line 189 of file vcap_osd.h.
#define FIOSDS_TRANSPARENT _IOW(VCAP_IOC_MAGIC, 5, fiosd_transparent_t) |
Use to setup OSD font transparent level
ioctl(osd_fd, FIOSDS_TRANSPARENT, &font_tran).
- parameter :
osd_fd : OSD device handler
font_tran : reference to fiosd_transparent_t structure
- Examples:
- cap_osd_string.c.
Definition at line 199 of file vcap_osd.h.
#define FIOSDS_CHAR _IOW(VCAP_IOC_MAGIC, 6, fiosd_char_t) |
Use to add or replace a character in OSD ram
ioctl(osd_fd, FIOSDS_CHAR, &font_char).
- parameter :
osd_fd : OSD device handler
font_char : reference to fiosd_char_t structure
- Examples:
- cap_osd_string.c.
Definition at line 209 of file vcap_osd.h.
#define FIOSDS_STRING _IOW(VCAP_IOC_MAGIC, 7, fiosd_string_t) |
Use to setup OSD display string
ioctl(osd_fd, FIOSDS_STRING, &font_string).
- parameter :
osd_fd : OSD device handler
font_string : reference to fiosd_string_t structure
- Examples:
- cap_osd_string.c.
Definition at line 219 of file vcap_osd.h.
#define FIOSDS_PALTCOLOR _IOW(VCAP_IOC_MAGIC, 8, fiosd_palette_t) |
Use to setup OSD palette color
ioctl(osd_fd, FIOSDS_PALTCOLOR, &palette).
- parameter :
osd_fd : OSD device handler
palette : reference to fiosd_palette_t structure
- Examples:
- cap_osd_mask.c, and cap_osd_string.c.
Definition at line 229 of file vcap_osd.h.
#define FIOSDS_RMCHAR _IOW(VCAP_IOC_MAGIC, 9, char) |
Use to remove a character from OSD ram
ioctl(osd_fd, FIOSDS_RMCHAR, &font).
- parameter :
osd_fd : OSD device handler
font : character index
- Examples:
- cap_osd_string.c.
Definition at line 239 of file vcap_osd.h.
#define FIOSDG_CHARMAP _IOR(VCAP_IOC_MAGIC, 10, fiosd_charmap_t) |
Use to get the bit map of characters
ioctl(osd_fd, FIOSDG_CHARMAP, &charmap).
- parameter :
osd_fd : OSD device handler
charmap : reference to fiosd_charmap_t structure
Definition at line 249 of file vcap_osd.h.
#define FIOSDG_HWINFO _IOR(VCAP_IOC_MAGIC, 11, fiosd_hw_info_t) |
Use to get OSD hardware information
ioctl(osd_fd, FIOSDG_HWINFO, &hwinfo).
- parameter :
osd_fd : OSD device handler
hwinfo : reference to fiosd_hw_info_t structure
Definition at line 259 of file vcap_osd.h.
#define FIOSDS_BWINOFFSET _IOR(VCAP_IOC_MAGIC, 12, int) |
Use relative OSD window postion and dimension setup control
ioctl(osd_fd, FIOSDS_BWINOFFSET, &enable).
- parameter :
osd_fd : OSD device handler
enable : 0: disable, 1: enable
Definition at line 269 of file vcap_osd.h.
#define FIOSDS_FRAMEMODE _IOR(VCAP_IOC_MAGIC, 13, int) |
Use to enable/disable OSD force frame type
ioctl(osd_fd, FIOSDS_FRAMEMODE, &enable).
- parameter :
osd_fd : OSD device handler
enable : 0: disable, 1: enable
Definition at line 279 of file vcap_osd.h.
#define FIOSDMASKS_ON _IOW(VCAP_IOC_MAGIC, 30, int) |
Use to enable OSD mask window
ioctl(osd_fd, FIOSDMASKS_ON, &windex).
- parameter :
osd_fd : OSD device handler
windex : specify to enable which OSD mask window, from 0~7
- Examples:
- cap_osd_mask.c.
Definition at line 289 of file vcap_osd.h.
#define FIOSDMASKS_OFF _IOW(VCAP_IOC_MAGIC, 31, int) |
Use to disable OSD mask window
ioctl(osd_fd, FIOSDMASKS_OFF, &windex).
- parameter :
osd_fd : OSD device handler
windex : specify to disable which OSD mask window, from 0~7
- Examples:
- cap_osd_mask.c.
Definition at line 299 of file vcap_osd.h.
#define FIOSDMASKS_TRANSPARENT _IOW(VCAP_IOC_MAGIC, 32, fiosd_transparent_t) |
Use to setup OSD mask transparent level
ioctl(osd_fd, FIOSDMASKS_TRANSPARENT, &mask_tran).
- parameter :
osd_fd : OSD device handler
mask_tran : reference to fiosd_transparent_t structure
- Examples:
- cap_osd_mask.c.
Definition at line 309 of file vcap_osd.h.
#define FIOSDMASKS_WIN _IOW(VCAP_IOC_MAGIC, 33, fiosdmask_win_t) |
Use to setup OSD mask window size and position
ioctl(osd_fd, FIOSDMASKS_WIN, &win).
- parameter :
osd_fd : OSD device handler
win : reference to fiosdmask_win_t structure
- Examples:
- cap_osd_mask.c.
Definition at line 319 of file vcap_osd.h.
#define FIOSDMASKS_BWINOFFSET _IOW(VCAP_IOC_MAGIC, 34, int) |
Use relative OSD mask window postion and dimension setup control
ioctl(osd_fd, FIOSDMASKS_BWINOFFSET, &enable).
- parameter :
osd_fd : OSD device handler
enable : 0: disable, 1: enable
Definition at line 329 of file vcap_osd.h.
Typedef Documentation
typedef struct fiosd_win fiosd_win_t |
This structure defines for setting OSD window postion and size.
typedef struct fiosd_font_info fiosd_font_info_t |
This structure defines for setting OSD font feature.
If width and height smaller than fonts in OSD ram, the display font will be cut.
For example:
If the fonts size is 12x16 in sram, we set the fiosd_font_info as 6x8.
The OSD will display the quarter font from top-left.
typedef struct fiosd_palette fiosd_palette_t |
This structure defines for setting palette color.
typedef struct fiosd_char fiosd_char_t |
This structure defines for add or replace a character in OSD ram.
The index 0 is special for FIOSDS_RMCHAR.
typedef struct fiosd_string fiosd_string_t |
This structure defines for setting display string.
The OSD will display string from fiosd_string->start to fiosd_string->start +
strlen(fiosd_string->string) in OSD display array. The string[128] is string
index that depend on char bit map. While using multiple OSD windows at the same
time, user has to manager string length in the common string buffer.
typedef struct fiosd_transparent fiosd_transparent_t |
This structure defines for setting transparent level.
typedef struct fiosd_charmap fiosd_charmap_t |
This structure defines for getting the bit map of characters.
typedef struct fiosdmask_win fiosdmask_win_t |
This structure defines for setting mask window postion and size.
typedef struct fiosd_hw_info fiosd_hw_info_t |
This structure defines for getting OSD hardware information.
Generated on Thu Nov 25 2010 17:50:15 for GM8126/GM812X Capture IOCTL and API Reference by 1.7.1