@amazon/vinyl 1.2.0 → 2.0.0

package/dist/types/current/text/TextTrack.d.ts

@@ -0,0 +1,125 @@
+import type { ChangeEvent } from '../event/ChangeEvent';
+import type { ReadonlyEventHost } from '@amazon/vinyl-util';
+/**
+ * Categorizes the role of a text track. Mirrors HTMLMediaElement.TextTrackKind.
+ */
+export type TextTrackKind = 'subtitles' | 'captions' | 'descriptions' | 'chapters' | 'metadata';
+/**
+ * Identifies and describes an available text track.
+ * One TextTrackInfo is produced per discovered subtitle rendition.
+ */
+export interface TextTrackInfo {
+    /**
+     * A stable, unique identifier within the current media presentation.
+     */
+    readonly id: string;
+    /**
+     * The text track kind. Defaults to 'subtitles' when not otherwise specified.
+     */
+    readonly kind: TextTrackKind;
+    /**
+     * The BCP 47 language tag for the cues in this track, or null if unknown.
+     */
+    readonly language: string | null;
+    /**
+     * A human-readable label for the track.
+     */
+    readonly label: string;
+    /**
+     * Set when the source manifest signals this track as the default selection.
+     */
+    readonly default: boolean;
+    /**
+     * Whether this is a forced track: it carries essential text (e.g.
+     * translations of foreign-language dialogue) meant to be shown even when
+     * the user has not enabled subtitles. Two tracks may share a language and
+     * differ only by this flag, so selection must distinguish them.
+     */
+    readonly forced: boolean;
+    /**
+     * Media characteristics / accessibility roles describing the track, e.g.
+     * `public.accessibility.transcribes-spoken-dialog` (HLS CHARACTERISTICS) or
+     * a DASH role/accessibility scheme value. Empty when none are signaled.
+     */
+    readonly characteristics: readonly string[];
+    /**
+     * The full URL of the underlying text resource (typically a WebVTT file).
+     */
+    readonly uri: string;
+    /**
+     * The MIME type signaled by the source manifest, when known.
+     */
+    readonly mimeType: string | null;
+    /**
+     * HLS EXT-X-DEFINE variables inherited from the parent multivariant
+     * playlist. Sidecar text-track media playlists commonly `IMPORT` these
+     * names and reference them in segment URIs. Present only for HLS-sourced
+     * tracks whose parent playlist declared any variables.
+     */
+    readonly variables?: Readonly<Record<string, string>>;
+}
+/**
+ * Events dispatched by a {@link TextTrackController}.
+ */
+export interface TextTrackEventMap {
+    /**
+     * Emitted when the available text tracks change.
+     */
+    readonly textTracksChange: ChangeEvent<readonly TextTrackInfo[]>;
+    /**
+     * Emitted when the active text track changes.
+     */
+    readonly activeTextTrackChange: ChangeEvent<TextTrackInfo | null>;
+    /**
+     * Emitted when an error occurs while loading or activating a text track.
+     */
+    readonly textTrackError: TextTrackErrorEvent;
+}
+export interface TextTrackErrorEvent {
+    readonly track: TextTrackInfo;
+    readonly error: Error;
+}
+export declare const ALL_TEXT_TRACK_EVENTS: readonly ["textTracksChange", "activeTextTrackChange", "textTrackError"];
+/**
+ * Read-only view of available text tracks and the active selection.
+ */
+export interface ReadonlyTextTrackController extends ReadonlyEventHost<TextTrackEventMap> {
+    /**
+     * The list of currently discovered text tracks.
+     */
+    readonly textTracks: readonly TextTrackInfo[];
+    /**
+     * The currently active text track, or null if none is active.
+     */
+    readonly activeTextTrack: TextTrackInfo | null;
+}
+/**
+ * Provides access to the text tracks of the current media and allows
+ * selecting one for playback.
+ *
+ * Selection is persisted across track changes only when applications choose
+ * to call {@link setActiveTextTrack} again on the new track. This matches
+ * how audio tracks are typically driven.
+ */
+export interface TextTrackController extends ReadonlyTextTrackController {
+    /**
+     * Selects the text track with the given id, or clears the active text
+     * track when called with null. No-op if the id does not match a known
+     * text track.
+     */
+    setActiveTextTrack(id: string | null): void;
+    /**
+     * Suspends cue rendering without changing the active selection: cancels any
+     * in-flight load and tears down the DOM text track (so its cues stop
+     * showing). Called when the owning media track is deactivated — e.g. while
+     * an ad plays over the suspended content. {@link resume} rebuilds it.
+     */
+    suspend(): void;
+    /**
+     * Rebuilds the DOM text track for the active selection after a
+     * {@link suspend}, reloading its cues. No-op when nothing is active or when
+     * already rendering. Called when the owning media track is reactivated.
+     */
+    resume(): void;
+}
+//# sourceMappingURL=TextTrack.d.ts.map

