diff --git a/README.md b/README.md index 8b32b1f..89f82a6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,35 @@ # AtOM: Anything to Ogg and Mp3 +This program is for you if +1. you want to have your music collection in the highest quality possible +2. you have devices that don't have enough storage to hold it or +3. you have devices that support a limited number of formats + +To satisfy that need, we take a "source" directory, inventory and read tags for +every file therein. From that, we can create and maintain copies of said +directory in other formats or quality. There is also the possibility of +ignoring or simply copying files with certain mime-types or extensions. + +We try to do this in a *smart* way, by only treating files that are new or +changed since the last run. + +Apart from transcoding from one format to another, AtOM can also change +sample-rate, bitrate, and the number of channels! Say, for example, that you +want to stream your music through icecast. In addition to having all the files +in the same format, it will want a constant sample-rate and bitrate. You can +have AtOM do that! + +Here's what I have for my tests: +| Directory | Format | Frequency | Bitrate | Channels | FAT32 compat. | ASCII | Size | +| --------- | ------ | --------- | ------- | -------- | ------------- | ----- | ---- | +| 0-Full | Mixed | Mixed | Mixed | Mixed | No | No | 508G | +| 1-High | Opus | Same | 128 | Same | Yes | No | 101G | +| 2-Medium | Opus | Same | 64 | Same | Yes | No | 59G | +| 3-Small | Opus | Same | 32 | Same | Yes | No | 30G | +| 4-MP3 | MP3 | 44100 | 128 | 2 | Yes | Yes | 114G | + + + * URL: https://framagit.org/ScriptFanix/AtOM/ * Author: Vincent Riquer * Copyright/left: 2012-2013,2015,2025 Vincent Riquer - GPLv3 @@ -11,7 +41,7 @@ * [SQLite](http://www.sqlite.org/) ### Optional: -Some features will not be available. +**Some features will be disabled** when not present. * [vorbis-tools](http://www.vorbis.com/) * `ogginfo` (Ogg Vorbis metadata) * `oggenc` (Ogg Vorbis encoding) @@ -41,7 +71,7 @@ If, however, you still want to make changes manually, please read doc/config. There are a lot of comments in the generated config file too. ### Preparing data: -Nothing specific needs to be done. You can edit ypur tags, rename files, move +Nothing specific needs to be done. You can edit your tags, rename files, move them around how you see fit. However, make sure you setup your tag editor to *do* update the files' timestamps: though it was initially plan to make this optional, using checksums or tags, it was abandoned due to the huge amount of