Audio Recording from godot #15967

Tugsav · 2018-01-22T08:17:14Z

This pull request implements an Audio bus effect, that outputs the audio from the bus into a raw audio file.

I implemented this since i needed it myself but figured i would put it up as a PR in case it could be useful for others.

Potential use case examples:

Record audio for in-game cut-scene
Allowing the user to save specific audio during run-time, for an example if you have a recorder in-game.

[edit]
As per the suggestions, the functionality has been changed in the following ways
The audio effect now records into a buffer that a user can get an AudioStreamSample object from.
AudioStreamSample formats supported are 8-bit and 16-bit PCM, as well as IMA_ADPCM
Additionally a function has been added to AudioStreamSample that allows the user to save it as a WAV file.
Supported formats for saving as WAV are 8-bit and 16-bit PCM

ghost · 2018-01-22T09:13:51Z

servers/audio/effects/audio_effect_record.cpp

@@ -0,0 +1,101 @@
+/*************************************************************************/
+/*  audio_effect_record.cpp                                             */


Please keep the */ in line on both files.

Thanks for contributing! Very nice feature. :)

Fixed. Thanks for spotting it quickly

Zylann · 2018-01-22T10:18:47Z

Aaah I thought it was for recording with a mic ^^"

groud · 2018-01-22T14:19:12Z

How do you change the output format ?

Tugsav · 2018-01-22T14:53:05Z

The output format is raw audio (no format really). In order to play it with a media player you have to encode it to a real format.
As an example i used ffmpeg to make a wav file:
ffmpeg -f f32le -ar 44.1k -ac 2 -i testaudio.raw testconverted.wav

groud · 2018-01-23T13:05:27Z

I like the idea, but I wonder if how it is useful when building a game.
I think it would be better making this a plugin, as I see few realistic use cases.

But maybe you have a good counter-example. ^^

Tugsav · 2018-01-23T14:22:18Z

The original intention of this were to use it for pre-rendered cutscenes created in the godot engine (using the --fixed-fps and --disable-render-loop flags and using a GD-script to save frames).
As for whether to use pre-rendered cutscenes or not (or a mix) the opinions are many ^^'

reduz · 2018-01-23T14:32:02Z

Memory allocation and IO in audio threads is forbidden, you should probably use a ringbuffer for this and write in another thread.

Also, we should expose AudioEffect via GDNative, so you can do this without needing to modify core godot.

Zylann · 2018-01-23T17:03:05Z

Being able to write AudioEffects using GDNative would be awesome :D

Tugsav · 2018-01-25T12:06:40Z

I have moved the IO to a separate thread and instead buffered the Audio as requested. Also the recording audio effect now creates a header in the file so that we get valid (though completely uncompressed) .wav files.

I am not sure if there isn't a better way of dealing with creation of the thread though. Optimally it should only be started when beginning a new recording, but i am not sure if it is allowed to start the thread from within the Audio thread.

Tugsav · 2018-02-26T10:41:46Z

I have rebased the PR to adhere to the guidelines. Also the audio is now saved as uncompressed .wav files instead of raw audio.

reduz · 2018-05-07T20:53:25Z

@SaracenOne is working on something similar that also includes audio input. Holding off on this one to see how both mix, if they do.

SaracenOne · 2018-05-08T06:43:51Z

@reduz It should be fine I think. As per what we discussed, my microphone code is only interested in trying to get microphone input from the audio driver into an audio stream, and then ultimately into the mixer where we can do things with it.

reduz · 2018-07-04T21:17:04Z

After discussion, probably a more desired functionality would be to just record to an AudioStreamSample, and eventually add a function to it to save to a wav file. This way we can use it together with the new option to record from microphone

Tugsav · 2018-07-24T06:10:58Z

@reduz PR has been updated in an attempt to implement it like the desired functionality. PR description has been updated as well.

akien-mga · 2018-07-24T15:25:36Z

scene/resources/audio_stream_sample.cpp

@@ -509,6 +509,34 @@ PoolVector<uint8_t> AudioStreamSample::get_data() const {
 	return pv;
 }