package/dist/types/current/text/TextTrack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextTrack.d.ts","sourceRoot":"","sources":["../../../../src/text/TextTrack.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,aAAa,GACnB,WAAW,GACX,UAAU,GACV,cAAc,GACd,UAAU,GACV,UAAU,CAAA;AAEhB;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IAEzB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAA;IAE3C;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAEhC;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,WAAW,CAAC,SAAS,aAAa,EAAE,CAAC,CAAA;IAEhE;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,WAAW,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IAEjE;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,mBAAmB,CAAA;CAC/C;AAED,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CACxB;AAED,eAAO,MAAM,qBAAqB,0EAIuB,CAAA;AAEzD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB,CAAC,iBAAiB,CAAC;IACrF;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,aAAa,EAAE,CAAA;IAE7C;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,aAAa,GAAG,IAAI,CAAA;CACjD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAoB,SAAQ,2BAA2B;IACpE;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAE3C;;;;;OAKG;IACH,OAAO,IAAI,IAAI,CAAA;IAEf;;;;OAIG;IACH,MAAM,IAAI,IAAI,CAAA;CACjB"}

package/dist/types/current/text/TextTrack.js

@@ -0,0 +1,9 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export const ALL_TEXT_TRACK_EVENTS = [
+    'textTracksChange',
+    'activeTextTrackChange',
+    'textTrackError',
+];

package/dist/types/current/text/VttCueStyle.d.ts

@@ -0,0 +1,41 @@
+import type { ObjectSchema } from '@amazon/vinyl-validation';
+/**
+ * Layout style applied to each rendered WebVTT cue, mirroring the settable
+ * positioning properties of the DOM `VTTCue`. Only the properties that are set
+ * are applied; the rest keep the browser defaults.
+ *
+ * These are the WebVTT cue-box layout controls (not text color/font, which are
+ * only reachable via the non-configurable `::cue` pseudo-element). See
+ * {@link https://developer.mozilla.org/docs/Web/API/VTTCue}.
+ */
+export interface VttCueStyle {
+    /** Text alignment within the cue box. */
+    readonly align?: AlignSetting;
+    /** Line (vertical) position, as a line number/percentage or `'auto'`. */
+    readonly line?: number | AutoKeyword;
+    /** How `line` is anchored. */
+    readonly lineAlign?: LineAlignSetting;
+    /** Inline position of the cue box, as a percentage or `'auto'`. */
+    readonly position?: number | AutoKeyword;
+    /** How `position` is anchored. */
+    readonly positionAlign?: PositionAlignSetting;
+    /** Size of the cue box as a percentage of the video dimension. */
+    readonly size?: number;
+    /** Whether `line` is a line number (true) or a percentage (false). */
+    readonly snapToLines?: boolean;
+    /** Writing direction. */
+    readonly vertical?: DirectionSetting;
+}
+/**
+ * Type guard for a DOM cue that is a `VTTCue` (and so carries the WebVTT layout
+ * properties). On platforms without `VTTCue`, cues are plain `TextTrackCue`s
+ * that cannot be styled.
+ */
+export declare function isVttCue(cue: TextTrackCue): cue is VTTCue;
+/**
+ * Applies the configured layout style to a `VTTCue`, setting only the
+ * properties present in `style`.
+ */
+export declare function applyVttCueStyle(cue: VTTCue, style: VttCueStyle): void;
+export declare const vttCueStyleValidator: ObjectSchema<VttCueStyle>;
+//# sourceMappingURL=VttCueStyle.d.ts.map

