Merge branch 'dev' into 'master'

v1.0.4 last minute fixes

See merge request atom/AtOM!32

.gitignore

@@ -1,4 +1,5 @@
 *.ex
 *.EX
 trace.log
-.vscode/
+.vscode/
+Makefile.in

CHANGELOG.md

@@ -0,0 +1,34 @@
+# 1.0.3
+## `BREAKING CHANGES`
+* Implementing replaygain copy meant bumping versions of every tag parser. All file tags will be read again. Running in batches (`-B <batchsize>`) is recommended.
+
+### Bugs
+* Fix a number of issues with `releasecountry` tag
+
+### Enhancements
+* Spawn tasks faster when slots are available.
+* Copy replaygain tags.
+* Add `copy_extension` to setup
+
+# 1.0.2
+### Bugs
+* Tag reading hangs on vorbis files with embedded images.
+* Recreate destination files on releasecountry tag change (bump database schema to 5).
+
+# 1.0.1
+## `BREAKING CHANGES`
+* Implementing releasecountry meant bumping versions of every tag parser. All file tags will be read again. Running in batches (`-B <batchsize>`) is recommended.
+
+### Enhancements
+* Copy releasecountry tag ("MusicBrainz Album Release Country" for MP3).
+
+### Bugs
+* Opus tags were not actually parsed due to an issue with the tag reader selector.
+
+### Enhancements
+* Fetch releasecountry tag from files
+* Add `%{releasecountry}` placeholder in `rename`
+* Add `-r` (show release country) to toys/createindex
+
+# 1.0.0
+Initial public release

Makefile

