JukeBox Class Reference

#include <jukebox.h>

Collaboration diagram for JukeBox:

[legend]List of all members.

Public Member Functions
	JukeBox ()
void	Init ()
void	End ()
bool	UseMusic () const
bool	UseEffects () const
int	GetFrequency () const
int	HowManyChannels () const
void	Pause ()
void	Resume ()
void	ActiveMusic (bool on)
void	ActiveEffects (bool on)
void	SetFrequency (int frequency)
void	SetNumbersOfChannel (int channels)
void	LoadXML (const std::string &profile)
int	Play (const std::string &category, const std::string &sample, const int loop=1)
int	Stop (int channel)
int	StopAll ()
Private Types
typedef std::multimap< std::string, std::string >::value_type	sound_sample
typedef std::multimap< std::string, std::string >::iterator	sample_iterator
Private Member Functions
int	PlaySample (Mix_Chunk *sample, int loop=0)
Static Private Member Functions
static void	EndChunk (int channel)
Private Attributes
std::multimap< std::string, std::string >	m_soundsamples
std::map< int, Mix_Chunk * >	chunks
JukeBox::s_m_config	m_config
bool	m_init
std::set< std::string >	m_profiles_loaded
Classes
struct	s_m_config

---

Detailed Description

Definition at line 34 of file jukebox.h.

---

Member Typedef Documentation

typedef std::multimap<std::string, std::string>::iterator JukeBox::sample_iterator [private]

Definition at line 41 of file jukebox.h.

typedef std::multimap<std::string, std::string>::value_type JukeBox::sound_sample [private]

Definition at line 39 of file jukebox.h.

---

Constructor & Destructor Documentation

JukeBox::JukeBox

(

)

Definition at line 33 of file jukebox.cpp.

{
  m_init = false;
  
  m_config.music = true;
  m_config.effects = true;
  m_config.frequency = 44100; //MIX_DEFAULT_FREQUENCY;
  m_config.channels = 2; // stereo
}

---

Member Function Documentation

void JukeBox::ActiveEffects

(

bool

on

)

[inline]

Definition at line 73 of file jukebox.h.

{m_config.effects = on;};

Here is the caller graph for this function:

void JukeBox::ActiveMusic

(

bool

on

)

[inline]

Definition at line 72 of file jukebox.h.

{m_config.music = on ;};

Here is the caller graph for this function:

void JukeBox::End

(

)

Definition at line 90 of file jukebox.cpp.

