@amazon/vinyl-util 1.2.1 → 1.2.2

package/dist/types/current/util/webm/parseWebm.d.ts

@@ -1,43 +0,0 @@
-/** The default `TimecodeScale` (1ms in nanoseconds) when none is present. */
-export declare const DEFAULT_WEBM_TIMECODE_SCALE = 1000000;
-export interface WebmInitInfo {
-    /**
-     * The absolute byte offset (in the file) where the `Segment` element's
-     * content begins. `CueClusterPosition` values are relative to this.
-     */
-    readonly segmentDataStart: number;
-    /**
-     * The `Segment` content size in bytes, or `null` if encoded as unknown.
-     */
-    readonly segmentSize: number | null;
-    /**
-     * The `TimecodeScale` in nanoseconds per tick (cue times are in these ticks).
-     */
-    readonly timecodeScale: number;
-}
-/**
- * Parses a WebM initialization segment for the `Segment` data offset and
- * `TimecodeScale`. The init segment is everything before the first `Cluster`
- * (EBML header, `Segment` header, `SeekHead`, `Info`, `Tracks`).
- */
-export declare function parseWebmInit(buffer: ArrayBuffer): WebmInitInfo;
-/**
- * A single WebM cue point: a cluster's start time and its byte offset relative
- * to the `Segment` data start.
- */
-export interface WebmCuePoint {
-    /**
-     * The cluster's start time, in `TimecodeScale` ticks.
-     */
-    readonly time: number;
-    /**
-     * The cluster's byte offset relative to the `Segment` data start.
-     */
-    readonly clusterPosition: number;
-}
-/**
- * Parses a WebM `Cues` element (as located by a DASH `SegmentBase@indexRange`)
- * into its cue points, in order.
- */
-export declare function parseWebmCues(buffer: ArrayBuffer): readonly WebmCuePoint[];
-//# sourceMappingURL=parseWebm.d.ts.map

package/dist/types/current/util/webm/parseWebm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parseWebm.d.ts","sourceRoot":"","sources":["../../../../../src/util/webm/parseWebm.ts"],"names":[],"mappings":"AA6BA,6EAA6E;AAC7E,eAAO,MAAM,2BAA2B,UAAY,CAAA;AAmGpD,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;CACjC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,WAAW,GAAG,YAAY,CAsB/D;AAcD;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACnC;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,YAAY,EAAE,CAiB1E"}

package/dist/types/current/util/webm/parseWebm.js

