Rsgain - Revision history

Complexlogic: Update for v3.5

2024-02-28T04:03:07Z

Update for v3.5

← Older revision		Revision as of 04:03, 28 February 2024
Line 5:		Line 5:
	\| developer = complexlogic		\| developer = complexlogic
	\| released = 2022-05-10		\| released = 2022-05-10
	\| stable_release = 3.3		\| stable_release = 3.5
	\| stable_release_date = ~~2023~~-04-23		\| stable_release_date = 2024-02-25
	\| operating_system = Windows, macOS, Linux, BSD		\| operating_system = Windows, macOS, Linux, BSD, Android
	\| use = ReplayGain tagging		\| use = ReplayGain tagging
	\| license = BSD license		\| license = BSD license
	\| website = [https://github.com/complexlogic/rsgain]		\| website = [https://github.com/complexlogic/rsgain]
	}}		}}
	'''rsgain''' ('''r'''eally '''s'''imple '''gain''') is a free and open source [[ReplayGain 2.0 specification\|ReplayGain 2.0]] tagging utility for Windows, macOS, and ~~Linux~~. rsgain applies loudness metadata tags to your files, while leaving the audio stream untouched. A [[ReplayGain#Players_support\|ReplayGain-compatible player]] will dynamically adjust the volume of your tagged files during playback.		'''rsgain''' ('''r'''eally '''s'''imple '''gain''') is a free and open source [[ReplayGain 2.0 specification\|ReplayGain 2.0]] tagging utility for Windows, macOS, Linux, BSD, and Android. rsgain applies loudness metadata tags to your files, while leaving the audio stream untouched. A [[ReplayGain#Players_support\|ReplayGain-compatible player]] will dynamically adjust the volume of your tagged files during playback.

	rsgain is designed with a "batteries included" philosophy, allowing a user to scan their entire music library without requiring external scripts or other tools. It aims to strike the perfect balance between power and simplicity by providing multiple user interfaces. See [[#usage\|Usage]] for more information.		rsgain is designed with a "batteries included" philosophy, allowing a user to scan their entire music library without requiring external scripts or other tools. It aims to strike the perfect balance between power and simplicity by providing multiple user interfaces. See [[#usage\|Usage]] for more information.
Line 54:		Line 54:
	* [[Wavpack]]		* [[Wavpack]]
	* [[Monkey's Audio]]		* [[Monkey's Audio]]
			* [[TAK]]

	==Usage==		==Usage==
Line 148:		Line 149:
	-L, --lowercase Write lowercase tags (MP2/MP3/MP4/WMA/WAV/AIFF).		-L, --lowercase Write lowercase tags (MP2/MP3/MP4/WMA/WAV/AIFF).
	This is non-standard but sometimes needed.		This is non-standard but sometimes needed.
	-I 3, --id3v2-version=3 Write ID3v2.3 tags to MP2/MP3/WAV/AIFF ~~(default)~~.		-I keep, --id3v2-version=keep Keep file's existing ID3v2 version, 3 if none exists (default).
			-I 3, --id3v2-version=3 Write ID3v2.3 tags to MP2/MP3/WAV/AIFF.
	-I 4, --id3v2-version=4 Write ID3v2.4 tags to MP2/MP3/WAV/AIFF.		-I 4, --id3v2-version=4 Write ID3v2.4 tags to MP2/MP3/WAV/AIFF.
	~~-I keep, --id3v2-version=keep Keep file's existing ID3v2 version, 3 if none exists.~~

	-o d, --opus-mode=d Write standard ReplayGain tags, clear header output gain (default).		-o d, --opus-mode=d Write standard ReplayGain tags, clear header output gain (default).
	-o r, --opus-mode=r Write R128_*_GAIN tags, clear header output gain.		-o r, --opus-mode=r Write R128_*_GAIN tags, clear header output gain.
			-o s, --opus-mode=s Same as 'r', plus override target loudness to -23 LUFS.
	-o t, --opus-mode=t Write track gain to header output gain.		-o t, --opus-mode=t Write track gain to header output gain.
	-o a, --opus-mode=a Write album gain to header output gain.		-o a, --opus-mode=a Write album gain to header output gain.
Line 159:		Line 161:
	-O, --output Output tab-delimited scan data to stdout.		-O, --output Output tab-delimited scan data to stdout.
	-O s, --output=s Output with sep header (needed for Microsoft Excel compatibility).		-O s, --output=s Output with sep header (needed for Microsoft Excel compatibility).
	.		-O a, --output=a Output with files sorted in alphanumeric order.
			-p, --preserve-mtimes Preserve file mtimes.
	-q, --quiet Don't print scanning status messages.		-q, --quiet Don't print scanning status messages.

	Please report any issues to https://github.com/complexlogic/rsgain/issues		Please report any issues to https://github.com/complexlogic/rsgain/issues

	</pre>		</pre>

Complexlogic at 15:43, 13 May 2023

2023-05-13T15:43:12Z

← Older revision		Revision as of 15:43, 13 May 2023
Line 5:		Line 5:
	\| developer = complexlogic		\| developer = complexlogic
	\| released = 2022-05-10		\| released = 2022-05-10
	\| stable_release = 3.~~1.1~~		\| stable_release = 3.3
	\| stable_release_date = ~~2022~~-11-15		\| stable_release_date = 2023-04-23
	\| operating_system = Windows, macOS, Linux, BSD		\| operating_system = Windows, macOS, Linux, BSD
	\| use = ReplayGain tagging		\| use = ReplayGain tagging
Line 62:		Line 62:
	rsgain's Easy Mode ''is'' that wrapper script; the functionality is built-in to the program. In Easy Mode, the user simply points the program to their library and it will be recursively scanned with all recommended settings enabled by default.		rsgain's Easy Mode ''is'' that wrapper script; the functionality is built-in to the program. In Easy Mode, the user simply points the program to their library and it will be recursively scanned with all recommended settings enabled by default.

	The legacy-style interface has been retained as "Custom Mode" for users that require a higher level of control.		The legacy-style interface has been retained as "Custom Mode" for users that require a higher level of control. Custom Mode is mostly used for scripting.

	===Easy Mode===		===Easy Mode===
	Easy Mode recursively scans your entire music library using the recommended settings for each file type. ~~You can use Easy Mode if the following conditions apply:~~		Easy Mode recursively scans your entire music library using the recommended settings for each file type. Easy Mode is invoked with the command {{code\|rsgain easy}} followed by the root of the directory you want to scan:
	* Your music library is organized by album, i.e. each album has its own folder
	* In each album folder, all audio files are of the same type. It is acceptable to have non-audio files mixed in such as log files or artwork, but if multiple ''audio'' file types are detected, the folder will not be scanned.

	Easy Mode is invoked with the command {{code\|rsgain easy}} followed by the root of the directory you want to scan~~, e.g.~~:

	{{code\|rsgain easy /path/to/music/library}}		{{code\|rsgain easy /path/to/music/library}}
Line 75:		Line 71:
	{{code\|rsgain easy "C:\path\to\music library"}}		{{code\|rsgain easy "C:\path\to\music library"}}

	~~This is all~~ that is ~~required~~ for ~~most users~~. ~~Advanced users should see~~ the [[#~~scan_presets~~\|Scan Presets]] section for more information about the ~~default settings and how to override them, if desired~~.		Easy Mode assumes that you have you have your music library organized by album, so that each album is contained in its own folder. The album gain calculations rely on this assumption. If you do not have your music library organized by album, you should disable the album tags because the calculated values will not be valid. rsgain ships with a scan preset which can disable the album tags for you; invoke it with {{code\|-p no_album}}. See the [[#Scan_Presets\|Scan Presets]] section for more information about how the scan preset feature works.

	====Multithreaded Scanning====		====Multithreaded Scanning====
Line 111:		Line 107:

	A preset is specified with the {{code\|-p}} option, followed by the path to a preset file ''or'' a preset name. A preset name is the filename of a preset without the directory or .ini file extension; rsgain will search the default preset location(s) for the file based on your platform:		A preset is specified with the {{code\|-p}} option, followed by the path to a preset file ''or'' a preset name. A preset name is the filename of a preset without the directory or .ini file extension; rsgain will search the default preset location(s) for the file based on your platform:
	* On Windows, the folder {{code\|presets}} in the same folder that contains {{code\|rsgain.exe}}		* On Windows, rsgain will search first in {{code\|%USERPROFILE%\.rsgain\presets}}, then the folder {{code\|presets}} in the same folder that contains {{code\|rsgain.exe}}
	* On Unix platforms, rsgain will search first in the user home directory: {{code\|~/Library/rsgain/presets}} on Mac and {{code\|~/.config/rsgain/presets}} on Linux (you need to create these directories if they don't already exist). If the requested preset name is not found in the home directory, rsgain will search {{code\|<install prefix>/share/rsgain/presets}}		* On Unix platforms, rsgain will search first in the user home directory: {{code\|~/Library/rsgain/presets}} on Mac and {{code\|~/.config/rsgain/presets}} on Linux (you need to create these directories if they don't already exist). If the requested preset name is not found in the home directory, rsgain will search {{code\|<install prefix>/share/rsgain/presets}}

Line 133:		Line 129:

	Options:		Options:
	-h, --help Show this help.		-h, --help Show this help.

	-a, --album Calculate album gain and peak.		-a, --album Calculate album gain and peak.
	-S, --skip-existing Don't scan files with existing ReplayGain information.		-S, --skip-existing Don't scan files with existing ReplayGain information.

	-s s, --tagmode=s Scan files but don't write ReplayGain tags (default).		-s s, --tagmode=s Scan files but don't write ReplayGain tags (default).
	-s d, --tagmode=d Delete ReplayGain tags from files.		-s d, --tagmode=d Delete ReplayGain tags from files.
	-s i, --tagmode=i Scan and write ReplayGain 2.0 tags to files.		-s i, --tagmode=i Scan and write ReplayGain 2.0 tags to files.

	-l n, --loudness=n Use n LUFS as target loudness (-30 ≤ n ≤ -5).		-l n, --loudness=n Use n LUFS as target loudness (-30 ≤ n ≤ -5).

	-c n, --clip-mode=n No clipping protection (default).		-c n, --clip-mode=n No clipping protection (default).
	-c p, --clip-mode=p Clipping protection enabled for positive gain values only.		-c p, --clip-mode=p Clipping protection enabled for positive gain values only.
	-c a, --clip-mode=a Clipping protection always enabled.		-c a, --clip-mode=a Clipping protection always enabled.
	-m n, --max-peak=n Use max peak level n dB for clipping protection.		-m n, --max-peak=n Use max peak level n dB for clipping protection.
	-t, --true-peak Use true peak for peak calculations.		-t, --true-peak Use true peak for peak calculations.

	-L, --lowercase Write lowercase tags (MP2/MP3/MP4/WMA/WAV/AIFF).		-L, --lowercase Write lowercase tags (MP2/MP3/MP4/WMA/WAV/AIFF).
	This is non-standard but sometimes needed.		This is non-standard but sometimes needed.
	-I 3, --id3v2-version=3 Write ID3v2.3 tags to MP2/MP3/WAV/AIFF (default).		-I 3, --id3v2-version=3 Write ID3v2.3 tags to MP2/MP3/WAV/AIFF (default).
	-I 4, --id3v2-version=4 Write ID3v2.4 tags to MP2/MP3/WAV/AIFF.		-I 4, --id3v2-version=4 Write ID3v2.4 tags to MP2/MP3/WAV/AIFF.
			-I keep, --id3v2-version=keep Keep file's existing ID3v2 version, 3 if none exists.

	-o d, --opus-mode=d Write standard ReplayGain tags, clear header output gain (default).		-o d, --opus-mode=d Write standard ReplayGain tags, clear header output gain (default).
	-o r, --opus-mode=r Write R128_*_GAIN tags, clear header output gain.		-o r, --opus-mode=r Write R128_*_GAIN tags, clear header output gain.
	-o t, --opus-mode=t Write track gain to header output gain.		-o t, --opus-mode=t Write track gain to header output gain.
	-o a, --opus-mode=a Write album gain to header output gain.		-o a, --opus-mode=a Write album gain to header output gain.

	-O, --output Output tab-delimited scan data to stdout.		-O, --output Output tab-delimited scan data to stdout.
	-q, --quiet Don't print scanning status messages.		-O s, --output=s Output with sep header (needed for Microsoft Excel compatibility).
			.
			-q, --quiet Don't print scanning status messages.

	Please report any issues to https://github.com/complexlogic/rsgain/issues		Please report any issues to https://github.com/complexlogic/rsgain/issues

	</pre>		</pre>

Complexlogic at 19:35, 4 December 2022

2022-12-04T19:35:09Z

← Older revision		Revision as of 19:35, 4 December 2022
Line 5:		Line 5:
	\| developer = complexlogic		\| developer = complexlogic
	\| released = 2022-05-10		\| released = 2022-05-10
	\| stable_release = 3.0		\| stable_release = 3.1.1
	\| stable_release_date = 2022-09-14		\| stable_release_date = 2022-11-15
	\| operating_system = Windows, macOS, Linux		\| operating_system = Windows, macOS, Linux, BSD
	\| use = ReplayGain tagging		\| use = ReplayGain tagging
	\| license = BSD license		\| license = BSD license
Line 15:		Line 15:

	rsgain is designed with a "batteries included" philosophy, allowing a user to scan their entire music library without requiring external scripts or other tools. It aims to strike the perfect balance between power and simplicity by providing multiple user interfaces. See [[#usage\|Usage]] for more information.		rsgain is designed with a "batteries included" philosophy, allowing a user to scan their entire music library without requiring external scripts or other tools. It aims to strike the perfect balance between power and simplicity by providing multiple user interfaces. See [[#usage\|Usage]] for more information.

			rsgain is the backend for the MusicBrainz Picard ReplayGain 2.0 plugin. Users that are not comfortable with command line interfaces may prefer this method since the plugin provides a GUI frontend to rsgain. See [[#MusicBrainz_Picard_Plugin\|MusicBrainz Picard Plugin]] for more information.

	==Installation==		==Installation==
Line 30:		Line 32:

	===Linux===		===Linux===
	An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on Debian Bullseye and later, Ubuntu 21.04 and later. There is also an [https://aur.archlinux.org/packages/rsgain-git AUR package] available for Arch/Manjaro users.		An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on Debian Bullseye and later, Ubuntu 21.04 and later. There is also a .rpm package for Fedora users. An [https://aur.archlinux.org/packages/rsgain-git AUR package] is available for Arch/Manjaro users.

	Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].		Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].

			===FreeBSD===
			Available via ports tree or using packages (2023Q1 and later) as listed below:
			{{code\|cd /usr/ports/audio/rsgain && make install clean}}
			{{code\|pkg install rsgain}}

	==Format Support==		==Format Support==
Line 42:		Line 49:
	* [[M4A]] ([[AAC]], [[ALAC]])		* [[M4A]] ([[AAC]], [[ALAC]])
	* [[WMA]]		* [[WMA]]
			* [[Musepack]]
	* [[WAV]]		* [[WAV]]
	* [[AIFF]]		* [[AIFF]]
Line 79:		Line 87:

	The speed gains offered by multithreaded scanning are significant. With {{code\|-m 4}} or higher, you can typically expect to see a 50-80% reduction in total scan time, depending on your hardware, settings, and library composition.		The speed gains offered by multithreaded scanning are significant. With {{code\|-m 4}} or higher, you can typically expect to see a 50-80% reduction in total scan time, depending on your hardware, settings, and library composition.

			====Skip Files with Existing Tags====
			rsgain has an option which will skip files with existing ReplayGain information, invoked by passing {{code\|-S}} or {{code\|--skip-existing}}. When enabled, rsgain will check whether the given file has a {{code\|REPLAYGAIN_TRACK_GAIN}} tag, and skip scanning any files that do. If album tags are enabled, the files in the list will be judged collectively, i.e. if a single file is missing ReplayGain info, then all of them will be scanned.

			This feature merely checks for the existence of the tags, and does not verify that the tags are complete, and are compatible with your current settings, e.g. target loudness. You should use this feature only if you are confident in the integrity of the files in the directory to be scanned. It's generally not a good idea to run this on files that you've recently download from the internet, which may have pre-existing ReplayGain information that was tagged by a different scanner.

	====Logging====		====Logging====
Line 123:		Line 136:

	-a, --album Calculate album gain and peak.		-a, --album Calculate album gain and peak.
			-S, --skip-existing Don't scan files with existing ReplayGain information.

	-s s, --tagmode=s Scan files but don't write ReplayGain tags (default).		-s s, --tagmode=s Scan files but don't write ReplayGain tags (default).
Line 150:		Line 164:

	Please report any issues to https://github.com/complexlogic/rsgain/issues		Please report any issues to https://github.com/complexlogic/rsgain/issues

	</pre>		</pre>

			===MusicBrainz Picard Plugin===
			[https://picard.musicbrainz.org/ MusicBrainz Picard] is a free, cross-platform music tagging application. Picard features a robust plugin ecosystem that greatly extends its functionality. rsgain serves as the backend for the ReplayGain 2.0 plugin, which is available from the official plugins repository. Users that prefer a graphical interface over a command line interface can use this plugin to scan their music library.

			To install the plugin, navigate to the Options menu in Picard. Select "Plugins" in the sidebar, then find "ReplayGain 2.0" and click the download button. The plugin itself does not include rsgain; you'll still need to download and install rsgain separately per the [[#installation\|Installation]] section for your chosen platform.

			You need to set the path to rsgain in the plugin settings. This field is pre-populated with the {{code\|rsgain}} command. On Unix platforms, programs are typically installed into a directory that's already in your {{code\|PATH}}, so no further action is necessary in that case. On Windows, you will need to either manually add the folder containing rsgain to your {{code\|Path}} as per the installation instructions, or use the exact path to {{code\|rsgain.exe}} in the plugin settings.

			To use the plugin, add files to Picard and associate them with a release (so the files are in the right window). The plugin can scan albums or individual tracks. Select one or more albums or tracks, then right click and select "Plugins->Calculate ReplayGain" from the context menu. This calculates the ReplayGain information for the selected items, but does not tag the files. The new tags are available for viewing in the metadata window at the bottom. Click the save button to write the new tags to file.

	==See also==		==See also==

Complexlogic: Fix grammar mistake

2022-09-18T16:14:09Z

Fix grammar mistake

← Older revision		Revision as of 16:14, 18 September 2022
Line 30:		Line 30:

	===Linux===		===Linux===
	An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on Debian Bullseye and later, Ubuntu 21.04 and later. There is also a [https://aur.archlinux.org/packages/rsgain-git AUR package] available for Arch/Manjaro users.		An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on Debian Bullseye and later, Ubuntu 21.04 and later. There is also an [https://aur.archlinux.org/packages/rsgain-git AUR package] available for Arch/Manjaro users.

	Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].		Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].

Complexlogic: Update for v3.0

2022-09-18T16:03:01Z

Update for v3.0

Show changes

Complexlogic at 19:36, 18 May 2022

2022-05-18T19:36:19Z

← Older revision		Revision as of 19:36, 18 May 2022
Line 79:		Line 79:
	The overrides file is an INI-formatted file that contains sections enclosed in square brackets which correspond to the available formats, and each section contains key=value pairs that correspond to settings. The overrides feature is intended for users that can't use the default settings of Easy Mode, but still prefer the functionality of Easy Mode over Custom Mode.		The overrides file is an INI-formatted file that contains sections enclosed in square brackets which correspond to the available formats, and each section contains key=value pairs that correspond to settings. The overrides feature is intended for users that can't use the default settings of Easy Mode, but still prefer the functionality of Easy Mode over Custom Mode.

	For example, ~~rsgain~~ writes lowercase tags on MP3 files by default, but suppose you want uppercase tags instead. Format your {{code\|overrides.ini}} file as follows:		For example, Easy Mode writes lowercase tags on MP3 files by default, but suppose you want uppercase tags instead. Format your {{code\|overrides.ini}} file as follows:

	<pre>		<pre>
Line 90:		Line 90:
	{{code\|rsgain easy -o /path/to/overrides.ini /path/to/music/library}}		{{code\|rsgain easy -o /path/to/overrides.ini /path/to/music/library}}

	A default {{code\|overrides.ini}} file ships with rsgain in the root package directory for Windows, and in {{code\|<install prefix>/share/rsgain}} for Unix. The file is pre-populated ~~will~~ all settings that are available to change. Note that this is an ''overrides'' file, not a configuration file, i.e any formats or settings you're not interested in can simply be deleted and the defaults will be used instead.		A default {{code\|overrides.ini}} file ships with rsgain in the root package directory for Windows, and in {{code\|<install prefix>/share/rsgain}} for Unix. The file is pre-populated with all settings that are available to change. Note that this is an ''overrides'' file, not a configuration file, i.e any formats or settings you're not interested in can simply be deleted and the defaults will be used instead.

	===Custom Mode===		===Custom Mode===

Complexlogic: Update for v2.0.1

2022-05-18T13:59:42Z

Update for v2.0.1

← Older revision		Revision as of 13:59, 18 May 2022
Line 5:		Line 5:
	\| developer = complexlogic		\| developer = complexlogic
	\| released = 2022-05-10		\| released = 2022-05-10
	\| stable_release = 2.0		\| stable_release = 2.0.1
	\| stable_release_date = 2022-05-10		\| stable_release_date = 2022-05-18
	\| operating_system = Windows, macOS, Linux		\| operating_system = Windows, macOS, Linux
	\| use = ReplayGain tagging		\| use = ReplayGain tagging
Line 12:		Line 12:
	\| website = [https://github.com/complexlogic/rsgain]		\| website = [https://github.com/complexlogic/rsgain]
	}}		}}
	'''rsgain''' ('''r'''eally '''s'''imple '''gain''') is a free and open source [[ReplayGain 2.0 specification\|ReplayGain 2]] tagging utility for Windows, macOS, and Linux. rsgain applies loudness metadata tags to your files, while leaving the audio stream untouched. A [[ReplayGain#Players_support\|ReplayGain-compatible player]] will dynamically adjust the volume of your tagged files during playback.		'''rsgain''' ('''r'''eally '''s'''imple '''gain''') is a free and open source [[ReplayGain 2.0 specification\|ReplayGain 2.0]] tagging utility for Windows, macOS, and Linux. rsgain applies loudness metadata tags to your files, while leaving the audio stream untouched. A [[ReplayGain#Players_support\|ReplayGain-compatible player]] will dynamically adjust the volume of your tagged files during playback.

	rsgain is a heavily modified fork of [[loudgain]]. The goal of rsgain is to take the excellent platform created by loudgain and simplify it for the average user, while also preserving the advanced features for users that need them. The following improvements have been made from loudgain:		rsgain is a heavily modified fork of [[loudgain]]. The goal of rsgain is to take the excellent platform created by loudgain and simplify it for the average user, while also preserving the advanced features for users that need them. The following improvements have been made from loudgain:
Line 25:		Line 25:
	rsgain is compatible with Windows 10 and later. Download the win64 .zip file from the [https://github.com/complexlogic/rsgain/releases/latest latest release on GitHub], and extract its contents to a directory of your choosing.		rsgain is compatible with Windows 10 and later. Download the win64 .zip file from the [https://github.com/complexlogic/rsgain/releases/latest latest release on GitHub], and extract its contents to a directory of your choosing.

	It is recommended to add the directory to your {{code\|Path}} system environment variable so you can invoke the program with the {{code\|rsgain}} command instead of ~~using~~ the ~~full~~ path to its .exe file. In the Windows taskbar search, type "env", then select "Edit the system environment variables". In the resulting window, click the "Environment variables" button. In the next window under "System variables", select "Path", then press Edit. Add the folder that you extracted {{code\|rsgain.exe}} to in the previous step.		It is recommended to add the directory to your {{code\|Path}} system environment variable so you can invoke the program with the {{code\|rsgain}} command instead of the path to its .exe file. In the Windows taskbar search, type "env", then select "Edit the system environment variables". In the resulting window, click the "Environment variables" button. In the next window under "System variables", select "Path", then press Edit. Add the folder that you extracted {{code\|rsgain.exe}} to in the previous step.

	===macOS===		===macOS===
Line 31:		Line 31:

	===Linux===		===Linux===
	An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on most APT-based distro releases from ~~2020~~ and later. There is also a [https://github.com/complexlogic/rsgain/blob/master/config/PKGBUILD PKGBUILD script] available for Arch/Manjaro users.		An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on most APT-based distro releases from 2021 and later. There is also a [https://github.com/complexlogic/rsgain/blob/master/config/PKGBUILD PKGBUILD script] available for Arch/Manjaro users.

	Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].		Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].
Line 145:		Line 145:
	* [[WMA]]		* [[WMA]]
	* [[WAV]]		* [[WAV]]
			* [[AIFF]]
	* [[Wavpack]]		* [[Wavpack]]
	* [[Monkey's Audio]]		* [[Monkey's Audio]]

Complexlogic at 05:37, 11 May 2022

2022-05-11T05:37:14Z

← Older revision		Revision as of 05:37, 11 May 2022
Line 1:		Line 1:
	{{Software Infobox		{{Software Infobox
	\| name = rsgain		\| name = rsgain
	\| screenshot = [[File:rsgain_help.png\|~~256px~~]]		\| screenshot = [[File:rsgain_help.png\|300px]]
	\| caption = Default help screen in a Linux terminal		\| caption = Default help screen in a Linux terminal
	\| developer = complexlogic		\| developer = complexlogic

Complexlogic: Page creation

2022-05-11T05:34:48Z

Page creation

New page

{{Software Infobox
| name = rsgain
| screenshot = [[File:rsgain_help.png|256px]]
| caption = Default help screen in a Linux terminal
| developer = complexlogic
| released = 2022-05-10
| stable_release = 2.0
| stable_release_date = 2022-05-10
| operating_system = Windows, macOS, Linux
| use = ReplayGain tagging
| license = BSD license
| website = [https://github.com/complexlogic/rsgain]
}}
'''rsgain''' ('''r'''eally '''s'''imple '''gain''') is a free and open source [[ReplayGain 2.0 specification|ReplayGain 2]] tagging utility for Windows, macOS, and Linux. rsgain applies loudness metadata tags to your files, while leaving the audio stream untouched. A [[ReplayGain#Players_support|ReplayGain-compatible player]] will dynamically adjust the volume of your tagged files during playback.

rsgain is a heavily modified fork of [[loudgain]]. The goal of rsgain is to take the excellent platform created by loudgain and simplify it for the average user, while also preserving the advanced features for users that need them. The following improvements have been made from loudgain:
* Native Windows support
* Built-in recursive directory scanning without the need for a wrapper script. See [[#Easy_Mode|Easy Mode]] for more details.
* Multithreaded scanning

==Installation==
rsgain is available in source form on all platforms, and executable form on some platforms.

===Windows===
rsgain is compatible with Windows 10 and later. Download the win64 .zip file from the [https://github.com/complexlogic/rsgain/releases/latest latest release on GitHub], and extract its contents to a directory of your choosing.

It is recommended to add the directory to your {{code|Path}} system environment variable so you can invoke the program with the {{code|rsgain}} command instead of using the full path to its .exe file. In the Windows taskbar search, type "env", then select "Edit the system environment variables". In the resulting window, click the "Environment variables" button. In the next window under "System variables", select "Path", then press Edit. Add the folder that you extracted {{code|rsgain.exe}} to in the previous step.

===macOS===
There is currently no binary package available for macOS, so Mac users will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].

===Linux===
An amd64 .deb package is provided on the [https://github.com/complexlogic/rsgain/releases/latest GitHub release page]. It is installable on most APT-based distro releases from 2020 and later. There is also a [https://github.com/complexlogic/rsgain/blob/master/config/PKGBUILD PKGBUILD script] available for Arch/Manjaro users.

Users of other distros will need to build from source. See the [https://github.com/complexlogic/rsgain/blob/master/docs/BUILDING.md#building build instructions on GitHub].

==Usage==
rsgain has two modes of operation: Easy Mode and Custom Mode. Easy Mode is recommended over Custom Mode for almost all use cases. Custom Mode exists to provides backwards compatibility with the legacy loudgain/mp3gain command line.

===Easy Mode===
Easy Mode recursively scans your entire music library using the recommended settings for each file type. You can use Easy Mode if the following conditions apply:
* Your music library is organized by album, i.e. each album has its own folder
* In each album folder, all audio files are of the same type. It is acceptable to have non-audio files mixed in such as log files or artwork, but if multiple ''audio'' file types are detected, the folder will not be scanned.

Easy Mode is invoked with the command {{code|rsgain easy}} followed by the root of the directory you want to scan, e.g.:

{{code|rsgain easy /path/to/music/library}}

{{code|rsgain easy "C:\path\to\music library"}}

This is all that is required for most users. Advanced users should see [[#Setting_Overrides|Setting Overrides]] for more information about the default settings and how to override them, if desired.

====Multithreaded Scanning====
Easy Mode includes optional multithreaded operation to speed up the duration of a scan. Use the {{code|-m}} option, followed by the number of threads to create. The number of threads must be one per physical CPU core or fewer. For example, if you have a quad core CPU:

{{code|rsgain easy -m 4 /path/to/music/library}}

The scan progress bar is automatically disabled in multithreaded operation because multiple files are being scanned in parallel.

The speed gains offered by multithreaded scanning are significant. With {{code|-m 4}} or higher, you can typically expect to see speed gains of 60-70%. However, you will also have close to 100% CPU utilization when scanning multithreaded. Consider using multithreaded on a full library scan, and the default single threaded mode when incrementally adding one or two albums to your library.

====Setting Overrides====
Easy Mode scans files with the following settings by default:
* Clipping protection enabled
* Lowercase tags for MP2/MP3, M4A, WMA, WAV, and AIFF (uppercase for all others)
* Decibal units
* All optional tags enabled:
** Range calculations
** Peak calcuations
** Reference loudness
** Album tags
* ID3 version 2.3 tags
* Strip obsolete ID3 version 1 tags
* -1 dBTP max true peak
* No pregain

These settings are recommended for maximum comptatibility with available players. However, if you need one of the settings changed, you can override them on a per-format basis using the {{code|-o}} option, and an overrides file.

The overrides file is an INI-formatted file that contains sections enclosed in square brackets which correspond to the available formats, and each section contains key=value pairs that correspond to settings. The overrides feature is intended for users that can't use the default settings of Easy Mode, but still prefer the functionality of Easy Mode over Custom Mode.

For example, rsgain writes lowercase tags on MP3 files by default, but suppose you want uppercase tags instead. Format your {{code|overrides.ini}} file as follows:

<pre>
[MP3]
Lowercase=false
</pre>

Then, pass the path to the overrides file with the {{code|-o}} option:

{{code|rsgain easy -o /path/to/overrides.ini /path/to/music/library}}

A default {{code|overrides.ini}} file ships with rsgain in the root package directory for Windows, and in {{code|<install prefix>/share/rsgain}} for Unix. The file is pre-populated will all settings that are available to change. Note that this is an ''overrides'' file, not a configuration file, i.e any formats or settings you're not interested in can simply be deleted and the defaults will be used instead.

===Custom Mode===
Custom Mode preserves loudgain's command line syntax for users that still need it. Unlike Easy Mode, Custom Mode works with files, not directories. If you want recursive directory-based scanning, you will need to use a wrapper script.

Custom Mode is invoked with {{code|rsgain custom}} followed by options and a list of files to scan. For example, scan all FLAC files in the current directory with album gain and clipping protection enabled:

{{code|rsgain custom -a -k -s e *.flac}}

See the command line help for all available options:

<pre>
Usage: rsgain custom [OPTIONS] FILES...
Custom Mode allows the user to specify the options to scan the files with. The
list of files to scan must be listed explicitly after the options.

Options:
-h, --help Show this help.

-r, --track Calculate track gain only (default).
-a, --album Calculate album gain (and track gain).

-c, --clip Ignore clipping warning.
-k, --noclip Lower track/album gain to avoid clipping (<= -1 dBTP).
-K n, --maxtpl=n Avoid clipping; max. true peak level = n dBTP.
-d n, --pregain=n Apply n dB/LU pre-gain value (-5 for -23 LUFS target).

-s d, --tagmode=d Delete ReplayGain tags from files.
-s i, --tagmode=i Write ReplayGain 2.0 tags to files.
-s e, --tagmode=e like '-s i', plus extra tags (reference, ranges).
-s l, --tagmode=l like '-s e', but LU units instead of dB.
-s s, --tagmode=s Don't write ReplayGain tags (default).

-L, --lowercase Force lowercase tags (MP2/MP3/MP4/WMA/WAV/AIFF).
This is non-standard but sometimes needed.
-S, --striptags Strip tag types other than ID3v2 from MP2/MP3.
Strip tag types other than APEv2 from WavPack/APE.
-I 3, --id3v2version=3 Write ID3v2.3 tags to MP2/MP3/WAV/AIFF.
-I 4, --id3v2version=4 Write ID3v2.4 tags to MP2/MP3/WAV/AIFF (default).

-O, --output Database-friendly tab-delimited list output.
-q, --quiet Don't print scanning status messages.

Please report any issues to https://github.com/complexlogic/rsgain/issues
</pre>

==Format Support==
rsgain has support for the following file formats:
* [[MP2]]/[[MP3]]
* [[FLAC]]
* [[Ogg]] ([[Vorbis]], [[Speex]])
* [[Opus]]
* [[M4A]] ([[AAC]], [[ALAC]])
* [[WMA]]
* [[WAV]]
* [[Wavpack]]
* [[Monkey's Audio]]

==See also==
* [[ReplayGain]]
* [[ReplayGain 2.0 specification]]

==External links==
* [https://github.com/complexlogic/rsgain/ rsgain GitHub page]
* [https://en.wikipedia.org/wiki/EBU_R_128 EBU R128]

[[Category:Software]]