ReadMe.txt

   1 Simple x264 Launcher - use 64-Bit x264 with 32-Bit Avisynth
   2 Copyright (C) 2004-2013 LoRd_MuldeR <MuldeR2@GMX.de>
   3
   4
   5 1. Introduction
   6 ---------------
   7
   8 This program is a simple GUI front-end for the x264 H.264/AVC encoder.
   9 Thanks to Avs2YUV, this program can use the 64-Bit version of x264 with
  10 the 32-Bit version of Avisynth. This way you can keep on using your
  11 favorite 32-Bit Avisynth plug-ins (e.g. DGDecodeNV) and still benefit
  12 from the speed improvements of 64-Bit x264. Of course you can also use
  13 64-Bit Avisynth, which is still considered experimental, if desired.
  14 And of course you can use x264's built-in LAVF/FFMS input instead of
  15 Avisynth just as well. Moreover this program provides full batch
  16 encoding support. This means that you can run several encoding jobs in
  17 parallel. Or you can let them run in sequence - one by one.
  18
  19
  20 2. System Requirements
  21 ----------------------
  22
  23 This program runs on Windows XP with Service Pack 2 and later.
  24 64-Bit Windows is highly recommended, but 32-Bit Windows works as well.
  25 The CPU should support at least the MMX and SSE1 instruction sets.
  26 Avisynth 2.5.x must be installed in order to use Avisynth (.avs) input.
  27 YV16/YV24 color spaces only supported by Avisynth 2.6 [see section 9].
  28 Audio encoding NOT officially supported by x264 yet [see section 10].
  29
  30
  31 3. Anti-Virus Warning
  32 ---------------------
  33
  34 Occasionally your Antivirus program may mistakenly detect "malware"
  35 (virus, trojan, worm, etc.) in some of the files here. This is called a
  36 "False Positive" and the files are actually innocent/clean. It´s an
  37 error in your specific Antivirus software.
  38
  39 In case you encounter such problems, go to http://www.virustotal.com/
  40 and check the file again with multiple Antivirus engines! And take care
  41 with results like "suspicious" , "generic" or "packed". Those are *not*
  42 real hits, they are just wild speculation.
  43
  44 Apparently Antivirus programs tend to suspect installers/uninstaller
  45 created with NSIS. Furthermore some Antivirus programs blindly suspect
  46 all UPX´d (packed) executables of being malware. Obviously this is a
  47 stupid generalization, so you can safely ignore those warnings!
  48
  49 Last but not least: Always keep in mind that this is OpenSource
  50 software! If you don´t trust the people providing the pre-compiled
  51 binaries, download the source codes and compile them yourself.
  52
  53 DON´T SUBMIT ANY VIRUS/TROJAN REPORTS, UNLESS YOU HAVE VERIFIED THE
  54 INFECTION WITH MULTIPLE ANTIVIRUS ENGNINES. THANKS!
  55
  56
  57 4. License
  58 ----------
  59
  60 This program is free software; you can redistribute it and/or modify
  61 it under the terms of the GNU General Public License as published by
  62 the Free Software Foundation; either version 2 of the License, or
  63 (at your option) any later version.
  64
  65 This program is distributed in the hope that it will be useful,
  66 but WITHOUT ANY WARRANTY; without even the implied warranty of
  67 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  68 GNU General Public License for more details.
  69
  70 You should have received a copy of the GNU General Public License along
  71 with this program; if not, write to the Free Software Foundation, Inc.,
  72 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  73
  74 http://www.gnu.org/licenses/gpl-2.0.txt
  75
  76
  77 5. Portable Mode
  78 ----------------
  79
  80 This application can be run in "portable" mode. Just rename the EXE
  81 file to 'x264_launcher_portable.exe' in order to trigger portable mode.
  82 In that mode all configuration files will be saved in the same folder
  83 where the EXE file resides. This may be helpful, if you want to run the
  84 application directly from your USB stick on different computers. Note,
  85 however, that in portable mode the install folder must be writable!
  86
  87
  88 6. Updating Your x264 Binaries
  89 ------------------------------
  90
  91 This application works best with the x264 binaries that are included in
  92 the distribution package. That's because these binaries have been
  93 tested to work properly with the GUI. Nonetheless in some cases you may
  94 want to replace the included binaries with a newer version of x264 or
  95 with an alternative build of the same version. Generally newer versions
  96 of x264 should work with the GUI too, though there is NO guarantee. In
  97 rare cases the CLI syntax (or console output) of x264 may change in a
  98 way that breaks the compatibility and therefore will require an update
  99 of the GUI itself. Furthermore this application does NOT provide any
 100 support for unofficial x264 patches. Usually x264 builds that contain
 101 unofficial patches will work anyway, but again there is NO guarantee.
 102 Using old/outdated x264 binaries with this application is NOT supported
 103 or intended. Report bugs rather than reverting to an old version!
 104
 105
 106 7. Timeout Warning
 107 ------------------
 108
 109 This application provides "deadlock" prevention. This means that if an
 110 encoder process (x264 or Avisynth) stops responding, it will be
 111 terminated. This is done in order to ensure that the main program as
 112 well as the other encoder processes can continue properly. More
 113 specifically, a warning will be raised if the process does not respond
 114 for one minute. If the process still didn't respond after five minutes,
 115 it will be terminated and consequently the encoding job is aborted. In
 116 some rare cases, your Avisynth script may take a very long time to
 117 initialize and thus the process will be aborted before the encoding can
 118 start. For example, this can happen if FFMS2/FFVideoSource takes a very
 119 long time to index the source file. In that case, we recommend to index
 120 the source file beforehand, e.g. by using the 'ffmsindex' tool.
 121
 122
 123 8. Custom Parameters
 124 --------------------
 125
 126 This application provides a "Custom Parameters" edit box. All command-
 127 line parameters you enter there will be passed to x264 unmodified. This
 128 way you can send arbitrary parameters to x264 - even such ones that are
 129 only available in patched builds of x264. See the x264 Wiki or the Help
 130 Screen for a list of available parameters. However be aware that the
 131 GUI will not check your parameters at all! Thus using an unknown or
 132 unsupported parameter will cause your encode to fail. Using an existing
 133 parameter in the wrong way will cause your encode to fail too. Last but
 134 not least, some parameters are forbidden by the GUI. If some parameter
 135 is forbidden, that's because the GUI will set that parameter for you
 136 (if required) or because that parameter is NOT compatible with the GUI.
 137
 138 Hint: Occasionally your custom parameters string may become very long,
 139 especially when working with zones. In that case you can right-click on
 140 the "Custom Parameters" edit box and choose "Open the Text-Editor".
 141 This will open a multi-line text editor for easier parameter handling.
 142
 143
 144 9. Color Spaces / Chroma Subsampling
 145 ------------------------------------
 146
 147 Avs2YUV converts the output of your Avisynth script to the YV12 format,
 148 i.e. YUV data with 4:2:0 chroma subsampling and 8-Bit precision.
 149 Usually this is exactly what you want/need. If, however, your Avisynth
 150 script outputs image data with a higher chroma resolution, e.g. YUY2
 151 (4:2:2), then the conversion to YV12 (4:2:0) will discard some of the
 152 information. In that case, and if you want/need to keep the full chroma
 153 resolution of your Avisynth script's output, you will have to pass the
 154 "-csp" switch to Avs2YUV as a custom parameter! Use "-csp I422" for
 155 YUV 4:2:2 (YV16) and use "-csp I444" for YUV 4:4:4 (YV24). Please note
 156 that Avs2YUV can NOT pass through the "packed" YUY2 format. Thus it has
 157 to be converted to the "planar" YV16 format. As both, YUY2 and YV16,
 158 are YUV 4:2:2 formats, converting from YUY2 to YV16 is a lossless
 159 operation. Note, however, that Avisynth 2.5 did NOT support YV16/YV24,
 160 so you need to use Avisynth 2.6; otherwise Avs2YUV will fail to do the
 161 conversion! Also be aware that the x264 encoder itself will convert any
 162 YV16 or YV24 input back to the YV12 format, if you don't pass the
 163 suitable "--output-csp i422/i444" switch to x264 as a custom parameter!
 164 In short, to encode YUY2 from Avisynth, you have to pass "-csp I422" to
 165 Avs2YUV and "--output-csp i422" to x264 to avoid 4:2:0 downsampling.
 166
 167
 168 10. Audio Processing/Encoding
 169 -----------------------------
 170
 171 This application is a front-end to the x264 encoder. And, as x264 does
 172 NOT support audio processing/encoding yet, there is NO explicit support
 173 for audio encoding in this application. Thus, if you want to create a
 174 video file *with* audio, you will have to add the audio stream to the
 175 encoded video file afterwards. This process is called 'multiplexing' or
 176 just 'muxing'. In case you are dealing with Matroska (MKV) files, then
 177 "MKVMerge GUI" from the "MKVToolNix" package is the right tool for this
 178 task. If, instead, you are dealing with MP4 files, then you may use
 179 "MP4Box" or the "YAMB" front-end for muxing the audio stream.
 180
 181 Having said all that, there now is an unofficial "Audio" branch of x264
 182 available. If you are using one of the modified x264 builds with "audio
 183 support" patch (e.g. those provided by JEEB), then you can process the
 184 audio with x264 and skip the additional muxing step. Basically the
 185 audio patch adds a new "--acodec" switch, which you can pass to x264 as
 186 a custom parameter. For example, you can pass "--acodec aac" for
 187 encoding the audio to the AAC format (recommended for MP4 files). Or
 188 you can pass "--acodec vorbis" for encoding the audio to the Ogg/Vorbis
 189 format (recommended for MKV files). Please be aware that audio encoding
 190 will work only, if your input file contains an audio stream! When using
 191 the built-in LAVF/FFMS input of x264, the audio can be encoded straight
 192 from the input file. This does NOT work with Avisynth input! Instead,
 193 if you want to encode audio from an Avisynth script, you must pass the
 194 "--audiofile <path_to_avs_file>" switch to x264 as a custom parameter.
 195 For convenience, the string "--audiofile $(INPUT)" may be used.
 196
 197
 198 11. OpenCL Support
 199 -----------------------
 200
 201 Newer builds of x264 now support OpenCL Lookahead, i.e. GPU accelerated
 202 encoding. This can be enabled with the "--opencl" custom parameter. But
 203 OpenCL Lookahead will only work if you have an OpenCL-capable graphics
 204 card *and* if you have an up-to-date video driver installed!
 205
 206 Note that x264 will now *only* try to load the OpenCL.DLL if you really
 207 use the "--opencl" option. Therefore, the "dummy" OpenCL.DLL included
 208 in older versions of the Simple x264 Launcher is *NOT* needed anymore!!
 209
 210
 211 12. Command-line Syntax
 212 -----------------------
 213
 214 The following command-line switches are available:
 215
 216 --add <file> [<file>] ... Create new job(s) from files(s)
 217 --console ............... Show the "debug" console
 218 --no-console ............ Don't show the "debug" console
 219 --no-style .............. Don't use the Qt "Plastique" style
 220 --skip-avisynth-check ... Skip Avisynth check (not recommended!)
 221 --force-cpu-no-64bit .... Forcefully disable 64-Bit support
 222
 223 These are parameters you can pass to Simple x264 Launcher, they can NOT
 224 be passed to x264 itself as "custom" parameters!
 225
 226
 227 13. Help & Support
 228 ------------------
 229
 230 For help and support, please join the discussion at:
 231 http://forum.doom9.org/showthread.php?t=144140
 232
 233 Please do NOT send me e-mail with support requests. Thanks!
 234
 235
 236 e.o.f.