@@ -0,0 +1,19 @@
+include Makefile.in
+
+all: atom #$(wildcard toys/*) $(wildcard lib/*/*)
+	mkdir work
+	cp -r atom toys work
+	sed -i 's:%LIBDIR%:'$(libdir)':;s:%SHAREDIR%:'$(sharedir)':;s:%DOCDIR%:'$(docdir)':' work/atom work/toys/*
+
+install:
+	install -m 644 -D -t $(docdir) doc/*
+	install -m 644 -D README.md $(docdir)/README.md
+	install -m 644 -D work/toys/README $(docdir)/README.toys
+	rm work/toys/README
+	install -m 644 -D -t $(sharedir) share/*
+	install -d $(libdir)
+	cp -dpr --no-preserve=ownership lib/* $(libdir)
+	install -D -t $(bindir) work/atom work/toys/*
+
+clean:
+	rm -Rf work

README.md

@@ -1,9 +1,38 @@
 # AtOM: Anything to Ogg and Mp3
 
-* URL: https://framagit.org/ScriptFanix/AtOM/
+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 | Sample rate | 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/atom/AtOM/
 * Author: Vincent Riquer <vincent+prog.atom@riquer.fr>
 * Copyright/left: 2012-2013,2015,2025 Vincent Riquer - GPLv3
-  - except: transogg: WTFPL 2.0
 
 ## Dependencies
 ### Required:
@@ -12,6 +41,7 @@
 * [SQLite](http://www.sqlite.org/)
 
 ### Optional:
+**Some features will be disabled** when not present.
 * [vorbis-tools](http://www.vorbis.com/)
     * `ogginfo` (Ogg Vorbis metadata)
     * `oggenc` (Ogg Vorbis encoding)
@@ -31,6 +61,13 @@
 
 ## Using the software
 
+### Installation
+
+1. Clone the repository: `git clone https://framagit.org/atom/AtOM.git`
+2. run `./configure && make && sudo make install`
+
+`./configure` takes an optional prefix: `./configure --prefix=/usr`. Defaults to /usr/local.
+
 ### Configuration:
 On first run, AtOM will ask a set of questions to help you create a
 configuration file.
@@ -41,7 +78,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

TODO

@@ -1,5 +0,0 @@
-Tag Guessing
-------------
-From a user-defined pattern, guess tags for unsupported formats/untagged files
-from the file path and file name.
-

atom

@@ -18,6 +18,7 @@ declare -A			\
 	destinationchannels	\
 	destinationfat32compat	\
 	destinationcopymime	\
+	destinationcopyext	\
 	destinationformat	\
 	destinationfrequency	\
 	destinationid		\
@@ -36,17 +37,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
-
 LC_ALL=C
 
 shopt -s extglob
@@ -58,13 +57,22 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 help() {
 	cat <<-EOF
 	Options:
 	        -c <file>        Load configuration file <file>
 	        -C               Dump configuration and exit
 	        -l <load>        Override max-load
-		-f <workers>     Use exactly <workers> child processes
+	        -f <workers>     Use exactly <workers> child processes
 	        -T <seconds>     override load-interval
 	        -F <destination> Force re-generation of all files in
 	                         <destination>
@@ -77,7 +85,6 @@ help() {
 }
 
 #parse arguments
-OPTERR=0
 while getopts ':c:Cl:T:F:f:B:ShDq' opt
 do
 	case $opt in
@@ -176,163 +183,7 @@ set +H
 (( cfgdump )) && exit
 
 # check sanity
-if [ ! -d "$tempdir" ] && ! mkdir -p "$tempdir"
-then
-	echo "[FATAL] Could not create temp directory $tempdir" >&2
-	(( sanityfail++ ))
-fi
-if [ ! -f "$database" ] && [ ! -d "${database%/*}" ] && ! mkdir -p "${database%/*}"
-then
-	echo "[FATAL] Directory holding database file does not exist and could"	\
-		"not be created" >&2
-	(( sanityfail++ ))
-fi
-if [ ! -d "$sourcepath" ]
-then
-	echo "[FATAL] Source path $sourcepath does not exist or is not a directory" >&2
-	(( sanityfail++ ))
-fi
-if ! which sed >/dev/null
-then
-	echo "[FATAL] Required tool sed is not installed or not in PATH
-	I never thought this would actually hit someone..." >&2
-	(( sanityfail++ ))
-fi
-if ! which sox >/dev/null
-then
-	echo "[FATAL] Required tool sox is not installed or not in PATH" >&2
-	(( sanityfail++ ))
-fi
-if ! which ogginfo >/dev/null
-then
-	echo "[WARNING] Tool ogginfo (from vorbis-tools) is not"	\
-	"installed or not in PATH
-	WebM metadata disabled" >&2
-	disableogginfo=1
-	(( sanitywarn++ ))
-fi
-if ! which soxi >/dev/null
-then
-	echo "[WARNING] Tool soxi (from sox) is not"	\
-	"installed or not in PATH
-	Vorbis metadata disabled" >&2
-	disablesoxi=1
-	(( sanitywarn++ ))
-fi
-if (( oggencneeded )) && ! which oggenc >/dev/null
-then
-	echo "[WARNING] Tool oggenc (from vorbis-tools) is not"	\
-	"installed or not in PATH
-	Vorbis targets disabled" >&2
-	disableoggenc=1
-	(( sanitywarn++ ))
-fi
-if ! which opusinfo >/dev/null
-then
-	echo "[WARNING] Tool opusinfo (from opus-tools) is not"	\
-	"installed or not in PATH
-	Opus metadata disabled" >&2
-	disableopusinfo=1
-	(( sanitywarn++ ))
-fi
-if (( opusencneeded )) && ! which opusenc >/dev/null
-then
-	echo "[WARNING] Tool opusenc (from opus-tools) is not"	\
-	"installed or not in PATH
-	Opus targets disabled" >&2
-	disableopusenc=1
-	(( sanitywarn++ ))
-fi
-if ! which opusdec >/dev/null
-then
-	echo "[WARNING] Tool opusdec (from opus-tools) is not"	\
-	"installed or not in PATH
-	Opus support disabled" >&2
-	disableopusdec=1
-	(( sanitywarn++ ))
-fi
-if (( lameneeded )) && ! which lame >/dev/null
-then
-	echo "[WARNING] Tool lame is not installed or not in PATH
-	MP3 targets disabled" >&2
-	disablelame=1
-	(( sanitywarn++ ))
-fi
-if ! which metaflac >/dev/null
-then
-	echo "[WARNING] Tool metaflac (from FLAC) is not installed"	\
-	"or not in PATH
-	FLAC metadata disabled" >&2
-	disableflac=1
-	(( sanitywarn++ ))
-fi
-if ! which mpcdec >/dev/null
-then
-	echo "[WARNING] Tool mpcdec (from Musepack) is not"	\
-	"installed or not in PATH
-	Musepack support disabled" >&2
-	disablempcdec=1
-	(( sanitywarn++ ))
-fi
-if ! which mkvextract >/dev/null
-then
-	echo "[WARNING] Tool mkvextract (from MKVToolNix) is not"	\
-	"installed or not in PATH
-	WebM metadata disabled
-	WebM support disabled" >&2
-	disablemkvextract=1
-	(( sanitywarn++ ))
-fi
-if ! which ffprobe >/dev/null
-then
-	echo "[WARNING] Tool ffprobe (from FFmpeg) is not installed or not in PATH
-	Video metadata disabled
-	MPEG metadata disabled
-	MusePack metadata disabled
-	Unknown format metadata disabled" >&2
-	disableffprobe=1
-	(( sanitywarn++ ))
-fi
-if ! which ffmpeg >/dev/null
-then
-	echo "[WARNING] Tool ffmpeg is not installed or not in PATH
-	Video support disabled" >&2
-	disablevideo=1
-	(( sanitywarn++ ))
-fi
-if (( textunidecodeneeded )) && ! perl -MText::Unidecode -e 'exit;' 2>/dev/null
-then
-	echo "[WARNING] Perl module Text::Unidecode is not available
-	Renaming to ASCII-only disabled" >&2
-	unset destinationascii
-	destinationascii=0
-	textunidecodeneeded=0
-	(( sanitywarn++ ))
-fi
-if (( sanityfail ))
-then
-	echo "
-Sanity checks raised ${sanitywarn:-0} warnings, $sanityfail failures. Dying now." >&2
-	exit $ESANITY
-elif (( sanitywarn ))
-then
-	echo "
-Sanity checks raised $sanitywarn warnings... Hit Control-C to abort." >&2
-	if ! (( cron ))
-	then
-		timeout=$(( sanitywarn * 10 ))
-		echo -n "Starting in $(printf %3i $timeout)"	\
-			$'seconds...\b\b\b\b\b\b\b\b\b\b\b' >&2
-		while (( timeout ))
-		do
-			echo -n $'\b\b\b'"$(printf %3i $timeout)" >&2
-			sleep 1
-			(( timeout-- ))
-		done
-		echo -en "\r\033[K"
-	fi
-fi
-
+sanityCheck
 openDatabase
 
 for destination in "${destinations[@]}"
@@ -547,20 +398,23 @@ echo '
 		mime_type_actions.mime_text,
 		destinations.name,
 		destination_files.id,
-		tags.depth,
-		tags.rate,
-		tags.channels,
-		tags.bitrate,
-		tags.genre,
-		tags.albumartist,
-		tags.year,
 		tags.album,
-		tags.disc,
+		tags.albumartist,
 		tags.artist,
-		tags.track,
-		tags.title,
+		tags.bitrate,
+		tags.channels,
 		tags.composer,
-		tags.performer
+		tags.depth,
+		tags.disc,
+		tags.genre,
+		tags.performer,
+		tags.rate,
+		tags.releasecountry,
+		tags.replaygain_alb,
+		tags.replaygain_trk,
+		tags.title,
+		tags.track,
+		tags.year
 	FROM			source_files
 		INNER JOIN	destination_files
 			ON	source_files.id
@@ -603,33 +457,39 @@ do
 	rest=${rest#*::AtOM:SQL:Sep::}
 	destfileid=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
-	bitdepth=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
-	rate=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
-	channels=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
-	bitrate=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
-	genre=${rest%%::AtOM:SQL:Sep::*}
+	album=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
 	albumartist=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
-	year=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
-	album=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
-	disc=${rest%%::AtOM:SQL:Sep::*}
-	rest=${rest#*::AtOM:SQL:Sep::}
 	artist=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
-	track=${rest%%::AtOM:SQL:Sep::*}
+	bitrate=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
-	title=${rest%%::AtOM:SQL:Sep::*}
+	channels=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
 	composer=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
+	depth=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	disc=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	genre=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
 	performer=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	rate=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	releasecountry=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	replaygain_alb=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	replaygain_trk=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	title=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	track=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
+	year=${rest%%::AtOM:SQL:Sep::*}
 	unset rest
 	case ${destinationformat["$destination"]} in
 		vorbis)	(( disableoggenc ))	&& continue	;;
@@ -641,7 +501,7 @@ do
 	getDestFile
 	for copy_ext in "${destinationcopyext[@]}"
 	do
-		if [[ $filename =~ '.*\.'$copy_ext'$' ]]
+		if [[ $filename =~ '.*\.'"$copy_ext"'$' ]]
 		then
 			copied=1
 			break
@@ -657,13 +517,13 @@ do
 		album		\
 		albumartist	\
 		artist		\
-		bitdepth	\
 		bitrate		\
 		channels	\
 		commandline	\
 		composer	\
 		copied		\
 		decodetaskid	\
+		depth		\
 		destfileid	\
 		destination	\
 		disc		\
@@ -672,6 +532,9 @@ do
 		mimetype	\
 		performer	\
 		rate		\
+		releasecountry	\
+		replaygain_alb	\
+		replaygain_trk	\
 		rest		\
 		sox_needed	\
 		soxoptions_in	\
@@ -692,19 +555,20 @@ echo "Created ${count:-0} tasks for $filecount files ${togo:+($togo left) }(${co
 concurrency=$(( maxload / 2 ))
 (( concurrency )) || concurrency=1
 active=0
-concurrencychange=$(date +%s)
+concurrencychange=$EPOCHSECONDS
 starttime=$concurrencychange
 taskcount=$count
 remaining=$taskcount
 failed=0
 echo 'BEGIN TRANSACTION;' >&3
-committime=$(date +%s)
+committime=$EPOCHSECONDS
 while (( (remaining || ${#workers[@]}) && ! quit ))
 do
-	if (( $(date +%s) - committime >= 60 ))
+	timestamp=$EPOCHSECONDS
+	if (( $timestamp - committime >= 60 ))
 	then
 		echo $'COMMIT;\nBEGIN TRANSACTION;' >&3
-		committime=$(date +%s)
+		committime=$timestamp
 	fi
 	read humanload garbage < /proc/loadavg
 	load=${humanload%.*}
@@ -714,16 +578,16 @@ do
 	else
 		if [ -z "$quit" ]					\
 		&& (( ! pause ))					\
-		&& (( $(date +%s)-concurrencychange >= loadinterval ))
+		&& (( timestamp - concurrencychange >= loadinterval ))
 		then
 			if (( concurrency > 1 ))	\
 			&& (( load > maxload ))
 			then
-				concurrencychange=$(date +%s)
+				concurrencychange=$timestamp
 				(( --concurrency ))
 			elif (( load < maxload )) && (( active > concurrency - 1 ))
 			then
-				concurrencychange=$(date +%s)
+				concurrencychange=$timestamp
 				(( ++concurrency ))
 			fi
 		fi
@@ -733,7 +597,7 @@ do
 	(( pause )) || master
 	if (( ran - failed ))
 	then
-		currenttime=$(date +%s)
+		currenttime=$timestamp
 		if (( pause ))
 		then
 			(( runtime = pausestart - starttime - pausedtime ))
@@ -809,7 +673,7 @@ done
 echo 'COMMIT;' >&3
 unset count
 
-endtime=$(date +%s)
+endtime=$EPOCHSECONDS
 
 (( elapsedseconds = endtime - starttime - pausedtime ))
 (( days =
@@ -906,8 +770,7 @@ then
 		FROM		tasks
 		INNER JOIN	source_files
 			ON	tasks.source_file=source_files.id
-		WHERE		tasks.status = 2
-		AND		requires is NULL;
+		WHERE		tasks.status = 2;
 
 		SELECT "AtOM:NoMoreFiles";' >&3
 	read -u4 line
@@ -946,6 +809,7 @@ do
 		tags.disc,
 		tags.genre,
 		tags.performer,
+		tags.releasecountry,
 		tags.title,
 		tags.track,
 		tags.year
@@ -1014,6 +878,8 @@ do
 			rest=${rest#*::AtOM:SQL:Sep::}
 			performer=${rest%%::AtOM:SQL:Sep::*}
 			rest=${rest#*::AtOM:SQL:Sep::}
+			releasecountry=${rest%%::AtOM:SQL:Sep::*}
+			rest=${rest#*::AtOM:SQL:Sep::}
 			title=${rest%%::AtOM:SQL:Sep::*}
 			rest=${rest#*::AtOM:SQL:Sep::}
 			track=${rest%%::AtOM:SQL:Sep::*}

configure

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# defaults
+default_prefix=/usr/local
+#default_bindir=$default_prefix/bin
+#default_libdir=$default_prefix/lib
+#default_sharedir=$default_prefix/share
+
+while (( $# ))
+do
+	case "$1" in
+		--prefix=*)	prefix="${1#*=}"
+		;;
+	esac
+	shift
+done
+
+bindir="${prefix:-$default_prefix}"/bin
+libdir="${prefix:-$default_prefix}"/lib/AtOM
+sharedir="${prefix:-$default_prefix}"/share/AtOM
+docdir="${prefix:-$default_prefix}"/share/doc/AtOM
+
+cat > Makefile.in <<-EOMakefile.in
+	bindir = "$bindir"
+	libdir = "$libdir"
+	sharedir = "$sharedir"
+	docdir = "$docdir"
+EOMakefile.in

doc/GPL-3

@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.

doc/example.cfg

@@ -1,55 +1,186 @@
 [general]
-ionice			3
-max-load		6
-load-interval		30
-temporary-directory	%HOME%/.atom/tmp
-database		%HOME%/.atom/atom.db
-debug			0
+# This section contains parameters of the program itself.
+
+# * max-load <load>: Integer. Defines how parallel processing will behave. AtOM
+#     will try to keep the 1 minute load average between <load> and <load>+1 by
+#     adjusting concurrency.
+#     Initial concurrency will be set to half of that value.
+max-load		16
+
+# * load-interval <seconds>: Integer. How often should we check the load average
+#     and adjust concurrency. Set this too low, and concurrency may be increased
+#     too quickly. Set this too high, and AtOM will not adapt quickly enough to
+#     load increase. In both cases, your hard drive will suffer. In my
+#     experience, 30 seconds is a good value.
+load-interval		10
+
+# * ionice <class> [niceness]: IO-hungry processes will be run with ionice class
+#     <class> and niceness [niceness] (if applicable). See man ionice for details.
+ionice			3 
+
+# * temporary-directory <directory>: String. Name speaks for itself: this is
+#     where FIFOs (for communicating with sqlite) and temporary WAVE files will
+#     be created.  Note that debug logs (if enabled) will go there too.
+temporary-directory	/tmp/AtOM-user/
+
+# * database <file>: String. Where the SQLite database should be stored.
+database		/home/user/.local/share/AtOM/atom.db
+
+# * debug <level>: Integer.
+#    0: No debug output, encoding and decoding errors logged to 
+#       <temporary-directory>/workerN.log
+#    1: Print some debug to stdout, log decoding and encoding commands to
+#       <temporary-directory>/workerN.log
+#    3: log SQL queries to <temporary-directory>/debug.log
+#debug			1
+
 
 [source]
-path		/var/lib/mpd/music
-skip		/last
-skip		/lastfm
-skip		/zzz-atrier
+# This section defines where are the files you want transcoded.
 
-[Ogg]
-path		/mnt/Musique-OggQ2
-format		vorbis
-quality		1
-normalize	yes
-channels	2
-frequency	44100
+# * path <directory>: String. The root of your collection.
+#     Default: /var/lib/mpd/music
+path			/mnt/Musique
+
+# * skip <directory>: String. Files in <directory> will be ignored. Note that
+#     <directory> can be any expression accepted by find.
+skip			/lost+found
+skip			/last
+skip			/lastfm
+skip			/zzz-atrier
+
+[Vorbis]
+# Each section not named 'general' or 'source' will define a new destination.
+
+# Common parameters:
+#  Mandatory parameters:
+#   * enabled: Whether or not to treat this destination (1=true/0=false)
+enabled			1
+
+#   * path: Where files will be written
+path			/mnt/Musique-OggQ2
+
+#   * format: copy, ogg, opus or mp3. Other formats may appear in the future -
+#   feel free to implement your preferred format.
+format			vorbis
+
+# Ogg parameters:
+#   * quality <quality>: The quality parameter of oggenc. See man oggenc for
+#     more info. This is the only mode supported and planned. Still, if you want
+#     to be able to use bitrate settings, feel free to fork and file a pull
+#     request.
+quality			1
+
+# Optional parameters:
+#   * normalize <yes>/<no>: Normalize output files.
+normalize		yes
+
+#   * rename <string>: Destination files will be named according to <string>,
+#     after expansion of special strings:
+#       %{album},
+#       %{albumartist},
+#       %{artist},
+#       %{disc},
+#       %{genre},
+#       %{releasecountry},
+#       %{title},
+#       %{track},
+#       %{year}.
+#     Untagged files or files in unrecognized formats will not be changed.
+rename			%{genre}/%{albumartist}/%{year}-%{album}-%{releasecountry}/%{disc}%{track}--%{artist}-%{title}
+
+#   * fat32compat <yes>/<no>: Rename files for compatibility with FAT32
+#     filesystems.
+fat32compat		yes
+
+#   * ascii-only <yes>/<no>: Rename files for compatibility with ASCII-only
+#     systems.
+ascii-only		no
 
 # you should not skip or copy application/octet-stream, they could be something
 # similar to "Audio file with ID3 version 2.4.0, unsynchronized frames"
-copy_mime-type	image/*
-copy_mime-type	text/*
+
+#   * skip_mime-type <mime-type>: Files with mime-type <mime-type> will not
+#     be included in that destination. For more than one mime-type, use multiple
+#     times, as needed. The '*' character is a wildcard.
+skip_mime-type		inode/x-empty
+skip_mime-type		audio/midi
+skip_mime-type		image/*
+skip_mime-type		text/*
+skip_mime-type		application/pdf
+skip_mime-type		application/javascript*
+skip_mime-type		very short file (no magic)
+
+#   * copy_mime-type <mime-type>: Same as skip_mime-type, except that files
+#     matching will be copied as-is to the destination. E.g. image/* will copy
+#     covers and other images to the destination. In fact, AtOM will try to use
+#     hard links instead of copies.
+copy_mime-type		image/*
+
+#   * copy_extension <extension>: Copy files whose name and with ".<extension>"
+copy_extension		txt
+
+#   * channels <number>: Files with more than <number> channels will be
+#     downmixed. Useful if you create files for telephony music-on-hold.
+channels		2
+
+#   * frequency <hertz>: Files will be resampled as needed to <hertz>Hz
+#     sampling-rate. Shoutcast/Icecast streams require a constant sampling-rate.
+#     Telephony systems often require a sample rate of 8000Hz.
+frequency		44100
+
+#   * higher-than <bitrate>: Integer. Only reencode files with bitrates higher
+#     then <bitrate>kbps. This only applies if sample-rate, channel count and of
+#     course format are equal. If unset, only files with bitrates equal to that
+#     of the target will be copied (actually, hardlinking will be attempted
+#     first). As Ogg Vorbis target quality is not defined by its bitrate, Ogg
+#     Vorbis files will always be reencoded if unset.
+higher-than		200
 
 [Opus]
+enabled		1
 path		/mnt/Musique-opus
 format		opus
+
+# Opus parameters:
+#   * bitrate <bitrate>: Set (VBR) bitrate to <bitrate>. Note that while Opus
+#     allows for decimal values, AtOM does not. The reason for this is simple:
+#     we do numeric comparisons, and Bash only manipulates integers.
 bitrate		96
+
 normalize	yes
 frequency	48000
 copy_mime-type	image/*
 copy_mime-type	text/*
 
 [MP3]
-path		/mnt/Musique-mp3.test
+enabled		1
+path		/mnt/Musique-mp3
 format		mp3
+
+# MP3 parameters:
+#   * bitrate <bitrate>: Set ABR to <bitrate>. Again, if you want CBR or any
+#     other mode supported by lame, please fork and file a pull request.
 bitrate		96
+
+#   * noresample <yes>/<no>: LAME may decide to encode your file to a lower
+#     sampling-rate if you use a low bitrate. Setting this to yes will
+#     append --resample <original file's rate>, preventing any resampling from
+#     happening.
 noresample	yes
+
 normalize	yes
 higher-than	128
 
 # rename file, path unchanged
 rename		%{track}--%{artist}-%{title}
 # change the whole filepath
-#rename	%{genre}/%{albumartist}/%{year}-%{album}/%{track}--%{artist}-%{title}
+#rename	%{genre}/%{albumartist}/%{year}-%{album}-%{releasecountry}/%{track}--%{artist}-%{title}
 skip_mime-type	image/*
 skip_mime-type	text/*
 
 [asterisk]
+enabled		1
 path		/mnt/Musique-asterisk
 format		vorbis
 quality		0

lib/config/print

@@ -49,13 +49,13 @@ printConfig() {
 			EOF
 			[ -n "${destinationskipmime["$destination"]}" ]	\
 			&& echo " |Skipped mime-types|${destinationskipmime["$destination"]//\|/
-| | |}"
+| |}"
 			[ -n "${destinationcopymime["$destination"]}" ]	\
 			&& echo " |Copied mime-types|${destinationcopymime["$destination"]//\|/
-| | |}"
+| |}"
 			[ -n "${destinationcopyext["$destination"]}" ]	\
 			&& echo " |Copied extensions|${destinationcopyext["$destination"]//\|/
-| | |}"
+| |}"
 		done
 	}|column -t -s'|'
 }

lib/config/write

@@ -60,7 +60,7 @@ path			$sourcepath
 
 # Common parameters:
 #  Mandatory parameters:
-#   * enabled: Whether or not to treat this destination (1=tue/0=false)
+#   * enabled: Whether or not to treat this destination (1=true/0=false)
 enabled			1
 
 #   * path: Where files will be written
@@ -144,6 +144,7 @@ bitrate			${destinationquality["$destination"]}
 #       %{artist},
 #       %{disc},
 #       %{genre},
+#       %{releasecountry},
 #       %{title},
 #       %{track},
 #       %{year}.
@@ -207,8 +208,7 @@ bitrate			${destinationquality["$destination"]}
 		done
 		cat <<-EOCfg
 
-#   * copy_extension <extension>: Same as skip_extension, except that files
-#     matching will be copied as-is to the destination.
+#   * copy_extension <extension>: Copy files whose name and with ".<extension>"
 		EOCfg
 		destinationcopyext["$destination"]="${destinationcopyext["$destination"]}|"
 		while [[ ${destinationcopyext["$destination"]} =~ \| ]]

lib/database/checkVersion

@@ -1,5 +1,5 @@
-#!/bin/bash
-currentdbversion=3
+#!/usr/bin/env bash
+currentdbversion=6
 checkDatabaseVersion() {
 	local dbversion
 	if dbversion=$(Select atom version <<<"\"1\" = 1")

lib/database/open

@@ -1,5 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
 openDatabase() {
+	[[ -f "$database" ]] || populate_db=1
 	rm -f "$tempdir"/sqlite.{in,out}
 	mkfifo "$tempdir"/sqlite.{in,out}
 	sqlite3 -bail "$database"	\
@@ -13,7 +14,7 @@ openDatabase() {
 		exec 5>&3
 		exec 3> >(tee -a "$tempdir/debug.log" >&5)
 	fi
-	cat $schema >&3
+	(( populate_db )) && cat $schema >&3
 	echo '.separator ::AtOM:SQL:Sep::' >&3
 	echo 'PRAGMA foreign_keys = ON;' >&3
 	echo 'PRAGMA recursive_triggers = ON;' >&3

lib/database/upgradedatabase_1_2

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 upgradedatabase_1_2() {
 	local	data		\

lib/database/upgradedatabase_2_3

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 upgradedatabase_2_3() {
 	local	data		\
@@ -11,4 +11,4 @@ upgradedatabase_2_3() {
         Update destinations enabled 1 <<< "1 = 1"
 
         Update atom version 3 <<<"1 = 1"
-}
+}

lib/database/upgradedatabase_3_4

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+upgradedatabase_3_4() {
+        echo "Upgrading database to version 4... (backup is $database.bak_v3)"
+        cp "$database" "$database.bak_v3"
+        echo 'ALTER TABLE tags ADD COLUMN releasecountry TEXT;' >&3
+
+        Update atom version 4 <<<"1 = 1"
+}

lib/database/upgradedatabase_4_5

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+upgradedatabase_4_5() {
+	echo "Upgrading database to version 5... (backup is $database.bak_v4)"
+	cp "$database" "$database.bak_v4"
+	echo 'DROP TRIGGER force_destination_update_on_tag_update;' >&3
+	echo '
+		CREATE TRIGGER IF NOT EXISTS force_destination_update_on_tag_update
+		AFTER UPDATE OF
+			genre,
+			albumartist,
+			year,
+			album,
+			disc,
+			artist,
+			track,
+			title,
+			composer,
+			performer,
+			releasecountry,
+			rate,
+			channels,
+			bitrate,
+			depth
+		ON tags
+		BEGIN
+			UPDATE destination_files SET last_change=0
+			WHERE source_file_id=old.source_file;
+		END;
+	' >&3
+
+	Update atom version 5 <<<"1 = 1"
+}

lib/database/upgradedatabase_5_6

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+upgradedatabase_5_6() {
+	echo "Upgrading database to version 6... (backup is $database.bak_v5)"
+	cp "$database" "$database.bak_v5"
+	echo '
+		ALTER TABLE tags ADD COLUMN replaygain_alb TEXT;
+		ALTER TABLE tags ADD COLUMN replaygain_trk TEXT;
+		DROP TRIGGER force_destination_update_on_tag_update;
+		CREATE TRIGGER IF NOT EXISTS force_destination_update_on_tag_update
+		AFTER UPDATE OF
+			genre,
+			albumartist,
+			year,
+			album,
+			disc,
+			artist,
+			track,
+			title,
+			composer,
+			performer,
+			releasecountry,
+			replaygain_alb,
+			replaygain_trk,
+			rate,
+			channels,
+			bitrate,
+			depth
+		ON tags
+		BEGIN
+			UPDATE destination_files SET last_change=0
+			WHERE source_file_id=old.source_file;
+		END;
+	' >&3
+
+	Update atom version 6 <<<"1 = 1"
+}

lib/decode/sox

@@ -26,7 +26,7 @@ decodeSox() {
 		commandline+=(-c ${destinationchannels["$destination"]})
 		soxoptions_out+=" -c ${destinationchannels["$destination"]}"
 	fi
-	if (( ${bitdepth:-0} > 16 ))
+	if (( ${depth:-0} > 16 ))
 	then
 		commandline+=(-b 16)
 		soxoptions_out+=" -b 16"

lib/encode/mp3

@@ -1,6 +1,6 @@
-#!/bin/bash
+#!/usr/bin/env bash
 encodeFile::mp3() {
-	lameopts=(${ionice}lame --quiet)
+	lameopts=(${ionice}lame --quiet --noreplaygain)
 	lameopts+=(-v --abr ${destinationquality[$destination]})
 	[ -n "$album"	] && lameopts+=(--tl "$album" )
 	[ -n "$artist"	] && lameopts+=(--ta "$artist")
@@ -11,6 +11,12 @@ encodeFile::mp3() {
 	[ -n "$albumartist" ] && lameopts+=(--tv TPE2="$albumartist")
 	[ -n "$composer" ] && lameopts+=(--tv TCOM="$composer")
 	[ -n "$performer" ] && lameopts+=(--tv TOPE="$performer")
+	[ -n "$releasecountry" ] \
+		&& lameopts+=(--tv TXXX="MusicBrainz Album Release Country=$releasecountry")
+	[ -n "$replaygain_alb" ] \
+		&& lameopts+=(--tv "TXXX=REPLAYGAIN_ALBUM_GAIN=$replaygain_alb")
+	[ -n "$replaygain_trk" ] \
+		&& lameopts+=(--tv "TXXX=REPLAYGAIN_TRACK_GAIN=$replaygain_trk")
 	[ -n "$disc"	] && lameopts+=(--tv TPOS="$disc")
 	if (( ${destinationnoresample[$destination]:-0} == 1 ))
 	then

lib/encode/opus

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 encodeFile::opus() {
 	opusencopts=(${ionice}opusenc --quiet)
 	opusencopts+=(--bitrate ${destinationquality[$destination]})
@@ -11,6 +11,14 @@ encodeFile::opus() {
 	[ -n "$disc"	] && opusencopts+=(--comment "DISCNUMBER=$disc")
 	[ -n "$genre"	] && opusencopts+=(--comment "GENRE=$genre")
 	[ -n "$performer" ] && opusencopts+=(--comment "PERFORMER=$performer")
+	[ -n "$releasecountry" ] \
+		&& opusencopts+=(--comment "RELEASECOUNTRY=$releasecountry")
+	[ -n "$replaygain_alb" ] 					\
+		&& opusencopts+=(--comment)				\
+		&& opusencopts+=("REPLAYGAIN_ALBUM_GAIN=$replaygain_alb")
+	[ -n "$replaygain_trk" ] 					\
+		&& opusencopts+=(--comment)				\
+		&& opusencopts+=("REPLAYGAIN_TRACK_GAIN=$replaygain_trk")
 	[ -n "$title"	] && opusencopts+=(--title "$title")
 	[ -n "$track"	] && opusencopts+=(--comment "TRACKNUMBER=${track%/*}")
 	[ -n "${track#*/}" ] && opusencopts+=(--comment "TRACKTOTAL=${track#*/}")

lib/encode/vorbis

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 encodeFile::vorbis() {
 	oggencopts=(${ionice}oggenc -Q -q ${destinationquality[$destination]})
 	[ -n "$albumartist" ] && oggencopts+=(-c "ALBUMARTIST=$albumartist")
@@ -8,6 +8,12 @@ encodeFile::vorbis() {
 	[ -n "$disc"	] && oggencopts+=(-c "DISCNUMBER=$disc")
 	[ -n "$genre"	] && oggencopts+=(-G "$genre")
 	[ -n "$performer" ] && oggencopts+=(-c "PERFORMER=$performer")
+	[ -n "$releasecountry" ] \
+		&& oggencopts+=(-c "RELEASECOUNTRY=$releasecountry")
+	[ -n "$replaygain_alb" ] \
+		&& oggencopts+=(-c "REPLAYGAIN_ALBUM_GAIN=$replaygain_alb")
+	[ -n "$replaygain_trk" ] \
+		&& oggencopts+=(-c "REPLAYGAIN_TRACK_GAIN=$replaygain_trk")
 	[ -n "$title"	] && oggencopts+=(-t "$title")
 	[ -n "$track"	] && oggencopts+=(-N "$track")
 	[ -n "$year"	] && oggencopts+=(-d "$year")

lib/files/getDestDir

@@ -10,6 +10,10 @@ getDestDir() {
 			[[ ${destinationrenamepath[$destination]} ==	\
 				*?([^[])%\{albumartist\}?([^\]])* ]]	\
 			&& [ -n "$albumartist" ]
+		) || (
+			[[ ${destinationrenamepath[$destination]} ==	\
+				*?([^[])%\{releasecountry\}?([^\]])* ]]		\
+			&& [ -n "$releasecountry" ]
 		) || (
 			[[ ${destinationrenamepath[$destination]} ==	\
 				*?([^[])%\{artist\}?([^\]])* ]]		\
@@ -44,6 +48,8 @@ getDestDir() {
 			read -r -u${toascii[0]} album
 			echo "$albumartist" >&${toascii[1]}
 			read -r -u${toascii[0]} albumartist
+			echo "$releasecountry" >&${toascii[1]}
+			read -r -u${toascii[0]} releasecountry
 			echo "$artist" >&${toascii[1]}
 			read -r -u${toascii[0]} artist
 			echo "$genre" >&${toascii[1]}
@@ -61,6 +67,8 @@ getDestDir() {
 		destdir+="${destinationrenamepath[$destination]//?(\[)%\{album\}?(\])/$replace}"
 		replace=$(sanitizeFile "$albumartist" dir)
 		destdir="${destdir//?(\[)%\{albumartist\}?(\])/$replace}"
+		replace=$(sanitizeFile "$releasecountry" dir)
+		destdir="${destdir//?(\[)%\{releasecountry\}?(\])/$releasecountry}"
 		replace=$(sanitizeFile "$artist" dir)
 		destdir="${destdir//?(\[)%\{artist\}?(\])/$replace}"
 		replace=$(sanitizeFile "$genre" dir)
@@ -86,7 +94,8 @@ getDestDir() {
 				echo "$thispart" >&${toascii[1]}
 				read -r -u${toascii[0]} thispart
 			fi
-			destdir+="/$(sanitizeFile "$thispart" dir)"
+			sanitized="$(sanitizeFile "$thispart" dir)"
+			destdir+="${sanitized:+/}$sanitized"
 			part=${part#*/}
 		done
 	fi

lib/files/getDestFile

@@ -10,6 +10,10 @@ getDestFile() {
 			[[ ${destinationrename[$destination]} ==	\
 				*?([^[])%\{albumartist\}?([^\]])* ]]	\
 			&& [ -n "$albumartist" ]
+		) || (
+			[[ ${destinationrenamepath[$destination]} ==	\
+				*?([^[])%\{releasecountry\}?([^\]])* ]]		\
+			&& [ -n "$releasecountry" ]
 		) || (
 			[[ ${destinationrename[$destination]} ==	\
 				*?([^[])%\{artist\}?([^\]])* ]]		\
@@ -39,6 +43,7 @@ getDestFile() {
 	then
 		destfile="${destinationrename[$destination]//?(\[)%\{album\}?(\])/$album}"
 		destfile="${destfile//?(\[)%\{albumartist\}?(\])/$albumartist}"
+		destfile="${destfile//?(\[)%\{releasecountry\}?(\])/$releasecountry}"
 		destfile="${destfile//?(\[)%\{artist\}?(\])/$artist}"
 		destfile="${destfile//?(\[)%\{genre\}?(\])/$genre}"
 		destfile="${destfile//?(\[)%\{title\}?(\])/$title}"

lib/files/getFiles

@@ -1,6 +1,6 @@
 #!/bin/bash
 getFiles() {
-	scantime=$(date +%s)
+	scantime=$EPOCHSECONDS
 	for prune_expression in "${skippeddirectories[@]}"
 	do
 		prunes+=( -path "$sourcepath$prune_expression" -prune -o )

lib/setup/destination

@@ -251,6 +251,7 @@ setupDestination() {
                 %{artist},
                 %{disc},
                 %{genre},
+		%{releasecountry},
                 %{title},
                 %{track},
                 %{year}.
@@ -387,16 +388,16 @@ setupDestination() {
 			copiedmimes+=("${destinationcopymime["$destination"]%%|*}")
 			destinationcopymime["$destination"]="${destinationcopymime["$destination"]#*|}"
 		done
-		[ -n "${destinationcopymime["$destination"]}" ]			\
+		[ -n "${destinationcopymime["$destination"]}" ]		\
 		&& copiedmimes+=("${destinationcopymime["$destination"]}")
 		count=${#copiedmimes[@]}
 		unset destinationcopymime["$destination"]
 		for (( i=0 ; 1 ; i++ ))
 		do
-			read							\
-				-e						\
+			read						\
+				-e					\
 				${copiedmimes[i]+-i"${copiedmimes[i]}"}	\
-				-p 'Copy mime-type: '				\
+				-p 'Copy mime-type: '			\
 				value
 			if [ -n "$value" ]
 			then
@@ -409,6 +410,44 @@ setupDestination() {
 			fi
 		done
 		unset copiedmimes
+
+		cat <<-EODesc
+
+		Copy extensions (extension, string):
+		    Files with extension <extension> will be copied as-is to the
+		    destination. E.g. .jpg will copy covers and other images to the
+		    destination.
+
+		    This prompt will loop until an empty string is encountered.
+		EODesc
+		while [[ ${destinationcopyext["$destination"]} =~ \| ]]
+		do
+			copiedexts+=("${destinationcopyext["$destination"]%%|*}")
+			destinationcopyext["$destination"]="${destinationcopyext["$destination"]#*|}"
+		done
+		[ -n "${destinationcopyext["$destination"]}" ]		\
+		&& copiedexts+=("${destinationcopyext["$destination"]}")
+		count=${#copiedexts[@]}
+		unset destinationcopyext["$destination"]
+		for (( i=0 ; 1 ; i++ ))
+		do
+			read						\
+				-e					\
+				${copiedexts[i]+-i"${copiedexts[i]}"}	\
+				-p 'Copy extension: '			\
+				value
+			if [ -n "$value" ]
+			then
+				destinationcopyext[$destination]="${destinationcopyext[$destination]:+${destinationcopyext[$destination]}|}$value"
+			elif (( i < count ))
+			then
+				continue
+			else
+				break
+			fi
+		done
+		unset copiedexts
+
 		cat <<-EODesc
 
 		Channels (integer):

lib/setup/setup

@@ -24,6 +24,7 @@ Completion is available for prompts asking for a paths or filenames.
 		destinationchannels	\
 		destinationfat32compat	\
 		destinationcopymime	\
+		destinationcopyext	\
 		destinationformat	\
 		destinationfrequency	\
 		destinationid		\
@@ -40,6 +41,7 @@ Completion is available for prompts asking for a paths or filenames.
 		destinationchannels	\
 		destinationfat32compat	\
 		destinationcopymime	\
+		destinationcopyext	\
 		destinationformat	\
 		destinationfrequency	\
 		destinationid		\
@@ -74,7 +76,7 @@ Completion is available for prompts asking for a paths or filenames.
 			esac
 		;;
 	esac
-	read -p'Run now? [Y/n] ' do_run
+	read -p'Run index and conversion now? [Y/n] ' do_run
 	case $do_run in
 		n)	exit	;;
 		*)		;;

lib/tags/ffmpeg

@@ -1,55 +0,0 @@
-#!/bin/bash
-getInfosffmpeg_version='ffmpeg-6'
-tagreaders+=( "$getInfosffmpeg_version" )
-getInfos::ffmpeg() {
-	tagreader="$getInfosffmpeg_version"
-	local allinfos=$(
-		ffprobe -show_streams			\
-			-i "$sourcepath/$filename" 2>&1	\
-		|sed '
-			/^Input/,/.* Audio: /{s/ *: */=/}
-			s/^[[:space:]]*//
-			s/\0//g'
-	)
-	local metadata=$(
-		echo -e "$allinfos"			\
-		|sed -n '/Metadata=/,/\[STREAM\]/p'
-	)
-	local fmt_infos=$(
-		echo -e "$allinfos"				\
-		|sed -n						\
-		'/codec_type=audio/,/\[STREAM\]/{
-			/^\(sample_fmt\|sample_rate\|bit_rate\|channels\)=/{
-				p
-			}
-		}'
-	)
-	local infos="$metadata"
-	albumartist=$(gettag album_artist)
-	album=$(gettag album)
-	artist=$(gettag artist)
-	composer=$(gettag composer)
-	disc=$(gettag disc)
-	genre=$(gettag genre)
-	performer=$(gettag TOPE)
-	title=$(gettag title)
-	tracknum=$(gettag track)
-	year=$(gettag date)
-	expr='^[0-9]*$'
-	if [ -n "$genre" ] && [[ $genre =~ $expr ]]
-	then
-		genre="${id3genres[$genre]}"
-	fi
-	infos="$fmt_infos"
-	channels=$(gettag channels)
-	rate=$(gettag 'sample_rate')
-	bitrate=$(gettag 'bit_rate')
-	bitdepth=$(gettag 'sample_fmt')
-	bitdepth=${bitdepth//[A-z]/}
-	if [[ $bitrate == N/A ]]
-	then
-		unset bitrate
-	else
-		bitrate=$((bitrate / 1000))
-	fi
-}

lib/tags/flac

@@ -1,48 +0,0 @@
-#!/bin/bash
-getInfosFLAC_version='FLAC-3'
-tagreaders+=( "$getInfosFLAC_version" )
-getInfos::FLAC() {
-	tagreader="$getInfosFLAC_version"
-	infos=$(
-		metaflac			\
-			--show-tag=ALBUM	\
-			--show-tag=ALBUMARTIST	\
-			--show-tag=ARTIST	\
-			--show-tag=COMPOSER	\
-			--show-tag=DATE		\
-			--show-tag=DISCNUMBER	\
-			--show-tag=GENRE	\
-			--show-tag=PERFORMER	\
-			--show-tag=TITLE	\
-			--show-tag=TRACKNUMBER	\
-			--show-tag=TRACKTOTAL	\
-			"$sourcepath/$filename"
-	)
-	albumartist=$(gettag albumartist)
-	album=$(gettag album)
-	artist=$(gettag artist)
-	composer=$(gettag composer)
-	disc=$(gettag discnumber)
-	genre=$(gettag genre)
-	performer=$(gettag performer)
-	title=$(gettag title)
-	tracknum=$(gettag tracknumber)
-	tracktotal=$(gettag tracktotal)
-	year=$(gettag date)
-	if [ -n "$tracknum" -a -n "$tracktotal" ]
-	then
-		tracknum="$tracknum/$tracktotal"
-	fi
-	year=$(gettag DATE)
-	{
-		read rate
-		read channels
-		read bitdepth
-	} < <(
-		metaflac			\
-			--show-sample-rate	\
-			--show-channels		\
-			--show-bps		\
-			"$sourcepath/$filename"
-	)
-}

lib/tags/getInfos::FLAC

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+getInfosFLAC_version='FLAC-5'
+tagreaders+=( "$getInfosFLAC_version" )
+getInfos::FLAC() {
+	local			\
+		infos		\
+
+	tagreader="$getInfosFLAC_version"
+	infos=$(
+		metaflac					\
+			--show-sample-rate			\
+			--show-channels				\
+			--show-bps				\
+			--show-tag=ALBUM			\
+			--show-tag=ALBUMARTIST			\
+			--show-tag=ARTIST			\
+			--show-tag=COMPOSER			\
+			--show-tag=DATE				\
+			--show-tag=DISCNUMBER			\
+			--show-tag=GENRE			\
+			--show-tag=PERFORMER			\
+			--show-tag=RELEASECOUNTRY		\
+			--show-tag=REPLAYGAIN_ALBUM_GAIN	\
+			--show-tag=REPLAYGAIN_TRACK_GAIN	\
+			--show-tag=TITLE			\
+			--show-tag=TRACKNUMBER			\
+			--show-tag=TRACKTOTAL			\
+			"$sourcepath/$filename"
+	)
+	albumartist=$(gettag albumartist)
+	album=$(gettag album)
+	artist=$(gettag artist)
+	composer=$(gettag composer)
+	disc=$(gettag discnumber)
+	genre=$(gettag genre)
+	performer=$(gettag performer)
+	releasecountry=$(gettag releasecountry)
+	replaygain_alb=$(gettag replaygain_album_gain)
+	replaygain_trk=$(gettag replaygain_track_gain)
+	title=$(gettag title)
+	tracknum=$(gettag tracknumber)
+	tracktotal=$(gettag tracktotal)
+	year=$(gettag date)
+	if [ -n "$tracknum" -a -n "$tracktotal" ]
+	then
+		tracknum="$tracknum/$tracktotal"
+	fi
+	year=$(gettag DATE)
+	{
+		read rate
+		read channels
+		read depth
+	} <<<"$infos"
+}

lib/tags/getInfos::Opus

@@ -1,8 +1,11 @@
-#!/bin/bash
-getInfosOpus_version='Opus-2'
+#!/usr/bin/env bash
+getInfosOpus_version='Opus-4'
 tagreaders+=( "$getInfosOpus_version" )
 getInfos::Opus() {
 	tagreader="$getInfosOpus_version"
+	local			\
+		infos		\
+
 	infos=$(
 		opusinfo "$sourcepath/$filename"	\
 		| sed 's/\t//'
@@ -14,6 +17,9 @@ getInfos::Opus() {
 	disc=$(gettag discnumber)
 	genre=$(gettag genre)
 	performer=$(gettag performer)
+	releasecountry=$(gettag releasecountry)
+	replaygain_alb=$(gettag replaygain_album_gain)
+	replaygain_trk=$(gettag replaygain_track_gain)
 	title=$(gettag title)
 	tracknum=$(gettag tracknumber)
 	tracktotal=$(gettag tracktotal)
@@ -24,7 +30,9 @@ getInfos::Opus() {
 	year=$(gettag date)
 	infos="${infos//: /=}"
 	rate=$(gettag 'original sample rate'|head -n1)
+	rate=${rate% Hz}
 	channels=$(gettag channels|head -n1)
 	bitrate=$(gettag 'average bitrate')
+	bitrate=${bitrate%% kbit*}
 	bitrate=${bitrate%%.*}
 }

lib/tags/getInfos::ffmpeg

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+getInfosffmpeg_version='ffmpeg-9'
+tagreaders+=( "$getInfosffmpeg_version" )
+getInfos::ffmpeg() {
+	tagreader="$getInfosffmpeg_version"
+	local			\
+		infos		\
+
+	infos=$(
+		ffprobe -v error					\
+			-show_entries "					\
+				format_tags=				\
+					album_artist,			\
+					album,				\
+					artist,				\
+					composer,			\
+					disc,				\
+					genre,				\
+					TOPE,				\
+					releasecountry,			\
+					'MusicBrainz Album Release Country',\
+					title,				\
+					track,				\
+					date,				\
+					replaygain_track_gain,		\
+					replaygain_album_gain		\
+				:stream=				\
+					bit_rate,			\
+					channels,			\
+					sample_rate,			\
+				"					\
+			-of default=noprint_wrappers=1			\
+			-i "$sourcepath/$filename"			\
+		| egrep -v '=N/A$'
+	)
+	albumartist=$(gettag TAG:album_artist)
+	album=$(gettag TAG:album)
+	artist=$(gettag TAG:artist)
+	composer=$(gettag TAG:composer)
+	disc=$(gettag TAG:disc)
+	genre=$(gettag TAG:genre)
+	performer=$(gettag TAG:TOPE)
+	releasecountry=$(gettag TAG:releasecountry)
+	[[ -z "$releasecountry" ]]					\
+	&& releasecountry=$(gettag "TAG:MusicBrainz Album Release Country")
+	replaygain_alb=$(gettag TAG:replaygain_album_gain)
+	replaygain_trk=$(gettag TAG:replaygain_track_gain)
+	title=$(gettag TAG:title)
+	tracknum=$(gettag TAG:track)
+	year=$(gettag TAG:date)
+	expr='^[0-9]*$'
+	if [ -n "$genre" ] && [[ $genre =~ $expr ]]
+	then
+		genre="${id3genres[$genre]}"
+	fi
+	channels=$(gettag channels)
+	rate=$(gettag 'sample_rate')
+	case $rate in
+		96) rate=96000;;
+		48) rate=48000;;
+		441) rate=44100;;
+		32) rate=32000;;
+		24) rate=24000;;
+		225) rate=22500;;
+	esac
+	bitrate=$(gettag 'bit_rate')
+	depth=$(gettag 'sample_fmt')
+	depth=${depth//[A-z]/}
+	if [[ $bitrate == N/A ]]
+	then
+		unset bitrate
+	else
+		bitrate=$((bitrate / 1000))
+	fi
+}

lib/tags/getInfos::soxi

@@ -1,10 +1,14 @@
-#!/bin/bash
-getInfosSoxi_version='soxi-1'
+#!/usr/bin/env bash
+getInfosSoxi_version='soxi-3'
 tagreaders+=( "$getInfosSoxi_version" )
 getInfos::soxi() {
 	tagreader="$getInfosSoxi_version"
+	local			\
+		infos		\
+
 	infos=$(
-		soxi "$sourcepath/$filename"
+		soxi "$sourcepath/$filename"	\
+		| grep -v METADATA_BLOCK_PICTURE
 	)
 	albumartist=$(gettag albumartist)
 	album=$(gettag album)
@@ -13,6 +17,9 @@ getInfos::soxi() {
 	disc=$(gettag discnumber)
 	genre=$(gettag genre)
 	performer=$(gettag performer)
+	releasecountry=$(gettag releasecountry)
+	replaygain_alb=$(gettag replaygain_album_gain)
+	replaygain_trk=$(gettag replaygain_track_gain)
 	title=$(gettag title)
 	tracknum=$(gettag tracknumber)
 	tracktotal=$(gettag tracktotal)
@@ -27,6 +34,6 @@ getInfos::soxi() {
 	bitrate=$(gettag 'bit rate')
 	bitrate=${bitrate%k}
 	bitrate=${bitrate%%.*}
-	bitdepth=$(gettag precision)
-	bitdepth=${bitdepth%-bit}
+	depth=$(gettag precision)
+	depth=${depth%-bit}
 }

lib/tags/gettags

@@ -11,11 +11,15 @@ getTags() {
 			type=Opus
 			(( disableopusinfo )) && unset type
 		;;
+		'audio/ogg opus')
+			type=Opus
+			(( disableopusinfo )) && unset type
+		;;
 		application/ogg*)
 			type=soxi
 			(( disablesoxi )) && unset type
 		;;
-		audio/ogg)
+		audio/ogg*)
 			type=soxi
 			(( disablesoxi )) && unset type
 		;;

lib/tags/tryAPE

@@ -1,6 +0,0 @@
-#!/bin/bash
-tryAPE() {
-	grep -q 'APETAGEX'	\
-	"$sourcepath/$filename" \
-	&& type=APE
-}

lib/tags/update

@@ -1,5 +1,7 @@
-#!/bin/bash
+#!/usr/bin/env bash
 updateTags() {
+	local	reader			\
+
 	for reader in "${tagreaders[@]}"
 	do
 		tagreaderclause+="${tagreaderclause:+ AND }NOT tags.tagreader = \"$reader\""
@@ -18,6 +20,9 @@ updateTags() {
 			tags.disc,
 			tags.genre,
 			tags.performer,
+			tags.releasecountry,
+			tags.replaygain_alb,
+			tags.replaygain_trk,
 			tags.title,
 			tags.track,
 			tags.year,
@@ -81,6 +86,12 @@ echo '
 		rest=${rest#*::AtOM:SQL:Sep::}
 		oldperformer=${rest%%::AtOM:SQL:Sep::*}
 		rest=${rest#*::AtOM:SQL:Sep::}
+		oldreleasecountry=${rest%%::AtOM:SQL:Sep::*}
+		rest=${rest#*::AtOM:SQL:Sep::}
+		oldreplaygain_alb=${rest%%::AtOM:SQL:Sep::*}
+		rest=${rest#*::AtOM:SQL:Sep::}
+		oldreplaygain_trk=${rest%%::AtOM:SQL:Sep::*}
+		rest=${rest#*::AtOM:SQL:Sep::}
 		oldtitle=${rest%%::AtOM:SQL:Sep::*}
 		rest=${rest#*::AtOM:SQL:Sep::}
 		oldtrack=${rest%%::AtOM:SQL:Sep::*}
@@ -94,7 +105,7 @@ echo '
 		oldbitrate=${rest%%::AtOM:SQL:Sep::*}
 		((++count))
 		(( cron )) || echo -en "\rTags: $((count*100/filecount))%"
-		if (( count % 1000 == 0 ))
+		if (( count % 100 == 0 ))
 		then
 			echo 'COMMIT;BEGIN TRANSACTION;' >&3
 			(( debug ))					\
@@ -106,10 +117,13 @@ echo '
 			[[ $oldalbumartist != "$albumartist" ]]&&uaa=1
 			[[ $oldartist	!= "$artist"	]]&& uar=1
 			[[ $oldcomposer	!= "$composer"	]]&& uco=1
-			[[ $olddepth	!= "$bitdepth"	]]&& ude=1
+			[[ $olddepth	!= "$depth"	]]&& ude=1
 			[[ $olddisc	!= "$disc"	]]&& udi=1
 			[[ $oldgenre	!= "$genre"	]]&& uge=1
 			[[ $oldperformer != "$performer" ]]&& upe=1
+			[[ $oldreleasecountry != "$releasecountry" ]]&& urc=1
+			[[ $oldreplaygain_alb != "$replaygain_alb" ]]&& urpa=1
+			[[ $oldreplaygain_trk != "$replaygain_trk" ]]&& urpt=1
 			[[ $oldtitle	!= "$title"	]]&& uti=1
 			[[ $oldtrack	!= "$tracknum"	]]&& utr=1
 			[[ $oldyear	!= "$year"	]]&& uye=1
@@ -121,10 +135,13 @@ echo '
 			${uaa:+albumartist	"${albumartist:+::AtOM:FT::}${albumartist:-NULL}"}\
 			${uar:+artist		"${artist:+::AtOM:FT::}${artist:-NULL}"}\
 			${uco:+composer		"${composer:+::AtOM:FT::}${composer:-NULL}"}\
-			${ude:+depth		"${bitdepth:-NULL}"}	\
+			${ude:+depth		"${depth:-NULL}"}	\
 			${udi:+disc		"${disc:-NULL}"}	\
 			${uge:+genre		"${genre:-NULL}"}	\
 			${upe:+performer	"${performer:+::AtOM:FT::}${performer:-NULL}"}\
+			${urc:+releasecountry	"${releasecountry:+::AtOM:FT::}${releasecountry:-NULL}"}\
+			${urpa:+replaygain_alb	"${replaygain_alb:-NULL}"}\
+			${urpt:+replaygain_trk	"${replaygain_trk:-NULL}"}\
 			${uti:+title		"${title:+::AtOM:FT::}${title:-NULL}"}\
 			${utr:+track		"${track:+::AtOM:FT::}${tracknum:-NULL}"}\
 			${uye:+year		"${year:-NULL}"}	\
@@ -133,35 +150,58 @@ echo '
 			${uch:+channels		"${channels:-NULL}"}	\
 			${ubi:+bitrate		"${bitrate:-NULL}"}	\
 			tagreader		"$tagreader"		\
-		>/dev/null <<<"source_file = $sourcefileid"
-		unset	genre		\
-			albumartist	\
-			year		\
-			album		\
-			disc		\
-			artist		\
-			tracknum	\
-			title		\
-			composer	\
-			performer	\
-			rate		\
-			bitdepth	\
-			bitrate		\
-			channels	\
-			ual		\
-			uaa		\
-			uar		\
-			uco		\
-			ude		\
-			udi		\
-			uge		\
-			upe		\
-			uti		\
-			utr		\
-			uye		\
-			ura		\
-			uch		\
-			ubi
+			>/dev/null <<<"source_file = $sourcefileid"
+			unset	genre			\
+				albumartist		\
+				year			\
+				album			\
+				disc			\
+				artist			\
+				tracknum		\
+				title			\
+				composer		\
+				performer		\
+				releasecountry		\
+				replaygain_alb		\
+				replaygain_trk		\
+				rate			\
+				depth			\
+				bitrate			\
+				channels		\
+				oldgenre		\
+				oldalbumartist		\
+				oldyear			\
+				oldalbum		\
+				olddisc			\
+				oldartist		\
+				oldtracknum		\
+				oldtitle		\
+				oldcomposer		\
+				oldperformer		\
+				oldreleasecountry	\
+				oldreplaygain_alb	\
+				oldreplaygain_trk	\
+				oldrate			\
+				olddepth		\
+				oldbitrate		\
+				oldchannels		\
+				ual			\
+				uaa			\
+				uar			\
+				uco			\
+				ude			\
+				udi			\
+				uge			\
+				upe			\
+				urc			\
+				urpa			\
+				urpt			\
+				uti			\
+				utr			\
+				uye			\
+				ura			\
+				uch			\
+				ubi
 		fi
 	done
 	echo 'COMMIT;' >&3

lib/tools/sanityChecks

@@ -0,0 +1,166 @@
+#!/usr/bin/env bash
+
+sanityCheck() {
+	if [ ! -d "$tempdir" ] && ! mkdir -p "$tempdir"
+	then
+		echo "[FATAL] Could not create temp directory $tempdir" >&2
+		(( sanityfail++ ))
+	fi
+	if [ ! -f "$database" ] && [ ! -d "${database%/*}" ]	\
+	&& ! mkdir -p "${database%/*}"
+	then
+		echo "[FATAL] Directory holding database file does not exist"\
+		"and could not be created" >&2
+		(( sanityfail++ ))
+	fi
+	if [ ! -d "$sourcepath" ]
+	then
+		echo "[FATAL] Source path $sourcepath does not exist or is"\
+		"not a directory" >&2
+		(( sanityfail++ ))
+	fi
+	if ! which sed >/dev/null
+	then
+		echo "[FATAL] Required tool sed is not installed or not in PATH
+		I never thought this would actually hit someone..." >&2
+		(( sanityfail++ ))
+	fi
+	if ! which sox >/dev/null
+	then
+		echo "[FATAL] Required tool sox is not installed or not in"\
+		"PATH" >&2
+		(( sanityfail++ ))
+	fi
+	if ! which ogginfo >/dev/null
+	then
+		echo "[WARNING] Tool ogginfo (from vorbis-tools) is not"\
+		"installed or not in PATH
+		WebM metadata disabled" >&2
+		disableogginfo=1
+		(( sanitywarn++ ))
+	fi
+	if ! which soxi >/dev/null
+	then
+		echo "[WARNING] Tool soxi (from sox) is not"	\
+		"installed or not in PATH
+		Vorbis metadata disabled" >&2
+		disablesoxi=1
+		(( sanitywarn++ ))
+	fi
+	if (( oggencneeded )) && ! which oggenc >/dev/null
+	then
+		echo "[WARNING] Tool oggenc (from vorbis-tools) is not"	\
+		"installed or not in PATH
+		Vorbis targets disabled" >&2
+		disableoggenc=1
+		(( sanitywarn++ ))
+	fi
+	if ! which opusinfo >/dev/null
+	then
+		echo "[WARNING] Tool opusinfo (from opus-tools) is not"	\
+		"installed or not in PATH
+		Opus metadata disabled" >&2
+		disableopusinfo=1
+		(( sanitywarn++ ))
+	fi
+	if (( opusencneeded )) && ! which opusenc >/dev/null
+	then
+		echo "[WARNING] Tool opusenc (from opus-tools) is not"	\
+		"installed or not in PATH
+		Opus targets disabled" >&2
+		disableopusenc=1
+		(( sanitywarn++ ))
+	fi
+	if ! which opusdec >/dev/null
+	then
+		echo "[WARNING] Tool opusdec (from opus-tools) is not"	\
+		"installed or not in PATH
+		Opus support disabled" >&2
+		disableopusdec=1
+		(( sanitywarn++ ))
+	fi
+	if (( lameneeded )) && ! which lame >/dev/null
+	then
+		echo "[WARNING] Tool lame is not installed or not in PATH
+		MP3 targets disabled" >&2
+		disablelame=1
+		(( sanitywarn++ ))
+	fi
+	if ! which metaflac >/dev/null
+	then
+		echo "[WARNING] Tool metaflac (from FLAC) is not installed"\
+		"or not in PATH
+		FLAC metadata disabled" >&2
+		disableflac=1
+		(( sanitywarn++ ))
+	fi
+	if ! which mpcdec >/dev/null
+	then
+		echo "[WARNING] Tool mpcdec (from Musepack) is not"	\
+		"installed or not in PATH
+		Musepack support disabled" >&2
+		disablempcdec=1
+		(( sanitywarn++ ))
+	fi
+	if ! which mkvextract >/dev/null
+	then
+		echo "[WARNING] Tool mkvextract (from MKVToolNix) is not"\
+		"installed or not in PATH
+		WebM metadata disabled
+		WebM support disabled" >&2
+		disablemkvextract=1
+		(( sanitywarn++ ))
+	fi
+	if ! which ffprobe >/dev/null
+	then
+		echo "[WARNING] Tool ffprobe (from FFmpeg) is not installed"\
+		"or not in PATH
+		Video metadata disabled
+		MPEG metadata disabled
+		MusePack metadata disabled
+		Unknown format metadata disabled" >&2
+		disableffprobe=1
+		(( sanitywarn++ ))
+	fi
+	if ! which ffmpeg >/dev/null
+	then
+		echo "[WARNING] Tool ffmpeg is not installed or not in PATH
+		Video support disabled" >&2
+		disablevideo=1
+		(( sanitywarn++ ))
+	fi
+	if (( textunidecodeneeded )) && ! perl -MText::Unidecode -e 'exit;' 2>/dev/null
+	then
+		echo "[WARNING] Perl module Text::Unidecode is not available
+		Renaming to ASCII-only disabled" >&2
+		unset destinationascii
+		destinationascii=0
+		textunidecodeneeded=0
+		(( sanitywarn++ ))
+	fi
+	if (( sanityfail ))
+	then
+		echo "
+Sanity checks raised ${sanitywarn:-0} warnings, $sanityfail failures. Dying now." >&2
+		exit $ESANITY
+	elif (( sanitywarn ))
+	then
+		echo "
+Sanity checks raised $sanitywarn warnings... Hit Control-C to abort." >&2
+		if ! (( cron ))
+		then
+			timeout=$(( sanitywarn * 10 ))
+			echo -n "Starting in $(printf %3i $timeout)"	\
+				$'seconds...\b\b\b\b\b\b\b\b\b\b\b' >&2
+			while (( timeout ))
+			do
+				echo -n $'\b\b\b'"$(printf %3i $timeout)" >&2
+				sleep 1
+				(( timeout-- ))
+			done
+			echo -en "\r\033[K"
+		fi
+	fi
+}
+
+# vim:set ts=8 sw=8:

lib/workers/master

@@ -17,213 +17,224 @@ master() {
 			return 0
 		fi
 
-		echo '
-			SELECT	COUNT(*)
-			FROM	tasks
-			WHERE	status = 0
-			AND	requires IN (
-					SELECT	id
-					FROM	tasks
-					WHERE	status = 4
-				);
+		until (( active == concurrency || remaining == 0 ))
+		do
+			echo '
+				SELECT	COUNT(*)
+				FROM	tasks
+				WHERE	status = 0
+				AND	requires IN (
+						SELECT	id
+						FROM	tasks
+						WHERE	status = 4
+					);
 
-			SELECT
-				id,
-				source_file,
-				cmd_arg0,
-				cmd_arg1,
-				cmd_arg2,
-				cmd_arg3,
-				cmd_arg4,
-				cmd_arg5,
-				cmd_arg6,
-				cmd_arg7,
-				cmd_arg8,
-				cmd_arg9,
-				cmd_arg10,
-				cmd_arg11,
-				cmd_arg12,
-				cmd_arg13,
-				cmd_arg14,
-				cmd_arg15,
-				cmd_arg16,
-				cmd_arg17,
-				cmd_arg18,
-				cmd_arg19,
-				cmd_arg20,
-				cmd_arg21,
-				cmd_arg22,
-				cmd_arg23,
-				cmd_arg24,
-				cmd_arg25,
-				cmd_arg26,
-				cmd_arg27,
-				cmd_arg28,
-				cmd_arg29,
-				cmd_arg30,
-				cmd_arg31,
-				cmd_arg32,
-				cmd_arg33,
-				cmd_arg34,
-				cmd_arg35,
-				cmd_arg36,
-				cmd_arg37,
-				cmd_arg38,
-				cmd_arg39,
-				cmd_arg40,
-				cmd_arg41,
-				cmd_arg42,
-				cmd_arg43,
-				cmd_arg44,
-				cmd_arg45,
-				cmd_arg46,
-				cmd_arg47,
-				cmd_arg48,
-				cmd_arg49,
-				cmd_arg50,
-				cmd_arg51,
-				cmd_arg52,
-				cmd_arg53,
-				cmd_arg54,
-				cmd_arg55,
-				cmd_arg56,
-				cmd_arg57,
-				cmd_arg58,
-				cmd_arg59,
-				cleanup,
-				fileid,
-				filename
-			FROM	tasks
-			WHERE	status = 0
-			AND	requires IN (
-					SELECT	id
-					FROM	tasks
-					WHERE	status = 4
-					ORDER BY source_file
-					/* LIMIT 1 */
-				)
-			ORDER BY source_file
-			LIMIT 1;
-		'>&3
+				SELECT
+					id,
+					source_file,
+					cmd_arg0,
+					cmd_arg1,
+					cmd_arg2,
+					cmd_arg3,
+					cmd_arg4,
+					cmd_arg5,
+					cmd_arg6,
+					cmd_arg7,
+					cmd_arg8,
+					cmd_arg9,
+					cmd_arg10,
+					cmd_arg11,
+					cmd_arg12,
+					cmd_arg13,
+					cmd_arg14,
+					cmd_arg15,
+					cmd_arg16,
+					cmd_arg17,
+					cmd_arg18,
+					cmd_arg19,
+					cmd_arg20,
+					cmd_arg21,
+					cmd_arg22,
+					cmd_arg23,
+					cmd_arg24,
+					cmd_arg25,
+					cmd_arg26,
+					cmd_arg27,
+					cmd_arg28,
+					cmd_arg29,
+					cmd_arg30,
+					cmd_arg31,
+					cmd_arg32,
+					cmd_arg33,
+					cmd_arg34,
+					cmd_arg35,
+					cmd_arg36,
+					cmd_arg37,
+					cmd_arg38,
+					cmd_arg39,
+					cmd_arg40,
+					cmd_arg41,
+					cmd_arg42,
+					cmd_arg43,
+					cmd_arg44,
+					cmd_arg45,
+					cmd_arg46,
+					cmd_arg47,
+					cmd_arg48,
+					cmd_arg49,
+					cmd_arg50,
+					cmd_arg51,
+					cmd_arg52,
+					cmd_arg53,
+					cmd_arg54,
+					cmd_arg55,
+					cmd_arg56,
+					cmd_arg57,
+					cmd_arg58,
+					cmd_arg59,
+					cleanup,
+					fileid,
+					filename
+				FROM	tasks
+				WHERE	status = 0
+				AND	requires IN (
+						SELECT	id
+						FROM	tasks
+						WHERE	status = 4
+						ORDER BY source_file
+						/* LIMIT 1 */
+					)
+				ORDER BY source_file
+				LIMIT 1;
+			'>&3
 
-		read -u4 ready
-		if (( ready > 0 ))
-		then
-			createworker
-			return 0
-		fi
+			read -u4 ready
+			if (( ready > 0 ))
+			then
+				createworker
+				continue
+			fi
 
-		echo '
-			SELECT	COUNT(*)
-			FROM	tasks
-			WHERE	status = 0
-			AND	requires is NULL;
+			echo '
+				SELECT	COUNT(*)
+				FROM	tasks
+				WHERE	status = 0
+				AND	requires is NULL;
 
-			SELECT
-				id,
-				source_file,
-				cmd_arg0,
-				cmd_arg1,
-				cmd_arg2,
-				cmd_arg3,
-				cmd_arg4,
-				cmd_arg5,
-				cmd_arg6,
-				cmd_arg7,
-				cmd_arg8,
-				cmd_arg9,
-				cmd_arg10,
-				cmd_arg11,
-				cmd_arg12,
-				cmd_arg13,
-				cmd_arg14,
-				cmd_arg15,
-				cmd_arg16,
-				cmd_arg17,
-				cmd_arg18,
-				cmd_arg19,
-				cmd_arg20,
-				cmd_arg21,
-				cmd_arg22,
-				cmd_arg23,
-				cmd_arg24,
-				cmd_arg25,
-				cmd_arg26,
-				cmd_arg27,
-				cmd_arg28,
-				cmd_arg29,
-				cmd_arg30,
-				cmd_arg31,
-				cmd_arg32,
-				cmd_arg33,
-				cmd_arg34,
-				cmd_arg35,
-				cmd_arg36,
-				cmd_arg37,
-				cmd_arg38,
-				cmd_arg39,
-				cmd_arg40,
-				cmd_arg41,
-				cmd_arg42,
-				cmd_arg43,
-				cmd_arg44,
-				cmd_arg45,
-				cmd_arg46,
-				cmd_arg47,
-				cmd_arg48,
-				cmd_arg49,
-				cmd_arg50,
-				cmd_arg51,
-				cmd_arg52,
-				cmd_arg53,
-				cmd_arg54,
-				cmd_arg55,
-				cmd_arg56,
-				cmd_arg57,
-				cmd_arg58,
-				cmd_arg59,
-				cleanup,
-				fileid,
-				filename
-			FROM	tasks
-			WHERE	status = 0
-			AND	requires is NULL
-			ORDER BY source_file
-			LIMIT 1;
-		' >&3
+				SELECT
+					id,
+					source_file,
+					cmd_arg0,
+					cmd_arg1,
+					cmd_arg2,
+					cmd_arg3,
+					cmd_arg4,
+					cmd_arg5,
+					cmd_arg6,
+					cmd_arg7,
+					cmd_arg8,
+					cmd_arg9,
+					cmd_arg10,
+					cmd_arg11,
+					cmd_arg12,
+					cmd_arg13,
+					cmd_arg14,
+					cmd_arg15,
+					cmd_arg16,
+					cmd_arg17,
+					cmd_arg18,
+					cmd_arg19,
+					cmd_arg20,
+					cmd_arg21,
+					cmd_arg22,
+					cmd_arg23,
+					cmd_arg24,
+					cmd_arg25,
+					cmd_arg26,
+					cmd_arg27,
+					cmd_arg28,
+					cmd_arg29,
+					cmd_arg30,
+					cmd_arg31,
+					cmd_arg32,
+					cmd_arg33,
+					cmd_arg34,
+					cmd_arg35,
+					cmd_arg36,
+					cmd_arg37,
+					cmd_arg38,
+					cmd_arg39,
+					cmd_arg40,
+					cmd_arg41,
+					cmd_arg42,
+					cmd_arg43,
+					cmd_arg44,
+					cmd_arg45,
+					cmd_arg46,
+					cmd_arg47,
+					cmd_arg48,
+					cmd_arg49,
+					cmd_arg50,
+					cmd_arg51,
+					cmd_arg52,
+					cmd_arg53,
+					cmd_arg54,
+					cmd_arg55,
+					cmd_arg56,
+					cmd_arg57,
+					cmd_arg58,
+					cmd_arg59,
+					cleanup,
+					fileid,
+					filename
+				FROM	tasks
+				WHERE	status = 0
+				AND	requires is NULL
+				ORDER BY source_file
+				LIMIT 1;
+			' >&3
 
-		read -u4 ready
+			read -u4 ready
 
-		if (( active == 0 && ready == 0 ))
-		then
-			dumpfile="$tempdir/tasks-$(date -Iseconds).csv"
-			cat <<-EOF
+			if (( active == 0 && ready == 0 ))
+			then
+				dumpfile="$tempdir/tasks-$(date -Iseconds).csv"
+				cat <<-EOF
 
 
-			$remaining TASKS LEFT, NONE READY!
+				$remaining TASKS LEFT, NONE READY!
 
-			Something went wrong, dumping tasks table to $dumpfile
-			EOF
-			cat >&3 <<-EOSQL
-			.mode csv
-			.headers on
-			.output $dumpfile
-			SELECT * from tasks;
-			.mode list
-			.headers off
-			.output stdout
-			COMMIT;
-			EOSQL
-			closeDatabase
-			echo "Waiting for children to come back home..."
-			wait
-			echo $'\nGood luck!'
-			exit 1
-		elif (( ready == 0 ))
-		then
-			sleep 0.1
-		else
-			createworker
-		fi
+				Something went wrong, dumping tasks table to $dumpfile
+				EOF
+				cat >&3 <<-EOSQL
+				.mode csv
+				.headers on
+				.output $dumpfile
+				SELECT * from tasks;
+				.mode list
+				.headers off
+				.output stdout
+				COMMIT;
+				EOSQL
+				closeDatabase
+				echo "Waiting for children to come back home..."
+				wait
+				echo $'\nGood luck!'
+				exit 1
+			elif (( ready == 0 ))
+			then
+				sleep 0.1
+				break
+			else
+				createworker
+			fi
+			echo '
+				SELECT	COUNT(*)
+				FROM	tasks
+				WHERE	status = 0;
+			'>&3
+
+			read -u4 remaining
+		done
 	fi
 }

lib/xdg/migrate

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# https://specifications.freedesktop.org/basedir-spec/latest/
+
+xdgUpdateData() {
+	local -r programname=AtOM
+	local -r my_data_home="${XDG_DATA_HOME:-$HOME/.local/share}/$programname"
+	local -r new_db_path="$my_data_home/atom.db"
+
+	[[ -d "$my_data_home" ]] || mkdir -p "$my_data_home"
+	mv "$1" "$new_db_path"
+	echo "$new_db_path"
+}
+
+xdgUpdateRuntime() {
+	local -r programname=AtOM					\
+		my_runtime_dir="${XDG_RUNTIME_DIR:-/tmp}"		\
+
+	echo "$my_runtime_dir/$programname"
+}
+
+xdgMigrate() {
+	local -r programname=AtOM
+	local -r my_config_home="${XDG_CONFIG_HOME:-$HOME/.config}/$programname"
+	local new_database
+
+	cffile="$HOME/.atom/atom.cfg"
+	getConfig
+	new_database=$(xdgUpdateData "$database")
+	database="$new_database"
+	tempdir=$(xdgUpdateRuntime)
+	cffile="$my_config_home/atom.cfg"
+	[[ -d "$my_config_home" ]] || mkdir -p "$my_config_home"
+	writeConfig >"$cffile"
+}

share/schema.sql

@@ -58,6 +58,9 @@ CREATE TABLE IF NOT EXISTS tags (
 	title		TEXT,
 	composer	TEXT,
 	performer	TEXT,
+	releasecountry	TEXT,
+	replaygain_alb	TEXT,
+	replaygain_trk	TEXT,
 	depth		INTEGER,
 	rate		INTEGER,
 	channels	INTEGER,
@@ -129,10 +132,13 @@ CREATE TRIGGER IF NOT EXISTS force_destination_update_on_tag_update
 		title,
 		composer,
 		performer,
+		releasecountry,
+		replaygain_alb,
+		replaygain_trk,
 		rate,
 		channels,
 		bitrate,
-		bitdepth
+		depth
 	ON tags
 BEGIN
 	UPDATE destination_files SET last_change=0

toys/checkextensions

@@ -23,16 +23,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
 LC_ALL=C
 
 shopt -s extglob
@@ -42,6 +41,15 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 while getopts 'urnD' opt
 do
 	case $opt in
@@ -54,6 +62,7 @@ done
 
 getConfig
 
+sanityCheck
 openDatabase
 
 (( update )) && getFiles

toys/checkgenre

@@ -23,16 +23,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
 LC_ALL=C
 
 shopt -s extglob
@@ -42,6 +41,15 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 while getopts 'D' opt
 do
 	case $opt in
@@ -50,7 +58,7 @@ do
 done
 
 getConfig
-
+sanityCheck
 openDatabase
 
 sourcepath=''

toys/checkmissing

@@ -23,16 +23,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
 LC_ALL=C
 
 shopt -s extglob
@@ -42,6 +41,15 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 while getopts 'Dr' opt
 do
 	case $opt in
@@ -51,7 +59,7 @@ do
 done
 
 getConfig
-
+sanityCheck
 openDatabase
 
 echo 'SELECT id,filename FROM destination_files WHERE filename IS NOT NULL;' >&3

toys/cleandestinations

@@ -23,16 +23,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
 LC_ALL=C
 
 shopt -s extglob
@@ -42,6 +41,15 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 while getopts 'rD' opt
 do
 	case $opt in
@@ -51,7 +59,7 @@ do
 done
 
 getConfig
-
+sanityCheck
 openDatabase
 
 checkwanted() {

toys/createindex

@@ -25,28 +25,35 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
-
 LC_ALL=C
 
 shopt -s extglob
 
-source ./share/id3genres
+source "$SHAREDIR"/id3genres
 
 for function in "$LIBDIR"/*/*
 do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 args="$@"
 while [ -n "$1" ]
 do
@@ -66,6 +73,7 @@ do
 		'-M')	show+=(types)		;;
 		'-N')	show+=(tracktotals)	;;
 		'-p')	show+=(performers)	;;
+		'-r')	show+=(releasecountries)	;;
 		'-s')	show+=(rates)		;;
 		'-S')	show+=(size)
 			length[count]=5		;;
@@ -114,6 +122,7 @@ done
 	    -d Disc
 	    -g Genre
 	    -p Performer
+	    -r Release Country
 	    -N Track total
 	    -t Title
 	    -y Year
@@ -130,7 +139,7 @@ done
 }
 
 getConfig
-
+sanityCheck
 openDatabase
 
 columns="${show[@]//*/-}"
@@ -273,17 +282,17 @@ fi
 
 cat <<-EOBrag
 	# Generated by AtOM's createindex toy.
-	# https://gitorious.org/atom
-	# (C) 2012-2013 Vincent Riquer (GPL-3)
+	# https://framagit.org/atom/AtOM/
+	# (C) 2012-2025 Vincent Riquer (GPL-3)
 	# 
 	# $0 $args
 	#
-	# Last database update: $(date -d @$lastupdate +'%x %X')
+	# Last database update: $(printf "%(%x %X)T" "$lastupdate")
 
 EOBrag
 
 printDate() {
-	date -d"@$1" +"${timeformat:-%x %X}"
+	printf "%("${timeformat:-%x %X}")T" "$1"
 }
 
 for index in ${!show[@]}
@@ -305,6 +314,7 @@ do
 		oldtimestamp)	info='Last modified'	;;
 		types)		info='Format'		;;
 		performers)	info='Performer'	;;
+		releasecountries)	info='Country'		;;
 		rates)		info='Sample rate'	;;
 		titles)		info='Title'		;;
 		tracktotals)	info='Track total'	;;
@@ -338,6 +348,7 @@ SELECT
 	tags.disc,
 	tags.genre,
 	tags.performer,
+	tags.releasecountry,
 	tags.title,
 	tags.track,
 	tags.year,
@@ -396,6 +407,8 @@ do
 	rest="${rest#*::AtOM:SQL:Sep::}"
 	performer="${rest%%::AtOM:SQL:Sep::*}"
 	rest="${rest#*::AtOM:SQL:Sep::}"
+	releasecountry="${rest%%::AtOM:SQL:Sep::*}"
+	rest="${rest#*::AtOM:SQL:Sep::}"
 	title="${rest%%::AtOM:SQL:Sep::*}"
 	rest="${rest#*::AtOM:SQL:Sep::}"
 	track="${rest%%::AtOM:SQL:Sep::*}"
@@ -523,6 +536,13 @@ do
 			[ -n "$performer" ]	\
 			&& performers+="${performers+,}$performer"
 		fi
+		if ! [[ $releasecountries =~ $expr1"$releasecountry"$expr2 ]]
+		then
+			[ -z "$releasecountries" ]	\
+				&& unset releasecountries
+			[ -n "$releasecountry" ]	\
+			&& releasecountries+="${releasecountries+,}$releasecountry"
+		fi
 		if ! [[ $titles =~ $expr1"$title"$expr2 ]]
 		then
 			[ -z "$titles" ]	\
@@ -549,10 +569,10 @@ do
 		then
 			printline
 		fi
-		unset bitrates
+		unset bitrates depths rates
 		channelss="$channels"
-		rates="$rate"
-		depths="$depth"
+		(( rate )) && rates="$rate"
+		(( depth )) && depths="$depth"
 		types="$type"
 		albumartists="$albumartist"
 		albums="$album"
@@ -561,6 +581,7 @@ do
 		discs="$disc"
 		genres="$genre"
 		performers="$performer"
+		releasecountries="$releasecountry"
 		titles="$title"
 		tracktotals="$tracktotal"
 		years="$year"

toys/lowquality

@@ -23,16 +23,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
 LC_ALL=C
 
 shopt -s extglob
@@ -42,6 +41,15 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 while getopts 'fm:o:p:*:uD' opt
 do
 	case $opt in
@@ -67,7 +75,7 @@ do
 done
 
 getConfig
-
+sanityCheck
 openDatabase
 
 if (( update ))

toys/missingtags

@@ -24,16 +24,15 @@ declare -A			\
 }
 
 declare -r				\
-	DOCDIR=./doc			\
-	LIBDIR=./lib			\
-	SHAREDIR=./share
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
 declare -r				\
 	exampleconf=$DOCDIR/example.cfg	\
 	schema=$SHAREDIR/schema.sql	\
 					\
 	oldIFS="$IFS"
 
-cffile="$HOME/.atom/atom.cfg"
 LC_ALL=C
 
 shopt -s extglob
@@ -43,6 +42,15 @@ do
 	source "$function"
 done
 
+if ! [[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg" ]]	\
+&& [[ -f "$HOME/.atom/atom.cfg" ]]
+then
+	echo	"Configuration found in legacy location $HOME/.atom/atom.cfg."\
+		"Migrating configuration and data to XDG standard"
+	xdgMigrate
+fi
+cffile="${XDG_CONFIG_HOME:-$HOME/.config}/AtOM/atom.cfg"
+
 while getopts 'AlacdgptnNyuD' opt
 do
 	case $opt in
@@ -86,7 +94,7 @@ done
 }
 
 getConfig
-
+sanityCheck
 openDatabase
 
 if (( update ))

transogg

@@ -1,503 +0,0 @@
-#!/bin/bash
-
-cat <<-EOF
-This script is buggy and may destroy data
-DON'T USE IT!
-
-AtOM will be a clean and safe rewrite of this dirty hack.
-
-I repeat: DON'T use this script.
-EOF
-exit
-
-source /etc/transogg.conf
-
-[ ! -d "$TEMPDIR" ] && mkdir -p "$TEMPDIR"
-
-# log errors
-exec 2> $TEMPDIR/debug-$$.log
-
-set -E
-
-MyPID=$$
-
-tty=$(who -m|awk '{print $2}')
-
-cleanup() {
-	pkill -t $tty find||true
-	unset files
-	export killed=1
-}
-
-export -f cleanup
-
-usage() {
-	cat <<-EOF
-	$0 [-D] [-n <instances>] [-F] [-s <source directory>] [-t <target directory>]
-
-	    -n <instances>: run <instances> simultaneous processes (overrides config
-	                    file)
-	    -l <max load>: Don't start transcoding if the load average reaches <max
-	                   load>
-	    -T <time>: time before raising instance number again after reaching max
-	               load
-	    -F: ignore any existing timestamp file (useful if you change target
-	        quality)
-	    -D: increase debug level (produces potentially huge log files in
-	        $TEMPDIR)
-	    -c <conf-file>: Alternate configuration file
-	EOF
-}
-
-trap cleanup 1 2 15 EXIT
-
-declare -i DEBUG=0
-
-while getopts 'l:FhiDs:t:T:c:' opt
-do
-	case $opt in
-		s) ORIGDIR=$OPTARG ;;
-		t) DESTDIR=$OPTARG ;;
-		l) TARGETLOAD=$OPTARG
-		;;
-		F) rm -f "$TIMESTAMP"
-		;;
-		h) usage ; exit 0 ;;
-		T) LOADTIME=$OPTARG ;;
-		D) DEBUG+=1; set -x ;;
-		c) source "$OPTARG" ;;
-		*) exit 127
-		;;
-	esac
-done
-
-(( DEBUG >= 2 )) && set -v
-
-COLUMNS=$(tput cols)
-LINES=$(tput lines)
-trap 'COLUMNS=$(tput cols) LINES=$(tput lines)' WINCH
-declare -a children
-declare -i filenum=0
-declare -i lastid=-1
-FIFO=/tmp/transogg-$UID-$MyPID-status
-IDFIFO=/tmp/transogg-$UID-$MyPID-finished
-shopt -s extglob
-declare -i lastINSTchange=0
-((instances = TARGETLOAD / 2))
-
-[ -d "$TEMPDIR" ] \
-		|| mkdir -p "$TEMPDIR" \
-		|| exit 1
-
-[ -d "$DESTDIR" ] \
-		|| mkdir -p "$DESTDIR" \
-		|| exit 1
-
-[ -f "$TIMESTAMP" ] \
-		|| touch -t 197001010100 "$TIMESTAMP"
-
-case $FORMAT in
-	ogg)
-		function encode {
-			nice -n $NICENESS ionice -c3 \
-				oggenc \
-				-Q \
-				-a "${artist:-?}" \
-				-l "${album:-?}" \
-				-N "${tracknum}${tracktotal/#//}" \
-				-t "${title:-$(basename "$1")}" \
-				-q $QUALITY \
-				-d "$year" \
-				-G "$genre" \
-				-c DISCNUMBER="$disc" \
-				-o "$2" \
-				$tmpfile \
-				2> /dev/null
-		}
-	;;
-	mp3)
-		function encode {
-			nice -n $NICENESS ionice -c3 \
-				lame \
-				--quiet \
-				--ta "${artist:-?}" \
-				--tl "${album:-?}" \
-				--tn "${tracknum}${tracktotal/#//}" \
-				--tt "${title:-$(basename "$1")}" \
-				-v \
-				--abr $BITRATE \
-				--ty "$year" \
-				--tg "$genre" \
-				$tmpfile \
-				"$2" \
-				2> /dev/null
-		}
-	;;
-	*)
-		exit 127
-	;;
-esac
-
-gettag() {
-	echo -e "$1" \
-		 | egrep -i '^'${2}= \
-		 | cut -d = -f 2
-}
-
-mpc_info() {
-	infos=$(ionice -c3 \
-			 strings "$1" \
-			 | egrep -A1 'artist|album|title|track|year|genre')
-	title=$(echo -e "$infos"|sed -n /title/I {n;p})
-	artist=$(echo -e "$infos"|sed -n /artist/I {n;p})
-	track=$(echo -e "$infos"|sed -n /track/I {n;p})
-	album=$(echo -e "$infos"|sed -n /album/I {n;p})
-	year=$(echo -e "$infos"|sed -n /year/I {n;p})
-	genre=$(echo -e "$infos"|sed -n /genre/I {n;p})
-	unset infos
-}
-
-flac_info() {
-	infos=$(ionice -c3 \
-			 metaflac \
-			 --show-tag=TITLE \
-			 --show-tag=ARTIST \
-			 --show-tag=ALBUM \
-			 --show-tag=TRACKNUMBER \
-			 --show-tag=TRACKTOTAL \
-			 --show-tag=DATE \
-			 --show-tag=DISCNUMBER \
-			 --show-tag=GENRE \
-			 "$1")
-
-	artist=$(gettag "$infos" artist)
-
-	album=$(gettag "$infos" album)
-
-	title=$(gettag "$infos" title)
-
-	tracknum=$(gettag "$infos" tracknumber)
-
-	tracktotal=$(gettag "$infos" tracktotal)
-
-	year=$(gettag "$infos" date)
-
-	disc=$(gettag "$infos" discnumber)
-
-	genre=$(gettag "$infos" genre)
-
-	unset infos
-}
-
-function vorbis_info {
-	infos=$(ionice -c3 ogginfo "$1" | sed 's/^\t//')
-
-    artist=$(gettag "$infos" artist)
-
-    album=$(gettag "$infos" album)
-    
-    title=$(gettag "$infos" title)
-    
-    tracknum=$(gettag "$infos" tracknumber)
-
-	tracktotal=$(gettag "$infos" tracktotal)
-
-	year=$(gettag "$infos" date)
-
-	disc=$(gettag "$infos" discnumber)
-
-	genre=$(gettag "$infos" genre)
-
-	unset infos
-}
-
-function mp3_info {
-	infos=$(ionice -c3 mp3info -p 'artist=%a
-album=%l
-title=%t
-tracknum=%n
-year=%y
-genre=%g' "$1" | iconv -f $ID3CHARSET -t utf-8//TRANSLIT)
-    artist=$(gettag "$infos" artist|iconv -t utf-8)
-    album=$(gettag "$infos" album|iconv -t utf-8)
-    title=$(gettag "$infos" title|iconv -t utf-8)
-    tracknum=$(gettag "$infos" tracknum|iconv -t utf-8)
-	year=$(gettag "$infos" year)
-	genre=$(gettag "$infos" genre)
-
-	unset infos
-}
-
-function get_info {
-    case "$(file "$1")" in
-				   *Musepack*)
-					   mpc_info "$1"
-					   ;;
-				   *MPEG*)
-					   mp3_info "$1"
-					   ;;
-				   *MP3*)
-					   mp3_info "$1"
-					   ;;
-				   *Vorbis*)
-					   vorbis_info "$1"
-					   ;;
-				   *FLAC*)
-					   flac_info "$1"
-					   ;;
-				   *)
-					   :
-					   ;;
-    esac
-}
-
-function theRealSox {
-	echo "$1: $2 → $3" >&2
-    get_info "$2" 2>/dev/null
-    tmpfile="$TEMPDIR"/transogg-$UID-$(date +%Y%m%d%H%M%S%N).wav
-    nice -n $NICENESS ionice -c3 \
-			sox \
-			--norm \
-			--single-threaded "$2" \
-			-r ${RATE:=44100} \
-			-c ${CHANNELS:=2} \
-			--temp $TEMPDIR \
-			$tmpfile \
-			> /dev/null || true
-    encode "$2" "$3" || true
-	rm -f $tmpfile
-    unset artist album tracknum tracktotal title year genre tmpfile
-	until echo $1 >> $IDFIFO
-	do
-		sleep 1
-	done
-}
-
-function CleanIdFile {
-	while read curid
-	do
-		if (( lastid + 1 == $curid ))
-		then
-			if [ -n "${files[$curid]}" ]
-			then
-				touch -r "$ORIGDIR/${files[$curid]}" "$TIMESTAMP"
-			fi
-			sed -n -i "/^$curid$/d;p" $IDFIFO
-			lastid=$curid
-		fi
-		unset children[$curid]
-		echo -n '' > $FIFO
-		for processInd in ${!children[@]}
-		do
-			echo ${children[$processInd]} >> $FIFO
-		done
-		echo $filenum $instances $TARGETLOAD $message
-	done < <(sort -n $IDFIFO)
-}
-
-function MySox {
-	load=$(sed 's/^\([0-9]\+\)[. ].*/\1/' /proc/loadavg)
-	if (( load > TARGETLOAD && instances > 1 && $(date +%s) - lastINSTchange >= LOADTIME))
-	then
-		((instances -= 1))
-		if ((instances < 1))
-		then
-			instances=1
-		fi
-		lastINSTchange=$(date +%s)
-		echo $filenum $instances $TARGETLOAD $message
-	elif (( load < TARGETLOAD && $(date +%s) - lastINSTchange >= LOADTIME))
-	then
-		((instances += 1))
-		lastINSTchange=$(date +%s)
-		echo $filenum $instances $TARGETLOAD $message
-	fi
-	CleanIdFile
-	until [ ${#children[@]} -lt $instances ]
-	do
-		load=$(sed 's/^\([0-9]\+\)[. ].*/\1/' /proc/loadavg)
-		if (( load > TARGETLOAD && instances > 1 && $(date +%s) - lastINSTchange >= LOADTIME))
-		then
-			((instances -= 1))
-			if ((instances < 1))
-			then
-				instances=1
-			fi
-			lastINSTchange=$(date +%s)
-			echo $filenum $instances $TARGETLOAD $message
-		elif (( load < TARGETLOAD && $(date +%s) - lastINSTchange >= LOADTIME))
-		then
-			((instances += 1))
-			lastINSTchange=$(date +%s)
-			echo $filenum $instances $TARGETLOAD $message
-		fi
-		CleanIdFile
-		read -t 0.5 -n 1 load_change||true
-		case $load_change in
-			+) ((TARGETLOAD += 1))
-			   echo $filenum $instances $TARGETLOAD $message
-			   ;;
-			-) ((TARGETLOAD -= 1))
-			   echo $filenum $instances $TARGETLOAD $message
-			   ;;
-			q) cleanup
-			   message=Exiting...
-			   echo $filenum $instances $TARGETLOAD $message
-			   ;;
-		esac
-		if ((instances < 1))
-		then
-			instances=1
-			echo $filenum $instances $TARGETLOAD $message
-		fi
-		unset message
-	done
-	theRealSox $filenum "$1" "$2" 2>>$TEMPDIR/debug-$MyPID-theRealSox &
-	children[$filenum]="${1#$ORIGDIR/}"
-}
-
-function FileDisappeared {
-	dialog --yes-label "Continue" \
-		--no-label "Rescan" \
-		--yesno "File $1 disappeared!" \
-		$LINES $COLUMNS
-}
-
-function FindFiles {
-	cd "$ORIGDIR" || {
-		echo "Could not cd into $ORIGDIR"
-		exit 1
-	}
-	cd -
-	readarray -t files < <(find "$ORIGDIR"/ \
-		-newer "$TIMESTAMP" \
-		-type f \
-		-printf "%TY%Tm%Td%TH%TM.%TS %P\n" \
-		| grep -v .timestamp \
-		| tee >(dialog --output-fd 1 --progressbox "Looking for new files..." \
-			$LINES $COLUMNS) \
-		| sort \
-		| sed 's/^[^ ]* //' )
-}
-
-function ShowProgress {
-	while read filenum concurrency targetload message
-	do
-		stamp=$(ls -go --time-style="+%d/%m/%Y %H:%M:%S" $TIMESTAMP | \
-			awk '{print $4 " " $5}')
-		if [ "$filenum" -gt 0 -a $nfiles -gt 0 ]
-		then
-			percent=$((${filenum:-${#files[@]}}*100/$nfiles))
-		else
-			percent=0
-		fi
-		echo XXX
-		echo $percent
-		echo "Position: ${filenum:-?} / $nfiles ($stamp) $message"
-		echo "$concurrency processes max. Target load: $targetload."
-		echo -e "(+/- to change, q to quit)\n"
-		sed 's/$/\n/' $FIFO
-		echo XXX
-	done \
-	| dialog \
-		--title "Transcoding files from $ORIGDIR to $DESTDIR..." \
-		--no-shadow \
-		--gauge "Transcoding files from $ORIGDIR to $DESTDIR..." \
-		$LINES $COLUMNS
-}
-
-function ProcessFiles {
-	lastINSTchange=$(date +%s)
-	for filenum in ${!files[@]}
-	do
-		filename=${files[$filenum]}
-		if [ -z "$filename" ]
-		then
-			break
-		fi
-		if [ ! -e "$ORIGDIR/$filename" ]
-		then
-			restart=1
-			return 0
-		fi
-		destfile="$DESTDIR/${filename%.*}.$FORMAT"
-		[ -d "${destfile%/?*}" ] || mkdir -p "${destfile%/?*}"
-		MySox "$ORIGDIR/$filename" "$destfile"
-		echo -n '' > $FIFO
-		for processInd in ${!children[@]}
-		do
-			echo ${children[$processInd]} >> $FIFO
-		done
-		echo $filenum $instances $TARGETLOAD $message
-		sleep 0.01
-	done
-	until [ ${#children[@]} -eq 0 ]
-	do
-		echo ${#files[@]} $instances $TARGETLOAD Finishing...
-		sleep 1
-		CleanIdFile
-	done
-	echo ${#files[@]} $instances $TARGETLOAD Done\!
-}
-
-function Work {
-	echo "Looking for new files..."
-	FindFiles 2>$TEMPDIR/debug-$MyPID-FindFiles
-
-	nfiles=${#files[@]}
-
-	ProcessFiles 2>$TEMPDIR/debug-$MyPID-ProcessFiles \
-	> >(ShowProgress 2>$TEMPDIR/debug-$MyPID-ShowProgress)
-	sleep 1
-	clear
-	if [ -n "$killed" ]
-	then
-		rm $FIFO $IDFIFO
-		exit 1
-	fi
-	while [ -n "$restart" ]
-	do
-		unset restart
-		if FileDisappeared
-		then
-			for indice in {0..$lastid}
-			do
-				unset files[$indice]
-			done
-			ProcessFiles 2>>$TEMPDIR/debug-$MyPID-ProcessFiles \
-			> >(ShowProgress 2>>$TEMPDIR/debug-$MyPID-ShowProgress)
-		else
-			Work
-		fi
-	done
-}
-
-Work
-rm $FIFO $IDFIFO
-
-set +x
-
-clear
-
-cd "$DESTDIR" || {
-	echo "Could not cd into $DESTDIR"
-	exit 1
-}
-(
-	echo "Obsolete files..."
-	find . -type f \
-		| grep -v .timestamp \
-		| grep -v 00-INDEX.txt \
-		| while read filename
-		do
-			if [ ! -e "$ORIGDIR/${filename%.$FORMAT}".* ]
-			then
-				echo "Deleting $filename..."
-				rm -f "$filename"
-			fi
-		done
-	cd "$DESTDIR"
-	cd "$OLDPWD"
-	echo -e "\nEmpty directories..."
-	find "$DESTDIR" -type d -empty -print -delete
-) | dialog --output-fd 1 --progressbox "Removing obsolete files..." $LINES $COLUMNS