sound_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef SOUND_TYPE_H
#define SOUND_TYPE_H
 
enum class SoundSource : uint8_t {
  BasesetOldFormat,
  BasesetNewFormat,
  NewGRF,
};
 
struct SoundEntry {
  std::shared_ptr<std::vector<uint8_t>> data;
  class RandomAccessFile *file;
  size_t file_offset;
  size_t file_size;
  uint16_t rate;
  uint8_t bits_per_sample;
  uint8_t channels;
  uint8_t volume;
  uint8_t priority;
  SoundSource source;
  uint8_t grf_container_ver; 
};
 
enum SoundFx {
  SND_BEGIN = 0,
  SND_02_CONSTRUCTION_WATER = 0,         
  SND_03_FACTORY,                        
  SND_04_DEPARTURE_STEAM,                
  SND_05_TRAIN_THROUGH_TUNNEL,           
  SND_06_DEPARTURE_CARGO_SHIP,           
  SND_07_DEPARTURE_FERRY,                
  SND_08_TAKEOFF_PROPELLER,              
  SND_09_TAKEOFF_JET,                    
  SND_0A_DEPARTURE_TRAIN,                
  SND_0B_MINE,                           
  SND_0C_POWER_STATION,                  
  SND_0D_UNUSED,                         
  SND_0E_LEVEL_CROSSING,                 
  SND_0F_BREAKDOWN_ROADVEHICLE,          
  SND_10_BREAKDOWN_TRAIN_SHIP,           
  SND_11_UNUSED,                         
  SND_12_EXPLOSION,                      
  SND_13_TRAIN_COLLISION,                
  SND_14_CASHTILL,                       
  SND_15_BEEP,                           
  SND_16_NEWS_TICKER,                    
  SND_17_SKID_PLANE,                     
  SND_18_TAKEOFF_HELICOPTER,             
  SND_19_DEPARTURE_OLD_RV_1,             
  SND_1A_DEPARTURE_OLD_RV_2,             
  SND_1B_DEPARTURE_MODERN_BUS,           
  SND_1C_DEPARTURE_OLD_BUS,              
  SND_1D_APPLAUSE,                       
  SND_1E_NEW_ENGINE,                     
  SND_1F_CONSTRUCTION_OTHER,             
  SND_20_CONSTRUCTION_RAIL,              
  SND_21_ROAD_WORKS,                     
  SND_22_UNUSED,                         
  SND_23_UNUSED,                         
  SND_24_FARM_1,                         
  SND_25_FARM_2,                         
  SND_26_FARM_3,                         
  SND_27_CONSTRUCTION_BRIDGE,            
  SND_28_SAWMILL,                        
  SND_00_GOOD_YEAR,                      
  SND_01_BAD_YEAR,                       
  SND_29_SUGAR_MINE_2,                   
  SND_2A_TOY_FACTORY_3,                  
  SND_2B_TOY_FACTORY_2,                  
  SND_2C_TOY_FACTORY_1,                  
  SND_2D_SUGAR_MINE_1,                   
  SND_2E_BUBBLE_GENERATOR,               
  SND_2F_BUBBLE_GENERATOR_FAIL,          
  SND_30_TOFFEE_QUARRY,                  
  SND_31_BUBBLE_GENERATOR_SUCCESS,       
  SND_32_UNUSED,                         
  SND_33_PLASTIC_MINE,                   
  SND_34_ARCTIC_SNOW_1,                  
  SND_35_BREAKDOWN_ROADVEHICLE_TOYLAND,  
  SND_36_LUMBER_MILL_3,                  
  SND_37_LUMBER_MILL_2,                  
  SND_38_LUMBER_MILL_1,                  
  SND_39_ARCTIC_SNOW_2,                  
  SND_3A_BREAKDOWN_TRAIN_SHIP_TOYLAND,   
  SND_3B_TAKEOFF_JET_FAST,               
  SND_3C_DEPARTURE_BUS_TOYLAND_1,        
  SND_3D_TAKEOFF_JET_BIG,                
  SND_3E_DEPARTURE_BUS_TOYLAND_2,        
  SND_3F_DEPARTURE_TRUCK_TOYLAND_1,      
  SND_40_DEPARTURE_TRUCK_TOYLAND_2,      
  SND_41_DEPARTURE_MAGLEV,               
  SND_42_RAINFOREST_1,                   
  SND_43_RAINFOREST_2,                   
  SND_44_RAINFOREST_3,                   
  SND_45_TAKEOFF_PROPELLER_TOYLAND_1,    
  SND_46_TAKEOFF_PROPELLER_TOYLAND_2,    
  SND_47_DEPARTURE_MONORAIL,             
  SND_48_RAINFOREST_4,                   
  SND_END
};
 
static const uint ORIGINAL_SAMPLE_COUNT = 73;
 
typedef uint16_t SoundID;
 
static const SoundID INVALID_SOUND = 0xFFFF;
 
static const uint8_t SOUND_EFFECT_MAX_VOLUME = 128;
 
#endif /* SOUND_TYPE_H */