Open Source Tomb Raider Engine
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

SoundNull.h 2.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109
  1. /*!
  2. * \file include/SoundNull.h
  3. * \brief This is the null audio manager Header
  4. *
  5. * \author xythobuz
  6. */
  7. #ifndef _SOUND_NULL_H_
  8. #define _SOUND_NULL_H_
  9. #include "Sound.h"
  10. /*!
  11. * \brief This is the null audio manager
  12. */
  13. class SoundNull : public Sound {
  14. public:
  15. /*!
  16. * \brief Constructs an object of SoundNull
  17. */
  18. SoundNull();
  19. /*!
  20. * \brief Deconstructs an object of SoundNull
  21. */
  22. virtual ~SoundNull();
  23. /*!
  24. * \brief Initialize sound system
  25. * \returns 0 on success or < 0 error flags
  26. */
  27. virtual int initialize();
  28. virtual void setEnabled(bool on);
  29. virtual bool getEnabled() { return false; }
  30. /*!
  31. * \brief Set the volume
  32. * \param vol new source gain
  33. */
  34. virtual void setVolume(float vol);
  35. virtual float getVolume() { return 0.0f; }
  36. /*!
  37. * \brief Get number of registered sources
  38. * \returns number of registered sources
  39. */
  40. virtual unsigned long registeredSources();
  41. /*!
  42. * \brief Remove all loaded sounds
  43. */
  44. virtual void clear();
  45. /*!
  46. * \brief Move listener and repositions them
  47. * \param pos New position for listener
  48. * \param angle New orientation for listener
  49. */
  50. virtual void listenAt(float pos[3], float angle[3]);
  51. /*!
  52. * \brief Move sound source to position
  53. * \param source valid source id
  54. * \param pos new position for source
  55. */
  56. virtual void sourceAt(unsigned long source, float pos[3]);
  57. /*!
  58. * \brief Load wav file from disk
  59. * \param filename not NULL!
  60. * \param source not NULL! Returns new source ID or -1 on error.
  61. * \param flags set options. Use SoundFlags enum bitwise OR-ed
  62. * \returns 0 for no error or < 0 error flag
  63. */
  64. virtual int addFile(const char* filename, unsigned long* source, unsigned int flags);
  65. /*!
  66. * \brief Load wav file from buffer
  67. * \param wav not NULL! Is a valid waveform buffer!
  68. * \param length length of wav buffer
  69. * \param source not NULL! Returns new source ID or -1 on error.
  70. * \param flags set options. Use SoundFlags enum bitwise OR-ed
  71. * \returns 0 for no error or < 0 error flag
  72. */
  73. virtual int addWave(unsigned char* wav, unsigned int length, unsigned long* source,
  74. unsigned int flags);
  75. /*!
  76. * \brief Play sound source
  77. * \param source sound source to play
  78. */
  79. virtual void play(unsigned long source);
  80. /*!
  81. * \brief Stop playing sound source
  82. * \param source sound source to stop
  83. */
  84. virtual void stop(unsigned long source);
  85. private:
  86. unsigned long sources;
  87. };
  88. #endif