Merge pull request #62122 from reduz/implement-movie-writer

Implement a Movie Maker mode

4 files changed, 86 insertions, 6 deletions

diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index 9f4041fa2b..4048b483e8 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -2569,19 +2569,21 @@
 		</constant>
 		<constant name="PROPERTY_HINT_SAVE_FILE" value="38" enum="PropertyHint">
 		</constant>
-		<constant name="PROPERTY_HINT_INT_IS_OBJECTID" value="39" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_GLOBAL_SAVE_FILE" value="39" enum="PropertyHint">
 		</constant>
-		<constant name="PROPERTY_HINT_INT_IS_POINTER" value="41" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_INT_IS_OBJECTID" value="40" enum="PropertyHint">
 		</constant>
-		<constant name="PROPERTY_HINT_ARRAY_TYPE" value="40" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_INT_IS_POINTER" value="42" enum="PropertyHint">
 		</constant>
-		<constant name="PROPERTY_HINT_LOCALE_ID" value="42" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_ARRAY_TYPE" value="41" enum="PropertyHint">
+		</constant>
+		<constant name="PROPERTY_HINT_LOCALE_ID" value="43" enum="PropertyHint">
 			Hints that a string property is a locale code. Editing it will show a locale dialog for picking language and country.
 		</constant>
-		<constant name="PROPERTY_HINT_LOCALIZABLE_STRING" value="43" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_LOCALIZABLE_STRING" value="44" enum="PropertyHint">
 			Hints that a dictionary property is string translation map. Dictionary keys are locale codes and, values are translated strings.
 		</constant>
-		<constant name="PROPERTY_HINT_MAX" value="44" enum="PropertyHint">
+		<constant name="PROPERTY_HINT_MAX" value="45" enum="PropertyHint">
 		</constant>
 		<constant name="PROPERTY_USAGE_NONE" value="0" enum="PropertyUsageFlags">
 		</constant>
diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml
index da5b907fab..20e26714bc 100644
--- a/doc/classes/Image.xml
+++ b/doc/classes/Image.xml
@@ -380,6 +380,19 @@
 				[b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project.
 			</description>
 		</method>
+		<method name="save_jpg" qualifiers="const">
+			<return type="int" enum="Error" />
+			<argument index="0" name="path" type="String" />
+			<argument index="1" name="quality" type="float" default="0.75" />
+			<description>
+			</description>
+		</method>
+		<method name="save_jpg_to_buffer" qualifiers="const">
+			<return type="PackedByteArray" />
+			<argument index="0" name="quality" type="float" default="0.75" />
+			<description>
+			</description>
+		</method>
 		<method name="save_png" qualifiers="const">
 			<return type="int" enum="Error" />
 			<argument index="0" name="path" type="String" />
diff --git a/doc/classes/MovieWriter.xml b/doc/classes/MovieWriter.xml
new file mode 100644
index 0000000000..6cc3829b20
--- /dev/null
+++ b/doc/classes/MovieWriter.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="MovieWriter" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+	<brief_description>
+	</brief_description>
+	<description>
+	</description>
+	<tutorials>
+	</tutorials>
+	<methods>
+		<method name="_get_audio_mix_rate" qualifiers="virtual const">
+			<return type="int" />
+			<description>
+			</description>
+		</method>
+		<method name="_get_audio_speaker_mode" qualifiers="virtual const">
+			<return type="int" enum="AudioServer.SpeakerMode" />
+			<description>
+			</description>
+		</method>
+		<method name="_handles_file" qualifiers="virtual const">
+			<return type="bool" />
+			<argument index="0" name="path" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="_write_begin" qualifiers="virtual">
+			<return type="int" enum="Error" />
+			<argument index="0" name="movie_size" type="Vector2i" />
+			<argument index="1" name="fps" type="int" />
+			<argument index="2" name="base_path" type="String" />
+			<description>
+			</description>
+		</method>
+		<method name="_write_end" qualifiers="virtual">
+			<return type="void" />
+			<description>
+			</description>
+		</method>
+		<method name="_write_frame" qualifiers="virtual">
+			<return type="int" enum="Error" />
+			<argument index="0" name="frame_image" type="Image" />
+			<argument index="1" name="audio_frame_block" type="const void*" />
+			<description>
+			</description>
+		</method>
+		<method name="add_writer" qualifiers="static">
+			<return type="void" />
+			<argument index="0" name="writer" type="MovieWriter" />
+			<description>
+			</description>
+		</method>
+	</methods>
+</class>
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 6fd3f9f9fc..3d939a6926 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -553,6 +553,18 @@
 			See [enum DisplayServer.VSyncMode] for possible values and how they affect the behavior of your application.
 			Depending on the platform and used renderer, the engine will fall back to [code]Enabled[/code], if the desired mode is not supported.
 		</member>
+		<member name="editor/movie_writer/disable_vsync" type="bool" setter="" getter="" default="false">
+		</member>
+		<member name="editor/movie_writer/fps" type="int" setter="" getter="" default="60">
+		</member>
+		<member name="editor/movie_writer/mix_rate_hz" type="int" setter="" getter="" default="48000">
+		</member>
+		<member name="editor/movie_writer/mjpeg_quality" type="float" setter="" getter="" default="0.75">
+		</member>
+		<member name="editor/movie_writer/movie_file" type="String" setter="" getter="" default="&quot;&quot;">
+		</member>
+		<member name="editor/movie_writer/speaker_mode" type="int" setter="" getter="" default="0">
+		</member>
 		<member name="editor/node_naming/name_casing" type="int" setter="" getter="" default="0">
 			When creating node names automatically, set the type of casing in this project. This is mostly an editor setting.
 		</member>