@@ -1,166 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { ValidationError } from '../../error/ValidationError';
-import { ErrorOrigin } from '../../error/ErrorOrigin';
-/**
- * A minimal EBML/Matroska (WebM) parser: just enough to index a DASH
- * `SegmentBase` WebM stream — the `Segment` data offset and `TimecodeScale`
- * from the initialization segment, and the `CuePoint`s from the `Cues` element
- * (the WebM equivalent of an ISO-BMFF `sidx`).
- *
- * @module
- */
-/** EBML element IDs (with their length-descriptor marker bits intact). */
-const EBML_ID = {
-    Segment: 0x18538067,
-    Info: 0x1549a966,
-    TimecodeScale: 0x2ad7b1,
-    Cues: 0x1c53bb6b,
-    CuePoint: 0xbb,
-    CueTime: 0xb3,
-    CueTrackPositions: 0xb7,
-    CueClusterPosition: 0xf1,
-};
-/** The default `TimecodeScale` (1ms in nanoseconds) when none is present. */
-export const DEFAULT_WEBM_TIMECODE_SCALE = 1_000_000;
-/**
- * Reads an EBML variable-length integer at `pos`.
- *
- * @param keepMarker When true (element ids), the leading length-descriptor
- * marker bit is retained; when false (sizes/uints), it is stripped to yield the
- * numeric value, and an all-ones value ("unknown size") yields `null`.
- */
-function readVint(view, pos, keepMarker) {
-    const first = view.getUint8(pos);
-    let mask = 0x80;
-    let length = 1;
-    while (length <= 8 && (first & mask) === 0) {
-        mask >>= 1;
-        length++;
-    }
-    if (length > 8)
-        throw new ValidationError('invalid EBML variable-length integer', ErrorOrigin.MEDIA);
-    let value = keepMarker ? first : first & (mask - 1);
-    let allOnes = (first & (mask - 1)) === mask - 1;
-    for (let i = 1; i < length; i++) {
-        const byte = view.getUint8(pos + i);
-        allOnes = allOnes && byte === 0xff;
-        // Multiply (not shift) to stay correct beyond 32 bits.
-        value = value * 256 + byte;
-    }
-    return { value: !keepMarker && allOnes ? null : value, length };
-}
-/**
- * Reads the EBML element header at `pos`.
- */
-function readElementHeader(view, pos) {
-    const { value: id, length: idLength } = readVint(view, pos, true);
-    const { value: size, length: sizeLength } = readVint(view, pos + idLength, false);
-    const contentStart = pos + idLength + sizeLength;
-    return {
-        id: id,
-        contentStart,
-        size,
-        end: size == null ? null : contentStart + size,
-    };
-}
-/**
- * Reads the child element headers in `[start, end)`. An unknown-size element
- * (no bounded end) terminates the list.
- */
-function childHeaders(view, start, end) {
-    const out = [];
-    let pos = start;
-    while (pos < end) {
-        const el = readElementHeader(view, pos);
-        out.push(el);
-        if (el.end == null)
-            break;
-        pos = el.end;
-    }
-    return out;
-}
-/**
- * Reads a big-endian unsigned integer of `length` bytes at `pos`.
- */
-function readUint(view, pos, length) {
-    let value = 0;
-    for (let i = 0; i < length; i++)
-        value = value * 256 + view.getUint8(pos + i);
-    return value;
-}
-/**
- * Parses a WebM initialization segment for the `Segment` data offset and
- * `TimecodeScale`. The init segment is everything before the first `Cluster`
- * (EBML header, `Segment` header, `SeekHead`, `Info`, `Tracks`).
- */
-export function parseWebmInit(buffer) {
-    const view = new DataView(buffer);
-    const segment = childHeaders(view, 0, view.byteLength).find((el) => el.id === EBML_ID.Segment);
-    if (!segment)
-        throw new ValidationError('WebM init segment missing Segment element', ErrorOrigin.MEDIA);
-    const segmentEnd = Math.min(segment.end ?? view.byteLength, view.byteLength);
-    const info = childHeaders(view, segment.contentStart, segmentEnd).find((el) => el.id === EBML_ID.Info && el.size != null);
-    return {
-        segmentDataStart: segment.contentStart,
-        segmentSize: segment.size,
-        timecodeScale: info
-            ? readTimecodeScale(view, info.contentStart, info.end)
-            : DEFAULT_WEBM_TIMECODE_SCALE,
-    };
-}
-/**
- * Reads `Info > TimecodeScale`, defaulting when absent.
- */
-function readTimecodeScale(view, start, end) {
-    const el = childHeaders(view, start, end).find((child) => child.id === EBML_ID.TimecodeScale && child.size);
-    return el
-        ? readUint(view, el.contentStart, el.size)
-        : DEFAULT_WEBM_TIMECODE_SCALE;
-}
-/**
- * Parses a WebM `Cues` element (as located by a DASH `SegmentBase@indexRange`)
- * into its cue points, in order.
- */
-export function parseWebmCues(buffer) {
-    const view = new DataView(buffer);
-    const cues = readElementHeader(view, 0);
-    if (cues.id !== EBML_ID.Cues)
-        throw new ValidationError(`expected WebM 'Cues' element but had id: 0x${cues.id.toString(16)}`, ErrorOrigin.MEDIA);
-    const cuesEnd = Math.min(cues.end ?? view.byteLength, view.byteLength);
-    const cuePoints = [];
-    for (const el of childHeaders(view, cues.contentStart, cuesEnd)) {
-        if (el.id !== EBML_ID.CuePoint || el.size == null)
-            continue;
-        const cuePoint = parseCuePoint(view, el.contentStart, el.end);
-        if (cuePoint)
-            cuePoints.push(cuePoint);
-    }
-    return cuePoints;
-}
-/**
- * Parses a single `CuePoint` (its `CueTime` and first
- * `CueTrackPositions > CueClusterPosition`).
- */
-function parseCuePoint(view, start, end) {
-    let time = null;
-    let clusterPosition = null;
-    for (const el of childHeaders(view, start, end)) {
-        if (el.id === EBML_ID.CueTime && el.size)
-            time = readUint(view, el.contentStart, el.size);
-        else if (el.id === EBML_ID.CueTrackPositions && el.size != null)
-            clusterPosition = readCueClusterPosition(view, el.contentStart, el.end);
-    }
-    return time != null && clusterPosition != null
-        ? { time, clusterPosition }
-        : null;
-}
-/**
- * Reads `CueTrackPositions > CueClusterPosition`.
- */
-function readCueClusterPosition(view, start, end) {
-    const el = childHeaders(view, start, end).find((child) => child.id === EBML_ID.CueClusterPosition && child.size);
-    return el ? readUint(view, el.contentStart, el.size) : null;
-}

