Fujitsu DTV/STB solution driver (FAPex driver) Documentation [V01L00R00]


fapex/abst_libviout.h File Reference

abstraction library header file (Video Output driver) More...

Data Structures

struct  FAPEX_VISCALE_ParamChangeInfoT
 Parameters that have changed are intimated by this structure. More...
struct  FAPEX_VIOUT_HdmiParamStrT
 HDMI Video parameters for the VIOUT driver. More...
struct  FAPEX_VIOUT_OpenCmnParamStrT
 open parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_OpenSubParamStrT
 open sub_id parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_ScalerParamStrT
 scaler parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_AlphaParamStrT
 alpha parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_FadingParamStrT
 fade parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_ResizeParamStrT
 resize parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_PosParamStrT
 position parameters for the VIOUT driver More...
struct  FAPEX_VIOUT_FillRectParamStrT
 fill rectangle parameters for the VIOUT driver More...

Defines

#define FAPEX_VIOUT_ERR_BASE   (FAPEX_VISCALE_MODULE_BASE + FAPEX_RET_ERR_BASE)
#define FAPEX_VIOUT_ERR_BAD_PARAMETER   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)
#define FAPEX_VIOUT_ERR_OUT_OF_MEMORY   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)
#define FAPEX_VIOUT_ERR_INVALID_STATUS   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)
#define FAPEX_VIOUT_ERR_SEMAPHORE_CREATE   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_SEMAPHORE_CREATE)
#define FAPEX_VIOUT_SYSTEM_MODE_UNKNOWN   0
 Enumeration type for system mode.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x2397P   1
 System mode is 1920x1080p at 23.97 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x24P   2
 System mode is 1920x1080p at 24 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x25P   3
 System mode is 1920x1080p at 25 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x2997P   4
 System mode is 1920x1080p at 29.97 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x30P   5
 System mode is 1920x1080p at 30 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x50I   6
 System mode is 1920x1080i at 50 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x50P   7
 System mode is 1920x1080p at 50 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x5994I   8
 System mode is 1920x1080i at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x5994P   9
 System mode is 1920x1080p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x60I   10
 System mode is 1920x1080i at 60 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x60P   11
 System mode is 1920x1080p at 60 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x2397P   12
 System mode is 1280x720p at 23.97 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x24P   13
 System mode is 1280x720p at 24 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x25P   14
 System mode is 1280x720p at 25 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x2997P   15
 System mode is 1280x720p at 29.97 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x30P   16
 System mode is 1280x720p at 30 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x50P   17
 System mode is 1280x720p at 50 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x5994P   18
 System mode is 1280x720p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x60P   19
 System mode is 1280x720p at 60 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_720x576x50I   20
 System mode is 720x576i at 50 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_720x576x50P   21
 System mode is 720x576p at 50 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_720x480x5994I   22
 System mode is 720x480i at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_720x480x5994P   23
 System mode is 720x480p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_VGA_640x480x5994P   24
 System mode is 640x480p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_VGA_800x600x5994P   25
 System mode is 800x600p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_VGA_1024x768x5994P   26
 System mode is 1024x768p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_VGA_1360x768x5994P   27
 System mode is 1360x768p at 59.94 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_LCD_640x480x50P   28
 System mode is 640x480p at 50 Hz.
#define FAPEX_VIOUT_SYSTEM_MODE_LCD_1024x768x50P   29
 System mode is 1024x768p at 50 Hz.
#define FAPEX_VIOUT_ENABLE_NORMAL   (0x0000)
 default output
#define FAPEX_VIOUT_ENABLE_HDMI   (0x0001)
 Enable HDMI output.
#define FAPEX_VIOUT_SCALER_UNKNOWN   (-1)
 Unknown scaler.
#define FAPEX_VIOUT_SCALER_VIDEO   0
 Video scaler.
#define FAPEX_VIOUT_SCALER_SD   1
 SD scaler.
#define FAPEX_VIOUT_SCALER_WBU   2
#define FAPEX_VIOUT_SCALER_OSD1   3
 OSD1 scaler.
#define FAPEX_VIOUT_SCALER_OSD2   4
 OSD2 scaler.
#define FAPEX_VIOUT_SCALER_OSD3   5
 OSD1 scaler.
#define FAPEX_VIOUT_SCALER_OSD4   6
 OSD2 scaler.
#define FAPEX_VIOUT_SCALER_CURSOR_PLANE   7
 Cursor Plane.
#define FAPEX_VIOUT_OVERLAY_UNKNOWN   (-1)
 Unknown state of topology descriptor.
