Skip to content

Commit

Permalink
Add exrwav export to Godot Engine for movie making.
Browse files Browse the repository at this point in the history
  • Loading branch information
@fire
fire committed Mar 2, 2023
1 parent 92bee43 commit b7af17b
Show file tree
Hide file tree
Showing 3 changed files with 247 additions and 0 deletions.
170 changes: 170 additions & 0 deletions servers/movie_writer/movie_writer_exrwav.cpp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
/**************************************************************************/
/* movie_writer_exrwav.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

#include "movie_writer_exrwav.h"
#include "core/config/project_settings.h"
#include "core/io/dir_access.h"

uint32_t MovieWriterEXRWAV::get_audio_mix_rate() const {
return mix_rate;
}
AudioServer::SpeakerMode MovieWriterEXRWAV::get_audio_speaker_mode() const {
return speaker_mode;
}

void MovieWriterEXRWAV::get_supported_extensions(List<String> *r_extensions) const {
r_extensions->push_back("exr");
}

bool MovieWriterEXRWAV::handles_file(const String &p_path) const {
return p_path.get_extension().to_lower() == "exr";
}

String MovieWriterEXRWAV::zeros_str(uint32_t p_index) {
char zeros[MAX_TRAILING_ZEROS + 1];
for (uint32_t i = 0; i < MAX_TRAILING_ZEROS; i++) {
uint32_t idx = MAX_TRAILING_ZEROS - i - 1;
uint32_t digit = (p_index / uint32_t(Math::pow(double(10), double(idx)))) % 10;
zeros[i] = '0' + digit;
}
zeros[MAX_TRAILING_ZEROS] = 0;
return zeros;
}

Error MovieWriterEXRWAV::write_begin(const Size2i &p_movie_size, uint32_t p_fps, const String &p_base_path) {
// Quick & Dirty PNGEXR Code based on - https://docs.microsoft.com/en-us/windows/win32/directshow/avi-riff-file-reference

base_path = p_base_path.get_basename();
if (base_path.is_relative_path()) {
base_path = "res://" + base_path;
}

{
//Remove existing files before writing anew
uint32_t idx = 0;
Ref<DirAccess> d = DirAccess::open(base_path.get_base_dir());
String file = base_path.get_file();
while (true) {
String path = file + zeros_str(idx) + ".exr";
if (d->remove(path) != OK) {
break;
}
}
}

f_wav = FileAccess::open(base_path + ".wav", FileAccess::WRITE_READ);
ERR_FAIL_COND_V(f_wav.is_null(), ERR_CANT_OPEN);

fps = p_fps;

f_wav->store_buffer((const uint8_t *)"RIFF", 4);
int total_size = 4 /* WAVE */ + 8 /* fmt+size */ + 16 /* format */ + 8 /* data+size */;
f_wav->store_32(total_size); //will store final later
f_wav->store_buffer((const uint8_t *)"WAVE", 4);

/* FORMAT CHUNK */

f_wav->store_buffer((const uint8_t *)"fmt ", 4);

uint32_t channels = 2;
switch (speaker_mode) {
case AudioServer::SPEAKER_MODE_STEREO:
channels = 2;
break;
case AudioServer::SPEAKER_SURROUND_31:
channels = 4;
break;
case AudioServer::SPEAKER_SURROUND_51:
channels = 6;
break;
case AudioServer::SPEAKER_SURROUND_71:
channels = 8;
break;
}

f_wav->store_32(16); //standard format, no extra fields
f_wav->store_16(1); // compression code, standard PCM
f_wav->store_16(channels); //CHANNELS: 2

f_wav->store_32(mix_rate);

/* useless stuff the format asks for */

int bits_per_sample = 32;
int blockalign = bits_per_sample / 8 * channels;
int bytes_per_sec = mix_rate * blockalign;

audio_block_size = (mix_rate / fps) * blockalign;

f_wav->store_32(bytes_per_sec);
f_wav->store_16(blockalign); // block align (unused)
f_wav->store_16(bits_per_sample);

/* DATA CHUNK */

f_wav->store_buffer((const uint8_t *)"data", 4);

f_wav->store_32(0); //data size... wooh
wav_data_size_pos = f_wav->get_position();

return OK;
}

