Cutscene video with FFmpeg - Revision history

Datiswous: /* References */ Hidden link to internal forum page, because those pages don't really exist for most users.

2023-01-28T13:27:25Z

References: Hidden link to internal forum page, because those pages don't really exist for most users.

← Older revision		Revision as of 13:27, 28 January 2023
Line 195:		Line 195:
	= References =		= References =

	Forum thread [http://forums.thedarkmod.com/topic/18820-why-roq/page-2#entry407624 "Why ROQ"] about FFmpeg cinematics.		<!-- Forum thread [http://forums.thedarkmod.com/topic/18820-why-roq/page-2#entry407624 "Why ROQ"] about FFmpeg cinematics. -->

	Issue [http://bugs.thedarkmod.com/view.php?id=4519 4159]: Investigate using videos of common formats		Issue [http://bugs.thedarkmod.com/view.php?id=4519 4159]: Investigate using videos of common formats

Stgatilov: Updated set of supported formats to just mp4 + h264 + aac

2021-06-05T17:07:16Z

Updated set of supported formats to just mp4 + h264 + aac

← Older revision		Revision as of 17:07, 5 June 2021
Line 26:		Line 26:
	As for video and sound codecs, you can see them e.g if you open your video in VLC and go to menu "Tools"->"Codec information".		As for video and sound codecs, you can see them e.g if you open your video in VLC and go to menu "Tools"->"Codec information".

	~~Here are containers supported by~~ TDM:		Starting with TDM 2.10, TDM supports only one combination:
	* '''mp4''' ~~and '''m4v'''~~		* '''mp4''' container
	* '''avi'''		* '''h264''' video codec (also known as "MPEG-4 AVC (part 10)")
	~~Video codecs supported by TDM:~~		* '''aac''' audio codec (also known as "MPEG AAC Audio")
	* '''h264''': also known as "MPEG-4 AVC (part 10)"~~, usually compressed with x264.~~		As of 2021, it is universally supported by video processing software.
	* '''~~mpeg4~~''': also known as "MPEG~~-4 Video~~" ~~or "MPEG-4 (part 2~~)", ~~usually compressed with Xvid or DivX.~~		ROQ videos are also supported for backward compatibility.
	~~Audio codecs~~ supported by ~~TDM:~~
	* '''aac''': also known as "MPEG AAC Audio".
	* '''mp3''': also ~~known as "MPEG audio layer 3"~~.

	'''IMPORTANT:''' The video file must have ~~one of the following extensions:~~ '''mp4''' ~~or '''m4v''' or '''avi'''~~.		'''IMPORTANT:''' The video file must have '''.mp4''' extension.
	Otherwise video will not play properly (probably generating a warning "''Opening video file "%s", which is compressed inside PK4''" or simply refusing to open video).		Otherwise video will not play properly (probably generating a warning "''Opening video file "%s", which is compressed inside PK4''" or simply refusing to open video).

	~~It is recommended to use default codec settings and avoid any weird/unpopular choices.~~


Line 102:		Line 97:
	resetTime "HideBriefingVideo" 0;		resetTime "HideBriefingVideo" 0;
	}		}

	~~'''Note:''' If you implement custom GUI, it is strongly recommended to listen to this event and set "notime 1" for the window with video material in the handler.~~

	By the way, you no longer have to break your videos into one-minute chunks, with new cinematics videos can have arbitrary length.		By the way, you no longer have to break your videos into one-minute chunks, with new cinematics videos can have arbitrary length.

Petike: adding category tag

2018-11-22T04:24:57Z

adding category tag

← Older revision		Revision as of 04:24, 22 November 2018
Line 215:		Line 215:

	{{editing}}		{{editing}}
			[[Category:Video and cutscenes]]

Stgatilov: Improved wording in automatic duration section.

2018-07-17T17:53:15Z

Improved wording in automatic duration section.

← Older revision		Revision as of 17:53, 17 July 2018
Line 83:		Line 83:

	It is no longer necessary to explicitly specify the duration of a video file, as it was for the ROQ files.		It is no longer necessary to explicitly specify the duration of a video file, as it was for the ROQ files.
	The ~~standard~~ GUI script for single-mission briefing would detect automatically when the video ends.		The stock GUI script for single-mission briefing would detect automatically when the video ends.
	Make sure to set briefing video length to 0 in ''mainmenu_custom_defs.gui'':		Make sure to set briefing video length to 0 in ''mainmenu_custom_defs.gui'':

