External Interface

The external interface to MagicEight (data structures loaded from file, or generated by user code) generally uses data structures dedicated to that purpose. In the case of streams, these are the m8_ stream_ desc and m8_ stream_ ap_ desc data structures.

typedef struct {
  m8_uint16    type;
  m8_uint16    num_dims;
  char           name[ M8_OBJECT_NAME_SIZE ];
  m8_uint8     dims[ M8_MAX_NUM_DIMS ];
} m8_stream_desc;

The m8_ stream_ desc data structure is used to represent a data stream in a m8 graph presented for execution. The name and data type of the stream, as well as the number of dimensions explicitly defined for the stream and their ``name''.

typedef struct {
  m8_uint16    type;
  m8_uint16    num_dims;
  m8_int32     offset[ M8_MAX_NUM_DIMS ];
  m8_uint32    extent[ M8_MAX_NUM_DIMS ];
  m8_int32     step[ M8_MAX_NUM_DIMS ];
  m8_uint8     order[ M8_MAX_NUM_DIMS ];
  m8_uint8     dims[ M8_MAX_NUM_DIMS ];
} m8_stream_ap_desc;

This definition of m8_ stream_ ap_ desc is no longer up to date...