... more
« Back to documentation index
r_vdec.h File Reference
VDEC driver API definitions.
More...
Go to the source code of this file.
struct vdec_active_period_t struct vdec_noise_rd_lpf_t struct vdec_sync_slicer_t struct vdec_horizontal_afc_t struct vdec_vcount_down_t struct vdec_agc_t struct vdec_peak_limiter_t struct vdec_sync_separation_t struct vdec_over_range_t struct vdec_yc_sep_ctrl_t struct vdec_chrfil_tap_t struct vdec_yc_separation_t struct vdec_chrmdec_ctrl_t struct vdec_burst_lock_t struct vdec_acc_t struct vdec_tint_ry_t struct vdec_chroma_decoding_t struct vdec_pedestal_clamp_t struct vdec_center_clamp_t struct vdec_noise_det_t struct vdec_degital_clamp_t struct vdec_output_t struct vdec_q_sync_sep_t struct vdec_q_agc_t struct vdec_q_chroma_dec_t struct vdec_q_digital_clamp_t enum vdec_error_t { VDEC_OK = 0,
VDEC_ERR_CHANNEL ,
VDEC_ERR_PARAM ,
VDEC_ERR_NUM
}enum vdec_channel_t { VDEC_CHANNEL_0 = 0,
VDEC_CHANNEL_1 ,
VDEC_CHANNEL_NUM
}enum vdec_onoff_t { VDEC_OFF = 0,
VDEC_ON = 1
}enum vdec_adc_vinsel_t { VDEC_ADC_VINSEL_VIN1 = 0,
VDEC_ADC_VINSEL_VIN2 ,
VDEC_ADC_VINSEL_NUM
}enum vdec_lpfvsync_t { VDEC_LPF_VSYNC_NONE = 0,
VDEC_LPF_VSYNC_0_94 ,
VDEC_LPF_VSYNC_0_67 ,
VDEC_LPF_VSYNC_0_54 ,
VDEC_LPF_VSYNC_0_47 ,
VDEC_LPF_VSYNC_0_34 ,
VDEC_LPF_VSYNC_0_27 ,
VDEC_LPF_VSYNC_0_23
enum vdec_lpfhsync_t { VDEC_LPF_HSYNC_NONE = 0,
VDEC_LPF_HSYNC_2_15 ,
VDEC_LPF_HSYNC_1_88 ,
VDEC_LPF_HSYNC_1_34 ,
VDEC_LPF_HSYNC_1_07 ,
VDEC_LPF_HSYNC_0_94 ,
VDEC_LPF_HSYNC_0_67 ,
VDEC_LPF_HSYNC_0_54
enum vdec_velocityshift_h_t { VDEC_VELOCITY_SHIFT_1 = 0,
VDEC_VELOCITY_SHIFT_2 ,
VDEC_VELOCITY_SHIFT_4 ,
VDEC_VELOCITY_SHIFT_8 ,
VDEC_VELOCITY_SHIFT_16 ,
VDEC_VELOCITY_SHIFT_32 ,
VDEC_VELOCITY_SHIFT_64 ,
VDEC_VELOCITY_SHIFT_128 ,
VDEC_VELOCITY_SHIFT_256
enum vdec_slicermode_t { VDEC_SLICE_MODE_MANULAL = 0,
VDEC_SLICE_MODE_AUTO_25 ,
VDEC_SLICE_MODE_AUTO_50 ,
VDEC_SLICE_MODE_AUTO_75
}enum vdec_ssclipsel_t { VDEC_CLIP_LV_512 = 0,
VDEC_CLIP_LV_546 ,
VDEC_CLIP_LV_580 ,
VDEC_CLIP_LV_614 ,
VDEC_CLIP_LV_648 ,
VDEC_CLIP_LV_682 ,
VDEC_CLIP_LV_716 ,
VDEC_CLIP_LV_750 ,
VDEC_CLIP_LV_785 ,
VDEC_CLIP_LV_819 ,
VDEC_CLIP_LV_853 ,
VDEC_CLIP_LV_887 ,
VDEC_CLIP_LV_921 ,
VDEC_CLIP_LV_955 ,
VDEC_CLIP_LV_989 ,
VDEC_CLIP_LV_1023
enum vdec_hafcmode_t { VDEC_HAFCMD_FIX_PHST = 0,
VDEC_HAFCMD_FIX_LGRD ,
VDEC_HAFCMD_AUTO_PHST ,
VDEC_HAFCMD_AUTO_LGRD
}enum vdec_phdet_div_t { VDEC_PHDET_DIV_1_1 = 0,
VDEC_PHDET_DIV_1_2 ,
VDEC_PHDET_DIV_1_4 ,
VDEC_PHDET_DIV_1_8 ,
VDEC_PHDET_DIV_1_16 ,
VDEC_PHDET_DIV_1_32
enum vdec_vcddefault_t { VDEC_VCD_FRQ_AUTO = 0,
VDEC_VCD_FRQ_50HZ ,
VDEC_VCD_FRQ_59_94HZ ,
VDEC_VCD_FRQ_60HZ
}enum vdec_peaklevel_t { VDEC_PEAKLV_LIM_OFF = 0,
VDEC_PEAKLV_1008 ,
VDEC_PEAKLV_992 ,
VDEC_PEAKLV_960
}enum vdec_peakratio_t { VDEC_PEAKRATIO_50 = 0,
VDEC_PEAKRATIO_25 ,
VDEC_PEAKRATIO_12_5 ,
VDEC_PEAKRATIO_0
}enum vdec_lstg_bpfsel_t { VDEC_LSTG_BPFSEL_BYPASS = 0,
VDEC_LSTG_BPFSEL_17TAP = 1
}enum vdec_fstg_bpfsel_t { VDEC_FSTG_BPFSEL_17TAP = 0,
VDEC_FSTG_BPFSEL_9TAP = 1
}enum vdec_hfil_tap_sel_t { VDEC_HFIL_TAP_SEL_17TAP = 0,
VDEC_HFIL_TAP_SEL_9TAP = 1
}enum vdec_filmix_ratio_t { VDEC_FILMIX_RATIO_0 = 0,
VDEC_FILMIX_RATIO_12_5 ,
VDEC_FILMIX_RATIO_25 ,
VDEC_FILMIX_RATIO_37_5 ,
VDEC_FILMIX_RATIO_50 ,
VDEC_FILMIX_RATIO_62_5 ,
VDEC_FILMIX_RATIO_75 ,
VDEC_FILMIX_RATIO_87_5 ,
VDEC_FILMIX_RATIO_100
enum vdec_2dfil_mdsel_t { VDEC_2DFIL_MDSEL_BYPASS = 0,
VDEC_2DFIL_MDSEL_CASCADE ,
VDEC_2DFIL_MDSEL_TAKEOFF
}enum vdec_2d_fil_sel_t { VDEC_2D_FIL_SEL_BYPASS = 0,
VDEC_2D_FIL_SEL_17TAP = 1
}enum vdec_color_sys_t { VDEC_COL_SYS_NTSC = 0,
VDEC_COL_SYS_PAL ,
VDEC_COL_SYS_SECAM ,
VDEC_COL_SYS_NON ,
VDEC_COL_SYS_NUM
enum vdec_demodmode_t { VDEC_DEMOD_MD_NO = 0,
VDEC_DEMOD_MD_PAL = 2
}enum vdec_lockrange_t { VDEC_LOCK_RANGE_400HZ = 0,
VDEC_LOCK_RANGE_800HZ ,
VDEC_LOCK_RANGE_1200HZ ,
VDEC_LOCK_RANGE_1600HZ
}enum vdec_accmode_t { VDEC_ACC_MD_AUTO = 0,
VDEC_ACC_MD_MANUAL = 1
}enum vdec_accmaxgain_t { VDEC_ACC_MAX_GAIN_6 = 0,
VDEC_ACC_MAX_GAIN_8 ,
VDEC_ACC_MAX_GAIN_12 ,
VDEC_ACC_MAX_GAIN_16
}enum vdec_chrm_subgain_t { VDEC_CHRM_SB_GAIN_1 = 0,
VDEC_CHRM_SB_GAIN_2 ,
VDEC_CHRM_SB_GAIN_4 ,
VDEC_CHRM_SB_GAIN_8
}enum vdec_dcpmode_t { VDEC_DCPMODE_MANUAL = 0,
VDEC_DCPMODE_AUTO = 1
}enum vdec_acfinput_t { VDEC_ACFINPUT_Y = 0,
VDEC_ACFINPUT_CB ,
VDEC_ACFINPUT_CR
}enum vdec_answer_t { VDEC_NO = 0,
VDEC_YES = 1
}enum vdec_lock_t { VDEC_UNLOCK = 0,
VDEC_LOCK = 1
}enum vdec_fhmode_t { VDEC_FHMD_NORMAL = 0,
VDEC_FHMD_MULTIPLIED = 1
}enum vdec_fvmode_t { VDEC_FVMD_50HZ = 0,
VDEC_FVMD_60HZ = 1
}enum vdec_fscmode_t { VDEC_FSCMD_3_58 = 0,
VDEC_FSCMD_4_43 = 1
}vdec_error_t R_VDEC_Initialize (const vdec_channel_t ch, const vdec_adc_vinsel_t vinsel, void(*const init_func)(uint32_t), const uint32_t user_num) VDEC driver initialization. vdec_error_t R_VDEC_Terminate (const vdec_channel_t ch, void(*const quit_func)(uint32_t), const uint32_t user_num) VDEC driver termination. vdec_error_t R_VDEC_ActivePeriod (const vdec_channel_t ch, const vdec_active_period_t *const param) Active image period setup. vdec_error_t R_VDEC_SyncSeparation (const vdec_channel_t ch, const vdec_sync_separation_t *const param) Sync separation processing. vdec_error_t R_VDEC_YcSeparation (const vdec_channel_t ch, const vdec_yc_separation_t *const param) Y/C separation processing. vdec_error_t R_VDEC_ChromaDecoding (const vdec_channel_t ch, const vdec_chroma_decoding_t *const param) Chroma decoding processing. vdec_error_t R_VDEC_DigitalClamp (const vdec_channel_t ch, const vdec_degital_clamp_t *const param) Digital clamp processing. vdec_error_t R_VDEC_Output (const vdec_channel_t ch, const vdec_output_t *const param) Output adjustment processing. vdec_error_t R_VDEC_Query (const vdec_channel_t ch, vdec_q_sync_sep_t *const q_sync_sep, vdec_q_agc_t *const q_agc, vdec_q_chroma_dec_t *const q_chroma_dec, vdec_q_digital_clamp_t *const q_digital_clamp) VDEC information acquisition processing.
Detailed Description
VDEC driver API definitions.
Version: 1.00 Rev: 199 Date: 2014-05-23 16:33:52 +0900# Definition in file r_vdec.h .
Enumeration Type Documentation
Two-dimensional cascade filter select
Enumerator:
Bypass
17 TAP
Definition at line 335 of file r_vdec.h .
Two-dimensional cascade/TAKE-OFF filter mode select
Enumerator:
Bypass
Cascade filter
TAKE-OFF filter
Definition at line 328 of file r_vdec.h .
Maximum ACC gain
Enumerator:
6 times
8 times
12 times
16 times
Definition at line 444 of file r_vdec.h .
ACC operating mode
Enumerator:
Auto gain
Manual gain
Definition at line 439 of file r_vdec.h .
Video signal for autocorrelation function
Enumerator:
Y signal
Cb signal
Cr signal
Definition at line 505 of file r_vdec.h .
Input pin control
Enumerator:
VIN1 input
VIN2 input
The number of input pins
Definition at line 79 of file r_vdec.h .
Answer
Enumerator:
Definition at line 539 of file r_vdec.h .
VDEC channel
Enumerator:
Channel 0
Channel 1
The number of channels
Definition at line 65 of file r_vdec.h .
Chroma manual gain (sub)
Enumerator:
1 time
2 times
4 times
8 times
Definition at line 452 of file r_vdec.h .
Color system
Enumerator:
NTSC
PAL
SECAM
Not specified/undetectable
The number of color system settings
Definition at line 396 of file r_vdec.h .
Clamp level setting mode
Enumerator:
Manual clamp level setting
Auto clamp level setting
Definition at line 487 of file r_vdec.h .
Averaging processing for pre-demodulated line
Enumerator:
No processing
For PAL
Definition at line 404 of file r_vdec.h .
Error codes of the VDEC driver
Enumerator:
Normal termination
Invalid channel error
Parameter error
The number of the error codes
Definition at line 57 of file r_vdec.h .
Speed detection result
Enumerator:
Normal speed
Multiplied speed
Definition at line 549 of file r_vdec.h .
Mixing ratio of signals after passing filters
Enumerator:
0%
12.5%
25%
37.5%
50%
62.5%
75%
87.5%
100%
Definition at line 315 of file r_vdec.h .
Color sub-carrier frequency detection result
Enumerator:
3.58 MHz
4.43 MHz
Definition at line 559 of file r_vdec.h .
Former-stage BPF select
Enumerator:
17 TAP
9 TAP
Definition at line 305 of file r_vdec.h .
Vertical countdown oscillation mode
Enumerator:
50 Hz
60 Hz
Definition at line 554 of file r_vdec.h .
Horizontal AFC VBI period operating mode
Enumerator:
Loop gain is fixed and phase comparison is stopped during VBI period
Loop gain is fixed and loop gain is reduced during VBI period
Loop gain is automatically controlled and phase comparison is stopped during VBI period
Loop gain is automatically controlled and loop gain is reduced during VBI period
Definition at line 191 of file r_vdec.h .
Horizontal filter and horizontal/vertical filter bandwidth switch signal
Enumerator:
17 TAP
9 TAP
Definition at line 310 of file r_vdec.h .
Lock state
Enumerator:
Unlocked
Locked
Definition at line 544 of file r_vdec.h .
Burst lock PLL lock range
Enumerator:
+-400 Hz
+-800 Hz
+-1200 Hz
+-1600 Hz
Definition at line 422 of file r_vdec.h .
LPF cutoff frequency before horizontal sync separation
Enumerator:
None
2.15 MHz
1.88 MHz
1.34 MHz
1.07 MHz
0.94 MHz
0.67 MHz
0.54 MHz
Definition at line 108 of file r_vdec.h .
LPF cutoff frequency before vertical sync separation
Enumerator:
None
0.94 MHz
0.67 MHz
0.54 MHz
0.47 MHz
0.34 MHz
0.27 MHz
0.23 MHz
Definition at line 96 of file r_vdec.h .
Latter-stage BPF select
Enumerator:
Bypass
17 TAP
Definition at line 300 of file r_vdec.h .
On/Off
Enumerator:
Definition at line 72 of file r_vdec.h .
Peak luminance value to operate peak limiter
Enumerator:
Limiter OFF
1008 LSB
992 LSB
960 LSB
Definition at line 253 of file r_vdec.h .
Maximum compression rate of peak limiter
Enumerator:
Compressed up to 50%
Compressed up to 25%
Compressed up to 12.5%
Compressed up to 0%
Definition at line 261 of file r_vdec.h .
Phase comparator feedback adjust for low sync signal lock stability
Enumerator:
1/1
1/2
1/4
1/8
1/16
1/32
Definition at line 202 of file r_vdec.h .
Auto-slice level setting for composite sync separation circuit
Enumerator:
Manual setting
25% of sync depth (Auto)
50% of sync depth (Auto)
75% of sync depth (Auto)
Definition at line 138 of file r_vdec.h .
Clipping level
Enumerator:
512
546
580
614
648
682
716
750
785
819
853
887
921
955
989
1023
Definition at line 146 of file r_vdec.h .
Vertical countdown center oscillation frequency
Enumerator:
Auto-detection
50.00 Hz
59.94 Hz
60.00 Hz
Definition at line 227 of file r_vdec.h .
Reference level operation speed control for composite sync separation (for Hsync signal)
Enumerator:
x1
x2
x4
x8
x16
x32
x64
x128
x256
Definition at line 125 of file r_vdec.h .
Function Documentation
Active image period setup.
Description:
Parameters:
[in] ch : Channel [in] param : Active image period parameter
Return values:
Definition at line 133 of file r_vdec.c .
Chroma decoding processing.
Description:
Configures the color system detection.
Configures the BCO.
Configures the ACC/color killer.
Configures the TINT correction/R-Y axis correction. Parameters:
[in] ch : Channel [in] param : Chroma decoding parameter
Return values:
Definition at line 230 of file r_vdec.c .
Digital clamp processing.
Description:
Configures the digital clamp control.
Configures the center clamp.
Configures the pedestal clamp.
Configures the noise detection control. Parameters:
[in] ch : Channel [in] param : Digital clamp parameter
Return values:
Definition at line 262 of file r_vdec.c .
VDEC driver initialization.
Description:
Calls the user-defined function specified in init_func.
Sets up the input pins. Parameters:
[in] ch : Channel [in] vinsel : Input pin control
VDEC_ADC_VINSEL_VIN1
VDEC_ADC_VINSEL_VIN2
[in] init_func : Pointer to a user-defined function [in] user_num : User defined number
Return values:
Definition at line 67 of file r_vdec.c .
Output adjustment processing.
Description:
Parameters:
[in] ch : Channel [in] param : Output adjustment parameter
Return values:
Definition at line 290 of file r_vdec.c .
VDEC information acquisition processing.
Description:
Sync separation parameters
AGC parameters
Chroma decoding parameters
Digital clamp parameters Parameters:
[in] ch : Channel [out] q_sync_sep : Pointer to the place where the sync separation parameters are stored. [out] q_agc : Pointer to the place where the AGC parameters are stored. [out] q_chroma_dec : Pointer to the place where the chroma decoding parameters are stored. [out] q_digital_clamp : Pointer to the place where the digital clamp parameters are stored.
Return values:
Definition at line 325 of file r_vdec.c .
Sync separation processing.
Description:
Configures the noise reduction LPF.
Configures the auto level control sync slicer.
Configures the horizontal AFC.
Configures the vertical count-down.
Configures the AGC.
Configures the peak limiter control. Parameters:
[in] ch : Channel [in] param : Sync separation parameter
Return values:
Definition at line 167 of file r_vdec.c .
VDEC driver termination.
Description:
Calls the user-defined function specified in quit_func. Parameters:
[in] ch : Channel [in] quit_func : Pointer to a user-defined function [in] user_num : User defined number
Return values:
Definition at line 105 of file r_vdec.c .
Y/C separation processing.
Description:
Configures the over-range control.
Configures the Y/C separation control.
Configures the chroma filter TAP coefficients for Y/C separation. Parameters:
[in] ch : Channel [in] param : Y/C separation parameter
Return values:
Definition at line 198 of file r_vdec.c .
1.7.2