Error MovieWriterEXRWAV::write_frame(const Ref<Image> &p_image, const int32_t *p_audio_data) {
ERR_FAIL_COND_V(!f_wav.is_valid(), ERR_UNCONFIGURED);

Ref<Image> image = p_image->duplicate();
image->srgb_to_linear();
Vector<uint8_t> exr_buffer = image->save_exr_to_buffer(false);

Ref<FileAccess> fi = FileAccess::open(base_path + zeros_str(frame_count) + ".exr", FileAccess::WRITE);
fi->store_buffer(exr_buffer.ptr(), exr_buffer.size());
f_wav->store_buffer((const uint8_t *)p_audio_data, audio_block_size);

frame_count++;

return OK;
}

void MovieWriterEXRWAV::write_end() {
if (f_wav.is_valid()) {
uint32_t total_size = 4 /* WAVE */ + 8 /* fmt+size */ + 16 /* format */ + 8 /* data+size */;
uint32_t datasize = f_wav->get_position() - wav_data_size_pos;
f_wav->seek(4);
f_wav->store_32(total_size + datasize);
f_wav->seek(0x28);
f_wav->store_32(datasize);
}
}

MovieWriterEXRWAV::MovieWriterEXRWAV() {
mix_rate = GLOBAL_GET("editor/movie_writer/mix_rate");
speaker_mode = AudioServer::SpeakerMode(int(GLOBAL_GET("editor/movie_writer/speaker_mode")));
}
71 changes: 71 additions & 0 deletions servers/movie_writer/movie_writer_exrwav.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
/**************************************************************************/
/* movie_writer_exrwav.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

#ifndef MOVIE_WRITER_EXRWAV_H
#define MOVIE_WRITER_EXRWAV_H

#include "servers/movie_writer/movie_writer.h"

class MovieWriterEXRWAV : public MovieWriter {
GDCLASS(MovieWriterEXRWAV, MovieWriter)

enum {
MAX_TRAILING_ZEROS = 8 // more than 10 days at 60fps, no hard drive can put up with this anyway :)
};

uint32_t mix_rate = 48000;
AudioServer::SpeakerMode speaker_mode = AudioServer::SPEAKER_MODE_STEREO;
String base_path;
uint32_t frame_count = 0;
uint32_t fps = 0;

uint32_t audio_block_size = 0;

Ref<FileAccess> f_wav;
uint32_t wav_data_size_pos = 0;

String zeros_str(uint32_t p_index);

protected:
virtual uint32_t get_audio_mix_rate() const override;
virtual AudioServer::SpeakerMode get_audio_speaker_mode() const override;
virtual void get_supported_extensions(List<String> *r_extensions) const override;

virtual Error write_begin(const Size2i &p_movie_size, uint32_t p_fps, const String &p_base_path) override;
virtual Error write_frame(const Ref<Image> &p_image, const int32_t *p_audio_data) override;
virtual void write_end() override;

virtual bool handles_file(const String &p_path) const override;

public:
MovieWriterEXRWAV();
};

#endif // MOVIE_WRITER_EXRWAV_H
6 changes: 6 additions & 0 deletions servers/register_server_types.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
#include "debugger/servers_debugger.h"
#include "display_server.h"
#include "movie_writer/movie_writer.h"
#include "movie_writer/movie_writer_exrwav.h"
#include "movie_writer/movie_writer_mjpeg.h"
#include "movie_writer/movie_writer_pngwav.h"
#include "navigation_server_2d.h"
Expand Down Expand Up @@ -113,6 +114,7 @@ static bool has_server_feature_callback(const String &p_feature) {

static MovieWriterMJPEG *writer_mjpeg = nullptr;
static MovieWriterPNGWAV *writer_pngwav = nullptr;
static MovieWriterEXRWAV *writer_exrwav = nullptr;

void register_server_types() {
shader_types = memnew(ShaderTypes);
Expand Down Expand Up @@ -286,13 +288,17 @@ void register_server_types() {

writer_pngwav = memnew(MovieWriterPNGWAV);
MovieWriter::add_writer(writer_pngwav);

writer_exrwav = memnew(MovieWriterEXRWAV);
MovieWriter::add_writer(writer_exrwav);
}

void unregister_server_types() {
ServersDebugger::deinitialize();
memdelete(shader_types);
memdelete(writer_mjpeg);
memdelete(writer_pngwav);
memdelete(writer_exrwav);
}

void register_server_singletons() {
Expand Down

0 comments on commit b7af17b

Please sign in to comment.