Super Mario Galaxy wiki - User contributions [en]

THPConv-Guide

2024-05-10T17:21:06Z

HummingOwl:

This guide is created specifically to make THP videos for SMG1. Other games that support THP may have a different THP setup.

== Required Tools ==

* FFmpeg ([https://web.archive.org/web/20200901234146/https://ffmpeg.zeranoe.com/builds/win32/static/ Win32 older builds], for Linux you can use your package manager)
* THPConv.exe (with dsptool.dll, [https://archive.org/details/WiiDevelopmentPackage/ Wii SDK])
* [https://github.com/MasterofGalaxies/THPConv Alternative THPConv build] (for Linux users)
* [https://www.videolan.org/vlc/ VLC Media Player] (to reproduce THP files)
* [https://www.winehq.org/ Wine] (for Linux users)

== Steps ==

Open a CMD/Terminal in the same place the video you want to convert is and type the following command (Fig. 1):

<code>path\to\ffmpeg.exe -i [input_video] -vf scale="[width]:[height]" -r [fps] [temp_video]</code>

*<code>[input_video]</code> is the video of your choice to convert. Can be any video format.
*<code>[width]</code> is the width the <code>[temp_video]</code> will have. Cannot exceed 672 pixels.
*<code>[height]</code> is the height the <code>[temp_video]</code> will have. There is no limit on this value.
*<code>[fps]</code> are the frames per second the <code>[temp_video]</code> will have. Frame rates can be from 1.0 to 59.94.

[[File:THPConv-Guide_Fig-1.webp|right|thumb|Fig. 1 - Create temporal video]]

{{note |
* All this information is extracted from the Wii SDK docs for THPConv.
* SMG uses 59.94 fps and 640x368 video dimensions for all THP files in the <code>MovieData</code> folder. Use <code>path\to\ffmpeg.exe -i [THP video file]</code> to see it yourself.
* If you use different frame rates than 59.94 the video on SMG1 will play slower or faster but not at its "normal" speed.
You can use different values for the width and height of the video, be sure they follow the rules said above and that the dimensions are a multiple of 16.
* To get a better video resolution on the final THP video you can use the following flags on the above command <code>-preset veryslow -b:v 21M</code> (file size will increase a lot as <code>-b:v</code> sets the bitrate of the output video). <code>21M</code> was selected because of the bitrates of the OG THP videos on the MovieData folder (you can select any value you want, <code>M</code> means megabyte).
}}

Create a folder named <code>temp</code> in the same place the <code>[temp_video]</code> is and then type the following command (Fig. 2 and 3):

<code>path\to\ffmpeg.exe -i [temp_video] temp\output%03d.jpg</code>

This will dump all the frames the <code>[temp_video]</code> has into JPG images.

[[File:THPConv-Guide Fig-2.webp|right|thumb|Fig. 2 - Create temporal folder]]

[[File:THPConv-Guide Fig-3.webp|right|thumb|Fig. 3 - Dump temporal video frames into folder]]

{{ note |
* JPG or JPEG can be used, the only restriction the THPConv docs say is that they need to be in the baseline DCT format (which ffmpeg automatically converts them to with the above command).
* The minimum frames a THP video can have without breaking the game is 21. Tested with <code>PrologueA.thp</code> in Riivolution.
* Very low width and height values for the THP video (16x16 for example) will allow to show blue rectangles on the screen when reproducing the associated cutscene. Tested it very little so I am unsure if this happens all the time.
* To get a video resolution similar to the [temp_video] on your THP video you can use the following flag on the above command <code>-q:v 1</code>
}}

Then, to get the audio part of the video execute (Fig. 4):

<code>path\to\ffmpeg.exe -i [temp_video] -acodec pcm_s16le -ar 32000 [WAV_audio].wav</code>

*<code>[WAV_audio].wav</code> is the name of the WAV audio file to use with THPConv.

:This will convert the audio of the <code>[temp_video]</code> in a WAV audio using the pcm_s16le format.

[[File:THPConv-Guide_Fig-4.webp|right|thumb|Fig. 4 - Create WAV audio file]]

{{ note |
* WAV audios are the only audio input THPConv can process. Specifically non-compressed 16-bit PCM data ones.
* WAV audios can be Mono or Stereo, they are both supported by THPConv.
* The <code>-ar 32000</code> sets the frequency of the WAV audio. 32000 Hz is needed for the audio in SMG1 since different values make the audio sound at a higher or lower pitch.
}}

Finally, to get the THP converted file we do (Fig. 5):

<code>path\to\THPConv.exe -j temp\output*.jpg -s [WAV_audio].wav -r 59.94 -d [Output THP].thp -v</code>

[[File:THPConv-Guide_Fig-5.webp|right|thumb|Fig. 5 - Create THP file with THPConv]]

{{ note |
* The <code>-j</code> flag is used to select the JPEG sequential frames that are going to be used in the THP video.
* The <code>-s</code> flag is used to select the WAV audio to be used in the THP video (optional).
* The <code>-r</code> flag is used to set the frame rate of the THP video. If you want your video to reproduce normally on SMG1 use 59.94 as frame rate. If omitted THPConv will set the frame rate of the THP video to 29.97 fps.
* The <code>-d</code> flag is used to set the THP file creation path and name.
* The <code>-v</code> flag is used to print more info on the CMD when THPConv is converting the JPG frames and WAV audio into a THP video (optional).
* To check more info on the commands THPConv has, check its documentation (Wii SDK or [[THPConv | here]]).
}}

Now you can replace the THP file with the one you want from your SMG1 dump and test the video on game!

{{ note |
* You can use VLC Media Player to play/test THP videos as well as FFmpeg to convert THP videos to other video formats (you can't convert to THP with FFmpeg).
* When testing the THP video on console it is better to not use Riivolution but rather pack the THP into the WBFS file and run said WBFS in a USB Loader. Due to either Riivolution file copying velocity or how inefficient the THP processing algorhythm/video format is (or a combination of both) the video can't be reproduced at its normal speed when being replaced by Riivolution.
}}

''Thanks to Lord-Giganticus and EmilyTheDemon for their support during the guide!''

== See also ==

* [[THPConv | THPConv documentation]]

THPConv

2024-05-10T17:03:15Z

HummingOwl: edited page styles

[[Category:Tools]]{{SDK Reference}}

'''THPConv.exe''' is a prebuilt Win32 console application that Nintendo provides in the Wii and GCN SDKs. It is used to convert sequential JPEG images into a THP video format (with an option to include audio into it from a WAV audio file) and to include/replace audio of an existent THP video. It needs the '''dsptool.dll''' file to work.

There is a similar program called '''THPConvD.exe''' included alonside '''THPConv.exe''' and according to the Wii SDK docs:

<blockquote>there is no difference in how the two behave. Normally you should use THPConv.exe. THPConvD.exe remains in order to maintain compatibility with past systems.</blockquote>

So you may use either '''THPConv.exe''' or '''THPConvD.exe''' to make/edit THP files (be sure to have the respective '''dsptoolD.dll''' for '''THPConvD.exe''').

Linux users can use [https://www.winehq.org/ Wine] to run both programs.

== Converting Sequential JPEG files to THP Movie Data ==

=== Description ===

The following describes how to use the THPConv tool to convert '''Sequential JPEG files''' to '''THP movie data''':

<code>THPConv.exe -j <*.jpg> -d <outputfile> [-<option> <argument>]</code>

Options description:

<table border="1" cellpadding="3" cellspacing="0">
<tr align="center">
<th width="50" bgcolor="#C0C0C0">Option</th>
<th width="100" bgcolor="#C0C0C0">Argument</th>
<th bgcolor="#C0C0C0">Description</th>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-j</th>
<td align="center" width="100" bgcolor="#E6E6FA"><*.jpg></td>
<td>Specifies the input files (sequential JPEG files). Wildcard characters ("*") can be used. This argument must always be specified.</td>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-d</th>
<td align="center" width="100" bgcolor="#E6E6FA"><outputfile></td>
<td>Specifies the output file (THP file). This argument must always be specified.</td>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-s</th>
<td align="center" width="100" bgcolor="#E6E6FA"><wavefile><wavefile>......</td>
<td>Specifies the audio file (WAV file) that will be converted to THP audio data. When specifying more than one file for the argument, data is allocated to audio tracks in the order it is specified.</td>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-r</th>
<td align="center" width="100" bgcolor="#E6E6FA"><framerate></td>
<td>Specifies the movie's frame rate. Frame rates from 1.0 to 59.94 can be specified. If nothing is specified, the default value (29.97) is used.</td>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-o</th>
<td align="center" width="100" bgcolor="#E6E6FA">-</td>
<td>THP movie data can internally store offsets to each frame data as a table. If this argument is specified, the THPConv tool will create an offset table in the THP data. If this argument is not specified, the THP movie data, no offset table will be created in the THP movie data.</td>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-non</th>
<td align="center" width="100" bgcolor="#E6E6FA" rowspan="3">-</td>
<td rowspan="3">Specifies the THP video data format. When interlace starts the video data from an odd numbered field, specify -odd. When interlace starts from an even numbered field, specify -even. If this argument is not specified, the THP video data format is automatically set to non-interlaced (-non).</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-odd</th>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-even</th>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-v</th>
<td align="center" width="100" bgcolor="#E6E6FA">-</td>
<td>Turns on Verbose mode.</td>
</tr>

<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-h</th>
<td align="center" width="100" bgcolor="#E6E6FA">-</td>
<td>Displays the option list.</td>
</tr>
</table>

=== Example ===

<code>THPConv.exe -j test*.jpg -d output.thp</code>

When this example is executed from a command line, the sequential JPEG files in the current directory (test001.jpg, test002.jpg, test003.jpg, etc.) are converted to THP video data and collected into a single THP movie data file (output.thp). No WAV audio is specified so the THP video will be just video without audio.

{{ note |
* When converting sequential JPEG files to THP movie data, the names of the specified input files must have the extension ".jpg" or ".jpeg".
* Unlike the Nintendo GameCube, audio data is output at the set playback frequency (of 48,000 Hz or 32,000 Hz) on the Wii.
}}

== Changing THP Audio Data in THP Movie Data ==

Note that some of the commands options above are the same here (being those '''-s''', '''-d''', '''-r''', '''-o''', '''-non''', '''-even''', '''-odd''', '''-v''', '''-h''').

=== Description ===

Below are the instructions for using the THPConv tool to change the THP audio data in '''THP Movie Data'''.

<code>THPConv.exe -c <inputfile> -s <wavefile> <wavefile>... -d <outputfile> [-<option> <argument>]</code>

Options Description:

<table border="1" cellpadding="3" cellspacing="0">
<tr align="center">
<th width="50" bgcolor="#C0C0C0">option</th>
<th width="100" bgcolor="#C0C0C0">argument</th>
<th bgcolor="#C0C0C0">Description</th>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-c</th>
<td align="center" width="100" bgcolor="#E6E6FA"><inputfile></td>
<td>Specifies the input file (THP file). This argument must always be specified.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-s</th>
<td align="center" width="100" bgcolor="#E6E6FA"><wavefile><wavefile>......</td>
<td>Specifies the replacing sound file ('''WAV file'''). When specifying more than one file for the argument, data is allocated to audio tracks in the order it is specified. If a THP file format that does not support multitracks is input, the output file will be in a format that supports multitracks.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-d</th>
<td align="center" width="100" bgcolor="#E6E6FA"><outputfile></td>
<td>Specifies the output file (THP file). If this argument is not given, the THPConv tool will overwrite the input file.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-r</th>
<td align="center" width="100" bgcolor="#E6E6FA"><framerate></td>
<td>Specifies the movie's frame rate. Frame rates from 1.0 to 59.94 can be specified. If nothing is specified, the default value (29.97) is used.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-o</th>
<td align="center" width="100" bgcolor="#E6E6FA">-</td>
<td>THP movie data can internally store offsets to each frame data as a table. If this argument is specified, the THPConv tool will create an offset table in the THP data. If this argument is not specified, the THP movie data, no offset table will be created in the THP movie data.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-non</th>
<td align="center" width="100" bgcolor="#E6E6FA" rowspan="3">-</td>
<td rowspan="3">Specifies the THP video data format. When interlace starts the video data from an odd numbered field, specify -odd. When interlace starts from an even numbered field, specify -even. If this argument is not specified, the THP video data format will be automatically set to non-interlaced (-non).</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-odd</th>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-even</th>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-trk</th>
<td align="center" width="100" bgcolor="#E6E6FA"><track No.><wavefile></td>
<td>If you only want to replace a single audio track dataset, use this option instead of -s. The first argument is the audio track number to replace (0-), the second argument is the sound file (WAV file) that will make the replacement. Using this option invalidates the -r, -o, -non, -odd, and -even options. This option can only be used with the THP file formats that support multitracks.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-v</th>
<td align="center" width="100" bgcolor="#E6E6FA">-</td>
<td>Turns on Verbose mode.</td>
</tr>
<tr>
<th align="center" width="50" bgcolor="#FFFFCC">-h</th>
<td align="center" width="100" bgcolor="#E6E6FA">-</td>
<td>Displays the option list.</td>
</tr>
</table>

{{ note |
* When the THPConv tool replaces audio data in existing THP movie data, the old THP audio data is deleted. Once the THP audio data is deleted, it cannot be restored. If no output file is specified when the audio data is replaced, the THPConv tool will overwrite the THP movie data. When replacing the audio data, be sure to create a backup file or to specify an output file; this will prevent accidental deletion of your data.
* If the replacement WAV file has a longer playback time than the THP movie data, the section of the replacement WAV file that is longer than the THP movie data will not be converted. If the playback time of the THP movie data is longer than the wave file, the remaining section will be silent.
* If the THP movie data specified as the input data does not contain audio data, this operation will add THP audio data to the specified file.
* If you want the THP movie data to contain more than one audio track dataset, make sure that the channel counts and playback frequencies for all audio track datasets are the same.
* Unlike the Nintendo GameCube, audio data on the Wii console is output at a set playback frequency (48,000 Hz or 32,000 Hz).
}}

== Compatible file formats for THPConv ==

=== Sequential JPEG File Format ===

==== Description ====

The THPConv tool can convert a group of sequential JPEG files having sequence numbers at the end of their filenames (indicating the playback order) to THP movie data. When interleaving audio data in sequential JPEG files, you must either specify the WAV files by using the -s option at the time the sequential JPEG files are converted, or add the WAV files after conversion.

The following restrictions apply to groups of sequential JPEG files that can be handled with the THPConv tool:

* All JPEG files to be collected into a single THP movie dataset must have the same number of pixels in the horizontal and vertical directions.
* The group of sequential JPEG files must have sequence numbers (corresponding to frame numbers) appended to the end of their filenames.
* The number of the JPEG file corresponding to the initial frame of the THP movie data can be any number. However, the numbers of all files thereafter must be sequential.
* Please add leading zeros to the frame numbers appended to the filenames so that they all match the number of digits in the last frame.

The following restrictions apply to each file in a group of sequential JPEG files:

* Only the JPEG baseline DCT format is supported.
* Only sequential encoding is supported.
* Only supports a sample rate of 4:2:0.
* The pixel counts in both the horizontal and vertical directions must be a multiple of 16.
* The maximum pixel count in the horizontal direction is 672 dots. There is no restriction on the pixel count in the vertical direction.

If the sequential JPEG files do not meet these requirements, the THPConv tool will output an error and stop processing.

==== Example ====

To create four seconds of THP movie data at 30 FPS from sequential JPEG files, the numbers of the sequential JPEG files (testxxx.jpg) should look like the following:

<table border="0">
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60"> 1 : </td>
<td width="180">test001.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60"> 2 : </td>
<td width="180">test002.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60"> 3 : </td>
<td width="180">test003.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80"> …</td>
<td align="right" width="60"> … : </td>
<td width="180"> …</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60">51 : </td>
<td width="180">test051.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60">52 : </td>
<td width="180">test052.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80"> …</td>
<td align="right" width="60"> … : </td>
<td width="180"> …</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60">118 : </td>
<td width="180">test118.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60">119 : </td>
<td width="180">test119.jpg</td>
</tr>
<tr align="center">
<td align="center" width="80">Frame</td>
<td align="right" width="60">120 : </td>
<td width="180">test120.jpg</td>
</tr>
</table>

=== WAV file format ===

==== Description ====

The THPConv tool can convert a general WAV file to THP audio data and interleave it with THP movie data. The following restrictions apply to WAV files that can be converted by the THPConv tool:

* They must be non-compressed 16-bit PCM data.
* Monaural (one channel) and stereo (two channels) are supported.

If the wav file does not meet these requirements, the THPConv tool will output an error and stop processing.

{{ note |
* Unlike the Nintendo GameCube, audio data is output at the set playback frequency (of 48,000 Hz or 32,000 Hz) on the Wii.
* WAV files having a playback frequency other than 48,000Hz or 32,000Hz can be specified in THPConv. When playing THP movie data created with such WAV files, use <code>THPPlayerStrmAX</code>.Even if you created THP movie data specifying wav files with a playback frequency of 48,000Hz or 32,000Hz, if the playback frequency setting on the Wii is different, use <code>THPPlayerStrmAX</code>.
* If you want the THP movie data to contain more than one audio data set, make sure the channel counts and playback frequencies for all data sets are the same.
}}

THPConv-Guide

2024-05-10T14:26:17Z

HummingOwl:

This guide is created specifically to make THP videos for SMG1. Other games that support THP may have a different THP setup.

== Required Tools ==

* FFmpeg ([https://web.archive.org/web/20200901234146/https://ffmpeg.zeranoe.com/builds/win32/static/ Win32 older builds], for Linux you can use your package manager)
* THPConv.exe (with dsptool.dll, [https://archive.org/details/WiiDevelopmentPackage/ Wii SDK])
* [https://github.com/MasterofGalaxies/THPConv Alternative THPConv build] (for Linux users)
* [https://www.videolan.org/vlc/ VLC Media Player] (to reproduce THP files)
* [https://www.winehq.org/ Wine] (for Linux users)

== Steps ==

Open a CMD/Terminal in the same place the video you want to convert is and type the following command (Fig. 1):

<code>path\to\ffmpeg.exe -i [input_video] -vf scale="[width]:[height]" -r [fps] [temp_video]</code>

*<code>[input_video]</code> is the video of your choice to convert. Can be any video format.
*<code>[width]</code> is the width the <code>[temp_video]</code> will have. Cannot exceed 672 pixels.
*<code>[height]</code> is the height the <code>[temp_video]</code> will have. There is no limit on this value.
*<code>[fps]</code> are the frames per second the <code>[temp_video]</code> will have. Frame rates can be from 1.0 to 59.94.

[[File:THPConv-Guide_Fig-1.webp|right|thumb|Fig. 1 - Create temporal video]]

{{note |
* All this information is extracted from the Wii SDK docs for THPConv.
* SMG uses 59.94 fps and 640x368 video dimensions for all THP files in the <code>MovieData</code> folder. Use <code>path\to\ffmpeg.exe -i [THP video file]</code> to see it yourself.
* If you use different frame rates than 59.94 the video on SMG1 will play slower or faster but not at its "normal" speed.
You can use different values for the width and height of the video, be sure they follow the rules said above and that the dimensions are a multiple of 16.
* To get a better video resolution on the final THP video you can use the following flags on the above command <code>-preset veryslow -b:v 21M</code> (file size will increase a lot as <code>-b:v</code> sets the bitrate of the output video). <code>21M</code> was selected because of the bitrates of the OG THP videos on the MovieData folder (you can select any value you want, <code>M</code> means megabyte).
}}

Create a folder named <code>temp</code> in the same place the <code>[temp_video]</code> is and then type the following command (Fig. 2 and 3):

<code>path\to\ffmpeg.exe -i [temp_video] temp\output%03d.jpg</code>

This will dump all the frames the <code>[temp_video]</code> has into JPG images.

[[File:THPConv-Guide Fig-2.webp|right|thumb|Fig. 2 - Create temporal folder]]

[[File:THPConv-Guide Fig-3.webp|right|thumb|Fig. 3 - Dump temporal video frames into folder]]

{{ note |
* JPG or JPEG can be used, the only restriction the THPConv docs say is that they need to be in the baseline DCT format (which ffmpeg automatically converts them to with the above command).
* The minimum frames a THP video can have without breaking the game is 21. Tested with <code>PrologueA.thp</code> in Riivolution.
* Very low width and height values for the THP video (16x16 for example) will allow to show blue rectangles on the screen when reproducing the associated cutscene. Tested it very little so I am unsure if this happens all the time.
* To get a video resolution similar to the [temp_video] on your THP video you can use the following flag on the above command <code>-q:v 1</code>
}}

Then, to get the audio part of the video execute (Fig. 4):

<code>path\to\ffmpeg.exe -i [temp_video] -acodec pcm_s16le -ar 32000 [WAV_audio].wav</code>

*<code>[WAV_audio].wav</code> is the name of the WAV audio file to use with THPConv.

:This will convert the audio of the <code>[temp_video]</code> in a WAV audio using the pcm_s16le format.

[[File:THPConv-Guide_Fig-4.webp|right|thumb|Fig. 4 - Create WAV audio file]]

{{ note |
* WAV audios are the only audio input THPConv can process. Specifically non-compressed 16-bit PCM data ones.
* WAV audios can be Mono or Stereo, they are both supported by THPConv.
* The <code>-ar 32000</code> sets the frequency of the WAV audio. 32000 Hz is needed for the audio in SMG1 since different values make the audio sound at a higher or lower pitch.
}}

Finally, to get the THP converted file we do (Fig. 5):

<code>path\to\THPConv.exe -j temp\output*.jpg -s [WAV_audio].wav -r 59.94 -d [Output THP].thp -v</code>

[[File:THPConv-Guide_Fig-5.webp|right|thumb|Fig. 5 - Create THP file with THPConv]]

{{ note |
* The <code>-j</code> flag is used to select the JPEG sequential frames that are going to be used in the THP video.
* The <code>-s</code> flag is used to select the WAV audio to be used in the THP video (optional).
* The <code>-r</code> flag is used to set the frame rate of the THP video. If you want your video to reproduce normally on SMG1 use 59.94 as frame rate. If omitted THPConv will set the frame rate of the THP video to 29.97 fps.
* The <code>-d</code> flag is used to set the THP file creation path and name.
* The <code>-v</code> flag is used to print more info on the CMD when THPConv is converting the JPG frames and WAV audio into a THP video (optional).
* To check more info on the commands THPConv has, check its documentation (Wii SDK or [[THPConv | here]]).
</blockquote>

Now you can replace the THP file with the one you want from your SMG1 dump and test the video on game!

{{ note |
* You can use VLC Media Player to play/test THP videos as well as FFmpeg to convert THP videos to other video formats (you can't convert to THP with FFmpeg).
* When testing the THP video on console it is better to not use Riivolution but rather pack the THP into the WBFS file and run said WBFS in a USB Loader. Due to either Riivolution file copying velocity or how inefficient the THP processing algorhythm/video format is (or a combination of both) the video can't be reproduced at its normal speed when being replaced by Riivolution.
}}

''Thanks to Lord-Giganticus and EmilyTheDemon for their support during the guide!''

== See also ==

* [[THPConv | THPConv documentation]]

THPConv-Guide

2024-05-10T04:06:30Z

HummingOwl: using new note box!

This guide is created specifically to make THP videos for SMG1. Other games that support THP may have a different THP setup.

== Required Tools ==

* FFmpeg ([https://web.archive.org/web/20200901234146/https://ffmpeg.zeranoe.com/builds/win32/static/ Win32 older builds], for Linux you can use your package manager)
* THPConv.exe (with dsptool.dll, [https://archive.org/details/WiiDevelopmentPackage/ Wii SDK])
* [https://github.com/MasterofGalaxies/THPConv Alternative THPConv build] (for Linux users)
* [https://www.videolan.org/vlc/ VLC Media Player] (to reproduce THP files)
* [https://www.winehq.org/ Wine] (for Linux users)

== Steps ==

Open a CMD/Terminal in the same place the video you want to convert is and type the following command (Fig. 1):

<code>path\to\ffmpeg.exe -i [input_video] -vf scale="[width]:[height]" -r [fps] [temp_video]</code>

*<code>[input_video]</code> is the video of your choice to convert. Can be any video format.
*<code>[width]</code> is the width the <code>[temp_video]</code> will have. Cannot exceed 672 pixels.
*<code>[height]</code> is the height the <code>[temp_video]</code> will have. There is no limit on this value.
*<code>[fps]</code> are the frames per second the <code>[temp_video]</code> will have. Frame rates can be from 1.0 to 59.94.

[[File:THPConv-Guide_Fig-1.webp|right|thumb|Fig. 1 - Create temporal video]]

{{note |
* All this information is extracted from the Wii SDK docs for THPConv.
* SMG uses 59.94 fps and 640x368 video dimensions for all THP files in the <code>MovieData</code> folder. Use <code>path\to\ffmpeg.exe -i [THP video file]</code> to see it yourself.
* If you use different frame rates than 59.94 the video on SMG1 will play slower or faster but not at its "normal" speed.
You can use different values for the width and height of the video, be sure they follow the rules said above and that the dimensions are a multiple of 16.
* To get a better video resolution on the final THP video you can use the following flags on the above command <code>-preset veryslow -b:v 21M</code> (file size will increase a lot as <code>-b:v</code> sets the bitrate of the output video). <code>21M</code> was selected because of the bitrates of the OG THP videos on the MovieData folder (you can select any value you want, <code>M</code> means megabyte).
}}

Create a folder named <code>temp</code> in the same place the <code>[temp_video]</code> is and then type the following command (Fig. 2 and 3):

<code>path\to\ffmpeg.exe -i [temp_video] temp\output%03d.jpg</code>

This will dump all the frames the <code>[temp_video]</code> has into JPG images.

[[File:THPConv-Guide Fig-2.webp|right|thumb|Fig. 2 - Create temporal folder]]

[[File:THPConv-Guide Fig-3.webp|right|thumb|Fig. 3 - Dump temporal video frames into folder]]

{{ note |
* JPG or JPEG can be used, the only restriction the THPConv docs say is that they need to be in the baseline DCT format (which ffmpeg automatically converts them to with the above command).
* The minimum frames a THP video can have without breaking the game is 21. Tested with <code>PrologueA.thp</code> in Riivolution.
* Very low width and height values for the THP video (16x16 for example) will allow to show blue rectangles on the screen when reproducing the associated cutscene. Tested it very little so I am unsure if this happens all the time.
* To get a video resolution similar to the [temp_video] on your THP video you can use the following flag on the above command <code>-q:v 1</code>
}}

Then, to get the audio part of the video execute (Fig. 4):

<code>path\to\ffmpeg.exe -i [temp_video] -acodec pcm_s16le -ar 32000 [WAV_audio].wav</code>

*<code>[WAV_audio].wav</code> is the name of the WAV audio file to use with THPConv.

:This will convert the audio of the <code>[temp_video]</code> in a WAV audio using the pcm_s16le format.

[[File:THPConv-Guide_Fig-4.webp|right|thumb|Fig. 4 - Create WAV audio file]]

{{ note |
* WAV audios are the only audio input THPConv can process. Specifically non-compressed 16-bit PCM data ones.
* WAV audios can be Mono or Stereo, they are both supported by THPConv.
* The <code>-ar 32000</code> sets the frequency of the WAV audio. 32000 Hz is needed for the audio in SMG1 since different values make the audio sound at a higher or lower pitch.
}}

Finally, to get the THP converted file we do (Fig. 5):

<code>path\to\THPConv.exe -j temp\output*.jpg -s [WAV_audio].wav -r 59.94 -d [Output THP].thp -v</code>

[[File:THPConv-Guide_Fig-5.webp|right|thumb|Fig. 5 - Create THP file with THPConv]]

{{ note |
* The <code>-j</code> flag is used to select the JPEG sequential frames that are going to be used in the THP video.
* The <code>-s</code> flag is used to select the WAV audio to be used in the THP video (optional).
* The <code>-r</code> flag is used to set the frame rate of the THP video. If you want your video to reproduce normally on SMG1 use 59.94 as frame rate. If omitted THPConv will set the frame rate of the THP video to 29.97 fps.
* The <code>-d</code> flag is used to set the THP file creation path and name.
* The <code>-v</code> flag is used to print more info on the CMD when THPConv is converting the JPG frames and WAV audio into a THP video (optional).
* To check more info on the commands THPConv has, check its documentation (Wii SDK or [[THPConv | here]]).
</blockquote>

Now you can replace the THP file with the one you want from your SMG1 dump and test the video on game!

{{ note |
* You can use VLC Media Player to play/test THP videos as well as FFmpeg to convert THP videos to other video formats (you can't convert to THP with FFmpeg).
* When testing the THP video on console it is better to not use Riivolution but rather pack the THP into the WBFS file and run said WBFS in a USB Loader. Due to either Riivolution file copying velocity or how inefficient the THP processing algorhythm/video format is (or a combination of both) the video can't be reproduced at its normal speed when being replaced by Riivolution.
}}

''Thanks to Lord-Giganticus and EmilyTheDemon for their support during the guide!''

== See also ==

* [[THPConv | THPConv documentation]]
* [https://github.com/MasterofGalaxies/THPConv THPConv port to Linux]

Template:Note

2024-05-10T04:01:22Z

HummingOwl:

2023-04-29T01:30:36Z

HummingOwl: Added GM's port of THPConv for Linux as tool

[[Category:File formats]]
{{SDK Reference}}
'''THP''' does not stand for anything unlike other file formats. It's mainly used for prerendered cutscenes and other prerendered videos. This format was also used on the Nintendo GameCube.

= Format Specifications =
Below you'll find helpful tables on how the file is structured
== Header ==
Each THP starts with a ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || "THP0" in ASCII
|-
| 0x04 || UInt32 || ''Version Number''. SMG uses 0x1048832
|-
| 0x08 || UInt32 || The Maximum Frame data size
|-
| 0x0C || UInt32 || Max no. of Audio Samples. SMG uses 0x570556416
|-
| 0x10 || Float || Frame Rate. Defaults to 29.97 in ''THPConv.exe''. SMG uses 59.97 (the max value)
|-
| 0x14 || UInt32 || Total number of frames
|-
| 0x18 || UInt32 || The length of the first frame
|-
| 0x1C || UInt32 || The length of ALL frames
|-
| 0x20 || UInt32 || Offset to components
|-
| 0x24 || UInt32 || Offset to FrameOffsetData
|-
| 0x28 || UInt32 || First frame offset
|-
| 0x2C || UInt32 || Last frame offset
|-
|}
== Frame Comp Info ==
This section is for the Component structure
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Number of components in this frame. Max is 16
|-
| 0x04 || UInt8[16] || Component types (0 = video, 1 = audio, -1 = none)
|-
|}
== Video ==
This section contains the video data.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Width. SMG uses 640
|-
| 0x04 || UInt32 || Height. SMG uses 368
|-
| 0x08 || UInt32 || Video format (Only used in certain versions)
|-
|}

== Audio ==
This sections contains the audio data.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Number of Audio Channels (Min is 0, Max is 2)
|-
| 0x04 || UInt32 || Frequency
|-
| 0x08 || UInt32 || Number of samples played
|-
| 0x0C || UInt32 || Number of tracks (Only used in certain versions)
|-
|}
== Frame ==
A frame starts with a frame ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Total size of the next frame
|-
| 0x04 || UInt32 || Total size of previous frame
|-
| 0x08 || UInt32 || Total size of the current frame
|-
| 0x0C || UInt32 || Audio size (Only if there is audio in the current frame)
|-
| 0x0C or 0x10 || colspan="2" style="text-align:center; background: #d0d0d0;" | Image Data
|-
|}
=== Video ===
Video data
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int8['''I'''] || Image Data
|-
| '''I''' || colspan="2" style="text-align:center; background: #d0d0d0;" | End of Image Data
|-
|}
=== Audio ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Channel size
|-
| 0x04 || UInt32 || Number of samples
|-
| 0x08 || Int16[16] || Table 1
|-
| 0x28 || Int16[16] || Table 2
|-
| 0x48 || Int16 || Channel 1 previous 1
|-
| 0x4A || Int16 || Channel 1 previous 2
|-
| 0x4C || Int16 || Channel 2 previous 1
|-
| 0x4E || Int16 || Channel 2 previous 2
|-
| 0x50 || colspan="2" style="text-align:center; background: #d0d0d0;" | Audio Data
|-
|}
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int8['''M'''] || Audio Data
|-
| '''M''' || colspan="2" style="text-align:center; background: #d0d0d0;" | End of Audio Data
|-
|}
= Tools =
The following tools can handle THP files:
* [https://github.com/soopercool101/BrawlCrate BrawlCrate] (Can only view the files)
* [https://www.ffmpeg.org/ ffmpeg] (Can convert THP videos to other video formats)
* [https://www.videolan.org/vlc/ VLC media player] (Can reproduce THP video files)
* [https://sites.google.com/site/wiiflowiki4/trailers/thp-video-convertor Wiiflow THP Video Converter] (Creates THP videos. Only supports 30 fps)
* [https://github.com/Lord-Giganticus/THP-Conveter THP-Converter] (Can convert to and from THP files using other programs)
* [[THPConv|THPConv.exe]] (Nintendo's internal program to make THP videos, used by other programs)
* [https://github.com/MasterofGalaxies/THPConv THPConv (for Linux)] (Port of Nintendo's THPConv tool to Linux)

THP

2023-04-29T00:17:14Z

HummingOwl: Added VLC as tool to open THP videos

[[Category:File formats]]
{{SDK Reference}}
'''THP''' does not stand for anything unlike other file formats. It's mainly used for prerendered cutscenes and other prerendered videos. This format was also used on the Nintendo GameCube.

= Format Specifications =
Below you'll find helpful tables on how the file is structured
== Header ==
Each THP starts with a ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || String || "THP0" in ASCII
|-
| 0x04 || UInt32 || ''Version Number''. SMG uses 0x1048832
|-
| 0x08 || UInt32 || The Maximum Frame data size
|-
| 0x0C || UInt32 || Max no. of Audio Samples. SMG uses 0x570556416
|-
| 0x10 || Float || Frame Rate. Defaults to 29.97 in ''THPConv.exe''. SMG uses 59.97 (the max value)
|-
| 0x14 || UInt32 || Total number of frames
|-
| 0x18 || UInt32 || The length of the first frame
|-
| 0x1C || UInt32 || The length of ALL frames
|-
| 0x20 || UInt32 || Offset to components
|-
| 0x24 || UInt32 || Offset to FrameOffsetData
|-
| 0x28 || UInt32 || First frame offset
|-
| 0x2C || UInt32 || Last frame offset
|-
|}
== Frame Comp Info ==
This section is for the Component structure
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Number of components in this frame. Max is 16
|-
| 0x04 || UInt8[16] || Component types (0 = video, 1 = audio, -1 = none)
|-
|}
== Video ==
This section contains the video data.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Width. SMG uses 640
|-
| 0x04 || UInt32 || Height. SMG uses 368
|-
| 0x08 || UInt32 || Video format (Only used in certain versions)
|-
|}

== Audio ==
This sections contains the audio data.
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Number of Audio Channels (Min is 0, Max is 2)
|-
| 0x04 || UInt32 || Frequency
|-
| 0x08 || UInt32 || Number of samples played
|-
| 0x0C || UInt32 || Number of tracks (Only used in certain versions)
|-
|}
== Frame ==
A frame starts with a frame ''header''
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Total size of the next frame
|-
| 0x04 || UInt32 || Total size of previous frame
|-
| 0x08 || UInt32 || Total size of the current frame
|-
| 0x0C || UInt32 || Audio size (Only if there is audio in the current frame)
|-
| 0x0C or 0x10 || colspan="2" style="text-align:center; background: #d0d0d0;" | Image Data
|-
|}
=== Video ===
Video data
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int8['''I'''] || Image Data
|-
| '''I''' || colspan="2" style="text-align:center; background: #d0d0d0;" | End of Image Data
|-
|}
=== Audio ===
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || Channel size
|-
| 0x04 || UInt32 || Number of samples
|-
| 0x08 || Int16[16] || Table 1
|-
| 0x28 || Int16[16] || Table 2
|-
| 0x48 || Int16 || Channel 1 previous 1
|-
| 0x4A || Int16 || Channel 1 previous 2
|-
| 0x4C || Int16 || Channel 2 previous 1
|-
| 0x4E || Int16 || Channel 2 previous 2
|-
| 0x50 || colspan="2" style="text-align:center; background: #d0d0d0;" | Audio Data
|-
|}
{| class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Int8['''M'''] || Audio Data
|-
| '''M''' || colspan="2" style="text-align:center; background: #d0d0d0;" | End of Audio Data
|-
|}
= Tools =
The following tools can handle THP files:
* [https://github.com/soopercool101/BrawlCrate BrawlCrate] (Can only view the files)
* [https://www.ffmpeg.org/ ffmpeg] (Can convert THP videos to other video formats)
* [https://www.videolan.org/vlc/ VLC media player] (Can reproduce THP video files)
* [https://sites.google.com/site/wiiflowiki4/trailers/thp-video-convertor Wiiflow THP Video Converter] (Creates thp videos. Only supports 30 fps)
* [https://github.com/Lord-Giganticus/THP-Conveter THP-Converter] (Can convert to and from THP files using other programs)
* [[THPConv|THPConv.exe]] (Nintendo's internal program to make thp videos, used by other programs)