audio.h

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2023 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 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, either version 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
#pragma once
 
#include <QVector>
 
typedef void (*audio_finished_callback)();
 
class QString;
struct audio_plugin {
  QString name;
  QString descr;
  bool (*init)();
  void (*shutdown)();
  void (*stop)();
  void (*wait)();
  double (*get_volume)();
  void (*set_volume)(double volume);
  bool (*play)(const QString &tag, const QString &path, bool repeat,
               audio_finished_callback cb);
};
 
enum music_usage { MU_MENU, MU_INGAME };
 
struct option;
const QVector<QString> *get_soundplugin_list(const struct option *poption);
const QVector<QString> *get_soundset_list(const struct option *poption);
const QVector<QString> *get_musicset_list(const struct option *poption);
 
void audio_init();
void audio_real_init(const QString &soundspec_name,
                     const QString &musicset_name,
                     const QString &preferred_plugin_name);
void audio_add_plugin(struct audio_plugin *p);
void audio_shutdown();
void audio_stop();
void audio_stop_usage();
void audio_restart(const QString &soundset_name,
                   const QString &musicset_name);
 
void audio_play_sound(const QString &tag, const QString &alt_tag);
void audio_play_music(const QString &tag, const QString &alt_tag,
                      enum music_usage usage);
void audio_play_track(const QString &tag, const QString &alt_tag);
 
double audio_get_volume();
void audio_set_volume(double volume);
 
bool audio_select_plugin(const QString &name);
const QString audio_get_all_plugin_names();