Loads an AG TRAU program to an NMS board DSP and binds the program to a CT Access context.

DWORD trauLoad ( CTAHD loadhd,
unsigned board,
char *file_name,
TRAUDSPID *dspid,
void *start_parms,
unsigned size )

loadhd A CT Access context handle used to open an AG TRAU service.

board AG board number on which to load AG TRAU programs. Set to ANY_FUSION_BOARD to load programs to DSPs on any available NMS board.

file_name Pointer to the file name of the AG TRAU program file to load.

dspid Pointer to a location to receive an AG TRAU DSP ID associated with the AG TRAU program.

start_parms Pointer to an optional data structure that specifies program-specific initialization values for the AG TRAU program. Set to NULL if not used. This is reserved.

size Size of the start_parms structure in bytes (when start_parms is not NULL). If start_parms is NULL, set to zero.

• SUCCESS
• CTAERR_FILE_OPEN_FAILED
  Unable to open the file specified in file_name.
• CTAERR_FILE_READ_FAILED
  Unable to read AG TRAU program specified in file_name.
• CTAERR_INVALID_CTAHD
• CTAERR_OUT_OF_MEMORY
  A process memory allocation problem occurred while executing the function.
• TRAUERR_NO_FREE_DSP
  No DSP is available to receive the AG TRAU program.
• TRAUERR_NOT_LOAD_HANDLE
  The loadhd passed in was not valid because it has an attached channel.

• TRAUEVN_LOAD_DONE
  If the AG TRAU program loads successfully, the TRAUEVN_LOAD_DONE event returns (in the CTA_EVENT buffer field) a pointer to the following structure: typedef struct _TRAU_LOAD_DONE_DATA

  {

  unsigned type; /* Vocoder type identifier */

  TRAUDSPID dspid; /* The associated dspid */
  unsigned board; /* Board ( 0-15 ) */

  unsigned dsp; /* DSP ( 1-48 ) */

  unsigned channels; /* Channels created */

  unsigned frame_tic; /* Tics in .25ms increments */

  unsigned max_frame_size; /* HBF specific */

  /* SWITCHING INFORMATION FOLLOWS */

  DWORD bus; /* Bus used */

  int pcm_stream_from_dsp; /* Stream used for voice PCM */

  int pcm_stream_to_dsp; /* Stream used for voice PCM */

  int pcm_count; /* Number of PCM slots used */

  DWORD pcm_slot[ PCM_MAX_SLOTS ]; /* Array of PCM slots */

  /* COMPRESSED TX FUSION ONLY (set to 0 if HBF) */

  int tx_stream_from_dsp; /* Stream for data from TX */

  int tx_stream_to_dsp; /* Stream for data to TX */

  int tx_count; /* # of bonded time slots */

  DWORD tx_slot[ TX_MAX_SLOTS ]; /* Array of data slots */

  } TRAU_LOAD_DONE_DATA;

• The TRAUEVN_LOAD_DONE event value field also contains one of the following:

CTA_REASON_FINISHED

The AG TRAU program was successfully loaded to an

NMS board.

CTAERR_BAD_SIZE

For Fusion host-based applications, the number of

vocoders exceeds the frame-per-transfer size.


CTAERR_INCOMPATABLE_REVISION

The program specified by file_name is not

compatible with current version of the AG TRAU

service.

CTAERR_INVALID_STATE

The AG TRAU program has not been initialized state.

CTAERR_NOT_IMPLEMENTED

A bad or unknown message type was received from

the AG TRAU service.

CTAERR_OUT_OF_MEMORY

The AG TRAU service could not allocate enough

memory to load the AG TRAU program.

TRAUERR_BAD_FILE_SIZE

The AG TRAU program file is not a valid size.

TRAUERR_BOARD_ERROR

An unexpected board error occurred and the load

operation was aborted.

TRAUERR_INVALID_RESPONSE

An unexpected response was received from the

AG TRAU program.

TRAUERR_NO_FREE_DSP

No DSP resources available for the AG TRAU

program.

This function loads a specified AG TRAU program to an available
NMS board DSP. If the board value is set to ANY_FUSION_BOARD, the AG TRAU load AG TRAU programs to available DSPs on any NMS board on the system.

Note: ANY_FUSION_BOARD can be used only in systems that use a single type of DSP resource board. A system that uses more than one type of DSP resource board (for example an AG 4000 and an
AG 2000 board), cannot use this option.

The load operation is complete when the TRAUEVN_LOAD_DONE event is returned. If the operation completes successfully, the TRAUEVN_LOAD_DONE points to a buffer that holds information about the loaded AG TRAU program and its associated channels. Applications should call trauReleaseBuffer after retrieving data from this buffer.

Applications can use dspids to match returned events with their associated AG TRAU programs (loadhds).

Note: CTA_REASON_FINISHED always tries to return a buffer containing LOAD_DONE_DATA. If size is set to 0 and buffer is set to NULL, the application failed to return buffer resources to the AG TRAU service with trauReleaseBuffer.

Refer to the Fusion readme.txt for a list of available AG TRAU program file names.

For Fusion host-based applications, you may specify the optimization parameter startdata[0] with the start_parms argument. Although this parameter increases signal latency it tends to reduce the number of packets the host processor drops under heavy host processing conditions.

startdata[0] uses the specified value to set the depth of an internal jitter buffer between the HBF service and host processor. The specified value sets the jitter depth in number of frames (valid entries range from 1 to 5). A jitter depth of 1 frame (the minimum) is set when you specify NULL and 0 for the start_parms and size arguments. NMS recommends a value of 2 frames (as set by the gSJThresh argument in the example code that follows).

int     gSJThresh = 2;     
...
    case 's':
     gSJThresh = atoi(&argv[i][2]);  
     break;
...

DWORD loadDSP(char* vocoder, unsigned *dspNum, unsigned *channels, unsigned *trauType)
{
    DWORD ret;
    TRAU_LOAD_DONE_DATA* pLoadDoneData;
    unsigned dspId;
    CTA_EVENT Event;

 WORD startdata[4];

 startdata[0] = gSJThresh; startdata[1] = 18; startdata[2] = 19;  
 startdata[3] = 20; // Only 0 is used
#if 1
    if(( ret = trauLoad(ghTrauLd, gBoardNumber, vocoder,
  &dspId, startdata, 8 )) != SUCCESS)            
  // last two parameters were NULL, 0       (ptr,siz)
    {
  dprintf("loadDSP(): trauLoad() failed...0x%x\n", ret);
  return E_FAIL;
    }
#else
    if(( ret = trauLoad(ghTrauLd, gBoardNumber, vocoder,
  &dspId, NULL, 0 )) != SUCCESS)              // last two parameters were NULL, 0       (ptr,siz)
    {
  dprintf("loadDSP(): trauLoad() failed...0x%x\n", ret);
  return E_FAIL;
    }
#endif

trauAttach, trauEnable, trauReleaseBuffer, trauUnload