package/dist/types/current/text/VttCueStyle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VttCueStyle.d.ts","sourceRoot":"","sources":["../../../../src/text/VttCueStyle.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAG5D;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IACxB,yCAAyC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAA;IAC7B,yEAAyE;IACzE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IACpC,8BAA8B;IAC9B,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAA;IACrC,mEAAmE;IACnE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IACxC,kCAAkC;IAClC,QAAQ,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAA;IAC7C,kEAAkE;IAClE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IACtB,sEAAsE;IACtE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;IAC9B,yBAAyB;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAA;CACvC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,MAAM,CAEzD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,IAAI,CAUtE;AAED,eAAO,MAAM,oBAAoB,EAAE,YAAY,CAAC,WAAW,CAczD,CAAA"}

package/dist/types/current/text/VttCueStyle.js

@@ -0,0 +1,45 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { boolean, isOneOf, number, object } from '@amazon/vinyl-validation';
+/**
+ * Type guard for a DOM cue that is a `VTTCue` (and so carries the WebVTT layout
+ * properties). On platforms without `VTTCue`, cues are plain `TextTrackCue`s
+ * that cannot be styled.
+ */
+export function isVttCue(cue) {
+    return typeof VTTCue !== 'undefined' && cue instanceof VTTCue;
+}
+/**
+ * Applies the configured layout style to a `VTTCue`, setting only the
+ * properties present in `style`.
+ */
+export function applyVttCueStyle(cue, style) {
+    if (style.align !== undefined)
+        cue.align = style.align;
+    if (style.line !== undefined)
+        cue.line = style.line;
+    if (style.lineAlign !== undefined)
+        cue.lineAlign = style.lineAlign;
+    if (style.position !== undefined)
+        cue.position = style.position;
+    if (style.positionAlign !== undefined)
+        cue.positionAlign = style.positionAlign;
+    if (style.size !== undefined)
+        cue.size = style.size;
+    if (style.snapToLines !== undefined)
+        cue.snapToLines = style.snapToLines;
+    if (style.vertical !== undefined)
+        cue.vertical = style.vertical;
+}
+export const vttCueStyleValidator = object({
+    align: isOneOf('start', 'center', 'end', 'left', 'right').optional(),
+    line: number().or(isOneOf('auto')).optional(),
+    lineAlign: isOneOf('start', 'center', 'end').optional(),
+    position: number().or(isOneOf('auto')).optional(),
+    positionAlign: isOneOf('line-left', 'center', 'line-right', 'auto').optional(),
+    size: number().optional(),
+    snapToLines: boolean().optional(),
+    vertical: isOneOf('', 'rl', 'lr').optional(),
+});

package/dist/types/current/text/discoverDashTextTracks.d.ts

@@ -0,0 +1,24 @@
+import type { DashManifest } from '@amazon/vinyl-mpd-parser';
+import type { TextTrackInfo } from './TextTrack';
+/**
+ * Discovers sidecar text tracks from a DASH manifest.
+ *
+ * Considers an `<AdaptationSet>` to carry text when one of:
+ *  - `contentType="text"`
+ *  - `mimeType` starts with `text/` (e.g. `text/vtt`)
+ *  - `mimeType` is `application/mp4` *and* the codec/role indicates text
+ *
+ * Within a text adaptation set, each `<Representation>` becomes one
+ * {@link TextTrackInfo}. The `BaseURL` chain (MPD → Period → AdaptationSet →
+ * Representation) is resolved against the supplied `baseUrl`.
+ *
+ * Only sidecar (single-file) WebVTT renditions are surfaced. Segmented text
+ * tracks (`stpp`/`wvtt` codecs) are ignored - they would require streaming
+ * through MSE which the sidecar pipeline does not support.
+ *
+ * @param manifest The parsed DASH manifest.
+ * @param baseUrl The URL of the manifest, used as the root for `BaseURL`
+ * resolution.
+ */
+export declare function discoverDashTextTracks(manifest: DashManifest, baseUrl: string): readonly TextTrackInfo[];
+//# sourceMappingURL=discoverDashTextTracks.d.ts.map

