Visible to Intel only — GUID: jcj1655825689853
Ixiasoft
Visible to Intel only — GUID: jcj1655825689853
Ixiasoft
16.5. Deinterlacer IP Software API
Register definition header file: intel_vvp_dil_regs.h
Include file: intel_vvp_dil.h
Name | Description |
---|---|
intel_vvp_dil_init | Initialize the Deinterlacer instance |
Intel_vvp_core_* | Accessors defined in Video and Vision Processing IPs Software Programming Model |
intel_vvp_dil_get_lite_mode | Returns lite mode is on |
intel_vvp_dil_get_debug_enabled | Returns debug features is on. |
Intel_vvp_dil_get_max_width | Returns the maximum supported width |
intel_vvp_dil_get_dil_algorithm | Returns the deinterlacing algorithm |
intel_vvp_dil_get_field_sync | Returns the field synchronization method |
intel_vvp_dil_is_running | Returns if the IP is processing data |
intel_vvp_dil_get_status | Reads the status register |
enum eIntelVvpDilAlgorithms
- Members
-
kIntelVvpDilBobAlgo (0) – Bob deinterlacing
kIntelVvpDilAlgoErr (-1) – Invalid deinterlacing algorithm
- Description
- Enumeration for the deinterlacing algorithm supported by the IP
enum eIntelVvpDilFieldSyncs
- Members
-
kIntelVvpDilDeinterlaceSyncF0 – Synchronization on F0 (input frame rate = output frame rate)
kIntelVvpDilDeinterlaceSyncF0 – Synchronization on F1 (input frame rate = output frame rate)
kIntelVvpDilDeinterlaceSyncBoth – Synchronization on F0 and F1 (input field rate = output frame rate)
- Description
- Enumeration for the three supported field-to-frame rate conversions
intel_vvp_dil_init
- Prototype
-
int intel_vvp_dil_init(intel_vvp_dil_instance *instance, intel_vvp_core_base base);
- Description
- Initializes a deinterlacer instance. The initialization stops early if the vendor ID or product ID read at the base address are not a match or if the register map version is not supported. Otherwise, the function proceeds to read and store the IP compile-time parameterization. The instance is not fully initialized and the application should not use it further if returning a non-zero error code.
- Arguments
-
instance – pointer to the intel_vvp_dil_instance software driver instance structure
base – base address of the register map
- Returns
-
kIntelVvpCoreOk (0) in case of success, a negative error code in case of error
kIntelVvpCoreVidErr if the vendor id of the core is not the IntelFPGA vendor ID (0x6AF7).
kIntelVvpCorePidErr if the product_id does not match with the Deinterlacer product ID
kIntelVvpCoreInstanceErr if the instance is a null pointer
kIntelVvpDilRegMapVersionErr if the register map is not supported
intel_vvp_dil_get_lite_mode
- Prototype
-
bool intel_vvp_dil_get_lite_mode(intel_vvp_dil_instance *instance);
- Description
- Returns the value of the LITE_MODE register. The instance must be a valid intel_vvp_dil_instance fully initialized
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- true if the IP is parameterized in lite mode
intel_vvp_dil_get_debug_enabled
- Prototype
-
bool intel_vvp_dil_get_debug_enabled(intel_vvp_dil_instance *instance);
- Description
- Returns the value of the DEBUG_ENABLED register. The instance must be a valid intel_vvp_dil_instance fully initialized.
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- true if the IP is parameterized with debug features enabled
intel_vvp_dil_get_max_width
- Prototype
-
uint32_t intel_vvp_dil_get_max_widh(intel_vvp_dil_instance *instance);
- Description
- Returns the value of the MAX_WIDTH register. The instance must be a valid intel_vvp_dil_instance fully initialized.
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- Maximum supported width
intel_vvp_dil_get_dil_algorithm
- Prototype
-
eIntelVvpDilAlgorithms_t intel_vvp_dil_get_dil_algorithm(intel_vvp_dil_instance *instance);
- Description
- Returns the value of the deinterlacing algorithm register. The instance must be a valid intel_vvp_dil_instance fully initialized.
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- Deinterlacing algorithm selected at compile-time
intel_vvp_dil_get_field_sync
- Prototype
-
eIntelVvpDilFieldSyncs intel_vvp_dil_get_field_sync(intel_vvp_dil_instance *instance);
- Description
- Returns the value of the field synchronization register. The instance must be a valid intel_vvp_dil_instance fully initialized.
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- Field synchronization algorithm selected at compile-time
intel_vvp_dil_is_running
- Prototype
-
bool intel_vvp_ dil _is_running(intel_vvp_dil_instance* instance);
- Description
- Reads and returns the running bit of the STATUS register. The instance must be a valid intel_vvp_dil_instance fully initialized.
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- True is the IP is currently generating an output field, false when between two fields
intel_vvp_dil_get_status
- Prototype
-
uint8_t intel_vvp_dil_get_status(intel_vvp_tpg_instance* instance);
- Description
- Reads and returns the STATUS register. The instance must be a valid intel_vvp_dil_instance fully initialized.
- Arguments
- instance – pointer to the intel_vvp_dil_instance software driver instance structure
- Returns
- The value read from the status register