tagging

get_iplayer Metadata Tagging

Usage

Options

Command Line	Option File	Description
--no-artwork	noartwork (0/1)	Do not embed thumbnail image in output file. All other metadata values will be written.
--no-tag	notag (0/1)	Do not tag downloaded programmes
--tag-format-show	tag_formatshow (string)	Format template for programme name in metadata (use substitution parameters). Default: <name>
--tag-format-title	tag_formattitle (string)	Format template for episode title in metadata (use substitution parameters). Default: <episodeshort>
--tag-isodate	tag_isodate (0/1)	Use ISO8601 dates (YYYY-MM-DD) in programme names and episode titles
--tag-podcast	tag_podcast (0/1)	Tag downloaded radio and tv programmes as iTunes podcasts
--tag-podcast-radio	tag_podcast_radio (0/1)	Tag only downloaded radio programmes as iTunes podcasts
--tag-podcast-tv	tag_podcast_tv (0/1)	Tag only downloaded tv programmes as iTunes podcasts
--tag-utf8	tag_utf8 (0/1)	Use UTF-8 encoding for non-ASCII characters in AtomicParsley parameter values (Linux/Unix/macOS only). Use only if auto-detect fails.

Obsolete AtomicParsley

Some Linux/BSD distros ship obsolete versions of AtomicParsley. Tagging will likely fail on large files (>4GB) if you are using AtomicParsley < 0.94. See the AtomicParsley Bitbucket repository for instructions on building an up-to-date version. If you use Windows or macOS and follow the installation instructions, you will have an up-to-date build of AtomicParsley.

Content Encoding

The get_iplayer metadata is assumed to be encoded as UTF-8 and is then re-encoded as necessary for the different tagging applications. This doesn't always hold true, so substitution characters may sometimes appear in the tags, particularly lyrics or longDescription.

Tag Scheme

The table below describes the scheme used to convert get_iplayer metadata into tags for downloaded programmes. The tag names were selected to match AtomicParsley parameter names. Each tag is mapped, where possible, to the corresponding get_iplayer substitution parameter, AtomicParsley arg, MP4 atom. The list of iTunes fields indicate where each tag will appear in the iTunes Get Info dialog. Conversion rules specific to particular fields are indicated in the footnotes. If you wish to experiment with variations, the conversion of get_iplayer metadata to tag values is encapsulated in the Tagger::tags_from_metadata subroutine.

|Tag Name|Substitution Param¹|AtomicParsley arg|MP4 atom|iTunes Field |-----|-----|-----|-----|-----|-----|----- |stik²|<ext>|--stik|stik|Options:Media Kind |advisory³|<guidance>|--advisory|rtng|Summary:Advisory |copyright⁴|<dldate>|--copyright|cprt|Summary:Copyright |title|<episode>⁵|--title|©nam|Info:Song/Title |artist|<channel>|--artist|©ART|Info:Artist |albumArtist|BBC <type>⁶|--albumArtist|aART|Info:Album Artist |album|<name>|--album|©alb|Info:Album/Programme |grouping|<categories>|--grouping|©grp|Info:Grouping |composer|BBC iPlayer|--composer|©wrt|Info:Composer |comment|<descshort>|--comment|©cmt|Info:Comments |genre⁷|<categories>|--genre|©ge|Info:Genre |year|<firstbcast>⁸|--year|©day|Info:Year |tracknum|<episodenum>|--tracknum|trkn|Info:Track Number |disk|<seriesnum>|--disk|disk|Info:Disc Number |lyrics|<desc>⁹|--lyrics|©lyr|Lyrics |description|<descshort>|--description|desc|Video:Description |longDescription|<desc>|--longdesc¹⁰ OR
--longDescription¹¹|ldes|(Hidden):Long Description |hdvideo¹²|<mode>|--hdvideo¹³|hdvd|(Browser):HD Icon |TVShowName|<name>|--TVShowName|tvsh|Video:Show |TVEpisode|<senum>¹⁴|--TVEpisode|tven|Video:Episode ID |TVSeasonNum|<seriesnum>|--TVSeasonNum|tvsh|Video:Season Number |TVEpisodeNum|<episodenum>|--TVEpisodeNum|tves|Video:Episode Number |TVNetwork|<channel>|--TVNetwork|tvnn|(Hidden):TV Network |artwork|<thumbfile>|--artwork|covr|Artwork |podcastFlag¹⁵|true|--podcastFlag|pcst|Options:Media Kind |category¹⁵|<categories>¹⁶|--category|catg|(Hidden):Podcast Category |keyword¹⁵|<categories>|--keyword|keyw|(Hidden):Podcast Keywords |podcastGUID¹⁵|<player>|--podcastGUID|egid|(Hidden):Podcast GUID

1. Full list of substitution parameters may be found here.

2. TV Show if MP4/M4V, Movie if MP4/M4V and <categories> contains "Film", Normal otherwise

3. explicit if <guidance> non-empty, remove otherwise

4. Year taken from <dldate>, e.g.: (C) 2011 British Broadcasting Corporation, all rights reserved

5. Use --tag-format-title="<title>" for full title

6. BBC TV, BBC Radio

7. First item in <categories> used unless it is one of: ("Films", "Sign Zone", "Audio Described", "Northern Ireland", "Scotland", "Wales", "England"), in which case second item is used. If <categories> is empty, set to get_iplayer

8. If <firstbcast> is not valid date, current date is used

9. <player> and <web> appended if present

10. Not available with all AtomicParsley versions

11. Not available with all AtomicParsley versions

12. true if <mode> contains "hd", false otherwise

13. Not available with all AtomicParsley versions

14. If <senum> empty, <pid> is used

15. --tag-podcast required

16. Uses same rules as genre [7]