/*  Starshatter: The Open Source Project
    Copyright (c) 2021-2024, Starshatter: The Open Source Project Contributors
    Copyright (c) 2011-2012, Starshatter OpenSource Distribution Contributors
    Copyright (c) 1997-2006, Destroyer Studios LLC.

    AUTHOR:       John DiCamillo


    OVERVIEW
    ========
    MusicTrack class
*/


#ifndef MusicTrack_h
#define MusicTrack_h

#include "Types.h"
#include "List.h"
#include "Text.h"

// +-------------------------------------------------------------------+

class Sound;

// +-------------------------------------------------------------------+

class MusicTrack
{
public:
    enum STATE { NONE, FADE_IN, PLAY, FADE_OUT, STOP };

    MusicTrack(const Text& name, int mode=0, int index=0);
    virtual ~MusicTrack();

    // Operations:
    virtual void      ExecFrame();

    virtual void      Play();
    virtual void      Stop();
    virtual void      FadeIn();
    virtual void      FadeOut();

    // accessors / mutators
    const Text&       Name()      const { return name;    }
    Sound*            GetSound()  const { return sound;   }
    int               GetState()  const { return state;   }
    int               GetMode()   const { return mode;    }
    int               GetIndex()  const { return index;   }

    int               IsReady()   const;
    int               IsPlaying() const;
    int               IsDone()    const;
    int               IsLooped()  const;

    virtual long      GetVolume() const;
    virtual void      SetVolume(long v);

    virtual double    GetTotalTime()     const;
    virtual double    GetTimeRemaining() const;
    virtual double    GetTimeElapsed()   const;

    virtual double    GetFadeTime()      const { return fade_time; }
    virtual void      SetFadeTime(double t)    { fade_time = t;    }

protected:
    Text              name;
    Sound*            sound;
    int               state;
    int               mode;
    int               index;
    double            fade;
    double            fade_time;
};

#endif  // MusicTrack_h