#define FAPEX_VIOUT_OVERLAY_NO_OSD   0
 None of the OSD layers are overlaid on SD output so all are on HD path.
#define FAPEX_VIOUT_OVERLAY_OSD1   1
 OSD1 scaler overlaid on SD output.
#define FAPEX_VIOUT_OVERLAY_OSD2   2
 OSD2 scaler overlaid on SD output.
#define FAPEX_VIOUT_OVERLAY_OSD3   3
 OSD3 scaler overlaid on SD out.
#define FAPEX_VIOUT_OVERLAY_OSD4   4
 OSD4 scaler overlaid on SD output.
#define FAPEX_VIOUT_OVERLAY_CURSOR   5
 Cursor overlaid on SD output.
#define FAPEX_VIOUT_VO_BYPASS_DISABLE   6
 Configuration parameter for turning off VO scaler bypass mode.
#define FAPEX_VIOUT_VO_BYPASS_ENABLE   7
 Configuration parameter for bypassing the VO scaler.
#define FAPEX_VIOUT_SCALER_MODE_NONE   0
#define FAPEX_VIOUT_SCALER_MODE_PLBOX   1
 Pillar or letter box.
#define FAPEX_VIOUT_SCALER_MODE_FSZOOM   2
 Fullscreen zoom.
#define FAPEX_VIOUT_SCALER_MODE_FSCCO   3
 fullscreen center cut out
#define FAPEX_VIOUT_SCALER_MODE_LTVS   4
 let TV scale
#define FAPEX_VIOUT_OSD_MODE_32_24BIT   0
 Tru colour 32 or 24 bit OSD.
#define FAPEX_VIOUT_OSD_MODE_5551   1
 Tru colour 16 bit 5551 OSD.
#define FAPEX_VIOUT_OSD_MODE_4444   2
 Tru colour 14 bit 444 OSD.
#define FAPEX_VIOUT_OSD_MODE_16BIT   4
 16 bit OSD
#define FAPEX_VIOUT_OSD_MODE_CLUT_4BIT   10
 4 bit clut OSD
#define FAPEX_VIOUT_OSD_MODE_CLUT_8BIT   11
 8 bit clut OSD
#define FAPEX_VIOUT_OSD_MODE_UNKNOWN   15
 Unknown OSD mode.
#define FAPEX_VIOUT_CURSOR_MODE_1BIT   0
 1 bit Cursor
#define FAPEX_VIOUT_CURSOR_MODE_2BIT   1
 2 bit Cursor
#define FAPEX_VIOUT_CURSOR_MODE_4BIT   2
 4 bit Cursor
#define FAPEX_VIOUT_CURSOR_MODE_8BIT   3
 8 bit Cursor
#define FAPEX_VIOUT_CURSOR_MODE_UNKNOWN   4
 Unknown Cursor mode.
#define FAPEX_VIOUT_OSD_LAYOUT_UNKNOWN   (-1)
 Unknown layout format of OSD in memory.
#define FAPEX_VIOUT_OSD_LAYOUT_ARGB   1
 RGB mode with alpha as most significant byte.
#define FAPEX_VIOUT_OSD_LAYOUT_RGBA   2
 RGB mode with alpha as least significant byte.
#define FAPEX_VIOUT_OSD_LAYOUT_ACbYCr   3
 CrYCb mode with alpha as most significant byte.
#define FAPEX_VIOUT_OSD_LAYOUT_CbYCrA   4
 CrYCb mode with alpha as least significant byte.
#define FAPEX_VIOUT_PARAMETER_GET   0
 Returns the parameters.
#define FAPEX_VIOUT_PARAMETER_SET   1
 Applies the parameters.
#define FAPEX_VIOUT_PARAMETER_INCREASE   2
 Increase by step size as specified.
#define FAPEX_VIOUT_PARAMETER_DECREASE   3
 decrease by step size as specified
#define FAPEX_VIOUT_PARAMETER_ON   4
 Turns on a specified parameter or feature.
#define FAPEX_VIOUT_PARAMETER_OFF   5
 Turns off a specified parameter or feature.
#define FAPEX_VIOUT_VIDEO_FADE_IN   0
 For fading in video.
#define FAPEX_VIOUT_VIDEO_FADE_OUT   1
 For fading out video.