package/dist/types/current/text/discoverDashTextTracks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discoverDashTextTracks.d.ts","sourceRoot":"","sources":["../../../../src/text/discoverDashTextTracks.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAE5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CAClC,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,MAAM,GAChB,SAAS,aAAa,EAAE,CAwD1B"}

package/dist/types/current/text/discoverDashTextTracks.js

@@ -0,0 +1,109 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { resolveUrl } from '@amazon/vinyl-util';
+/**
+ * Discovers sidecar text tracks from a DASH manifest.
+ *
+ * Considers an `<AdaptationSet>` to carry text when one of:
+ *  - `contentType="text"`
+ *  - `mimeType` starts with `text/` (e.g. `text/vtt`)
+ *  - `mimeType` is `application/mp4` *and* the codec/role indicates text
+ *
+ * Within a text adaptation set, each `<Representation>` becomes one
+ * {@link TextTrackInfo}. The `BaseURL` chain (MPD → Period → AdaptationSet →
+ * Representation) is resolved against the supplied `baseUrl`.
+ *
+ * Only sidecar (single-file) WebVTT renditions are surfaced. Segmented text
+ * tracks (`stpp`/`wvtt` codecs) are ignored - they would require streaming
+ * through MSE which the sidecar pipeline does not support.
+ *
+ * @param manifest The parsed DASH manifest.
+ * @param baseUrl The URL of the manifest, used as the root for `BaseURL`
+ * resolution.
+ */
+export function discoverDashTextTracks(manifest, baseUrl) {
+    const out = [];
+    const periods = manifest.MPD.Period;
+    const mpdBase = chainBase(baseUrl, manifest.MPD.BaseURL);
+    for (let p = 0; p < periods.length; p++) {
+        const period = periods[p];
+        const periodBase = chainBase(mpdBase, period.BaseURL);
+        const adaptationSets = period.AdaptationSet ?? [];
+        for (const adaptationSet of adaptationSets) {
+            if (!isTextAdaptationSet(adaptationSet))
+                continue;
+            const asBase = chainBase(periodBase, adaptationSet.BaseURL);
+            const representations = adaptationSet.Representation ?? [];
+            for (const representation of representations) {
+                const repBase = chainBase(asBase, representation.BaseURL);
+                const uri = pickRepresentationUri(repBase, representation.id);
+                const mimeType = representation.mimeType ?? adaptationSet.mimeType ?? null;
+                // Only surface sidecar formats. Segmented text (stpp/wvtt) is
+                // intentionally skipped.
+                if (!isSidecarTextMime(mimeType))
+                    continue;
+                const language = adaptationSet.lang ?? null;
+                const roleValues = (adaptationSet.Role ?? [])
+                    .filter((d) => d.schemeIdUri === 'urn:mpeg:dash:role:2011')
+                    .map((d) => d.value)
+                    .filter((v) => v != null);
+                // Accessibility descriptors (e.g. SDH / hard-of-hearing) also
+                // describe the track's role; surface them as characteristics.
+                const accessibility = (adaptationSet.Accessibility ?? [])
+                    .map((d) => d.value)
+                    .filter((v) => v != null);
+                const characteristics = [...roleValues, ...accessibility];
+                const isCaption = roleValues.includes('caption');
+                const isDefault = roleValues.includes('main');
+                // DASH signals forced text via the `forced_subtitle` /
+                // `forced-subtitle` role value.
+                const forced = roleValues.includes('forced_subtitle') ||
+                    roleValues.includes('forced-subtitle');
+                out.push({
+                    id: `dash-text-${p}-${representation.id}`,
+                    kind: isCaption ? 'captions' : 'subtitles',
+                    language,
+                    label: language ?? representation.id,
+                    default: isDefault,
+                    forced,
+                    characteristics,
+                    uri,
+                    mimeType,
+                });
+            }
+        }
+    }
+    return out;
+}
+function isTextAdaptationSet(adaptationSet) {
+    if (adaptationSet.contentType === 'text')
+        return true;
+    const mt = adaptationSet.mimeType;
+    if (mt && mt.startsWith('text/'))
+        return true;
+    return false;
+}
+function isSidecarTextMime(mimeType) {
+    // Permissive when manifest omits the MIME type, otherwise require a
+    // text/* MIME type. Segmented codec-only types like application/mp4
+    // (used with stpp/wvtt codecs) are excluded.
+    if (mimeType == null)
+        return true;
+    return mimeType.startsWith('text/');
+}
+function chainBase(parent, bases) {
+    if (!bases || bases.length === 0)
+        return parent;
+    return resolveUrl(bases[0]._content, parent);
+}
+function pickRepresentationUri(base, id) {
+    // For a sidecar text representation, the BaseURL is expected to point at
+    // the file. When the chain ends in a directory (trailing `/`), append a
+    // conventional `<id>.vtt` filename so the loader can fetch the resource.
+    if (base.endsWith('/')) {
+        return resolveUrl(`${id}.vtt`, base);
+    }
+    return base;
+}

