audio_server.cpp 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082
  1. /**************************************************************************/
  2. /* audio_server.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "audio_server.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/debugger/engine_debugger.h"
  33. #include "core/error/error_macros.h"
  34. #include "core/io/file_access.h"
  35. #include "core/io/resource_loader.h"
  36. #include "core/math/audio_frame.h"
  37. #include "core/os/os.h"
  38. #include "core/string/string_name.h"
  39. #include "core/templates/pair.h"
  40. #include "scene/resources/audio_stream_wav.h"
  41. #include "scene/scene_string_names.h"
  42. #include "servers/audio/audio_driver_dummy.h"
  43. #include "servers/audio/effects/audio_effect_compressor.h"
  44. #include <cstring>
  45. #ifdef TOOLS_ENABLED
  46. #define MARK_EDITED set_edited(true);
  47. #else
  48. #define MARK_EDITED
  49. #endif
  50. AudioDriver *AudioDriver::singleton = nullptr;
  51. AudioDriver *AudioDriver::get_singleton() {
  52. return singleton;
  53. }
  54. void AudioDriver::set_singleton() {
  55. singleton = this;
  56. }
  57. void AudioDriver::audio_server_process(int p_frames, int32_t *p_buffer, bool p_update_mix_time) {
  58. if (p_update_mix_time) {
  59. update_mix_time(p_frames);
  60. }
  61. if (AudioServer::get_singleton()) {
  62. AudioServer::get_singleton()->_driver_process(p_frames, p_buffer);
  63. }
  64. }
  65. void AudioDriver::update_mix_time(int p_frames) {
  66. _last_mix_frames = p_frames;
  67. if (OS::get_singleton()) {
  68. _last_mix_time = OS::get_singleton()->get_ticks_usec();
  69. }
  70. }
  71. double AudioDriver::get_time_since_last_mix() {
  72. lock();
  73. uint64_t last_mix_time = _last_mix_time;
  74. unlock();
  75. return (OS::get_singleton()->get_ticks_usec() - last_mix_time) / 1000000.0;
  76. }
  77. double AudioDriver::get_time_to_next_mix() {
  78. lock();
  79. uint64_t last_mix_time = _last_mix_time;
  80. uint64_t last_mix_frames = _last_mix_frames;
  81. unlock();
  82. double total = (OS::get_singleton()->get_ticks_usec() - last_mix_time) / 1000000.0;
  83. double mix_buffer = last_mix_frames / (double)get_mix_rate();
  84. return mix_buffer - total;
  85. }
  86. void AudioDriver::input_buffer_init(int driver_buffer_frames) {
  87. const int input_buffer_channels = 2;
  88. input_buffer.resize(driver_buffer_frames * input_buffer_channels * 4);
  89. input_position = 0;
  90. input_size = 0;
  91. }
  92. void AudioDriver::input_buffer_write(int32_t sample) {
  93. if ((int)input_position < input_buffer.size()) {
  94. input_buffer.write[input_position++] = sample;
  95. if ((int)input_position >= input_buffer.size()) {
  96. input_position = 0;
  97. }
  98. if ((int)input_size < input_buffer.size()) {
  99. input_size++;
  100. }
  101. } else {
  102. WARN_PRINT("input_buffer_write: Invalid input_position=" + itos(input_position) + " input_buffer.size()=" + itos(input_buffer.size()));
  103. }
  104. }
  105. int AudioDriver::_get_configured_mix_rate() {
  106. StringName audio_driver_setting = "audio/driver/mix_rate";
  107. int mix_rate = GLOBAL_GET(audio_driver_setting);
  108. #ifdef WEB_ENABLED
  109. // `0` is an acceptable value (resorts to the browser's default).
  110. return MAX(0, mix_rate);
  111. #else // !WEB_ENABLED
  112. // In the case of invalid mix rate, let's default to a sensible value..
  113. if (mix_rate <= 0) {
  114. WARN_PRINT(vformat("Invalid mix rate of %d, consider reassigning setting \'%s\'. \nDefaulting mix rate to value %d.",
  115. mix_rate, audio_driver_setting, AudioDriverManager::DEFAULT_MIX_RATE));
  116. mix_rate = AudioDriverManager::DEFAULT_MIX_RATE;
  117. }
  118. return mix_rate;
  119. #endif
  120. }
  121. AudioDriver::SpeakerMode AudioDriver::get_speaker_mode_by_total_channels(int p_channels) const {
  122. switch (p_channels) {
  123. case 4:
  124. return SPEAKER_SURROUND_31;
  125. case 6:
  126. return SPEAKER_SURROUND_51;
  127. case 8:
  128. return SPEAKER_SURROUND_71;
  129. }
  130. // Default to STEREO
  131. return SPEAKER_MODE_STEREO;
  132. }
  133. int AudioDriver::get_total_channels_by_speaker_mode(AudioDriver::SpeakerMode p_mode) const {
  134. switch (p_mode) {
  135. case SPEAKER_MODE_STEREO:
  136. return 2;
  137. case SPEAKER_SURROUND_31:
  138. return 4;
  139. case SPEAKER_SURROUND_51:
  140. return 6;
  141. case SPEAKER_SURROUND_71:
  142. return 8;
  143. }
  144. ERR_FAIL_V(2);
  145. }
  146. PackedStringArray AudioDriver::get_output_device_list() {
  147. PackedStringArray list;
  148. list.push_back("Default");
  149. return list;
  150. }
  151. String AudioDriver::get_output_device() {
  152. return "Default";
  153. }
  154. PackedStringArray AudioDriver::get_input_device_list() {
  155. PackedStringArray list;
  156. list.push_back("Default");
  157. return list;
  158. }
  159. void AudioDriver::start_sample_playback(const Ref<AudioSamplePlayback> &p_playback) {
  160. if (p_playback.is_valid()) {
  161. if (p_playback->stream.is_valid()) {
  162. WARN_PRINT_ED(vformat(R"(Trying to play stream (%s) as a sample (%s), but the driver doesn't support sample playback.)", p_playback->get_instance_id(), p_playback->stream->get_instance_id()));
  163. } else {
  164. WARN_PRINT_ED(vformat(R"(Trying to play stream (%s) as a null sample, but the driver doesn't support sample playback.)", p_playback->get_instance_id()));
  165. }
  166. } else {
  167. WARN_PRINT_ED("Trying to play a null sample playback from a driver that don't support sample playback.");
  168. }
  169. }
  170. AudioDriverDummy AudioDriverManager::dummy_driver;
  171. AudioDriver *AudioDriverManager::drivers[MAX_DRIVERS] = {
  172. &AudioDriverManager::dummy_driver,
  173. };
  174. int AudioDriverManager::driver_count = 1;
  175. void AudioDriverManager::add_driver(AudioDriver *p_driver) {
  176. ERR_FAIL_COND(driver_count >= MAX_DRIVERS);
  177. drivers[driver_count - 1] = p_driver;
  178. // Last driver is always our dummy driver
  179. drivers[driver_count++] = &AudioDriverManager::dummy_driver;
  180. }
  181. int AudioDriverManager::get_driver_count() {
  182. return driver_count;
  183. }
  184. void AudioDriverManager::initialize(int p_driver) {
  185. GLOBAL_DEF_RST("audio/driver/enable_input", false);
  186. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "audio/driver/mix_rate", PROPERTY_HINT_RANGE, "11025,192000,1,or_greater,suffix:Hz"), DEFAULT_MIX_RATE);
  187. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "audio/driver/mix_rate.web", PROPERTY_HINT_RANGE, "0,192000,1,or_greater,suffix:Hz"), 0); // Safer default output_latency for web (use browser default).
  188. int failed_driver = -1;
  189. // Check if there is a selected driver
  190. if (p_driver >= 0 && p_driver < driver_count) {
  191. if (drivers[p_driver]->init() == OK) {
  192. drivers[p_driver]->set_singleton();
  193. return;
  194. } else {
  195. failed_driver = p_driver;
  196. }
  197. }
  198. // No selected driver, try them all in order
  199. for (int i = 0; i < driver_count; i++) {
  200. // Don't re-init the driver if it failed above
  201. if (i == failed_driver) {
  202. continue;
  203. }
  204. if (drivers[i]->init() == OK) {
  205. drivers[i]->set_singleton();
  206. break;
  207. }
  208. }
  209. if (driver_count > 1 && String(AudioDriver::get_singleton()->get_name()) == "Dummy") {
  210. WARN_PRINT("All audio drivers failed, falling back to the dummy driver.");
  211. }
  212. }
  213. AudioDriver *AudioDriverManager::get_driver(int p_driver) {
  214. ERR_FAIL_INDEX_V(p_driver, driver_count, nullptr);
  215. return drivers[p_driver];
  216. }
  217. //////////////////////////////////////////////
  218. //////////////////////////////////////////////
  219. //////////////////////////////////////////////
  220. //////////////////////////////////////////////
  221. void AudioServer::_driver_process(int p_frames, int32_t *p_buffer) {
  222. mix_count++;
  223. int todo = p_frames;
  224. #ifdef DEBUG_ENABLED
  225. uint64_t prof_ticks = OS::get_singleton()->get_ticks_usec();
  226. #endif
  227. if (channel_count != get_channel_count()) {
  228. // Amount of channels changed due to a output_device change
  229. // reinitialize the buses channels and buffers
  230. init_channels_and_buffers();
  231. }
  232. ERR_FAIL_COND_MSG(buses.is_empty() && todo, "AudioServer bus count is less than 1.");
  233. while (todo) {
  234. if (to_mix == 0) {
  235. _mix_step();
  236. }
  237. int to_copy = MIN(to_mix, todo);
  238. Bus *master = buses[0];
  239. int from = buffer_size - to_mix;
  240. int from_buf = p_frames - todo;
  241. //master master, send to output
  242. int cs = master->channels.size();
  243. // Take away 1 from the stride, as we are manually incrementing by 1 for stereo.
  244. uintptr_t stride_minus_one = (cs * 2) - 1;
  245. for (int k = 0; k < cs; k++) {
  246. // The destination start for data will be the same in all cases.
  247. int32_t *dest = &p_buffer[from_buf * (cs * 2) + (k * 2)];
  248. if (master->channels[k].active) {
  249. const AudioFrame *buf = master->channels[k].buffer.ptr();
  250. for (int j = 0; j < to_copy; j++) {
  251. float l = CLAMP(buf[from + j].left, -1.0, 1.0);
  252. int32_t vl = l * ((1 << 20) - 1);
  253. int32_t vl2 = (vl < 0 ? -1 : 1) * (ABS(vl) << 11);
  254. *dest = vl2;
  255. dest++;
  256. float r = CLAMP(buf[from + j].right, -1.0, 1.0);
  257. int32_t vr = r * ((1 << 20) - 1);
  258. int32_t vr2 = (vr < 0 ? -1 : 1) * (ABS(vr) << 11);
  259. *dest = vr2;
  260. dest += stride_minus_one;
  261. }
  262. } else {
  263. // Bizarrely, profiling indicates that detecting the common case of cs == 1,
  264. // k == 0, and using memset is SLOWER than setting them individually.
  265. // Perhaps it gets optimized to a faster instruction than memset.
  266. for (int j = 0; j < to_copy; j++) {
  267. *dest = 0;
  268. dest++;
  269. *dest = 0;
  270. dest += stride_minus_one;
  271. }
  272. }
  273. }
  274. todo -= to_copy;
  275. to_mix -= to_copy;
  276. }
  277. #ifdef DEBUG_ENABLED
  278. prof_time.add(OS::get_singleton()->get_ticks_usec() - prof_ticks);
  279. #endif
  280. }
  281. void AudioServer::_mix_step() {
  282. bool solo_mode = false;
  283. for (int i = 0; i < buses.size(); i++) {
  284. Bus *bus = buses[i];
  285. bus->index_cache = i; //might be moved around by editor, so..
  286. for (int k = 0; k < bus->channels.size(); k++) {
  287. bus->channels.write[k].used = false;
  288. }
  289. if (bus->solo) {
  290. //solo chain
  291. solo_mode = true;
  292. bus->soloed = true;
  293. do {
  294. if (bus != buses[0]) {
  295. //everything has a send save for master bus
  296. if (!bus_map.has(bus->send)) {
  297. bus = buses[0]; //send to master
  298. } else {
  299. int prev_index_cache = bus->index_cache;
  300. bus = bus_map[bus->send];
  301. if (prev_index_cache >= bus->index_cache) { //invalid, send to master
  302. bus = buses[0];
  303. }
  304. }
  305. bus->soloed = true;
  306. } else {
  307. bus = nullptr;
  308. }
  309. } while (bus);
  310. } else {
  311. bus->soloed = false;
  312. }
  313. }
  314. for (CallbackItem *ci : mix_callback_list) {
  315. ci->callback(ci->userdata);
  316. }
  317. for (AudioStreamPlaybackListNode *playback : playback_list) {
  318. // Paused streams are no-ops. Don't even mix audio from the stream playback.
  319. if (playback->state.load() == AudioStreamPlaybackListNode::PAUSED) {
  320. continue;
  321. }
  322. if (playback->stream_playback->get_is_sample()) {
  323. continue;
  324. }
  325. bool fading_out = playback->state.load() == AudioStreamPlaybackListNode::FADE_OUT_TO_DELETION || playback->state.load() == AudioStreamPlaybackListNode::FADE_OUT_TO_PAUSE;
  326. AudioFrame *buf = mix_buffer.ptrw();
  327. // Copy the lookeahead buffer into the mix buffer.
  328. for (int i = 0; i < LOOKAHEAD_BUFFER_SIZE; i++) {
  329. buf[i] = playback->lookahead[i];
  330. }
  331. // Mix the audio stream
  332. unsigned int mixed_frames = playback->stream_playback->mix(&buf[LOOKAHEAD_BUFFER_SIZE], playback->pitch_scale.get(), buffer_size);
  333. if (tag_used_audio_streams && playback->stream_playback->is_playing()) {
  334. playback->stream_playback->tag_used_streams();
  335. }
  336. if (mixed_frames != buffer_size) {
  337. // We know we have at least the size of our lookahead buffer for fade-out purposes.
  338. float fadeout_base = 0.94;
  339. float fadeout_coefficient = 1;
  340. static_assert(LOOKAHEAD_BUFFER_SIZE == 64, "Update fadeout_base and comment here if you change LOOKAHEAD_BUFFER_SIZE.");
  341. // 0.94 ^ 64 = 0.01906. There might still be a pop but it'll be way better than if we didn't do this.
  342. for (unsigned int idx = mixed_frames; idx < buffer_size; idx++) {
  343. fadeout_coefficient *= fadeout_base;
  344. buf[idx] *= fadeout_coefficient;
  345. }
  346. AudioStreamPlaybackListNode::PlaybackState new_state;
  347. new_state = AudioStreamPlaybackListNode::AWAITING_DELETION;
  348. playback->state.store(new_state);
  349. } else {
  350. // Move the last little bit of what we just mixed into our lookahead buffer.
  351. for (int i = 0; i < LOOKAHEAD_BUFFER_SIZE; i++) {
  352. playback->lookahead[i] = buf[buffer_size + i];
  353. }
  354. }
  355. AudioStreamPlaybackBusDetails *ptr = playback->bus_details.load();
  356. ERR_FAIL_NULL(ptr);
  357. // By putting null into the bus details pointers, we're taking ownership of their memory for the duration of this mix.
  358. AudioStreamPlaybackBusDetails bus_details = *ptr;
  359. // Mix to any active buses.
  360. for (int idx = 0; idx < MAX_BUSES_PER_PLAYBACK; idx++) {
  361. if (!bus_details.bus_active[idx]) {
  362. continue;
  363. }
  364. int bus_idx = thread_find_bus_index(bus_details.bus[idx]);
  365. int prev_bus_idx = -1;
  366. for (int search_idx = 0; search_idx < MAX_BUSES_PER_PLAYBACK; search_idx++) {
  367. if (!playback->prev_bus_details->bus_active[search_idx]) {
  368. continue;
  369. }
  370. if (playback->prev_bus_details->bus[search_idx].hash() == bus_details.bus[idx].hash()) {
  371. prev_bus_idx = search_idx;
  372. }
  373. }
  374. for (int channel_idx = 0; channel_idx < channel_count; channel_idx++) {
  375. AudioFrame *channel_buf = thread_get_channel_mix_buffer(bus_idx, channel_idx);
  376. if (fading_out) {
  377. bus_details.volume[idx][channel_idx] = AudioFrame(0, 0);
  378. }
  379. AudioFrame channel_vol = bus_details.volume[idx][channel_idx];
  380. AudioFrame prev_channel_vol = AudioFrame(0, 0);
  381. if (prev_bus_idx != -1) {
  382. prev_channel_vol = playback->prev_bus_details->volume[prev_bus_idx][channel_idx];
  383. }
  384. _mix_step_for_channel(channel_buf, buf, prev_channel_vol, channel_vol, playback->attenuation_filter_cutoff_hz.get(), playback->highshelf_gain.get(), &playback->filter_process[channel_idx * 2], &playback->filter_process[channel_idx * 2 + 1]);
  385. }
  386. }
  387. // Now go through and fade-out any buses that were being played to previously that we missed by going through current data.
  388. for (int idx = 0; idx < MAX_BUSES_PER_PLAYBACK; idx++) {
  389. if (!playback->prev_bus_details->bus_active[idx]) {
  390. continue;
  391. }
  392. int bus_idx = thread_find_bus_index(playback->prev_bus_details->bus[idx]);
  393. int current_bus_idx = -1;
  394. for (int search_idx = 0; search_idx < MAX_BUSES_PER_PLAYBACK; search_idx++) {
  395. if (bus_details.bus[search_idx] == playback->prev_bus_details->bus[idx]) {
  396. current_bus_idx = search_idx;
  397. }
  398. }
  399. if (current_bus_idx != -1) {
  400. // If we found a corresponding bus in the current bus assignments, we've already mixed to this bus.
  401. continue;
  402. }
  403. for (int channel_idx = 0; channel_idx < channel_count; channel_idx++) {
  404. AudioFrame *channel_buf = thread_get_channel_mix_buffer(bus_idx, channel_idx);
  405. AudioFrame prev_channel_vol = playback->prev_bus_details->volume[idx][channel_idx];
  406. // Fade out to silence
  407. _mix_step_for_channel(channel_buf, buf, prev_channel_vol, AudioFrame(0, 0), playback->attenuation_filter_cutoff_hz.get(), playback->highshelf_gain.get(), &playback->filter_process[channel_idx * 2], &playback->filter_process[channel_idx * 2 + 1]);
  408. }
  409. }
  410. // Copy the bus details we mixed with to the previous bus details to maintain volume ramps.
  411. std::copy(std::begin(bus_details.bus_active), std::end(bus_details.bus_active), std::begin(playback->prev_bus_details->bus_active));
  412. std::copy(std::begin(bus_details.bus), std::end(bus_details.bus), std::begin(playback->prev_bus_details->bus));
  413. for (int bus_idx = 0; bus_idx < MAX_BUSES_PER_PLAYBACK; bus_idx++) {
  414. std::copy(std::begin(bus_details.volume[bus_idx]), std::end(bus_details.volume[bus_idx]), std::begin(playback->prev_bus_details->volume[bus_idx]));
  415. }
  416. switch (playback->state.load()) {
  417. case AudioStreamPlaybackListNode::AWAITING_DELETION:
  418. case AudioStreamPlaybackListNode::FADE_OUT_TO_DELETION:
  419. playback_list.erase(playback, [](AudioStreamPlaybackListNode *p) {
  420. delete p->prev_bus_details;
  421. delete p->bus_details;
  422. p->stream_playback.unref();
  423. delete p;
  424. });
  425. break;
  426. case AudioStreamPlaybackListNode::FADE_OUT_TO_PAUSE: {
  427. // Pause the stream.
  428. AudioStreamPlaybackListNode::PlaybackState old_state, new_state;
  429. do {
  430. old_state = playback->state.load();
  431. new_state = AudioStreamPlaybackListNode::PAUSED;
  432. } while (!playback->state.compare_exchange_strong(/* expected= */ old_state, new_state));
  433. } break;
  434. case AudioStreamPlaybackListNode::PLAYING:
  435. case AudioStreamPlaybackListNode::PAUSED:
  436. // No-op!
  437. break;
  438. }
  439. }
  440. for (int i = buses.size() - 1; i >= 0; i--) {
  441. //go bus by bus
  442. Bus *bus = buses[i];
  443. for (int k = 0; k < bus->channels.size(); k++) {
  444. if (bus->channels[k].active && !bus->channels[k].used) {
  445. //buffer was not used, but it's still active, so it must be cleaned
  446. AudioFrame *buf = bus->channels.write[k].buffer.ptrw();
  447. for (uint32_t j = 0; j < buffer_size; j++) {
  448. buf[j] = AudioFrame(0, 0);
  449. }
  450. }
  451. }
  452. //process effects
  453. if (!bus->bypass) {
  454. for (int j = 0; j < bus->effects.size(); j++) {
  455. if (!bus->effects[j].enabled) {
  456. continue;
  457. }
  458. #ifdef DEBUG_ENABLED
  459. uint64_t ticks = OS::get_singleton()->get_ticks_usec();
  460. #endif
  461. for (int k = 0; k < bus->channels.size(); k++) {
  462. if (!(bus->channels[k].active || bus->channels[k].effect_instances[j]->process_silence())) {
  463. continue;
  464. }
  465. bus->channels.write[k].effect_instances.write[j]->process(bus->channels[k].buffer.ptr(), temp_buffer.write[k].ptrw(), buffer_size);
  466. }
  467. //swap buffers, so internal buffer always has the right data
  468. for (int k = 0; k < bus->channels.size(); k++) {
  469. if (!(buses[i]->channels[k].active || bus->channels[k].effect_instances[j]->process_silence())) {
  470. continue;
  471. }
  472. SWAP(bus->channels.write[k].buffer, temp_buffer.write[k]);
  473. }
  474. #ifdef DEBUG_ENABLED
  475. bus->effects.write[j].prof_time += OS::get_singleton()->get_ticks_usec() - ticks;
  476. #endif
  477. }
  478. }
  479. //process send
  480. Bus *send = nullptr;
  481. if (i > 0) {
  482. //everything has a send save for master bus
  483. if (!bus_map.has(bus->send)) {
  484. send = buses[0];
  485. } else {
  486. send = bus_map[bus->send];
  487. if (send->index_cache >= bus->index_cache) { //invalid, send to master
  488. send = buses[0];
  489. }
  490. }
  491. }
  492. for (int k = 0; k < bus->channels.size(); k++) {
  493. if (!bus->channels[k].active) {
  494. bus->channels.write[k].peak_volume = AudioFrame(AUDIO_MIN_PEAK_DB, AUDIO_MIN_PEAK_DB);
  495. continue;
  496. }
  497. AudioFrame *buf = bus->channels.write[k].buffer.ptrw();
  498. AudioFrame peak = AudioFrame(0, 0);
  499. float volume = Math::db_to_linear(bus->volume_db);
  500. if (solo_mode) {
  501. if (!bus->soloed) {
  502. volume = 0.0;
  503. }
  504. } else {
  505. if (bus->mute) {
  506. volume = 0.0;
  507. }
  508. }
  509. //apply volume and compute peak
  510. for (uint32_t j = 0; j < buffer_size; j++) {
  511. buf[j] *= volume;
  512. float l = ABS(buf[j].left);
  513. if (l > peak.left) {
  514. peak.left = l;
  515. }
  516. float r = ABS(buf[j].right);
  517. if (r > peak.right) {
  518. peak.right = r;
  519. }
  520. }
  521. bus->channels.write[k].peak_volume = AudioFrame(Math::linear_to_db(peak.left + AUDIO_PEAK_OFFSET), Math::linear_to_db(peak.right + AUDIO_PEAK_OFFSET));
  522. if (!bus->channels[k].used) {
  523. //see if any audio is contained, because channel was not used
  524. if (MAX(peak.right, peak.left) > Math::db_to_linear(channel_disable_threshold_db)) {
  525. bus->channels.write[k].last_mix_with_audio = mix_frames;
  526. } else if (mix_frames - bus->channels[k].last_mix_with_audio > channel_disable_frames) {
  527. bus->channels.write[k].active = false;
  528. continue; //went inactive, don't mix.
  529. }
  530. }
  531. if (send) {
  532. //if not master bus, send
  533. AudioFrame *target_buf = thread_get_channel_mix_buffer(send->index_cache, k);
  534. for (uint32_t j = 0; j < buffer_size; j++) {
  535. target_buf[j] += buf[j];
  536. }
  537. }
  538. }
  539. }
  540. mix_frames += buffer_size;
  541. to_mix = buffer_size;
  542. }
  543. void AudioServer::_mix_step_for_channel(AudioFrame *p_out_buf, AudioFrame *p_source_buf, AudioFrame p_vol_start, AudioFrame p_vol_final, float p_attenuation_filter_cutoff_hz, float p_highshelf_gain, AudioFilterSW::Processor *p_processor_l, AudioFilterSW::Processor *p_processor_r) {
  544. if (p_highshelf_gain != 0) {
  545. AudioFilterSW filter;
  546. filter.set_mode(AudioFilterSW::HIGHSHELF);
  547. filter.set_sampling_rate(AudioServer::get_singleton()->get_mix_rate());
  548. filter.set_cutoff(p_attenuation_filter_cutoff_hz);
  549. filter.set_resonance(1);
  550. filter.set_stages(1);
  551. filter.set_gain(p_highshelf_gain);
  552. ERR_FAIL_NULL(p_processor_l);
  553. ERR_FAIL_NULL(p_processor_r);
  554. bool is_just_started = p_vol_start.left == 0 && p_vol_start.right == 0;
  555. p_processor_l->set_filter(&filter, /* clear_history= */ is_just_started);
  556. p_processor_l->update_coeffs(buffer_size);
  557. p_processor_r->set_filter(&filter, /* clear_history= */ is_just_started);
  558. p_processor_r->update_coeffs(buffer_size);
  559. for (unsigned int frame_idx = 0; frame_idx < buffer_size; frame_idx++) {
  560. // Make this buffer size invariant if buffer_size ever becomes a project setting.
  561. float lerp_param = (float)frame_idx / buffer_size;
  562. AudioFrame vol = p_vol_final * lerp_param + (1 - lerp_param) * p_vol_start;
  563. AudioFrame mixed = vol * p_source_buf[frame_idx];
  564. p_processor_l->process_one_interp(mixed.left);
  565. p_processor_r->process_one_interp(mixed.right);
  566. p_out_buf[frame_idx] += mixed;
  567. }
  568. } else {
  569. for (unsigned int frame_idx = 0; frame_idx < buffer_size; frame_idx++) {
  570. // Make this buffer size invariant if buffer_size ever becomes a project setting.
  571. float lerp_param = (float)frame_idx / buffer_size;
  572. p_out_buf[frame_idx] += (p_vol_final * lerp_param + (1 - lerp_param) * p_vol_start) * p_source_buf[frame_idx];
  573. }
  574. }
  575. }
  576. AudioServer::AudioStreamPlaybackListNode *AudioServer::_find_playback_list_node(Ref<AudioStreamPlayback> p_playback) {
  577. for (AudioStreamPlaybackListNode *playback_list_node : playback_list) {
  578. if (playback_list_node->stream_playback == p_playback) {
  579. return playback_list_node;
  580. }
  581. }
  582. return nullptr;
  583. }
  584. bool AudioServer::thread_has_channel_mix_buffer(int p_bus, int p_buffer) const {
  585. if (p_bus < 0 || p_bus >= buses.size()) {
  586. return false;
  587. }
  588. if (p_buffer < 0 || p_buffer >= buses[p_bus]->channels.size()) {
  589. return false;
  590. }
  591. return true;
  592. }
  593. AudioFrame *AudioServer::thread_get_channel_mix_buffer(int p_bus, int p_buffer) {
  594. ERR_FAIL_INDEX_V(p_bus, buses.size(), nullptr);
  595. ERR_FAIL_INDEX_V(p_buffer, buses[p_bus]->channels.size(), nullptr);
  596. AudioFrame *data = buses.write[p_bus]->channels.write[p_buffer].buffer.ptrw();
  597. if (!buses[p_bus]->channels[p_buffer].used) {
  598. buses.write[p_bus]->channels.write[p_buffer].used = true;
  599. buses.write[p_bus]->channels.write[p_buffer].active = true;
  600. buses.write[p_bus]->channels.write[p_buffer].last_mix_with_audio = mix_frames;
  601. for (uint32_t i = 0; i < buffer_size; i++) {
  602. data[i] = AudioFrame(0, 0);
  603. }
  604. }
  605. return data;
  606. }
  607. int AudioServer::thread_get_mix_buffer_size() const {
  608. return buffer_size;
  609. }
  610. int AudioServer::thread_find_bus_index(const StringName &p_name) {
  611. if (bus_map.has(p_name)) {
  612. return bus_map[p_name]->index_cache;
  613. } else {
  614. return 0;
  615. }
  616. }
  617. void AudioServer::set_bus_count(int p_count) {
  618. ERR_FAIL_COND(p_count < 1);
  619. ERR_FAIL_INDEX(p_count, 256);
  620. MARK_EDITED
  621. lock();
  622. int cb = buses.size();
  623. if (p_count < buses.size()) {
  624. for (int i = p_count; i < buses.size(); i++) {
  625. bus_map.erase(buses[i]->name);
  626. memdelete(buses[i]);
  627. }
  628. }
  629. buses.resize(p_count);
  630. for (int i = cb; i < buses.size(); i++) {
  631. String attempt = "New Bus";
  632. int attempts = 1;
  633. while (true) {
  634. bool name_free = true;
  635. for (int j = 0; j < i; j++) {
  636. if (buses[j]->name == attempt) {
  637. name_free = false;
  638. break;
  639. }
  640. }
  641. if (!name_free) {
  642. attempts++;
  643. attempt = "New Bus " + itos(attempts);
  644. } else {
  645. break;
  646. }
  647. }
  648. buses.write[i] = memnew(Bus);
  649. buses.write[i]->channels.resize(channel_count);
  650. for (int j = 0; j < channel_count; j++) {
  651. buses.write[i]->channels.write[j].buffer.resize(buffer_size);
  652. }
  653. buses[i]->name = attempt;
  654. buses[i]->solo = false;
  655. buses[i]->mute = false;
  656. buses[i]->bypass = false;
  657. buses[i]->volume_db = 0;
  658. if (i > 0) {
  659. buses[i]->send = SceneStringName(Master);
  660. }
  661. bus_map[attempt] = buses[i];
  662. }
  663. unlock();
  664. AudioDriver::get_singleton()->set_sample_bus_count(p_count);
  665. emit_signal(SNAME("bus_layout_changed"));
  666. }
  667. void AudioServer::remove_bus(int p_index) {
  668. ERR_FAIL_INDEX(p_index, buses.size());
  669. ERR_FAIL_COND(p_index == 0);
  670. MARK_EDITED
  671. lock();
  672. bus_map.erase(buses[p_index]->name);
  673. memdelete(buses[p_index]);
  674. buses.remove_at(p_index);
  675. unlock();
  676. AudioDriver::get_singleton()->remove_sample_bus(p_index);
  677. emit_signal(SNAME("bus_layout_changed"));
  678. }
  679. void AudioServer::add_bus(int p_at_pos) {
  680. MARK_EDITED
  681. if (p_at_pos >= buses.size()) {
  682. p_at_pos = -1;
  683. } else if (p_at_pos == 0) {
  684. if (buses.size() > 1) {
  685. p_at_pos = 1;
  686. } else {
  687. p_at_pos = -1;
  688. }
  689. }
  690. String attempt = "New Bus";
  691. int attempts = 1;
  692. while (true) {
  693. bool name_free = true;
  694. for (int j = 0; j < buses.size(); j++) {
  695. if (buses[j]->name == attempt) {
  696. name_free = false;
  697. break;
  698. }
  699. }
  700. if (!name_free) {
  701. attempts++;
  702. attempt = "New Bus " + itos(attempts);
  703. } else {
  704. break;
  705. }
  706. }
  707. Bus *bus = memnew(Bus);
  708. bus->channels.resize(channel_count);
  709. for (int j = 0; j < channel_count; j++) {
  710. bus->channels.write[j].buffer.resize(buffer_size);
  711. }
  712. bus->name = attempt;
  713. bus->solo = false;
  714. bus->mute = false;
  715. bus->bypass = false;
  716. bus->volume_db = 0;
  717. bus_map[attempt] = bus;
  718. if (p_at_pos == -1) {
  719. buses.push_back(bus);
  720. } else {
  721. buses.insert(p_at_pos, bus);
  722. }
  723. AudioDriver::get_singleton()->add_sample_bus(p_at_pos);
  724. emit_signal(SNAME("bus_layout_changed"));
  725. }
  726. void AudioServer::move_bus(int p_bus, int p_to_pos) {
  727. ERR_FAIL_COND(p_bus < 1 || p_bus >= buses.size());
  728. ERR_FAIL_COND(p_to_pos != -1 && (p_to_pos < 1 || p_to_pos > buses.size()));
  729. MARK_EDITED
  730. if (p_bus == p_to_pos) {
  731. return;
  732. }
  733. Bus *bus = buses[p_bus];
  734. buses.remove_at(p_bus);
  735. if (p_to_pos == -1) {
  736. buses.push_back(bus);
  737. } else if (p_to_pos < p_bus) {
  738. buses.insert(p_to_pos, bus);
  739. } else {
  740. buses.insert(p_to_pos - 1, bus);
  741. }
  742. AudioDriver::get_singleton()->move_sample_bus(p_bus, p_to_pos);
  743. emit_signal(SNAME("bus_layout_changed"));
  744. }
  745. int AudioServer::get_bus_count() const {
  746. return buses.size();
  747. }
  748. void AudioServer::set_bus_name(int p_bus, const String &p_name) {
  749. ERR_FAIL_INDEX(p_bus, buses.size());
  750. if (p_bus == 0 && p_name != "Master") {
  751. return; // Bus 0 is always "Master".
  752. }
  753. MARK_EDITED
  754. lock();
  755. StringName old_name = buses[p_bus]->name;
  756. if (old_name == p_name) {
  757. unlock();
  758. return;
  759. }
  760. String attempt = p_name;
  761. int attempts = 1;
  762. while (true) {
  763. bool name_free = true;
  764. for (int i = 0; i < buses.size(); i++) {
  765. if (buses[i]->name == attempt) {
  766. name_free = false;
  767. break;
  768. }
  769. }
  770. if (name_free) {
  771. break;
  772. }
  773. attempts++;
  774. attempt = p_name + " " + itos(attempts);
  775. }
  776. bus_map.erase(old_name);
  777. buses[p_bus]->name = attempt;
  778. bus_map[attempt] = buses[p_bus];
  779. unlock();
  780. emit_signal(SNAME("bus_renamed"), p_bus, old_name, attempt);
  781. }
  782. String AudioServer::get_bus_name(int p_bus) const {
  783. ERR_FAIL_INDEX_V(p_bus, buses.size(), String());
  784. return buses[p_bus]->name;
  785. }
  786. int AudioServer::get_bus_index(const StringName &p_bus_name) const {
  787. for (int i = 0; i < buses.size(); ++i) {
  788. if (buses[i]->name == p_bus_name) {
  789. return i;
  790. }
  791. }
  792. return -1;
  793. }
  794. void AudioServer::set_bus_volume_db(int p_bus, float p_volume_db) {
  795. ERR_FAIL_INDEX(p_bus, buses.size());
  796. MARK_EDITED
  797. buses[p_bus]->volume_db = p_volume_db;
  798. AudioDriver::get_singleton()->set_sample_bus_volume_db(p_bus, p_volume_db);
  799. }
  800. float AudioServer::get_bus_volume_db(int p_bus) const {
  801. ERR_FAIL_INDEX_V(p_bus, buses.size(), 0);
  802. return buses[p_bus]->volume_db;
  803. }
  804. int AudioServer::get_bus_channels(int p_bus) const {
  805. ERR_FAIL_INDEX_V(p_bus, buses.size(), 0);
  806. return buses[p_bus]->channels.size();
  807. }
  808. void AudioServer::set_bus_send(int p_bus, const StringName &p_send) {
  809. ERR_FAIL_INDEX(p_bus, buses.size());
  810. MARK_EDITED
  811. buses[p_bus]->send = p_send;
  812. AudioDriver::get_singleton()->set_sample_bus_send(p_bus, p_send);
  813. }
  814. StringName AudioServer::get_bus_send(int p_bus) const {
  815. ERR_FAIL_INDEX_V(p_bus, buses.size(), StringName());
  816. return buses[p_bus]->send;
  817. }
  818. void AudioServer::set_bus_solo(int p_bus, bool p_enable) {
  819. ERR_FAIL_INDEX(p_bus, buses.size());
  820. MARK_EDITED
  821. buses[p_bus]->solo = p_enable;
  822. AudioDriver::get_singleton()->set_sample_bus_solo(p_bus, p_enable);
  823. }
  824. bool AudioServer::is_bus_solo(int p_bus) const {
  825. ERR_FAIL_INDEX_V(p_bus, buses.size(), false);
  826. return buses[p_bus]->solo;
  827. }
  828. void AudioServer::set_bus_mute(int p_bus, bool p_enable) {
  829. ERR_FAIL_INDEX(p_bus, buses.size());
  830. MARK_EDITED
  831. buses[p_bus]->mute = p_enable;
  832. AudioDriver::get_singleton()->set_sample_bus_mute(p_bus, p_enable);
  833. }
  834. bool AudioServer::is_bus_mute(int p_bus) const {
  835. ERR_FAIL_INDEX_V(p_bus, buses.size(), false);
  836. return buses[p_bus]->mute;
  837. }
  838. void AudioServer::set_bus_bypass_effects(int p_bus, bool p_enable) {
  839. ERR_FAIL_INDEX(p_bus, buses.size());
  840. MARK_EDITED
  841. buses[p_bus]->bypass = p_enable;
  842. }
  843. bool AudioServer::is_bus_bypassing_effects(int p_bus) const {
  844. ERR_FAIL_INDEX_V(p_bus, buses.size(), false);
  845. return buses[p_bus]->bypass;
  846. }
  847. void AudioServer::_update_bus_effects(int p_bus) {
  848. for (int i = 0; i < buses[p_bus]->channels.size(); i++) {
  849. buses.write[p_bus]->channels.write[i].effect_instances.resize(buses[p_bus]->effects.size());
  850. for (int j = 0; j < buses[p_bus]->effects.size(); j++) {
  851. Ref<AudioEffectInstance> fx = buses.write[p_bus]->effects.write[j].effect->instantiate();
  852. if (Object::cast_to<AudioEffectCompressorInstance>(*fx)) {
  853. Object::cast_to<AudioEffectCompressorInstance>(*fx)->set_current_channel(i);
  854. }
  855. buses.write[p_bus]->channels.write[i].effect_instances.write[j] = fx;
  856. }
  857. }
  858. }
  859. void AudioServer::add_bus_effect(int p_bus, const Ref<AudioEffect> &p_effect, int p_at_pos) {
  860. ERR_FAIL_COND(p_effect.is_null());
  861. ERR_FAIL_INDEX(p_bus, buses.size());
  862. MARK_EDITED
  863. lock();
  864. Bus::Effect fx;
  865. fx.effect = p_effect;
  866. //fx.instance=p_effect->instantiate();
  867. fx.enabled = true;
  868. #ifdef DEBUG_ENABLED
  869. fx.prof_time = 0;
  870. #endif
  871. if (p_at_pos >= buses[p_bus]->effects.size() || p_at_pos < 0) {
  872. buses[p_bus]->effects.push_back(fx);
  873. } else {
  874. buses[p_bus]->effects.insert(p_at_pos, fx);
  875. }
  876. _update_bus_effects(p_bus);
  877. unlock();
  878. }
  879. void AudioServer::remove_bus_effect(int p_bus, int p_effect) {
  880. ERR_FAIL_INDEX(p_bus, buses.size());
  881. MARK_EDITED
  882. lock();
  883. buses[p_bus]->effects.remove_at(p_effect);
  884. _update_bus_effects(p_bus);
  885. unlock();
  886. }
  887. int AudioServer::get_bus_effect_count(int p_bus) {
  888. ERR_FAIL_INDEX_V(p_bus, buses.size(), 0);
  889. return buses[p_bus]->effects.size();
  890. }
  891. Ref<AudioEffectInstance> AudioServer::get_bus_effect_instance(int p_bus, int p_effect, int p_channel) {
  892. ERR_FAIL_INDEX_V(p_bus, buses.size(), Ref<AudioEffectInstance>());
  893. ERR_FAIL_INDEX_V(p_effect, buses[p_bus]->effects.size(), Ref<AudioEffectInstance>());
  894. ERR_FAIL_INDEX_V(p_channel, buses[p_bus]->channels.size(), Ref<AudioEffectInstance>());
  895. return buses[p_bus]->channels[p_channel].effect_instances[p_effect];
  896. }
  897. Ref<AudioEffect> AudioServer::get_bus_effect(int p_bus, int p_effect) {
  898. ERR_FAIL_INDEX_V(p_bus, buses.size(), Ref<AudioEffect>());
  899. ERR_FAIL_INDEX_V(p_effect, buses[p_bus]->effects.size(), Ref<AudioEffect>());
  900. return buses[p_bus]->effects[p_effect].effect;
  901. }
  902. void AudioServer::swap_bus_effects(int p_bus, int p_effect, int p_by_effect) {
  903. ERR_FAIL_INDEX(p_bus, buses.size());
  904. ERR_FAIL_INDEX(p_effect, buses[p_bus]->effects.size());
  905. ERR_FAIL_INDEX(p_by_effect, buses[p_bus]->effects.size());
  906. MARK_EDITED
  907. lock();
  908. SWAP(buses.write[p_bus]->effects.write[p_effect], buses.write[p_bus]->effects.write[p_by_effect]);
  909. _update_bus_effects(p_bus);
  910. unlock();
  911. }
  912. void AudioServer::set_bus_effect_enabled(int p_bus, int p_effect, bool p_enabled) {
  913. ERR_FAIL_INDEX(p_bus, buses.size());
  914. ERR_FAIL_INDEX(p_effect, buses[p_bus]->effects.size());
  915. MARK_EDITED
  916. buses.write[p_bus]->effects.write[p_effect].enabled = p_enabled;
  917. }
  918. bool AudioServer::is_bus_effect_enabled(int p_bus, int p_effect) const {
  919. ERR_FAIL_INDEX_V(p_bus, buses.size(), false);
  920. ERR_FAIL_INDEX_V(p_effect, buses[p_bus]->effects.size(), false);
  921. return buses[p_bus]->effects[p_effect].enabled;
  922. }
  923. float AudioServer::get_bus_peak_volume_left_db(int p_bus, int p_channel) const {
  924. ERR_FAIL_INDEX_V(p_bus, buses.size(), 0);
  925. ERR_FAIL_INDEX_V(p_channel, buses[p_bus]->channels.size(), 0);
  926. return buses[p_bus]->channels[p_channel].peak_volume.left;
  927. }
  928. float AudioServer::get_bus_peak_volume_right_db(int p_bus, int p_channel) const {
  929. ERR_FAIL_INDEX_V(p_bus, buses.size(), 0);
  930. ERR_FAIL_INDEX_V(p_channel, buses[p_bus]->channels.size(), 0);
  931. return buses[p_bus]->channels[p_channel].peak_volume.right;
  932. }
  933. bool AudioServer::is_bus_channel_active(int p_bus, int p_channel) const {
  934. ERR_FAIL_INDEX_V(p_bus, buses.size(), false);
  935. ERR_FAIL_INDEX_V(p_channel, buses[p_bus]->channels.size(), false);
  936. return buses[p_bus]->channels[p_channel].active;
  937. }
  938. void AudioServer::set_playback_speed_scale(float p_scale) {
  939. ERR_FAIL_COND(p_scale <= 0);
  940. playback_speed_scale = p_scale;
  941. }
  942. float AudioServer::get_playback_speed_scale() const {
  943. return playback_speed_scale;
  944. }
  945. void AudioServer::start_playback_stream(Ref<AudioStreamPlayback> p_playback, const StringName &p_bus, Vector<AudioFrame> p_volume_db_vector, float p_start_time, float p_pitch_scale) {
  946. ERR_FAIL_COND(p_playback.is_null());
  947. HashMap<StringName, Vector<AudioFrame>> map;
  948. map[p_bus] = p_volume_db_vector;
  949. start_playback_stream(p_playback, map, p_start_time, p_pitch_scale);
  950. }
  951. void AudioServer::start_playback_stream(Ref<AudioStreamPlayback> p_playback, const HashMap<StringName, Vector<AudioFrame>> &p_bus_volumes, float p_start_time, float p_pitch_scale, float p_highshelf_gain, float p_attenuation_cutoff_hz) {
  952. ERR_FAIL_COND(p_playback.is_null());
  953. AudioStreamPlaybackListNode *playback_node = new AudioStreamPlaybackListNode();
  954. playback_node->stream_playback = p_playback;
  955. playback_node->stream_playback->start(p_start_time);
  956. AudioStreamPlaybackBusDetails *new_bus_details = new AudioStreamPlaybackBusDetails();
  957. int idx = 0;
  958. for (KeyValue<StringName, Vector<AudioFrame>> pair : p_bus_volumes) {
  959. if (pair.value.size() < channel_count || pair.value.size() != MAX_CHANNELS_PER_BUS) {
  960. delete new_bus_details;
  961. ERR_FAIL();
  962. }
  963. new_bus_details->bus_active[idx] = true;
  964. new_bus_details->bus[idx] = pair.key;
  965. for (int channel_idx = 0; channel_idx < MAX_CHANNELS_PER_BUS; channel_idx++) {
  966. new_bus_details->volume[idx][channel_idx] = pair.value[channel_idx];
  967. }
  968. idx++;
  969. }
  970. playback_node->bus_details = new_bus_details;
  971. playback_node->prev_bus_details = new AudioStreamPlaybackBusDetails();
  972. playback_node->pitch_scale.set(p_pitch_scale);
  973. playback_node->highshelf_gain.set(p_highshelf_gain);
  974. playback_node->attenuation_filter_cutoff_hz.set(p_attenuation_cutoff_hz);
  975. memset(playback_node->prev_bus_details->volume, 0, sizeof(playback_node->prev_bus_details->volume));
  976. for (AudioFrame &frame : playback_node->lookahead) {
  977. frame = AudioFrame(0, 0);
  978. }
  979. playback_node->state.store(AudioStreamPlaybackListNode::PLAYING);
  980. playback_list.insert(playback_node);
  981. }
  982. void AudioServer::stop_playback_stream(Ref<AudioStreamPlayback> p_playback) {
  983. ERR_FAIL_COND(p_playback.is_null());
  984. // Handle sample playback.
  985. if (p_playback->get_is_sample() && p_playback->get_sample_playback().is_valid()) {
  986. AudioServer::get_singleton()->stop_sample_playback(p_playback->get_sample_playback());
  987. return;
  988. }
  989. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  990. if (!playback_node) {
  991. return;
  992. }
  993. AudioStreamPlaybackListNode::PlaybackState new_state, old_state;
  994. do {
  995. old_state = playback_node->state.load();
  996. if (old_state == AudioStreamPlaybackListNode::AWAITING_DELETION) {
  997. break; // Don't fade out again.
  998. }
  999. new_state = AudioStreamPlaybackListNode::FADE_OUT_TO_DELETION;
  1000. } while (!playback_node->state.compare_exchange_strong(old_state, new_state));
  1001. }
  1002. void AudioServer::set_playback_bus_exclusive(Ref<AudioStreamPlayback> p_playback, const StringName &p_bus, Vector<AudioFrame> p_volumes) {
  1003. ERR_FAIL_COND(p_volumes.size() != MAX_CHANNELS_PER_BUS);
  1004. HashMap<StringName, Vector<AudioFrame>> map;
  1005. map[p_bus] = p_volumes;
  1006. set_playback_bus_volumes_linear(p_playback, map);
  1007. }
  1008. void AudioServer::set_playback_bus_volumes_linear(Ref<AudioStreamPlayback> p_playback, const HashMap<StringName, Vector<AudioFrame>> &p_bus_volumes) {
  1009. ERR_FAIL_COND(p_bus_volumes.size() > MAX_BUSES_PER_PLAYBACK);
  1010. // Samples.
  1011. if (p_playback->get_is_sample() && p_playback->get_sample_playback().is_valid()) {
  1012. Ref<AudioSamplePlayback> sample_playback = p_playback->get_sample_playback();
  1013. AudioDriver::get_singleton()->set_sample_playback_bus_volumes_linear(sample_playback, p_bus_volumes);
  1014. return;
  1015. }
  1016. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1017. if (!playback_node) {
  1018. return;
  1019. }
  1020. AudioStreamPlaybackBusDetails *old_bus_details, *new_bus_details = new AudioStreamPlaybackBusDetails();
  1021. int idx = 0;
  1022. for (KeyValue<StringName, Vector<AudioFrame>> pair : p_bus_volumes) {
  1023. if (idx >= MAX_BUSES_PER_PLAYBACK) {
  1024. break;
  1025. }
  1026. ERR_FAIL_COND(pair.value.size() < channel_count);
  1027. ERR_FAIL_COND(pair.value.size() != MAX_CHANNELS_PER_BUS);
  1028. new_bus_details->bus_active[idx] = true;
  1029. new_bus_details->bus[idx] = pair.key;
  1030. for (int channel_idx = 0; channel_idx < MAX_CHANNELS_PER_BUS; channel_idx++) {
  1031. new_bus_details->volume[idx][channel_idx] = pair.value[channel_idx];
  1032. }
  1033. idx++;
  1034. }
  1035. do {
  1036. old_bus_details = playback_node->bus_details.load();
  1037. } while (!playback_node->bus_details.compare_exchange_strong(old_bus_details, new_bus_details));
  1038. bus_details_graveyard.insert(old_bus_details);
  1039. }
  1040. void AudioServer::set_playback_all_bus_volumes_linear(Ref<AudioStreamPlayback> p_playback, Vector<AudioFrame> p_volumes) {
  1041. ERR_FAIL_COND(p_playback.is_null());
  1042. ERR_FAIL_COND(p_volumes.size() != MAX_CHANNELS_PER_BUS);
  1043. HashMap<StringName, Vector<AudioFrame>> map;
  1044. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1045. if (!playback_node) {
  1046. return;
  1047. }
  1048. for (int bus_idx = 0; bus_idx < MAX_BUSES_PER_PLAYBACK; bus_idx++) {
  1049. if (playback_node->bus_details.load()->bus_active[bus_idx]) {
  1050. map[playback_node->bus_details.load()->bus[bus_idx]] = p_volumes;
  1051. }
  1052. }
  1053. set_playback_bus_volumes_linear(p_playback, map);
  1054. }
  1055. void AudioServer::set_playback_pitch_scale(Ref<AudioStreamPlayback> p_playback, float p_pitch_scale) {
  1056. ERR_FAIL_COND(p_playback.is_null());
  1057. // Samples.
  1058. if (p_playback->get_is_sample() && p_playback->get_sample_playback().is_valid()) {
  1059. Ref<AudioSamplePlayback> sample_playback = p_playback->get_sample_playback();
  1060. AudioServer::get_singleton()->update_sample_playback_pitch_scale(sample_playback, p_pitch_scale);
  1061. return;
  1062. }
  1063. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1064. if (!playback_node) {
  1065. return;
  1066. }
  1067. playback_node->pitch_scale.set(p_pitch_scale);
  1068. }
  1069. void AudioServer::set_playback_paused(Ref<AudioStreamPlayback> p_playback, bool p_paused) {
  1070. ERR_FAIL_COND(p_playback.is_null());
  1071. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1072. if (!playback_node) {
  1073. return;
  1074. }
  1075. AudioStreamPlaybackListNode::PlaybackState new_state, old_state;
  1076. do {
  1077. old_state = playback_node->state.load();
  1078. new_state = p_paused ? AudioStreamPlaybackListNode::FADE_OUT_TO_PAUSE : AudioStreamPlaybackListNode::PLAYING;
  1079. if (!p_paused && old_state == AudioStreamPlaybackListNode::PLAYING) {
  1080. return; // No-op.
  1081. }
  1082. if (p_paused && (old_state == AudioStreamPlaybackListNode::PAUSED || old_state == AudioStreamPlaybackListNode::FADE_OUT_TO_PAUSE)) {
  1083. return; // No-op.
  1084. }
  1085. } while (!playback_node->state.compare_exchange_strong(old_state, new_state));
  1086. }
  1087. void AudioServer::set_playback_highshelf_params(Ref<AudioStreamPlayback> p_playback, float p_gain, float p_attenuation_cutoff_hz) {
  1088. ERR_FAIL_COND(p_playback.is_null());
  1089. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1090. if (!playback_node) {
  1091. return;
  1092. }
  1093. playback_node->attenuation_filter_cutoff_hz.set(p_attenuation_cutoff_hz);
  1094. playback_node->highshelf_gain.set(p_gain);
  1095. }
  1096. bool AudioServer::is_playback_active(Ref<AudioStreamPlayback> p_playback) {
  1097. ERR_FAIL_COND_V(p_playback.is_null(), false);
  1098. if (p_playback->get_is_sample() && p_playback->get_sample_playback().is_valid()) {
  1099. return sample_playback_list.has(p_playback->get_sample_playback());
  1100. }
  1101. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1102. if (!playback_node) {
  1103. return false;
  1104. }
  1105. return playback_node->state.load() == AudioStreamPlaybackListNode::PLAYING;
  1106. }
  1107. float AudioServer::get_playback_position(Ref<AudioStreamPlayback> p_playback) {
  1108. ERR_FAIL_COND_V(p_playback.is_null(), 0);
  1109. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1110. if (!playback_node) {
  1111. return 0;
  1112. }
  1113. return playback_node->stream_playback->get_playback_position();
  1114. }
  1115. bool AudioServer::is_playback_paused(Ref<AudioStreamPlayback> p_playback) {
  1116. ERR_FAIL_COND_V(p_playback.is_null(), false);
  1117. AudioStreamPlaybackListNode *playback_node = _find_playback_list_node(p_playback);
  1118. if (!playback_node) {
  1119. return false;
  1120. }
  1121. return playback_node->state.load() == AudioStreamPlaybackListNode::PAUSED || playback_node->state.load() == AudioStreamPlaybackListNode::FADE_OUT_TO_PAUSE;
  1122. }
  1123. uint64_t AudioServer::get_mix_count() const {
  1124. return mix_count;
  1125. }
  1126. uint64_t AudioServer::get_mixed_frames() const {
  1127. return mix_frames;
  1128. }
  1129. void AudioServer::notify_listener_changed() {
  1130. for (CallbackItem *ci : listener_changed_callback_list) {
  1131. ci->callback(ci->userdata);
  1132. }
  1133. }
  1134. void AudioServer::init_channels_and_buffers() {
  1135. channel_count = get_channel_count();
  1136. temp_buffer.resize(channel_count);
  1137. mix_buffer.resize(buffer_size + LOOKAHEAD_BUFFER_SIZE);
  1138. for (int i = 0; i < temp_buffer.size(); i++) {
  1139. temp_buffer.write[i].resize(buffer_size);
  1140. }
  1141. for (int i = 0; i < buses.size(); i++) {
  1142. buses[i]->channels.resize(channel_count);
  1143. for (int j = 0; j < channel_count; j++) {
  1144. buses.write[i]->channels.write[j].buffer.resize(buffer_size);
  1145. }
  1146. _update_bus_effects(i);
  1147. }
  1148. }
  1149. void AudioServer::init() {
  1150. channel_disable_threshold_db = GLOBAL_DEF_RST("audio/buses/channel_disable_threshold_db", -60.0);
  1151. channel_disable_frames = float(GLOBAL_DEF_RST(PropertyInfo(Variant::FLOAT, "audio/buses/channel_disable_time", PROPERTY_HINT_RANGE, "0,5,0.01,or_greater"), 2.0)) * get_mix_rate();
  1152. buffer_size = 512; //hardcoded for now
  1153. init_channels_and_buffers();
  1154. mix_count = 0;
  1155. set_bus_count(1);
  1156. set_bus_name(0, "Master");
  1157. if (AudioDriver::get_singleton()) {
  1158. AudioDriver::get_singleton()->start();
  1159. AudioDriver::get_singleton()->set_sample_bus_count(1);
  1160. }
  1161. #ifdef TOOLS_ENABLED
  1162. set_edited(false); //avoid editors from thinking this was edited
  1163. #endif
  1164. GLOBAL_DEF_RST("audio/video/video_delay_compensation_ms", 0);
  1165. }
  1166. void AudioServer::update() {
  1167. #ifdef DEBUG_ENABLED
  1168. if (EngineDebugger::is_profiling("servers")) {
  1169. // Driver time includes server time + effects times
  1170. // Server time includes effects times
  1171. uint64_t driver_time = AudioDriver::get_singleton()->get_profiling_time();
  1172. uint64_t server_time = prof_time.get();
  1173. // Subtract the server time from the driver time
  1174. if (driver_time > server_time) {
  1175. driver_time -= server_time;
  1176. }
  1177. Array values;
  1178. for (int i = buses.size() - 1; i >= 0; i--) {
  1179. Bus *bus = buses[i];
  1180. if (bus->bypass) {
  1181. continue;
  1182. }
  1183. for (int j = 0; j < bus->effects.size(); j++) {
  1184. if (!bus->effects[j].enabled) {
  1185. continue;
  1186. }
  1187. values.push_back(String(bus->name) + bus->effects[j].effect->get_name());
  1188. values.push_back(USEC_TO_SEC(bus->effects[j].prof_time));
  1189. // Subtract the effect time from the driver and server times
  1190. if (driver_time > bus->effects[j].prof_time) {
  1191. driver_time -= bus->effects[j].prof_time;
  1192. }
  1193. if (server_time > bus->effects[j].prof_time) {
  1194. server_time -= bus->effects[j].prof_time;
  1195. }
  1196. }
  1197. }
  1198. values.push_back("audio_server");
  1199. values.push_back(USEC_TO_SEC(server_time));
  1200. values.push_back("audio_driver");
  1201. values.push_back(USEC_TO_SEC(driver_time));
  1202. values.push_front("audio_thread");
  1203. EngineDebugger::profiler_add_frame_data("servers", values);
  1204. }
  1205. // Reset profiling times
  1206. for (int i = buses.size() - 1; i >= 0; i--) {
  1207. Bus *bus = buses[i];
  1208. if (bus->bypass) {
  1209. continue;
  1210. }
  1211. for (int j = 0; j < bus->effects.size(); j++) {
  1212. if (!bus->effects[j].enabled) {
  1213. continue;
  1214. }
  1215. bus->effects.write[j].prof_time = 0;
  1216. }
  1217. }
  1218. AudioDriver::get_singleton()->reset_profiling_time();
  1219. prof_time.set(0);
  1220. #endif
  1221. for (CallbackItem *ci : update_callback_list) {
  1222. ci->callback(ci->userdata);
  1223. }
  1224. mix_callback_list.maybe_cleanup();
  1225. update_callback_list.maybe_cleanup();
  1226. listener_changed_callback_list.maybe_cleanup();
  1227. playback_list.maybe_cleanup();
  1228. for (AudioStreamPlaybackBusDetails *bus_details : bus_details_graveyard_frame_old) {
  1229. bus_details_graveyard_frame_old.erase(bus_details, [](AudioStreamPlaybackBusDetails *d) { delete d; });
  1230. }
  1231. for (AudioStreamPlaybackBusDetails *bus_details : bus_details_graveyard) {
  1232. bus_details_graveyard_frame_old.insert(bus_details);
  1233. bus_details_graveyard.erase(bus_details);
  1234. }
  1235. bus_details_graveyard.maybe_cleanup();
  1236. bus_details_graveyard_frame_old.maybe_cleanup();
  1237. }
  1238. void AudioServer::load_default_bus_layout() {
  1239. String layout_path = GLOBAL_GET("audio/buses/default_bus_layout");
  1240. if (ResourceLoader::exists(layout_path)) {
  1241. Ref<AudioBusLayout> default_layout = ResourceLoader::load(layout_path);
  1242. if (default_layout.is_valid()) {
  1243. set_bus_layout(default_layout);
  1244. }
  1245. }
  1246. }
  1247. void AudioServer::finish() {
  1248. for (int i = 0; i < AudioDriverManager::get_driver_count(); i++) {
  1249. AudioDriverManager::get_driver(i)->finish();
  1250. }
  1251. for (int i = 0; i < buses.size(); i++) {
  1252. memdelete(buses[i]);
  1253. }
  1254. buses.clear();
  1255. }
  1256. /* MISC config */
  1257. void AudioServer::lock() {
  1258. AudioDriver::get_singleton()->lock();
  1259. }
  1260. void AudioServer::unlock() {
  1261. AudioDriver::get_singleton()->unlock();
  1262. }
  1263. AudioServer::SpeakerMode AudioServer::get_speaker_mode() const {
  1264. return (AudioServer::SpeakerMode)AudioDriver::get_singleton()->get_speaker_mode();
  1265. }
  1266. float AudioServer::get_mix_rate() const {
  1267. return AudioDriver::get_singleton()->get_mix_rate();
  1268. }
  1269. float AudioServer::read_output_peak_db() const {
  1270. return 0;
  1271. }
  1272. AudioServer *AudioServer::get_singleton() {
  1273. return singleton;
  1274. }
  1275. double AudioServer::get_output_latency() const {
  1276. return AudioDriver::get_singleton()->get_latency();
  1277. }
  1278. double AudioServer::get_time_to_next_mix() const {
  1279. return AudioDriver::get_singleton()->get_time_to_next_mix();
  1280. }
  1281. double AudioServer::get_time_since_last_mix() const {
  1282. return AudioDriver::get_singleton()->get_time_since_last_mix();
  1283. }
  1284. AudioServer *AudioServer::singleton = nullptr;
  1285. void AudioServer::add_update_callback(AudioCallback p_callback, void *p_userdata) {
  1286. CallbackItem *ci = new CallbackItem();
  1287. ci->callback = p_callback;
  1288. ci->userdata = p_userdata;
  1289. update_callback_list.insert(ci);
  1290. }
  1291. void AudioServer::remove_update_callback(AudioCallback p_callback, void *p_userdata) {
  1292. for (CallbackItem *ci : update_callback_list) {
  1293. if (ci->callback == p_callback && ci->userdata == p_userdata) {
  1294. update_callback_list.erase(ci, [](CallbackItem *c) { delete c; });
  1295. }
  1296. }
  1297. }
  1298. void AudioServer::add_mix_callback(AudioCallback p_callback, void *p_userdata) {
  1299. CallbackItem *ci = new CallbackItem();
  1300. ci->callback = p_callback;
  1301. ci->userdata = p_userdata;
  1302. mix_callback_list.insert(ci);
  1303. }
  1304. void AudioServer::remove_mix_callback(AudioCallback p_callback, void *p_userdata) {
  1305. for (CallbackItem *ci : mix_callback_list) {
  1306. if (ci->callback == p_callback && ci->userdata == p_userdata) {
  1307. mix_callback_list.erase(ci, [](CallbackItem *c) { delete c; });
  1308. }
  1309. }
  1310. }
  1311. void AudioServer::add_listener_changed_callback(AudioCallback p_callback, void *p_userdata) {
  1312. CallbackItem *ci = new CallbackItem();
  1313. ci->callback = p_callback;
  1314. ci->userdata = p_userdata;
  1315. listener_changed_callback_list.insert(ci);
  1316. }
  1317. void AudioServer::remove_listener_changed_callback(AudioCallback p_callback, void *p_userdata) {
  1318. for (CallbackItem *ci : listener_changed_callback_list) {
  1319. if (ci->callback == p_callback && ci->userdata == p_userdata) {
  1320. listener_changed_callback_list.erase(ci, [](CallbackItem *c) { delete c; });
  1321. }
  1322. }
  1323. }
  1324. void AudioServer::set_bus_layout(const Ref<AudioBusLayout> &p_bus_layout) {
  1325. ERR_FAIL_COND(p_bus_layout.is_null() || p_bus_layout->buses.is_empty());
  1326. lock();
  1327. for (int i = 0; i < buses.size(); i++) {
  1328. memdelete(buses[i]);
  1329. }
  1330. buses.resize(p_bus_layout->buses.size());
  1331. bus_map.clear();
  1332. AudioDriver::get_singleton()->set_sample_bus_count(buses.size());
  1333. for (int i = 0; i < p_bus_layout->buses.size(); i++) {
  1334. Bus *bus = memnew(Bus);
  1335. if (i == 0) {
  1336. bus->name = SceneStringName(Master);
  1337. } else {
  1338. bus->name = p_bus_layout->buses[i].name;
  1339. bus->send = p_bus_layout->buses[i].send;
  1340. AudioDriver::get_singleton()->set_sample_bus_send(i, bus->send);
  1341. }
  1342. bus->solo = p_bus_layout->buses[i].solo;
  1343. bus->mute = p_bus_layout->buses[i].mute;
  1344. bus->bypass = p_bus_layout->buses[i].bypass;
  1345. bus->volume_db = p_bus_layout->buses[i].volume_db;
  1346. AudioDriver::get_singleton()->set_sample_bus_solo(i, bus->solo);
  1347. AudioDriver::get_singleton()->set_sample_bus_mute(i, bus->mute);
  1348. AudioDriver::get_singleton()->set_sample_bus_volume_db(i, bus->volume_db);
  1349. for (int j = 0; j < p_bus_layout->buses[i].effects.size(); j++) {
  1350. Ref<AudioEffect> fx = p_bus_layout->buses[i].effects[j].effect;
  1351. if (fx.is_valid()) {
  1352. Bus::Effect bfx;
  1353. bfx.effect = fx;
  1354. bfx.enabled = p_bus_layout->buses[i].effects[j].enabled;
  1355. #ifdef DEBUG_ENABLED
  1356. bfx.prof_time = 0;
  1357. #endif
  1358. bus->effects.push_back(bfx);
  1359. }
  1360. }
  1361. bus_map[bus->name] = bus;
  1362. buses.write[i] = bus;
  1363. buses[i]->channels.resize(channel_count);
  1364. for (int j = 0; j < channel_count; j++) {
  1365. buses.write[i]->channels.write[j].buffer.resize(buffer_size);
  1366. }
  1367. _update_bus_effects(i);
  1368. }
  1369. #ifdef TOOLS_ENABLED
  1370. set_edited(false);
  1371. #endif
  1372. unlock();
  1373. // Samples bus sync.
  1374. }
  1375. Ref<AudioBusLayout> AudioServer::generate_bus_layout() const {
  1376. Ref<AudioBusLayout> state;
  1377. state.instantiate();
  1378. state->buses.resize(buses.size());
  1379. for (int i = 0; i < buses.size(); i++) {
  1380. state->buses.write[i].name = buses[i]->name;
  1381. state->buses.write[i].send = buses[i]->send;
  1382. state->buses.write[i].mute = buses[i]->mute;
  1383. state->buses.write[i].solo = buses[i]->solo;
  1384. state->buses.write[i].bypass = buses[i]->bypass;
  1385. state->buses.write[i].volume_db = buses[i]->volume_db;
  1386. for (int j = 0; j < buses[i]->effects.size(); j++) {
  1387. AudioBusLayout::Bus::Effect fx;
  1388. fx.effect = buses[i]->effects[j].effect;
  1389. fx.enabled = buses[i]->effects[j].enabled;
  1390. state->buses.write[i].effects.push_back(fx);
  1391. }
  1392. }
  1393. return state;
  1394. }
  1395. PackedStringArray AudioServer::get_output_device_list() {
  1396. return AudioDriver::get_singleton()->get_output_device_list();
  1397. }
  1398. String AudioServer::get_output_device() {
  1399. return AudioDriver::get_singleton()->get_output_device();
  1400. }
  1401. void AudioServer::set_output_device(const String &p_name) {
  1402. AudioDriver::get_singleton()->set_output_device(p_name);
  1403. }
  1404. PackedStringArray AudioServer::get_input_device_list() {
  1405. return AudioDriver::get_singleton()->get_input_device_list();
  1406. }
  1407. String AudioServer::get_input_device() {
  1408. return AudioDriver::get_singleton()->get_input_device();
  1409. }
  1410. void AudioServer::set_input_device(const String &p_name) {
  1411. AudioDriver::get_singleton()->set_input_device(p_name);
  1412. }
  1413. void AudioServer::set_enable_tagging_used_audio_streams(bool p_enable) {
  1414. tag_used_audio_streams = p_enable;
  1415. }
  1416. #ifdef TOOLS_ENABLED
  1417. void AudioServer::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1418. const String pf = p_function;
  1419. if ((p_idx == 0 && pf == "get_bus_index") || (p_idx == 1 && pf == "set_bus_send")) {
  1420. for (const AudioServer::Bus *E : buses) {
  1421. r_options->push_back(String(E->name).quote());
  1422. }
  1423. }
  1424. Object::get_argument_options(p_function, p_idx, r_options);
  1425. }
  1426. #endif
  1427. AudioServer::PlaybackType AudioServer::get_default_playback_type() const {
  1428. int playback_type = GLOBAL_GET("audio/general/default_playback_type");
  1429. ERR_FAIL_COND_V_MSG(
  1430. playback_type < 0 || playback_type >= PlaybackType::PLAYBACK_TYPE_MAX,
  1431. PlaybackType::PLAYBACK_TYPE_STREAM,
  1432. vformat(R"(Project settings value (%s) for "audio/general/default_playback_type" is not supported)", playback_type));
  1433. switch (playback_type) {
  1434. case 1: {
  1435. return PlaybackType::PLAYBACK_TYPE_SAMPLE;
  1436. } break;
  1437. case 0:
  1438. default: {
  1439. return PlaybackType::PLAYBACK_TYPE_STREAM;
  1440. } break;
  1441. }
  1442. }
  1443. bool AudioServer::is_stream_registered_as_sample(const Ref<AudioStream> &p_stream) {
  1444. ERR_FAIL_COND_V_MSG(p_stream.is_null(), false, "Parameter p_stream is null.");
  1445. return AudioDriver::get_singleton()->is_stream_registered_as_sample(p_stream);
  1446. }
  1447. void AudioServer::register_stream_as_sample(const Ref<AudioStream> &p_stream) {
  1448. ERR_FAIL_COND_MSG(p_stream.is_null(), "Parameter p_stream is null.");
  1449. ERR_FAIL_COND_MSG(!(p_stream->can_be_sampled()), "Parameter p_stream cannot be sampled.");
  1450. Ref<AudioSample> sample = p_stream->generate_sample();
  1451. register_sample(sample);
  1452. }
  1453. void AudioServer::unregister_stream_as_sample(const Ref<AudioStream> &p_stream) {
  1454. ERR_FAIL_COND_MSG(p_stream.is_null(), "Parameter p_stream is null.");
  1455. ERR_FAIL_COND_MSG(!(p_stream->can_be_sampled()), "Parameter p_stream cannot be sampled.");
  1456. Ref<AudioSample> sample = p_stream->generate_sample();
  1457. unregister_sample(sample);
  1458. }
  1459. void AudioServer::register_sample(const Ref<AudioSample> &p_sample) {
  1460. ERR_FAIL_COND_MSG(p_sample.is_null(), "Parameter p_sample is null.");
  1461. ERR_FAIL_COND_MSG(p_sample->stream.is_null(), "Parameter p_sample->stream is null.");
  1462. ERR_FAIL_COND_MSG(!(p_sample->stream->can_be_sampled()), "Parameter p_stream cannot be sampled.");
  1463. AudioDriver::get_singleton()->register_sample(p_sample);
  1464. }
  1465. void AudioServer::unregister_sample(const Ref<AudioSample> &p_sample) {
  1466. ERR_FAIL_COND_MSG(p_sample.is_null(), "Parameter p_sample is null.");
  1467. ERR_FAIL_COND_MSG(p_sample->stream.is_null(), "Parameter p_sample->stream is null.");
  1468. AudioDriver::get_singleton()->unregister_sample(p_sample);
  1469. }
  1470. void AudioServer::start_sample_playback(const Ref<AudioSamplePlayback> &p_playback) {
  1471. ERR_FAIL_COND_MSG(p_playback.is_null(), "Parameter p_playback is null.");
  1472. AudioDriver::get_singleton()->start_sample_playback(p_playback);
  1473. sample_playback_list.ordered_insert(p_playback);
  1474. }
  1475. void AudioServer::stop_sample_playback(const Ref<AudioSamplePlayback> &p_playback) {
  1476. ERR_FAIL_COND_MSG(p_playback.is_null(), "Parameter p_playback is null.");
  1477. AudioDriver::get_singleton()->stop_sample_playback(p_playback);
  1478. sample_playback_list.erase(p_playback);
  1479. }
  1480. void AudioServer::set_sample_playback_pause(const Ref<AudioSamplePlayback> &p_playback, bool p_paused) {
  1481. ERR_FAIL_COND_MSG(p_playback.is_null(), "Parameter p_playback is null.");
  1482. AudioDriver::get_singleton()->set_sample_playback_pause(p_playback, p_paused);
  1483. }
  1484. bool AudioServer::is_sample_playback_active(const Ref<AudioSamplePlayback> &p_playback) {
  1485. ERR_FAIL_COND_V_MSG(p_playback.is_null(), false, "Parameter p_playback is null.");
  1486. return AudioDriver::get_singleton()->is_sample_playback_active(p_playback);
  1487. }
  1488. void AudioServer::update_sample_playback_pitch_scale(const Ref<AudioSamplePlayback> &p_playback, float p_pitch_scale) {
  1489. ERR_FAIL_COND_MSG(p_playback.is_null(), "Parameter p_playback is null.");
  1490. return AudioDriver::get_singleton()->update_sample_playback_pitch_scale(p_playback, p_pitch_scale);
  1491. }
  1492. void AudioServer::_bind_methods() {
  1493. ClassDB::bind_method(D_METHOD("set_bus_count", "amount"), &AudioServer::set_bus_count);
  1494. ClassDB::bind_method(D_METHOD("get_bus_count"), &AudioServer::get_bus_count);
  1495. ClassDB::bind_method(D_METHOD("remove_bus", "index"), &AudioServer::remove_bus);
  1496. ClassDB::bind_method(D_METHOD("add_bus", "at_position"), &AudioServer::add_bus, DEFVAL(-1));
  1497. ClassDB::bind_method(D_METHOD("move_bus", "index", "to_index"), &AudioServer::move_bus);
  1498. ClassDB::bind_method(D_METHOD("set_bus_name", "bus_idx", "name"), &AudioServer::set_bus_name);
  1499. ClassDB::bind_method(D_METHOD("get_bus_name", "bus_idx"), &AudioServer::get_bus_name);
  1500. ClassDB::bind_method(D_METHOD("get_bus_index", "bus_name"), &AudioServer::get_bus_index);
  1501. ClassDB::bind_method(D_METHOD("get_bus_channels", "bus_idx"), &AudioServer::get_bus_channels);
  1502. ClassDB::bind_method(D_METHOD("set_bus_volume_db", "bus_idx", "volume_db"), &AudioServer::set_bus_volume_db);
  1503. ClassDB::bind_method(D_METHOD("get_bus_volume_db", "bus_idx"), &AudioServer::get_bus_volume_db);
  1504. ClassDB::bind_method(D_METHOD("set_bus_send", "bus_idx", "send"), &AudioServer::set_bus_send);
  1505. ClassDB::bind_method(D_METHOD("get_bus_send", "bus_idx"), &AudioServer::get_bus_send);
  1506. ClassDB::bind_method(D_METHOD("set_bus_solo", "bus_idx", "enable"), &AudioServer::set_bus_solo);
  1507. ClassDB::bind_method(D_METHOD("is_bus_solo", "bus_idx"), &AudioServer::is_bus_solo);
  1508. ClassDB::bind_method(D_METHOD("set_bus_mute", "bus_idx", "enable"), &AudioServer::set_bus_mute);
  1509. ClassDB::bind_method(D_METHOD("is_bus_mute", "bus_idx"), &AudioServer::is_bus_mute);
  1510. ClassDB::bind_method(D_METHOD("set_bus_bypass_effects", "bus_idx", "enable"), &AudioServer::set_bus_bypass_effects);
  1511. ClassDB::bind_method(D_METHOD("is_bus_bypassing_effects", "bus_idx"), &AudioServer::is_bus_bypassing_effects);
  1512. ClassDB::bind_method(D_METHOD("add_bus_effect", "bus_idx", "effect", "at_position"), &AudioServer::add_bus_effect, DEFVAL(-1));
  1513. ClassDB::bind_method(D_METHOD("remove_bus_effect", "bus_idx", "effect_idx"), &AudioServer::remove_bus_effect);
  1514. ClassDB::bind_method(D_METHOD("get_bus_effect_count", "bus_idx"), &AudioServer::get_bus_effect_count);
  1515. ClassDB::bind_method(D_METHOD("get_bus_effect", "bus_idx", "effect_idx"), &AudioServer::get_bus_effect);
  1516. ClassDB::bind_method(D_METHOD("get_bus_effect_instance", "bus_idx", "effect_idx", "channel"), &AudioServer::get_bus_effect_instance, DEFVAL(0));
  1517. ClassDB::bind_method(D_METHOD("swap_bus_effects", "bus_idx", "effect_idx", "by_effect_idx"), &AudioServer::swap_bus_effects);
  1518. ClassDB::bind_method(D_METHOD("set_bus_effect_enabled", "bus_idx", "effect_idx", "enabled"), &AudioServer::set_bus_effect_enabled);
  1519. ClassDB::bind_method(D_METHOD("is_bus_effect_enabled", "bus_idx", "effect_idx"), &AudioServer::is_bus_effect_enabled);
  1520. ClassDB::bind_method(D_METHOD("get_bus_peak_volume_left_db", "bus_idx", "channel"), &AudioServer::get_bus_peak_volume_left_db);
  1521. ClassDB::bind_method(D_METHOD("get_bus_peak_volume_right_db", "bus_idx", "channel"), &AudioServer::get_bus_peak_volume_right_db);
  1522. ClassDB::bind_method(D_METHOD("set_playback_speed_scale", "scale"), &AudioServer::set_playback_speed_scale);
  1523. ClassDB::bind_method(D_METHOD("get_playback_speed_scale"), &AudioServer::get_playback_speed_scale);
  1524. ClassDB::bind_method(D_METHOD("lock"), &AudioServer::lock);
  1525. ClassDB::bind_method(D_METHOD("unlock"), &AudioServer::unlock);
  1526. ClassDB::bind_method(D_METHOD("get_speaker_mode"), &AudioServer::get_speaker_mode);
  1527. ClassDB::bind_method(D_METHOD("get_mix_rate"), &AudioServer::get_mix_rate);
  1528. ClassDB::bind_method(D_METHOD("get_output_device_list"), &AudioServer::get_output_device_list);
  1529. ClassDB::bind_method(D_METHOD("get_output_device"), &AudioServer::get_output_device);
  1530. ClassDB::bind_method(D_METHOD("set_output_device", "name"), &AudioServer::set_output_device);
  1531. ClassDB::bind_method(D_METHOD("get_time_to_next_mix"), &AudioServer::get_time_to_next_mix);
  1532. ClassDB::bind_method(D_METHOD("get_time_since_last_mix"), &AudioServer::get_time_since_last_mix);
  1533. ClassDB::bind_method(D_METHOD("get_output_latency"), &AudioServer::get_output_latency);
  1534. ClassDB::bind_method(D_METHOD("get_input_device_list"), &AudioServer::get_input_device_list);
  1535. ClassDB::bind_method(D_METHOD("get_input_device"), &AudioServer::get_input_device);
  1536. ClassDB::bind_method(D_METHOD("set_input_device", "name"), &AudioServer::set_input_device);
  1537. ClassDB::bind_method(D_METHOD("set_bus_layout", "bus_layout"), &AudioServer::set_bus_layout);
  1538. ClassDB::bind_method(D_METHOD("generate_bus_layout"), &AudioServer::generate_bus_layout);
  1539. ClassDB::bind_method(D_METHOD("set_enable_tagging_used_audio_streams", "enable"), &AudioServer::set_enable_tagging_used_audio_streams);
  1540. ClassDB::bind_method(D_METHOD("is_stream_registered_as_sample", "stream"), &AudioServer::is_stream_registered_as_sample);
  1541. ClassDB::bind_method(D_METHOD("register_stream_as_sample", "stream"), &AudioServer::register_stream_as_sample);
  1542. ADD_PROPERTY(PropertyInfo(Variant::INT, "bus_count"), "set_bus_count", "get_bus_count");
  1543. ADD_PROPERTY(PropertyInfo(Variant::STRING, "output_device"), "set_output_device", "get_output_device");
  1544. ADD_PROPERTY(PropertyInfo(Variant::STRING, "input_device"), "set_input_device", "get_input_device");
  1545. // The default value may be set to an empty string by the platform-specific audio driver.
  1546. // Override for class reference generation purposes.
  1547. ADD_PROPERTY_DEFAULT("input_device", "Default");
  1548. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "playback_speed_scale"), "set_playback_speed_scale", "get_playback_speed_scale");
  1549. ADD_SIGNAL(MethodInfo("bus_layout_changed"));
  1550. ADD_SIGNAL(MethodInfo("bus_renamed", PropertyInfo(Variant::INT, "bus_index"), PropertyInfo(Variant::STRING_NAME, "old_name"), PropertyInfo(Variant::STRING_NAME, "new_name")));
  1551. BIND_ENUM_CONSTANT(SPEAKER_MODE_STEREO);
  1552. BIND_ENUM_CONSTANT(SPEAKER_SURROUND_31);
  1553. BIND_ENUM_CONSTANT(SPEAKER_SURROUND_51);
  1554. BIND_ENUM_CONSTANT(SPEAKER_SURROUND_71);
  1555. BIND_ENUM_CONSTANT(PLAYBACK_TYPE_DEFAULT);
  1556. BIND_ENUM_CONSTANT(PLAYBACK_TYPE_STREAM);
  1557. BIND_ENUM_CONSTANT(PLAYBACK_TYPE_SAMPLE);
  1558. BIND_ENUM_CONSTANT(PLAYBACK_TYPE_MAX);
  1559. }
  1560. AudioServer::AudioServer() {
  1561. singleton = this;
  1562. }
  1563. AudioServer::~AudioServer() {
  1564. singleton = nullptr;
  1565. }
  1566. /////////////////////////////////
  1567. bool AudioBusLayout::_set(const StringName &p_name, const Variant &p_value) {
  1568. String s = p_name;
  1569. if (s.begins_with("bus/")) {
  1570. int index = s.get_slice("/", 1).to_int();
  1571. if (buses.size() <= index) {
  1572. buses.resize(index + 1);
  1573. }
  1574. Bus &bus = buses.write[index];
  1575. String what = s.get_slice("/", 2);
  1576. if (what == "name") {
  1577. bus.name = p_value;
  1578. } else if (what == "solo") {
  1579. bus.solo = p_value;
  1580. } else if (what == "mute") {
  1581. bus.mute = p_value;
  1582. } else if (what == "bypass_fx") {
  1583. bus.bypass = p_value;
  1584. } else if (what == "volume_db") {
  1585. bus.volume_db = p_value;
  1586. } else if (what == "send") {
  1587. bus.send = p_value;
  1588. } else if (what == "effect") {
  1589. int which = s.get_slice("/", 3).to_int();
  1590. if (bus.effects.size() <= which) {
  1591. bus.effects.resize(which + 1);
  1592. }
  1593. Bus::Effect &fx = bus.effects.write[which];
  1594. String fxwhat = s.get_slice("/", 4);
  1595. if (fxwhat == "effect") {
  1596. fx.effect = p_value;
  1597. } else if (fxwhat == "enabled") {
  1598. fx.enabled = p_value;
  1599. } else {
  1600. return false;
  1601. }
  1602. return true;
  1603. } else {
  1604. return false;
  1605. }
  1606. return true;
  1607. }
  1608. return false;
  1609. }
  1610. bool AudioBusLayout::_get(const StringName &p_name, Variant &r_ret) const {
  1611. String s = p_name;
  1612. if (s.begins_with("bus/")) {
  1613. int index = s.get_slice("/", 1).to_int();
  1614. if (index < 0 || index >= buses.size()) {
  1615. return false;
  1616. }
  1617. const Bus &bus = buses[index];
  1618. String what = s.get_slice("/", 2);
  1619. if (what == "name") {
  1620. r_ret = bus.name;
  1621. } else if (what == "solo") {
  1622. r_ret = bus.solo;
  1623. } else if (what == "mute") {
  1624. r_ret = bus.mute;
  1625. } else if (what == "bypass_fx") {
  1626. r_ret = bus.bypass;
  1627. } else if (what == "volume_db") {
  1628. r_ret = bus.volume_db;
  1629. } else if (what == "send") {
  1630. r_ret = bus.send;
  1631. } else if (what == "effect") {
  1632. int which = s.get_slice("/", 3).to_int();
  1633. if (which < 0 || which >= bus.effects.size()) {
  1634. return false;
  1635. }
  1636. const Bus::Effect &fx = bus.effects[which];
  1637. String fxwhat = s.get_slice("/", 4);
  1638. if (fxwhat == "effect") {
  1639. r_ret = fx.effect;
  1640. } else if (fxwhat == "enabled") {
  1641. r_ret = fx.enabled;
  1642. } else {
  1643. return false;
  1644. }
  1645. return true;
  1646. } else {
  1647. return false;
  1648. }
  1649. return true;
  1650. }
  1651. return false;
  1652. }
  1653. void AudioBusLayout::_get_property_list(List<PropertyInfo> *p_list) const {
  1654. for (int i = 0; i < buses.size(); i++) {
  1655. p_list->push_back(PropertyInfo(Variant::STRING, "bus/" + itos(i) + "/name", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1656. p_list->push_back(PropertyInfo(Variant::BOOL, "bus/" + itos(i) + "/solo", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1657. p_list->push_back(PropertyInfo(Variant::BOOL, "bus/" + itos(i) + "/mute", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1658. p_list->push_back(PropertyInfo(Variant::BOOL, "bus/" + itos(i) + "/bypass_fx", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1659. p_list->push_back(PropertyInfo(Variant::FLOAT, "bus/" + itos(i) + "/volume_db", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1660. p_list->push_back(PropertyInfo(Variant::FLOAT, "bus/" + itos(i) + "/send", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1661. for (int j = 0; j < buses[i].effects.size(); j++) {
  1662. p_list->push_back(PropertyInfo(Variant::OBJECT, "bus/" + itos(i) + "/effect/" + itos(j) + "/effect", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1663. p_list->push_back(PropertyInfo(Variant::BOOL, "bus/" + itos(i) + "/effect/" + itos(j) + "/enabled", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  1664. }
  1665. }
  1666. }
  1667. AudioBusLayout::AudioBusLayout() {
  1668. buses.resize(1);
  1669. buses.write[0].name = SceneStringName(Master);
  1670. }