#define FAPEX_VIOUT_MAX_HRES   1920
#define FAPEX_VIOUT_MAX_VRES   1088
#define FAPEX_VIOUT_OSD1_MAX_LINE_BYTE   (960 * 8)
#define FAPEX_VIOUT_OSD2_MAX_LINE_BYTE   (240 * 8)
#define FAPEX_VIOUT_OSD1_MAX_SIZE   (FAPEX_VIOUT_OSD1_MAX_LINE_BYTE * FAPEX_VIOUT_MAX_VRES)
#define FAPEX_VIOUT_OSD2_MAX_SIZE   (FAPEX_VIOUT_OSD2_MAX_LINE_BYTE * FAPEX_VIOUT_MAX_VRES)
#define FAPEX_VIOUT_CURSOR_RAM_MAX_SIZE   (4 * 1024)
#define FAPEX_IOCCOM_VIOUT_OPEN   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 0, FAPEX_VIOUT_OpenCmnParamStrT)
 ioctl specific command for the VIOUT driver
#define FAPEX_IOCCOM_VIOUT_OPEN_SUBID   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_SUBID_VIOUT, FAPEX_VIOUT_OpenSubParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_PLANEORDER   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 1, int32_t[6])
#define FAPEX_IOCCOM_VIOUT_GET_PLANEORDER   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 1, int32_t[6])
#define FAPEX_IOCCOM_VIOUT_SET_BGCOLOUR   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 2, uint32_t)
#define FAPEX_IOCCOM_VIOUT_GET_BGCOLOUR   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 2, uint32_t)
#define FAPEX_IOCCOM_VIOUT_GET_SYSTEM_MODE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 3, int32_t)
#define FAPEX_IOCCOM_VIOUT_ENABLE   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 4)
#define FAPEX_IOCCOM_VIOUT_DISABLE   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 5)
#define FAPEX_IOCCOM_VIOUT_SET_SCALER_PARAMS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 6, FAPEX_VIOUT_ScalerParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_SCALER_PARAMS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 6, FAPEX_VIOUT_ScalerParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_ASPECT_RATIO   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 7, uint32_t)
#define FAPEX_IOCCOM_VIOUT_SET_ALPHA   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 8, FAPEX_VIOUT_AlphaParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_ALPHA   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 9, uint32_t)
#define FAPEX_IOCCOM_VIOUT_SET_FADING   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 10, FAPEX_VIOUT_FadingParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_FADING   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 10, FAPEX_VIOUT_FadingParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_RESIZE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 11, FAPEX_VIOUT_ResizeParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_POSITION   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 12, FAPEX_VIOUT_PosParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_POSITION   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 12, FAPEX_VIOUT_PosParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_FILLCOLOUR   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 13, uint32_t)
#define FAPEX_IOCCOM_VIOUT_GET_FILLCOLOUR   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 13, uint32_t)
#define FAPEX_IOCCOM_VIOUT_FILL_RECTANGLE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 14, FAPEX_VIOUT_FillRectParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_CLUT   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 15, uint32_t[256])
#define FAPEX_IOCCOM_VIOUT_GET_CLUT   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 15, uint32_t[256])
#define FAPEX_IOCCOM_VIOUT_SET_HILIGHT   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 16, uint32_t)
#define FAPEX_IOCCOM_VIOUT_FLUSH_PLANE   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 17)
#define FAPEX_IOCCOM_VIOUT_UPDATE_AVI_INFO   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 18, FAPEX_VIOUT_HdmiParamStrT)
#define FAPEX_IOCCOM_VIOUT_HDMI_RESTART   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 19)
#define FAPEX_IOCCOM_VIOUT_SCALER_SET_WSSSTATE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 20, FAPEX_VISCALE_WssStateEnumT)
#define FAPEX_IOCCOM_VIOUT_SET_BRIGHTNESS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 21, int32_t)
#define FAPEX_IOCCOM_VIOUT_SET_CONTRAST   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 22, int32_t)
#define FAPEX_IOCCOM_VIOUT_SET_SATURATION   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 23, int32_t)

Enumerations

enum  FAPEX_VISCALE_AspectRatioEnumT {
  FAPEX_VIOUT_DISPLAY_AR_NONE = 0, FAPEX_VIOUT_DISPLAY_AR_4_3, FAPEX_VIOUT_DISPLAY_AR_14_9, FAPEX_VIOUT_DISPLAY_AR_16_9,
  FAPEX_VIOUT_DISPLAY_AR_221_100, FAPEX_VIOUT_DISPLAY_AR_235_100
}
 

Enumeration type for user defined aspect ratio of the display.

More...
enum  FAPEX_VISCALE_ScalingMethodEnumT {
  FAPEX_VISCALE_SM_NONE = 0, FAPEX_VISCALE_SM_PLBOX, FAPEX_VISCALE_SM_FSZOOM, FAPEX_VISCALE_SM_FSCCO,
  FAPEX_VISCALE_SM_LTVS
}
 

