DVB Font Downloads

index.d.ts

@@ -216,6 +216,10 @@ declare namespace dashjs {
 
         getSelectionPriority(realAdaptation: object): number;
 
+        getEssentialPropertiesForAdaptation(adaptation: object): object;
+
+        getEssentialPropertiesAsArrayForAdaptation(adaptation: object): any[];
+
         getEssentialPropertiesForRepresentation(realRepresentation: object): {schemeIdUri: string, value: string}
 
         getRepresentationFor(index: number, adaptation: object): object;
@@ -254,9 +258,19 @@ declare namespace dashjs {
 
         getServiceDescriptions(manifest: object): serviceDescriptions;
 
-        getSupplementalProperties(adaptation: object): object;
         getSegmentAlignment(adaptation: object): boolean;
+
         getSubSegmentAlignment(adaptation: object): boolean;
+
+        getSupplementalPropertiesForAdaptation(adaptation: object): object;
+
+        getSupplementalPropertiesAsArrayForAdaptation(adaptation: object): any[];
+
+        getSupplementalPropertiesForRepresentation(representation: Representation): object;
+
+        getSupplementalPropertiesAsArrayForRepresentation(representation: Representation): any[];
+
+        setConfig(config: object): void;
     }
 
     export interface PatchManifestModel {
@@ -472,6 +486,9 @@ declare namespace dashjs {
         isEmbedded: any | null;
         selectionPriority: number;
         supplementalProperties: object;
+        supplementalPropertiesAsArray: any[];
+        essentialProperties: object;
+        essentialPropertiesAsArray: any[];
         segmentAlignment: boolean;
         subSegmentAlignment: boolean;
     }
@@ -582,6 +599,9 @@ declare namespace dashjs {
         schemeIdUri: string;
         value: string;
         id: string;
+        dvb_url?: string;
+        dvb_mimeType?: string;
+        dvb_fontFamily?: string;
     }
 
     export class ContentSteeringResponse {
@@ -3504,7 +3524,32 @@ declare namespace dashjs {
      * Streaming - Text
      **/
 
-     export type TextTrackType = 'subtitles' | 'caption' | 'descriptions' | 'chapters' | 'metadata';
+    export type TextTrackType = 'subtitles' | 'caption' | 'descriptions' | 'chapters' | 'metadata';
+
+    export type FontDownloadStatus = 'unloaded' | 'loaded' | 'error';
+
+    export interface FontInfo {
+        fontFamily: string;
+        url: string;
+        mimeType: string;
+        trackId: number;
+        streamId: string;
+        isEssential: boolean;
+        status: FontDownloadStatus;
+        fontFace: FontFace;
+    }
+
+    export interface DVBFonts {
+        addFontsFromTracks(tracks: TextTrackInfo, streamId: string): void;
+
+        downloadFonts(): void;
+
+        getFonts(): FontInfo[];
+
+        getFontsForTrackId(trackId: number): FontInfo[];
+
+        reset(): void;
+    }
 
     export interface EmbeddedTextHtmlRender {
         createHTMLCaptionsFromScreen(videoElement: HTMLVideoElement, startTime: number, endTime: number, captionScreen: any): any[];
@@ -3644,8 +3689,6 @@ declare namespace dashjs {
         deleteCuesFromTrackIdx(trackIdx: number, start: number, end: number): void;
 
         deleteAllTextTracks(): void;
-
-        deleteTextTrack(idx: number): void;
     }
 
     /**

src/core/events/CoreEvents.js

@@ -49,6 +49,9 @@ class CoreEvents extends EventsBase {
         this.CMSD_STATIC_HEADER = 'cmsdStaticHeader';
         this.CURRENT_TRACK_CHANGED = 'currentTrackChanged';
         this.DATA_UPDATE_COMPLETED = 'dataUpdateCompleted';
+        this.DVB_FONT_DOWNLOAD_ADDED = 'dvbFontDownloadAdded';
+        this.DVB_FONT_DOWNLOAD_COMPLETE = 'dvbFontDownloadComplete';
+        this.DVB_FONT_DOWNLOAD_FAILED = 'dvbFontDownloadFailed';
         this.INBAND_EVENTS = 'inbandEvents';
         this.INITIAL_STREAM_SWITCH = 'initialStreamSwitch';
         this.INIT_FRAGMENT_LOADED = 'initFragmentLoaded';

src/dash/DashAdapter.js

@@ -1121,6 +1121,10 @@ function DashAdapter() {
             }
         }
 
+        // TODO: Unsure if grabbing essential properties present on all representations is necessary like it has been done above
+        mediaInfo.essentialProperties = dashManifestModel.getEssentialPropertiesForAdaptation(realAdaptation);        
+        mediaInfo.essentialPropertiesAsArray = dashManifestModel.getEssentialPropertiesAsArrayForAdaptation(realAdaptation);
+
         mediaInfo.isFragmented = dashManifestModel.getIsFragmented(realAdaptation);
         mediaInfo.isEmbedded = false;
 

src/dash/constants/DashConstants.js

@@ -88,6 +88,7 @@ class DashConstants {
         this.AUDIO_CHANNEL_CONFIGURATION = 'AudioChannelConfiguration';
         this.CONTENT_PROTECTION = 'ContentProtection';
         this.ESSENTIAL_PROPERTY = 'EssentialProperty';
+        this.ESSENTIAL_PROPERTY_ASARRAY = 'EssentialProperty_asArray';
         this.SUPPLEMENTAL_PROPERTY = 'SupplementalProperty';
         this.SUPPLEMENTAL_PROPERTY_ASARRAY = 'SupplementalProperty_asArray';
         this.INBAND_EVENT_STREAM = 'InbandEventStream';
@@ -133,6 +134,9 @@ class DashConstants {
         this.CENC_DEFAULT_KID = 'cenc:default_KID';
         this.DVB_PRIORITY = 'dvb:priority';
         this.DVB_WEIGHT = 'dvb:weight';
+        this.DVB_URL = 'dvb:url';
+        this.DVB_MIMETYPE = 'dvb:mimeType';
+        this.DVB_FONTFAMILY = 'dvb:fontFamily';
         this.SUGGESTED_PRESENTATION_DELAY = 'suggestedPresentationDelay';
         this.SERVICE_DESCRIPTION = 'ServiceDescription';
         this.SERVICE_DESCRIPTION_SCOPE = 'Scope';

src/dash/models/DashManifestModel.js

@@ -1290,13 +1290,16 @@ function DashManifestModel() {
         return serviceDescriptions;
     }
 
+    /* SUPPLEMENTAL PROPERTY DESCRIPTORS */
+
     function getSupplementalPropertiesForAdaptation(adaptation) {
         const supplementalProperties = {};
 
         if (adaptation && adaptation.hasOwnProperty(DashConstants.SUPPLEMENTAL_PROPERTY_ASARRAY)) {
             for (const sp of adaptation.SupplementalProperty_asArray) {
-                if (sp.hasOwnProperty(Constants.SCHEME_ID_URI) && sp.hasOwnProperty(DashConstants.VALUE)) {
-                    supplementalProperties[sp[Constants.SCHEME_ID_URI]] = sp[DashConstants.VALUE];
+                if (sp.hasOwnProperty(Constants.SCHEME_ID_URI)) {
+                    // N.B this will only work where there is a single SupplementalProperty descriptor with this SchemeIdUri
+                    supplementalProperties[sp[Constants.SCHEME_ID_URI]] = {...sp};
                 }
             }
         }
@@ -1316,8 +1319,9 @@ function DashManifestModel() {
 
         if (representation && representation.hasOwnProperty(DashConstants.SUPPLEMENTAL_PROPERTY_ASARRAY)) {
             for (const sp of representation.SupplementalProperty_asArray) {
-                if (sp.hasOwnProperty(Constants.SCHEME_ID_URI) && sp.hasOwnProperty(DashConstants.VALUE)) {
-                    supplementalProperties[sp[Constants.SCHEME_ID_URI]] = sp[DashConstants.VALUE];
+                if (sp.hasOwnProperty(Constants.SCHEME_ID_URI)) {
+                    // N.B this will only work where there is a single SupplementalProperty descriptor with this SchemeIdUri
+                    supplementalProperties[sp[Constants.SCHEME_ID_URI]] = {...sp};
                 }
             }
         }
@@ -1332,6 +1336,30 @@ function DashManifestModel() {
         });
     }
 
+    /* ESSENTIAL PROPERTY DESCRIPTORS */
+
+    function getEssentialPropertiesForAdaptation(adaptation) {
+        const essentialProperties = {};
+
+        if (adaptation && adaptation.hasOwnProperty(DashConstants.ESSENTIAL_PROPERTY_ASARRAY)) {
+            for (const ep of adaptation.EssentialProperty_asArray) {
+                if (ep.hasOwnProperty(Constants.SCHEME_ID_URI)) {
+                    // N.B this will only work where there is a single EssentialProperty descriptor with this SchemeIdUri
+                    essentialProperties[ep[Constants.SCHEME_ID_URI]] = {...ep};
+                }
+            }
+        }
+        return essentialProperties;
+    }
+
+    function getEssentialPropertiesAsArrayForAdaptation(adaptation) {
+        if (!adaptation || !adaptation.hasOwnProperty(DashConstants.ESSENTIAL_PROPERTY_ASARRAY) || !adaptation.EssentialProperty_asArray.length) return [];
+        return adaptation.EssentialProperty_asArray.map( supp => {
+            const s = new DescriptorType();
+            return s.init(supp);
+        });
+    }
+
     function setConfig(config) {
         if (!config) return;
 
@@ -1382,6 +1410,8 @@ function DashManifestModel() {
         getRegularPeriods,
         getMpd,
         getEventsForPeriod,
+        getEssentialPropertiesForAdaptation,
+        getEssentialPropertiesAsArrayForAdaptation,
         getEssentialPropertiesForRepresentation,
         getEventStreamForAdaptationSet,
         getEventStreamForRepresentation,

src/dash/vo/DescriptorType.js

@@ -32,6 +32,8 @@
  * @class
  * @ignore
  */
+import DashConstants from '../constants/DashConstants'
+
 class DescriptorType {
     constructor() {
         this.schemeIdUri = null;
@@ -44,6 +46,16 @@ class DescriptorType {
             this.schemeIdUri = data.schemeIdUri ? data.schemeIdUri : null;
             this.value = data.value ? data.value : null;
             this.id = data.id ? data.id : null;
+            // Only add the DVB extensions if they exist
+            if (data[DashConstants.DVB_URL]) {
+                this.dvb_url = data[DashConstants.DVB_URL]
+            }
+            if (data[DashConstants.DVB_MIMETYPE]) {
+                this.dvb_mimeType = data[DashConstants.DVB_MIMETYPE]
+            }
+            if (data[DashConstants.DVB_FONTFAMILY]) {
+                this.dvb_fontFamily = data[DashConstants.DVB_FONTFAMILY]
+            }
         }
         return this;
     }

src/dash/vo/MediaInfo.js

@@ -60,6 +60,8 @@ class MediaInfo {
         this.selectionPriority = 1;
         this.supplementalProperties = {};
         this.supplementalPropertiesAsArray = [];
+        this.essentialProperties = {};
+        this.essentialPropertiesAsArray = [];
         this.segmentAlignment = false;
         this.subSegmentAlignment = false;
     }

src/streaming/MediaPlayer.js

@@ -2178,6 +2178,7 @@ function MediaPlayer() {
                 manifestModel,
                 adapter,
                 mediaController,
+                baseURLController,
                 videoModel,
                 settings
             });

src/streaming/constants/Constants.js

@@ -278,17 +278,22 @@ class Constants {
         this.INITIALIZE = 'initialize';
         this.TEXT_SHOWING = 'showing';
         this.TEXT_HIDDEN = 'hidden';
+        this.TEXT_DISABLED = 'disabled';
         this.CC1 = 'CC1';
         this.CC3 = 'CC3';
         this.UTF8 = 'utf-8';
         this.SCHEME_ID_URI = 'schemeIdUri';
         this.START_TIME = 'starttime';
         this.SERVICE_DESCRIPTION_DVB_LL_SCHEME = 'urn:dvb:dash:lowlatency:scope:2019';
         this.SUPPLEMENTAL_PROPERTY_DVB_LL_SCHEME = 'urn:dvb:dash:lowlatency:critical:2019';
+        this.FONT_DOWNLOAD_DVB_SCHEME = 'urn:dvb:dash:fontdownload:2014';
         this.XML = 'XML';
         this.ARRAY_BUFFER = 'ArrayBuffer';
         this.DVB_REPORTING_URL = 'dvb:reportingUrl';
         this.DVB_PROBABILITY = 'dvb:probability';
+        this.OFF_MIMETYPE = 'application/font-sfnt';
+        this.WOFF_MIMETYPE = 'application/font-woff';
+        this.TTS_FONT_FAMILY = 'http://www.w3.org/ns/ttml#styling fontFamily';
         this.VIDEO_ELEMENT_READY_STATES = {
             HAVE_NOTHING: 0,
             HAVE_METADATA: 1,

src/streaming/controllers/PlaybackController.js

@@ -836,7 +836,8 @@ function PlaybackController() {
 
     function _checkEnableLowLatency(mediaInfo) {
         if (mediaInfo && mediaInfo.supplementalProperties &&
-            mediaInfo.supplementalProperties[Constants.SUPPLEMENTAL_PROPERTY_DVB_LL_SCHEME] === 'true') {
+            mediaInfo.supplementalProperties[Constants.SUPPLEMENTAL_PROPERTY_DVB_LL_SCHEME] &&
+            mediaInfo.supplementalProperties[Constants.SUPPLEMENTAL_PROPERTY_DVB_LL_SCHEME].value === 'true') {
             logger.debug('Low Latency critical SupplementalProperty set: Enabling low Latency');
             lowLatencyModeEnabled = true;
         }