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 below!)
  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+, native Linux version planned
  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 *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.
  42
  43
  44 Output Formats (Encoders)
  45 -------------------------
  46
  47 Currently the following output formats (audio encoders) are supported by LameXP:
  48
  49 * [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]
  50 * [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]
  51 * [MPEG Audio-Layer III (MP3)](http://en.wikipedia.org/wiki/MP3), using the [LAME](http://lame.sourceforge.net/) encoder [built-in]
  52 * [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*]
  53 * [Free Lossless Audio Codec (FLAC)](https://xiph.org/flac/) [built-in]
  54 * [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]
  55 * [Monkey's Audio (APE)](http://www.monkeysaudio.com/), lossless audio compression [built-in]
  56 * DCA, using the [DCA Enc](https://gitorious.org/dtsenc/dtsenc) encoder software (still experimental) [built-in]
  57 * Uncompressed PCM / Waveform Audio File (WAV/RIFF)
  58
  59
  60 Input Formats (Decoders)
  61 ------------------------
  62
  63 Currently the following input formats (audio decoders) are supported by LameXP:
  64
  65 * AC-3 (ATSC A/52), using Valib decoder [built-in]
  66 * Advanced Audio Coding (AAC), using FAAD decoder [built-in]
  67 * Apple Lossless (ALAC) [built-in]
  68 * Apple/SGI AIFF [built-in]
  69 * Avisynth, audio only [requires Avisynth 2.5.x to be installed]
  70 * Digital Theater System, using Valib decoder [built-in]
  71 * Free Lossless Audio Codec (FLAC) [built-in]
  72 * Microsoft ADPCM [built-in]
  73 * Monkey's Audio (APE) [built-in]
  74 * MPEG Audio-Layer I (MP1), using mpg123 decoder [built-in]
  75 * MPEG Audio-Layer II (MP2), using mpg123 decoder [built-in]
  76 * MPEG Audio-Layer III (MP3), using mpg123 decoder [built-in]
  77 * Musepack [built-in]
  78 * Opus Audio Codec [built-in]
  79 * Shorten [built-in]
  80 * Speex [built-in]
  81 * Sun/NeXT Au [built-in]
  82 * The True Audio (TTA) [built-in]
  83 * Uncompressed PCM / Waveform Audio File (WAV/RIFF) [built-in]
  84 * WavPack Hybrid Lossless Audio [built-in]
  85 * Windows Media Audio (WMA), using wma2wav [built-in]
  86
  87
  88 Leagl Information
  89 =================
  90
  91 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.
  92
  93 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!
  94
  95
  96 Third-party Software
  97 --------------------
  98
  99 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.
 100
 101
 102 License Terms
 103 -------------
 104
 105 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!
 106
 107         LameXP - Audio Encoder Front-End
 108         Copyright (C) 2004-2014 LoRd_MuldeR <MuldeR2@GMX.de>
 109
 110         This program is free software; you can redistribute it and/or
 111         modify it under the terms of the GNU General Public License
 112         as published by the Free Software Foundation; either version 2
 113         of the License, or (at your option) any later version.
 114
 115         This program is distributed in the hope that it will be useful,
 116         but WITHOUT ANY WARRANTY; without even the implied warranty of
 117         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 118         GNU General Public License for more details.
 119
 120         You should have received a copy of the GNU General Public License
 121         along with this program; if not, write to the Free Software
 122         Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 123
 124 &nbsp;
 125 **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.
 126
 127
 128 Tutorial (Step-by-Step Guide)
 129 =============================
 130
 131 **TODO**
 132
 133
 134 Help &amp; Support
 135 ==================
 136
 137 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!
 138
 139
 140 Download Mirrors
 141 ----------------
 142
 143 The latest *official* release of the LameXP software can be obtained from one of the following *official* download mirrors:
 144
 145 * <https://github.com/lordmulder/LameXP/releases/latest>
 146 * <http://sourceforge.net/projects/lamexp/files/>
 147 * <https://lamexp.codeplex.com/releases/>
 148 * <https://bitbucket.org/lord_mulder/lamexp/downloads>
 149 * <https://www.assembla.com/spaces/lamexp/documents>
 150 * <http://www.free-codecs.com/lamexp_download.htm>
 151 * <http://www.videohelp.com/tools/LameXP>
 152
 153 &nbsp;
 154 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!
 155
 156 Bugtracker
 157 ----------
 158
 159 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:
 160
 161 * <https://github.com/lordmulder/LameXP/issues>
 162
 163 &nbsp;
 164 *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)!
 165
 166
 167 Support Forum
 168 -------------
 169
 170 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:
 171
 172 * <http://forum.doom9.org/showthread.php?t=157726> &ndash; English
 173 * <http://forum.gleitz.info/showthread.php?t=37956> &ndash; German
 174
 175 &nbsp;
 176 *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.
 177
 178
 179 Developer Center
 180 ================
 181
 182 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.
 183
 184
 185 Source Code Access
 186 ------------------
 187
 188 The source code of the **LameXP** software is managed using [*Git*](http://git-scm.com/) version control system. The repository can be *cloned* from one of the official Git mirrors:
 189
 190 * ``git clone git://git.code.sf.net/p/lamexp/code lamexp-src`` ([Browse](http://sourceforge.net/p/lamexp/code/))
 191
 192 * ``git clone https://github.com/lordmulder/LameXP.git lamexp-src`` ([Browse](https://github.com/lordmulder/LameXP))
 193
 194 * ``git clone https://git01.codeplex.com/lamexp lamexp-src`` ([Browse](https://lamexp.codeplex.com/SourceControl/latest))
 195
 196 * ``git clone https://bitbucket.org/lord_mulder/lamexp.git lamexp-src`` ([Browse](https://bitbucket.org/lord_mulder/lamexp/src))
 197
 198 * ``git clone git://git.assembla.com/lamexp.git lamexp-src`` ([Browse](https://www.assembla.com/code/lamexp/git/nodes))
 199
 200 * ``git clone git://gitorious.org/lamexp/lamexp.git lamexp-src`` ([Browse](http://gitorious.org/lamexp/lamexp/trees/master))
 201
 202 * ``git clone git://repo.or.cz/LameXP.git lamexp-src`` ([Browse](http://repo.or.cz/w/LameXP.git))
 203
 204 &nbsp;
 205 The source code of the **MUtilities** library is managed using [*Git*](http://git-scm.com/) version control system. The repository can be *cloned* from one of the official Git mirrors:
 206
 207 * ``git clone git://git.code.sf.net/p/mutilities/code mutilities-src`` ([Browse](http://sourceforge.net/p/mutilities/code/))
 208
 209 * ``git clone https://github.com/lordmulder/MUtilities.git mutilities-src`` ([Browse](https://github.com/lordmulder/MUtilities))
 210
 211 * ``git clone https://git01.codeplex.com/mutilities mutilities-src`` ([Browse](https://mutilities.codeplex.com/SourceControl/latest))
 212
 213 * ``git clone https://bitbucket.org/lord_mulder/mutilities.git mutilities-src`` ([Browse](https://bitbucket.org/lord_mulder/mutilities/src))
 214
 215 * ``git clone git://git.assembla.com/mutilities.git mutilities-src`` ([Browse](https://www.assembla.com/code/mutilities/git/nodes))
 216
 217 * ``git clone git://gitorious.org/mutilities/mutilities.git mutilities-src`` ([Browse](http://gitorious.org/mutilities/mutilities/trees/master))
 218
 219 * ``git clone git://repo.or.cz/MUtilities.git mutilities-src`` ([Browse](http://repo.or.cz/w/MUtilities.git))
 220
 221 &nbsp;
 222 *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.
 223
 224
 225 Build Prerequisites
 226 -------------------
 227
 228 LameXP is currently being developed and built using the following development tools and libraries:
 229
 230 * [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
 231
 232 * [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/))
 233
 234 * Windows Platform SDK v7.1A, included with Visual Studio 2013 or Visual Studio 2012
 235
 236 * The minimum supported *build* platform is Windows 7 (x86 and x64)
 237
 238 &nbsp;
 239 In order to create LameXP release packages, using the included deployment scripts, you need the following additional tools:
 240
 241 * [7-Zip](http://www.7-zip.org/) &ndash; file archiver with a high compression ratio
 242
 243 * [NSIS](http://nsis.sourceforge.net/) &ndash; Nullsoft Scriptable Install System ([*Unicode version*](http://www.scratchpaper.com/) recommended!)
 244     + [StdUtils](http://nsis.sourceforge.net/StdUtils_plug-in) plug-in
 245     + [LockedList](http://nsis.sourceforge.net/LockedList_plug-in) plug-in
 246     + [Inetc](http://nsis.sourceforge.net/Inetc_plug-in) plug-in
 247     + [Aero](http://forums.winamp.com/showthread.php?t=329990) plug-in
 248
 249 * [UPX](http://upx.sourceforge.net/) &ndash; the Ultimate Packer for eXecutables
 250
 251 * [Pandoc](http://johnmacfarlane.net/pandoc/) &ndash; the Universal Document Converter
 252
 253 * [GnuPG](ftp://ftp.gnupg.org/gcrypt/binary/) &ndash; the GNU Privacy Guard v1.4.x
 254
 255
 256 Qt as Static Libraries
 257 ----------------------
 258
 259 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:
 260
 261  1. Make sure *Visual Studio 2013* with Update-4 (or later) is installed
 262
 263  2. Make sure *Strawberry Perl *for Windows and *Python 2.7* are installed
 264
 265  3. Download and extract the *Qt 4.8.x* source code package (e.g. to ``C:\QtSources\4.8.x``)
 266
 267  4. Edit the file ``mkspecs\win32-msvc2010\qmake.conf`` from your Qt Sources directory as follows:
 268
 269     + ``Old: QMAKE_CFLAGS_RELEASE = -O2 -MD``
 270     + ``New: QMAKE_CFLAGS_RELEASE = -O2 -MT <more optimization flags here>``
 271     + ``Old: QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MD -Zi``
 272     + ``New: QMAKE_CFLAGS_RELEASE_WITH_DEBUGINFO += -O2 -MT -Zi <more optimization flags here>``
 273
 274  5. Open a new command window (``cmd.exe``) &ndash; use this very same console for all upcoming steps!
 275
 276  6. Add *Strawberry Perl* to your PATH (e.g. ``set PATH=C:\strawberry\perl\bin;%PATH%``)
 277
 278  7. Add *Python 2.7* to your PATH (e.g. ``set PATH=C:\python27;%PATH%``)
 279
 280  8. Run ``vcvarsall.bat x86`` form your Visual C++ install directory - within the same console!
 281
 282  9. Change the current directory to the *Qt Sources* path (e.g. ``C:\QtSources\4.8.x``)
 283
 284 10. Run ``configure.exe -release -static -ltcg -qt-zlib -qt-libpng -qt-libjpeg -qt-libtiff -qt-libmng``
 285
 286     + Hint: For Visual Studio 2013 you currently need to add ``-platform win32-msvc2012`` too
 287
 288 11. Now the makefiles should have been generated, so simply enter ``nmake /B`` and be patient - voilà!
 289
 290 12. The build process is going to take good amount of time. Once it is done, make sure you got all needed libs:
 291
 292     + ``lib\qtmain.lib``
 293     + ``lib\QtCore.lib``
 294     + ``lib\QtGui.lib``
 295     + ``lib\QtSvg.lib``
 296     + ``lib\QtXml.lib``
 297     + ``plugins\imageformats\qico.lib``
 298     + ``plugins\imageformats\qsvg.lib``
 299     + ``plugins\imageformats\qtga.lib``
 300
 301 13. Put all the static *.lib files into the ``Prerequisites\qt4_static\lib`` directory
 302
 303 14. ImageFormat plugins go to ``Prerequisites\qt4_static\plugins\imageformats``
 304
 305 15. Congratulations, you should now be prepared to build the ``Release_Static`` configuration of LameXP &#x1f60a;
 306
 307 &nbsp;
 308 *Note:* Static libraries only work with the exactly same compiler (version) they were built with!
 309
 310
 311 F.A.Q. (Frequently Asked Questions)
 312 ===================================
 313
 314 **TODO**
 315
 316
 317 **eof**