Sound output status

The following constants are play method.

These constants are used 'ADXT_CALC_WORK' macro

nch: maximum number of playback (monaural:1, stereo:2)

stmflg: playback mode

ADXT_PLY_MEM: memory playback

ADXT_PLY_STM: stream playback

nstm: maximum number of DISC streams

sfreq: maximum playback sampling frequency

None.

Work area size (bytes)

Calculates the work area size for each ADXT handle.

The maximum number of DISC streams specifies the number of streams that can be read from DISC simultaneously.

When reading from DISC, this is the sum of ADXT handles used simultaneously.

The work area size calculation formula is as follows.

work area = input buffer size + output buffer size

(sampling frequency 48000Hz, mono)

*1 For stereo playback, double the area is required.

*2 The input buffer can be reduced according to the sampling frequency.

stmflg: playback mode

ADXT_PLY_MEM: memory playback

ADXT_PLY_STM: stream playback

nstm: maximum number of DISC streams

sfreq: maximum playback sampling frequency

None.

Work area size (bytes)

Calculates the work area size for each ADXT handle.

The maximum number of DISC streams specifies the number of streams that can be read from DISC simultaneously.

When reading from DISC, this is the sum of ADXT handles and ADXF handles used simultaneously.

ADXT handle controls ADX playback.

It is generated by the ADXT_Creat function.

None.

None.

None.

Initializes the ADX library.

Registers the server function with the Vsync interrupt.

None.

None.

None.

Performs shutdown processing for the ADX library. Deletes created handles

/* ADX library initialization */
ADXT_Init();
    :
/* ADX library finalization */
ADXT_Finish();

maxnch: maximum number of playback channels (mono=1, stereo=2)

work: work area

worksize: work area size

None.

Pointer to generated ADXT structure element (ADXT handle)

Creates an ADXT handle.

maxnch should be set to "1" for mono playback only and to "2" for stereo playback.

Also when maxnch is set to "2", mono playback is possible.

The work area is allocated by the syMalloc function.

adxt: ADXT handle

None.

None.

Deletes the specified ADXT handle.

/* work area size */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];    /* work area */
ADXT adxt;              /* ADXT handle */


/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
    :
ADXT_Destroy(adxt);/* delete ADXT handle */

None.

None.

None.

Deletes the all ADXT handle.

adxt: ADXT handle

fnmae: sound file name

None.

None.

Starts playback of file specified by fname. When the function is executed for a handle that is already being played, sound output stops and playback of the specified file starts. ADX files and WAV files can be specified as sound files. By executing the function for different handles, several sound files can be played simultaneously.

/* playing back 1 stream of 48 kHz stereo data */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];    /* work area */
ADXT adxt;              /* ADXT handle */


/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "MUSIC.ADX");
    :
/* Start playback */
ADXT_StartFname(adxt, "SE2.WAV");
    :

adxt: ADXT handle

fname: sound file name

offset_sct:offset[sector]

range_sct:size[sector]

None.

None.

Starts playback of file specified by fname and the range.

adxt: ADXT handle

adxdat: sound data address

None.

None.

Plays sound data in memory specified by adxdat. Allows sound playback with better response than DISC stream playback. Delay time is approx. 50 milliseconds.

/* When playing mono data */
#define WKSIZE ADXT_CALC_WORK(1, ADXT_PLY_MEM, 0, 0)


Uint8 *work[WKSIZE];        /* work area */
Uint8 adxdat[ADXDAT_SIZE];  /* data area */
ADXT adxt;                  /* ADXT handle */


/* read sound data */
load_data(adxdat);
/* Create ADXT handle */
adxt = ADXT_Create(1, work, WKSIZE);
/* Start playback */
ADXT_StartMem(adxt, adxdat);
  :

adxt: ADXT handle

adxdat: sound data address

datlen: Length of playing ADX data

None.

None.

Plays sound data in memory specified by adxdat. Plays to specified length.

adxt: ADXT handle

acxdat: ACX data address

no: index number

None.

None.

Plays data of specified number within ACX data.