package/dist/types/current/text/discoverHlsTextTracks.d.ts

@@ -0,0 +1,19 @@
+import type { HlsMainPlaylist } from '@amazon/vinyl-hls-parser';
+import type { TextTrackInfo } from './TextTrack';
+/**
+ * Discovers sidecar text tracks from an HLS multivariant playlist.
+ *
+ * Per RFC 8216 §4.3.4.2, subtitle renditions are signaled with
+ * `EXT-X-MEDIA:TYPE=SUBTITLES` and (when usable as sidecar) carry a `URI`
+ * attribute pointing at a media playlist or, in the simplified single-file
+ * case, a `.vtt` file directly.
+ *
+ * Closed captions (`TYPE=CLOSED-CAPTIONS`) are intentionally excluded - they
+ * are delivered in-band with the video stream and are surfaced by the browser
+ * automatically, not through a sidecar fetch.
+ *
+ * @param mainPlaylist The parsed HLS main playlist.
+ * @param baseUrl The URL of the main playlist, used to resolve relative URIs.
+ */
+export declare function discoverHlsTextTracks(mainPlaylist: HlsMainPlaylist, baseUrl: string): readonly TextTrackInfo[];
+//# sourceMappingURL=discoverHlsTextTracks.d.ts.map

package/dist/types/current/text/discoverHlsTextTracks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discoverHlsTextTracks.d.ts","sourceRoot":"","sources":["../../../../src/text/discoverHlsTextTracks.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAE/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAEhD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,qBAAqB,CACjC,YAAY,EAAE,eAAe,EAC7B,OAAO,EAAE,MAAM,GAChB,SAAS,aAAa,EAAE,CA2B1B"}

package/dist/types/current/text/discoverHlsTextTracks.js

@@ -0,0 +1,49 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { resolveUrl } from '@amazon/vinyl-util';
+/**
+ * Discovers sidecar text tracks from an HLS multivariant playlist.
+ *
+ * Per RFC 8216 §4.3.4.2, subtitle renditions are signaled with
+ * `EXT-X-MEDIA:TYPE=SUBTITLES` and (when usable as sidecar) carry a `URI`
+ * attribute pointing at a media playlist or, in the simplified single-file
+ * case, a `.vtt` file directly.
+ *
+ * Closed captions (`TYPE=CLOSED-CAPTIONS`) are intentionally excluded - they
+ * are delivered in-band with the video stream and are surfaced by the browser
+ * automatically, not through a sidecar fetch.
+ *
+ * @param mainPlaylist The parsed HLS main playlist.
+ * @param baseUrl The URL of the main playlist, used to resolve relative URIs.
+ */
+export function discoverHlsTextTracks(mainPlaylist, baseUrl) {
+    const out = [];
+    let index = 0;
+    const parentDefines = mainPlaylist.defines && Object.keys(mainPlaylist.defines).length > 0
+        ? mainPlaylist.defines
+        : undefined;
+    for (const rendition of mainPlaylist.alternativeRenditions) {
+        if (rendition.type !== 'SUBTITLES')
+            continue;
+        if (!rendition.uri)
+            continue;
+        const resolved = resolveUrl(rendition.uri, baseUrl);
+        out.push({
+            id: `hls-text-${index++}-${rendition.groupId}-${rendition.name}`,
+            kind: 'subtitles',
+            language: rendition.language ?? null,
+            label: rendition.name,
+            default: rendition.default === true,
+            forced: rendition.forced === true,
+            characteristics: rendition.characteristics ?? [],
+            uri: resolved,
+            // HLS subtitle renditions don't carry a MIME type; WebVTT is the
+            // overwhelmingly dominant format for sidecar HLS subtitles.
+            mimeType: 'text/vtt',
+            ...(parentDefines && { variables: parentDefines }),
+        });
+    }
+    return out;
+}

