Move MovieWriterMJPEG class to jpg module it depends on

akien-mga · akien-mga · commit 6b35f262cea7 · 2025-05-02T10:49:55.000+02:00
Fixes #90932.
diff --git a/doc/classes/MovieWriter.xml b/doc/classes/MovieWriter.xml
@@ -6,7 +6,7 @@
 	<description>
 		Godot can record videos with non-real-time simulation. Like the [code]--fixed-fps[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url], this forces the reported [code]delta[/code] in [method Node._process] functions to be identical across frames, regardless of how long it actually took to render the frame. This can be used to record high-quality videos with perfect frame pacing regardless of your hardware's capabilities.
 		Godot has 2 built-in [MovieWriter]s:
-		- AVI container with MJPEG for video and uncompressed audio ([code].avi[/code] file extension). Lossy compression, medium file sizes, fast encoding. The lossy compression quality can be adjusted by changing [member ProjectSettings.editor/movie_writer/mjpeg_quality]. The resulting file can be viewed in most video players, but it must be converted to another format for viewing on the web or by Godot with [VideoStreamPlayer]. MJPEG does not support transparency. AVI output is currently limited to a file of 4 GB in size at most.
+		- AVI container with MJPEG for video and uncompressed audio ([code].avi[/code] file extension). This requires the [code]jpg[/code] module to be enabled at compile time (default behavior). Lossy compression, medium file sizes, fast encoding. The lossy compression quality can be adjusted by changing [member ProjectSettings.editor/movie_writer/mjpeg_quality]. The resulting file can be viewed in most video players, but it must be converted to another format for viewing on the web or by Godot with [VideoStreamPlayer]. MJPEG does not support transparency. AVI output is currently limited to a file of 4 GB in size at most.
 		- PNG image sequence for video and WAV for audio ([code].png[/code] file extension). Lossless compression, large file sizes, slow encoding. Designed to be encoded to a video file with another tool such as [url=https://ffmpeg.org/]FFmpeg[/url] after recording. Transparency is currently not supported, even if the root viewport is set to be transparent.
 		If you need to encode to a different format or pipe a stream through third-party software, you can extend the [MovieWriter] class to create your own movie writers. This should typically be done using GDExtension for performance reasons.
 		[b]Editor usage:[/b] A default movie file path can be specified in [member ProjectSettings.editor/movie_writer/movie_file]. Alternatively, for running single scenes, a [code]movie_file[/code] metadata can be added to the root node, specifying the path to a movie file that will be used when recording that scene. Once a path is set, click the video reel icon in the top-right corner of the editor to enable Movie Maker mode, then run any scene as usual. The engine will start recording as soon as the splash screen is finished, and it will only stop recording when the engine quits. Click the video reel icon again to disable Movie Maker mode. Note that toggling Movie Maker mode does not affect project instances that are already running.
diff --git a/main/main.cpp b/main/main.cpp
@@ -71,7 +71,6 @@
 #include "servers/camera_server.h"
 #include "servers/display_server.h"
 #include "servers/movie_writer/movie_writer.h"
-#include "servers/movie_writer/movie_writer_mjpeg.h"
 #include "servers/register_server_types.h"
 #include "servers/rendering/rendering_server_default.h"
 #include "servers/text/text_server_dummy.h"
diff --git a/modules/jpg/movie_writer_mjpeg.cpp b/modules/jpg/movie_writer_mjpeg.cpp
diff --git a/modules/jpg/movie_writer_mjpeg.h b/modules/jpg/movie_writer_mjpeg.h
diff --git a/modules/jpg/register_types.cpp b/modules/jpg/register_types.cpp
@@ -31,23 +31,40 @@
 #include "register_types.h"
 
 #include "image_loader_libjpeg_turbo.h"
+#include "movie_writer_mjpeg.h"
 
 static Ref<ImageLoaderLibJPEGTurbo> image_loader_libjpeg_turbo;
+static MovieWriterMJPEG *writer_mjpeg = nullptr;
 
 void initialize_jpg_module(ModuleInitializationLevel p_level) {
-	if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
-		return;
-	}
+	switch (p_level) {
+		case MODULE_INITIALIZATION_LEVEL_SERVERS: {
+			writer_mjpeg = memnew(MovieWriterMJPEG);
+			MovieWriter::add_writer(writer_mjpeg);
+		} break;
+
+		case MODULE_INITIALIZATION_LEVEL_SCENE: {
+			image_loader_libjpeg_turbo.instantiate();
+			ImageLoader::add_image_format_loader(image_loader_libjpeg_turbo);
+		} break;
 
-	image_loader_libjpeg_turbo.instantiate();
-	ImageLoader::add_image_format_loader(image_loader_libjpeg_turbo);
+		default:
+			break;
+	}
 }
 
 void uninitialize_jpg_module(ModuleInitializationLevel p_level) {
-	if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) {
-		return;
-	}
+	switch (p_level) {
+		case MODULE_INITIALIZATION_LEVEL_SCENE: {
+			ImageLoader::remove_image_format_loader(image_loader_libjpeg_turbo);
+			image_loader_libjpeg_turbo.unref();
+		} break;
+
+		case MODULE_INITIALIZATION_LEVEL_SERVERS: {
+			memdelete(writer_mjpeg);
+		} break;
 
-	ImageLoader::remove_image_format_loader(image_loader_libjpeg_turbo);
-	image_loader_libjpeg_turbo.unref();
+		default:
+			break;
+	}
 }
diff --git a/servers/register_server_types.cpp b/servers/register_server_types.cpp
@@ -60,7 +60,6 @@
 #include "display/native_menu.h"
 #include "display_server.h"
 #include "movie_writer/movie_writer.h"
-#include "movie_writer/movie_writer_mjpeg.h"
 #include "movie_writer/movie_writer_pngwav.h"
 #include "rendering/renderer_rd/framebuffer_cache_rd.h"
 #include "rendering/renderer_rd/storage_rd/render_data_rd.h"
@@ -133,7 +132,6 @@ static bool has_server_feature_callback(const String &p_feature) {
 	return false;
 }
 
-static MovieWriterMJPEG *writer_mjpeg = nullptr;
 static MovieWriterPNGWAV *writer_pngwav = nullptr;
 
 void register_server_types() {
@@ -342,9 +340,7 @@ void register_server_types() {
 	GDREGISTER_ABSTRACT_CLASS(XRTracker);
 #endif // XR_DISABLED
 
-	writer_mjpeg = memnew(MovieWriterMJPEG);
-	MovieWriter::add_writer(writer_mjpeg);
-
+	// MovieWriterMJPEG is registered in the jpg module.
 	writer_pngwav = memnew(MovieWriterPNGWAV);
 	MovieWriter::add_writer(writer_pngwav);
 
@@ -356,7 +352,6 @@ void unregister_server_types() {
 
 	ServersDebugger::deinitialize();
 	memdelete(shader_types);
-	memdelete(writer_mjpeg);
 	memdelete(writer_pngwav);
 
 	OS::get_singleton()->benchmark_end_measure("Servers", "Unregister Extensions");