/* mono data playback */
#define WKSIZE ADXT_CALC_WORK(1, ADXT_PLY_MEM, 0, 0)


Uint8 *work[WKSIZE];       /* work area */
Uint8 acxdat[ADXDAT_SIZE]; /* data area */
ADXT adxt;                 /* ADXT handle */


/* read sound data */
load_data(acxdat);
/* Create ADXT handle */
adxt = ADXT_Create(1, work, WKSIZE);
/* Start playback */
ADXT_StartMem(adxt, acxdat, 5);
    :
/* Start playback */
ADXT_StartMem(adxt, acxdat, 8);
    :

adxt: ADXT handle

pat_id: partition ID

file_id: file ID

None.

None.

Plays data from AFS file on the disc.

The ADXF_LoadPartitionNw function serves for correlating the par_id and the AFS file name. The file_id refers to the sequential number inside the AFS file.

AFSLNK.EXE outputs a header file specifying the file ID. A message corresponding to the file name can also be specified.

/* simultaneous playback of 48 kHz stereo and 24 kHz mono */
/* 48 kHz stereo playback work area */
#define WKSIZE48 ADXT_CALC_WORK(2, ADXT_PLY_STM, 2, 48000)
/* 24 kHz mono playback work area */
#define WKSIZE24 ADXT_CALC_WORK(1, ADXT_PLY_STM, 2, 24000)
/* maximum number of files in partition */
#define MAX_NFILES 10000


/* partition information area */
Uint8 ptinfo[ADXF_CALC_PTINFO_SIZE(MAX_NFILES)];
Uint8 *work1[WKSIZE48];  /* work area */
Uint8 *work2[WKSIZE24];  /* work area */
ADXT adxt1, adxt2;       /* ADXT handle */


/* partition information read-in */
ADXF_LoadPartitionNw(PAT01, "pat01.afs", NULL, ptinfo);
for (;;) {
    if (ADXF_GetPtStat(PAT01) == ADXF_STAT_READEND) {
        break;
    }


    /* Server function */
    ADXM_ExecMain();
}


/* create ADXT handles */
adxt1 = ADXT_Create(2, work1, WKSIZE48);
adxt2 = ADXT_Create(1, work2, WKSIZE24);
/* Start playback */
ADXT_StartAfs(adxt1, PATID, BGM);
    :
/* Start playback */
ADXT_StartAfs(adxt1, PATID, SRF137);
    :

adxt: ADXT handle

sj: Stream Joint

None.

None.

Plays data of specified Stream Joint.

adxt: ADXT handle

None.

None.

Stops ADX playback.

/* 48 kHz stereo data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];  /* work area */
ADXT adxt;            /* ADXT handle */


/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "MUSIC.ADX");
    :
