| MIL 10 Reference
| Customize Help
| Save Settings

MseqInquire


See also
Availability
Available in MIL-Lite
Available in MIL

Available on Windows
Not available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
MseqHookFunction
MseqProcess
Synopsis
Inquire information about a sequence context or an individual source or destination setting.
Syntax
MIL_INT MseqInquire(
MIL_ID ContextSeqId, //in
MIL_INT SequenceIndex, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires information about a sequence context or an individual source or destination setting.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
ContextSeqId

Specifies the sequence context about which to inquire information. The sequence context must have been previously allocated using MseqAlloc().

SequenceIndex

Specifies that the sequence context, the source of an input, or a destination of an output is inquired. Set this parameter to one of the following values:

function map For specifying a context, or an individual source or destination
CollapseValue Description
Collapse M_DEFAULT

Same as M_CONTEXT.
Collapse
M_SEQ_INPUT(
MIL_INT Index
)

Specifies an input of the sequence operation, whose source must be inquired.

(summarize)
Parameters

Specifies the index of the input. The index must be 0.
Collapse
M_SEQ_OUTPUT(
MIL_INT Index
) +

Specifies an output of the sequence operation, whose destination must be inquired. An output can have multiple destinations.


You must specify a combination value from the following table:
(summarize)
Parameters

Specifies the index of the output. The index must be set to 0.
Collapse M_CONTEXT

Inquires information about the specified sequence context.
Combination constant for M_SEQ_OUTPUT.

You must add the following value to the above-mentioned value to specify the index of the destination of the output to inquire.

function map For specifying the index of the destination of the output to inquire
CollapseCombination value Description
Collapse
M_SEQ_DEST(
MIL_INT Index
)

Specifies the destination of the output to inquire.

(summarize)
Parameters

Specifies the index of the destination. The index must be between 0 and 31.
InquireType

Specifies the type of setting about which to inquire.

See the Parameter associations section for possible values that can be specified.

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type MIL_TEXT_CHAR
  • MIL_DOUBLE
  • MIL_INT

Specifies the address in which to write the requested information.

Since the MseqInquire() function also returns the requested information, you can set this parameter to M_NULL, except when the specified InquireType requires the UserVarPtr parameter to be set to the address of a MIL_INT, MIL_DOUBLE, or MIL_TEXT_CHAR. In this case, you must set this parameter to the address of a MIL_INT, MIL_DOUBLE, or MIL_TEXT_CHAR, respectively.

See the Parameter associations section for possible values that can be returned.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

The following inquire types allow you to inquire the H.264 compression settings for the sequence context (M_CONTEXT).

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For retrieving information about the H.264 compression operation settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_CODEC_TYPE

Inquires the type of codec used for the compression or decompression operation. SET

(summarize)
Collapse M_QSV + M_HARDWARE

Specifies to perform the operation using hardware acceleration.
Collapse M_QSV + M_SOFTWARE

Specifies to perform the operation in software.
Collapse M_SETTING_AUTO_ADJUSTMENT

Inquires whether incompatible operation settings are automatically adjusted. SET

(summarize)
Collapse M_DISABLE

Specifies to not automatically adjust incompatible settings. INFO
Collapse M_ENABLE

Specifies to automatically adjust incompatible settings. INFO
Collapse M_SIZE_X

Inquires the width of the elementary video stream. SET

(summarize)
Collapse Value

Specifies the width, in pixels.
Collapse M_SIZE_Y

Inquires the height of the elementary video stream. SET

(summarize)
Collapse Value

Specifies the height, in pixels.
Collapse M_STREAM_BIT_RATE +

Inquires the elementary video stream bit rate. SET

(summarize)
Collapse Value > 0

Specifies the bit rate, in Kbits/sec.
Collapse M_STREAM_BIT_RATE_MAX +

Inquires the maximum bit rate that the elementary video stream can have. SET

(summarize)
Collapse Value > 0

Specifies the maximum bit rate, in Kbits/sec.
Collapse M_STREAM_BIT_RATE_MODE

Inquires the type of bit rate the elementary video stream will have. SET

(summarize)
Collapse M_CONSTANT

Specifies that the bit rate will remain constant throughout the duration of the elementary video stream. INFO
Collapse M_VARIABLE

Specifies that the bit rate will fluctuate depending on how compressible sections of the elementary video stream are. INFO
Collapse M_STREAM_FRAME_RATE

Inquires the frame rate of the elementary video stream. SET

(summarize)
Collapse UserVarPtr data type info

Data type: MIL_DOUBLE

Collapse Value > 0.0

Specifies the elementary video stream's frame rate, in frames/sec.
Collapse M_STREAM_FRAME_RATE_MODE

Inquires how the decoding frame rate, written in the header of M_FILE destination types, is established. SET

(summarize)
Collapse M_CONSTANT

Specifies that the decoding frame rate written in the header of M_FILE destination types is the same as the frame rate specified with M_STREAM_FRAME_RATE.
Collapse M_VARIABLE

Specifies that the decoding frame rate written in the header of M_FILE destination types is the average encoding frame rate, if the processor could not encode at the specified frame rate; otherwise, the frame rate specified with M_STREAM_FRAME_RATE will be written. INFO
Collapse M_STREAM_GROUP_OF_PICTURE_SIZE +

Inquires the group-of-pictures size. SET

(summarize)
Collapse Value

Specifies the group-of-pictures size, in number of frames/group. INFO
Collapse M_STREAM_LEVEL +

Inquires the H.264 compression level used by the compression operation. SET

(summarize)
Collapse M_LEVEL_1

Specifies the 1 compression level.
Collapse M_LEVEL_1_1

Specifies the 1.1 compression level.
Collapse M_LEVEL_1_2

Specifies the 1.2 compression level.
Collapse M_LEVEL_1_3

Specifies the 1.3 compression level.
Collapse M_LEVEL_1B

Specifies the 1B compression level.
Collapse M_LEVEL_2

Specifies the 2 compression level.
Collapse M_LEVEL_2_1

Specifies the 2.1 compression level.
Collapse M_LEVEL_2_2

Specifies the 2.2 compression level.
Collapse M_LEVEL_3

Specifies the 3 compression level.
Collapse M_LEVEL_3_1

Specifies the 3.1 compression level.
Collapse M_LEVEL_3_2

Specifies the 3.2 compression level.
Collapse M_LEVEL_4

Specifies the 4 compression level.
Collapse M_LEVEL_4_1

Specifies the 4.1 compression level.
Collapse M_LEVEL_4_2

Specifies the 4.2 compression level.
Collapse M_LEVEL_5

Specifies the 5 compression level.
Collapse M_LEVEL_5_1

Specifies the 5.1 compression level.
Collapse M_STREAM_PROFILE +

Inquires the H.264 compression profile. SET

(summarize)
Collapse M_PROFILE_BASELINE

Specifies to use the baseline profile. INFO
Collapse M_PROFILE_HIGH

Specifies to use the high profile. INFO
Collapse M_PROFILE_MAIN

Specifies to use the main profile. INFO
Collapse M_STREAM_QUALITY +

Inquires the H.264 compression operation priority. SET

(summarize)
Collapse 0 <= Value <= 100

Specifies the speed/quality priority. INFO

You can add the following value to the above-mentioned values to get the actual values used if MseqControl() with M_SETTING_AUTO_ADJUSTMENT was set to M_ENABLE.

function map For inquiring the actual values used
CollapseCombination value Description
Collapse M_EFFECTIVE_VALUE

Inquires the actual value used by the compression operation.

You can inquire information about the following settings for any type of individual source (M_SEQ_INPUT()) or destination (M_SEQ_OUTPUT() + M_SEQ_DEST()).

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For retrieving information about general individual source or destination settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_TYPE

Inquires the type of source or destination at the specified index. SET

(summarize)
Collapse M_BUFFER_LIST

Specifies the source of the input, or destination of the output, of the sequence operation is a buffer list. INFO
Collapse M_FILE

Specifies the source of the input, or destination of the output, of the sequence operation is a file.
Collapse M_USER_FEED

Specifies the source of the input of the sequence operation is a manual image feed, where the images are passed individually to the sequence operation. INFO
Collapse M_USER_HOOK

Specifies the destination of the output is the internal output buffer of the operation; if this is the only destination, you should use a user-defined hook function to retrieve the data before it is overwritten by the next frame of resulting data (MseqHookFunction() with M_FRAME_END). INFO

You can inquire information about the following settings for individual file sources or destinations (M_SEQ_INPUT() or M_SEQ_OUTPUT() + M_SEQ_DEST() defined as M_FILE).

Unless otherwise specified, the following values require that you pass the UserVarPtr parameter the address of a MIL_INT.

function map For retrieving information about individual file (M_FILE) source or destination settings
CollapseInquireType Description
UserVarPtr
- Possible values returned
Collapse M_FILE_FORMAT

Inquires the format of the file at the specified index. SET

(summarize)
Collapse M_FILE_FORMAT_AVI

Specifies that the file is in AVI format.
Collapse M_FILE_FORMAT_H264

Specifies that the file is in H.264 elementary video data format.
Collapse M_FILE_FORMAT_MP4

Specifies that the file is in MP4 format.
Collapse M_STREAM_FILE_NAME

Inquires the name of the file at the specified index. SET

(summarize)
Collapse UserVarPtr data type info

Data type: array of type MIL_TEXT_CHAR
Array size: To determine the size of the array required to store the file name, use MseqInquire() with M_STREAM_FILE_NAME_SIZE

Collapse Value

Specifies the file name.
Collapse M_STREAM_FILE_NAME_SIZE

Inquires the length of the string returned by M_STREAM_FILE_NAME.

(summarize)
Collapse Value

Specifies the length of the string, including the terminating null character ("\0").
Return value
The returned value is the requested information, cast to a MIL_INT; otherwise M_ERROR is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
DEFAULT CONTEXT CODEC TYPE QSV M HARDWARE QSV M SOFTWARE SETTING AUTO ADJUSTMENT DISABLE ENABLE SIZE X SIZE Y STREAM BIT RATE STREAM BIT RATE MAX STREAM BIT RATE MODE CONSTANT VARIABLE STREAM FRAME RATE STREAM FRAME RATE MODE CONSTANT VARIABLE STREAM GROUP OF PICTURE SIZE STREAM LEVEL LEVEL 1 LEVEL 1 1 LEVEL 1 2 LEVEL 1 3 LEVEL 1B LEVEL 2 LEVEL 2 1 LEVEL 2 2 LEVEL 3 LEVEL 3 1 LEVEL 3 2 LEVEL 4 LEVEL 4 1 LEVEL 4 2 LEVEL 5 LEVEL 5 1 STREAM PROFILE PROFILE BASELINE PROFILE HIGH PROFILE MAIN STREAM QUALITY EFFECTIVE VALUE TYPE BUFFER LIST FILE USER FEED USER HOOK FILE FORMAT FILE FORMAT AVI FILE FORMAT H264 FILE FORMAT MP4 STREAM FILE NAME STREAM FILE NAME SIZE DEFAULT CONTEXT DEFAULT CONTEXT DEFAULT CONTEXT FILE