MseqDefine

See also

User Guide:

Compressing and decompressing a sequence of images Setting your inputs and outputs Steps to performing a sequence operation

Reference:

MbufAllocColor MseqAlloc MseqFeed MseqGetHookInfo MseqHookFunction MseqProcess

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Not available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

mseqhandler.cpp
mseqprocess.cpp
mseqprocess.cs
mseqprocess.vb

Function Map

Table:	For specifying an input or output of the sequence operation at a given index
+ combination:	For specifying the index of the destination of the output to define or redefine

- SequenceType

- Param1Ptr

- Param2

Parameter Associations

Table:

For specifying the source or destination settings

Compilation information

Synopsis

Define, or redefine, a source or destination of an input or output of the sequence operation, respectively.

Syntax

void MseqDefine(

MIL_ID ContextSeqId,	//in
MIL_INT SequenceIndex,	//in
MIL_INT64 SequenceType,	//in
const void *Param1Ptr,	//in
MIL_DOUBLE Param2	//in

)

Description

This function defines, or redefines, the source of an input or a destination of an output of the sequence operation of the specified sequence context. The source of an input specifies from where to obtain the data to be operated on by the sequence processing operation, while the destinations of an output specify where to store data resulting from the sequence processing operation.

You can define multiple destinations for each output of the operation, but only one source for each input of the operation. The number of inputs and outputs are operation dependent. Both a sequence compression and a sequence decompression take only one input and have only one output.

If you specify an index that has already been defined, that index will be associated with the new information. If you do not want to use a destination at a specified index, redefine the destination as M_USER_HOOK. If you do not want to use a source at a specified index, redefine the source as M_USER_FEED.

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 which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

ContextSeqId

Specifies the identifier of the sequence context. The sequence context must have been previously allocated using MseqAlloc().

SequenceIndex

Specifies whether to define, or redefine, the source of an input or one of the destinations of an output for the sequence operation of the specified sequence context.

Specifies the index of the input or the output whose source or destinations must be defined or redefined; respectively.

For specifying an input or output of the sequence operation at a given index
Value	Description
M_SEQ_INPUT( MIL_INT Index )	Specifies an input of the sequence operation, whose source must be defined or redefined. (summarize) Specifies an input of the sequence operation, whose source must be defined or redefined. (more details...)
		Parameters
		Index Specifies the index of the input. The index must be 0.
M_SEQ_OUTPUT( MIL_INT Index )	Specifies an output of the sequence operation, whose destination must be defined or redefined. An output can have multiple destinations. You must specify a combination value from the following table: To specify the index of the destination of the output, to define or redefine (summarize) Specifies an output of the sequence operation, whose destination must be defined or redefined. (more details...)
		Parameters
		Index Specifies the index of the output. The index must be set to 0.

Combination value 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 define or redefine.

For specifying the index of the destination of the output to define or redefine
Combination value	Description
M_SEQ_DEST( MIL_INT Index )	Specifies the destination of the output, to define or redefine. (summarize) Specifies the destination of the output, to define or redefine. (more details...)
		Parameters
		Index Specifies the index of the destination. The index must be between 0 and 31.

SequenceType

Specifies the type of source or destination to define.

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

Param1Ptr

Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):

array of type MIL_ID [optionally, in C++: a reference to a constant std::vector<MIL_ID> ]
MIL_CONST_TEXT_PTR [optionally, in C++: a reference to a MIL_STRING]

Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen.

Set this parameter to M_NULL if not used.

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

Param2

Specifies an attribute of the source or destination to define. Its definition is dependent on the sequence type chosen.

Set this parameter to M_NULL if not used.

When using a standard vector (std::vector) overload function in C++, you can pass M_DEFAULT to this parameter and MIL will automatically determine the size based on the number of items in the vector passed to the Param1Ptr parameter.

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

Parameter associations

The table below lists possible values for the SequenceType, Param1Ptr, and Param2 parameters.

