Compaq Multimedia Services
for OpenVMS Alpha
Programmer's Guide
Previous Contents Index

ICGetSharpening

 Name ICGetSharpening --- Obtain current sharpening value Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICGetSharpening(HIC hic)
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

Description

The ICGetSharpening function obtains the current contrast value.
Extensions The ICGetSharpening function is a Compaq extension to the Microsoft multimedia API specification.

Return Values

1
Returns the current sharpening value if the function is successful; otherwise, it returns the following error code:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
See Also ICSetSharpening

ICGetState

 Name ICGetState --- Obtain current state of a compressor or decompressor Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICGetState(HIC hic, 
                    LPVOID pv, 
                    DWORD cb);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

LPVOID pv
Specifies a pointer to a buffer used to return the state data. The data structure must be allocated with the mmeAllocMem function before being passed to the ICGetState function.

DWORD cb
Specifies the size (in bytes) of the state data buffer.

Description

The ICGetState function obtains the current state of a compressor or decompressor. Use the ICGetStateSize function before calling the ICGetState function to determine the size of the buffer to allocate for the call.
Extensions None.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns the following error code:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
See Also ICGetStateSize , ICSetState

ICGetStateSize

 Name ICGetStateSize --- Obtain size of state data used by a compressor or decompressor Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICGetStateSize(HIC hic)
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

Description

The ICGetStateSize function obtains the size of the state data used by a compressor or decompressor. Use the ICGetStateSize function to get the size of the state data for the ICGetState and ICSetState buffers.
Extensions None.

Return Values

1
Returns the number of bytes used by the state data if the function is successful; otherwise, it returns the following error code:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
See Also ICGetState , ICSetState

ICInfo

 Name ICInfo --- Return information about compressors and decompressors Syntax 


#include <mme/mme_api.h> 
 
BOOL ICInfo(DWORD fccType, 
            DWORD fccHandler, 
            ICINFO *lpicinfo);
Arguments DWORD fccType
Specifies a four-character code indicating the type of compressor or decompressor. For video, the value should be ICTYPE_VIDEO or the FOURCC vidc. For audio, the value should be ICTYPE_AUDIO or the FOURCC audc.

DWORD fccHandler
Identifies a specific compressor or decompressor about which to get information. If this value is zero, then information about the first compressor or decompressor found of the type specified in the fccType argument is returned.

If this value is a number between 1 and the number of installed compressors of the type specified in the fccType argument, then information about the compressor or decompressor with that number is returned.

If this value is a FOURCC, then information about the compressor or decompressor denoted by that FOURCC is returned. The smallest possible FOURCC is four spaces " ", which converts to 128. Therefore, the greatest number of installed compressors is 127, from 1 to 127. The following shows available options and their values:
Option FOURCC Value
FullVideo Supreme JPEG " J321 "
FullVideo Supreme " J301 "
Software JPEG CODEC " SJPG "

ICINFO *lpicinfo
Specifies a pointer to an ICINFO data structure used to return information about the compressor. The ICINFO data structure must be allocated with the mmeAllocMem function before being passed to ICInfo function.

Description

The ICInfo function returns information about specific installed compressors and decompressors, or it enumerates the compressors installed.
Extensions None.

Return Values

1
Returns TRUE if the function is successful; otherwise, it returns FALSE.

See Also None.

ICLocate

 Name ICLocate --- Find a compressor or decompressor that can handle images with the formats specified, or find a decompressor that can decompress an image with the specified format directly to hardware Syntax 


#include <mme/mme_api.h> 
 
HIC ICLocate(DWORD fccType, 
             DWORD fccHandler, 
             LPBITMAPINFOHEADER lpbiIn, 
             LPBITMAPINFOHEADER lpbiOut, 
             WORD wFlags);
Arguments DWORD fccType
Specifies the type of compressor or decompressor the application wants to find. For video, the value should be ICTYPE_VIDEO or the FOURCC vidc. For audio, the value should be ICTYPE_AUDIO or the FOURCC audc.

DWORD fccHandler
Specifies a single preferred handler of the given type that should be tried first. Typically, this handler comes from the stream header in an AVI file or from the ICINFO structure.

If this value is:

LPBITMAPINFOHEADER lpbiIn
Specifies a pointer to a BITMAPINFOHEADER data structure defining the input format. A compressor handle will not be returned unless it can handle this format.

The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICLocate function. See Chapter 2 for more information about the memory allocation functions.

LPBITMAPINFOHEADER lpbiOut
Specifies NULL or a pointer to a BITMAPINFOHEADER data structure defining an optional output format. If lpbiOut is not NULL, a compressor handle will not be returned unless it can create this output option.

The BITMAPINFOHEADER data structure must be allocated with the mmeAllocMem function before being passed to the ICLocate function. See Chapter 2 for more information about the memory allocation functions.

WORD wFlags
Specifies flags defining the use of the compressor or decompressor.

The following flags are defined:

ICMODE_COMPRESS
Indicates the compressor should be able to compress an image with a format defined by lpbiIn to the format defined by lpbiOut.

ICMODE_DECOMPRESS
Indicates the decompressor should be able to decompress an image with a format defined by lpbiIn to the format defined by lpbiOut.

ICMODE_DRAW
Indicates the decompressor should be able to decompress an image with a format defined by lpbiIn and draw it directly to hardware. The video option modules do not support IC_DRAW functionality.

Description

The ICLocate function finds a compressor or decompressor that can handle images with the formats specified, or it finds a decompressor that can decompress an image with the specified format directly to hardware. If an appropriate compressor or decompressor is found, it is opened and a handle is returned to the application.
Extensions None.

Return Values

1
Returns a handle to an open compressor or decompressor if the function is successful; otherwise, it returns zero.