{
  if (!m_init) return;
  m_init = false;

  StopAll();

  m_soundsamples.clear();
  m_profiles_loaded.clear();

  Mix_CloseAudio();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void JukeBox::EndChunk

(

int

channel

)

[static, private]

Definition at line 254 of file jukebox.cpp.

{
  Mix_Chunk* chk = jukebox.chunks[channel];
  
  if(!chk) return;
  
  Mix_FreeChunk(chk);
  jukebox.chunks[channel] = 0;
}

Here is the caller graph for this function:

int JukeBox::GetFrequency

(

)

const [inline]

Definition at line 67 of file jukebox.h.

{return m_config.frequency;};

Here is the caller graph for this function:

int JukeBox::HowManyChannels

(

)

const [inline]

Definition at line 68 of file jukebox.h.

{return m_config.channels;};

void JukeBox::Init

(

)

Definition at line 55 of file jukebox.cpp.

{
  if (!m_config.music && !m_config.effects) {
    End();
    return;
  }

  if (m_init) return;

  Uint16 audio_format = MIX_DEFAULT_FORMAT;

  /* Initialize the SDL library */
  if ( SDL_Init(SDL_INIT_AUDIO) < 0 ) {
    std::cerr << "* Couldn't initialize SDL: "<< SDL_GetError() << std::endl;
    return;
  } 
  
  int audio_buffer = 1024;

  /* Open the audio device */
  if (Mix_OpenAudio(m_config.frequency, audio_format, m_config.channels, audio_buffer) < 0) {
    std::cerr << "* Couldn't open audio: " <<  SDL_GetError() << std::endl;
    return;
  } else {
    Mix_QuerySpec(&m_config.frequency, &audio_format, &m_config.channels);
    std::cout << "o Opened audio at " << m_config.frequency <<" Hz "<< (audio_format&0xFF) 
              <<" bit " << std::endl;
  }
  Mix_ChannelFinished(JukeBox::EndChunk);
  
  m_init = true;  
  
  LoadXML("share");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void JukeBox::LoadXML

(

const std::string &

profile

)

Definition at line 132 of file jukebox.cpp.

{

  if (!UseEffects()) return;

  // is xml_file already loaded ?
  std::set<std::string>::iterator it_profile = m_profiles_loaded.find(profile) ;
  if (it_profile !=  m_profiles_loaded.end()) {
          MSG_DEBUG("jukebox", "Profile %s is already loaded !", profile.c_str());
      return;
  } 
  std::cout << "o Loading sound profile " << profile << std::endl;

  XmlReader doc;

  // Load the XML
  std::string folder = Config::GetInstance()->GetDataDir() + PATH_SEPARATOR + "sound"+ PATH_SEPARATOR + profile + PATH_SEPARATOR;
  std::string xml_filename = folder + "profile.xml";
  if( !IsFileExist(xml_filename) ){
    std::cerr << "[Sound] Error : file " << xml_filename << " not found" << std::endl;
    return;
  }
  if(!doc.Load(xml_filename))
    return;

  xmlpp::Node::NodeList nodes = doc.GetRoot()->get_children("sound");
  xmlpp::Node::NodeList::iterator 
    it=nodes.begin(),
    fin=nodes.end();

  for (; it != fin; ++it)
    {
      // lit le XML
      xmlpp::Element *elem = dynamic_cast<xmlpp::Element*> (*it);
      std::string sample="no_sample";
      std::string file="no_file";
      XmlReader::ReadStringAttr(elem, "sample", sample);
      XmlReader::ReadStringAttr(elem, "file", file);

          MSG_DEBUG("jukebox", "Load sound sample %s/%s: %s", profile.c_str(), sample.c_str(), file.c_str());

      // Charge le son
      std::string sample_filename = folder + file;
      if( !IsFileExist(sample_filename) ){
        std::cerr << "Sound error: File " << sample_filename.c_str() 
                  << " does not exist !" << std::endl; 
        continue;
      }
        
      // Inserting sound sample in list
      m_soundsamples.insert(sound_sample(profile+"/"+sample, sample_filename));  
    }

  // The profile is loaded
  m_profiles_loaded.insert(profile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void JukeBox::Pause

(

)

Definition at line 43 of file jukebox.cpp.

{
  Mix_Pause(-1);
  Mix_PauseMusic();
}

Here is the caller graph for this function:

int JukeBox::Play	(	const std::string &	category,
		const std::string &	sample,
		const int	loop = 1
	)

Playing a sound effect

Returns:

the channel used to play the sample loop: -1 for loop forever, else number of times to play

Definition at line 189 of file jukebox.cpp.

{
  if (!UseEffects()) return -1;

  uint nb_sons= m_soundsamples.count(category+"/"+sample);
  if (nb_sons) 
  {
    std::pair<sample_iterator, sample_iterator> p = m_soundsamples.equal_range(category+"/"+sample);
    sample_iterator it = p.first;

    // Choose a random sound sample
    if (nb_sons > 1)
    {
      uint selection = uint(randomObj.GetLong(0, nb_sons));
      if (selection == nb_sons) --selection ;

      it = p.first ;
      
      for ( uint i=0 ; i<selection && it!=p.second ; ++i ) it++ ;
    }

    // Play the sound
    Mix_Chunk * sampleChunk = Mix_LoadWAV(it->second.c_str());
    MSG_DEBUG("jukebox.play", "Playing sample %s/%s", category.c_str(), sample.c_str());
    return PlaySample(sampleChunk, loop);
  }
  else if (category != "default") { // try with default profile
    return Play("default", sample, loop) ; // try with default profile
  } 

  MSG_DEBUG("jukebox", "Error: No sound found for sample %s/%s", category.c_str(), sample.c_str());
  return -1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int JukeBox::PlaySample	(	Mix_Chunk *	sample,
		int	loop = 0
	)			[private]

Playing a sound effect

Returns:

the channel used to play the sample loop: -1 for loop forever, else number of times -1 to play

Definition at line 239 of file jukebox.cpp.

{
  if (loop != -1) loop--;

  int channel = Mix_PlayChannel(-1, sample, loop);

  if (channel == -1) {
        MSG_DEBUG("jukebox", "Error: Jukebox::PlaySample: %s", Mix_GetError());
        Mix_FreeChunk(sample);
  }
  else
    chunks[channel] = sample;
  return channel;
}

Here is the caller graph for this function:

void JukeBox::Resume

(

)

Definition at line 49 of file jukebox.cpp.

{    
  Mix_Resume(-1);
  Mix_ResumeMusic();
}

Here is the caller graph for this function:

void JukeBox::SetFrequency

(

int

frequency

)

Definition at line 103 of file jukebox.cpp.

{
  if ((frequency != 11025) 
      && (frequency != 22050) 
      && (frequency != 44100)) frequency = 44100;

  if (m_config.frequency == frequency) return;

  m_config.frequency = frequency;

  // Close and reopen audio device
  End();
  Init();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void JukeBox::SetNumbersOfChannel

(

int

channels

)

int JukeBox::Stop

(

int

channel

)

Definition at line 224 of file jukebox.cpp.

{
  if(!m_config.music && !m_config.effects) return 0;
  if (channel == -1) return 0;
  return Mix_HaltChannel(channel);
}

Here is the caller graph for this function:

int JukeBox::StopAll

(

)

Definition at line 231 of file jukebox.cpp.

{
  if (!m_config.music && !m_config.effects) return 0;

  // halt playback on all channels
  return Mix_HaltChannel(-1);
}

Here is the caller graph for this function:

bool JukeBox::UseEffects

(

)

const [inline]

Definition at line 66 of file jukebox.h.

{return m_config.effects;};

Here is the caller graph for this function:

bool JukeBox::UseMusic

(

)

const [inline]

Definition at line 65 of file jukebox.h.

{return m_config.music;};

Here is the caller graph for this function:

---

Member Data Documentation

std::map<int, Mix_Chunk*> JukeBox::chunks [private]

Definition at line 45 of file jukebox.h.

struct JukeBox::s_m_config JukeBox::m_config [private]

bool JukeBox::m_init [private]

Definition at line 54 of file jukebox.h.

std::set<std::string> JukeBox::m_profiles_loaded [private]

Definition at line 56 of file jukebox.h.

std::multimap<std::string, std::string> JukeBox::m_soundsamples [private]

Definition at line 43 of file jukebox.h.

---

The documentation for this class was generated from the following files:

• src/sound/jukebox.h
• src/sound/jukebox.cpp

---