State Machine Rman Interface

RmanStateMach

• StateMachDesc *machine - A pointer to a machine description, which defines the number of phases and the particularities of each. It is not copied by Norman, and should remain allocated and constant until the pipe has finished executing.
• parameter_list *params - A pointer to a parameter structure. Multiple phases use the same parameters (although this is not absolutely necessary, just for simplicity), interpreted by different parameter_maps for each phase provided by the machine description. This struct is utilized only as an argument, and may be changed upon return of this function.
• short **src0
• short **src1
• short **dst0
• short **dst1 - Pointers to arrays of pointers (handles) to the data buffers to be used. If the handles, or the actual pointers are NULL, the stream pipe returned doesn't have such a source or sink of stream data (in that phase). These arrays are utilized only as arguments, and may be changed upon return of this function.
• unsigned long x_size
• unsigned long y_size - The x_size and y_size arguments are pointers to arrays of RMAN_STATEMACH_NUM_PORTS unsigned ints. Entry 0 is for src0, entry 1 for src1, entry 2 for dst0, and entry3 for dst1... If any buffer is unused, it's entry in the x or y size arrays is ignored. These arrays are utilized only as arguments, and may be changed upon return of this function.
• void (*done)() - A pointer to a function which will be called when the queue element has finished execution.

RmanStateMachSetSrcDst

• QueueElem *q - Pointer to a State Machine queue element
• short src0 - pointer to source buffer 0
• short src1 - pointer to source buffer 1
• short dst0 - pointer to destination buffer 0
• short dst1 - pointer to destination buffer 1

RmanStateMachSetDimensions

• QueueElem *q - Pointer to a State Machine queue element
• unsigned long x_sizeA - x dimension of src buffer
• unsigned long y_sizeA - y dimension of src buffer
• unsigned long x_sizeB - x dimension of dst buffer
• unsigned long y_sizeB - y dimension of dst buffer

This function changes the dimensions of the source and destination buffers of a State Machine queue element.

RmanStateMachSetSampling

• QueueElem *q - Pointer to a State Machine queue element
• unsigned upx - Amount of x upsampling to use at source
• unsigned upy - Amount of y upsampling to use at source
• unsigned up_mode - REPLICATE or ZERO-PAD ?
• unsigned dnx - Amount of x downsampling to use at destination
• unsigned dny - Amount of y downsampling to use at destination

This function changes the sampling rate used by a State Machine processing pipeline.

NOTE: NOT IMPLEMENTED AS OF 7/13/96

There is also a version which is better suited to multiphase transfers (such as the holo calculations). Instead of a single dst pointer, it takes a pointer to an array of pointers. The number of dsts is given by num_phases - 1. The x_size and y_size arguments are likewise now each an array of num_phases values. The 0th entry are the source dimensions.

NOTE: NOT IMPLEMENTED AS OF 7/13/96

extern QueueElem *RmanStateMachineMulti( short *src, short **dst,
		 int *x_size, int *y_size, int num_phases,
		 int pipe_delay, void (*done)() );

Loading a Machine Description

The State Machine is configured by selecting a combination of hardware and software modules to perform a particular task. This configuration information must also be stored with the request to process a piece of data, as it may change from application to appplication or even within an application. The StateMachDesc structure is used to store the configuration information for a particular "function".

Parameter List Support

These functions each take a pointer to an existing parameter list and a single data value. They all return void.
Example Declaration:

inline void param_add_ulong( parameter_list *list, unsigned long value );

Complete Listing of Functions

• param_add_ulong
• param_add_long
• param_add_ushort
• param_add_short
• param_add_uchar
• param_add_char
• param_add_float
• param_add_double
• param_add_smem
• param_add_struct