See Also ICClose , ICOpen

ICOpen

 Name ICOpen --- Open a compressor or decompressor Syntax 


#include <mme/mme_api.h> 
 
HIC ICOpen(DWORD fccType, 
           DWORD fccHandler, 
           UINT wMode);
Arguments DWORD fccType
Specifies the type of compressor or decompressor the application wants to open. For video, this type is ICTYPE_VIDEO.

DWORD fccHandler
Specifies a handler of a given type. Typically, this handler comes from the stream header in an AVI file or from the ICINFO structure.

UINT wMode
Specifies flags defining the use of the compressor or decompressor. The following flags are defined:

ICMODE_COMPRESS
Advises a compressor that it is opened for compression.

ICMODE_DECOMPRESS
Advises a decompressor that it is opened for decompression.

ICMODE_DRAW
Advises a decompressor that it is opened to decompress an image and draw it directly to hardware. The video option modules do not support IC_DRAW functionality.

ICMODE_QUERY
Advises a compressor or decompressor that it is opened to obtain information only.

Description

The ICOpen function opens a compressor or decompressor.
Extensions None.

Return Values

1
Returns a handle to a compressor or decompressor if the function is successful; otherwise, it returns zero.

See Also ICClose , ICLocate

ICSetBrightness

 Name ICSetBrightness --- Set current brightness value Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICSetBrightness(HIC hic, 
                         DWORD dwBrightness);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

DWORD dwBrightness
Specifies the brightness value. This value ranges from 0 to 10,000.

Description

The ICSetBrightness function sets the current brightness value. This function is only valid when decompressing an image into 8-bit X image format.
Extensions The ICSetBrightness function is a Compaq extension to the Microsoft multimedia API specification.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
ICERR_BADPARAM The value of the dwBrightness argument is out of range.
ICERR_CANTUPDATE The attribute cannot be modified.
ICERR_UNSUPPORTED The function is not supported.
See Also ICGetBrightness

ICSetContrast

 Name ICSetContrast --- Set current contrast value Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICSetContrast(HIC hic, 
                       DWORD dwContrast);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

DWORD dwContrast
Specifies the contrast value. This value ranges from 0 to 10,000.

Description

The ICSetContrast function sets the current contrast value. This function is only valid when decompressing an image into 8-bit X image format.
Extensions The ICSetContrast function is a Compaq extension to the Microsoft multimedia API specification.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
ICERR_BADPARAM The value of the dwContrast argument is out of range.
ICERR_CANTUPDATE The attribute cannot be modified.
ICERR_UNSUPPORTED The function is not supported.
See Also ICGetContrast

ICSetMirror

 Name ICSetMirror --- Set current mirroring value Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICSetMirror(HIC hic, 
                     BOOL mirror);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

BOOL mirror
Specifies the mirroring value. This value can be either TRUE or FALSE.

Description

The ICSetMirror function sets the current mirroring value. This function is only valid when decompressing an image into 8-bit X image format.
Extensions The ICSetMirror function is a Compaq extension to the Microsoft multimedia API specification.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
ICERR_BADPARAM The value of the mirror argument is invalid.
ICERR_CANTUPDATE The attribute cannot be modified.
ICERR_UNSUPPORTED The function is not supported.
See Also ICGetMirror

ICSetSaturation

 Name ICSetSaturation --- Set current saturation value Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICSetSaturation(HIC hic, 
                         DWORD dwSaturation);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

DWORD dwSaturation
Specifies the saturation value. This value ranges from 0 to 10,000.

Description

The ICSetSaturation function sets the current saturation value. This function is only valid when decompressing an image into 8-bit X image format.
Extensions The ICSetSaturation function is a Compaq extension to the Microsoft multimedia API specification.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
ICERR_BADPARAM The value of the dwSaturation argument is out of range.
ICERR_CANTUPDATE The attribute cannot be modified.
ICERR_UNSUPPORTED The function is not supported.
See Also ICGetSaturation

ICSetSharpening

 Name ICSetSharpening --- Set current sharpening value Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICSetSharpening(HIC hic, 
                         DWORD dwSharpening);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

DWORD dwSharpening
Specifies the sharpening value. This value ranges from 0 to 10,000.

Description

The ICSetSharpening function sets the current sharpening value. This function is only valid when decompressing an image into 8-bit X image format.
Extensions The ICSetSharpening function is a Compaq extension to the Microsoft multimedia API specification.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
ICERR_BADPARAM The value of the dwSharpening argument is out of range.
ICERR_CANTUPDATE The attribute cannot be modified.
ICERR_UNSUPPORTED The function is not supported.
See Also ICGetSharpening

ICSetState

 Name ICSetState --- Set current state of a compressor or decompressor Syntax 


#include <mme/mme_api.h> 
 
MMRESULT ICSetState(HIC hic, 
                    LPVOID pv, 
                    DWORD cb);
Arguments HIC hic
Specifies a handle to a compressor or decompressor.

LPVOID pv
Specifies a pointer to a buffer containing the state data to be set. The data buffer must be allocated with the mmeAllocBuffer function before being passed to the ICSetState function.

DWORD cb
Specifies the size in bytes of the buffer containing the state data.

Description

The ICSetState function sets the current state of a compressor or decompressor.

See Appendix B for device state information.

Extensions None.

Return Values

1
Returns ICERR_OK if the function is successful; otherwise, it returns one of the following error codes:
Error Code Description
ICERR_BADHANDLE The hic argument is invalid or the compressor or decompressor is not open.
ICERR_BADPARAM The pv argument is NULL.
ICERR_CANTUPDATE The attribute cannot be modified.
ICERR_UNSUPPORTED The function is not supported.
See Also ICGetState , ICGetStateSize

Previous Next Contents Index