diff options
Diffstat (limited to 'arm-wt-22k/host_src/eas.h')
| -rw-r--r-- | arm-wt-22k/host_src/eas.h | 570 |
1 files changed, 285 insertions, 285 deletions
diff --git a/arm-wt-22k/host_src/eas.h b/arm-wt-22k/host_src/eas.h index 524601e..c64af49 100644 --- a/arm-wt-22k/host_src/eas.h +++ b/arm-wt-22k/host_src/eas.h @@ -1,16 +1,16 @@ /*---------------------------------------------------------------------------- * - * File: + * File: * eas.h * * Contents and purpose: * The public interface header for the EAS synthesizer. * * This header only contains declarations that are specific - * to this implementation. + * to this implementation. * * DO NOT MODIFY THIS FILE! - * + * * Copyright Sonic Network Inc. 2005, 2006 * Licensed under the Apache License, Version 2.0 (the "License"); @@ -48,59 +48,59 @@ extern "C" { typedef struct { - EAS_U32 libVersion; - EAS_BOOL checkedVersion; - EAS_I32 maxVoices; - EAS_I32 numChannels; - EAS_I32 sampleRate; - EAS_I32 mixBufferSize; - EAS_BOOL filterEnabled; - EAS_U32 buildTimeStamp; - EAS_CHAR *buildGUID; + EAS_U32 libVersion; + EAS_BOOL checkedVersion; + EAS_I32 maxVoices; + EAS_I32 numChannels; + EAS_I32 sampleRate; + EAS_I32 mixBufferSize; + EAS_BOOL filterEnabled; + EAS_U32 buildTimeStamp; + EAS_CHAR *buildGUID; } S_EAS_LIB_CONFIG; /* enumerated effects module numbers for configuration */ typedef enum { - EAS_MODULE_ENHANCER = 0, - EAS_MODULE_COMPRESSOR, - EAS_MODULE_REVERB, - EAS_MODULE_CHORUS, - EAS_MODULE_WIDENER, - EAS_MODULE_GRAPHIC_EQ, - EAS_MODULE_WOW, - EAS_MODULE_MAXIMIZER, - EAS_MODULE_TONECONTROLEQ, - NUM_EFFECTS_MODULES + EAS_MODULE_ENHANCER = 0, + EAS_MODULE_COMPRESSOR, + EAS_MODULE_REVERB, + EAS_MODULE_CHORUS, + EAS_MODULE_WIDENER, + EAS_MODULE_GRAPHIC_EQ, + EAS_MODULE_WOW, + EAS_MODULE_MAXIMIZER, + EAS_MODULE_TONECONTROLEQ, + NUM_EFFECTS_MODULES } E_FX_MODULES; /* enumerated optional module numbers for configuration */ typedef enum { - EAS_MODULE_MMAPI_TONE_CONTROL = 0, - EAS_MODULE_METRICS + EAS_MODULE_MMAPI_TONE_CONTROL = 0, + EAS_MODULE_METRICS } E_OPT_MODULES; -#define NUM_OPTIONAL_MODULES 2 +#define NUM_OPTIONAL_MODULES 2 /* enumerated audio decoders for configuration */ typedef enum { - EAS_DECODER_PCM = 0, - EAS_DECODER_SMAF_ADPCM, - EAS_DECODER_IMA_ADPCM, - EAS_DECODER_7BIT_SMAF_ADPCM, - EAS_DECODER_NOT_SUPPORTED + EAS_DECODER_PCM = 0, + EAS_DECODER_SMAF_ADPCM, + EAS_DECODER_IMA_ADPCM, + EAS_DECODER_7BIT_SMAF_ADPCM, + EAS_DECODER_NOT_SUPPORTED } E_DECODER_MODULES; -#define NUM_DECODER_MODULES 4 +#define NUM_DECODER_MODULES 4 /* defines for EAS_PEOpenStream flags parameter */ -#define PCM_FLAGS_STEREO 0x00000100 /* stream is stereo */ -#define PCM_FLAGS_8_BIT 0x00000001 /* 8-bit format */ -#define PCM_FLAGS_UNSIGNED 0x00000010 /* unsigned format */ -#define PCM_FLAGS_STREAMING 0x80000000 /* streaming mode */ +#define PCM_FLAGS_STEREO 0x00000100 /* stream is stereo */ +#define PCM_FLAGS_8_BIT 0x00000001 /* 8-bit format */ +#define PCM_FLAGS_UNSIGNED 0x00000010 /* unsigned format */ +#define PCM_FLAGS_STREAMING 0x80000000 /* streaming mode */ /* maximum volume setting */ -#define EAS_MAX_VOLUME 100 +#define EAS_MAX_VOLUME 100 /*---------------------------------------------------------------------------- * EAS_Init() @@ -109,8 +109,8 @@ typedef enum * Initialize the synthesizer library * * Inputs: - * polyphony - number of voices to play (dynamic memory model only) - * ppLibData - pointer to data handle variable for this instance + * polyphony - number of voices to play (dynamic memory model only) + * ppLibData - pointer to data handle variable for this instance * * Outputs: * @@ -141,7 +141,7 @@ EAS_PUBLIC const S_EAS_LIB_CONFIG *EAS_Config (void); * synthesizer (dynamic memory model only) * * Inputs: - * pEASData - handle to data for this instance + * pEASData - handle to data for this instance * * Outputs: * @@ -157,12 +157,12 @@ EAS_PUBLIC EAS_RESULT EAS_Shutdown (EAS_DATA_HANDLE pEASData); * * Inputs: * pEASData - buffer for internal EAS data - * pOut - output buffer pointer - * nNumRequested - requested num samples to generate - * pnNumGenerated - actual number of samples generated + * pOut - output buffer pointer + * nNumRequested - requested num samples to generate + * pnNumGenerated - actual number of samples generated * * Outputs: - * EAS_SUCCESS if PCM data was successfully rendered + * EAS_SUCCESS if PCM data was successfully rendered * *---------------------------------------------------------------------------- */ @@ -171,21 +171,21 @@ EAS_PUBLIC EAS_RESULT EAS_Render (EAS_DATA_HANDLE pEASData, EAS_PCM *pOut, EAS_I /*---------------------------------------------------------------------------- * EAS_SetRepeat() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the selected stream to repeat. * * Inputs: - * pEASData - handle to data for this instance - * streamHandle - handle to stream - * repeatCount - repeat count (0 = no repeat, -1 = repeat forever) - * + * pEASData - handle to data for this instance + * streamHandle - handle to stream + * repeatCount - repeat count (0 = no repeat, -1 = repeat forever) + * * Outputs: * * Side Effects: * * Notes: - * 0 = no repeat - * 1 = repeat once, i.e. play through twice + * 0 = no repeat + * 1 = repeat once, i.e. play through twice * -1 = repeat forever *---------------------------------------------------------------------------- */ @@ -194,21 +194,21 @@ EAS_PUBLIC EAS_RESULT EAS_SetRepeat (EAS_DATA_HANDLE pEASData, EAS_HANDLE stream /*---------------------------------------------------------------------------- * EAS_GetRepeat() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Gets the current repeat count for the selected stream. * * Inputs: - * pEASData - handle to data for this instance - * streamHandle - handle to stream - * pRrepeatCount - pointer to variable to hold repeat count - * + * pEASData - handle to data for this instance + * streamHandle - handle to stream + * pRrepeatCount - pointer to variable to hold repeat count + * * Outputs: * * Side Effects: * * Notes: - * 0 = no repeat - * 1 = repeat once, i.e. play through twice + * 0 = no repeat + * 1 = repeat once, i.e. play through twice * -1 = repeat forever *---------------------------------------------------------------------------- */ @@ -217,14 +217,14 @@ EAS_PUBLIC EAS_RESULT EAS_GetRepeat (EAS_DATA_HANDLE pEASData, EAS_HANDLE stream /*---------------------------------------------------------------------------- * EAS_SetPlaybackRate() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the playback rate. * * Inputs: - * pEASData - handle to data for this instance - * streamHandle - handle to stream - * rate - rate (28-bit fractional amount) - * + * pEASData - handle to data for this instance + * streamHandle - handle to stream + * rate - rate (28-bit fractional amount) + * * Outputs: * * Side Effects: @@ -232,22 +232,22 @@ EAS_PUBLIC EAS_RESULT EAS_GetRepeat (EAS_DATA_HANDLE pEASData, EAS_HANDLE stream *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_SetPlaybackRate (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHandle, EAS_U32 rate); -#define MAX_PLAYBACK_RATE (EAS_U32)(1L << 29) -#define MIN_PLAYBACK_RATE (EAS_U32)(1L << 27) +#define MAX_PLAYBACK_RATE (EAS_U32)(1L << 29) +#define MIN_PLAYBACK_RATE (EAS_U32)(1L << 27) /*---------------------------------------------------------------------------- * EAS_SetTransposition) *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Sets the key tranposition for the synthesizer. Transposes all * melodic instruments by the specified amount. Range is limited * to +/-12 semitones. * * Inputs: - * pEASData - handle to data for this instance - * streamHandle - handle to stream - * transposition - +/-12 semitones - * + * pEASData - handle to data for this instance + * streamHandle - handle to stream + * transposition - +/-12 semitones + * * Outputs: * * Side Effects: @@ -255,21 +255,21 @@ EAS_PUBLIC EAS_RESULT EAS_SetPlaybackRate (EAS_DATA_HANDLE pEASData, EAS_HANDLE *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_SetTransposition (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHandle, EAS_I32 transposition); -#define MAX_TRANSPOSE 12 +#define MAX_TRANSPOSE 12 /*---------------------------------------------------------------------------- * EAS_SetSynthPolyphony() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the polyphony of the synthesizer. Value must be >= 1 and <= the * maximum number of voices. This function will pin the polyphony * at those limits * * Inputs: - * pEASData - pointer to overall EAS data structure - * synthNum - synthesizer number (0 = onboard, 1 = DSP) - * polyphonyCount - the desired polyphony count - * + * pEASData - pointer to overall EAS data structure + * synthNum - synthesizer number (0 = onboard, 1 = DSP) + * polyphonyCount - the desired polyphony count + * * Outputs: * * Side Effects: @@ -281,14 +281,14 @@ EAS_PUBLIC EAS_RESULT EAS_SetSynthPolyphony (EAS_DATA_HANDLE pEASData, EAS_I32 s /*---------------------------------------------------------------------------- * EAS_GetSynthPolyphony() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Returns the current polyphony setting of the synthesizer * * Inputs: - * pEASData - pointer to overall EAS data structure - * synthNum - synthesizer number (0 = onboard, 1 = DSP) - * pPolyphonyCount - pointer to variable to receive polyphony count - * + * pEASData - pointer to overall EAS data structure + * synthNum - synthesizer number (0 = onboard, 1 = DSP) + * pPolyphonyCount - pointer to variable to receive polyphony count + * * Outputs: * * Side Effects: @@ -300,16 +300,16 @@ EAS_PUBLIC EAS_RESULT EAS_GetSynthPolyphony (EAS_DATA_HANDLE pEASData, EAS_I32 s /*---------------------------------------------------------------------------- * EAS_SetPolyphony() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the polyphony of the stream. Value must be >= 1 and <= the * maximum number of voices. This function will pin the polyphony * at those limits * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - handle returned by EAS_OpenFile - * polyphonyCount - the desired polyphony count - * + * pEASData - pointer to overall EAS data structure + * streamHandle - handle returned by EAS_OpenFile + * polyphonyCount - the desired polyphony count + * * Outputs: * * Side Effects: @@ -321,14 +321,14 @@ EAS_PUBLIC EAS_RESULT EAS_SetPolyphony (EAS_DATA_HANDLE pEASData, EAS_HANDLE str /*---------------------------------------------------------------------------- * EAS_GetPolyphony() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Returns the current polyphony setting of the stream * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - handle returned by EAS_OpenFile - * pPolyphonyCount - pointer to variable to receive polyphony count - * + * pEASData - pointer to overall EAS data structure + * streamHandle - handle returned by EAS_OpenFile + * pPolyphonyCount - pointer to variable to receive polyphony count + * * Outputs: * * Side Effects: @@ -340,17 +340,17 @@ EAS_PUBLIC EAS_RESULT EAS_GetPolyphony (EAS_DATA_HANDLE pEASData, EAS_HANDLE str /*---------------------------------------------------------------------------- * EAS_SetPriority() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the priority of the stream. Determines which stream's voices * are stolen when there are insufficient voices for all notes. * Value must be in the range of 1-255, lower values are higher * priority. The default priority is 50. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - handle returned by EAS_OpenFile - * polyphonyCount - the desired polyphony count - * + * pEASData - pointer to overall EAS data structure + * streamHandle - handle returned by EAS_OpenFile + * polyphonyCount - the desired polyphony count + * * Outputs: * * Side Effects: @@ -362,14 +362,14 @@ EAS_PUBLIC EAS_RESULT EAS_SetPriority (EAS_DATA_HANDLE pEASData, EAS_HANDLE stre /*---------------------------------------------------------------------------- * EAS_GetPriority() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Returns the current priority setting of the stream * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - handle returned by EAS_OpenFile - * pPriority - pointer to variable to receive priority - * + * pEASData - pointer to overall EAS data structure + * streamHandle - handle returned by EAS_OpenFile + * pPriority - pointer to variable to receive priority + * * Outputs: * * Side Effects: @@ -381,14 +381,14 @@ EAS_PUBLIC EAS_RESULT EAS_GetPriority (EAS_DATA_HANDLE pEASData, EAS_HANDLE stre /*---------------------------------------------------------------------------- * EAS_SetVolume() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the master volume for the mixer. The default volume setting is * 90 (-10 dB). The volume range is 0 to 100 in 1dB increments. * * Inputs: - * pEASData - pointer to overall EAS data structure - * volume - the desired master volume - * + * pEASData - pointer to overall EAS data structure + * volume - the desired master volume + * * Outputs: * * @@ -402,13 +402,13 @@ EAS_PUBLIC EAS_RESULT EAS_SetVolume (EAS_DATA_HANDLE pEASData, EAS_HANDLE stream /*---------------------------------------------------------------------------- * EAS_GetVolume() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Returns the master volume for the mixer in 1dB increments. * * Inputs: - * pEASData - pointer to overall EAS data structure - * volume - the desired master volume - * + * pEASData - pointer to overall EAS data structure + * volume - the desired master volume + * * Outputs: * * @@ -422,7 +422,7 @@ EAS_PUBLIC EAS_I32 EAS_GetVolume (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHan /*---------------------------------------------------------------------------- * EAS_SetMaxLoad() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Sets the maximum workload the parsers will do in a single call to * EAS_Render. The units are currently arbitrary, but should correlate * well to the actual CPU cycles consumed. The primary effect is to @@ -431,9 +431,9 @@ EAS_PUBLIC EAS_I32 EAS_GetVolume (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHan * the workload limiting function. * * Inputs: - * pEASData - handle to data for this instance - * maxLoad - the desired maximum workload - * + * pEASData - handle to data for this instance + * maxLoad - the desired maximum workload + * * Outputs: * * Side Effects: @@ -449,9 +449,9 @@ EAS_PUBLIC EAS_RESULT EAS_SetMaxLoad (EAS_DATA_HANDLE pEASData, EAS_I32 maxLoad) * use PCM streaming. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - handle returned by EAS_OpenFile - * maxNumStreams - maximum number of PCM streams + * pEASData - pointer to overall EAS data structure + * streamHandle - handle returned by EAS_OpenFile + * maxNumStreams - maximum number of PCM streams *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_SetMaxPCMStreams (EAS_DATA_HANDLE pEASData, EAS_HANDLE pStream, EAS_I32 maxNumStreams); @@ -459,16 +459,16 @@ EAS_PUBLIC EAS_RESULT EAS_SetMaxPCMStreams (EAS_DATA_HANDLE pEASData, EAS_HANDLE /*---------------------------------------------------------------------------- * EAS_OpenFile() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Opens a file for audio playback. * * Inputs: - * pEASData - pointer to overall EAS data structure - * locator - pointer to filename or other locating information - * pStreamHandle - pointer to stream handle variable - * + * pEASData - pointer to overall EAS data structure + * locator - pointer to filename or other locating information + * pStreamHandle - pointer to stream handle variable + * * Outputs: - * + * * * Side Effects: * @@ -480,16 +480,16 @@ EAS_PUBLIC EAS_RESULT EAS_OpenFile (EAS_DATA_HANDLE pEASData, EAS_FILE_LOCATOR l /*---------------------------------------------------------------------------- * EAS_MMAPIToneControl() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Opens a ToneControl file for audio playback. * * Inputs: - * pEASData - pointer to overall EAS data structure - * locator - pointer to filename or other locating information - * pStreamHandle - pointer to stream handle variable - * + * pEASData - pointer to overall EAS data structure + * locator - pointer to filename or other locating information + * pStreamHandle - pointer to stream handle variable + * * Outputs: - * + * * * Side Effects: * @@ -502,9 +502,9 @@ EAS_PUBLIC EAS_RESULT EAS_MMAPIToneControl (EAS_DATA_HANDLE pEASData, EAS_FILE_L *---------------------------------------------------------------------------- * Helper function to retrieve WAVE file fmt chunk for MMAPI *---------------------------------------------------------------------------- - * pEASData - pointer to EAS persistent data object - * streamHandle - stream handle - * pFmtChunk - pointer to pointer to FMT chunk data + * pEASData - pointer to EAS persistent data object + * streamHandle - stream handle + * pFmtChunk - pointer to pointer to FMT chunk data *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_GetWaveFmtChunk (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHandle, EAS_VOID_PTR *ppFmtChunk); @@ -515,9 +515,9 @@ EAS_PUBLIC EAS_RESULT EAS_GetWaveFmtChunk (EAS_DATA_HANDLE pEASData, EAS_HANDLE *---------------------------------------------------------------------------- * Returns the file type (see eas_types.h for enumerations) *---------------------------------------------------------------------------- - * pEASData - pointer to EAS persistent data object - * streamHandle - stream handle - * pFileType - pointer to variable to receive file type + * pEASData - pointer to EAS persistent data object + * streamHandle - stream handle + * pFileType - pointer to variable to receive file type *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_GetFileType (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHandle, EAS_I32 *pFileType); @@ -525,19 +525,19 @@ EAS_PUBLIC EAS_RESULT EAS_GetFileType (EAS_DATA_HANDLE pEASData, EAS_HANDLE stre /*---------------------------------------------------------------------------- * EAS_ParseMetaData() *---------------------------------------------------------------------------- - * Purpose: - * + * Purpose: + * * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * playLength - pointer to variable to store the play length (in msecs) - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * playLength - pointer to variable to store the play length (in msecs) + * * Outputs: - * + * * * Side Effects: - * - resets the parser to the start of the file + * - resets the parser to the start of the file *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_ParseMetaData (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHandle, EAS_I32 *pPlayLength); @@ -545,16 +545,16 @@ EAS_PUBLIC EAS_RESULT EAS_ParseMetaData (EAS_DATA_HANDLE pEASData, EAS_HANDLE st /*---------------------------------------------------------------------------- * EAS_Prepare() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Prepares the synthesizer to play the file or stream. Parses the first * frame of data from the file and arms the synthesizer. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * * Outputs: - * + * * * Side Effects: * @@ -565,15 +565,15 @@ EAS_PUBLIC EAS_RESULT EAS_Prepare (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHa /*---------------------------------------------------------------------------- * EAS_State() *---------------------------------------------------------------------------- - * Purpose: - * Returns the state of an audio file or stream. + * Purpose: + * Returns the state of an audio file or stream. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * * Outputs: - * + * * * Side Effects: * @@ -584,32 +584,32 @@ EAS_PUBLIC EAS_RESULT EAS_State (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHand /*---------------------------------------------------------------------------- * EAS_RegisterMetaDataCallback() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Registers a metadata callback function for parsed metadata. To * de-register the callback, call this function again with parameter * cbFunc set to NULL. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * cbFunc - pointer to host callback function - * metaDataBuffer - pointer to metadata buffer - * metaDataBufSize - maximum size of the metadata buffer - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * cbFunc - pointer to host callback function + * metaDataBuffer - pointer to metadata buffer + * metaDataBufSize - maximum size of the metadata buffer + * * Outputs: - * + * * * Side Effects: * *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_RegisterMetaDataCallback ( - EAS_DATA_HANDLE pEASData, - EAS_HANDLE streamHandle, - EAS_METADATA_CBFUNC cbFunc, - char *metaDataBuffer, - EAS_I32 metaDataBufSize, - EAS_VOID_PTR pUserData); + EAS_DATA_HANDLE pEASData, + EAS_HANDLE streamHandle, + EAS_METADATA_CBFUNC cbFunc, + char *metaDataBuffer, + EAS_I32 metaDataBufSize, + EAS_VOID_PTR pUserData); /*---------------------------------------------------------------------------- * EAS_GetNoteCount () @@ -617,9 +617,9 @@ EAS_PUBLIC EAS_RESULT EAS_RegisterMetaDataCallback ( * Returns the total number of notes played in this stream * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * pNoteCount - pointer to variable to receive note count + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * pNoteCount - pointer to variable to receive note count *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_GetNoteCount (EAS_DATA_HANDLE pEASData, EAS_HANDLE pStream, EAS_I32 *pNoteCount); @@ -627,16 +627,16 @@ EAS_PUBLIC EAS_RESULT EAS_GetNoteCount (EAS_DATA_HANDLE pEASData, EAS_HANDLE pSt /*---------------------------------------------------------------------------- * EAS_CloseFile() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Closes an audio file or stream. Playback should have either paused or * completed (EAS_State returns EAS_PAUSED or EAS_STOPPED). * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * * Outputs: - * + * * * Side Effects: * @@ -647,16 +647,16 @@ EAS_PUBLIC EAS_RESULT EAS_CloseFile (EAS_DATA_HANDLE pEASData, EAS_HANDLE stream /*---------------------------------------------------------------------------- * EAS_OpenMIDIStream() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Opens a raw MIDI stream allowing the host to route MIDI cable data directly to the synthesizer * * Inputs: - * pEASData - pointer to overall EAS data structure - * pStreamHandle - pointer to variable to hold file or stream handle - * streamHandle - open stream or NULL for new synthesizer instance - * + * pEASData - pointer to overall EAS data structure + * pStreamHandle - pointer to variable to hold file or stream handle + * streamHandle - open stream or NULL for new synthesizer instance + * * Outputs: - * + * * * Side Effects: * @@ -667,17 +667,17 @@ EAS_PUBLIC EAS_RESULT EAS_OpenMIDIStream (EAS_DATA_HANDLE pEASData, EAS_HANDLE * /*---------------------------------------------------------------------------- * EAS_WriteMIDIStream() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Send data to the MIDI stream device * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - stream handle - * pBuffer - pointer to buffer - * count - number of bytes to write - * + * pEASData - pointer to overall EAS data structure + * streamHandle - stream handle + * pBuffer - pointer to buffer + * count - number of bytes to write + * * Outputs: - * + * * * Side Effects: * @@ -688,15 +688,15 @@ EAS_PUBLIC EAS_RESULT EAS_WriteMIDIStream(EAS_DATA_HANDLE pEASData, EAS_HANDLE s /*---------------------------------------------------------------------------- * EAS_CloseMIDIStream() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Closes a raw MIDI stream * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - stream handle - * + * pEASData - pointer to overall EAS data structure + * streamHandle - stream handle + * * Outputs: - * + * * * Side Effects: * @@ -707,16 +707,16 @@ EAS_PUBLIC EAS_RESULT EAS_CloseMIDIStream (EAS_DATA_HANDLE pEASData, EAS_HANDLE /*---------------------------------------------------------------------------- * EAS_Locate() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Locate into the file associated with the handle. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file handle - * milliseconds - playback offset from start of file in milliseconds - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file handle + * milliseconds - playback offset from start of file in milliseconds + * * Outputs: - * + * * * Side Effects: * the actual offset will be quantized to the closest update period, typically @@ -730,12 +730,12 @@ EAS_PUBLIC EAS_RESULT EAS_Locate (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHan /*---------------------------------------------------------------------------- * EAS_GetRenderTime() *---------------------------------------------------------------------------- - * Purpose: - * Returns the current playback offset + * Purpose: + * Returns the current playback offset * * Inputs: - * pEASData - pointer to overall EAS data structure - * + * pEASData - pointer to overall EAS data structure + * * Outputs: * Gets the render time clock in msecs. * @@ -748,13 +748,13 @@ EAS_PUBLIC EAS_RESULT EAS_GetRenderTime (EAS_DATA_HANDLE pEASData, EAS_I32 *pTim /*---------------------------------------------------------------------------- * EAS_GetLocation() *---------------------------------------------------------------------------- - * Purpose: - * Returns the current playback offset + * Purpose: + * Returns the current playback offset * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file handle - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file handle + * * Outputs: * The offset in milliseconds from the start of the current sequence, quantized * to the nearest update period. Actual resolution is typically 5.9 ms. @@ -768,17 +768,17 @@ EAS_PUBLIC EAS_RESULT EAS_GetLocation (EAS_DATA_HANDLE pEASData, EAS_HANDLE stre /*---------------------------------------------------------------------------- * EAS_Pause() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Pauses the playback of the data associated with this handle. The audio * is gracefully ramped down to prevent clicks and pops. It may take several * buffers of audio before the audio is muted. * * Inputs: - * psEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * + * psEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * * Outputs: - * + * * * Side Effects: * @@ -790,16 +790,16 @@ EAS_PUBLIC EAS_RESULT EAS_Pause (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHand /*---------------------------------------------------------------------------- * EAS_Resume() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Resumes the playback of the data associated with this handle. The audio * is gracefully ramped up to prevent clicks and pops. * * Inputs: - * psEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * + * psEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * * Outputs: - * + * * * Side Effects: * @@ -811,18 +811,18 @@ EAS_PUBLIC EAS_RESULT EAS_Resume (EAS_DATA_HANDLE pEASData, EAS_HANDLE streamHan /*---------------------------------------------------------------------------- * EAS_GetParameter() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the parameter of a module. See E_MODULES for a list of modules * and the header files of the modules for a list of parameters. * * Inputs: - * psEASData - pointer to overall EAS data structure - * module - enumerated module number - * param - enumerated parameter number - * pValue - pointer to variable to receive parameter value - * + * psEASData - pointer to overall EAS data structure + * module - enumerated module number + * param - enumerated parameter number + * pValue - pointer to variable to receive parameter value + * * Outputs: - * + * * * Side Effects: * @@ -834,19 +834,19 @@ EAS_PUBLIC EAS_RESULT EAS_GetParameter (EAS_DATA_HANDLE pEASData, EAS_I32 module /*---------------------------------------------------------------------------- * EAS_SetParameter() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Set the parameter of a module. See E_MODULES for a list of modules * and the header files of the modules for a list of parameters. * * Inputs: - * psEASData - pointer to overall EAS data structure - * handle - file or stream handle - * module - enumerated module number - * param - enumerated parameter number - * value - new parameter value - * + * psEASData - pointer to overall EAS data structure + * handle - file or stream handle + * module - enumerated module number + * param - enumerated parameter number + * value - new parameter value + * * Outputs: - * + * * * Side Effects: * @@ -855,18 +855,18 @@ EAS_PUBLIC EAS_RESULT EAS_GetParameter (EAS_DATA_HANDLE pEASData, EAS_I32 module */ EAS_PUBLIC EAS_RESULT EAS_SetParameter (EAS_DATA_HANDLE pEASData, EAS_I32 module, EAS_I32 param, EAS_I32 value); -#ifdef _METRICS_ENABLED +#ifdef _METRICS_ENABLED /*---------------------------------------------------------------------------- * EAS_MetricsReport() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Displays the current metrics through the EAS_Report interface. * * Inputs: - * pEASData - instance data handle - * + * pEASData - instance data handle + * * Outputs: - * + * * * Side Effects: * @@ -877,14 +877,14 @@ EAS_PUBLIC EAS_RESULT EAS_MetricsReport (EAS_DATA_HANDLE pEASData); /*---------------------------------------------------------------------------- * EAS_MetricsReset() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Displays the current metrics through the EAS_Report interface. * * Inputs: - * pEASData - instance data handle - * + * pEASData - instance data handle + * * Outputs: - * + * * * Side Effects: * @@ -896,16 +896,16 @@ EAS_PUBLIC EAS_RESULT EAS_MetricsReset (EAS_DATA_HANDLE pEASData); /*---------------------------------------------------------------------------- * EAS_SetSoundLibrary() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Sets the location of the sound library. * * Inputs: - * pEASData - instance data handle - * streamHandle - file or stream handle - * pSoundLib - pointer to sound library - * + * pEASData - instance data handle + * streamHandle - file or stream handle + * pSoundLib - pointer to sound library + * * Outputs: - * + * * * Side Effects: * @@ -926,8 +926,8 @@ EAS_PUBLIC EAS_RESULT EAS_SetSoundLibrary (EAS_DATA_HANDLE pEASData, EAS_HANDLE * it make take slightly longer to process the EAS_OpenFile request. * * Inputs: - * pEASData - instance data handle - * searchFlag - search flag (EAS_TRUE or EAS_FALSE) + * pEASData - instance data handle + * searchFlag - search flag (EAS_TRUE or EAS_FALSE) *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_SetHeaderSearchFlag (EAS_DATA_HANDLE pEASData, EAS_BOOL searchFlag); @@ -940,9 +940,9 @@ EAS_PUBLIC EAS_RESULT EAS_SetHeaderSearchFlag (EAS_DATA_HANDLE pEASData, EAS_BOO * default play mode (usually straight playback) is always zero. * * Inputs: - * pEASData - instance data handle - * handle - file or stream handle - * playMode - play mode (see eas_types.h for enumerations) + * pEASData - instance data handle + * handle - file or stream handle + * playMode - play mode (see eas_types.h for enumerations) *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_SetPlayMode (EAS_DATA_HANDLE pEASData, EAS_HANDLE pStream, EAS_I32 playMode); @@ -951,16 +951,16 @@ EAS_PUBLIC EAS_RESULT EAS_SetPlayMode (EAS_DATA_HANDLE pEASData, EAS_HANDLE pStr /*---------------------------------------------------------------------------- * EAS_LoadDLSCollection() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Downloads a DLS collection * * Inputs: - * pEASData - instance data handle - * streamHandle - file or stream handle - * locator - file locator - * + * pEASData - instance data handle + * streamHandle - file or stream handle + * locator - file locator + * * Outputs: - * + * * * Side Effects: * May overlay instruments in the GM sound set @@ -973,15 +973,15 @@ EAS_PUBLIC EAS_RESULT EAS_LoadDLSCollection (EAS_DATA_HANDLE pEASData, EAS_HANDL /*---------------------------------------------------------------------------- * EAS_SetFrameBuffer() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Sets the frame buffer pointer passed to the IPC communications functions * * Inputs: - * pEASData - instance data handle - * locator - file locator - * + * pEASData - instance data handle + * locator - file locator + * * Outputs: - * + * * * Side Effects: * May overlay instruments in the GM sound set @@ -994,41 +994,41 @@ EAS_PUBLIC EAS_RESULT EAS_SetFrameBuffer (EAS_DATA_HANDLE pEASData, EAS_FRAME_BU /*---------------------------------------------------------------------------- * EAS_RegExtAudioCallback() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Registers callback functions for audio events. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * cbProgChgFunc - pointer to host callback function for program change - * cbEventFunc - pointer to host callback functio for note events - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * cbProgChgFunc - pointer to host callback function for program change + * cbEventFunc - pointer to host callback functio for note events + * * Outputs: - * + * * * Side Effects: * *---------------------------------------------------------------------------- */ EAS_PUBLIC EAS_RESULT EAS_RegExtAudioCallback (EAS_DATA_HANDLE pEASData, - EAS_HANDLE streamHandle, - EAS_VOID_PTR pInstData, - EAS_EXT_PRG_CHG_FUNC cbProgChgFunc, - EAS_EXT_EVENT_FUNC cbEventFunc); + EAS_HANDLE streamHandle, + EAS_VOID_PTR pInstData, + EAS_EXT_PRG_CHG_FUNC cbProgChgFunc, + EAS_EXT_EVENT_FUNC cbEventFunc); /*---------------------------------------------------------------------------- * EAS_GetMIDIControllers() *---------------------------------------------------------------------------- - * Purpose: + * Purpose: * Returns the current state of MIDI controllers on the requested channel. * * Inputs: - * pEASData - pointer to overall EAS data structure - * streamHandle - file or stream handle - * pControl - pointer to structure to receive data - * + * pEASData - pointer to overall EAS data structure + * streamHandle - file or stream handle + * pControl - pointer to structure to receive data + * * Outputs: - * + * * * Side Effects: * @@ -1044,11 +1044,11 @@ EAS_PUBLIC EAS_RESULT EAS_GetMIDIControllers (EAS_DATA_HANDLE pEASData, EAS_HAND * position. Returns offset to start of sequence. * * Inputs: - * pEASData - pointer to EAS persistent data object - * fileHandle - file handle - * searchString - pointer to search sequence - * len - length of search sequence - * pOffset - pointer to variable to store offset to sequence + * pEASData - pointer to EAS persistent data object + * fileHandle - file handle + * searchString - pointer to search sequence + * len - length of search sequence + * pOffset - pointer to variable to store offset to sequence * * Returns EAS_EOF if end-of-file is reached *---------------------------------------------------------------------------- |