audio_music.h

Go to the documentation of this file.

//            Copyright (C) 2004-2007 by The Allacrost Project
//                         All Rights Reserved
//
// This code is licensed under the GNU GPL version 2. It is free software
// and you may modify it and/or redistribute it under the terms of this license.
// See http://www.gnu.org/copyleft/gpl.html for details.

#ifndef __AUDIO_MUSIC_HEADER__
#define __AUDIO_MUSIC_HEADER__

#include "utils.h"
#include "defs.h"
#include "audio.h"

namespace hoa_audio {

namespace private_audio {

class MusicData {
public:
  MusicData(const std::string & fname);
  ~MusicData();

  std::string filename;
  uint8 reference_count;
  Mix_Music *music;
  bool playing;

  bool IsValid();
  void RemoveReference();

  void DEBUG_PrintProperties();
};

} // namespace private_audio

class MusicDescriptor {
  friend class GameAudio;
public:
  MusicDescriptor();
  ~MusicDescriptor();

  const std::string &GetFilename()
    { if (_data != NULL) return _data->filename; throw std::runtime_error("MusicDescriptor: Can't get the filename reference!"); }

  bool LoadMusic(const std::string & fname);
  void FreeMusic();

  void PlayMusic();
  void PauseMusic();
  void ResumeMusic();
  void StopMusic();
  void RewindMusic();
  void SeekMusic(float seconds);

  uint8 GetMusicState();

  bool IsPlaying();

  void SetLoopCount(int32 loops)
    { _loop_count = loops; }
  void SetFadeInTime(uint32 fade_time)
    { _fade_in_time = fade_time; }
  void SetFadeOutTime(uint32 fade_time)
    { _fade_out_time = fade_time; }
  void SetPlayTimeout(uint32 timeout)
    { _play_timeout = timeout; }

  void DEBUG_dataProperties()
    { if (_data != NULL) _data->DEBUG_PrintProperties(); }
private:
  private_audio::MusicData *_data;
  int32 _loop_count;
  uint32 _fade_in_time;
  uint32 _fade_out_time;
  int32 _play_timeout;
}; // class MusicDescriptor

} // namespace hoa_audio

#endif /* #ifndef __AUDIO_MUSIC_HEADER__ */

---