audio_server.cpp 58 KB

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