/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     snd_CurveAdshr.h
  
  Copyright (C)2009-2011 Nintendo/HAL Laboratory, Inc.  All rights reserved.
  
  These coded instructions, statements, and computer programs contain proprietary
  information of Nintendo and/or its licensed developers and are protected by
  national and international copyright laws. 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.
  
  The content herein is highly confidential and should be handled accordingly.
  
  $Revision: 31311 $
 *---------------------------------------------------------------------------*/

#ifndef NW_SND_CURVE_ADSHR_H_
#define NW_SND_CURVE_ADSHR_H_

#include <nn/types.h>

namespace nw {
namespace snd {
namespace internal {

/* ========================================================================
        class definition
   ======================================================================== */

class CurveAdshr
{
    /* ------------------------------------------------------------------------
            typename difinition
       ------------------------------------------------------------------------ */
public:
    enum Status
    {
        STATUS_ATTACK = 0,
        STATUS_HOLD,
        STATUS_DECAY,
        STATUS_SUSTAIN,
        STATUS_RELEASE
    };

    /* ------------------------------------------------------------------------
            constant declaration
       ------------------------------------------------------------------------ */
private:
    static const float VOLUME_INIT; // -90.4;
    static const int ATTACK_INIT    = 127;
    static const int HOLD_INIT      = 0;
    static const int DECAY_INIT     = 127;
    static const int SUSTAIN_INIT   = 127;
    static const int RELEASE_INIT   = 127;

    static const int DECIBEL_SQUARE_TABLE_SIZE  = 128;
    static const int CALC_DECIBEL_SCALE_MAX     = 127;
    static const s16 DecibelSquareTable[ DECIBEL_SQUARE_TABLE_SIZE ];

    /* ------------------------------------------------------------------------
            class member
       ------------------------------------------------------------------------ */
public:
    CurveAdshr();
    void Initialize( float initDecibel = VOLUME_INIT );
    void Reset( float initDecibel = VOLUME_INIT );

    void Update( int msec );
    f32  GetValue() const;

    // Accesser
    Status GetStatus() const { return m_Status; }
    void SetStatus( Status status ) { m_Status = status; }

    void SetAttack( int attack );
    void SetHold( int hold );
    void SetDecay( int decay );
    void SetSustain( int sustain );
    void SetRelease( int release );

private:
    static f32 CalcRelease( int release );
    static s16 CalcDecibelSquare( int scale );

    Status m_Status;
    f32 m_Value;
    f32 m_Decay;
    f32 m_Release;
    f32 m_Attack;
    u16 m_Hold;
    u16 m_HoldCounter;
    u8  m_Sustain;
    u8  padding[3];
};


} // namespace nw::snd::internal
} // namespace nw::snd
} // namespace nw


#endif /* NW_SND_CURVE_ADSHR_H_ */