Line 90:		Line 90:
	#define MM_BRIEFING_VIDEO_LENGTH_2 0		#define MM_BRIEFING_VIDEO_LENGTH_2 0

	In more complex scenarios (campaign / SDK briefings / custom GUI code), listen to ~~'''CinematicEnd''' named~~ event in ~~the~~ GUI script ~~to detect when cinematic ends~~.		Under the hood, the "end of video" detection works via '''CinematicEnd''' named event.
	~~For instance, here is this event handler in standard script~~ ''mainmenu_briefing_video.gui'':		The stock script ''mainmenu_briefing_video.gui'' listens to this event in order to proceed to the objectives screen automatically.
			In more complex scenarios (campaign / SDK briefings / custom GUI code), you have to listen to this event yourself in your GUI script.
			Here are the exact lines from the stock ''mainmenu_briefing_video.gui'' script, serving as a good example:

	// #4535: this event fires up only for non-legacy (i.e. FFmpeg-based) videos		// #4535: this event fires up only for non-legacy (i.e. FFmpeg-based) videos

Stgatilov: Added quick-test section

2018-06-26T17:37:21Z

Added quick-test section

@@ Line 182: / Line 182: @@
 # the last section of log is "====== Close ======"
 = References =
@@ Line 194: / Line 209: @@
 Issue [http://bugs.thedarkmod.com/view.php?id=4845 4845]: Restrict set of features in FFmpeg cinematics
 {{editing}}

Stgatilov: Rewrote section "Common formats": now it includes list of containers/codecs supported for TDM 2.07

2018-06-24T11:24:03Z

Rewrote section "Common formats": now it includes list of containers/codecs supported for TDM 2.07

← Older revision		Revision as of 11:24, 24 June 2018
Line 12:		Line 12:
	== Common formats ==		== Common formats ==

	Since 2.06, most ~~of the~~ video formats can be used in TDM directly.		Since 2.06, the most popular video formats can be used in TDM directly.
	In order to achieve it, specify the path to your video file in the '''videoMap''' keyword of the material definition (just as usual).		In order to achieve it, specify the path to your video file in the '''videoMap''' keyword of the material definition (just as usual).

	~~You can encode~~ the ~~video with any codec~~ supported ~~by the libavcodec/FFmpeg (see [http://www.ffmpeg.org/general.html#Video-Codecs the approximate list]).~~		While FFmpeg supports vast variety of formats, the set of supported formats in TDM is intentionally restricted to a very small one.
	~~But please be wise~~ in ~~codec choice: better use common and widespread codecs with default options~~.		It is done to minimize the risk of breaking missions over years.
	~~Codecs XVID and x264 are good examples here~~.

			Recall that for playback purpose, every video file consists of three parts:
			# '''Container''' allows to extract video and sound streams from one file.
			# '''Video codec''' is responsible for decoding compressed video stream to get individual ready-to-show frames.
			# '''Audio codec''' is responsible for decoding compressed audio stream to get ready-to-play sound samples.

	~~Although FFmpeg supports many different containers~~, ~~TDM~~ can ~~only play a limited set of~~ them ~~from inside a pk4 file~~.		Container is usually determined by file extension (e.g. avi or mp4).
	~~If you use wrong type of container~~, ~~then~~ TDM ~~would generate~~ a warning "''Opening video file "%s", which is compressed inside PK4''", and ~~the video will not play properly~~.		As for video and sound codecs, you can see them e.g if you open your video in VLC and go to menu "Tools"->"Codec information".

			Here are containers supported by TDM:
			* '''mp4''' and '''m4v'''
			* '''avi'''
			Video codecs supported by TDM:
			* '''h264''': also known as "MPEG-4 AVC (part 10)", usually compressed with x264.
			* '''mpeg4''': also known as "MPEG-4 Video" or "MPEG-4 (part 2)", usually compressed with Xvid or DivX.
			Audio codecs supported by TDM:
			* '''aac''': also known as "MPEG AAC Audio".
			* '''mp3''': also known as "MPEG audio layer 3".

			'''IMPORTANT:''' The video file must have one of the following extensions: '''mp4''' or '''m4v''' or '''avi'''.
			Otherwise video will not play properly (probably generating a warning "''Opening video file "%s", which is compressed inside PK4''" or simply refusing to open video).

			It is recommended to use default codec settings and avoid any weird/unpopular choices.

	~~'''IMPORTANT:''' Use MPEG-4 or AVI container! So the video file must have one of the following extensions: '''mp4''' or '''m4v''' or '''avi'''~~

	== Play video with sound ==		== Play video with sound ==
Line 175:		Line 192:

	Issue [http://bugs.thedarkmod.com/view.php?id=4535 4535]: Showing video for its full duration		Issue [http://bugs.thedarkmod.com/view.php?id=4535 4535]: Showing video for its full duration

			Issue [http://bugs.thedarkmod.com/view.php?id=4845 4845]: Restrict set of features in FFmpeg cinematics

	{{editing}}		{{editing}}

Stgatilov: Wrote about cinematic log and finalization

2018-05-29T03:51:12Z

Wrote about cinematic log and finalization

← Older revision		Revision as of 03:51, 29 May 2018
Line 73:		Line 73:
	#define MM_BRIEFING_VIDEO_LENGTH_2 0		#define MM_BRIEFING_VIDEO_LENGTH_2 0

	In a more complex scenarios (campaign / SDK briefings / custom GUI code), listen to '''CinematicEnd''' named event in the GUI script to detect when cinematic ends.		In more complex scenarios (campaign / SDK briefings / custom GUI code), listen to '''CinematicEnd''' named event in the GUI script to detect when cinematic ends.
	For instance, here is this event handler in standard script ''mainmenu_briefing_video.gui'':		For instance, here is this event handler in standard script ''mainmenu_briefing_video.gui'':

Line 83:		Line 83:
	resetTime "HideBriefingVideo" 0;		resetTime "HideBriefingVideo" 0;
	}		}

			'''Note:''' If you implement custom GUI, it is strongly recommended to listen to this event and set "notime 1" for the window with video material in the handler.

	By the way, you no longer have to break your videos into one-minute chunks, with new cinematics videos can have arbitrary length.		By the way, you no longer have to break your videos into one-minute chunks, with new cinematics videos can have arbitrary length.


	= Examples =		= Examples =

	== ~~single~~ mission ==		== Single mission ==

	1. In ''mainmenu_custom_defs.gui'' of your mission:		1. In ''mainmenu_custom_defs.gui'' of your mission:
Line 153:		Line 154:
	Just make sure that all the names/filenames are set appropriately.		Just make sure that all the names/filenames are set appropriately.

			== Troubleshooting ==

			All related cvars start with the common prefix "'''r_cinematic_'''".

			The most useful one is '''r_cinematic_log''': it enables generic logging to a dedicated file ''log_cinematics.txt''.
			If you implement custom GUI scripts, this log can be helpful to see what happens.

			For instance, in order to check that cinematic stops properly in your custom GUI, check that:
			# new messages do '''not''' appear after cinematic stops
			# the last section of log is "====== Close ======"


Line 164:		Line 175:

	Issue [http://bugs.thedarkmod.com/view.php?id=4535 4535]: Showing video for its full duration		Issue [http://bugs.thedarkmod.com/view.php?id=4535 4535]: Showing video for its full duration

	~~All related cvars start with the common prefix "'''r_cinematic_'''".~~

	{{editing}}		{{editing}}

Stgatilov at 04:00, 11 November 2017

2017-11-11T04:00:03Z

← Older revision		Revision as of 04:00, 11 November 2017
Line 8:		Line 8:


			= New cinematics =

	== Common formats ==		== Common formats ==
Line 86:		Line 87:


			= Examples =

	== ~~Example:~~ single mission ==		== single mission ==

	1. In ''mainmenu_custom_defs.gui'' of your mission:		1. In ''mainmenu_custom_defs.gui'' of your mission:
Line 153:		Line 155:


	== References ==		= References =

	Forum thread [http://forums.thedarkmod.com/topic/18820-why-roq/page-2#entry407624 "Why ROQ"] about FFmpeg cinematics.		Forum thread [http://forums.thedarkmod.com/topic/18820-why-roq/page-2#entry407624 "Why ROQ"] about FFmpeg cinematics.

Stgatilov at 03:58, 11 November 2017

2017-11-11T03:58:23Z

@@ Line 6: / Line 6: @@
 The ROQ is rather old and weird, and it is not supported by most software.
 That's why it is considered a "legacy" option now.
 == Common formats ==
@@ Line 70: / Line 72: @@
   #define MM_BRIEFING_VIDEO_LENGTH_2 0
-In a more complex scenarios (campaign or custom GUI code), listen to '''CinematicEnd''' named event in the GUI script to detect when cinematic ends.
+In a more complex scenarios (campaign / SDK briefings / custom GUI code), listen to '''CinematicEnd''' named event in the GUI script to detect when cinematic ends.
 For instance, here is this event handler in standard script ''mainmenu_briefing_video.gui'':
@@ Line 80: / Line 82: @@
       resetTime "HideBriefingVideo" 0;
+  }

Stgatilov at 03:37, 11 November 2017

2017-11-11T03:37:26Z

← Older revision		Revision as of 03:37, 11 November 2017
Line 62:		Line 62:
	== Automatic duration ==		== Automatic duration ==

	'''~~TODO~~'''		It is no longer necessary to explicitly specify the duration of a video file, as it was for the ROQ files.
			The standard GUI script for single-mission briefing would detect automatically when the video ends.
			Make sure to set briefing video length to 0 in ''mainmenu_custom_defs.gui'':

			//set video length to zero (otherwise it would be forcefully terminated after prescribed time)
			#define MM_BRIEFING_VIDEO_LENGTH_1 0 //note: zero here =)
			#define MM_BRIEFING_VIDEO_LENGTH_2 0

			In a more complex scenarios (campaign or custom GUI code), listen to '''CinematicEnd''' named event in the GUI script to detect when cinematic ends.
			For instance, here is this event handler in standard script ''mainmenu_briefing_video.gui'':

			// #4535: this event fires up only for non-legacy (i.e. FFmpeg-based) videos
			onNamedEvent CinematicEnd
			{
			// Hide video
			set "HideBriefingVideo::notime" "0";
			resetTime "HideBriefingVideo" 0;
			}