Playing ROQ Video Files - Revision history

Geep: /* Audio */

2020-03-16T19:32:00Z

Audio

← Older revision		Revision as of 19:32, 16 March 2020
Line 44:		Line 44:
	=== Audio ===		=== Audio ===

	Audio can be included in the ROQ, but Doom3 evidently ignores it. [Unknown if this is still ~~necessary~~ true in TDM 2.06+] In the GUIs that use video and audio, the audio is triggered to play from a separate OGG or audio source at the same time the video is started. But if you want to make a ROQ with audio, the source audio must be 22050 Hz, or it will be resampled to that. More typically, in VirtualDub:		Audio can be included in the ROQ, but Doom3 evidently ignores it. [Unknown if this is still necessarily true in TDM 2.06+] In the GUIs that use video and audio, the audio is triggered to play from a separate OGG or audio source at the same time the video is started. But if you want to make a ROQ with audio, the source audio must be 22050 Hz, or it will be resampled to that. More typically, in VirtualDub:

	* Export the original AVI's audio track as a WAV file. Later, use your favorite audio software to make it an OGG.		* Export the original AVI's audio track as a WAV file. Later, use your favorite audio software to make it an OGG.

Geep: Add ODVideo link and caution to Preamble. Also tweak of Alternative: On Your Own Video Surface

2020-03-16T18:57:46Z

Add ODVideo link and caution to Preamble. Also tweak of Alternative: On Your Own Video Surface

← Older revision		Revision as of 18:57, 16 March 2020
Line 4:		Line 4:

	== Notice ==		== Notice ==
	'''These examples of using videos and ~~gui~~ resources in TDM are still valid and informative, but new FMs should use one of the more modern video formats, not RoQ.'''		'''These examples of using videos and GUI resources in TDM are still valid and informative, but new FMs should use one of the more modern video formats, not RoQ.'''
	== Preamble ==		== Preamble ==

	~~{{Original_Reference\|Drumple\|3504}}~~

	These examples, and their recommendations and images, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.		These examples, and their recommendations and images, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.

	Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:		Instead, see two 2015-era OpenArena tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:

	* The first uses XMedia Record to preprocess, then FFmpeg to output RoQ		* The first uses XMedia Record to preprocess, then FFmpeg to output RoQ
	* The second uses Shotcut and XnView to preprocess, then roq.exe, id's official win32 RoQ encoder. The latter is evidently no longer available from id, but the tutorial provides a copy.		* The second uses Shotcut and XnView to preprocess, then roq.exe, id's official win32 RoQ encoder. The latter is evidently no longer available from id, but the tutorial provides a copy.

			Or consider the Overdose-related RoQ-creation tool [https://overdose-game.com/sdk.html ODVideo]. But caution: RoQ tools tuned for other idTech4 games could be TDM-incompatible.

	Other 2020-era comments are shown in [square brackets].		Other 2020-era comments are shown in [square brackets].

	== Introduction to the RoQ Format ==		== Introduction to the RoQ Format ==

			{{Original_Reference\|Drumple\|3504}}

	The ROQ video file format is one traditionally used id Software, starting with early Doom and continuing (with some tightening of playback format requirements) to Doom3. These latter requirements include:		The ROQ video file format is one traditionally used id Software, starting with early Doom and continuing (with some tightening of playback format requirements) to Doom3. These latter requirements include:
Line 129:		Line 130:

	To make a video surface:		To make a video surface:
	* Make a brush and convert it to a func_static		* Make a brush and convert it to a func_static.
	* Add the gui key/vals, as above.		* Add the gui key/vals, as above.
	* Select one face - where your video will play - and apply the common/entitygui to it		* Select one face - where your video will play - and apply the common/entitygui to it [giving Figure A below].
	* Make sure you fit that image to your selected face [e.g., in DR Texture editor], otherwise the video will play in a corner of the selected face. ~~(In the Doom editor, figure 8 shows fitting the guientity.)~~		* Make sure you fit that image to your selected face [e.g., in the DR Texture editor, resulting in Figure B], otherwise the video will play in a corner of the selected face.

	[[Image:Roq_resize.jpg]]		[[Image:Roq_resize.jpg]]

Geep: Add Notice section

2020-03-14T19:49:36Z

Add Notice section

← Older revision		Revision as of 19:49, 14 March 2020
Line 3:		Line 3:
	[[Image:Builderlaptop.jpg]]		[[Image:Builderlaptop.jpg]]

			== Notice ==
			'''These examples of using videos and gui resources in TDM are still valid and informative, but new FMs should use one of the more modern video formats, not RoQ.'''
	== Preamble ==		== Preamble ==

Geep at 19:42, 14 March 2020

2020-03-14T19:42:45Z

← Older revision		Revision as of 19:42, 14 March 2020
Line 1:		Line 1:
	= Examples: A Repeating Video on an In-Game Laptop; and on Your Own Video Surface =		= Examples: A Repeating Video on an In-Game Laptop; and on Your Own Video Surface =

			[[Image:Builderlaptop.jpg]]

	== Preamble ==		== Preamble ==

	{{Original_Reference\|Drumple\|3504}}		{{Original_Reference\|Drumple\|3504}}

	These examples, and their recommendations, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.		These examples, and their recommendations and images, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.

	Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:		Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:
Line 23:		Line 26:
	== Programs to Create a ROQ File ==		== Programs to Create a ROQ File ==

	Among possible programs to make ROQ files [~~ref~~ Riot], some, such as QVM, fail for our purposes because they cannot handle square videos. SwitchBlade 3.12 works well, paired with preprocessing by VirtualDub.		Among possible programs to make ROQ files [Riot], some, such as Quake Video Maker (QVM), fail for our purposes because they cannot handle square videos. SwitchBlade 3.12 works well, paired with preprocessing by VirtualDub.

	== Preprocessing an AVI with VirtualDub ==		== Preprocessing an AVI with VirtualDub ==
Line 41:		Line 44:

	* Export the original AVI's audio track as a WAV file. Later, use your favorite audio software to make it an OGG.		* Export the original AVI's audio track as a WAV file. Later, use your favorite audio software to make it an OGG.

	* While preparing to create the ROQ video, select NO AUDIO from the VirtualDub Audio tab.		* While preparing to create the ROQ video, select NO AUDIO from the VirtualDub Audio tab.

Line 47:		Line 49:

	* The 512x512 ROQ video format was used by id in Doom3 for the id logo and some cinematic scenes, such as where you get rescued in the last scene. So those dimensions should generally suffice.		* The 512x512 ROQ video format was used by id in Doom3 for the id logo and some cinematic scenes, such as where you get rescued in the last scene. So those dimensions should generally suffice.
			* Video source dimensions should be at a power of 4:3. So if need be, adjust the video source with VirtualDub (as discussed in the SwitchBlade documentation).
	* ~~'''~~Video source dimensions~~'''~~ should be at a power of 4:3. So if need be, adjust the video source with VirtualDub (as discussed in the SwitchBlade documentation).

	* Optionally, choose an overall quality compression you want from the compression tab. (Drumple prefers no compression, which makes huge AVI files but has the best image quality.)		* Optionally, choose an overall quality compression you want from the compression tab. (Drumple prefers no compression, which makes huge AVI files but has the best image quality.)

	* As needed, use any other VirtualDub filters to improve the quality of the AVI.		* As needed, use any other VirtualDub filters to improve the quality of the AVI.

	* Finally, save as AVI.		* Finally, save as AVI.

Line 84:		Line 82:

	Next, we want a GUI that will -		Next, we want a GUI that will -
	* wait 8 seconds, then play the video [assumed to be ~~about~~ 8 seconds long]		* wait 8 seconds, then play the video [assumed to be no more than 8 seconds long]
	* replay it every 8 seconds after that.		* replay it every 8 seconds after that.
	So create a file named myguitest.gui, placed in the /guis folder, with content:		So create a file named myguitest.gui, placed in the /guis folder, with content:
Line 124:		Line 122:
	[[Image:Roq myguitest.jpg]]		[[Image:Roq myguitest.jpg]]

	Save~~/bsp~~ and try it out. ~~Here's a~~ screenshot ~~of it working in-game:~~		Save and try it out. See the first screenshot above.

	~~[[Image:Builderlaptop~~.~~jpg]]~~

	=== Alternative: On Your Own Video Surface ===		=== Alternative: On Your Own Video Surface ===

Geep: revise headers

2020-03-14T19:28:47Z

revise headers

← Older revision		Revision as of 19:28, 14 March 2020
Line 1:		Line 1:
	= ~~Example~~: An In-Game Laptop ~~with a Repeating RoQ~~ Video =		= Examples: A Repeating Video on an In-Game Laptop; and on Your Own Video Surface =
	== Preamble ==		== Preamble ==

	{{Original_Reference\|Drumple\|3504}}		{{Original_Reference\|Drumple\|3504}}
	~~This example~~, and ~~its~~ recommendations, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.
			These examples, and their recommendations, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.

	Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:		Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:
Line 35:		Line 36:
	Use VirtualDub to achieve these. From SwitchBlade documentation, some considerations:		Use VirtualDub to achieve these. From SwitchBlade documentation, some considerations:

	~~'''~~Audio~~'''~~		=== Audio ===

	Audio can be included in the ROQ, but Doom3 evidently ignores it. [Unknown if this is still necessary true in TDM 2.06+] In the GUIs that use video and audio, the audio is triggered to play from a separate OGG or audio source at the same time the video is started. But if you want to make a ROQ with audio, the source audio must be 22050 Hz, or it will be resampled to that. More typically, in VirtualDub:		Audio can be included in the ROQ, but Doom3 evidently ignores it. [Unknown if this is still necessary true in TDM 2.06+] In the GUIs that use video and audio, the audio is triggered to play from a separate OGG or audio source at the same time the video is started. But if you want to make a ROQ with audio, the source audio must be 22050 Hz, or it will be resampled to that. More typically, in VirtualDub:
Line 43:		Line 44:
	* While preparing to create the ROQ video, select NO AUDIO from the VirtualDub Audio tab.		* While preparing to create the ROQ video, select NO AUDIO from the VirtualDub Audio tab.

	~~'''~~Video~~'''~~		=== Video ===

	* The 512x512 ROQ video format was used by id in Doom3 for the id logo and some cinematic scenes, such as where you get rescued in the last scene. So those dimensions should generally suffice.		* The 512x512 ROQ video format was used by id in Doom3 for the id logo and some cinematic scenes, such as where you get rescued in the last scene. So those dimensions should generally suffice.
Line 65:		Line 66:

	== Testing the Video and Audio In-Game ==		== Testing the Video and Audio In-Game ==
			=== On an In-Game Laptop Screen ===

	There are different ways to implement a new ROQ video in-game. Here, we'll use a moveable_laptop, since it has a common/gui surface in the model already, right in front of the screen area.		There are different ways to implement a new ROQ video in-game. Here, we'll use a moveable_laptop, since it has a common/gui surface in the model already, right in front of the screen area.
Line 70:		Line 72:
	First, put the ROQ video (myroqtest.roq) and the OGG sound (myroqtest.ogg) into your game's directory, for example, within a folder called /video.		First, put the ROQ video (myroqtest.roq) and the OGG sound (myroqtest.ogg) into your game's directory, for example, within a folder called /video.

	Create a material shader [e.g., within some in .mtr file in your materials folder]:		Create a material shader [e.g., within some .mtr file in your materials folder]:

	video/myroq		video/myroq
Line 126:		Line 128:
	[[Image:Builderlaptop.jpg]]		[[Image:Builderlaptop.jpg]]

	== Alternative: ~~Making your~~ Own Video Surface ==		=== Alternative: On Your Own Video Surface ===

			To make a video surface:
	* Make a brush and convert it to a func_static		* Make a brush and convert it to a func_static
	* Add the gui key/vals, as above.		* Add the gui key/vals, as above.

Geep: /* Preamble - In-Game Video Example: In-Game Laptop with a Repeating RoQ Video */

2020-03-14T19:06:45Z

Preamble - In-Game Video Example: In-Game Laptop with a Repeating RoQ Video

← Older revision		Revision as of 19:06, 14 March 2020
Line 1:		Line 1:
	=~~= Preamble - In-Game Video~~ Example: In-Game Laptop with a Repeating RoQ Video ==		= Example: An In-Game Laptop with a Repeating RoQ Video =
			== Preamble ==

	{{Original_Reference\|Drumple\|3504}} This example, and its recommendations, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes.		{{Original_Reference\|Drumple\|3504}}
			This example, and its recommendations, are by Drumple circa 2007. This was rewritten for concision by Geep, 2020, with these added preamble notes. The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.
	The general approach is still valid, but the specific tools (SwitchBlade, VirtualDub, and the older Doom3 Editor) are less viable now. Standalone SwitchBlade is no longer available; its development ended with version 3, at which time it was folded into FFmpeg [https://wiki.multimedia.cx/index.php/RoQ RoQ]. TDM now uses a FFmpeg subset for video decoding, including RoQ.

	Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:		Instead, see two 2015-era tutorials by [https://openarena.fandom.com/wiki/RoQ ZaRR]:
Line 10:		Line 10:
	* The second uses Shotcut and XnView to preprocess, then roq.exe, id's official win32 RoQ encoder. The latter is evidently no longer available from id, but the tutorial provides a copy.		* The second uses Shotcut and XnView to preprocess, then roq.exe, id's official win32 RoQ encoder. The latter is evidently no longer available from id, but the tutorial provides a copy.

	Other comments are shown in [square brackets].		Other 2020-era comments are shown in [square brackets].

	== Introduction to the RoQ Format ==		== Introduction to the RoQ Format ==

Geep: /* RoQ References */ Fix links

2020-03-14T18:53:00Z

RoQ References: Fix links

← Older revision		Revision as of 18:53, 14 March 2020
Line 137:		Line 137:
	== RoQ References ==		== RoQ References ==

	'''VirtualDub'''. Development of this ceased at the end of 2013, and its forum expired in 2015, but (as of Feb. 2020) the last stable version is still available for download at [www.virtualdub.org VirtualDub].		'''VirtualDub'''. Development of this ceased at the end of 2013, and its forum expired in 2015, but (as of Feb. 2020) the last stable version is still available for download at [http://www.virtualdub.org VirtualDub].

	'''Quake Video Maker (QVM) - Easy ROQ creator'''. Historic URL, no longer valid: www.swift-tools.net/Quake/QVM/ . QVM is still available from 3rd-party sites.		'''Quake Video Maker (QVM) - Easy ROQ creator'''. Historic URL, no longer valid: www.swift-tools.net/Quake/QVM/ . QVM is still available from 3rd-party sites.

	'''Switchblade Video Encoder/RoQ Converter'''. Last reported version was 3 [planetdoom.gamespy.com/pagetools/pagetools1b7e.html?act=printnews&id=785], pointing to Riot's homepage. no longer.		'''Switchblade Video Encoder/RoQ Converter'''. Last reported version was 3 [http://planetdoom.gamespy.com/pagetools/pagetools1b7e.html?act=printnews&id=785 says planetdoom], pointing to Riot's homepage. No longer.

	[http://www.doom3world.org/phpbb2/viewtopic.php?t=3533 Doom3world Discussion]		[http://www.doom3world.org/phpbb2/viewtopic.php?t=3533 Doom3world Discussion]
Line 151:		Line 151:
	'''RoQ''' Brief history and tech overview at [https://wiki.multimedia.cx/index.php/RoQ RoQ].		'''RoQ''' Brief history and tech overview at [https://wiki.multimedia.cx/index.php/RoQ RoQ].

	'''RoQ Encoder''' Official Encoder (win32): [ftp://ftp.idsoftware.com/idstuff/quake3/tools/roq.zip]		'''RoQ Encoder''' Official Encoder (win32): [ftp://ftp.idsoftware.com/idstuff/quake3/tools/roq.zip idsoftware ftp]

	For an alternative take on using QVM to create ROQ files, see [https://www.moddb.com/tutorials/how-to-create-a-roq-video-file1 How to create a RoQ video-file]		For an alternative take on using QVM to create ROQ files, see [https://www.moddb.com/tutorials/how-to-create-a-roq-video-file1 How to create a RoQ video-file]

Geep: ENTIRELY REWRITTEN!!!!

2020-03-14T18:44:19Z

ENTIRELY REWRITTEN!!!!

Show changes

Geep: Remove {{style}} tag before page rename

2020-03-14T18:22:40Z

Remove {{style}} tag before page rename

← Older revision		Revision as of 18:22, 14 March 2020
Line 1:		Line 1:
	~~{{style}}~~
	{{infobox\|bg=#ffb0b0\|border=2px solid#ff0000\|text=		{{infobox\|bg=#ffb0b0\|border=2px solid#ff0000\|text=
	{{{text\|As of TDM 2.06, support for FFmpeg video codecs has been added, in addition to ROQ.}}}		{{{text\|As of TDM 2.06, support for FFmpeg video codecs has been added, in addition to ROQ.}}}

Petike: typo

2018-11-22T04:31:52Z

typo

← Older revision		Revision as of 04:31, 22 November 2018
Line 100:		Line 100:

	{{tutorial-editing}}		{{tutorial-editing}}
	[[Category:~~Videos~~ and cutscenes]]		[[Category:Video and cutscenes]]