Enumeration type for user defined scaling methods.

More...
enum  FAPEX_VISCALE_WssStateEnumT {
  FAPEX_VISCALE_UNKNOWN_WSS_STATE = (int32_t)-1, FAPEX_VISCALE_WSS_ENABLE_4_3_FULLFORMAT = 8, FAPEX_VISCALE_WSS_ENABLE_14_9_CENTRE = 1, FAPEX_VISCALE_WSS_ENABLE_16_9_BOX_CENTRE = 11,
  FAPEX_VISCALE_WSS_ENABLE_16_9_BOX_GT_CENTRE = 13, FAPEX_VISCALE_WSS_ENABLE_14_9_FULLFORMAT = 14, FAPEX_VISCALE_WSS_ENABLE_16_9_ANAMORPHIC = 7, FAPEX_VISCALE_WSS_ENABLE_14_9_TOP = 2,
  FAPEX_VISCALE_WSS_ENABLE_16_9_BOX_TOP = 4, FAPEX_VISCALE_WSS_DISABLE = 0
}
 

Enumerated types for Hnadling of Wss signal on analog SD encoder.

More...

Functions

FAPEXOPENRET_T FAPEX_VIOUT_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_VIOUT_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXIOCRET_T FAPEX_VIOUT_Ioctl (FAPEXIOCARG1_T id, FAPEXIOCARG2_T cmd, FAPEXIOCARG3_T pArg)
 ioctl method. This function is called with the systemcall "ioctl".
FAPEXMMPRET_T FAPEX_VIOUT_Mmap (FAPEXMMPARG1_T start, FAPEXMMPARG2_T length, FAPEXMMPARG3_T prot, FAPEXMMPARG4_T flags, FAPEXMMPARG5_T id, FAPEXMMPARG6_T offset)
 mmap method. This function is called with the systemcall "mmap".

FAPEXMUNMPRET_T FAPEX_VIOUT_Munmap (FAPEXMMPARG1_T start, FAPEXMMPARG2_T length)
 munmap method. This function is called with the systemcall "munmap".

Detailed Description

abstraction library header file (Video Output driver)

Attention:
This program is provided as is. You can redistribute it and/or modify it. Fujitsu Semiconductor Limited accepts no responsibility or liability for any errors or omissions.

Copyright (C) 2008-2010 Fujitsu Semiconductor Limited, All Rights Reserved.


Define Documentation

#define FAPEX_VIOUT_ERR_BASE   (FAPEX_VISCALE_MODULE_BASE + FAPEX_RET_ERR_BASE)

FAPex VIOUT error code base value

#define FAPEX_VIOUT_ERR_BAD_PARAMETER   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)

Bad parameter passed.

#define FAPEX_VIOUT_ERR_OUT_OF_MEMORY   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)

Memory allocation failed.

#define FAPEX_VIOUT_ERR_INVALID_STATUS   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_INVALID_HANDLE)

Invalid status.

#define FAPEX_VIOUT_ERR_SEMAPHORE_CREATE   (FAPEX_VIOUT_ERR_BASE + FAPEX_ERR_SEMAPHORE_CREATE)

Semaphore could not be created.

#define FAPEX_VIOUT_SYSTEM_MODE_UNKNOWN   0

Enumeration type for system mode.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x2397P   1

System mode is 1920x1080p at 23.97 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x24P   2

System mode is 1920x1080p at 24 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x25P   3

System mode is 1920x1080p at 25 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x2997P   4

System mode is 1920x1080p at 29.97 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x30P   5

System mode is 1920x1080p at 30 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x50I   6

System mode is 1920x1080i at 50 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x50P   7

System mode is 1920x1080p at 50 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x5994I   8

System mode is 1920x1080i at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x5994P   9

System mode is 1920x1080p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x60I   10

System mode is 1920x1080i at 60 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1920x1080x60P   11

System mode is 1920x1080p at 60 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x2397P   12

System mode is 1280x720p at 23.97 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x24P   13

System mode is 1280x720p at 24 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x25P   14

System mode is 1280x720p at 25 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x2997P   15

System mode is 1280x720p at 29.97 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x30P   16

System mode is 1280x720p at 30 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x50P   17

System mode is 1280x720p at 50 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x5994P   18

System mode is 1280x720p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_1280x720x60P   19

System mode is 1280x720p at 60 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_720x576x50I   20

System mode is 720x576i at 50 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_720x576x50P   21

System mode is 720x576p at 50 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_720x480x5994I   22