package/dist/types/current/text/parseWebVtt.d.ts

@@ -0,0 +1,46 @@
+/**
+ * A single WebVTT cue.
+ *
+ * @see https://www.w3.org/TR/webvtt1/
+ */
+export interface WebVttCue {
+    /**
+     * Optional cue identifier, the line that appears before the timing line.
+     */
+    readonly id: string | null;
+    /**
+     * Cue start time in seconds.
+     */
+    readonly startTime: number;
+    /**
+     * Cue end time in seconds.
+     */
+    readonly endTime: number;
+    /**
+     * The cue text payload, with line breaks preserved as `\n`.
+     */
+    readonly text: string;
+}
+/**
+ * The result of parsing a WebVTT document.
+ */
+export interface WebVttDocument {
+    /**
+     * Parsed cues in document order.
+     */
+    readonly cues: readonly WebVttCue[];
+}
+/**
+ * Parses a WebVTT document into a list of cues.
+ *
+ * Implements a forgiving subset of the WebVTT 1.0 specification: header
+ * detection, comment blocks (lines starting with `NOTE`), styling/region
+ * blocks (skipped), cue identifiers, and HH:MM:SS.mmm or MM:SS.mmm timestamps.
+ * Cue settings on the timing line are tolerated and ignored.
+ *
+ * @param input The raw WebVTT document text. Both LF and CRLF line endings
+ * are supported, and a leading BOM is stripped if present.
+ * @throws ValidationError if the input is missing the WEBVTT header.
+ */
+export declare function parseWebVtt(input: string): WebVttDocument;
+//# sourceMappingURL=parseWebVtt.d.ts.map

package/dist/types/current/text/parseWebVtt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseWebVtt.d.ts","sourceRoot":"","sources":["../../../../src/text/parseWebVtt.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,SAAS,EAAE,CAAA;CACtC;AAYD;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAuFzD"}

package/dist/types/current/text/parseWebVtt.js

