References ▼
This is the interface for the LEAD Video Deinterlace Filter.
Lists the valid values for the ApiLevel parameter that can be passed to the ResetToDefaultsEx method.
typedef enum{LMVDeinterlace_APILEVEL_1,LMVDeinterlace_APILEVEL_2,} _LMVDeinterlace_APILEVEL;
[0] Use the defaults from the previous version of the filter.
[1] Use the defaults from the current version of the filter.
The SEGMENT_OPERATION_MODE constants describe how segment frames will be processed.
typedef enum SEGMENT_OPERATION_MODE{MODE_NO_DEINTERLACE = 0,MODE_DEINTERLACE_ALL,MODE_DEINTERLACE_PATTERN,} SEGMENT_OPERATION_MODE;
Do not deinterlace any frame in the segment.
Deinterlace all frames in the segment.
Deinterlacing pattern is used. A frame will be deinterlaced if it lies in a deinterlace section in the pattern.
The SEGMENT_TIME_FORMAT constants describe the time format used for all segments.
typedef enum sSEGMENT_TIME_FORMAT{SEGMENT_TIME_FORMAT_FRAME = 0,SEGMENT_TIME_FORMAT_TIME,} SEGMENT_TIME_FORMAT;
Segment time format is frames. Frame numbering is zero-based and begins at the start of the stream.
Segment time format is time, defined as hours, minutes, seconds, and milliseconds. The time of the first frame is zero (all fields).
| Type | Name | Description |
|---|---|---|
| VARIANT_BOOL | Enabled | Indicates whether deinterlacing is enabled (TRUE) or not (FALSE). |
| VARIANT_BOOL | Even | Indicates whether to start with even lines (TRUE) or odd lines (FALSE). |
| VARIANT_BOOL | MergeFields | Indicates whether to use merge even and odd fields into a single frame. |
| VARIANT_BOOL | DoubleFrameRate | Indicates whether to double the output frame rate (TRUE) or not (FALSE). Currently, setting this property to TRUE overrides the pattern and segments settings, effectively ignoring all pattern and segment settings. |
| VARIANT_BOOL | StartWithEvenFrame | Indicates whether to start with an even frame (TRUE) or an odd frame (FALSE) when the DoubleFrameRate property is set to TRUE. |
| VARIANT_BOOL | IsLEADInputPinConnected | Read only; returns TRUE if the filters input pin is connected. |
| VARIANT_BOOL | IsLEADOutputPinConnected | Read only; returns TRUE if the filters output pin is connected. |
| long | InWidth | Read only; the input stream width. |
| long | InHeight | Read only; the input stream height. |
| long | OutWidth | Read only; the output stream width. |
| long | OutHeight | Read only; the output stream height. |
| long | InBits | Read only; the input stream bits per pixel. |
| long | OutBits | Read only; the output stream bits per pixel. |
| VARIANT_BOOL | EnableROI | Enables or disables the Region Of Interest. When an ROI is defined, the filter acts only on it, ignoring all pixels outside the region. Currently, the region is a rectangle defined by the ROILeft, ROITop, ROIRight and ROIBottom properties. |
| long | ROILeft | The left boundary of the ROI rectangle. |
| long | ROITop | The top boundary of the ROI rectangle. |
| long | ROIRight | The right boundary of the ROI rectangle. |
| long | ROIBottom | The bottom boundary of the ROI rectangle. |
| VARIANT_BOOL | EnableGlobalPattern | Enables or disables the global deinterlacing pattern. The global pattern affects all the frames in the stream. With patterns, either global or segment specific, you can define what frames will be deinterlaced or ignored. The pattern is defined using 3 parameters: |
| 1. The preamble frames: a group of frames at the beginning of the stream or segment. You can choose whether the preamble frames will be deinterlaced. | ||
| 2.No-Deinterlace frames: a group of frames, following the preamble frames, that will be ignored. No deinterlacing is applied. | ||
| 3.Deinterlace frames: a group of frames, following the No-Deinterlace frames, that will be deinterlaced. | ||
| SEGMENT_TIME_FORMAT | SegmentsTimeFormat | Value that specifies the time format used to define segments. |
| long | SegmentsCount | (Read only) This property is updated with the number of available segments. |
| VARIANT_BOOL | EnableProtectedArea | Enables or disables the protected area. The protected area, a rectangle, is defined by its 4 boundaries, and is an area that will be excluded from deinterlacing. The protected area is independent of the ROI and the 2 regions can have any settings in the allowed range. |
| VARIANT_BOOL | AutoDeinterlace | Enable/Disable the auto deinterlace option. This will automatically deinterlace frames that need deinterlacing. |
| double | AutoDeinterlaceSensitivity | Specifies when deinterlacing is necessary. Values range between 0.001 and 8.000. The default is 1.000. Values lower than 1.000 increase the chance a frame will be considered interlaced. With low values, deinterlacing may be performed even when the interlaced effect is on a small portion of the image. |
Resets the filter to default values.
Specifies which defaults should be used by the filter. Current applications should set ApiLevel to LMVDeinterlace_APILEVEL_2 = 1.
The filter might change in the future and have different properties or default behavior. Calling this method ensures future versions of the filter will behave the same way as when the application was developed.
It is best to call ResetToDefaultsEx(LMVDeinterlace_APILEVEL_2) before you start setting properties and start calling other methods for this interface.
| Return | Description |
|---|---|
| S_OK | Successful. |
| < 0 | An error occurred. |
| E_INVALIDARG | The ApiLevel parameter is invalid. |
Reset all the Deinterlace options to the default values.
Sets the global pattern parameters.
The number of preamble frames of the global pattern.
The number of No-Deinterlace frames of the global pattern.
The number of Deinterlace frames of the global pattern.
A Boolean value that indicates whether to deinterlace the preamble frames (TRUE) or not (FALSE).
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the global pattern parameters.
Pointer to a variable that will receive the number of preamble frames of the global pattern.
Pointer to a variable that will receive the number of No-Deinterlace frames of the global pattern.
Pointer to a variable that will receive the number of Deinterlace frames of the global pattern.
Pointer to a variable that will receive the state of preamble frames deinterlacing. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Indicates that the preamble frames will be deinterlaced. |
| FALSE | Indicates that the preamble frames will not be deinterlaced (passed untouched). |
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Adds a new segment before the segment at the specified index.
Index of the segment before which the new segment will be added. Valid indexes range from zero to SegmentsCount - 1. If an invalid index is passed, the segment will be added to the end of the list.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Removes the segment at the specified index.
Index of the segment to remove.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Attaches a 4-bytes user data to the segment whose index is passed.
The zero based index of the segment for which to set the data.
A 4-byte chunk of user data. The saved user data can be retrieved using the GetSegmentData method.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the user data attached to the segment whose index is passed.
The zero based index of the segment.
Pointer to a variable that will receive the user data saved using SetSegmentData, or zero if no data was attached to the segment.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the start time of the segment whose index is passed. If the segments time format is not SEGMENT_TIME_FORMAT_TIME, then the provided values are undefined.
The zero based index of the segment.
Pointer to a variable that will receive the hours portion of the segment start time.
Pointer to a variable that will receive the minutes portion of the segment start time.
Pointer to a variable that will receive the seconds portion of the segment start time.
Pointer to a variable that will receive the milliseconds portion of the segment start time.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the start time for the segment at the specified index. If the SegmentsTimeFormat property is not SEGMENT_TIME_FORMAT_TIME, then changing the start time will not have any effect.
The zero based index of the segment for which to set the start time.
The hours portion of the segment start time.
The minutes portion of the segment start time. Valid values range from 0 to 59.
The seconds portion of the segment start time. Valid values range from 0 to 59.
The milliseconds portion of the segment start time. Valid values range from 0 to 999.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the position of the first frame in the segment. If the SegmentsTimeFormat property is not SEGMENT_TIME_FORMAT_FRAME, then the provided value is undefined.
The zero based index of the segment.
Pointer to a variable that will receive the position of the first frame in the segment. Zero based frame counting from the start of the stream, is used.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the position of the first frame in the segment. If the SegmentsTimeFormat property is not SEGMENT_TIME_FORMAT_FRAME, then changing the start frame will not have any effect.
The zero based index of the segment.
The position of the first frame in the segment. Frame numbering is zero-based and starts at the beginning of the stream.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the operation mode of the segment whose index is passed.
The zero based index of the segment.
Pointer to a value that will receive the currently used segment operation mode.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the operation mode of the segment at the specified index.
The zero based index of the segment.
The operation mode to set.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the segment pattern parameters.
The zero based index of the segment.
Pointer to a variable that will receive the number of preamble frames of the segment's pattern.
Pointer to a variable that will receive the number of No-Deinterlace frames of the segment's pattern.
Pointer to a variable that will receive the number of Deinterlace frames of the segment's pattern.
Pointer to a variable that will receive the state of preamble frames deinterlacing. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Indicates that the preamble frames will be deinterlaced. |
| FALSE | Indicates that the preamble frames will not be deinterlaced (passed untouched). |
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the segment pattern parameters.
The number of preamble frames in the segment pattern.
The number of No-Deinterlace frames in the segment pattern.
The number of Deinterlace frames in the segment pattern.
A Boolean value that indicates whether to deinterlace the preamble frames (TRUE) or not (FALSE).
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the protected area boundaries.
Pointer to a variable to be updated with the left boundary of the protected area. The possible range for the left boundary is from zero to the right boundary minus one.
Pointer to a variable to be updated with the right boundary of the protected area. The possible range for the right boundary is from the left boundary plus one to the current video width.
Pointer to a variable that will receive the top boundary of the protected area. The possible range for the top boundary is from zero to the bottom boundary minus one.
Pointer to a variable that will receive the bottom boundary of the protected area. The possible range for the bottom boundary is from the top boundary plus one to the current video height.
| Return | Description |
|---|---|
| S_OK | Successful. |
| An error code | Otherwise. |
Sets the protected area boundaries. If the protected area is not enabled when this method is called, the new boundaries will be set and will take effect the next time the protected area is enabled.
Value that represents the left boundary of the protected area. The possible range for the left boundary is from zero to the right boundary minus one. Use -1 to keep the current left boundary value.
Value that represents the right boundary of the protected area. The possible range for the right boundary is from the left boundary plus one to the current video width. Use -1 to keep the current right boundary value.
Value that represents the top boundary of the protected area. The possible range for the top boundary is from zero to the bottom boundary minus one. Use -1 to keep the current top boundary value.
Value that represents the bottom boundary of the protected area. The possible range for the bottom boundary is from the top boundary plus one to the current video height. Use -1 to keep the current bottom boundary value.
| Return | Description |
|---|---|
| S_OK | Successful. |
| An error code | Otherwise. |