System mode is 720x480i at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_720x480x5994P   23

System mode is 720x480p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_VGA_640x480x5994P   24

System mode is 640x480p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_VGA_800x600x5994P   25

System mode is 800x600p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_VGA_1024x768x5994P   26

System mode is 1024x768p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_VGA_1360x768x5994P   27

System mode is 1360x768p at 59.94 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_LCD_640x480x50P   28

System mode is 640x480p at 50 Hz.

#define FAPEX_VIOUT_SYSTEM_MODE_LCD_1024x768x50P   29

System mode is 1024x768p at 50 Hz.

#define FAPEX_VIOUT_ENABLE_NORMAL   (0x0000)

default output

#define FAPEX_VIOUT_ENABLE_HDMI   (0x0001)

Enable HDMI output.

#define FAPEX_VIOUT_SCALER_UNKNOWN   (-1)

Unknown scaler.

#define FAPEX_VIOUT_SCALER_VIDEO   0

Video scaler.

#define FAPEX_VIOUT_SCALER_SD   1

SD scaler.

#define FAPEX_VIOUT_SCALER_WBU   2
#define FAPEX_VIOUT_SCALER_OSD1   3

OSD1 scaler.

#define FAPEX_VIOUT_SCALER_OSD2   4

OSD2 scaler.

#define FAPEX_VIOUT_SCALER_OSD3   5

OSD1 scaler.

#define FAPEX_VIOUT_SCALER_OSD4   6

OSD2 scaler.

#define FAPEX_VIOUT_SCALER_CURSOR_PLANE   7

Cursor Plane.

#define FAPEX_VIOUT_OVERLAY_UNKNOWN   (-1)

Unknown state of topology descriptor.

#define FAPEX_VIOUT_OVERLAY_NO_OSD   0

None of the OSD layers are overlaid on SD output so all are on HD path.

#define FAPEX_VIOUT_OVERLAY_OSD1   1

OSD1 scaler overlaid on SD output.

#define FAPEX_VIOUT_OVERLAY_OSD2   2

OSD2 scaler overlaid on SD output.

#define FAPEX_VIOUT_OVERLAY_OSD3   3

OSD3 scaler overlaid on SD out.

#define FAPEX_VIOUT_OVERLAY_OSD4   4

OSD4 scaler overlaid on SD output.

#define FAPEX_VIOUT_OVERLAY_CURSOR   5

Cursor overlaid on SD output.

#define FAPEX_VIOUT_VO_BYPASS_DISABLE   6

Configuration parameter for turning off VO scaler bypass mode.

#define FAPEX_VIOUT_VO_BYPASS_ENABLE   7

Configuration parameter for bypassing the VO scaler.

#define FAPEX_VIOUT_SCALER_MODE_NONE   0
#define FAPEX_VIOUT_SCALER_MODE_PLBOX   1

Pillar or letter box.

#define FAPEX_VIOUT_SCALER_MODE_FSZOOM   2

Fullscreen zoom.

#define FAPEX_VIOUT_SCALER_MODE_FSCCO   3

fullscreen center cut out

#define FAPEX_VIOUT_SCALER_MODE_LTVS   4

let TV scale

#define FAPEX_VIOUT_OSD_MODE_32_24BIT   0

Tru colour 32 or 24 bit OSD.

#define FAPEX_VIOUT_OSD_MODE_5551   1

Tru colour 16 bit 5551 OSD.

#define FAPEX_VIOUT_OSD_MODE_4444   2

Tru colour 14 bit 444 OSD.

#define FAPEX_VIOUT_OSD_MODE_16BIT   4

16 bit OSD

#define FAPEX_VIOUT_OSD_MODE_CLUT_4BIT   10

4 bit clut OSD

#define FAPEX_VIOUT_OSD_MODE_CLUT_8BIT   11

8 bit clut OSD

#define FAPEX_VIOUT_OSD_MODE_UNKNOWN   15

Unknown OSD mode.

#define FAPEX_VIOUT_CURSOR_MODE_1BIT   0

1 bit Cursor

#define FAPEX_VIOUT_CURSOR_MODE_2BIT   1

2 bit Cursor

#define FAPEX_VIOUT_CURSOR_MODE_4BIT   2

4 bit Cursor

#define FAPEX_VIOUT_CURSOR_MODE_8BIT   3

8 bit Cursor

#define FAPEX_VIOUT_CURSOR_MODE_UNKNOWN   4

Unknown Cursor mode.

#define FAPEX_VIOUT_OSD_LAYOUT_UNKNOWN   (-1)

