fix: subtitle codec types

vitalygashkov · Dec 6, 2024 · 51f20a5 · 51f20a5
1 parent fb3ac36
commit 51f20a5
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/dasha.js b/dasha.js
@@ -9,6 +9,7 @@ const {
   filterByLanguages,
   filterByChannels,
 } = require('./lib/track');
+const { SUBTITLE_CODECS } = require('./lib/subtitle');
 
 const parse = (text, url, fallbackLanguage) => {
   if (text.includes('<MPD'))
@@ -24,4 +25,5 @@ module.exports = {
   filterByCodecs,
   filterByLanguages,
   filterByChannels,
+  SUBTITLE_CODECS,
 };
diff --git a/lib/dash.js b/lib/dash.js
@@ -136,6 +136,7 @@ const parseLanguage = (representation, adaptationSet, fallbackLanguage) => {
 };
 
 const identifierPattern = /\$([A-z]*)(?:(%0)([0-9]+)d)?\$/g;
+
 const identifierReplacement =
   (values) => (match, identifier, format, width) => {
     if (match === '$$') return '$';
@@ -147,6 +148,7 @@ const identifierReplacement =
     if (value.length >= width) return value;
     return value.padStart(width, '0');
   };
+
 const buildSegmentUrl = (template, fields) => {
   return template.replace(identifierPattern, identifierReplacement(fields));
 };

diff --git a/lib/subtitle.js b/lib/subtitle.js
@@ -127,6 +127,7 @@ const createSubtitleTrack = ({
 };
 
 module.exports = {
+  SUBTITLE_CODECS,
   parseSubtitleCodec,
   tryParseSubtitleCodec,
   checkIsClosedCaption,

diff --git a/types/dasha.d.ts b/types/dasha.d.ts
@@ -139,13 +139,14 @@ export interface AudioTrack extends Track {
 }
 
 export type SubtitleCodec =
-  | 'SRT'
-  | 'SSA'
-  | 'ASS'
-  | 'TTML'
-  | 'VTT'
-  | 'STPP'
-  | 'WVTT';
+  | 'SRT' // https://wikipedia.org/wiki/SubRip
+  | 'SSA' // https://wikipedia.org/wiki/SubStation_Alpha
+  | 'ASS' // https://wikipedia.org/wiki/SubStation_Alpha#Advanced_SubStation_Alpha=
+  | 'TTML' // https://wikipedia.org/wiki/Timed_Text_Markup_Language
+  | 'VTT' // https://wikipedia.org/wiki/WebVTT
+  // MPEG-DASH box-encapsulated subtitle formats
+  | 'STPP' // https://www.w3.org/TR/2018/REC-ttml-imsc1.0.1-20180424
+  | 'WVTT'; // https://www.w3.org/TR/webvtt1
 
 export interface SubtitleTrack extends Track {
   type: 'text';