/* button pressed for stop */
if (PRESSED(Button)) {
    /* stop playback */
    ADXT_Stop(adxt);
      :

adxt: ADXT handle

None.

Operation status of current ADXT handle

Gets current operation condition of adxt.

Possible status modes are as follows.

/* 48 kHz mono data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(1, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];  /* work area */
ADXT adxt;            /* ADXT handle */
Sint32 stat;          /* operation status */


/* Create ADXT handle */
adxt = ADXT_Create(1, work, WKSIZE);
/* Start playback */
ADXT_StartAfs(adxt, pat_id, 0);


for (;;) {
    /* activate animation while sound is produced */
    stat = ADXT_GetStat(adxt);
    if (stat == ADXT_STAT_PLAYING || stat == ADXT_STAT_DECEND) {
        user_animate_obj();
    }


    /* play next sound when playback ends */
    if (stat == ADXT_STAT_PLAYEND) {
        ADXT_StartAfs(adxt, pat_id, 1);
    }


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

ncount: playback sample number

tscale:sampling frequency [Hz]

None.

Gets playback time in sample units.

/* 48 kHz stereo data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];          /* work area */
ADXT adxt;                    /* ADXT handle */
Sint32 nsmpl, sfreq;          /* playback time */
Sint32 nfrm, hh, mm, ss, ff;  /* time */


/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "music.adx");


for (;;) {
    /* playback time display (frame unit 1/60) */
    ADXT_GetTime(adxt, &nsmpl, &sfreq);
    nfrm = (Sint32)((Float32)nsmpl / (Float32)sfreq * 60.0f);
    hh = nfrm / (60*60*60);/* hours */
    mm = (nfrm - hh*60*60*60) / (60*60);/* minutes */
    ss = (nfrm - (hh*60+mm)*60*60) / 60;/* seconds */
    ff = nfrm % 1000;/* frames */
    disp_time(hh, mm, ss, ff);


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

None.

Playback time [1/100sec]

Gets playback time in real time, using units of 1/100 seconds.

/* 48 kHz stereo data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];   /* work area */
ADXT adxt;             /* ADXT handle */
Sint32 time;           /* playback time */
Sint32 hh, mm, ss, ff; /* time */


adxt = ADXT_Create(2, work, WKSIZE); /* Create ADXT handle */
ADXT_StartFname(adxt, "music.adx");  /* Start playback */
    :
for (;;) {
    /* playback time display (frame unit 1/100) */
    time = ADXT_GetTimeReal(adxt);
    hh = time / (60*60*100);/* hours */
    mm = (time - hh*60*60*100)/(60*100);/* minutes */
    ss = (time - (hh*60+mm)*60*100)/100;/* seconds */
    ff = time % 100;/* frames */


    /* display time */
    disp_time(hh, mm, ss, ff);


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

sw: pause switch (1 = pause, 0 = resume)

None.

None.

Carries out playback pause and resume. When the switch is set to 1, play pauses; when the switch is set to 0, play resumes. When pause is set when playback is in the STOP state, sound cannot be played back even if the start function is run. When pause is set in the PLAYING state, playback pauses. By releasing pause in the PLAYING state, sound instantly plays back.

(1)pause
/* Playback for only one stream of 48Khz stereo data */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];      /* work area */
ADXT adxt;                /* ADXT handle */
Sint32 pause_flag = 0;    /* pause flag */


/* ADXT handle creation */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "music.adx");


for (;;) {
    if (PRESSED(Button)) {
        if (pause_flag == 0) {
            /* pause */
            pause_flag = 1;
        } else {
            /* resume */
            pause_flag = 0
        }
        ADXT_Pause(adxt, pause_flag);
    }


    /* Server function */
    ADXM_ExecMain();
}




(2)Immediately playing back sound data on the disc
/* ADXT handle creation */
adxt = ADXT_Create(2, work, WKSIZE);
/* pause */
ADXT_Pause(adxt, 1);
/* playback start */
ADXT_StartFname(adxt, "music.adx");


/* Sound is not played back, state is PLAYING */
for (;;) {
    /* When the button is pressed, sound is immediately output */
    if (PRESSED(Button)) {
        ADXT_Pause(adxt, 0);
    }


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

None.

1=pause, 0=not pause

Obtains the status of pause.

adxt: ADXT handle

vol:attenuation level (from 0: 0dB to -960: -96.0dB)

None.

None.

Sets the output volume. Can be used before or during playback.

vol setting values0:-0dB no attenuation (maximum)

-30:-3dB approx. 70%

-60:-6dB approx. 50%

-960:-96dB mute

adxt: ADXT handle

None.

Output volume setting value (from 0: 0dB to -960: -96.0dB)

Gets the output volume setting.

/* 48 kHz stereo data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE]; /* work area */
ADXT adxt;           /* ADXT handle */
Sint32 vol;          /* current volume */
Sint32 fade_vol;     /* fader range */


/* set fade time as 3 seconds */
fade_vol = 960 / (60 * 3);
    :
/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "music.adx");


for (;;) {
    /* fade-in */
    if (PRESSED(Button1)) {
        vol = ADXT_GetOutVol(adxt);
        ADXT_SetOutVol(adxt, vol+fade_vol);
    }
    /* fade-out */
    if (PRESSED(Button2)) {
        vol = ADXT_GetOutVol(adxt);
        ADXT_SetOutVol(adxt, vol-fade_vol);
    }


    /* Server function */
    ADXM_ExecMain();
}

adxt:ADXT handle

ch: channel number (0 or 1)

ADXT_CH_L(0)=left channel, ADXT_CH_R(1)=right channel

pan: panpot setting value (from -15 to +15, -128)

ADXT_PAN_LEFT = -15, ADXT_PAN_CENTER = 0

ADXT_PAN_RIGHT = 15, ADXT_PAN_AUTO = -128

None.

None.

Sets the output panpot.

When the setting is AUTO, panning is performed automatically, depending on whether the sound data are mono or stereo. This setting can be made also during sound playback.

adxt: ADXT handle

ch: channel number

ADXT_CH_L(0): left channel, ADXT_CH_R(1): right channel

None.

Panpot setting value (from -15 to +15, -128)

Gets the output panpot setting.

/* 48 kHz mono data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(1, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE]; /* work area */
ADXT adxt;           /* ADXT handle */
Sint32 pan;          /* current panpot value */


/* Create ADXT handle */
adxt = ADXT_Create(1, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "srf01.adx");


for (;;) {
    if (PRESSED(Button1)) {              /* shift panpot to right */
        pan = ADXT_GetOutPan(adxt, 0);
        pan = min(ADXT_PAN_RIGHT, pan+1);
        ADXT_SetOutPan(adxt, 0, pan);
    }
    if (PRESSED(Button2)) {              /* shift panpot to left */
        pan = ADXT_GetOutPan(adxt, 0);
        pan = max(ADXT_PAN_LEFT, pan-1);
        ADXT_SetOutPan(adxt, 0, pan);
    }


    /* Server function */
    ADXM_ExecMain();
}

flag: monaural output flag (OFF=0, ON=1)

None.

None.

Sets the monaural output.

When the setting is ON, all stereo data is outputted as monaural data. Both channel data is mixed down.

adxt: ADXT handle

flg: 1=loop, 0=not loop

None.

None.

Sets whether play a loop or not.

You can only release looping play while playing.

If you set this flag again, you have to set just before start playing.

adxt: ADXT handle

None.

Number of times played a loop

Obtains the number of times that played a loop.

adxt: ADXT handle

flg: 1=waits, 0=starts to output sound

None.

None.

Sets waiting for starting to output the sound.

adxt: ADXT handle

None.

Total number of sound data samples

Gets total number of sound data samples for current playback.

This information can be obtained in the interval extending from playback preparation (ADXT_STAT_PREP = 2) to playback end (ADXT_STAT_PLAYEND = 5).

/* 48 kHz stereo data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE]; /* work area */
ADXT adxt;           /* ADXT handle */
Sint32 total_nsmpl;  /* total number of sample */
Sint32 nsmpl, sfreq; /* playback time */
Sint32 percent;      /* percent */


/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "music.adx");


