mirror of
https://gitlab.com/ecodis/exhale.git
synced 2025-01-08 21:22:10 +01:00
prepare documentation
This commit is contained in:
Christian R. Helmrich
parent
6f64cb68f1
commit
1963a3868e
94
README.md
94
README.md
@ -1,3 +1,93 @@
|
||||
# exhale
|
||||
exhale
|
||||
======
|
||||
|
||||
an open-source ISO/IEC 23003-3 (USAC, xHE-AAC) encoder
|
||||
exhale, which is an acronym for "Ecodis eXtended High-efficiency And
|
||||
Low-complexity Encoder", is a lightweight library and application to
|
||||
encode uncompressed WAVE-format audio files into MPEG-4 format files
|
||||
complying with the ISO/IEC 23003-3 (MPEG-D) Unified Speech and Audio
|
||||
Coding (USAC, also known as Extended High-Efficiency AAC) standard.
|
||||
|
||||
exhale currently makes use of all frequency-domain (FD) coding tools
|
||||
in the scalefactor based MDCT processing path, except for predictive
|
||||
joint stereo, which is already being worked on. It objective is high
|
||||
quality mono, stereo, and multichannel coding at medium and high bit
|
||||
rates, so the parametric USAC coding tools (ACELP, TCX, Enhanced SBR
|
||||
and MPEG Surround with Unified Stereo coding) won't be integrated.
|
||||
|
||||
____________________________________________________________________
|
||||
|
||||
|
||||
Copyright
|
||||
---------
|
||||
|
||||
(c) 2020 Christian R. Helmrich, project ecodis. All rights reserved.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
exhale is being made available under an open-source license which is
|
||||
similar to the 3-clause BSD license but modified to address specific
|
||||
lar aspects dictated by the nature and output of this application.
|
||||
|
||||
The license text and release notes for the current version 1.0.0 can
|
||||
be found in the "include" subdirectory of the exhale distribution.
|
||||
|
||||
|
||||
Compilation
|
||||
-----------
|
||||
|
||||
This section describes how to compile the exhale source code into an
|
||||
executable application under Linux and Microsoft Windows. The binary
|
||||
application files will show up in a newly created `bin` subdirectory
|
||||
of the exhale distribution directory and/or a subdirectory thereof.
|
||||
|
||||
### Linux and MacOS (GNU Compiler Collection, gcc):
|
||||
|
||||
In a terminal, change to the exhale distribution directory and enter
|
||||
|
||||
`
|
||||
make release
|
||||
`
|
||||
|
||||
to build a release-mode executable with the default (usually 64-bit)
|
||||
configuration. A 32-bit debug-mode executable can be built by typing
|
||||
|
||||
`
|
||||
make debug BUILD32=1
|
||||
`
|
||||
|
||||
### Microsoft Windows (Visual Studio 2012 and later):
|
||||
|
||||
Doubleclick the exhale_vs2012.sln file to open the project in Visual
|
||||
Studio. Once it's loaded, rightclick on `exhaleApp` in the "Solution
|
||||
Explorer" window on the right-hand side, then select `Set as StartUp
|
||||
Project`. Now simply press `F7` to build the solution in debug mode.
|
||||
|
||||
For fastest encoding speed, please select `Release` and `x64` before
|
||||
building the solution. This will create a release-mode 64-bit binary.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
This section describes how to run the exhale application either from
|
||||
the command-line or using a third-party software providing WAVE data
|
||||
to exhale's standard input pipe (stdin), such as foobar2000.
|
||||
|
||||
### Standalone (command-line):
|
||||
|
||||
In a terminal, change to exhale's `bin` subdirectory and then enter
|
||||
|
||||
`./exhale` (on Linux and MacOS) or `exhaleApp.exe` (on Windows)
|
||||
|
||||
to print out usage information. As an example, the following command
|
||||
|
||||
`exhaleApp.exe 5 C:\Music\Input.wav C:\Music\Output.m4a`
|
||||
|
||||
converts file Input.wav to file Output.m4a at roughly 128 kbit/s (if
|
||||
the input file is two-channel stereo) and in xHE-AAC audio format.
|
||||
|
||||
### Third-party stdin (foobar2000):
|
||||
|
||||
will follow soon
|
||||
|
||||
@ -1,53 +0,0 @@
|
||||
<!-- www.ecodis.de/exhale/license.htm - created by Christian R. Helmrich - Copyright (c) 2018-2019 Christian Helmrich -->
|
||||
|
||||
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" type="text/css" href="styles.css">
|
||||
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
|
||||
<meta name="author" content="Dr.-Ing. Christian R. Helmrich">
|
||||
<meta name="description" content="exhale License Specification">
|
||||
<meta name="keywords" content="audio, data compression, perceptual coding, subjective evaluation, video">
|
||||
<title>ecodis :: exhale :: License Text</title>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<table align="center" cellpadding="0" cellspacing="0">
|
||||
<colgroup>
|
||||
<col width="2">
|
||||
<col width="60">
|
||||
<col width="595">
|
||||
<col width="60">
|
||||
<col width="2">
|
||||
</colgroup>
|
||||
<tr>
|
||||
<td colspan="2"></td>
|
||||
<td valign="top">
|
||||
|
||||
<h1><br><span class="pink">exhale</span> - <span class="pink">e</span>codis e<span class="pink">x</span>tended <span class="pink">h</span>igh-efficiency <span class="pink">a</span>nd <span class="pink">l</span>ow-complexity <span class="pink">e</span>ncoder<br><span class="gray"><sup><br>referred to as «Software» below; additions to original BSD license text marked by [ ]</sup></span><br><br></h1>
|
||||
<h3> This Software is being made available and/or distributed under the following Modified <a href="http://www.linfo.org/bsdlicense.html">BSD</a>-style License. For a list of authors which have contributed to this Software, called «contributors» in the text below, please refer to the respective files provided with this distribution (source files or binary executable) to which modifications were contributed.</h3>
|
||||
<h3><br><b>Licensor's Copyright Notice</b></h3>
|
||||
<h3> Copyright © 2018–2019 Christian R. Helmrich, <a href="http://www.ecodis.de">ecodis</a> (Licensor). All rights reserved.</h3>
|
||||
<h3><br><b>List of License Conditions</b></h3>
|
||||
<h3> Redistribution and use <span class="gray">[</span>of this Software<span class="gray">]</span> in source and binary forms, with or without modification, are permitted provided that<sub> </sub><span class="gray">[</span>all of<span class="gray">]</span><sub> </sub>the following<sub> </sub><span class="gray">[</span>four<span class="gray">]</span><sub> </sub>conditions are met:</h3>
|
||||
<ul>
|
||||
<li><h3>Redistributions of source code must retain the above copyright notice <span class="gray">[</span>in each file provided with the distribution<span class="gray">]</span>, this list of conditions, and the following disclaimer.</h3></li>
|
||||
<li><h3>Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other files provided with the distribution.</h3></li>
|
||||
<li><h3><span class="gray">[</span>Redistributions of modified versions of this Software, whether in source or binary form, must reproduce a notice in each file provided with the distribution and affec­ted by the modification, documenting the name of the contributor having authored the modification and the year of the modification.<span class="gray">]</span></h3></li>
|
||||
<li><h3>Neither the name of the Licensor nor the names of the contributors may be used to endorse or promote products derived from this Software without specific prior written permission <span class="gray">[</span>from the Licensor<span class="gray">]</span>.</h3></li>
|
||||
</ul>
|
||||
<h3><br><b>Liability and Patent Disclaimer</b></h3>
|
||||
<h3> THIS SOFTWARE IS PROVIDED BY THE LICENSOR AND THE CONTRIBUTORS «<b>AS IS</b>» AND ANY EXPRESS OR IMPLIED WARRANTIES (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PUR­POSE) ARE DISCLAIMED. IN NO EVENT SHALL THE LICENSOR OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</h3>
|
||||
<h3> <span class="gray">[</span>This Software may be subject to other third-party and/or contributor rights, including patent rights. In particular, this Software may implement methods and/or technologies required to perform in compliance with certain specifications of the ISO/IEC (MPEG-D) international standard <a href="https://www.iso.org/standard/76385.html">23003-3</a>, which may be subject to said other rights. NO express or implied licenses to any patent claims related to the use of this Software are granted under this license, and the Licensor provides NO WARRANTY of patent non-infringement with respect to this Software. Patent licenses required for the use of this Software to generate digital bit-streams according to any specifications of ISO/IEC 23003-3 may be obtained through <a href="https://www.via-corp.com/licensing/aac/">Via Licensing</a> and/or the corresponding patent holders individually.<span class="gray">]</span><br><br></h3>
|
||||
<h4><span class="gray">Written by C. R. Helmrich for exhale 1.0.0, Dec. 2019. Available at www.ecodis.de/exhale/license.htm.</span><br><br></h4>
|
||||
|
||||
</td>
|
||||
<td valign="top" colspan="2">
|
||||
<p><br> <img src="../src/app/exhaleApp.ico" alt="exhale" title="exhale" height="48" width="48"></p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue
Block a user