aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniil Cherednik <dan.cherednik@gmail.com>2023-11-06 01:12:21 +0100
committerDaniil Cherednik <dan.cherednik@gmail.com>2023-11-06 01:12:21 +0100
commitde664619a2b110fa1639eb09c19390f97d4a96a8 (patch)
treec615481b214e1cdfd5163235242f63c66889f08c
parent2ff97d04227a9cb83ad90211b3f150991d11d737 (diff)
downloadatracdenc-de664619a2b110fa1639eb09c19390f97d4a96a8.tar.gz
Readme and man page fix
-rw-r--r--README.md17
-rw-r--r--man/atracdenc.158
2 files changed, 43 insertions, 32 deletions
diff --git a/README.md b/README.md
index 202ad63..9e12752 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
# atracdenc - ATRAC Decoder Encoder
-Implementation of ATRAC1, ATRAC3 encoders
+It is free LGPL implementation of ATRAC1, ATRAC3 encoders.
Building:
You need:
* C++11 compiler.
-* cmake >= 3.0
+* cmake >= 3.1
* libsndfiles
binary:
@@ -31,17 +31,16 @@ Usage:
ATRAC1:
```
-./atracdenc --encode -i ~/01.wav -o /tmp/01.aea
+./atracdenc -e atrac1 -i ~/01.wav -o /tmp/01.aea
```
-ATRAC3: - use it only if you want to improve it ;)
+ATRAC3:
+```
+./atracdenc -e atrac3 -i ~/01.wav -o /tmp/01.oma
+```
-You can use --help option to get help
+More information on the [atracdenc man page](man/atracdenc.1)
Limitations:
- Bit allocation based on the tonality of the signal (see http://www.minidisc.org/aes_atrac.html)
- Only 44100 16bit wav input file
-
-Other problems:
- - Unfortunately software using ffmpeg library often incorrectly detects AEA file.
- Be careful, the noise in case of wrong detection can be extremely high.
diff --git a/man/atracdenc.1 b/man/atracdenc.1
index 2480716..adebc8d 100644
--- a/man/atracdenc.1
+++ b/man/atracdenc.1
@@ -34,32 +34,44 @@ For ATRCA3 (also known as ATRAC LP on MiniDisk devices) OMA, AT3(riff)
and RealMedia container is supported. In case of OMA and AT3 container compatible bitrates are 66150 (LP4), 104738, 132300 (LP2) bits/s.
RealMedia container supports 66150, 93713, 104738, 132300, 146081, 176400, 264600, 352800 bits/s.
.SH OPTIONS
-\f[B]-h\f[R] Display help.
-
-\f[B]-i\f[R] Path to the input file. In case of encoding it should be WAV, AIFF or SND 44100 Khz 16 bit PCM file. \
+.TP
+.B \-h
+Display help.
+.TP
+.B \-i
+Path to the input file. In case of encoding it should be WAV, AIFF or SND 44100 Khz 16 bit PCM file. \
Use - to read from stdin.
-
-\f[B]-o\f[R] Path to output file. Container format chousen automaticaly acording with file extension.
-
-\f[B]-e <codec>\f[R] Encode mode. <codec> is a codec name must be on of atrac1, atrac3, atrac3_lp2, atrac3_lp4.
-
-\f[B]--encode=<codec>\f[R] Alias for -e.
-
-\f[B]-d\f[R] Decode mode. Only ATRAC1 is supported.
-
-\f[B]--decode\f[R] Alias for -d.
-
-\f[B]--bitrate\f[R] Specify using bitrate. Make sense only for ATRAC3.
-
+.TP
+.B \-o
+Path to output file. Container format chousen automaticaly acording with file extension.
+.TP
+.B \-e <codec>
+Encode mode. <codec> is a codec name must be on of atrac1, atrac3, atrac3_lp2, atrac3_lp4.
+.TP
+.B \--encode=<codec>
+Alias for -e.
+.TP
+.B \-d
+Decode mode. Only ATRAC1 is supported.
+.TP
+.B \--decode
+Alias for -d.
+.TP
+.B \--bitrate
+Specify using bitrate. Make sense only for ATRAC3.
+.TP
.SH ADVENCED OPTIONS
-
-\f[B]--bfuidxconst\f[R] Set constant amount of used BFU (ATRAC1, ATRAC3).
-
-\f[B]--bfuidxfast\f[R] Enable fast search of BFU amount (ATRAC1).
-
-\f[B]--notransient[=mask]\f[R] Disable transient detection and use optional mask \
+.TP
+.B \--bfuidxconst
+Set constant amount of used BFU (ATRAC1, ATRAC3).
+.TP
+.B \--bfuidxfast
+Enable fast search of BFU amount (ATRAC1).
+.TP
+.B \--notransient[=mask]
+Disable transient detection and use optional mask \
to set bands with forced short MDCT window.
-
+.TP
.SH EXAMPLES
.LP
ATRAC1 compatible encoding