Unknown layout format of OSD in memory.

#define FAPEX_VIOUT_OSD_LAYOUT_ARGB   1

RGB mode with alpha as most significant byte.

#define FAPEX_VIOUT_OSD_LAYOUT_RGBA   2

RGB mode with alpha as least significant byte.

#define FAPEX_VIOUT_OSD_LAYOUT_ACbYCr   3

CrYCb mode with alpha as most significant byte.

#define FAPEX_VIOUT_OSD_LAYOUT_CbYCrA   4

CrYCb mode with alpha as least significant byte.

#define FAPEX_VIOUT_PARAMETER_GET   0

Returns the parameters.

#define FAPEX_VIOUT_PARAMETER_SET   1

Applies the parameters.

#define FAPEX_VIOUT_PARAMETER_INCREASE   2

Increase by step size as specified.

#define FAPEX_VIOUT_PARAMETER_DECREASE   3

decrease by step size as specified

#define FAPEX_VIOUT_PARAMETER_ON   4

Turns on a specified parameter or feature.

#define FAPEX_VIOUT_PARAMETER_OFF   5

Turns off a specified parameter or feature.

#define FAPEX_VIOUT_VIDEO_FADE_IN   0

For fading in video.

#define FAPEX_VIOUT_VIDEO_FADE_OUT   1

For fading out video.

#define FAPEX_VIOUT_MAX_HRES   1920
#define FAPEX_VIOUT_MAX_VRES   1088
#define FAPEX_VIOUT_OSD1_MAX_LINE_BYTE   (960 * 8)
#define FAPEX_VIOUT_OSD2_MAX_LINE_BYTE   (240 * 8)
#define FAPEX_VIOUT_OSD1_MAX_SIZE   (FAPEX_VIOUT_OSD1_MAX_LINE_BYTE * FAPEX_VIOUT_MAX_VRES)
#define FAPEX_VIOUT_OSD2_MAX_SIZE   (FAPEX_VIOUT_OSD2_MAX_LINE_BYTE * FAPEX_VIOUT_MAX_VRES)
#define FAPEX_VIOUT_CURSOR_RAM_MAX_SIZE   (4 * 1024)
#define FAPEX_IOCCOM_VIOUT_OPEN   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 0, FAPEX_VIOUT_OpenCmnParamStrT)

ioctl specific command for the VIOUT driver

#define FAPEX_IOCCOM_VIOUT_OPEN_SUBID   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_SUBID_VIOUT, FAPEX_VIOUT_OpenSubParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_PLANEORDER   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 1, int32_t[6])
#define FAPEX_IOCCOM_VIOUT_GET_PLANEORDER   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 1, int32_t[6])
#define FAPEX_IOCCOM_VIOUT_SET_BGCOLOUR   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 2, uint32_t)
#define FAPEX_IOCCOM_VIOUT_GET_BGCOLOUR   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 2, uint32_t)
#define FAPEX_IOCCOM_VIOUT_GET_SYSTEM_MODE   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 3, int32_t)
#define FAPEX_IOCCOM_VIOUT_ENABLE   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 4)
#define FAPEX_IOCCOM_VIOUT_DISABLE   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 5)
#define FAPEX_IOCCOM_VIOUT_SET_SCALER_PARAMS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 6, FAPEX_VIOUT_ScalerParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_SCALER_PARAMS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 6, FAPEX_VIOUT_ScalerParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_ASPECT_RATIO   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 7, uint32_t)
#define FAPEX_IOCCOM_VIOUT_SET_ALPHA   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 8, FAPEX_VIOUT_AlphaParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_ALPHA   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 9, uint32_t)
#define FAPEX_IOCCOM_VIOUT_SET_FADING   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 10, FAPEX_VIOUT_FadingParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_FADING   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 10, FAPEX_VIOUT_FadingParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_RESIZE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 11, FAPEX_VIOUT_ResizeParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_POSITION   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 12, FAPEX_VIOUT_PosParamStrT)
#define FAPEX_IOCCOM_VIOUT_GET_POSITION   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 12, FAPEX_VIOUT_PosParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_FILLCOLOUR   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 13, uint32_t)
#define FAPEX_IOCCOM_VIOUT_GET_FILLCOLOUR   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 13, uint32_t)
#define FAPEX_IOCCOM_VIOUT_FILL_RECTANGLE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 14, FAPEX_VIOUT_FillRectParamStrT)
#define FAPEX_IOCCOM_VIOUT_SET_CLUT   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 15, uint32_t[256])
#define FAPEX_IOCCOM_VIOUT_GET_CLUT   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 15, uint32_t[256])
#define FAPEX_IOCCOM_VIOUT_SET_HILIGHT   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 16, uint32_t)
#define FAPEX_IOCCOM_VIOUT_FLUSH_PLANE   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 17)
#define FAPEX_IOCCOM_VIOUT_UPDATE_AVI_INFO   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 18, FAPEX_VIOUT_HdmiParamStrT)
#define FAPEX_IOCCOM_VIOUT_HDMI_RESTART   _IO (FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 19)
#define FAPEX_IOCCOM_VIOUT_SCALER_SET_WSSSTATE   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 20, FAPEX_VISCALE_WssStateEnumT)
#define FAPEX_IOCCOM_VIOUT_SET_BRIGHTNESS   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 21, int32_t)
#define FAPEX_IOCCOM_VIOUT_SET_CONTRAST   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 22, int32_t)
#define FAPEX_IOCCOM_VIOUT_SET_SATURATION   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_VIOUT + 23, int32_t)

