asndlib.h

Go to the documentation of this file.

/* ASNDLIB -> accelerated sound lib using the DSP

Copyright (c) 2008 Hermes <www.entuwii.net>
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this list of
  conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list
  of conditions and the following disclaimer in the documentation and/or other
  materials provided with the distribution.
- The names of the contributors may not be used to endorse or promote products derived
  from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __ASNDLIB_H__
#define __ASNDLIB_H__

#define __SNDLIB_H__

#define ASND_LIB 0x100
#define SND_LIB  (ASND_LIB+2)

#include <gctypes.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SND_OK               0
#define SND_INVALID         -1
#define SND_ISNOTASONGVOICE -2
#define SND_BUSY             1

#define SND_UNUSED   0   
#define SND_WORKING  1   
#define SND_WAITING  2   
#define VOICE_MONO_8BIT       0
#define VOICE_MONO_16BIT      1
#define VOICE_MONO_16BIT_BE   1
#define VOICE_STEREO_8BIT     2
#define VOICE_STEREO_16BIT    3
#define VOICE_STEREO_16BIT_BE 3
#define VOICE_MONO_8BIT_U     4
#define VOICE_MONO_16BIT_LE   5
#define VOICE_STEREO_8BIT_U   6
#define VOICE_STEREO_16BIT_LE 7

#define MIN_VOLUME 0
#define MID_VOLUME 127
#define MAX_VOLUME 255

#define MIN_PITCH      1      
#define F44100HZ_PITCH 44100  
#define MAX_PITCH      144000 
#define INIT_RATE_48000

enum
{
NOTE_DO=0,
NOTE_DOs,
NOTE_REb=NOTE_DOs,
NOTE_RE,
NOTE_REs,
NOTE_MIb=NOTE_REs,
NOTE_MI,
NOTE_FA,
NOTE_FAs,
NOTE_SOLb=NOTE_FAs,
NOTE_SOL,
NOTE_SOLs,
NOTE_LAb=NOTE_SOLs,
NOTE_LA,
NOTE_LAs,
NOTE_SIb=NOTE_LAs,
NOTE_SI
};

enum
{
NOTE_C=0,
NOTE_Cs,
NOTE_Db=NOTE_Cs,
NOTE_D,
NOTE_Ds,
NOTE_Eb=NOTE_Ds,
NOTE_E,
NOTE_F,
NOTE_Fs,
NOTE_Gb=NOTE_Fs,
NOTE_G,
NOTE_Gs,
NOTE_Ab=NOTE_Gs,
NOTE_A,
NOTE_As,
NOTE_Bb=NOTE_As,
NOTE_B
};

#define NOTE(note,octave) (note+(octave<<3)+(octave<<2)) 
/*------------------------------------------------------------------------------------------------------------------------------------------------------*/

#define Note2Freq               ANote2Freq
#define SND_Init                ASND_Init
#define SND_End                 ASND_End
#define SND_Pause               ASND_Pause
#define SND_Is_Paused           ASND_Is_Paused
#define SND_GetTime             ASND_GetTime
#define SND_GetSampleCounter    ASND_GetSampleCounter
#define SND_GetSamplesPerTick   ASND_GetSamplesPerTick
#define SND_SetTime             ASND_SetTime
#define SND_SetCallback         ASND_SetCallback
#define SND_GetAudioRate        ASND_GetAudioRate
#define SND_SetVoice            ASND_SetVoice
#define SND_AddVoice            ASND_AddVoice
#define SND_StopVoice           ASND_StopVoice
#define SND_PauseVoice          ASND_PauseVoice
#define SND_StatusVoice         ASND_StatusVoice
#define SND_GetFirstUnusedVoice ASND_GetFirstUnusedVoice
#define SND_ChangePitchVoice    ASND_ChangePitchVoice
#define SND_ChangeVolumeVoice   ASND_ChangeVolumeVoice
#define SND_ChangeVolumeVoice   ASND_ChangeVolumeVoice
#define SND_GetTickCounterVoice ASND_GetTickCounterVoice
#define SND_GetTimerVoice       ASND_GetTimerVoice
#define SND_TestPointer         ASND_TestPointer

/*------------------------------------------------------------------------------------------------------------------------------------------------------*/

typedef void (*ASNDVoiceCallback)(s32 voice);

/*------------------------------------------------------------------------------------------------------------------------------------------------------*/

int ANote2Freq(int note, int freq_base,int note_base);

/*------------------------------------------------------------------------------------------------------------------------------------------------------*/

void ASND_Init();

void ASND_End();

void ASND_Pause(s32 paused);

s32 ASND_Is_Paused();

u32 ASND_GetTime();

u32 ASND_GetSampleCounter();

u32 ASND_GetSamplesPerTick();

void ASND_SetTime(u32 time);

void ASND_SetCallback(void (*callback)());

s32 ASND_GetAudioRate();

// NOTE: I'm keeping this description around because I couldn't fully understand it; if someone else knows exactly what it's doing, they can come around
// and make sure the description is correct.
/* callback: can be NULL or one callback function is used to implement a double buffer use. When the second buffer is empty, the callback is called sending
          the voice number as parameter. You can use "void callback(s32 voice)" function to call ASND_AddVoice() and add one voice to the second buffer.
          NOTE: When callback is fixed the voice never stops and it turn in SND_WAITING status if success one timeout condition.
*/

s32 ASND_SetVoice(s32 voice, s32 format, s32 pitch,s32 delay, void *snd, s32 size_snd, s32 volume_l, s32 volume_r, ASNDVoiceCallback callback);

s32 ASND_SetInfiniteVoice(s32 voice, s32 format, s32 pitch,s32 delay, void *snd, s32 size_snd, s32 volume_l, s32 volume_r);

s32 ASND_AddVoice(s32 voice, void *snd, s32 size_snd);

s32 ASND_StopVoice(s32 voice);

s32 ASND_PauseVoice(s32 voice, s32 pause);

s32 ASND_StatusVoice(s32 voice);

s32 ASND_GetFirstUnusedVoice();

s32 ASND_ChangePitchVoice(s32 voice, s32 pitch);

s32 ASND_ChangeVolumeVoice(s32 voice, s32 volume_l, s32 volume_r);

u32 ASND_GetTickCounterVoice(s32 voice);

u32 ASND_GetTimerVoice(s32 voice);

s32 ASND_TestPointer(s32 voice, void *pointer);

s32 ASND_TestVoiceBufferReady(s32 voice);

u32 ASND_GetDSP_PercentUse();

u32 ASND_GetDSP_ProcessTime();

#ifdef __cplusplus
  }
#endif

#endif