/*---------------------------------------------------------------------------*
  Project:  TwlSDK - include - snd - common
  File:     exchannel.h

  Copyright 2004-2008 Nintendo. All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law. They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Date:: 2008-09-18#$
  $Rev: 8573 $
  $Author: okubata_ryoma $
 *---------------------------------------------------------------------------*/

#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

/******************************************************************************
	Macro Definitions
 ******************************************************************************/

#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 )

/******************************************************************************
	Structure Declaration
 ******************************************************************************/

struct SNDExChannel;

/******************************************************************************
	Enum Definitions
 ******************************************************************************/

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;

/******************************************************************************
	Type Definitions
 ******************************************************************************/

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

/******************************************************************************
	Structure Definitions
 ******************************************************************************/

#if !(defined(SDK_WIN32) || defined(SDK_FROM_TOOL))

typedef struct SNDWaveParam
{
    u8      format;                    // enum SNDWaveFormat
    u8      loopflag;                  // boolean
    u16     rate;                      // sampling rate
    u16     timer;                     // = SND_TIMER_CLOCK / rate
    u16     loopstart;                 // Loop-Start-Point [word length]
    u32     looplen;                   // Loop-Length [word length]
}
SNDWaveParam;                          // total 12 Bytes

#else

typedef struct SNDWaveParam
{
    u8      format;                    // enum SNDWaveFormat
    u8      loopflag;                  // boolean
    u16     rate;                      // sampling rate
    u16     timer;                     // = SND_TIMER_CLOCK / rate
    u32     loopstart;                 // Loop-Start-Point [sample length]
    u32     looplen;                   // Loop-Length [sample length]
}
SNDWaveParam;

#endif

typedef struct SNDLfoParam
{
    u8      target;                    // enum SNDLfoTarget
    u8      speed;                     // At 256, one sample at a time
    u8      depth;                     // At 128, multiplied by 1.0
    u8      range;
    u16     delay;
}
SNDLfoParam;

typedef struct SNDLfo
{
    struct SNDLfoParam param;

    u16     delay_counter;
    u16     counter;
}
SNDLfo;

typedef struct SNDExChannel
{
    u8      myNo;
    u8      type;                      // SNDExChannelType  
    u8      env_status;                // SNDEnvStatus
    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;                 // Attenuation due to envelope release

    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;


/******************************************************************************
	Public Function Declarations
 ******************************************************************************/

#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);

//-----------------------------------------------------------------------------
// Envelope

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);

//-----------------------------------------------------------------------------
// LFO

void    SND_InitLfoParam(SNDLfoParam *lfo);
void    SND_StartLfo(SNDLfo *lfo);
void    SND_UpdateLfo(SNDLfo *lfo);
s32     SND_GetLfoValue(SNDLfo *lfo);

//-----------------------------------------------------------------------------
// channel lock

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 /* SDK_ARM7 */

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* NITRO_SND_COMMON_EX_CHANNEL_H_ */