doc/Manual.md

   1 % LameXP Audio-Encoder Front-End &ndash; Manual
   2
   3 Introduction
   4 ============
   5
   6 LameXP is a graphical user-interface (front-end) for various of audio encoders: It allows you convert your audio files from one audio format to another one in the most simple way. Despite its name, LameXP is NOT only a front-end for the LAME encoder, but supports a wide range of output formats, including MP3, Ogg Vorbis, AAC/MP4, FLAC, AC-3 and Wave Audio. The number of supported input formats is even bigger! Furthermore LameXP does NOT only run on Windows XP, but also on Windows Vista, Windows 7 and many other operating systems.
   7
   8 ![LameXP](http://lamexp.sourceforge.net/lamexp.png)
   9
  10 As all the encoders and decoders used by LameXP are already "built-in" (with one exception), you do NOT need to install any additional software, such as "Codecs", "Filters" or "Plug-ins", on your computer. Everything works "out of the box"! You can even use LameXP as a "portable" application, e.g. run it from your USB stick. Moreover LameXP was designed for batch processing. This means that you can convert a huge number of audio files, e.g. a complete album or even your entire music collection, in a single step. And, as LameXP is able to process several audio files in parallel, it takes full advantage of modern multi-core processors! However LameXP is NOT only optimized for speed, it also provides excellent sound quality by using the most sophisticated encoders available and by giving the user unrestricted control over all encoding parameters. In addition to that, LameXP provides full support for metadata, including cover art. So when converting your audio files, LameXP will retain existing meta tags. But there also is an easy-to-use editor for adding or modifying metadata. LameXP supports Unicode for both, meta tags and filenames, so there won't be any problems with "foreign" characters. And, thanks to our translators, the user-interface of LameXP is available in multiple languages. Last but not least, LameXP supports a number of post-processing filters, including sample rate conversion, normalization (gain), tone adjustment and downmixing of multi-channel sources.
  11
  12
  13 Platform Support
  14 ----------------
  15
  16 **Tier #1:** LameXP is currently being developed on the following platforms:
  17
  18 * Microsoft Windows 8.1, 32-Bit and 64-Bit editions
  19 * Microsoft Windows 7 with Service Pack 1, 32-Bit and 64-Bit editions
  20 * Microsoft Windows XP with Service Pack 3 **(see remarks)**
  21
  22
  23 **Tier #2:** The following platforms should work too, but aren't tested extensively:
  24
  25 * Microsoft Windows 10, 32-Bit and 64-Bit editions
  26 * Microsoft Windows 8.0, 32-Bit and 64-Bit editions
  27 * Microsoft Windows Vista with Service Pack 2, 32-Bit and 64-Bit editions
  28 * Microsoft Windows XP x64 Edition with Service Pack 2
  29 * Microsoft Windows Server 2008 with Service Pack 2
  30 * Microsoft Windows Server 2008 R2 with Service Pack 1
  31 * GNU/Linux (e.g. Ubuntu 12.04), using Wine v1.4+
  32
  33 **Legacy:** The following platforms are NOT actively supported any longer:
  34
  35 * Microsoft Windows 2000
  36 * Microsoft Windows NT 4.0
  37 * Microsoft Windows Millennium Edition
  38 * Microsoft Windows 98
  39 * Microsoft Windows 95
  40
  41 &nbsp;
  42 *Remarks:* Windows XP has reached "end of life" on April 8th, 2014. This means that Microsoft has stopped all support for Windows XP, i.e. *no* updates or bugfixes are made available to regular Windows XP uses since that date, *not* even security fixes! Thus, all the security vulnerabilities that have been discovered *after* this deadline - and all the security vulnerabilities that will be discovered in the future - are going remain *unfixed* forever! Consequently, using Windows XP has become a severe security risk, and the situation is only going to get worse. While LameXP will continue to support Windows XP (note that Service Pack 3 is required!) for the foreseeable future, we *highly* recommend everybody to update to a less antiquated system now. Windows XP support will be discontinued in a future version, when most users have migrated to a contemporary system.
  43
  44
  45 Output Formats (Encoders)
  46 -------------------------
  47
  48 Currently the following output formats (audio encoders) are supported by LameXP:
  49
  50 * [Ogg Vorbis](http://www.vorbis.com/) by [Xiph.org](http://www.xiph.org/), using the OggEnc2/libvorbis encoder with [aoTuV](http://www.xiph.org/) [built-in]
  51 * [Opus Interactive Audio Codec](http://www.opus-codec.org/) by Xiph.org and Mozilla, using the [Opus-Tools](http://git.xiph.org/?p=opus-tools.git;a=summary) [built-in]
  52 * [MPEG Audio-Layer III (MP3)](http://en.wikipedia.org/wiki/MP3), using the [LAME](http://lame.sourceforge.net/) encoder [built-in]
  53 * [Advanced Audio Coding (AAC)](http://en.wikipedia.org/wiki/Advanced_Audio_Coding), using [Nero AAC](http://www.nero.com/deu/company/about-nero/nero-aac-codec.php) or [QAAC](https://sites.google.com/site/qaacpage/) encoder [*separate download*]
  54 * [Free Lossless Audio Codec (FLAC)](https://xiph.org/flac/) [built-in]
  55 * [ATSC A/52 (aka "AC-3")](http://www.atsc.org/cms/index.php/standards/standards/48-atsc-a52-standard), using the [Aften](http://aften.sourceforge.net/) encoder [built-in]
  56 * [Monkey's Audio (APE)](http://www.monkeysaudio.com/), lossless audio compression [built-in]
  57 * DCA, using the [DCA Enc](https://gitorious.org/dtsenc/dtsenc) encoder software (still experimental) [built-in]
  58 * Uncompressed PCM / Waveform Audio File (WAV/RIFF)
  59
  60
  61 Input Formats (Decoders)
  62 ------------------------
  63
  64 Currently the following input formats (audio decoders) are supported by LameXP:
  65
  66 * AC-3 (ATSC A/52), using Valib decoder [built-in]
  67 * Advanced Audio Coding (AAC), using FAAD decoder [built-in]
  68 * Apple Lossless (ALAC) [built-in]
  69 * Apple/SGI AIFF [built-in]
  70 * Avisynth, audio only [requires Avisynth 2.5.x to be installed]
  71 * Digital Theater System, using Valib decoder [built-in]
  72 * Free Lossless Audio Codec (FLAC) [built-in]
  73 * Microsoft ADPCM [built-in]
  74 * Monkey's Audio (APE) [built-in]
  75 * MPEG Audio-Layer I (MP1), using mpg123 decoder [built-in]
  76 * MPEG Audio-Layer II (MP2), using mpg123 decoder [built-in]
  77 * MPEG Audio-Layer III (MP3), using mpg123 decoder [built-in]
  78 * Musepack [built-in]
  79 * Opus Audio Codec [built-in]
  80 * Shorten [built-in]
  81 * Speex [built-in]
  82 * Sun/NeXT Au [built-in]
  83 * The True Audio (TTA) [built-in]
  84 * Uncompressed PCM / Waveform Audio File (WAV/RIFF) [built-in]
  85 * WavPack Hybrid Lossless Audio [built-in]
  86 * Windows Media Audio (WMA), using wma2wav [built-in]
  87
  88
  89
  90 Leagl Information
  91 =================
  92
  93 The LameXP software was developed, from the scratch, by LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Consequently, all copyrights on the LameXP software exclusively belong to LoRd_MuldeR. The right to use, modify and redistribute the LameXP software *according to the license terms* is granted to everybody. Please see below for license details! If you want to use the LameXP software in a way that is *not* covered by the license terms, e.g. if you want to include the LameXP software (or parts of it) in a *proprietary* software, written permission by LoRd_MuldeR is required.
  94
  95 More OpenSource projects by LoRd_MuldeR can be found at <http://muldersoft.com/> and <https://github.com/lordmulder>. Please do **not** send e-mail to LoRd_MuldeR directly, if the problem or suggestion can be discussed on the support forums or on the issue tracker!
  96
  97
  98 Third-party Software
  99 --------------------
 100
 101 It has to be noticed that LameXP uses a number of *third-party* applications and libraries. The copyright on these third-party tools belongs to the individual authors. *All* third-party tools that are included in the official distribution packages of LameXP are distributed in accordance with the respective software license. For legal reasons, some of the third-party tools can *not* be redistributed along with LameXP and therefore need to be obtained separately. For more details on the third-party tools that are used by the LameXP software, please refer to the "Third-party software" tab in the "About" dialogue. Moreover, various people have contributed translations to the LameXP project. These translation are redistributed with permission of the respective contributor. For more information about our contributors, please refer to the "Contributors" tab in the "About" dialogue.
 102
 103
 104 License Terms
 105 -------------
 106
 107 LameXP is [*free software*](http://en.wikipedia.org/wiki/Free_software_movement), released under the terms of the [*GNU General Public License* (GPL), version 2](http://www.gnu.org/licenses/gpl-2.0.html). The licenses for most software and other practical works are designed to take away your freedom to share and change the works. In contrast, the GPL is designed to guarantee your freedom to share and change all versions of the software. In other words, the GPL ensures that free software will remain free for all of its users. LameXP adds some additional terms in order to keep your computer safe from unwanted software. See the *GNU General Public License* for more details!
 108
 109         LameXP - Audio Encoder Front-End
 110         Copyright (C) 2004-2014 LoRd_MuldeR <MuldeR2@GMX.de>
 111
 112         This program is free software; you can redistribute it and/or
 113         modify it under the terms of the GNU General Public License
 114         as published by the Free Software Foundation; either version 2
 115         of the License, or (at your option) any later version.
 116
 117         This program is distributed in the hope that it will be useful,
 118         but WITHOUT ANY WARRANTY; without even the implied warranty of
 119         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 120         GNU General Public License for more details.
 121
 122         You should have received a copy of the GNU General Public License
 123         along with this program; if not, write to the Free Software
 124         Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 125
 126 &nbsp;
 127 **Addendum:** When distributing binaries of the LameXP software, it is *strictly forbidden* to bundle the LameXP program files and/or the LameXP installation program with any kind of *Adware*, *Spyware* or *PUP (potentially unwanted program)*, including, but not limited to, any downloaders, dialers, browser toolbars/extensions or restricted shareware/demo programs. It is, however, perfectly legitimate to bundle LameXP with other *OpenSource* programs, according to the OSI (Open Source Initiative). Finally, it is also legitimate to bundle LameXP with *commercial software*, as long as that software does *not* meet the criteria of *Adware*, *Spyware* or *PUP*. If you bundle the LameXP software with another software, you are *required* to make sure that the user is provided with an easy way to install and start the LameXP software separately from that other software.
 128
 129
 130
 131 Install Instructions
 132 ====================
 133
 134
 135 Install the LameXP Software
 136 ---------------------------
 137
 138 The LameXP software is provided in two different forms: a self-running **setup program** and a **ZIP package**. For regular users, using the *setup program* is highly recommended!
 139
 140
 141 ### Setup Program ###
 142
 143 In order to start the installation process, simply double-click on the LameXP setup program, e.g. ``LameXP.yyyy-mm-dd.Release-Static.Build-xxxx.exe``.
 144
 145 *Note:* Shortly after launching the setup program, an [UAC](http://en.wikipedia.org/wiki/User_Account_Control) (User Access Control) dialogue may appear. This is a standard Windows security feature, so don't worry! You have to choose "Yes", if you wish to continue the installation process.
 146
 147 ![Figure](img/lamexp/setup_1a.png)
 148
 149 &nbsp;
 150 Now simply follow the instructions of the setup wizard, which will guide you through the installation process&hellip;
 151
 152 *Note:* Please do **not** change the "Destionation Folder", unless you know exactly what you are doing. The "Destionation Folder" cannot be changed, when *upgrading* an existing LameXP installation.
 153
 154 ![Figure](img/lamexp/setup_1b.png)
 155
 156 &nbsp;
 157 Congratulation, LameXP has been installed successfully on your computer!
 158
 159 *Note:* If you keep the "Run LameXP &hellip;" option enabled and click on the "Finish" button, the LameXP software will be launched immediately.
 160
 161 ![Figure](img/lamexp/setup_1c.png)
 162
 163
 164 ### ZIP Package ###
 165
 166 **TODO**
 167
 168
 169 Install the AAC Encoder
 170 -----------------------
 171
 172 For legal reasons, the AAC (Advanced Audio Coding) encoder can **not** be included in the official LameXP distribution packages. Therefore, you need to download and install the AAC encoder *manually*.
 173
 174 LameXP can use the *Nero Digital* AAC encoder as well as the *Apple* (iTunes/QucikTime) AAC encoder. This chapter describes how to set up these AAC encoder for use with LameXP.
 175
 176 ### Nero Digital AAC Encoder ###
 177
 178 First of all, you need to download the Nero AAC encoder from the official Nero Digital web-site. The download is free of charge:
 179
 180 * <http://www.nero.com/eng/company/about-nero/nero-aac-codec.php>
 181
 182 &nbsp;
 183 Simply scroll down, click the "I agree" button, and enter ``user@example.com`` when asked for an e-mail address. Finally, click the "Download" button, which initates the download of the required ``NeroAACCodec-1.5.1.zip`` file.
 184
 185 *Note:*  Although the ZIP file is called ``NeroAACCodec-1.5.1.zip``, it actually contains version **1.5.4.0** of the Nero AAC encoder software. Please check the included ``changelog.txt`` to verify this!
 186
 187 ![Figure](img/lamexp/setup_3a.png)
 188
 189 &nbsp;
 190 Now open the downloaded ZIP file with your favourite file archive software (we recommend using [7-Zip](http://www.7-zip.org/) or [WinRar](http://www.rarlab.com/download.htm)) and navigate to the "win32" sub-directory.
 191
 192 ![Figure](img/lamexp/setup_3b.png)
 193
 194 &nbsp;
 195 Finally, *extract* all the three files ``neroAacDec.exe``, ``neroAacEnc.exe`` and ``neroAacTag.exe`` into the LameXP installation directory. That is the directory where your LameXP executable file, i.e. ``LameXP.exe``, is located.
 196
 197 *Note:* By default, the LameXP installation directory is either ``C:\Program Files (x86)\MuldeR\LameXP`` or ``C:\Program Files\MuldeR\LameXP``. However, this can be changed by the user during the setup process.
 198
 199 ![Figure](img/lamexp/setup_3c.png)
 200
 201 &nbsp;
 202 Once the required Nero AAC files have been put into the proper place, simply *restart* LameXP in order to enable the AAC encoding support!
 203
 204
 205 ### QAAC/Apple AAC Encoder ###
 206
 207 **TODO**
 208
 209
 210
 211 Tutorial (Step-by-Step Guide)
 212 =============================
 213
 214 This tutorial will teach you, step by step, how to convert your audio files using the LameXP software. The tutorial assumes that LameXP is already installed on your computer.
 215
 216
 217 Source Files
 218 ------------
 219
 220 First of all, you need to add all **source files** that you want to convert. So switch to the "Source Files" tab, just in case that tab is not active already, and then click the "Add File(s)" button.
 221
 222 ![Figure](img/lamexp/tutorial_1a.png)
 223
 224 &nbsp;
 225 This will bring up a standard file selection dialogue. Now simply select the files that you want to add and click the "Open" button. You can repeat this step multiple, e.g. to add files from different directories.
 226
 227 ![Figure](img/lamexp/tutorial_1b.png)
 228
 229 &nbsp;
 230 All files you have added, so far, will show up in the list. You can click the "Remove" button to remove a single file from the list or "Clear" to remove them all. Click the "Show details" button to show details about a file.
 231
 232 ![Figure](img/lamexp/tutorial_1c.png)
 233
 234 &nbsp;
 235 *Did you know?* Files can also be added via [Drag &amp; Drop](http://en.wikipedia.org/wiki/Drag_and_drop). Just grab the files that you want to add in your Explorer window and drop them onto the LameXP main window (or onto the LameXP "dropbox" widget).
 236
 237
 238 Output Directory
 239 ----------------
 240
 241 Next, you need to choose the **output directory**, i.e. the directory where the converted files will be saved. Switch to the "Output Directory" tab and choose the desired output directory from the directory tree view.
 242
 243 *Note:* There are several quick navigation buttons below, which will allow you to jump quickly to your personal "Home" folder, "Desktop" folder and "Music" folder, respectively.
 244
 245 ![Figure](img/lamexp/tutorial_2a.png)
 246
 247 &nbsp;
 248 Sometimes you may wish to store the converted files in a *new* (sub-)folder. In this case, simply click the "Make New Folder" button, enter the desired folder name and hit the "OK" button.
 249
 250 ![Figure](img/lamexp/tutorial_2b.png)
 251
 252 &nbsp;
 253 The new folder is going to be created inside the current directory and will be selected automatically. You can repeat this step multiple times in order to created nested sub-folders.
 254
 255 ![Figure](img/lamexp/tutorial_2c.png)
 256
 257 &nbsp;
 258 *Did you know?* If you enable the "Save output files in the same directory where the input file is located" option, each output file will be saved to the same location where the corresponding source file resides.
 259
 260
 261 Compression Settings
 262 --------------------
 263
 264 Finally, you need to choose your **compression settings**. First, and most important, you must decide for an output *audio format (encoder)*. Depending on your needs and preferences, you can choose between [MP3](http://en.wikipedia.org/wiki/MP3), [Ogg/Vorbis](http://en.wikipedia.org/wiki/Vorbis), [Opus](http://en.wikipedia.org/wiki/Opus_%28audio_format%29), [AAC/MP4](http://en.wikipedia.org/wiki/Advanced_Audio_Coding), [FLAC](https://xiph.org/flac/) and others.
 265
 266 *Note:* If you are uncertain which audio format to choose, then [this article](http://lifehacker.com/5927052/whats-the-difference-between-all-these-audio-formats-and-which-one-should-i-use) by Lifehacker is a good starting point. Also see the [comparison of audio coding formats](http://en.wikipedia.org/wiki/Comparison_of_audio_coding_formats) on Wikipedia. If still uncertain, just go with good old MP3 &#x1f609;
 267
 268 ![Figure](img/lamexp/tutorial_3a.png)
 269
 270 &nbsp;
 271 Once you have decided for an audio format, you need to choose a *rate-control* mode next. The available rate-control modes include VBR (quality-base variable bitrate), ABR (average bitrate) and CBR (constant bitrate). Not all modes are available for all audio formats.
 272
 273 *Note:* If you are uncertain which rate-control mode to chose, the guideline is that VBR mode should be preferred over ABR mode whenever possible. And CBR mode generally should be avoided. See also Wikipedia's article on [variable bitrate](http://en.wikipedia.org/wiki/Variable_bitrate) encoding.
 274
 275 ![Figure](img/lamexp/tutorial_3b.png)
 276
 277 &nbsp;
 278 Last but not least, you need to choose the desired target *bitrate* or *quality-level*. Put simply, this controls the  "quality vs. file size" trade-off. You choose a target quality-level in case of VBR mode, and you choose a target (average) bitrate in case of ABR or CBR mode.
 279
 280 *Note:* If you are uncertain which bitrate or quality-level to choose, bare in mind that a higher bitrate (or a better quality level) results in better audio quality, but also produces larger files &ndash; and vice versa. "Level 2" or "192 kbps" is a typical choice for MP3.
 281
 282 ![Figure](img/lamexp/tutorial_3c.png)
 283
 284 &nbsp;
 285 *Did you know?* You can click on the "Reset" link at any time in order to reset all available settings for all available encoders to their factory defaults.
 286
 287
 288 Processing
 289 ----------
 290
 291 When everything has been set up properly, the time has come to actually start the encoding process. So simply click the "Encode Now" button in order to get going!
 292
 293 ![Figure](img/lamexp/tutorial_4a.png)
 294
 295 &nbsp;
 296 This will bring up the "Processing" dialogue. LameXP will now convert all your audio files on the list. Depending on the number of audio files and depending on the performance of your system, this may take several minutes, so please be patient &#x1f609;
 297
 298 *Note:* In order to leverage the power "multi-core" processors and thus massively speed-up the encoding process, LameXP will run multiple encoding jobs in parallel &ndash; provided that your system has multiple processor cores and that there are enough encoding jobs left in the queue.
 299
 300 ![Figure](img/lamexp/tutorial_4b.png)
 301
 302 &nbsp;
 303 The "Processing" dialogue is going to turn *green*, as soon as all encoding jobs have finished successfully. If anything went wrong, e.g. if one of the encoding jobs failed for some reason, it will turn *red* instead.
 304
 305 ![Figure](img/lamexp/tutorial_4c.png)
 306
 307 &nbsp;
 308 *Did you know?* You can double-click on a completed (or failed) job in the list, in order to bring up a dialogue with all details about the specific job. This is especially useful, if something went wrong.
 309
 310
 311
 312 Help &amp; Support
 313 ==================
 314
 315 Before you report any problems that you may have encountered with the LameXP software, please make sure that the problem can be *reproduced* with the **latest** release version of LameXP!
 316
 317
 318 Download Mirrors
 319 ----------------
 320
 321 The latest *official* release of the LameXP software can be obtained from one of the following *official* download mirrors:
 322
 323 * <https://github.com/lordmulder/LameXP/releases/latest>
 324 * <http://sourceforge.net/projects/lamexp/files/>
 325 * <https://lamexp.codeplex.com/releases/>
 326 * <https://bitbucket.org/lord_mulder/lamexp/downloads>
 327 * <https://www.assembla.com/spaces/lamexp/documents>
 328 * <http://www.free-codecs.com/lamexp_download.htm>
 329 * <http://www.videohelp.com/tools/LameXP>
 330
 331 &nbsp;
 332 It is *highly recommended* to download LameXP *only* from one of the official mirrors listed above. We assume *no responsibility* for the integrity and trustworthiness of LameXP downloads you may have received from other locations!
 333
 334 Bugtracker
 335 ----------
 336
 337 The recommended way to submit *bug reports* or *feature requests* to the LameXP developers is using the *issue tracking system* at our GitHub project site:
 338
 339 * <https://github.com/lordmulder/LameXP/issues>
 340
 341 &nbsp;
 342 *Note:* In order to use the issue tracking system, you need to log in with your GitHub account. Creating a GitHub account is easy and completely free of charge, simply click [here](https://github.com/join)!
 343
 344
 345 Support Forum
 346 -------------
 347
 348 If you want to discuss the development of the LameXP software, help other users or receive help from other users, please use the LameXP thread at *Doom9's* Forum:
 349
 350 * <http://forum.doom9.org/showthread.php?t=157726> &ndash; English
 351 * <http://forum.gleitz.info/showthread.php?t=37956> &ndash; German
 352
 353 &nbsp;
 354 *Note:* Due to the massive amount of spam attacks, Doom9 has established strict anti-spam measures. Therefore, it takes a few days until your account will be approved.
 355
 356
 357
 358 Developer Center
 359 ================
 360
 361 While LameXP originally was written in Delphi/Pascal, the current version 4 series of the software has been re-written in the [**C++**](http://en.wikipedia.org/wiki/C%2B%2B) programming language. LameXP v4 uses the [*Qt cross-platform application framework*](http://www.qt.io/) and provides full [*Unicode*](http://en.wikipedia.org/wiki/Unicode) support. Furthermore, LameXP is tightly coupled with the [*MUtilities*](https://github.com/lordmulder/MUtilities) library, a vast collection of "utility" routines and classes to extend the Qt framework. Build files are currently provided for *Microsoft Visual Studio* only. Linux support is currently provided via [*Wine*](https://www.winehq.org/); a native Linux port of LameXP is planned for a future version.
 362
 363
 364 Source Code Access
 365 ------------------
 366
 367 The source code of the **LameXP** software is managed using the [*Git*](http://git-scm.com/) version control system. The Git repository can be *cloned* from one of the official Git mirrors:
 368
 369 * ``git clone git://git.code.sf.net/p/lamexp/code LameXP`` ([Browse](http://sourceforge.net/p/lamexp/code/))
 370
 371 * ``git clone https://github.com/lordmulder/LameXP.git LameXP`` ([Browse](https://github.com/lordmulder/LameXP))
 372
 373 * ``git clone https://git01.codeplex.com/lamexp LameXP`` ([Browse](https://lamexp.codeplex.com/SourceControl/latest))
 374
 375 * ``git clone https://bitbucket.org/lord_mulder/lamexp.git LameXP`` ([Browse](https://bitbucket.org/lord_mulder/lamexp/src))
 376
 377 * ``git clone git://git.assembla.com/lamexp.git LameXP`` ([Browse](https://www.assembla.com/code/lamexp/git/nodes))
 378
 379 * ``git clone git://gitorious.org/lamexp/lamexp.git LameXP`` ([Browse](http://gitorious.org/lamexp/lamexp/trees/master))
 380
 381 * ``git clone git://repo.or.cz/LameXP.git LameXP`` ([Browse](http://repo.or.cz/w/LameXP.git))
 382
 383 &nbsp;
 384 The source code of the **MUtilities** library is managed using the [*Git*](http://git-scm.com/) version control system. The Git repository can be *cloned* from one of the official Git mirrors:
 385
 386 * ``git clone git://git.code.sf.net/p/mutilities/code MUtilities`` ([Browse](http://sourceforge.net/p/mutilities/code/))
 387
 388 * ``git clone https://github.com/lordmulder/MUtilities.git MUtilities`` ([Browse](https://github.com/lordmulder/MUtilities))
 389
 390 * ``git clone https://git01.codeplex.com/mutilities MUtilities`` ([Browse](https://mutilities.codeplex.com/SourceControl/latest))
 391
 392 * ``git clone https://bitbucket.org/lord_mulder/mutilities.git MUtilities`` ([Browse](https://bitbucket.org/lord_mulder/mutilities/src))
 393
 394 * ``git clone git://git.assembla.com/mutilities.git MUtilities`` ([Browse](https://www.assembla.com/code/mutilities/git/nodes))
 395
 396 * ``git clone git://gitorious.org/mutilities/mutilities.git MUtilities`` ([Browse](http://gitorious.org/mutilities/mutilities/trees/master))
 397
 398 * ``git clone git://repo.or.cz/MUtilities.git MUtilities`` ([Browse](http://repo.or.cz/w/MUtilities.git))
 399
 400 &nbsp;
 401 *Remarks:* In case you are new to Git or want to extend your knowledge, have a look at the [*Pro Git*](http://git-scm.com/book/en/v2) book by Scott Chacon! For Windows users, we highly recommend using [*MSYS Git*](http://msysgit.github.com/) in conjunction with the superb [*Tortoise Git*](http://tortoisegit.googlecode.com/) front-end.
 402
 403
 404 Build Prerequisites
 405 -------------------
 406
 407 LameXP is currently being developed and built using the following development tools and libraries:
 408
 409 * [Visual Studio 2013 Update-4](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx), running on Windows 7 with Service Pack 1
 410
 411 * [Qt libraries 4.8.6](http://download.qt.io/archive/qt/4.8/) for Windows (pre-compiled Qt libraries for Visual Studio 2013 can be found [**here**](http://sourceforge.net/projects/lamexp/files/Miscellaneous/Qt%20Libraries/))
 412
 413 * Windows Platform SDK v7.1A, included with Visual Studio 2013 or Visual Studio 2012
 414
 415 * The minimum supported *build* platform is Windows 7 (x86 and x64)
 416
 417 &nbsp;
 418 In order to create LameXP release packages, using the included deployment scripts, you need the following additional tools:
 419
 420 * [7-Zip](http://www.7-zip.org/) &ndash; file archiver with a high compression ratio
 421
 422 * [NSIS](http://nsis.sourceforge.net/) &ndash; Nullsoft Scriptable Install System ([*Unicode version*](http://www.scratchpaper.com/) recommended!)
 423     + [StdUtils](http://nsis.sourceforge.net/StdUtils_plug-in) plug-in
 424     + [LockedList](http://nsis.sourceforge.net/LockedList_plug-in) plug-in
 425     + [Inetc](http://nsis.sourceforge.net/Inetc_plug-in) plug-in
 426     + [Aero](http://forums.winamp.com/showthread.php?t=329990) plug-in
 427
 428 * [UPX](http://upx.sourceforge.net/) &ndash; the Ultimate Packer for eXecutables
 429
 430 * [Pandoc](http://johnmacfarlane.net/pandoc/) &ndash; the Universal Document Converter
 431
 432 * [GnuPG](ftp://ftp.gnupg.org/gcrypt/binary/) &ndash; the GNU Privacy Guard v1.4.x
 433
 434
 435 Qt as Static Libraries
 436 ----------------------
 437
 438 In order to create a "fully static" build of LameXP, i.e. a build that does *not* depend on any "external" DLL files (except for the obligatory operating system DLL's that you cannot get around), you'll need to compile Qt as "static" libraries. The official Qt web-site *does* provide pre-compiled Qt libraries. However, they only provide DLL versions, they do *not* provide "static" libraries. Consequently, you need to build the required "static" Qt libraries yourself. The following simple instructions should make it easy to build Qt from the sources and as "static" libraries:
 439
 440  1. Make sure *Visual Studio 2013* with Update-4 (or later) is installed
 441
 442  2. Make sure *Strawberry Perl *for Windows and *Python 2.7* are installed
 443
 444  3. Download and extract the *Qt 4.8.x* source code package (e.g. to ``C:\QtSources\4.8.x``)
 445
 446  4. Edit the file ``mkspecs\win32-msvc2010\qmake.conf`` from your Qt Sources directory as follows:
 447
 448     + ``Old: QMAKE_CFLAGS_RELEASE = -O2 -MD``
 449     + ``New: QMAKE_CFLAGS_RELEASE = -O2 -MT <more optimization flags here>``
 450     + ``Old: QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MD -Zi``
 451     + ``New: QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MT -Zi <more optimization flags here>``
 452
 453  5. Open a new command window (``cmd.exe``) &ndash; use this very same console for all upcoming steps!
 454
 455  6. Add *Strawberry Perl* to your PATH (e.g. ``set PATH=C:\strawberry\perl\bin;%PATH%``)
 456
 457  7. Add *Python 2.7* to your PATH (e.g. ``set PATH=C:\python27;%PATH%``)
 458
 459  8. Run ``vcvarsall.bat x86`` form your Visual C++ install directory - within the same console!
 460
 461  9. Change the current directory to the *Qt Sources* path (e.g. ``C:\QtSources\4.8.x``)
 462
 463 10. Run ``configure.exe -release -static -ltcg -qt-zlib -qt-libpng -qt-libjpeg -qt-libtiff -qt-libmng``
 464
 465     + Hint: For Visual Studio 2013 you currently need to add ``-platform win32-msvc2012`` too
 466
 467 11. Now the makefiles should have been generated, so simply enter ``nmake /B`` and be patient - voilà!
 468
 469 12. The build process is going to take good amount of time. Once it is done, make sure you got all needed libs:
 470
 471     + ``lib\qtmain.lib``
 472     + ``lib\QtCore.lib``
 473     + ``lib\QtGui.lib``
 474     + ``lib\QtSvg.lib``
 475     + ``lib\QtXml.lib``
 476     + ``plugins\imageformats\qico.lib``
 477     + ``plugins\imageformats\qsvg.lib``
 478     + ``plugins\imageformats\qtga.lib``
 479
 480 13. Put all the static *.lib files into the ``Prerequisites\qt4_static\lib`` directory
 481
 482 14. ImageFormat plugins go to ``Prerequisites\qt4_static\plugins\imageformats``
 483
 484 15. Congratulations, you should now be prepared to build the ``Release_Static`` configuration of LameXP &#x1f60a;
 485
 486 &nbsp;
 487 *Note:* Static libraries only work with the exactly same compiler (version) they were built with!
 488
 489
 490
 491 F.A.Q. (Frequently Asked Questions)
 492 ===================================
 493
 494 **TODO**
 495
 496 &nbsp;
 497 &nbsp;
 498 **EOF**