Skip to content

Custom Formats

twolaw edited this page Aug 11, 2019 · 26 revisions

Table of Contents

1. Custom Formats

2. Format Tags

3. Matching

4. Templates

5. How To Apply

Custom Formats

Custom Formats are a way to completely automate anything. They work similar to Qualities: Releases and Files are parsed like always, however, now Radarr also checks if one or more of your Custom Formats might also match against the Release or File name. Quality remains as the primary deciding factor when grabbing a release and Custom Formats work secondary to this. At an equal Quality, the preferred release will have the most highest ranking Custom Format matches from the Formats allowed in the profile settings. Upgrading stops when at least one Custom Format match is above the profile cutoff.

A custom format has so called "Format Tags". These tags describe how Radarr tries to match a release or file. For more information on how exactly Format Tags match, see Format Tags and Matching.

Format Tags

A Format Tag consists of three parts: The Tag Prefix, the Tag Modifier (optional) and the Tag Value.

Format: PREFIX_MODIFIER_VALUE or PREFIX_VALUE

The Prefix determines what kind of Format Tag this is and against what it matches.

The Modifier changes how the matching occurs.

The Value is used for the matching.

Format Tag Types

Name Tag Prefix Possible Values / Examples Notes
Source Deprecated S_ S_WORKPRINT, TODO add all final values here This tag is matched against the source where a release was ripped from.
Resolution Deprecated R_ R_480, R_576, R_720, R_1080, R_2160 This tag is matched against the resolution parsed from either the release name or media info (if available)
Modifier Deprecated M_ M_SCREENER, M_REMUX, M_BRDISK, TODO add all final values here This tag is matched against any modifiers Radarr may parse, such as whether the release is a remux or a full bluray disk.
Language L_ L_English, L_German, etc. This tag is matched against any language(s) Radarr parses. All languages previously selectable in profiles work here.
Indexer Flags I_ I_GFreeleech, I_GHalfleech, etc. See Indexer Flags for a comprehensive list. This tag is matched against any Indexer Flags Radarr may parse.
Edition E_ E_Director, E_theatrical, E_EXTENDED, ... This tag is matched against any Editions Radarr may parse. You can put any value after E_ and Radarr will try to match that against what it parsed (case-insensitive).
Custom C_ C_Surround, C_YIFI, C_-Framestor, C_h264, ... This tag is matched against the whole release name (case-insensitve). You can put any value after C_.
Size G_ G_10<>20, G_15.4444<>20.3333, ... This tag is matched against the release size. The release size is converted to gigabytes and compared against the values x and y, where the format tag looks like this: G_x<>y. In other words, the release size must be between the two values specified between this tag, separated by <>.

Format Tag Modifiers

Name Abbreviation Notes
Regex RX CHANGED FROM R TO RX Is only useful for Edition and Custom Format Tags. Makes it, that Radarr parses the value of the Format Tag as a Regex and uses the Regex for matching.
Negate N Negates the Format Tag, i.e. when it normally matches it won't and when it normally wouldn't match it does.
Required RQ CHANGED FROM RE TO RQ Makes the Format Tag strongly required. More on that later.
Word Matching W NOT YET IMPLEMENTED Makes the Format Tag only match full words, e.g. C_W_3D would match Movie.3D.1080p, but not Movie3d.1080p. (Only really useful for edition or custom tags. Would be the same as making a \bword\b regex.)

Format Tags Examples

Example of Tag Example Release Name Matching Does it Match?
S_BLURAY Prometheus.2012.Bluray.1080p S_BLURAY == S_BLURAY YES
S_WEBDL Prometheus.2012.Bluray.1080p S_BLURAY == S_WEBDL NO
S_N_WEBDL Prometheus.2012.Bluray.1080p S_BLURAY != S_WEBDL YES
R_1080 Prometheus.2012.Bluray.1080p R_1080 == R_1080 YES
R_576 Prometheus.2012.Bluray.1080p R_1080 == R_576 NO
M_REMUX Prometheus.2012.Bluray.1080p M_NONE == M_REMUX NO
M_REMUX Prometheus.2012.Bluray.Remux.1080p M_REMUX == M_REMUX YES
L_English Prometheus.2012.Bluray.1080p [L_English] contains L_English YES
L_French Prometheus.2012.Bluray.MULTI.FRENCH.ENGLISH.1080p [L_English, L_French] contains L_French YES

Matching

How does Radarr decide if a custom format matches a release or not?

Radarr uses the following steps to find the best matching quality or custom format:

  1. Go through each custom format and find out which Format Tags match and which don't
  2. Discard all custom formats, where an absolutely required Format Tag (RQ) does not match
  3. Discard all custom formats, where at least one Format Tag of a type is present and none of the tags of this type match. Examples:
    • S_Bluray (NO MATCH), R_1080 (MATCH) Will be discarded, since a source tag is present, but none of the source tags match
    • S_Bluray (NO MATCH), S_WEBDL (MATCH), R_1080 (MATCH) Will not be discarded, since at least one of the source tags matches

Note that Radarr will try to match releases with all custom formats you created, whether they are checked or unchecked in profiles. Then, if the custom format is checked in profile, matching release will be accepted, if unchecked it will be rejected. See an example here with a bluray custom format.

Templates

Radarr provides a wide range of predefined templates. They are explained below and sometimes have tips on customizing them.

x264

Description: This custom format matches any releases that are encoded with the x264 (sometimes called h264) codec.

Usage: This format is useful, if you have a lot of older devices that struggle with the new x265 codec and you thus want Radarr to upgrade all movies to x264.

x265

Description: This custom format matches any releases that are encoded with the x265 (sometimes called h265 or HEVC) codec.

Usage: This format is useful, if most of your devices support h265 and you want to decrease storage usage by downloading h265 copies of all your movies.

Simple Hardcoded Subs

Description: This custom format matches any releases that have "sub" or "subs" in their release title.

Usage: This format is useful, if most of your releases with hardcoded subs are matched by this. By moving this custom format to below the "None" option in your profile, Radarr will try to upgrade releases that match this format, to one without this. Therefore, Radarr will replace releases with hardcoded subs with ones that do not have hardcoded subs.

Multi Language

Description: This custom format can be used as a template to make Radarr upgrade / prefer releases with multiple languages. By default it matches releases that contain either English, French or Both as languages.

Usage: This format can be easily customized by adding or removing desired languages.

Complex Examples

Surround Sound

C_RXRQ_DTS\-?(HD|X)|TRUEHD|ATMOS|DD(\+|P)(5|7)

Clone this wiki locally
You can’t perform that action at this time.