ReadMe.txt

   1 Simple x264/x265 Launcher - graphical front-end for x264 and x265
   2 Copyright (C) 2004-2014 LoRd_MuldeR <MuldeR2@GMX.de>
   3
   4
   5 1. Introduction
   6 ---------------
   7
   8 This application is a lightweight GUI front-end for the x264 H.264/AVC
   9 as well as the x265 H.265/HEVC encoder, based on the Qt toolkit.
  10
  11 Some key features of the Simple x264/x265 Launcher software include:
  12
  13 * Support for creating H.264/AVC (x264) and H.265/HEVC (x265) files
  14 * Fully self-contained, *no* additional Codecs or Plugin's are required
  15 * 64-Bit as well as 32-Bit encoder binaries are fully supported
  16 * Optionally the "high bit-depth" encoder variants can be selected
  17 * Batch encoding (job control) support is implemented
  18 * If desired, multiple encoding jobs can be executed concurrently
  19 * Adding new jobs via command-line interface is supported
  20 * Input from the Avisynth *and* VapurSynth frame servers is supported
  21 * 32-Bit Avisynth/VapourSynth can be mixed with 64-Bit x264/x265
  22 * Straightforward encoder setup thanks to the Preset and Tuning system
  23 * Custom encoder parameters can be added, if desired
  24 * Easily manage your encoder configurations with user-defined templates
  25 * Consistent "look & feel" on all systems thanks to the Qt toolkit
  26
  27
  28 2. System Requirements
  29 ----------------------
  30
  31 * Windows XP with Service Pack 2 or any later Windows system
  32 * 64-Bit Windows is highly recommended (32-Bit Windows works as well)
  33 * The CPU must support at least the MMX and SSE instruction sets
  34 * Avisynth input only available with Avisynth 2.5+ installed
  35 * VapourSynth input only available with VapourSynth R19+ installed
  36 * YV16/YV24 color spaces require Avisynth 2.6 (see section 10)
  37
  38 Simple x264 Launcher is 100% standalone, i.e. it does *not* require
  39 Mircrosoft.NET, Java Runtime Environment or other dependencies.
  40
  41 The required Qt DLLs and encoder binaries are included in the setup.
  42
  43
  44 3. Anti-Virus Warning
  45 ---------------------
  46
  47 Occasionally your Antivirus program may mistakenly detect "malware"
  48 (virus, trojan, worm, etc.) in some of the files here. This is called a
  49 "False Positive" and the files are actually innocent/clean. It´s an
  50 error in your specific Antivirus software.
  51
  52 In case you encounter such problems, go to http://www.virustotal.com/
  53 and check the file again with multiple Antivirus engines! And take care
  54 with results like "suspicious" , "generic" or "packed". Those are *not*
  55 real hits, they are just wild speculation.
  56
  57 Apparently Antivirus programs tend to suspect installers/uninstaller
  58 created with NSIS. Furthermore some Antivirus programs blindly suspect
  59 all UPX´d (packed) executables of being malware. Obviously this is a
  60 stupid generalization, so you can safely ignore those warnings!
  61
  62 Last but not least: Always keep in mind that this is OpenSource
  63 software! If you don´t trust the people providing the pre-compiled
  64 binaries, download the source codes and compile them yourself.
  65
  66 DON´T SUBMIT ANY VIRUS/TROJAN REPORTS, UNLESS YOU HAVE VERIFIED THE
  67 INFECTION WITH MULTIPLE ANTIVIRUS ENGNINES. THANKS!
  68
  69
  70 4. License
  71 ----------
  72
  73 Simple x264/x265 Launcher is Copyright (C) 2004-2014 LoRd_MuldeR.
  74
  75 This program is free software; you can redistribute it and/or modify
  76 it under the terms of the GNU General Public License as published by
  77 the Free Software Foundation; either version 2 of the License, or
  78 (at your option) any later version.
  79
  80 This program is distributed in the hope that it will be useful,
  81 but WITHOUT ANY WARRANTY; without even the implied warranty of
  82 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  83 GNU General Public License for more details.
  84
  85 You should have received a copy of the GNU General Public License along
  86 with this program; if not, write to the Free Software Foundation, Inc.,
  87 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  88
  89 http://www.gnu.org/licenses/gpl-2.0.txt
  90
  91
  92 5. Third-Party Software
  93 -----------------------
  94
  95 The following third-party software is used by this program:
  96
  97 The Qt GUI Toolkit is Copyright (C) 2012 Digia Plc.
  98 http://qt.digia.com/
  99 Qt is a free software, released under the terms of GNU GPL, version 3.
 100
 101 The x264 encoder software is Copyright (C) 2003-2014 x264 project.
 102 http://www.videolan.org/developers/x264.html
 103 x264 is a free software and is released under the terms of the GNU GPL.
 104
 105 The x265 encoder software is Copyright (C) 2013-2014 x265 project.
 106 http://www.videolan.org/developers/x265.html
 107 x265 is a free software and is released under the terms of the GNU GPL.
 108
 109 AviSynth is Copyright (C) 2002-2006 Ben Rudiak-Gould et al.
 110 http://avisynth.nl/index.php/Main_Page
 111 AviSynth is a free software, released under the terms of the GNU GPL.
 112
 113 VapourSynth is Copyright (c) 2012-2014 Fredrik Mellbin.
 114 http://www.vapoursynth.com/
 115 VapourSynth is free software, released under the terms of the GNU LGPL.
 116
 117 All third-party binaries included in this distribution package are
 118 redistributed in full accordance with the GNU General Public License,
 119 version 2. For further information see the respective web sites!
 120
 121
 122 6. Portable Mode
 123 ----------------
 124
 125 This application can be run in "portable" mode. Just rename the EXE
 126 file to 'x264_launcher_portable.exe' in order to trigger portable mode.
 127 In that mode all configuration files will be saved in the same folder
 128 where the EXE file resides. This may be helpful, if you want to run the
 129 application directly from your USB stick on different computers. Note,
 130 however, that in portable mode the install folder must be writable!
 131
 132
 133 7. Updating Your Encoder Binaries
 134 ---------------------------------
 135
 136 This application works best with the encoder binaries that are included
 137 in the distribution package. That's because these binaries have been
 138 tested to work properly with the GUI. Nonetheless in some cases you may
 139 want to replace the included binaries with a newer encoder version or
 140 with an alternative build of the same version. Generally newer versions
 141 of x264/x265 should work properly, though there is NO guarantee! In
 142 rare cases the CLI syntax (or console output) may have changed in a way
 143 that breaks the compatibility and therefore will require an update of
 144 the GUI itself. Furthermore this application does NOT provide any
 145 support for "unofficial" patches. Usually custom builds that contain
 146 "unofficial" patches will work anyway, but again there is NO guarantee.
 147 Using old (outdated) binaries with this application is NOT supported or
 148 intended. Please report bugs rather than reverting to an old version!
 149
 150
 151 8. Timeout Warning
 152 ------------------
 153
 154 This application provides "deadlock" prevention. This means that if an
 155 encoder process (x264 or Avisynth) stops responding, it will be
 156 terminated. This is done in order to ensure that the main program as
 157 well as the other encoder processes can continue properly. More
 158 specifically, a warning will be raised if the process does not respond
 159 for one minute. If the process still didn't respond after five minutes,
 160 it will be terminated and consequently the encoding job is aborted. In
 161 some rare cases, your Avisynth script may take a very long time to
 162 initialize and thus the process will be aborted before the encoding can
 163 start. For example, this can happen if FFMS2/FFVideoSource takes a very
 164 long time to index the source file. In that case, we recommend to index
 165 the source file beforehand, e.g. by using the 'ffmsindex' tool.
 166
 167
 168 9. Custom Parameters
 169 --------------------
 170
 171 This application provides a "Custom Parameters" edit box. All command-
 172 line parameters that you enter there will be passed to x264 or x265
 173 unmodified. You can send arbitrary parameters - even such ones that are
 174 only available in patched builds. See the x264/x265 manuals or the Help
 175 Screen for a list of available parameters. However be aware that the
 176 GUI will not check your parameters at all! Thus using an unknown or
 177 unsupported parameter will cause your encode to fail. Using an existing
 178 parameter in the wrong way will cause your encode to fail too. Last but
 179 not least, some parameters are forbidden by the GUI. If some parameter
 180 is forbidden, that's because the GUI will set that parameter for you
 181 (if required) or because that parameter is NOT compatible with the GUI.
 182
 183 HINT: Occasionally your custom parameters string may become very long,
 184 especially when working with zones. In that case you can right-click on
 185 the "Custom Parameters" edit box and choose "Open the Text-Editor".
 186 This will open a multi-line text editor for easier parameter handling!
 187
 188
 189 10. Color Spaces / Chroma Subsampling
 190 -------------------------------------
 191
 192 Avs2YUV converts the output of your Avisynth script to the YV12 format,
 193 i.e. YUV data with 4:2:0 chroma subsampling and 8-Bit precision.
 194 Usually this is exactly what you want/need. If, however, your Avisynth
 195 script outputs image data with a higher chroma resolution, e.g. YUY2
 196 (4:2:2), then the conversion to YV12 (4:2:0) will discard some of the
 197 information. In that case, and if you want/need to keep the full chroma
 198 resolution of your Avisynth script's output, you will have to pass the
 199 "-csp" switch to Avs2YUV as a custom parameter! Use "-csp I422" for
 200 YUV 4:2:2 (YV16) and use "-csp I444" for YUV 4:4:4 (YV24). Please note
 201 that Avs2YUV can NOT pass through the "packed" YUY2 format. Thus it has
 202 to be converted to the "planar" YV16 format. As both, YUY2 and YV16,
 203 are YUV 4:2:2 formats, converting from YUY2 to YV16 is a lossless
 204 operation. Note, however, that Avisynth 2.5 did NOT support YV16/YV24,
 205 so you need to use Avisynth 2.6; otherwise Avs2YUV will fail to do the
 206 conversion! Also be aware that the x264 encoder itself will convert any
 207 YV16 or YV24 input back to the YV12 format, if you don't pass the
 208 suitable "--output-csp i422/i444" switch to x264 as a custom parameter!
 209 In short, to encode YUY2 from Avisynth, you have to pass "-csp I422" to
 210 Avs2YUV and "--output-csp i422" to x264 to avoid 4:2:0 downsampling.
 211
 212
 213 11. Audio Processing/Encoding
 214 -----------------------------
 215
 216 This application is a front-end to the x264 encoder. And, as x264 does
 217 NOT support audio processing/encoding yet, there is NO explicit support
 218 for audio encoding in this application. Thus, if you want to create a
 219 video file *with* audio, you will have to add the audio stream to the
 220 encoded video file afterwards. This process is called 'multiplexing' or
 221 just 'muxing'. In case you are dealing with Matroska (MKV) files, then
 222 "MKVMerge GUI" from the "MKVToolNix" package is the right tool for this
 223 task. If, instead, you are dealing with MP4 files, then you may use
 224 "MP4Box" or the "YAMB" front-end for muxing the audio stream.
 225
 226 Having said all that, there now is an unofficial "Audio" branch of x264
 227 available. If you are using one of the modified x264 builds with "audio
 228 support" patch (e.g. those provided by JEEB), then you can process the
 229 audio with x264 and skip the additional muxing step. Basically the
 230 audio patch adds a new "--acodec" switch, which you can pass to x264 as
 231 a custom parameter. For example, you can pass "--acodec aac" for
 232 encoding the audio to the AAC format (recommended for MP4 files). Or
 233 you can pass "--acodec vorbis" for encoding the audio to the Ogg/Vorbis
 234 format (recommended for MKV files). Please be aware that audio encoding
 235 will work only, if your input file contains an audio stream! When using
 236 the built-in LAVF/FFMS input of x264, the audio can be encoded straight
 237 from the input file. This does NOT work with Avisynth input! Instead,
 238 if you want to encode audio from an Avisynth script, you must pass the
 239 "--audiofile <path_to_avs_file>" switch to x264 as a custom parameter.
 240 For convenience, the string "--audiofile $(INPUT)" may be used.
 241
 242
 243 12. OpenCL Support
 244 -----------------------
 245
 246 Newer builds of x264 now support OpenCL Lookahead, i.e. GPU accelerated
 247 encoding. This can be enabled with the "--opencl" custom parameter. But
 248 OpenCL Lookahead will only work if you have an OpenCL-capable graphics
 249 card *and* if you have an up-to-date video driver installed!
 250
 251 Note that x264 will now *only* try to load the OpenCL.DLL if you really
 252 use the "--opencl" option. Therefore, the "dummy" OpenCL.DLL included
 253 in older versions of the Simple x264 Launcher is *NOT* needed anymore!!
 254
 255
 256 13. Command-line Syntax
 257 -----------------------
 258
 259 PLEASE NOTE: These are parameters you can pass to Simple x264 Launcher,
 260 they can **not** be passed to x264 or x265 as "custom" parameters !!!
 261
 262 The following command-line switches are available:
 263
 264   --add-file <file> ............... Create a new job via GUI dialog
 265   --add-job <src> <dest> <tpl> .... Create a new job directly from CLI
 266   --[no-]force-start .............. Start the next job immediately
 267   --[no-]force-enqueue ............ Append the next job to the queue
 268   --skip-avisynth-check ........... Skip Avisynth detection
 269   --skip-vapoursynth-check ........ Skip VapourSynth detection
 270   --force-cpu-no-64bit ............ Forcefully disable 64-Bit support
 271   --no-deadlock-detection ......... Don't abort a processes on deadlock
 272   --[no-]console .................. Do [not] show the Debug console
 273   --no-style ...................... Don't use the Qt "Plastique" style
 274
 275 Some details on the "--add-job" command-line switch:
 276
 277   <src> .... Specifies the source media file or AVS/VPY script file
 278   <dest> ... Specifies the output H.264/HEVC/MKV/MP4 file to be written
 279   <tpl> .... Specifies the template to be used ("-" uses defaults)
 280
 281   Use "--[no-]force-start" or "--[no-]force-enqueue" to tweak startup
 282   behavior. If neither is used, the default startup behavior applies.
 283
 284
 285 14. Help & Support
 286 ------------------
 287
 288 For help and support, please join the discussion at:
 289 http://forum.doom9.org/showthread.php?t=144140
 290
 291 Please *avoid* sending me e-mail with support requests. Thank you!
 292
 293 (I get a lot of mail every day and cannot answer everything)
 294
 295
 296 15. Source Codes
 297 ----------------
 298
 299 Simple x264/x265 Launcher is written in C++ and currently developed
 300 with Microsoft Visual Studio 2013. It is based on the Qt toolkit.
 301
 302 The source codes can be obtained from the official Git repository:
 303
 304  https://github.com/lordmulder/Simple-x264-Launcher
 305  https://gitorious.org/simple-x264-launcher/simple-x264-launcher
 306  https://bitbucket.org/lord_mulder/simple-x264-launcher
 307
 308 Download Visual Studio Express 2013 for Windows *Desktop* here:
 309 http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs
 310
 311 Download the latest Qt toolkit (4.8.x) from the Qt Project web-site:
 312 http://download.qt-project.org/official_releases/qt/4.8/
 313
 314
 315 e.o.f.