Enumeration Type Documentation

Enumeration type for user defined aspect ratio of the display.

Enumerator:
FAPEX_VIOUT_DISPLAY_AR_NONE 

Aspect ratio is not defined,so the aspect ratio shall be as it is of the stream after application of AFD later filling the whole active region.

FAPEX_VIOUT_DISPLAY_AR_4_3 

Aspect ratio is 4/3.

FAPEX_VIOUT_DISPLAY_AR_14_9 

Aspect ratio is 14/9.

FAPEX_VIOUT_DISPLAY_AR_16_9 

Aspect ratio is 16/9 also called wide screen.

FAPEX_VIOUT_DISPLAY_AR_221_100 

Aspect ratio is 20/9 or also called 2.21.

FAPEX_VIOUT_DISPLAY_AR_235_100 

Aspect ratio is 235/100 or also called 2.35.

Enumeration type for user defined scaling methods.

Enumerator:
FAPEX_VISCALE_SM_NONE 

User can specify the preferred active area.

FAPEX_VISCALE_SM_PLBOX 

Scaling method specified as Pillar or letter box.

FAPEX_VISCALE_SM_FSZOOM 

Scaling method specified as Fullscreen zoom.

FAPEX_VISCALE_SM_FSCCO 

Scaling method specified as fullscreen center cut out.

FAPEX_VISCALE_SM_LTVS 

Scaling method specified as let TV scale.

Enumerated types for Hnadling of Wss signal on analog SD encoder.

Enumerator:
FAPEX_VISCALE_UNKNOWN_WSS_STATE 

Unknown handling state of Wss Signal.

FAPEX_VISCALE_WSS_ENABLE_4_3_FULLFORMAT 

User defined Wss signal is 8.

FAPEX_VISCALE_WSS_ENABLE_14_9_CENTRE 

User defined Wss signal is 1.

FAPEX_VISCALE_WSS_ENABLE_16_9_BOX_CENTRE 

User defined Wss signal is 11.

FAPEX_VISCALE_WSS_ENABLE_16_9_BOX_GT_CENTRE 

User defined Wss signal is 13.

FAPEX_VISCALE_WSS_ENABLE_14_9_FULLFORMAT 

User defined Wss signal is 14.

FAPEX_VISCALE_WSS_ENABLE_16_9_ANAMORPHIC 

User defined Wss signal is 7.

FAPEX_VISCALE_WSS_ENABLE_14_9_TOP 

User defined Wss signal is 2.

FAPEX_VISCALE_WSS_ENABLE_16_9_BOX_TOP 

User defined Wss signal is 4.

FAPEX_VISCALE_WSS_DISABLE 

The Wss Signaling is disabled.


Function Documentation

FAPEXOPENRET_T FAPEX_VIOUT_Open ( FAPEXOPENARG1_T  id,
FAPEXOPENARG2_T  flags,
FAPEXOPENARG3_T  argptr 
)

open method. This function is called with the systemcall "open".

Parameters:
idThe identifier for all layer (common descriptor).
flagsThis parameter indicate a open mode (read only/write only/read-write).
This implementation supports only read-write mode.
argptrargument pointer (FAPEX_VIOUT_OpenCmnParamStrT)
If descriptor for this 'id' has already been opened, this 'argptr' will be invalid.
Return values:
>=0process OK, new file descriptor is returned.
<0process fails, its value is set to errno.
FAPEXRELRET_T FAPEX_VIOUT_Close ( FAPEXRELARG1_T  id )

release method. This function is called with the systemcall "close".