For specifying the source or destination settings

To specify the settings of the source or destination, set the Param1Ptr and Param2 parameters to the following values. Note that any unused parameters should be set to M_NULL.

For specifying the source or destination settings INQ
SequenceType			Description
	Param1Ptr
	Param2
M_BUFFER_LIST			Defines the source of the input, or destination of the output, of the sequence operation as a buffer list. A buffer list cannot be used as the source of the input for a decompression operation or as the destination of the output for a compression operation (summarize) Defines the source of the input, or destination of the output, of the sequence operation as a buffer list. (more details...)
	Param1Ptr		Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a constant std::vector<MIL_ID> ] MORE Data type: array of type MIL_ID [optionally, in C++: a reference to a constant std::vector<MIL_ID> ] Required array size:(Param2) Specifies the address of the array containing the identifiers of the buffers on which to perform the operation. To allocate each buffer, use MbufAllocColor(). When performing a sequence processing operation (using MseqProcess()) with a buffer list as the source of the input, a call to MseqFeed() is done internally. See MseqFeed() for information regarding buffer depth and type. (summarize) Data type info: Data type: array of type MIL_ID [optionally, in C++: a reference to a constant std::vector<MIL_ID> ] MORE Data type: array of type MIL_ID [optionally, in C++: a reference to a constant std::vector<MIL_ID> ] Required array size:(Param2) Specifies the address of the array containing the identifiers of the buffers on which to perform the operation. (more details...)
	Param2		Specifies the number of buffers in the buffer list.
M_FILE			Defines the source of the input, or destination of the output, of the sequence operation as a file. INQ (summarize) Defines the source of the input, or destination of the output, of the sequence operation as a file. INQ (more details...)
	Param1Ptr		Data type info: Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Note: When using C++, you can pass a reference to a MIL_STRING instead. Specifies the file to use. (summarize) Data type info: Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Data type: address of a MIL_CONST_TEXT_PTR [optionally, in C++: MIL_STRING ] Note: When using C++, you can pass a reference to a MIL_STRING instead. Specifies the file to use. (more details...)
		MIL_TEXT("FileName") ¹	Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). If the sequence context is allocated on a remote system (under Distributed MIL), you must specify a file on the same remote computer. To do so, prefix the specified file name string with "remote:///" (for example, "remote:///C:\mydirectory\myfile"); otherwise, an error will occur. (summarize) Specifies the drive, directory, and name of the file (for example, "C:\mydirectory\myfile"). (more details...)
	Param2		Specifies the format of the file. (summarize) Specifies the format of the file. (more details...)
		M_FILE_FORMAT_AVI	Specifies that the file is in AVI format.
		M_FILE_FORMAT_H264	Specifies that the file is in H.264 elementary video data format. An H.264 elementary video file cannot be used as a destination for a decompression operation. (summarize) Specifies that the file is in H.264 elementary video data format. (more details...)
		M_FILE_FORMAT_MP4	Specifies that the file is in MP4 format.
M_USER_FEED			Defines the source of the input of the sequence operation as a manual image feed, where the images are passed individually to the sequence operation. To perform the feed, call MseqFeed() after you start the sequence processing operation using MseqProcess(). By default, the source of each input of the operation is an image feed. (summarize) Defines the source of the input of the sequence operation as a manual image feed, where the images are passed individually to the sequence operation. (more details...)
M_USER_HOOK			Defines the destination of the output as 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). In the hook function, use MseqGetHookInfo() with M_MODIFIED_BUFFER + M_BUFFER_ID to retrieve the identifier of the internal output buffer. By default, the destination of each output is set to M_USER_HOOK. You can use hook functions to retrieve data about the internal output buffer, regardless of whether M_USER_HOOK is specified. (summarize) Defines the destination of the output as 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). (more details...)

¹ If you are passing the value in a variable, don't enclose it in MIL_TEXT().

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.