pmd-sky/lib/include/nitro/snd/common/exchannel.h

#ifndef NITRO_SND_COMMON_EX_CHANNEL_H_
#define NITRO_SND_COMMON_EX_CHANNEL_H_

#include <nitro/types.h>
#include <nitro/snd/common/channel.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SND_EX_CHANNEL_PRIO_HIGHEST       255
#define SND_EX_CHANNEL_PRIO_LOWEST        1

#define SND_EX_CHANNEL_RELEASE_PRIO       1
#define SND_EX_CHANNEL_STOP_PRIO          0

#define SND_EX_CHANNEL_USER_PAN_MIN      -128
#define SND_EX_CHANNEL_USER_PAN_MAX       127

#define SND_EX_CHANNEL_ENV_DECAY_SHIFT    7

#define SND_EX_CHANNEL_UPDATE_START      (0x01 << 0)
#define SND_EX_CHANNEL_UPDATE_STOP       (0x01 << 1)
#define SND_EX_CHANNEL_UPDATE_TIMER      (0x01 << 2)
#define SND_EX_CHANNEL_UPDATE_VOLUME     (0x01 << 3)
#define SND_EX_CHANNEL_UPDATE_PAN        (0x01 << 4)

#define SND_LOCK_IMPLIED_ALLOC_CHANNEL   (1 << 0)

struct SNDExChannel;

typedef enum SNDExChannelType {
	SND_EX_CHANNEL_PCM,
	SND_EX_CHANNEL_PSG,
	SND_EX_CHANNEL_NOISE
} SNDExChannelType;

typedef enum SNDExChannelCallbackStatus {
	SND_EX_CHANNEL_CALLBACK_DROP,
	SND_EX_CHANNEL_CALLBACK_FINISH
} SNDExChannelCallbackStatus;

typedef enum SNDEnvStatus {
	SND_ENV_ATTACK,
	SND_ENV_DECAY,
	SND_ENV_SUSTAIN,
	SND_ENV_RELEASE
} SNDEnvStatus;

typedef enum SNDLfoTarget {
	SND_LFO_PITCH,
	SND_LFO_VOLUME,
	SND_LFO_PAN
} SNDLfoTarget;

typedef void (*SNDExChannelCallback) (struct SNDExChannel * ch_p, SNDExChannelCallbackStatus status, void * userData);

#if !(defined(SDK_WIN32) || defined(SDK_FROM_TOOL))
    typedef struct SNDWaveParam {
        u8 format;
        u8 loopflag;
        u16 rate;
        u16 timer;
        u16 loopstart;
        u32 looplen;
    } SNDWaveParam;
#else
    typedef struct SNDWaveParam {
        u8 format;
        u8 loopflag;
        u16 rate;
        u16 timer;
        u32 loopstart;
        u32 looplen;
    } SNDWaveParam;
#endif

typedef struct SNDLfoParam {
	u8 target;
	u8 speed;
	u8 depth;
	u8 range;
	u16 delay;
} SNDLfoParam;

typedef struct SNDLfo {
	struct SNDLfoParam param;
	u16 delay_counter;
	u16 counter;
} SNDLfo;

typedef struct SNDExChannel {
	u8 myNo;
	u8 type;
	u8 env_status;
	u8 active_flag : 1;
	u8 start_flag : 1;
	u8 auto_sweep : 1;
	u8 sync_flag : 5;
	u8 pan_range;
	u8 original_key;
	s16 user_decay2;
	u8 key;
	u8 velocity;
	s8 init_pan;
	s8 user_pan;
	s16 user_decay;
	s16 user_pitch;
	s32 env_decay;
	s32 sweep_counter;
	s32 sweep_length;
	u8 attack;
	u8 sustain;
	u16 decay;
	u16 release;
	u8 prio;
	u8 pan;
	u16 volume;
	u16 timer;
	struct SNDLfo lfo;
	s16 sweep_pitch;
	s32 length;

	struct SNDWaveParam wave;
	union {
		const void * data;
		SNDDuty duty;
	};

	SNDExChannelCallback callback;
	void * callback_data;
	struct SNDExChannel * nextLink;
} SNDExChannel;

#ifdef SDK_ARM7
    void Snd_ExChannelInit(void);
    void Snd_ExChannelMain(BOOL doPeriodicProc);
    void Snd_UpdateExChannel(void);

    struct SNDExChannel * Snd_AllocExChannel(u32 chBitMask,
                                            int prio,
                                            BOOL strongRequest,
                                            SNDExChannelCallback callback, void * callbackData);

    void Snd_FreeExChannel(struct SNDExChannel * ch_p);
    BOOL Snd_StartExChannelPcm(SNDExChannel * ch_p, const struct SNDWaveParam * wave, const void * data, s32 length);
    BOOL Snd_StartExChannelPsg(struct SNDExChannel * ch_p, SNDDuty duty, s32 length);
    BOOL Snd_StartExChannelNoise(struct SNDExChannel * ch_p, s32 length);
    void Snd_ReleaseExChannel(struct SNDExChannel * ch_p);
    BOOL Snd_IsExChannelActive(struct SNDExChannel * ch_p);
    void Snd_InvalidateWave(const void * start, const void * end);

    s32 Snd_UpdateExChannelEnvelope(SNDExChannel * ch_p, BOOL doPeriodicProc);

    void Snd_SetExChannelAttack(struct SNDExChannel * ch_p, int attack);
    void Snd_SetExChannelDecay(struct SNDExChannel * ch_p, int decay);
    void Snd_SetExChannelSustain(struct SNDExChannel * ch_p, int sustain);
    void Snd_SetExChannelRelease(struct SNDExChannel * ch_p, int release);

    void Snd_InitLfoParam(SNDLfoParam * lfo);
    void Snd_StartLfo(SNDLfo * lfo);
    void Snd_UpdateLfo(SNDLfo * lfo);
    s32 Snd_GetLfoValue(SNDLfo * lfo);

    void Snd_LockChannel(u32 chBitMask, u32 flags);
    void Snd_UnlockChannel(u32 chBitMask, u32 flags);
    void Snd_StopUnlockedChannel(u32 chBitMask, u32 flags);
    u32 Snd_GetLockedChannel(u32 flags);
#endif

#ifdef __cplusplus
}
#endif

#endif