References ▼
Lists the possible values for the format types.
typedef enum{LM_FORMATTYPE_VIDEOINFO,LM_FORMATTYPE_VIDEOINFO2,} LM_FORMATTYPE;
VIDEOINFO format type. The filter will accept media types of this format only.
VIDEOINFO2 format type. The filter will accept media types of this format only.
Describes the bit usage option.
typedef enum{USEUPPERBITS = 1,USELOWERBITS,USEFULLRANGE,NOCHANGE,} USEDBITS;
Describes the RGB supported formats.
typedef enum{LM_MEDIATYPE_AUTO = 0x0000, /* Any */LM_MEDIATYPE_RGB1 = 0x0001,LM_MEDIATYPE_RGB4 = 0x0004,LM_MEDIATYPE_RGB8 = 0x0008,LM_MEDIATYPE_RGB555 = 0x000f,LM_MEDIATYPE_RGB565 = 0x0010,LM_MEDIATYPE_RGB24 = 0x0018,LM_MEDIATYPE_RGB32 = 0x0020,LM_MEDIATYPE_ARGB32 = 0x0021,LM_MEDIATYPE_LGRY12 = 0x000c,LM_MEDIATYPE_LGRY16 = 0x0011,LM_MEDIATYPE_YUY2 = 0x0033} LM_MEDIATYPES;
Sets the current media input type.
One of the LM_MEDIATYPES values.
Determines whether the input is palletized or not, this is valid only if nType is LM_MEDIATYPE_RGB8.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the current media input type.
A valid pointer to an integer variable that will receive the input type ( one of the LM_MEDIATYPES constants).
A valid pointer to a Boolean variable that will receive the input palette status. This is valid only if the input type is LM_MEDIATYPE_RGB8, otherwise, pbPalette will be always set to FALSE.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the current media output type.
One of the LM_MEDIATYPES values.
Determines whether the output is palletized or not, this is valid only if nType is LM_MEDIATYPE_RGB8.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the current media output type.
A valid pointer to an integer variable that will receive the output type ( one of the LM_MEDIATYPES constants).
A valid pointer to a Boolean variable that will receive the output palette status. This is valid only if the output type is LM_MEDIATYPE_RGB8, otherwise, pbPalette will be always set to FALSE.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the RGB channels order, either RGB (TRUE) or BGR (FALSE).
TRUE to switch to RGB mode, FALSE to switch to BGR mode.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the RGB channel order, either RGB (TRUE) or BGR (FALSE).
A valid pointer to a Boolean variable that will receive the current RGB order, it will be set to TRUE if the order is RGB or FALSE if the order is BGR.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Determines the range of bits to be used, or which bits will hold the useful data.
An integer variable that contains the bit usage option. For possible values, refer to USEDBITS.
Used with LGRY media type only, either 16, or 12 bits.
Example: if the input is LGRY 16 with low bit = 3, and high bit = 10, and the output is 12 bit LGRY, then the filter can give the following options:
Use Lower bits, the output useful range will be: 0 to 7.
Use upper bits, the output useful range will be: 4 to 11.
Use full range, the output useful range will be: 0 to 11.
No change, leave output same as input if possible, in this case 3 to 10.
If none of the above options is applicable, the full range will be used.
For information about the support LEAD has added for 12- and 16-bit Grayscale, refer to 12- and 16-bit Grayscale Format used by LEADTOOLS toolkits.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Retrieves the currently used bits.
A valid pointer to an integer variable to be updated with the currently used bits. Upon a successful return, it will contain one of the following values of USEDBITS.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the graph auto stopping state.
A Boolean value that indicates the state of graph auto stopping. TRUE to automatically stop the graph when needed. Stopping the graph is needed when the filter reconnects one of its pins; this operation is needed when the user changes the pins media type. If set to FALSE, the filter will refuse the change.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the graph auto stopping state.
A valid pointer to a Boolean variable that will receive the current graph auto stopping state. TRUE indicates the graph will be stopped automatically if needed.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the current input video format the filter accepts.
A valid pointer to a variable that will receive the current input video format.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the input video format the filter accepts.
The new input video format to accept.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the current output video format the filter accepts.
A valid pointer to a variable that will receive the current output video format.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Sets the output video format the filter accepts.
The new output video format to offer.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Determines whether the filter input pin is currently connected.
| Return | Description |
|---|---|
| S_OK | Connected. |
| S_FALSE | Otherwise. |
Determines whether the filter output pin is currently connected.
| Return | Description |
|---|---|
| S_OK | Connected. |
| S_FALSE | Otherwise. |
Retrieves the current media dimensions.
A valid pointer to a long variable to be updated with the input media width. NULL can be passed if this value is not needed.
A valid pointer to a long variable to be updated with the input media height. NULL can be passed if this value is not needed.
A valid pointer to a long variable to be updated with the output media width. NULL can be passed if this value is not needed.
A valid pointer to a long variable to be updated with the output media height. NULL can be passed if this value is not needed.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the current media types of the filters input and output pins.
A valid pointer to a GUID structure to be updated with the input media type GUID. NULL can be passed if this value is not needed.
A valid pointer to a GUID structure to be updated with the output media type GUID. NULL can be passed if this value is not needed.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |
Gets the bits per pixel of the current connected input and output media formats.
A valid pointer to an integer to be updated with the input media bits per pixel value. NULL can be passed if this value is not needed.
A valid pointer to an integer to be updated with the output media bits per pixel value. NULL can be passed if this value is not needed.
| Return | Description |
|---|---|
| S_OK | Successful. |
| S_FALSE | Otherwise. |