/*---------------------------------------------------------------------------*
  Project:  TwlSDK - include - snd - common
  File:     seq.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_SEQ_H_
#define NITRO_SND_COMMON_SEQ_H_

#include <nitro/types.h>

#include <nitro/snd/common/exchannel.h> // for SNDLfoParam

#ifdef __cplusplus
extern "C" {
#endif

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

#define SND_PLAYER_NUM 16
#define SND_PLAYER_MIN  0
#define SND_PLAYER_MAX 15

#define SND_TRACK_NUM 32
#define SND_TRACK_MIN  0
#define SND_TRACK_MAX 31

#define SND_TRACK_NUM_PER_PLAYER 16

#define SND_INVALID_TRACK_INDEX 0xff

#define SND_BASE_TEMPO    240
#define SND_DEFAULT_TEMPO 120

#define SND_TRACK_CALL_STACK_DEPTH 3

// Caution: This affects the size of SNDSharedWork
#define SND_PLAYER_VARIABLE_NUM 16
#define SND_GLOBAL_VARIABLE_NUM 16

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

typedef enum
{
    SND_SEQ_MUTE_OFF,
    SND_SEQ_MUTE_NO_STOP,
    SND_SEQ_MUTE_RELEASE,
    SND_SEQ_MUTE_STOP
}
SNDSeqMute;

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

struct SNDBankData;

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

typedef struct SNDPlayer
{
    u8      active_flag:1;
    u8      prepared_flag:1;
    u8      pause_flag:1;
    u8      pad_:5;

    u8      myNo;
    u8      pad2_;
    u8      pad3_;

    u8      prio;
    u8      volume;
    s16     extFader;

    u8      tracks[SND_TRACK_NUM_PER_PLAYER];

    u16     tempo;
    u16     tempo_ratio;
    u16     tempo_counter;
    u16     pad__;

    struct SNDBankData *bank;
}
SNDPlayer;

typedef struct SNDTrack
{
    u8      active_flag:1;
    u8      note_wait:1;
    u8      mute_flag:1;
    u8      tie_flag:1;
    u8      note_finish_wait:1;
    u8      porta_flag:1;
    u8      cmp_flag:1;
    u8      channel_mask_flag:1;

    u8      pan_range;

    u16     prgNo;

    u8      volume;
    u8      volume2;
    s8      pitch_bend;
    u8      bend_range;

    s8      pan;
    s8      ext_pan;
    s16     extFader;
    s16     ext_pitch;

    u8      attack;
    u8      decay;
    u8      sustain;
    u8      release;

    u8      prio;
    s8      transpose;
    u8      porta_key;
    u8      porta_time;
    s16     sweep_pitch;

    struct SNDLfoParam mod;
    u16     channel_mask;

    s32     wait;

    const u8 *base;                    // Note: MainMemory pointer
    const u8 *cur;                     // Note: MainMemory pointer

    const u8 *call_stack[SND_TRACK_CALL_STACK_DEPTH];
    u8      loop_count[SND_TRACK_CALL_STACK_DEPTH];
    u8      call_stack_depth;

    struct SNDExChannel *channel_list;
}
SNDTrack;

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

#ifdef SDK_ARM7

void    SND_SeqInit(void);
void    SND_SeqMain(BOOL doPeriodicProc);

void    SND_StartSeq(int playerNo, const void *seqBase, u32 seqOffset, struct SNDBankData *bank_p);
void    SND_StopSeq(int playerNo);
void    SND_PrepareSeq(int playerNo, const void *seqBase, u32 seqOffset,
                       struct SNDBankData *bank_p);
void    SND_StartPreparedSeq(int playerNo);
void    SND_PauseSeq(int playerNo, BOOL flag);
void    SND_SkipSeq(int playerNo, u32 tick);

void    SND_SetTrackMute(int playerNo, u32 trackBitMask, SNDSeqMute mute);
void    SND_SetTrackAllocatableChannel(int playerNo, u32 trackBitMask, u32 chBitMask);

void    SND_InvalidateSeq(const void *start, const void *end);
void    SND_InvalidateBank(const void *start, const void *end);

void    SND_MmlPrintEnable(BOOL enble);

#endif /* SDK_ARM7 */

/******************************************************************************
	Private Function Declarations
 ******************************************************************************/

#ifdef SDK_ARM7

void    SNDi_SetPlayerParam(int playerNo, u32 offset, u32 data, int size);
void    SNDi_SetTrackParam(int playerNo, u32 trackBitMask, u32 offset, u32 data, int size);

#endif /* SDK_ARM7 */


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

#endif /* NITRO_SND_COMMON_SEQ_H_ */