audio_sound.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_SOUND_HEADER__
#define __AUDIO_SOUND_HEADER__

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

namespace hoa_audio {

namespace private_audio {

class SoundData {
public:
  SoundData(std::string fname);
  ~SoundData();

  std::string filename;
  int8 reference_count;
  Mix_Chunk *sound;

  bool IsValid();
  void RemoveReference();
  void DEBUG_PrintProperties();
};

} // namespace private_audio

/*!****************************************************************************
 * \brief Manages sound data loaded from memory.
 *
 * The purpose of this class is to provide the API user with an easy-to-use
 * interface for manipulating sound data.This class holds all the properties
 * about a given sound. Including its location, velocity, whether or not it
 * loops, and numerous other properties.
 *****************************************************************************/
class SoundDescriptor {
  friend class GameAudio;
public:
  SoundDescriptor();
  ~SoundDescriptor();
  
  const std::string &GetFilename()
    { if (_data != NULL) return _data->filename; }
  bool LoadSound(std::string fname);
  void FreeSound();

  void PlaySound();
  void PauseSound();
  void ResumeSound();
  void StopSound();
  // Rewinding and seeking of sounds is not supported in SDL_mixer
//  void RewindSound();
//  void SeekSound(float seconds);

  uint8 GetSoundState();

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

  int32 GetLoopCount()
    { return _loop_count; }
  uint32 GetFadeInTime()
    { return _fade_in_time; }
  uint32 GetFadeOutTime()
    { return _fade_out_time; }
  int32 GetPlayTimeout()
    { return _play_timeout; }

  void DEBUG_DataProperties()
    { if (_data != NULL) _data->DEBUG_PrintProperties(); }
private:
  private_audio::SoundData *_data;
  int32 _channel;
  int32 _loop_count;
  uint32 _fade_in_time;
  uint32 _fade_out_time;
  int32 _play_timeout;
}; // class SoundDescriptor

} // namespace hoa_audio

#endif /* #ifndef __AUDIO_SOUND_HEADER__ */

---