package/dist/types/ts3.7/util/async/poll.d.ts

@@ -1,34 +0,0 @@
-import { ReadonlyAbort } from './Abort';
-import { Maybe } from '../type';
-export interface PollOptions {
-    /**
-     * How long to keep polling before giving up, in seconds. If omitted,
-     * polling continues indefinitely until the predicate returns `true` (or the
-     * signal aborts).
-     */
-    readonly timeout?: number;
-    /**
-     * If provided, aborting rejects the returned promise with the signal's
-     * abort reason, cancelling the poll.
-     */
-    readonly abort?: Maybe<ReadonlyAbort>;
-    /**
-     * How often to re-evaluate the predicate, in seconds. Defaults to `0.05`
-     * (50ms).
-     */
-    readonly pollInterval?: number;
-}
-/**
- * Repeatedly evaluates `predicate` until it returns `true` or the timeout
- * elapses, resolving to the predicate's final value. Useful for waiting on
- * asynchronous state to settle without wiring up an event subscription.
- *
- * @param predicate Evaluated immediately and then every `pollInterval` seconds.
- * Polling stops as soon as it returns `true`.
- * @param options Optional {@link PollOptions}. With no `timeout`, polling
- * continues indefinitely until the predicate is `true` or `abort` fires.
- * @returns `true` if the predicate became true within the timeout, otherwise
- * `false`.
- */
-export declare function poll(predicate: () => boolean, options?: PollOptions): Promise<boolean>;
-//# sourceMappingURL=poll.d.ts.map

package/dist/types/ts3.7/util/webm/parseWebm.d.ts

