Create README.md

README.md

@@ -0,0 +1,30 @@
+# SegaSaturnFilmMuxer
+
+This tool will take the Audio and Video from 2 different source FILM files and remux them to create a new FILM file of the combined streams. This is useful if you need to modify only one aspect of an FMV in a Saturn game such as the following situations:
+
+1) You have a Japanese FMV that you want to replace the Audio with a different langauges dub while preserving the quality of the original Japanese Video encode.
+2) You have a newly encoded FMV but you want to preserve the quality or compression scheme of the original FMV from the game.
+
+The tool is able to support both uncompressed PCM audio as well as ADX compressed audio.
+
+# Requirements for use
+
+Currently the tool does have the following requirements for use:
+
+1) Both files video streams must have the exact same amount of frames and match in resolution and frame rate.
+2) Both files audio streams must have the same specifications (8-bit/16-bit, Mono/Stereo, Sample Rate, etc.). Audio Compression however does not matter.
+3) Being written in Java, a Java Runtime Environment must be installed. It should work with Java 8 or higher.
+
+# How to use
+
+1) Encode your new video as you normally would following the Sega Saturn Cinepak Encoding process making sure to adhear to the requirements listed above.
+    * If you want to preserve the original video but replace the audio, encode your a copy of the source video with your new audio swapped in.
+    * If you want to preserve the original audio, encode your modified video with uncompressed PCM audio that matches the specifications of the original source video.
+2) Run the tool and select the source FILM file for your audio, the source FILM file for your video, and the output directory.
+3) Click the "Mux Audio and Video" button.
+
+Your new file will be in the specified output directory with the naming convention "NEW_<Name_of_Source_Audio_File>".
+
+# Why use this instead of FFMPEG?
+
+While FFMPEG does technically support Sega FILM files, it does not generate the STAB chunk correctly. While some games may be lenient and still play these files, thay may present issues (Video glitches, Cracks and Pops in audio, other errors, etc.). Other games may instead just flat out refuse to play these files or crash completely. A good example of this is Sakura Wars 2. This tool will instead generate a correct file with a compliant STAB chunk that any game should be able to play.