@@ -66,8 +66,9 @@ corner of the editor *before* running the project:
66
66
67
67
Movie Maker mode is disabled, click the "movie reel" icon to enable
68
68
69
- The icon gets a background matching the accent color when Movie Maker mode is
70
- enabled:
69
+ A menu will be displayed with options to enable Movie Maker mode and to go to
70
+ the settings. The icon gets a background matching the accent color when Movie
71
+ Maker mode is enabled:
71
72
72
73
.. figure :: img/creating_movies_disable_movie_maker_mode.webp
73
74
:align: center
@@ -153,16 +154,45 @@ Choosing an output format
153
154
-------------------------
154
155
155
156
Output formats are provided by the :ref: `MovieWriter <class_MovieWriter >` class.
156
- Godot has 2 built-in :ref: `MovieWriters <class_MovieWriter >`, and more can be
157
+ Godot has 3 built-in :ref: `MovieWriters <class_MovieWriter >`, and more can be
157
158
implemented by extensions:
158
159
159
- AVI (recommended)
160
+ OGV (recommended)
160
161
~~~~~~~~~~~~~~~~~
161
162
163
+ OGV container with Theora for video and Vorbis for audio. Features lossy video
164
+ and audio compression with a good balance of file size and encoding speed, with
165
+ a better image quality than MJPEG. It has 4 speed levels that can be adjusted
166
+ by changing **Editor > Movie Writer > Encoding Speed ** with the fastest one
167
+ being around as fast as AVI with better compression. At slower speed levels, it
168
+ can compress even better while keeping the same image quality. The lossy
169
+ compression quality can be adjusted by changing **Editor > Movie Writer > Video
170
+ Quality ** for video and **Editor > Movie Writer > Audio Quality ** for audio.
171
+
172
+ The Keyframe Interval can be adjusted by changing **Editor > Movie Writer >
173
+ Keyframe Interval **. In some cases, increasing this setting can improve
174
+ compression efficiency without downsides.
175
+
176
+ The resulting file can be viewed in Godot with :ref: `VideoStreamPlayer
177
+ <class_VideoStreamPlayer>` and most video players but not web browsers. OGV
178
+ does not support transparency.
179
+
180
+ To use OGV, specify a path to a ``.ogv `` file to be created in the **Editor >
181
+ Movie Writer > Movie File ** project setting.
182
+
183
+ .. note ::
184
+
185
+ OGV can only be recorded in editor builds.
186
+ On the other hand, :ref: `OGV playback <doc_playing_videos >`
187
+ is possible in both editor and export template builds.
188
+
189
+ AVI
190
+ ~~~
191
+
162
192
AVI container with MJPEG for video and uncompressed audio. Features lossy video
163
193
compression, resulting in medium file sizes and fast encoding. The lossy
164
194
compression quality can be adjusted by changing
165
- **Editor > Movie Writer > MJPEG Quality **.
195
+ **Editor > Movie Writer > Video Quality **.
166
196
167
197
The resulting file can be viewed in most video players, but it must be converted
168
198
to another format for viewing on the web or by Godot with the VideoStreamPlayer
@@ -213,12 +243,12 @@ the **Advanced** toggle in the top-right corner of the Project Settings dialog.
213
243
desynchronizing over time.
214
244
- **Speaker Mode: ** The speaker mode to use in the recorded audio when writing
215
245
a movie (stereo, 5.1 surround or 7.1 surround).
216
- - **MJPEG Quality: ** The JPEG quality to use when writing a video to an AVI
217
- file, between ``0.01 `` and ``1.0 `` (inclusive). Higher quality values result
246
+ - **Video Quality: ** The image quality to use when writing a video to an OGV or
247
+ AVI file, between ``0.01 `` and ``1.0 `` (inclusive). Higher quality values result
218
248
in better-looking output at the cost of larger file sizes. Recommended quality
219
- values are between ``0.75 `` and ``0.9 ``. Even at quality ``1.0 ``, JPEG
220
- compression remains lossy. This setting does not affect audio quality and is
221
- ignored when writing to a PNG image sequence.
249
+ values are between ``0.75 `` and ``0.9 ``. Even at quality ``1.0 ``, compression
250
+ remains lossy. This setting does not affect audio quality and is ignored when
251
+ writing to a PNG image sequence.
222
252
- **Movie File: ** The output path for the movie. This can be absolute or
223
253
relative to the project root.
224
254
- **Disable V-Sync: ** If enabled, requests V-Sync to be disabled when writing a
@@ -231,6 +261,18 @@ the **Advanced** toggle in the top-right corner of the Project Settings dialog.
231
261
output file sizes. Most video hosting platforms do not support FPS values
232
262
higher than 60, but you can use a higher value and use that to generate motion
233
263
blur.
264
+ - **Audio Quality: ** The audio quality to use when writing a video to an OGV
265
+ file, between ``-0.1 `` and ``1.0 `` (inclusive). Higher quality values result
266
+ in better audio quality at the cost of very slightly larger file sizes.
267
+ Recommended quality values are between ``0.3 `` and ``0.5 ``. Even at quality
268
+ ``1.0 ``, compression remains lossy.
269
+ - **Encoding Speed: ** The speed level to use when writing a video to an OGV
270
+ file. Faster speed levels have less compression efficiency. The image quality
271
+ stays barely the same.
272
+ - **Keyframe Interval: ** Also known as GOP (Group Of Pictures), max number of
273
+ inter-frames to use when writing to an OGV file. Higher values can improve
274
+ compression efficiency without quality loss but at the cost of slower video
275
+ seeks.
234
276
235
277
.. note ::
236
278
@@ -254,8 +296,9 @@ to render before quitting.
254
296
Pressing :kbd: `F8 ` (:kbd: `Cmd + . ` on macOS) or pressing :kbd: `Ctrl + C ` on the
255
297
terminal running Godot is **not recommended **, as it will result in an
256
298
improperly formatted AVI file with no duration information. For PNG image
257
- sequences, PNG images will not be negatively altered, but the associated WAV file
258
- will still lack duration information.
299
+ sequences, PNG images will not be negatively altered, but the associated WAV
300
+ file will still lack duration information. OGV files might end up with slightly
301
+ different duration video and audio tracks but still valid.
259
302
260
303
Some video players may still be able to play the AVI or WAV file with working
261
304
video and audio. However, software that makes use of the AVI or WAV file such as
@@ -370,18 +413,18 @@ Some common post-processing steps are listed below.
370
413
371
414
.. _doc_creating_movies_converting_avi :
372
415
373
- Converting AVI video to MP4
374
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
416
+ Converting OGV/ AVI video to MP4
417
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
375
418
376
419
While some platforms such as YouTube support uploading the AVI file directly, many
377
420
others will require a conversion step beforehand. `HandBrake <https://handbrake.fr/ >`__
378
421
(GUI) and `FFmpeg <https://ffmpeg.org/ >`__ (CLI) are popular open source tools
379
422
for this purpose. FFmpeg has a steeper learning curve, but it's more powerful.
380
423
381
- The command below converts an AVI video to an MP4 (H.264) video with a Constant
382
- Rate Factor (CRF) of 15. This results in a relatively large file, but is
383
- well-suited for platforms that will re-encode your videos to reduce their size
384
- (such as most video sharing websites):
424
+ The command below converts an OGV/ AVI video to an MP4 (H.264) video with a
425
+ Constant Rate Factor (CRF) of 15. This results in a relatively large file, but
426
+ is well-suited for platforms that will re-encode your videos to reduce their
427
+ size (such as most video sharing websites):
385
428
386
429
::
387
430
0 commit comments