+void AudioStreamSample::save_to_wav(String path) {
+//	float sample_rate = AudioServer::get_singleton()->get_mix_rate();


Would you mind amend the first commit to remove/not add the commented out code? (You can leave a stub with a TODO comment if you want though.)

akien-mga · 2018-07-24T15:27:04Z

servers/audio/effects/audio_effect_record.cpp

+			//Read from the buffer into file
+			_io_store_buffer();
+			//Update the header
+			//_create_wav_header(ring_buffer_pos); //The ring_buffer_pos will be consistent with the amount of frames written


New commented out code here, should it be removed or fixed?

akien-mga · 2018-07-24T15:28:03Z

scene/resources/audio_stream_sample.cpp

@@ -509,6 +511,76 @@ PoolVector<uint8_t> AudioStreamSample::get_data() const {
 	return pv;
 }

+void AudioStreamSample::save_to_wav(String p_path) {
+	if (format == AudioStreamSample::FORMAT_IMA_ADPCM) {
+		printf("Saving IMA_ADPC samples are not supported yet\n");


You can use WARN_PRINTS to issue a proper warning (it takes a String, with no need for newline character at the end).

akien-mga · 2018-07-24T16:09:35Z

There seems to be a build issue on Android: https://travis-ci.org/godotengine/godot/jobs/407176455 (you might need to press the "Raw log" button if it doesn't show up)

Tugsav · 2018-07-25T06:49:02Z

I will look into those that build issue. It seems to be linked to the fact that i madeResourceImporterWAV::_compress_ima_adpcm into a static method.
Not sure if i should fix the commented code or just squash both commits into a single one.

akien-mga · 2018-07-25T07:21:18Z

Not sure if i should fix the commented code or just squash both commits into a single one.

That's up to you, but I think it makes sense to have two commits, once for implementing the audio recording feature, and one for implement the save to WAV.

Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav

8 and 16 bit sample saving has been implemented.

Tugsav · 2018-07-26T13:33:11Z

Recommended changes have been applied, and the Android build issue resolved

akien-mga · 2018-07-26T13:37:01Z

Awesome, thanks!

akien-mga added enhancement topic:audio labels Jan 22, 2018

akien-mga added this to the 3.1 milestone Jan 22, 2018

Tugsav force-pushed the AudioRecordingModule branch from 931e16e to 27e5184 Compare January 22, 2018 08:57

ghost reviewed Jan 22, 2018

View reviewed changes

Tugsav force-pushed the AudioRecordingModule branch from 27e5184 to 03c2afe Compare January 22, 2018 09:22

Tugsav force-pushed the AudioRecordingModule branch 4 times, most recently from a4a791d to ff2bb19 Compare January 29, 2018 10:37

hungrymonkey mentioned this pull request Feb 4, 2018

Created an inital guide on how to make audiostreams godotengine/godot-docs#1047

Merged

Tugsav force-pushed the AudioRecordingModule branch 2 times, most recently from 83842c9 to d80bb24 Compare February 26, 2018 08:31

Tugsav changed the title ~~Audio Recording from godot~~ Audio Recording from godot (WIP) Jul 23, 2018

Tugsav force-pushed the AudioRecordingModule branch 2 times, most recently from c2b9574 to caa01ad Compare July 23, 2018 14:30

Tugsav changed the title ~~Audio Recording from godot (WIP)~~ Audio Recording from godot Jul 24, 2018

Tugsav mentioned this pull request Jul 24, 2018

Scripts can now access the audio buffer #19977

Closed

akien-mga reviewed Jul 24, 2018

View reviewed changes

Tugsav force-pushed the AudioRecordingModule branch 6 times, most recently from 3b04390 to c1f6808 Compare July 26, 2018 11:41

Tugsav added 2 commits July 26, 2018 14:14

Audio Recording module

cd2070c

Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav

AudioStreamSample can now be saved to a WAV file

adb43b6

8 and 16 bit sample saving has been implemented.

Tugsav force-pushed the AudioRecordingModule branch from c1f6808 to adb43b6 Compare July 26, 2018 12:15

akien-mga merged commit 91d6fa8 into godotengine:master Jul 26, 2018

follower mentioned this pull request Sep 6, 2021

Fix the "AudioEffectRecord" descriptions. #52441

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Audio Recording from godot #15967

Audio Recording from godot #15967

Tugsav commented Jan 22, 2018 •

edited

Loading

ghost Jan 22, 2018

Tugsav Jan 22, 2018

Zylann commented Jan 22, 2018

groud commented Jan 22, 2018

Tugsav commented Jan 22, 2018

groud commented Jan 23, 2018

Tugsav commented Jan 23, 2018

reduz commented Jan 23, 2018

Zylann commented Jan 23, 2018

Tugsav commented Jan 25, 2018 •

edited

Loading

Tugsav commented Feb 26, 2018

reduz commented May 7, 2018

SaracenOne commented May 8, 2018

reduz commented Jul 4, 2018

Tugsav commented Jul 24, 2018

akien-mga Jul 24, 2018 •

edited

Loading

akien-mga Jul 24, 2018

akien-mga Jul 24, 2018

akien-mga commented Jul 24, 2018

Tugsav commented Jul 25, 2018

akien-mga commented Jul 25, 2018

Tugsav commented Jul 26, 2018

akien-mga commented Jul 26, 2018

		@@ -0,0 +1,101 @@
		/*************************************************************************/
		/* audio_effect_record.cpp */

Audio Recording from godot #15967

Audio Recording from godot #15967

Conversation

Tugsav commented Jan 22, 2018 • edited Loading

ghost Jan 22, 2018

Choose a reason for hiding this comment

Tugsav Jan 22, 2018

Choose a reason for hiding this comment

Zylann commented Jan 22, 2018

groud commented Jan 22, 2018

Tugsav commented Jan 22, 2018

groud commented Jan 23, 2018

Tugsav commented Jan 23, 2018

reduz commented Jan 23, 2018

Zylann commented Jan 23, 2018

Tugsav commented Jan 25, 2018 • edited Loading

Tugsav commented Feb 26, 2018

reduz commented May 7, 2018

SaracenOne commented May 8, 2018

reduz commented Jul 4, 2018

Tugsav commented Jul 24, 2018

akien-mga Jul 24, 2018 • edited Loading

Choose a reason for hiding this comment

akien-mga Jul 24, 2018

Choose a reason for hiding this comment

akien-mga Jul 24, 2018

Choose a reason for hiding this comment

akien-mga commented Jul 24, 2018

Tugsav commented Jul 25, 2018

akien-mga commented Jul 25, 2018

Tugsav commented Jul 26, 2018

akien-mga commented Jul 26, 2018

Tugsav commented Jan 22, 2018 •

edited

Loading

Tugsav commented Jan 25, 2018 •

edited

Loading

akien-mga Jul 24, 2018 •

edited

Loading