@@ -1,43 +0,0 @@
-/** The default `TimecodeScale` (1ms in nanoseconds) when none is present. */
-export declare const DEFAULT_WEBM_TIMECODE_SCALE = 1000000;
-export interface WebmInitInfo {
-    /**
-     * The absolute byte offset (in the file) where the `Segment` element's
-     * content begins. `CueClusterPosition` values are relative to this.
-     */
-    readonly segmentDataStart: number;
-    /**
-     * The `Segment` content size in bytes, or `null` if encoded as unknown.
-     */
-    readonly segmentSize: number | null;
-    /**
-     * The `TimecodeScale` in nanoseconds per tick (cue times are in these ticks).
-     */
-    readonly timecodeScale: number;
-}
-/**
- * Parses a WebM initialization segment for the `Segment` data offset and
- * `TimecodeScale`. The init segment is everything before the first `Cluster`
- * (EBML header, `Segment` header, `SeekHead`, `Info`, `Tracks`).
- */
-export declare function parseWebmInit(buffer: ArrayBuffer): WebmInitInfo;
-/**
- * A single WebM cue point: a cluster's start time and its byte offset relative
- * to the `Segment` data start.
- */
-export interface WebmCuePoint {
-    /**
-     * The cluster's start time, in `TimecodeScale` ticks.
-     */
-    readonly time: number;
-    /**
-     * The cluster's byte offset relative to the `Segment` data start.
-     */
-    readonly clusterPosition: number;
-}
-/**
- * Parses a WebM `Cues` element (as located by a DASH `SegmentBase@indexRange`)
- * into its cue points, in order.
- */
-export declare function parseWebmCues(buffer: ArrayBuffer): readonly WebmCuePoint[];
-//# sourceMappingURL=parseWebm.d.ts.map

package/dist/types/ts4.1/util/async/poll.d.ts

@@ -1,34 +0,0 @@
-import type { ReadonlyAbort } from './Abort';
-import type { Maybe } from '../type';
-export interface PollOptions {
-    /**
-     * How long to keep polling before giving up, in seconds. If omitted,
-     * polling continues indefinitely until the predicate returns `true` (or the
-     * signal aborts).
-     */
-    readonly timeout?: number;
-    /**
-     * If provided, aborting rejects the returned promise with the signal's
-     * abort reason, cancelling the poll.
-     */
-    readonly abort?: Maybe<ReadonlyAbort>;
-    /**
-     * How often to re-evaluate the predicate, in seconds. Defaults to `0.05`
-     * (50ms).
-     */
-    readonly pollInterval?: number;
-}
-/**
- * Repeatedly evaluates `predicate` until it returns `true` or the timeout
- * elapses, resolving to the predicate's final value. Useful for waiting on
- * asynchronous state to settle without wiring up an event subscription.
- *
- * @param predicate Evaluated immediately and then every `pollInterval` seconds.
- * Polling stops as soon as it returns `true`.
- * @param options Optional {@link PollOptions}. With no `timeout`, polling
- * continues indefinitely until the predicate is `true` or `abort` fires.
- * @returns `true` if the predicate became true within the timeout, otherwise
- * `false`.
- */
-export declare function poll(predicate: () => boolean, options?: PollOptions): Promise<boolean>;
-//# sourceMappingURL=poll.d.ts.map

package/dist/types/ts4.1/util/webm/parseWebm.d.ts

@@ -1,43 +0,0 @@
-/** The default `TimecodeScale` (1ms in nanoseconds) when none is present. */
-export declare const DEFAULT_WEBM_TIMECODE_SCALE = 1000000;
-export interface WebmInitInfo {
-    /**
-     * The absolute byte offset (in the file) where the `Segment` element's
-     * content begins. `CueClusterPosition` values are relative to this.
-     */
-    readonly segmentDataStart: number;
-    /**
-     * The `Segment` content size in bytes, or `null` if encoded as unknown.
-     */
-    readonly segmentSize: number | null;
-    /**
-     * The `TimecodeScale` in nanoseconds per tick (cue times are in these ticks).
-     */
-    readonly timecodeScale: number;
-}
-/**
- * Parses a WebM initialization segment for the `Segment` data offset and
- * `TimecodeScale`. The init segment is everything before the first `Cluster`
- * (EBML header, `Segment` header, `SeekHead`, `Info`, `Tracks`).
- */
-export declare function parseWebmInit(buffer: ArrayBuffer): WebmInitInfo;
-/**
- * A single WebM cue point: a cluster's start time and its byte offset relative
- * to the `Segment` data start.
- */
-export interface WebmCuePoint {
-    /**
-     * The cluster's start time, in `TimecodeScale` ticks.
-     */
-    readonly time: number;
-    /**
-     * The cluster's byte offset relative to the `Segment` data start.
-     */
-    readonly clusterPosition: number;
-}
-/**
- * Parses a WebM `Cues` element (as located by a DASH `SegmentBase@indexRange`)
- * into its cue points, in order.
- */
-export declare function parseWebmCues(buffer: ArrayBuffer): readonly WebmCuePoint[];
-//# sourceMappingURL=parseWebm.d.ts.map

