Audio output for sound and music. More...

Classes
struct	chunk_load_exception

struct	driver_status

class	music_thinker

class	music_muter

class	music_track
	Internal representation of music tracks. More...

Enumerations
enum	channel_group { NULL_CHANNEL = -1 , SOUND_SOURCES = 0 , SOUND_BELL , SOUND_TIMER , SOUND_UI , SOUND_FX }

Functions
void	flush_cache ()

std::optional< unsigned int >	get_current_track_index ()

std::shared_ptr< music_track >	get_current_track ()

std::shared_ptr< music_track >	get_previous_music_track ()

void	set_previous_track (std::shared_ptr< music_track > track)

unsigned int	get_num_tracks ()

std::shared_ptr< music_track >	get_track (unsigned int i)

void	set_track (unsigned int i, const std::shared_ptr< music_track > &to)

void	remove_track (unsigned int i)

static void	channel_finished_hook (int channel)

std::string	current_driver ()

std::vector< std::string >	enumerate_drivers ()

bool	init_sound ()

void	close_sound ()

void	reset_sound ()

void	stop_music ()

void	stop_sound ()

void	stop_bell ()

void	stop_UI_sound ()

void	play_music_once (const std::string &file)

void	empty_playlist ()

void	play_music ()

void	play_track (unsigned int i)

static void	play_new_music ()

void	play_music_repeatedly (const std::string &id)

void	play_music_config (const config &music_node, bool allow_interrupt_current_track, int i)

void	commit_music_changes ()

void	write_music_play_list (config &snapshot)

void	reposition_sound (int id, unsigned int distance)

bool	is_sound_playing (int id)

void	stop_sound (int id)

static Mix_Chunk *	load_chunk (const std::string &file, channel_group group)

static void	play_sound_internal (const std::string &files, channel_group group, unsigned int repeats=0, unsigned int distance=0, int id=-1, int loop_ticks=0, int fadein_ticks=0)

void	play_sound (const std::string &files, channel_group group, unsigned int repeats)

void	play_sound_positioned (const std::string &files, int id, int repeats, unsigned int distance)

void	play_bell (const std::string &files)

void	play_timer (const std::string &files, int loop_ticks, int fadein_ticks)

void	play_UI_sound (const std::string &files)

int	get_music_volume ()

void	set_music_volume (int vol)

int	get_sound_volume ()

void	set_sound_volume (int vol)

void	set_bell_volume (int vol)

void	set_UI_volume (int vol)

Variables
static std::vector< Mix_Chunk * >	channel_chunks

static std::vector< int >	channel_ids

Detailed Description

Audio output for sound and music.

This module provides the ability to play music and sounds. Setting music volume to 0 will stop the music.

Enumeration Type Documentation

◆ channel_group

enum sound::channel_group

Enumerator
NULL_CHANNEL
SOUND_SOURCES
SOUND_BELL
SOUND_TIMER
SOUND_UI
SOUND_FX

Definition at line 28 of file sound.hpp.

Function Documentation

◆ channel_finished_hook()

static void sound::channel_finished_hook ( int channel )

static

Definition at line 404 of file sound.cpp.

References channel_chunks, and channel_ids.

Referenced by init_sound().

◆ close_sound()

void sound::close_sound ( )

Definition at line 493 of file sound.cpp.

References ERR_AUDIO, LOG_AUDIO, stop_bell(), stop_music(), stop_sound(), and stop_UI_sound().

Referenced by reset_sound(), preferences::set_music(), preferences::set_sound(), preferences::set_turn_bell(), preferences::set_UI_sound(), and game_launcher::~game_launcher().

◆ commit_music_changes()

void sound::commit_music_changes ( )

Definition at line 835 of file sound.cpp.

References choose_track(), play_music(), and set_previous_track().

Referenced by game_events::event_handler::handle_event(), intf_music_commit(), and playsingle_controller::play_scenario().

◆ current_driver()

std::string sound::current_driver ( )

Definition at line 410 of file sound.cpp.

◆ empty_playlist()

void sound::empty_playlist ( )

Definition at line 610 of file sound.cpp.

Referenced by playsingle_controller::do_end_level(), do_gameloop(), intf_music_clear(), and campaign_controller::play_game().

◆ enumerate_drivers()

std::vector< std::string > sound::enumerate_drivers ( )

Definition at line 416 of file sound.cpp.

References n.

◆ flush_cache()

void sound::flush_cache ( )

Definition at line 193 of file sound.cpp.

Referenced by game_launcher::change_language(), events::console_handler::do_refresh(), and game_config_manager::reload_changed_game_config().

