th_sound.h

Go to the documentation of this file.

/*
Copyright (c) 2009 Peter "Corsix" Cawley
 
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef CORSIX_TH_TH_SOUND_H_
#define CORSIX_TH_TH_SOUND_H_
#include "config.h"
 
#include <SDL_mixer.h>
#include <SDL_rwops.h>
 
#include <array>
#include <mutex>
#include <vector>
 
class sound_archive {
 public:
  bool load_from_th_file(const uint8_t* pData, size_t iDataLength);
 
  size_t get_number_of_sounds() const;
 
  const char* get_sound_name(size_t iIndex) const;
 
  size_t get_sound_duration(size_t iIndex);
 
 
  SDL_RWops* load_sound(size_t iIndex);
 
 private:
  struct sound_dat_sound_info {
    std::array<char, 18> sound_name;
    uint32_t position;
    uint32_t length;
  };
 
  std::vector<uint8_t> data;
  std::vector<sound_dat_sound_info> sound_files;
};
 
class sound_player {
 public:
  enum class toggle_pause_result { error, paused, resumed };
  static constexpr uint32_t null_handle = 0u;
  static constexpr int number_of_channels = 32;
 
  sound_player();
  sound_player(const sound_player&) = delete;
  sound_player& operator=(const sound_player&) = delete;
  ~sound_player();
 
  static sound_player* get_singleton();
 
  void populate_from(sound_archive* pArchive);
 
  uint32_t play(size_t iIndex, double dVolume, int loops);
 
  uint32_t play_at(size_t iIndex, int iX, int iY, int loops);
 
  uint32_t play_at(size_t iIndex, double dVolume, int iX, int iY, int loops);
 
  toggle_pause_result toggle_pause(uint32_t handle);
 
  void stop(uint32_t handle);
 
  bool is_playing(uint32_t handle);
 
  void set_sound_effect_volume(double dVolume);
 
  void set_sound_effects_enabled(bool bOn);
 
  void set_camera(int iX, int iY, int iRadius);
 
  int reserve_channel();
 
  void release_channel(int iChannel);
 
 private:
  static sound_player* singleton;
  static void on_channel_finished(int iChannel);
 
  uint32_t play_raw(size_t iIndex, int iVolume, int loops);
 
  int playing_channel_for_handle(uint32_t handle);
 
  Mix_Chunk** sounds;
  size_t sound_count;
  int camera_x;
  int camera_y;
  double camera_radius;
  double master_volume;
  double sound_effect_volume;
  int positionless_volume;
  bool sound_effects_enabled;
 
  std::array<uint32_t, number_of_channels> channels{};
  uint32_t next_playing_track_handle{0};
 
  std::recursive_mutex channel_mutex{};
};
 
#endif  // CORSIX_TH_TH_SOUND_H_