package/dist/types/ts4.7/util/async/poll.d.ts

@@ -1,34 +0,0 @@
-import type { ReadonlyAbort } from './Abort';
-import type { Maybe } from '../type';
-export interface PollOptions {
-    /**
-     * How long to keep polling before giving up, in seconds. If omitted,
-     * polling continues indefinitely until the predicate returns `true` (or the
-     * signal aborts).
-     */
-    readonly timeout?: number;
-    /**
-     * If provided, aborting rejects the returned promise with the signal's
-     * abort reason, cancelling the poll.
-     */
-    readonly abort?: Maybe<ReadonlyAbort>;
-    /**
-     * How often to re-evaluate the predicate, in seconds. Defaults to `0.05`
-     * (50ms).
-     */
-    readonly pollInterval?: number;
-}
-/**
- * Repeatedly evaluates `predicate` until it returns `true` or the timeout
- * elapses, resolving to the predicate's final value. Useful for waiting on
- * asynchronous state to settle without wiring up an event subscription.
- *
- * @param predicate Evaluated immediately and then every `pollInterval` seconds.
- * Polling stops as soon as it returns `true`.
- * @param options Optional {@link PollOptions}. With no `timeout`, polling
- * continues indefinitely until the predicate is `true` or `abort` fires.
- * @returns `true` if the predicate became true within the timeout, otherwise
- * `false`.
- */
-export declare function poll(predicate: () => boolean, options?: PollOptions): Promise<boolean>;
-//# sourceMappingURL=poll.d.ts.map

package/dist/types/ts4.7/util/webm/parseWebm.d.ts

@@ -1,43 +0,0 @@
-/** The default `TimecodeScale` (1ms in nanoseconds) when none is present. */
-export declare const DEFAULT_WEBM_TIMECODE_SCALE = 1000000;
-export interface WebmInitInfo {
-    /**
-     * The absolute byte offset (in the file) where the `Segment` element's
-     * content begins. `CueClusterPosition` values are relative to this.
-     */
-    readonly segmentDataStart: number;
-    /**
-     * The `Segment` content size in bytes, or `null` if encoded as unknown.
-     */
-    readonly segmentSize: number | null;
-    /**
-     * The `TimecodeScale` in nanoseconds per tick (cue times are in these ticks).
-     */
-    readonly timecodeScale: number;
-}
-/**
- * Parses a WebM initialization segment for the `Segment` data offset and
- * `TimecodeScale`. The init segment is everything before the first `Cluster`
- * (EBML header, `Segment` header, `SeekHead`, `Info`, `Tracks`).
- */
-export declare function parseWebmInit(buffer: ArrayBuffer): WebmInitInfo;
-/**
- * A single WebM cue point: a cluster's start time and its byte offset relative
- * to the `Segment` data start.
- */
-export interface WebmCuePoint {
-    /**
-     * The cluster's start time, in `TimecodeScale` ticks.
-     */
-    readonly time: number;
-    /**
-     * The cluster's byte offset relative to the `Segment` data start.
-     */
-    readonly clusterPosition: number;
-}
-/**
- * Parses a WebM `Cues` element (as located by a DASH `SegmentBase@indexRange`)
- * into its cue points, in order.
- */
-export declare function parseWebmCues(buffer: ArrayBuffer): readonly WebmCuePoint[];
-//# sourceMappingURL=parseWebm.d.ts.map