Skip to content
CueNorm Public Validator

Rule

REQUIRED_METADATA

Requires programme metadata that the destination wants in the delivered file, such as the programme title or the on-air reference.

What it checks

Some destinations require the file to carry information about the programme: the BBC wants the programme title, the on-air UID, the publisher and the editor's name in the EBU-STL header; ARTE and the French broadcasters' CST-RT-040 baseline want the programme title. The rule produces a single issue for the whole file, listing the missing fields.

How it is measured

CueNorm looks at the programme metadata of the file: the values read from it (EBU-STL header, TTML ttm:title, EBU-TT ebuttm:documentMetadata) and the values given at conversion time (--metadata key=value on the command line, metadata in the API), which take precedence. When a conversion is checked, the generated file is read back, so a field counts only if the output format actually carries it.

Field EBU-STL header TTML family
originalProgrammeTitle OPT ttm:title
originalEpisodeTitle OET —
translatedProgrammeTitle, translatedEpisodeTitle TPT, TET —
translatorsName, translatorsContact TN, TCD —
subtitleListReference SLR (on-air UID) —
countryOfOrigin CO —
publisher, editorsName, editorsContact PUB, EN, ECD —
startOfProgramme TCP —

Parameters

Parameter Type Meaning
fields list of the field names above The fields that must be present

Example

With fields: [originalProgrammeTitle, subtitleListReference, publisher, editorsName], a file with only a title and a publisher is reported as Missing programme metadata: subtitleListReference, editorsName.

How to fix

  • Give the missing values at conversion time: cuenorm convert … --metadata originalProgrammeTitle="Snow White" --metadata subtitleListReference="ABC D123W/02", or the metadata object of the API.
  • If the source file already declares them (an EBU-STL header, a TTML title), check that they were filled in by the tool that produced it.

Profiles using this rule

ProfileSeverityParameters
ARTE SME German arte-sme-de error fields=originalProgrammeTitle
ARTE SME French arte-sme-fr error fields=originalProgrammeTitle
ARTE VOST German arte-vost-de error fields=originalProgrammeTitle
ARTE VOST French arte-vost-fr error fields=originalProgrammeTitle
BBC Subtitles English (UK), EBU-STL bbc-subtitle-en-gb-ebustl error fields=originalProgrammeTitle subtitleListReference publisher editorsName
BBC Subtitles English (UK), EBU-TT Part 1 bbc-subtitle-en-gb-ebutt error fields=originalProgrammeTitle originalEpisodeTitle subtitleListReference countryOfOrigin publisher editorsName
Channel 5 SDH English (UK), EBU-STL channel5-sdh-en-gb-ebustl error fields=originalProgrammeTitle originalEpisodeTitle subtitleListReference
French broadcasters SME (RT-040) fr-broadcast-sme-fr error fields=originalProgrammeTitle
French broadcasters VOST (RT-040) fr-broadcast-vost-fr error fields=originalProgrammeTitle
France Télévisions SME French francetv-sme-fr error fields=originalProgrammeTitle
France Télévisions VOST French francetv-vost-fr error fields=originalProgrammeTitle
TF1 SME French tf1-sme-fr error fields=originalProgrammeTitle
TF1 VM French tf1-vost-fr error fields=originalProgrammeTitle
UK broadcasters SDH (DPP-EBU-TT) uk-dpp-sdh-en-gb-ebutt error fields=originalProgrammeTitle originalEpisodeTitle subtitleListReference countryOfOrigin publisher editorsName