Difference between revisions of "REACT"

From Hydrogenaudio Knowledgebase
Jump to: navigation, search
Line 9: Line 9:
 
REACT is configured using an INI file and config files.  The commands used within the config files are command line/DOS commands, with the addition of numerous variables which REACT makes available.  For example, any instance of '''@artist@''' in the script will be replaced by the [[freedb]] artist name, while '''$artist$''' will be replaced with a ''filename-friendly'' version of the artist name (with illegal characters replaced according to your requirements).
 
REACT is configured using an INI file and config files.  The commands used within the config files are command line/DOS commands, with the addition of numerous variables which REACT makes available.  For example, any instance of '''@artist@''' in the script will be replaced by the [[freedb]] artist name, while '''$artist$''' will be replaced with a ''filename-friendly'' version of the artist name (with illegal characters replaced according to your requirements).
  
'''From REACT version 2.1, most configuration can be done by editing the INI file only'''. Only advanced users should edit the .cfg files.
+
'''From REACT version 2.0 final, most configuration can be done by editing the INI file only'''. Only advanced users should edit the .cfg files.
  
 
==Hotkeys==
 
==Hotkeys==
Line 35: Line 35:
 
==Configuration Files==
 
==Configuration Files==
  
There are three configuration files in total; The INI file, one CFG file for ripping to audio track files, and one for ripping to an audio image with cuesheet. The config files are stored in the REACT folder, and are named:
+
There are three configuration files in total; The INI file, one CFG file for copying to audio track files, and one for copying to an audio image with cuesheet. The config files are stored in the REACT folder, and are named:
  
 
{| border="0" cellpadding="0" cellspacing="4"
 
{| border="0" cellpadding="0" cellspacing="4"
Line 49: Line 49:
  
 
==The REACT.INI File==
 
==The REACT.INI File==
 +
There are four sections in the REACT.ini file. The first [Settings] section has global definitions that REACT uses. The next three [User...] sections have keys that are simply passed through to the .cfg configurations files. I.e. any KEY=VALUE defines a variable @KEY@ which gets expanded to VALUE in the .cfg files.
 +
 +
Note that you may add arbitrary keys to the [User...] sections, and they will expand to their values when used as variables in the .cfg files.
  
 
===Settings Section===
 
===Settings Section===
Line 55: Line 58:
 
<pre>
 
<pre>
 
[Settings]
 
[Settings]
Version=2.1
+
Version=2.0
 
ImageExt=flac
 
ImageExt=flac
 
ImageNaming=$artist$ - [$year$] $album$
 
ImageNaming=$artist$ - [$year$] $album$
Line 76: Line 79:
 
! style=padding-right:24px;| Variable || Description
 
! style=padding-right:24px;| Variable || Description
 
|-
 
|-
| ImageExt || Image mode only (F10). The format extension for the compressed image file + cuefile. E.g. flac, wv, or mp3. Set to wav when no compressed image is desired.
+
| ImageExt || Copy Image mode only (F10). The format extension for the compressed image file + cuefile. E.g. flac, wv, or mp3. Set to wav when no compressed image is desired.
 +
|-
 +
| ImageNaming || This variable detirmines how image files, and their cuesheets, will be named when REACT is used in copy image mode.  Variables available are: $album$; $artist$; $year$; $genre$; and $freedb$.  These are populated from the values of EAC's textboxes, and therefore do not strictly relate to the extended variables available within your config.<br />'''Please note:''' Your scheme ''must'' begin "$artist$ -" in order for Various Artists discs to be recognised properly.
 
|-
 
|-
 
| VA || Default set to 'Various Artists'. The variable @va@ holds this string. See @cdartist@ below for further details.
 
| VA || Default set to 'Various Artists'. The variable @va@ holds this string. See @cdartist@ below for further details.
Line 82: Line 87:
 
| CreateAllCuesheets || If set to 1, all four availabe types of cuesheets will be saved to the extraction directory, which must be preconfigured in EAC. The cuesheet base name can be accessed using the @albumfile@ variable.
 
| CreateAllCuesheets || If set to 1, all four availabe types of cuesheets will be saved to the extraction directory, which must be preconfigured in EAC. The cuesheet base name can be accessed using the @albumfile@ variable.
 
|-
 
|-
| ImageNaming || This variable detirmines how image files, and their cuesheets, will be named when REACT is used in image mode. Variables available are: $album$; $artist$; $year$; $genre$; and $freedb$.  These are populated from the values of EAC's textboxes, and therefore do not strictly relate to the extended variables available within your config.<br />'''Please note:''' Your scheme ''must'' begin "$artist$ -" in order for Various Artists discs to be recognised properly.
+
| RunCoverDownloader || If set to 1, run the albumart.exe application. Simply double click the cover you want (select close after save in settings in albumart). In Copy Tracks mode, albumart will wait until it is closed before starting copying. You may set RunCoverDownloader=2 to make it wait in both modes, 3 to wait only in Image Copy mode, or 4 to never wait.
 
|-
 
|-
 
| Sla_Bks_Col_Qst_Bar_Quo_Ast_Lt_Gt || Some characters cannot be used in file or folder names.  This variable allows you to specify what these characters should be replaced with.  Slash; Backslash; Colon; Question Mark; Bar (Pipe); Quotes; Asterisk; Less Than; Greater Than. It is also possible to convert Space to e.g. _ by appending a Bar and a _ (after the Gt convert character).
 
| Sla_Bks_Col_Qst_Bar_Quo_Ast_Lt_Gt || Some characters cannot be used in file or folder names.  This variable allows you to specify what these characters should be replaced with.  Slash; Backslash; Colon; Question Mark; Bar (Pipe); Quotes; Asterisk; Less Than; Greater Than. It is also possible to convert Space to e.g. _ by appending a Bar and a _ (after the Gt convert character).
|-
 
| Debug || If you are having problems with your config file setup, set this value to 1.  REACT will then pause before exiting, so you can examine the console output to attempt to determine where your process fell down.
 
 
|}
 
|}
  
 
===UserTrackFormat Section===
 
===UserTrackFormat Section===
 +
This section enables/disables output audio formats to be created.
 +
 
===UserOutputNames Section===
 
===UserOutputNames Section===
 +
Here the track names and the output paths are defined for the different output audio formats.
 +
 
===UserSettings Section===
 
===UserSettings Section===
 +
Set various variables for more detailed configuration.
 +
{| border="0" cellpadding="0" cellspacing="4"
 +
! style=padding-right:24px;| Variable || Description
 +
|-
 +
| Debug || If you are having problems with your config file setup, set this value to 1.  REACT will then pause before exiting, so you can examine the console output to attempt to determine where your process fell down.
 +
|}
  
==Modifying the CFG files (Advanced)==
+
==Modifying the CFG files (advanced)==
  
 
===Available Variables===
 
===Available Variables===
Line 108: Line 121:
 
| @mymusic@ || The path to your 'My Music' folder
 
| @mymusic@ || The path to your 'My Music' folder
 
|-
 
|-
| @sourcedir@ || The path to the folder in which the ripped source files are located ([[WAV]]/LOG/CUE)
+
| @sourcedir@ || The path to the folder in which the copied source files are located ([[WAV]]/LOG/CUE)
 
|-
 
|-
 
| @basename@ || The name of the file being created, excluding folders and extension  
 
| @basename@ || The name of the file being created, excluding folders and extension  
Line 115: Line 128:
 
|-
 
|-
 
| @image@ || The path to the final image file, when used in '''Copy Image''' mode
 
| @image@ || The path to the final image file, when used in '''Copy Image''' mode
 +
|-
 +
| @imageext@ || The extension of the compressed target image, e.g. flac
 
|-
 
|-
 
| @sourcecuesheet@ || The path to the (temporary) source [[Cuesheet|cuesheet]], when used in '''Copy Image''' mode
 
| @sourcecuesheet@ || The path to the (temporary) source [[Cuesheet|cuesheet]], when used in '''Copy Image''' mode
Line 121: Line 136:
 
|-
 
|-
 
| @eaclog@ || The path to the log file created by [[Exact Audio Copy|EAC]]
 
| @eaclog@ || The path to the log file created by [[Exact Audio Copy|EAC]]
 +
|-
 +
| @cover@ || The path to the cover/album art picture file, dowloaded with CoverDownloader.
 
|-
 
|-
 
| @albumfile@ || The base path to the cuesheet files without extension, created when CreateAllCuesheets=1 in the INI file. E.g, "@albumfile@.[mg].cue" is the multiple wav files cuesheet with gaps.  
 
| @albumfile@ || The base path to the cuesheet files without extension, created when CreateAllCuesheets=1 in the INI file. E.g, "@albumfile@.[mg].cue" is the multiple wav files cuesheet with gaps.  
Line 151: Line 168:
 
|-
 
|-
 
| '''OTHER''' ||  
 
| '''OTHER''' ||  
 +
|-
 +
| @various@ || Is 1 if the EAC 'Various' checkbox was checked. Otherwise 0
 +
|-
 +
| @va@ || The name of VariousArtist. Default 'Various Artists'.
 
|-
 
|-
 
| @crc@ || The [[CRC]] of the file
 
| @crc@ || The [[CRC]] of the file

Revision as of 13:43, 11 December 2006

This page is under construction.

REACT (Run EAC Tasks) can be used in conjunction with Exact Audio Copy (EAC), as an external compressor.

It is, however, not an encoder, but an interim application that provides a scripting facility to call muliple encoders or pre-/post-encoding applications to process the WAVE files created by EAC, or the files created by the script itself. In short, REACT allows you to run multiple tasks on the audio extracted, instead of only one.

REACT integrates with Exact Audio Copy, adding some hotkeys combinations to access often used functions more quickly. It will also alter the default name for image files according to your INI settings, and close the extraction dialogue in order for the logfile to be created and used from within your script. It can auto-configure EAC, updating the external compression options so that EAC is ready to run REACT immediately. This feature is extremely useful for novice users.

REACT is configured using an INI file and config files. The commands used within the config files are command line/DOS commands, with the addition of numerous variables which REACT makes available. For example, any instance of @artist@ in the script will be replaced by the freedb artist name, while $artist$ will be replaced with a filename-friendly version of the artist name (with illegal characters replaced according to your requirements).

From REACT version 2.0 final, most configuration can be done by editing the INI file only. Only advanced users should edit the .cfg files.

Hotkeys

REACT adds a few useful hotkeys to EAC:

Key Function
F1 Wiki page for EAC.
Alt-F1 Wiki page for REACT (this page).
Ctrl-F2 Configure EAC to be used with REACT.
Alt-F2 Edit REACT.ini in notepad.
Alt-F3 Edit REACT-image.cfg in notepad.
F4 Activates Shift-F5 in EAC (Copy selected tracks - Compressed). Optionally, it also starts CoverDownloader\albumart. You may edit REACT.ini and set TracksHotVal=+{F6} if you want to do Test & Copy instead of Copy only. If the INI key CreateAllCuesheets=1, all four cuesheet types are saved as different files as well.
F10 Shortcut to menu "Action - Copy Image and Save CUE Sheet - Compressed...". REACT will fill in the image name, as defined in the ImageNaming INI key (template). REACT will also close the Save Wavform dialog automatically if you have configured EAC to extract to a fixed directory.

Configuration Files

There are three configuration files in total; The INI file, one CFG file for copying to audio track files, and one for copying to an audio image with cuesheet. The config files are stored in the REACT folder, and are named:

File Description
REACT.ini Regular INI file with key=values pairs. Defines variables used by the CFG files.
REACT-tracks.cfg - Used for "Copy Selected Tracks Compressed", default shortcut : F4
REACT-image.cfg - Used for "Copy Image & Create CUE Sheet Compressed", default shortcut : F10

The REACT.INI File

There are four sections in the REACT.ini file. The first [Settings] section has global definitions that REACT uses. The next three [User...] sections have keys that are simply passed through to the .cfg configurations files. I.e. any KEY=VALUE defines a variable @KEY@ which gets expanded to VALUE in the .cfg files.

Note that you may add arbitrary keys to the [User...] sections, and they will expand to their values when used as variables in the .cfg files.

Settings Section

The first section in the INI file sets some global keys, which can be used in any or all encoder configs. These variables refer to high level settings, like the path to EAC, rather than encoder-specific settings. Here is an example:

[Settings]
Version=2.0
ImageExt=flac
ImageNaming=$artist$ - [$year$] $album$
ImageHotKey={F10}
TracksHotKey={F4}
TracksHotVal=+{F5}
VA=Various Artists
CreateAllCuesheets=0
RunCoverDownloader=1
CoverDownloader=C:\Program Files\REACT2\coverdownloader\albumart.exe
EAC=C:\Program Files\Exact Audio Copy\EAC.exe
MinimizeCompressionWindow=1
ProcessPriority=1
Sla_Bks_Col_Qst_Bar_Quo_Ast_Lt_Gt=-|-|-||!|'|#|[|]

Some of the keys are obvious, and some you really don't need to bother with unless you are a REACT Ninja, but here's a few to watch out for:

Variable Description
ImageExt Copy Image mode only (F10). The format extension for the compressed image file + cuefile. E.g. flac, wv, or mp3. Set to wav when no compressed image is desired.
ImageNaming This variable detirmines how image files, and their cuesheets, will be named when REACT is used in copy image mode. Variables available are: $album$; $artist$; $year$; $genre$; and $freedb$. These are populated from the values of EAC's textboxes, and therefore do not strictly relate to the extended variables available within your config.
Please note: Your scheme must begin "$artist$ -" in order for Various Artists discs to be recognised properly.
VA Default set to 'Various Artists'. The variable @va@ holds this string. See @cdartist@ below for further details.
CreateAllCuesheets If set to 1, all four availabe types of cuesheets will be saved to the extraction directory, which must be preconfigured in EAC. The cuesheet base name can be accessed using the @albumfile@ variable.
RunCoverDownloader If set to 1, run the albumart.exe application. Simply double click the cover you want (select close after save in settings in albumart). In Copy Tracks mode, albumart will wait until it is closed before starting copying. You may set RunCoverDownloader=2 to make it wait in both modes, 3 to wait only in Image Copy mode, or 4 to never wait.
Sla_Bks_Col_Qst_Bar_Quo_Ast_Lt_Gt Some characters cannot be used in file or folder names. This variable allows you to specify what these characters should be replaced with. Slash; Backslash; Colon; Question Mark; Bar (Pipe); Quotes; Asterisk; Less Than; Greater Than. It is also possible to convert Space to e.g. _ by appending a Bar and a _ (after the Gt convert character).

UserTrackFormat Section

This section enables/disables output audio formats to be created.

UserOutputNames Section

Here the track names and the output paths are defined for the different output audio formats.

UserSettings Section

Set various variables for more detailed configuration.

Variable Description
Debug If you are having problems with your config file setup, set this value to 1. REACT will then pause before exiting, so you can examine the console output to attempt to determine where your process fell down.

Modifying the CFG files (advanced)

Available Variables

Variable Description
PATHS AND FILES
@reactdir@ The path to the directory in which REACT resides
@tools@ The path to the directory in which the encoders reside. Set within the INI file
@mymusic@ The path to your 'My Music' folder
@sourcedir@ The path to the folder in which the copied source files are located (WAV/LOG/CUE)
@basename@ The name of the file being created, excluding folders and extension
@source@ The path to the temporary source WAVE file
@image@ The path to the final image file, when used in Copy Image mode
@imageext@ The extension of the compressed target image, e.g. flac
@sourcecuesheet@ The path to the (temporary) source cuesheet, when used in Copy Image mode
@cuesheet@ The path to the final cuesheet, when used in Copy Image mode
@eaclog@ The path to the log file created by EAC
@cover@ The path to the cover/album art picture file, dowloaded with CoverDownloader.
@albumfile@ The base path to the cuesheet files without extension, created when CreateAllCuesheets=1 in the INI file. E.g, "@albumfile@.[mg].cue" is the multiple wav files cuesheet with gaps.
METADATA
@cdartist@ The name of the CD artist. If @various@=1 @cdartist@ equals the variable @va@, otherwise @artist@. Use $cdartist$ in file paths
@artist@ The name of the track artist. Use $artist$ in paths
@album@ The name of the album. Use $album$ in paths
@title@ The song title. Use $title$ in paths
@track@ The track number. Use $track$ to zero-pad the track number, i.e.: turn 9 into 09
@numtracks@ The total number of tracks. Use $numtracks$ to zero-pad the number
@genre@ The album genre. Use $genre$ in paths
@year@ The album year
@comment@ The comment. Use $comment$ in paths
@freedbid@ The freedb ID
OTHER
@various@ Is 1 if the EAC 'Various' checkbox was checked. Otherwise 0
@va@ The name of VariousArtist. Default 'Various Artists'.
@crc@ The CRC of the file
@bitrate@ The value of the Bitrate dropdown on EAC's External Compressor dialogue
@curdate@ The current date


Links

Ask REACT questions in this thread : http://www.hydrogenaudio.org/forums/index.php?showtopic=35158

Download REACT from this thread : http://www.hydrogenaudio.org/forums/index.php?showtopic=36261