Parameters:
idThe identifier for all layer (common descriptor).
Return values:
0process OK
<0process fails, its value is set to errno.
FAPEXIOCRET_T FAPEX_VIOUT_Ioctl ( FAPEXIOCARG1_T  id,
FAPEXIOCARG2_T  cmd,
FAPEXIOCARG3_T  pArg 
)

ioctl method. This function is called with the systemcall "ioctl".

Parameters:
idThe identifier for this descriptor.
cmdThe ioctl command.
pArgThe pointer to the argument of the ioctl command.
Return values:
0process OK
<0process fails, its value is set to errno.

ioctl command(cmd) type:

  • FAPEX_IOCCOM_VIOUT_SET_PLANEORDER
    set Plane Order.
    Set pointer of order array data field (int32_t order[6]) to pArg.
    (order[0]:video, order[1]:osd1, order[2]:osd2, order[3]:osd3, order[4]:osd4, order[5]:cp)
    The id should be common descriptor opened in FAPEX_VIOUT_Open().

  • FAPEX_IOCCOM_VIOUT_GET_PLANEORDER
    get Plane Order.
    Set pointer of order array data field (int32_t order[4]) to pArg.
    (order[0]:video, order[1]:osd1, order[2]:osd2, order[3]:cp) The order number value will be set to these field.
    If it is negative value, its plane is not shown.
    The id should be common descriptor opened in FAPEX_VIOUT_Open().

  • FAPEX_IOCCOM_VIOUT_GET_BGCOLOUR
    get back ground color.
    Set pointer of colour data field (uint32_t) to pArg.
    The colour value (bit23-16:Y bit15-8:Cr bit7-0:Cb) will be set to this field.
    The id should be common descriptor opened in FAPEX_VIOUT_Open().

  • FAPEX_IOCCOM_START
    start Video output layer. (pArg is ignored)
    When id is common descriptor, all Video output layers on the ready state will start.
    When id is sub descriptor on the ready state, only this layer will start.

  • FAPEX_IOCCOM_STOP
    stop Video Output. (pArg is ignored)
    When id is common descriptor, all Video output layers on the running state will stop.
    When id is sub descriptor on the running state, only this layer will stop.

  • FAPEX_IOCCOM_VIOUT_SET_SATURATION
    set the saturation.
    Set the saturation from the arg. The recommended saturation values run from 0 (0%) to +400 (400%). 0% saturation stands for complete Black & white video. 100% saturation stands for coded chrominance levels. 400% saturation stands for over saturated chrominance levels.
FAPEXMMPRET_T FAPEX_VIOUT_Mmap ( FAPEXMMPARG1_T  start,
FAPEXMMPARG2_T  length,
FAPEXMMPARG3_T  prot,
FAPEXMMPARG4_T  flags,
FAPEXMMPARG5_T  id,
FAPEXMMPARG6_T  offset 
)

mmap method. This function is called with the systemcall "mmap".

This function supports accessing of the mapped area for frame buffer of OSD1/OSD2/CursorPlane.
The 'length' should be computed by ((inputWindowWidth x inputWindowHeight x bpp) >> 3) of FAPEX_VIOUT_ScalerParamStrT structure.
This information of FAPEX_VIOUT_ScalerParamStrT is got by using FAPEX_IOCCOM_VIOUT_GET_SCALER_PARAMS command with FAPEX_VIOUT_Ioctl().

Parameters:
startThe memory mapping start pointer.
lengthThe memory mapping size.
protThe desired memory protection.
flagsThe mapping option.
idThe identifier for OSD1/OSD2/CursorPlane layer descriptor (sub descriptor).
offsetThe memory mapping offset value.
Return values:
>0process OK, its value is the mapping address.
<0process fails, its value is set to errno.
FAPEXMUNMPRET_T FAPEX_VIOUT_Munmap ( FAPEXMMPARG1_T  start,
FAPEXMMPARG2_T  length 
)

munmap method. This function is called with the systemcall "munmap".

Parameters:
startThe memory mapping start pointer.
lengthThe memory mapping size.
Return values:
0process OK
<0process fails, its value is set to errno.


Copyright © 2006-2010 by Fujitsu Semiconductor Europe GmbH
Copyright © 2008-2010 by Fujitsu Semiconductor Limited

Disclaimer:
Please note that the use of this has been based on the terms and conditions of "DK Consent Letter (For Linux)" agreement between you and Fujitsu Semiconductor Limited.
The contents of this document may be revised without prior notice. Contact our sales department for confirmation. The information in this document are presented as is, no license is granted by implication or otherwise.
More...

FUJITSU sales representatives