minor documentation improvements

- change README from CRLF to LF
- add "attenuated" in description
- extend LICENSE year
- add license to main README

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Werner Robitza
+Copyright (c) 2015-2017 Werner Robitza
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -1,71 +1,100 @@
-ffmpeg-normalize
-================
-
-ffmpeg script for normalizing audio.
-
-This program normalizes media files to a certain dB level. The default is an
-RMS-based normalization where the mean is lifted. Peak normalization is
-possible with the ``-m`` option.
-
-It takes any audio or video file as input, and writes the audio part as
-output WAV file. The normalized audio can also be merged with the
-original.
-
-Requirements:
-
-- Python
-- `ffmpeg` and `ffprobe` from http://ffmpeg.org/ installed in your `$PATH`
-
-Installation::
-
-    pip install ffmpeg-normalize
-
-Usage::
-
-    ffmpeg-normalize [options] <input-file>...
-
-Options:
-
--  ``-f``, ``--force`` — Force overwriting existing files
--  ``-l``, ``--level <level>`` — dB level to normalize to [default: -26]
--  ``-p``, ``--prefix <prefix>`` — Prefix for normalized files or output folder name [default:
-   normalized]
--  ``-np``, ``--no-prefix`` — Write output file without prefix (cannot be used when `--dir` is used)
--  ``-t``, ``--threshold <threshold>`` — dB threshold below which the
-   audio will be not adjusted [default: 0.5]
--  ``-o``, ``--dir`` — Create an output folder under the input file's directory with the prefix instead of prefixing the
-   file (does not work if `--no-prefix` is chosen)
--  ``-m``, ``--max`` — Normalize to the maximum (peak) volume instead of
-   RMS
--  ``-v``, ``--verbose`` — Enable verbose output
--  ``-n``, ``--dry-run`` — Show what would be done, do not convert
--  ``-d``, ``--debug`` — Show debug output
--  ``-u``, ``--merge`` — Don’t create a separate WAV file but update the
-   original file. Use in combination with -p to create a copy
--  ``-a``, ``--acodec <acodec>`` — Set audio codec for ffmpeg (see
-   `ffmpeg -encoders`) (will be chosen based on format, default pcm_s16le for WAV)
--  ``-r``, ``--format <format>`` – Set format for ffmpeg (see `ffmpeg -formats`) to use for output file [default: wav]
--  ``-e``, ``--extra-options <extra-options>`` — Set extra options
-   passed to ffmpeg (e.g. “-b:a 192k” to set audio bitrate)
-
-Examples::
-
-Normalize a file and write to `normalized-file.wav`::
-
-    ffmpeg-normalize -v file.mp3
-    ffmpeg-normalize --verbose *.avi
-
-Normalize a number of AVI files and write to `normalized-<file>.wav`::
-
-    ffmpeg-normalize -v *.avi
-    ffmpeg-normalize --verbose *.avi
-
-Normalize a number of MP4 files to -5 dB peak volume and merge the audio stream back into the MP4 files, in a new directory called `normalized`::
-
-    ffmpeg-normalize -vuofm -l -5 *.mp4
-    ffmpeg-normalize --verbose --merge --dir --force --max --level -5 *.mp4
-
-Normalize a number of MKV files and merge the audio back in using the `libfdk_aac` encoder with 192 kBit/s CBR::
-
-    ffmpeg-normalize -vu -a libfdk_aac -e "-b:a 192k" *.mkv
-    ffmpeg-normalize --verbose --merge --acodec libfdk_aac --extra-options "-b:a 192k" *.mkv
+ffmpeg-normalize
+================
+
+ffmpeg script for normalizing audio.
+
+This program normalizes media files to a certain dB level. The default is an
+RMS-based normalization where the mean is lifted or attenuated. Peak normalization is
+possible with the ``-m`` option.
+
+It takes any audio or video file as input, and writes the audio part as
+output WAV file. The normalized audio can also be merged with the
+original.
+
+Requirements
+------------
+
+- Python
+- `ffmpeg` from http://ffmpeg.org/ installed in your `$PATH` (3.x or above recommended)
+
+Installation
+------------
+
+    pip install ffmpeg-normalize
+
+Usage
+-----
+
+    ffmpeg-normalize [options] <input-file>...
+
+Options:
+
+-  ``-f``, ``--force`` — Force overwriting existing files
+-  ``-l``, ``--level <level>`` — dB level to normalize to [default: -26]
+-  ``-p``, ``--prefix <prefix>`` — Prefix for normalized files or output folder name [default:
+   normalized]
+-  ``-np``, ``--no-prefix`` — Write output file without prefix (cannot be used when `--dir` is used)
+-  ``-t``, ``--threshold <threshold>`` — dB threshold below which the
+   audio will be not adjusted [default: 0.5]
+-  ``-o``, ``--dir`` — Create an output folder under the input file's directory with the prefix instead of prefixing the
+   file (does not work if `--no-prefix` is chosen)
+-  ``-m``, ``--max`` — Normalize to the maximum (peak) volume instead of
+   RMS
+-  ``-v``, ``--verbose`` — Enable verbose output
+-  ``-n``, ``--dry-run`` — Show what would be done, do not convert
+-  ``-d``, ``--debug`` — Show debug output
+-  ``-u``, ``--merge`` — Don’t create a separate WAV file but update the
+   original file. Use in combination with -p to create a copy
+-  ``-a``, ``--acodec <acodec>`` — Set audio codec for ffmpeg (see
+   `ffmpeg -encoders`) (will be chosen based on format, default pcm_s16le for WAV)
+-  ``-r``, ``--format <format>`` – Set format for ffmpeg (see `ffmpeg -formats`) to use for output file [default: wav]
+-  ``-e``, ``--extra-options <extra-options>`` — Set extra options
+   passed to ffmpeg (e.g. “-b:a 192k” to set audio bitrate)
+
+Examples
+--------
+
+Normalize a file and write to `normalized-file.wav`::
+
+    ffmpeg-normalize -v file.mp3
+    ffmpeg-normalize --verbose *.avi
+
+Normalize a number of AVI files and write to `normalized-<file>.wav`::
+
+    ffmpeg-normalize -v *.avi
+    ffmpeg-normalize --verbose *.avi
+
+Normalize a number of MP4 files to -5 dB peak volume and merge the audio stream back into the MP4 files, in a new directory called `normalized`::
+
+    ffmpeg-normalize -vuofm -l -5 *.mp4
+    ffmpeg-normalize --verbose --merge --dir --force --max --level -5 *.mp4
+
+Normalize a number of MKV files and merge the audio back in using the `libfdk_aac` encoder with 192 kBit/s CBR::
+
+    ffmpeg-normalize -vu -a libfdk_aac -e "-b:a 192k" *.mkv
+    ffmpeg-normalize --verbose --merge --acodec libfdk_aac --extra-options "-b:a 192k" *.mkv
+
+License
+-------
+
+The MIT License (MIT)
+
+Copyright (c) 2015-2017 Werner Robitza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ffmpeg_normalize/__main__.py

@@ -5,8 +5,8 @@
 ffmpeg script for normalizing audio.
 
 This program normalizes media files to a certain dB level. The default is an
-RMS-based normalization where the mean is lifted. Peak normalization is
-possible with the -m option.
+RMS-based normalization where the mean is lifted or attenuated. Peak normalization
+is possible with the -m option.
 
 It takes any audio or video file as input, and writes the audio part as
 output WAV file. The normalized audio can also be merged with the
@@ -42,7 +42,7 @@
 #
 # The MIT License (MIT)
 #
-# Copyright (c) 2015 Werner Robitza
+# Copyright (c) 2015-2017 Werner Robitza
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal