milesAudioSound.h

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file milesAudioSound.h
 * @author drose
 * @date 2007-07-30
 */

#ifndef MILESAUDIOSOUND_H
#define MILESAUDIOSOUND_H

#include "pandabase.h"
#ifdef HAVE_RAD_MSS //[

#include "audioSound.h"
#include "milesAudioManager.h"

#include <mss.h>

/**
 * The base class for both MilesAudioStream and MilesAudioSample.
 */
class EXPCL_MILES_AUDIO MilesAudioSound : public AudioSound {
protected:
  MilesAudioSound(MilesAudioManager *manager, const std::string &file_name);

public:
  virtual void set_loop(bool loop=true);
  virtual bool get_loop() const;

  virtual void set_loop_count(unsigned long loop_count=1);
  virtual unsigned long get_loop_count() const;

  virtual PN_stdfloat get_volume() const;
  virtual PN_stdfloat get_balance() const;
  virtual PN_stdfloat get_play_rate() const;

  virtual void set_time(PN_stdfloat start_time=0.0);

  virtual void set_active(bool active=true);
  virtual bool get_active() const;

  virtual void set_finished_event(const std::string &event);
  virtual const std::string &get_finished_event() const;

  virtual const std::string &get_name() const;

  virtual void cleanup();

protected:
  PT(MilesAudioManager) _manager;
  std::string _file_name;

  PN_stdfloat _volume; // 0..1.0
  PN_stdfloat _balance; // -1..1
  PN_stdfloat _play_rate; // 0..1.0
  unsigned long _loop_count;

  // _active is for things like a 'turn off sound effects' in a preferences
  // pannel.  _active is not about whether a sound is currently playing.  Use
  // status() for info on whether the sound is playing.
  bool _active;

  // _paused is not like the Pause button on a cddvd player.  It is used as a
  // flag to say that the sound was looping when it was set inactive.
  bool _paused;

  // This is the string that throw_event() will throw when the sound finishes
  // playing.  It is not triggered when the sound is stopped with stop().
  // Note: no longer implemented.
  std::string _finished_event;

  // This is set whenever we call set_time().  Calling play() will respect
  // this if it is set, and then reset it.
  PN_stdfloat _start_time;
  bool _got_start_time;

public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    AudioSound::init_type();
    register_type(_type_handle, "MilesAudioSound",
                  AudioSound::get_class_type());
  }
  virtual TypeHandle get_type() const {
    return get_class_type();
  }
  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}

private:
  static TypeHandle _type_handle;

  friend class MilesAudioManager;
};

#include "milesAudioSound.I"

#endif //]

#endif