◆ get_current_track()

std::shared_ptr< sound::music_track > sound::get_current_track ( )

Definition at line 206 of file sound.cpp.

Referenced by impl_music_get().

◆ get_current_track_index()

std::optional< unsigned int > sound::get_current_track_index ( )

Definition at line 199 of file sound.cpp.

Referenced by impl_music_get().

◆ get_music_volume()

int sound::get_music_volume ( )

Definition at line 1071 of file sound.cpp.

Referenced by impl_music_get().

◆ get_num_tracks()

unsigned int sound::get_num_tracks ( )

Definition at line 219 of file sound.cpp.

Referenced by impl_music_len(), impl_music_set(), and intf_music_next().

◆ get_previous_music_track()

std::shared_ptr< sound::music_track > sound::get_previous_music_track ( )

Definition at line 210 of file sound.cpp.

Referenced by impl_music_get().

◆ get_sound_volume()

int sound::get_sound_volume ( )

Definition at line 1091 of file sound.cpp.

Referenced by impl_audio_get().

◆ get_track()

std::shared_ptr< music_track > sound::get_track ( unsigned int i )

Definition at line 224 of file sound.cpp.

References i.

◆ init_sound()

bool sound::init_sound ( )

◆ is_sound_playing()

bool sound::is_sound_playing ( int id )

Definition at line 890 of file sound.cpp.

References channel_ids.

Referenced by soundsource::positional_source::update(), and soundsource::positional_source::update_positions().

◆ load_chunk()

static Mix_Chunk* sound::load_chunk	(	const std::string &	file,
		channel_group	group
	)

static

Definition at line 905 of file sound.cpp.

References channel_chunks, ERR_AUDIO, filesystem::get_binary_file_location(), filesystem::get_localized_path(), LOG_AUDIO, filesystem::make_read_RWops(), and NULL_CHANNEL.

Referenced by play_sound_internal().

◆ play_bell()

void sound::play_bell ( const std::string & files )

Definition at line 1048 of file sound.cpp.

References play_sound_internal(), SOUND_BELL, and preferences::turn_bell().

Referenced by playsingle_controller::before_human_turn(), and mp::ui_alerts::ready_for_start().

◆ play_music()

void sound::play_music ( )

Definition at line 615 of file sound.cpp.

Referenced by commit_music_changes(), init_sound(), play_music_config(), play_music_once(), play_music_repeatedly(), play_track(), and preferences::set_music().

◆ play_music_config()

void sound::play_music_config	(	const config &	music_node,
		bool	allow_interrupt_current_track,
		int	i
	)

Definition at line 711 of file sound.cpp.

References sound::music_track::append(), ERR_AUDIO, sound::music_track::file_path(), i, sound::music_track::id(), sound::music_track::immediate(), play_music(), sound::music_track::play_once(), set_previous_track(), and sound::music_track::valid().

Referenced by gui2::dialogs::story_viewer::display_part(), do_gameloop(), impl_music_set(), intf_music_add(), and playsingle_controller::play_scenario().

◆ play_music_once()

void sound::play_music_once ( const std::string & file )

Definition at line 601 of file sound.cpp.

References play_music(), and set_previous_track().

Referenced by playsingle_controller::do_end_level(), editor::editor_controller::do_execute_command(), and intf_music_play().

◆ play_music_repeatedly()

void sound::play_music_repeatedly ( const std::string & id )

Definition at line 689 of file sound.cpp.

References play_music().

◆ play_new_music()

static void sound::play_new_music ( )

static

Definition at line 639 of file sound.cpp.

References ERR_AUDIO, filesystem::get_localized_path(), LOG_AUDIO, filesystem::make_read_RWops(), and preferences::music_on().

Referenced by sound::music_thinker::process().

◆ play_sound()

void sound::play_sound	(	const std::string &	files,
		channel_group	group,
		unsigned int	repeats
	)

Definition at line 1033 of file sound.cpp.

References play_sound_internal(), and preferences::sound_on().

Referenced by gui2::dialogs::story_viewer::display_part(), play_controller::init_side_end(), game_lua_kernel::intf_play_sound(), game_lua_kernel::intf_set_achievement(), unit_frame::redraw(), and unit_display::unit_attack().

◆ play_sound_internal()

static void sound::play_sound_internal	(	const std::string &	files,
		channel_group	group,
		unsigned int	repeats = `0`,
		unsigned int	distance = `0`,
		int	id = `-1`,
		int	loop_ticks = `0`,
		int	fadein_ticks = `0`
	)