mediabunny 1.24.7 → 1.25.0

package/dist/bundles/mediabunny.cjs

@@ -723,7 +723,7 @@ var Mediabunny = (() => {
     return typeof x === "number" && !Number.isNaN(x);
   };
 
-  // src/tags.ts
+  // src/metadata.ts
   var RichImageData = class {
     /** Creates a new {@link RichImageData}. */
     constructor(data, mimeType) {
@@ -836,6 +836,37 @@ var Mediabunny = (() => {
   var metadataTagsAreEmpty = (tags) => {
     return tags.title === void 0 && tags.description === void 0 && tags.artist === void 0 && tags.album === void 0 && tags.albumArtist === void 0 && tags.trackNumber === void 0 && tags.tracksTotal === void 0 && tags.discNumber === void 0 && tags.discsTotal === void 0 && tags.genre === void 0 && tags.date === void 0 && tags.lyrics === void 0 && (!tags.images || tags.images.length === 0) && tags.comment === void 0 && (tags.raw === void 0 || Object.keys(tags.raw).length === 0);
   };
+  var DEFAULT_TRACK_DISPOSITION = {
+    default: true,
+    forced: false,
+    original: false,
+    commentary: false,
+    hearingImpaired: false,
+    visuallyImpaired: false
+  };
+  var validateTrackDisposition = (disposition) => {
+    if (!disposition || typeof disposition !== "object") {
+      throw new TypeError("disposition must be an object.");
+    }
+    if (disposition.default !== void 0 && typeof disposition.default !== "boolean") {
+      throw new TypeError("disposition.default must be a boolean.");
+    }
+    if (disposition.forced !== void 0 && typeof disposition.forced !== "boolean") {
+      throw new TypeError("disposition.forced must be a boolean.");
+    }
+    if (disposition.original !== void 0 && typeof disposition.original !== "boolean") {
+      throw new TypeError("disposition.original must be a boolean.");
+    }
+    if (disposition.commentary !== void 0 && typeof disposition.commentary !== "boolean") {
+      throw new TypeError("disposition.commentary must be a boolean.");
+    }
+    if (disposition.hearingImpaired !== void 0 && typeof disposition.hearingImpaired !== "boolean") {
+      throw new TypeError("disposition.hearingImpaired must be a boolean.");
+    }
+    if (disposition.visuallyImpaired !== void 0 && typeof disposition.visuallyImpaired !== "boolean") {
+      throw new TypeError("disposition.visuallyImpaired must be a boolean.");
+    }
+  };
 
   // src/codec.ts
   var VIDEO_CODECS = [
@@ -6254,6 +6285,10 @@ var Mediabunny = (() => {
     get timeResolution() {
       return this._backing.getTimeResolution();
     }
+    /** The track's disposition, i.e. information about its intended usage. */
+    get disposition() {
+      return this._backing.getDisposition();
+    }
     /**
      * Returns the start timestamp of the first packet of this track, in seconds. While often near zero, this value
      * may be positive or even negative. A negative starting timestamp means the track's timing has been offset. Samples
@@ -6608,6 +6643,7 @@ var Mediabunny = (() => {
             if (!moovSlice) break;
             this.moovSlice = moovSlice;
             this.readContiguousBoxes(this.moovSlice);
+            this.tracks.sort((a, b) => Number(b.disposition.default) - Number(a.disposition.default));
             for (const track of this.tracks) {
               const previousSegmentDurationsInSeconds = track.editListPreviousSegmentDurations / this.movieTimescale;
               track.editListOffset -= Math.round(previousSegmentDurationsInSeconds * track.timescale);
@@ -6854,6 +6890,9 @@ var Mediabunny = (() => {
               id: -1,
               demuxer: this,
               inputTrack: null,
+              disposition: {
+                ...DEFAULT_TRACK_DISPOSITION
+              },
               info: null,
               timescale: -1,
               durationInMovieTimescale: -1,
@@ -6895,10 +6934,8 @@ var Mediabunny = (() => {
             }
             const version = readU8(slice);
             const flags = readU24Be(slice);
-            const trackEnabled = (flags & 1) !== 0;
-            if (!trackEnabled) {
-              break;
-            }
+            const trackEnabled = !!(flags & 1);
+            track.disposition.default = trackEnabled;
             if (version === 0) {
               slice.skip(8);
               track.id = readU32Be(slice);
@@ -8374,6 +8411,9 @@ var Mediabunny = (() => {
     getTimeResolution() {
       return this.internalTrack.timescale;
     }
+    getDisposition() {
+      return this.internalTrack.disposition;
+    }
     async computeDuration() {
       const lastPacket = await this.getPacket(Infinity, { metadataOnly: true });
       return (lastPacket?.timestamp ?? 0) + (lastPacket?.duration ?? 0);
@@ -9597,7 +9637,7 @@ var Mediabunny = (() => {
         this.currentSegment.timestampScale = 1e6;
         this.currentSegment.timestampFactor = 1e9 / 1e6;
       }
-      this.currentSegment.tracks.sort((a, b) => Number(b.isDefault) - Number(a.isDefault));
+      this.currentSegment.tracks.sort((a, b) => Number(b.disposition.default) - Number(a.disposition.default));
       const idToTrack = new Map(this.currentSegment.tracks.map((x) => [x.id, x]));
       for (const cuePoint of this.currentSegment.cuePoints) {
         const track = idToTrack.get(cuePoint.trackId);
@@ -9944,7 +9984,9 @@ var Mediabunny = (() => {
               demuxer: this,
               clusterPositionCache: [],
               cuePoints: [],
-              isDefault: false,
+              disposition: {
+                ...DEFAULT_TRACK_DISPOSITION
+              },
               inputTrack: null,
               codecId: null,
               codecPrivate: null,
@@ -10088,7 +10130,42 @@ var Mediabunny = (() => {
         case 136 /* FlagDefault */:
           {
             if (!this.currentTrack) break;
-            this.currentTrack.isDefault = !!readUnsignedInt(slice, size);
+            this.currentTrack.disposition.default = !!readUnsignedInt(slice, size);
+          }
+          ;
+          break;
+        case 21930 /* FlagForced */:
+          {
+            if (!this.currentTrack) break;
+            this.currentTrack.disposition.forced = !!readUnsignedInt(slice, size);
+          }
+          ;
+          break;
+        case 21934 /* FlagOriginal */:
+          {
+            if (!this.currentTrack) break;
+            this.currentTrack.disposition.original = !!readUnsignedInt(slice, size);
+          }
+          ;
+          break;
+        case 21931 /* FlagHearingImpaired */:
+          {
+            if (!this.currentTrack) break;
+            this.currentTrack.disposition.hearingImpaired = !!readUnsignedInt(slice, size);
+          }
+          ;
+          break;
+        case 21932 /* FlagVisualImpaired */:
+          {
+            if (!this.currentTrack) break;
+            this.currentTrack.disposition.visuallyImpaired = !!readUnsignedInt(slice, size);
+          }
+          ;
+          break;
+        case 21935 /* FlagCommentary */:
+          {
+            if (!this.currentTrack) break;
+            this.currentTrack.disposition.commentary = !!readUnsignedInt(slice, size);
           }
           ;
           break;
@@ -10811,6 +10888,9 @@ var Mediabunny = (() => {
     getTimeResolution() {
       return this.internalTrack.segment.timestampFactor;
     }
+    getDisposition() {
+      return this.internalTrack.disposition;
+    }
     async getFirstPacket(options) {
       return this.performClusterLookup(
         null,
@@ -12588,6 +12668,11 @@ var Mediabunny = (() => {
       assert(this.demuxer.firstFrameHeader);
       return this.demuxer.firstFrameHeader.sampleRate;
     }
+    getDisposition() {
+      return {
+        ...DEFAULT_TRACK_DISPOSITION
+      };
+    }
     async getDecoderConfig() {
       assert(this.demuxer.firstFrameHeader);
       return {
@@ -13105,6 +13190,11 @@ var Mediabunny = (() => {
     getLanguageCode() {
       return UNDETERMINED_LANGUAGE;
     }
+    getDisposition() {
+      return {
+        ...DEFAULT_TRACK_DISPOSITION
+      };
+    }
     async getFirstTimestamp() {
       return 0;
     }
@@ -13845,6 +13935,11 @@ var Mediabunny = (() => {
     getLanguageCode() {
       return UNDETERMINED_LANGUAGE;
     }
+    getDisposition() {
+      return {
+        ...DEFAULT_TRACK_DISPOSITION
+      };
+    }
     async getFirstTimestamp() {
       return 0;
     }
@@ -14100,6 +14195,11 @@ var Mediabunny = (() => {
       assert(sampleRate !== void 0);
       return sampleRate;
     }
+    getDisposition() {
+      return {
+        ...DEFAULT_TRACK_DISPOSITION
+      };
+    }
     async getDecoderConfig() {
       assert(this.demuxer.firstFrameHeader);
       const bytes2 = new Uint8Array(3);
@@ -14680,6 +14780,11 @@ var Mediabunny = (() => {
       assert(this.demuxer.audioInfo);
       return this.demuxer.audioInfo.sampleRate;
     }
+    getDisposition() {
+      return {
+        ...DEFAULT_TRACK_DISPOSITION
+      };
+    }
     async getFirstTimestamp() {
       return 0;
     }
@@ -17090,7 +17195,11 @@ var Mediabunny = (() => {
     } else {
       matrix = IDENTITY_MATRIX;
     }
-    return fullBox("tkhd", +needsU64, 3, [
+    let flags = 2;
+    if (trackData.track.metadata.disposition?.default !== false) {
+      flags |= 1;
+    }
+    return fullBox("tkhd", +needsU64, flags, [
       u32OrU64(creationTime),
       // Creation time
       u32OrU64(creationTime),
@@ -19802,6 +19911,12 @@ var Mediabunny = (() => {
           { id: 215 /* TrackNumber */, data: trackData.track.id },
           { id: 29637 /* TrackUID */, data: trackData.track.id },
           { id: 131 /* TrackType */, data: TRACK_TYPE_MAP[trackData.type] },
+          trackData.track.metadata.disposition?.default === false ? { id: 136 /* FlagDefault */, data: 0 } : null,
+          trackData.track.metadata.disposition?.forced ? { id: 21930 /* FlagForced */, data: 1 } : null,
+          trackData.track.metadata.disposition?.hearingImpaired ? { id: 21931 /* FlagHearingImpaired */, data: 1 } : null,
+          trackData.track.metadata.disposition?.visuallyImpaired ? { id: 21932 /* FlagVisualImpaired */, data: 1 } : null,
+          trackData.track.metadata.disposition?.original ? { id: 21934 /* FlagOriginal */, data: 1 } : null,
+          trackData.track.metadata.disposition?.commentary ? { id: 21935 /* FlagCommentary */, data: 1 } : null,
           { id: 156 /* FlagLacing */, data: 0 },
           { id: 2274716 /* Language */, data: trackData.track.metadata.languageCode ?? UNDETERMINED_LANGUAGE },
           { id: 134 /* CodecID */, data: codecId },
@@ -23823,6 +23938,9 @@ ${cue.notes ?? ""}`;
     if (metadata.name !== void 0 && typeof metadata.name !== "string") {
       throw new TypeError("metadata.name, when provided, must be a string.");
     }
+    if (metadata.disposition !== void 0) {
+      validateTrackDisposition(metadata.disposition);
+    }
     if (metadata.maximumPacketCount !== void 0 && (!Number.isInteger(metadata.maximumPacketCount) || metadata.maximumPacketCount < 0)) {
       throw new TypeError("metadata.maximumPacketCount, when provided, must be a non-negative integer.");
     }
@@ -24730,9 +24848,10 @@ The @mediabunny/mp3-encoder extension package provides support for encoding MP3.
       }
       this.output.addVideoTrack(videoSource, {
         frameRate: trackOptions.frameRate,
-        // TEMP: This condition can be removed when all demuxers properly homogenize to BCP47 in v2
+        // TODO: This condition can be removed when all demuxers properly homogenize to BCP47 in v2
         languageCode: isIso639Dash2LanguageCode(track.languageCode) ? track.languageCode : void 0,
         name: track.name ?? void 0,
+        disposition: track.disposition,
         rotation: needsRerender ? 0 : totalRotation
         // Rerendering will bake the rotation into the output
       });
@@ -24896,9 +25015,10 @@ The @mediabunny/mp3-encoder extension package provides support for encoding MP3.
         }
       }
       this.output.addAudioTrack(audioSource, {
-        // TEMP: This condition can be removed when all demuxers properly homogenize to BCP47 in v2
+        // TODO: This condition can be removed when all demuxers properly homogenize to BCP47 in v2
         languageCode: isIso639Dash2LanguageCode(track.languageCode) ? track.languageCode : void 0,
-        name: track.name ?? void 0
+        name: track.name ?? void 0,
+        disposition: track.disposition
       });
       this._addedCounts.audio++;
       this._totalTrackCount++;