@@ -0,0 +1,120 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorOrigin, ValidationError } from '@amazon/vinyl-util';
+const WEBVTT_HEADER = 'WEBVTT';
+// Trailing cue settings are tolerated but ignored. They are separated from the
+// end timestamp by whitespace, so the tail is matched as an optional group that
+// begins with a whitespace character. Using `(?:\s.*)?$` rather than `\s*(.*)$`
+// avoids the ambiguous overlap between `\s*` and `.*` (both match spaces), which
+// would allow polynomial backtracking on space-heavy input.
+const TIME_RE = /^\s*(?:(\d+):)?([0-5]?\d):([0-5]?\d)\.(\d{3})\s*-->\s*(?:(\d+):)?([0-5]?\d):([0-5]?\d)\.(\d{3})(?:\s.*)?$/;
+/**
+ * Parses a WebVTT document into a list of cues.
+ *
+ * Implements a forgiving subset of the WebVTT 1.0 specification: header
+ * detection, comment blocks (lines starting with `NOTE`), styling/region
+ * blocks (skipped), cue identifiers, and HH:MM:SS.mmm or MM:SS.mmm timestamps.
+ * Cue settings on the timing line are tolerated and ignored.
+ *
+ * @param input The raw WebVTT document text. Both LF and CRLF line endings
+ * are supported, and a leading BOM is stripped if present.
+ * @throws ValidationError if the input is missing the WEBVTT header.
+ */
+export function parseWebVtt(input) {
+    if (typeof input !== 'string') {
+        throw new ValidationError('WebVTT input must be a string', ErrorOrigin.MEDIA);
+    }
+    let text = input;
+    // Strip BOM
+    if (text.charCodeAt(0) === 0xfeff)
+        text = text.slice(1);
+    // Normalize line endings
+    const lines = text.split(/\r\n|\r|\n/);
+    if (lines.length === 0 || !isWebVttHeader(lines[0])) {
+        throw new ValidationError('WebVTT must begin with a WEBVTT header', ErrorOrigin.MEDIA);
+    }
+    const cues = [];
+    // Per the WebVTT spec, everything from the `WEBVTT` signature up to (and
+    // including) the first blank line is the file header — any metadata
+    // header lines (e.g. HLS's `X-TIMESTAMP-MAP=...`) belong in that block
+    // and MUST NOT be interpreted as cue content.
+    let i = 1;
+    while (i < lines.length && lines[i] !== '')
+        i++;
+    while (i < lines.length) {
+        // Skip empty lines between blocks.
+        if (lines[i] === '') {
+            i++;
+            continue;
+        }
+        // NOTE comment block: skip until blank line.
+        if (lines[i] === 'NOTE' || lines[i].startsWith('NOTE ')) {
+            i++;
+            while (i < lines.length && lines[i] !== '')
+                i++;
+            continue;
+        }
+        // STYLE / REGION blocks - skip until blank line.
+        if (lines[i] === 'STYLE' || lines[i] === 'REGION') {
+            i++;
+            while (i < lines.length && lines[i] !== '')
+                i++;
+            continue;
+        }
+        // Cue: optional identifier, then a timing line, then payload.
+        let id = null;
+        let timingLine;
+        const firstLine = lines[i];
+        if (TIME_RE.test(firstLine)) {
+            timingLine = firstLine;
+            i++;
+        }
+        else {
+            id = firstLine;
+            i++;
+            if (i >= lines.length)
+                break;
+            timingLine = lines[i];
+            i++;
+        }
+        const match = TIME_RE.exec(timingLine);
+        if (!match) {
+            // Skip malformed cue: drain to next blank line.
+            while (i < lines.length && lines[i] !== '')
+                i++;
+            continue;
+        }
+        const startTime = toSeconds(match[1], match[2], match[3], match[4]);
+        const endTime = toSeconds(match[5], match[6], match[7], match[8]);
+        const payloadLines = [];
+        while (i < lines.length && lines[i] !== '') {
+            payloadLines.push(lines[i]);
+            i++;
+        }
+        cues.push({
+            id,
+            startTime,
+            endTime,
+            text: payloadLines.join('\n'),
+        });
+    }
+    return { cues };
+}
+function isWebVttHeader(line) {
+    if (!line.startsWith(WEBVTT_HEADER))
+        return false;
+    if (line.length === WEBVTT_HEADER.length)
+        return true;
+    const next = line.charCodeAt(WEBVTT_HEADER.length);
+    // Header may be followed by space, tab, or any text after a separator.
+    return next === 0x20 || next === 0x09;
+}
+function toSeconds(hours, minutes, seconds, millis) {
+    const h = hours ? Number(hours) : 0;
+    const m = Number(minutes);
+    const s = Number(seconds);
+    const ms = Number(millis);
+    return h * 3600 + m * 60 + s + ms / 1000;
+}

package/dist/types/current/text/pickPreferredTextTrack.d.ts

@@ -0,0 +1,14 @@
+import type { TextTrackInfo } from './TextTrack';
+/**
+ * Chooses the text track that best matches the preferred language(s), or null
+ * when none relate (or there is no preference / no tracks).
+ *
+ * Language dominates: a track is ranked first by which preference it relates to
+ * (earlier entries win) and how closely (see {@link languageRelatedness}).
+ * Within a single language, a full track is preferred over a forced-only track
+ * (a user asking for a caption language wants the full captions, not just the
+ * forced foreign-dialogue cues), and a manifest-default track breaks any
+ * remaining tie.
+ */
+export declare function pickPreferredTextTrack(tracks: readonly TextTrackInfo[], preferred: string | readonly string[] | null): TextTrackInfo | null;
+//# sourceMappingURL=pickPreferredTextTrack.d.ts.map

package/dist/types/current/text/pickPreferredTextTrack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickPreferredTextTrack.d.ts","sourceRoot":"","sources":["../../../../src/text/pickPreferredTextTrack.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAgBhD;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CAClC,MAAM,EAAE,SAAS,aAAa,EAAE,EAChC,SAAS,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,IAAI,GAC7C,aAAa,GAAG,IAAI,CActB"}