for (;;) {
    /* display playback progress (percent) */
    if ( ADXT_GetStat(adxt) >= ADXT_STAT_PREP ) {
        total_nsmpl = ADXT_GetNumSmpl(adxt);
        ADXT_GetTime(adxt, &nsmpl, &sfreq);
        percent = nsmpl * 100 / total_nsmpl;
    } else {
        percent = 0;
    }
    disp_progress(percent);


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

None.

Number of samples decoded

Obtains a decoded sample number of sound data.

This information can be obtained in the interval extending from playback preparation (ADXT_STAT_PREP) to playback end (ADXT_STAT_PLAYEND).

adxt: ADXT handle

None.

Sound data sampling frequency [Hz]

Gets sampling frequency of currently playing sound data.

This information can be obtained in the interval extending from playback preparation (ADXT_STAT_PREP = 2) to playback end (ADXT_STAT_PLAYEND = 5).

/* 48 kHz stereo data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];  /* work area */
ADXT adxt;            /* ADXT handle */
Sint32 sfreq;         /* sampling frequency */


/* Create ADXT handle */
adxt = ADXT_Create(2, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "music.adx");
for (;;) {
    /* get sampling frequency (Hz) */
    if (ADXT_GetStat(adxt) >= ADXT_STAT_PREP) {
        sfreq = ADXT_GetSfreq(adxt);
    }


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

None.

Number of channels

Gets sampling frequency of currently playing sound data.

This information can be obtained in the interval extending from playback preparation (ADXT_STAT_PREP) to playback end (ADXT_STAT_PLAYEND).

adxt: ADXT handle

None.

Number of quantization bits

Gets the number of quantization bits of currently playing sound data.

This information can be obtained in the interval extending from playback preparation (ADXT_STAT_PREP) to playback end (ADXT_STAT_PLAYEND).

adxt: ADXT handle

None.

Header length

Gets header length of currently playing sound data.

This information can be obtained in the interval extending from playback preparation (ADXT_STAT_PREP) to playback end (ADXT_STAT_PLAYEND).

adxt: ADXT handle

None.

Stream Joint

Obtains Stream Joint for the input.

adxt: ADXT handle

None.

Number of sector

Obtains the amount of data that is stored in input buffer.

adxt: ADXT handle

None.

Playable time (sec)

Obtains playable time using only data in input buffer.

You can use this function only playing ADX data.

adxt: ADXT handle

None.

1=Has enough data, 0=Data are insufficient

Checks whether the input buffer is having enough data or not.

Returns 'TRUE' when data more than the number of sector appointed exist in the input buffer.

adxt: ADXT handle

chno: channel (0=left channel, 1=right channel)

None.

Number of samples in an output buffer

Obtains the number of samples in an output buffer.

adxt: ADXT handle

None.

1=read is in progress, 0=read is stopped

Obtains current status of file read.

adxt: ADXT handle

None.

None.

Checks whether ADXT handle was preparations completion.

adxt: ADXT handle

None.

1=Finished, 0=Playing

Checks whether the play finished or not.

adxt: ADXT handle

time: start remain time

nch: number of channel

sfreq: sampling frequency

None.

None.

Sets of the time of start sector to reload into input buffer.

Reads data from disc when a quantity of data in the input buffer becomes less than 'time' (second).

adxt: ADXT handle

minsct: start sector number

None.

None.

Sets of the number of start sector to reload into input buffer.

Reads data from disc when a quantity of data in the input buffer becomes less than 'minsct' (sector).

num: the number of retry(-1: infinite retry)

None.

None.

Sets the number of retry inside ADX regardless of hardware.

None.

None.

the number of retry(-1: infinite retry)

Gets the number of retry set by ADXT_SetNumRetry function.

adxt : ADXT handle

None.

the number of error

Gets the number of error occurrences that needs retry.

freq: server function call frequency (number of calls per second)

None.

None.

Sets the call frequency for the server function (ADXT_ExecServer function).

This function can be used to control the amount of decoding performed by each server function.

The default setting is 60 (Vsync).

This function is not required because the server function is called by the Vsync interrupt.

adxt: ADXT handle

freq: server function call frequency (number of calls per second)

None.

None.

Sets the call frequency for the server function (ADXT_ExecServer function).

This function can be used to control the amount of decoding performed by each server function.

The default setting is 60 (Vsync).

This function is not required because the server function is called by the Vsync interrupt.

None.

None.

None.

Updates the internal status of the library and performs decoding processing.

Because the ADXT_Init function registers Vsync interrupt processing, the user does not need to call this function.

None.

None.

None.

Updates the internal status of an ADXT handle.

Because this function is called from 'ADXT_ExecServer' function, the user does not need to call this function.

adxt: ADXT handle

None.

Error code

Gets error code.

This value is held until cleared by the ADXT_ClearErrCode function.

Error code table

adxt: ADXT handle

None.

None.

Clears error code.

/* 48 kHz mono data 1 stream playback */
#define WKSIZE ADXT_CALC_WORK(1, ADXT_PLY_STM, 1, 48000)


Uint8 *work[WKSIZE];  /* work area */
ADXT adxt;            /* ADXT handle */
Sint32 errcode;       /* error code */


/* Create ADXT handle */
adxt = ADXT_Create(1, work, WKSIZE);
/* Start playback */
ADXT_StartFname(adxt, "srf01.adx");


for (;;) {
    errcode = ADXT_GetErrCode(adxt);
    if ( errcode != ADXT_ERR_OK ) {
        ADXT_ClearErrCode(adxt);
        ADXT_Stop(adxt);
    }


    /* Server function */
    ADXM_ExecMain();
}

adxt: ADXT handle

fname:Audio file name

None.

None.

Registers the audio file specified by "fname" as a file for seamless continuous playback. Only ADX data with no loop settings can be registered.

/* ADXT handle creation */
adxt = ADXT_Create(1, adxt_work, ADXT_WKSIZE);


/* Register ADX file */
ADXT_EntryFname(adxt, "smpsl1.adx");
ADXT_EntryFname(adxt, "smpsl2.adx");
ADXT_EntryFname(adxt, "smpsl3.adx");


/* Set loop */
ADXT_SetSeamlessLp(adxt, 1);
/* Start seamless */
ADXT_StartSeamless(adxt);

adxt: ADXT handle

fname:Audio file name

offset_sct:offset[sector]

range_sct:size[sector]

None.

None.

Registers the audio file specified by filename and the range for seamless continuous playback.

adxt: ADXT handle

patid: partition ID

fid: file ID

None.

None.

Registers AFS file as seamless continuous playback data.

adxt: ADXT handle

None.

None.

Reset file registration of seamless continuous playback.

This function can be used only when playback has stopped (ADXT_STAT_STOP).

adxt: ADXT handle

None.

None.

Starts seamless continuous playback.

adxt: ADXT handle

flg:0=Loop playback off, 1=Loop playback on.

None.

None.

Sets seamless loop playback.

adxt: ADXT handle

fname:Audio file name

None.

None.

Plays back the specified audio file repeatedly.

adxt: ADXT handle

fname:Audio file name

offset_sct:offset[sector]

range_sct:size[sector]

None.

None.

Plays back the specified filename and the range.

adxt: ADXT handle

None.

None.

Ends seamless continuous playback.

adxt: ADXT handle

None.

Number of files registered

Gets the number of files that have been registered.

adxt: ADXT handle

work: working area for AHX

worksize: size of AHX working area(byte)

None.

None.

Attach AHX function.

Using this function, it becomes possible to playback an AHX file.

adxt: ADXT handle

None.

None.

Detach AHX function.

Unuse of AHX is attained.

/* Calculation of work size */
#define ADXWKSZ ADXT_CALC_WORK(2, ADXT_PLY_STM, 1, 48000)
#define AHXWKSZ ADXT_WORKSIZE_AHX


Uint8 adxwk[ADXWKSZ];  /* work area for ADX */
Uint8 ahxwk[AIXWKSZ];  /* work area for AHX */
ADXT adxt;             /* ADXT handle */


/* Create ADXT handle */
adxt = ADXT_Create(2, adxwk, ADXWKSZ);
/* Attach AHX function */
ADXT_AttachAhx(adxt, ahxwk, AHXWKSZ);
    :
/* Detach AHX function */
ADXT_DetachAhx(adxt);
/* Delete ADXT handle */
ADXT_Destroy(adxt);

str: key strings

None.

None.

Sets default key strings. You have to input the same key strings as the key strings input at the time of encoding. When a different key strings from the time of encoding is input, it will become a noise and will be reproduced. NULL is specified to be 'str' when reproducing the ADX data which is not enciphered.

/* Set key strings */
ADXT_SetDefKeyString("CRI");


/* ADXT handle creation */
adxt = ADXT_Create(2, work, WKSIZE);


/* Start playback */
ADXT_StartFname(adxt, "MUSIC.ADX");
    :

adxt: ADXT handle

str: key strings

None.

None.

Sets key strings to each handle. You have to input the same key ode as the key strings input at the time of encoding. When a different key strings from the time of encoding is input, it will become a noise and will be reproduced. NULL is specified to be 'str' when reproducing the ADX data which is not enciphered.

/* ADXT handle creation */
adxt = ADXT_Create(2, work, WKSIZE);


/* Set key strings */
ADXT_SetDefKeyString(adxt, "CRI");


/* Start playback */
ADXT_StartFname(adxt, "MUSIC.ADX");
    :

adxt: ADXT handle

None.

Default volume(0:-0dB ... -960:-96.0dB)

Gets default volume included in the ADX data.

adxt: ADXT handle

chno: Channel number

ADXT_CH_L(0):Left channel, ADXT_CH_R(1):Right channel

None.

Default panpot(-15:left ... 0:center ... +15:right)

Gets default panpot included in the ADX data.

adxt: ADXT handle

None.

The data ID

Gets the data ID included in the ADX data.

stmflg: playback mode

ADXT_PLY_MEM: memory playback

ADXT_PLY_STM: stream playback

nstm: maximum number of DISC streams

sfreq: maximum playback sampling frequency

None

Work area size [bytes]

Calculates the work area size for each ADXT handle.

The maximum number of DISC streams specifies the number of streams that can be read from DISC simultaneously.

When reading from DISC, this is the sum of ADXT handles and ADXF handles used simultaneously.

work: work area

worksize: work area size

None.

Pointer to generated ADXT structure element (ADXT handle)

Creates an ADXT handle.

ADXT handle created using this function supports surround panning.

The work area size is calculated by ADXT_CALC_WORK_3D macro.

adxt: ADXT handle

x: x-coordinate (-127:left...0:center...+127:right)

y: y-coordinate (-127:front...0:center...+127:rear)

None.

None.

Sets the position of sound source.

This function is usable only for ADXT handle which was created by ADXT_Create3D function. And, this function has an effect only for mono ADX playback (stereo panning is not supported).

NOTE: Hardware decoder (which supports Dolby Digital or Dolby Pro Logic II) is required in order to preview the 3D sound.

tprm: parameter structure of ADX thread

None.

None.

Sets up ADX thread system. Creates thread and registers ADX server function.in Vsync thread.

Please call ADXM_SetupThrd() in front of ADXT_Init().

/* Setup threads */
ADXM_SetupThrd(NULL);


/* ADX library initialization */
ADXT_Init();
    :
for (;;) {
    /* Wait Vsync */
    ADXM_WaitVsync();


    /* Server function */
    ADXM_ExecMain();
        :
}

This function exists only for compatibility. You should use the ADXM_SetupFramework function rather than this function.

None.

None.

None.

Shuts down ADX thread system. Deletes thread that was created by ADXM_SetupThrd function.

This function exists only for compatibility. You should use the ADXM_ShutdownFramework function rather than this function.

None.

None.

None.

Updates the internal status of the library.

Application must call this function in main loop periodically.

/* Setup framework */
ADXM_SetupFramework(ADXM_FRAMEWORK_DEFAULT, NULL);


/* ADX library initialization */
ADXT_Init();
    :
for (;;) {
    /* Wait Vsync */
    ADXM_WaitVsync();


    /* Server function */
    ADXM_ExecMain();
        :
}

None.

None.

None.

Waits for the next Vsync. The main thread sleeps while it is waiting, and the processing time is given to the idle thread.

When Sofdec is reproducing, Sofdec decodes by the idle thread while executing this function.

Please do not use this function in the case of single thread framework.

/* Setup framework */
ADXM_SetupFramework(ADXM_FRAMEWORK_DEFAULT, NULL);


/* ADX library initialization */
ADXT_Init();
    :
for (;;) {
    /* Wait Vsync */
    ADXM_WaitVsync();


    /* Server function */
    ADXM_ExecMain();
        :
}

func: user callback function

obj: 1st argument of callback function

None.

None.

Registers an error callback function.

When an error occurs, the registered function is called in the following format.

void (*func)(*obj, char *emsg);

The 1st argument (obj) of this function becomes the 2nd argument of the ADXM_SetCbErr function. The second argument (emsg) is the error message. Because this function is intended for debugging purposes, it should be replaces with a do-nothing function during mastering.

void user_adx_error(void *obj, char *msg)
{
    /* On debugging, pause process and solve problems */
    ...
}


void main(void)
{
    /* Register error callback */
    ADXM_SetCbErr(user_adx_error, NULL);
       :
}