@amazon/vinyl-mpd-parser 1.0.0

package/dist/types/ts4.1/duration/duration.d.ts

@@ -0,0 +1,34 @@
+/**
+ * A duration, in seconds. (This may be negative)
+ */
+export type Duration = number;
+/**
+ * Parses an ISO 8601 duration into seconds.
+ * The accepted format is P(n)Y(n)M(n)DT(n)H(n)M(n)S
+ *
+ * All units shall have a fixed size.
+ *
+ * P - Period designator, precedes all durations.
+ * 1Y (Year) = 365 * 24 * 60 * 60 Seconds
+ * 1M (Month) = 30 * 24 * 60 * 60 Seconds
+ * 1D (Day) = 24 * 60 * 60 Seconds
+ *
+ * T - Time designator, precedes all time components.
+ * 1H (Hour) = 60 * 60 Seconds
+ * 1M (Minute) = 60 Seconds
+ * 1S (Second)
+ *
+ *
+ * @param value
+ * @return Returns the duration in seconds or throws an {@link ValidationError}
+ * if not properly formatted.
+ * @see https://www.w3.org/TR/xmlschema-2/#duration
+ */
+export declare function parseDuration(value: string): Duration;
+/**
+ * Returns the iso 8601 string representation of a duration value.
+ *
+ * @param value A duration value, in seconds.
+ */
+export declare function stringifyDuration(value: Duration): string;
+//# sourceMappingURL=duration.d.ts.map

package/dist/types/ts4.1/error/parsingError.d.ts

@@ -0,0 +1,2 @@
+export declare function throwParsingError(message: string): never;
+//# sourceMappingURL=parsingError.d.ts.map

package/dist/types/ts4.1/index.d.ts

@@ -0,0 +1,16 @@
+/** Auto-generated from build scripts */
+export * from './xmlns/mpeg/dash/schema/mpd/2011';
+export * from './xmlns/mpeg/cenc/2013';
+export * from './xmlns/microsoft/playready';
+export * from './media/ratio';
+export * from './media/frameRate';
+export * from './media/byteRange';
+export * from './manifest/dashParser';
+export * from './manifest/dashManifestXmlRules';
+export * from './manifest/ext/drm/playreadyXmlRules';
+export * from './manifest/ext/drm/contentProtection';
+export * from './manifest/ext/drm/cencXmlRules';
+export * from './manifest/ext/drm/ContentProtectionScheme';
+export * from './error/parsingError';
+export * from './duration/duration';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/ts4.1/manifest/dashManifestXmlRules.d.ts

@@ -0,0 +1,65 @@
+import type { XmlRules } from '@amazon/vinyl-xml';
+import type { ConditionalUintType, DashManifest, PresentationType, SwitchingTypeType, VideoScanType } from '../xmlns/mpeg/dash/schema/mpd/2011';
+export declare const dashNamespaceUri = "urn:mpeg:dash:schema:mpd:2011";
+export declare function dashManifestXmlRules(): XmlRules<DashManifest>;
+/**
+ * Parses a comma delimited list of profiles.
+ * Profile values are not whitespace trimmed.
+ *
+ * @param str
+ */
+export declare function parseProfiles(str: string): readonly string[];
+/**
+ * Returns the string representation of a {@link FrameRate} value.
+ *
+ * @param value
+ */
+export declare function stringifyProfiles(value: readonly string[]): string;
+/**
+ * @private
+ */
+export declare function parseVideoScan(str: string): VideoScanType;
+/**
+ * @private
+ */
+export declare function parseSwitchingTypeType(str: string): SwitchingTypeType;
+/**
+ * @private
+ */
+export declare function parseSap(str: string): number;
+/**
+ * Splits a string by whitespace.
+ *
+ * @private
+ */
+export declare function parseStringVector(str: string): readonly string[];
+/**
+ * Returns the string representation of a string vector value.
+ *
+ * @param value
+ */
+export declare function stringifyStringVector(value: readonly string[]): string;
+/**
+ * Splits a string by whitespace and parses as int.
+ *
+ * @private
+ */
+export declare function parseIntVector(str: string): readonly number[];
+/**
+ * Returns the string representation of an int vector value.
+ *
+ * @param value
+ */
+export declare function stringifyIntVector(value: readonly number[]): string;
+/**
+ * Asserts that the given string is one of the {@link PresentationType} enumerated values.
+ * @param str
+ */
+export declare function parsePresentationTypeType(str: string): PresentationType;
+/**
+ * Parses a string into true, false, or a number.
+ *
+ * @private
+ */
+export declare function parseConditionalUint(str: string): ConditionalUintType;
+//# sourceMappingURL=dashManifestXmlRules.d.ts.map

package/dist/types/ts4.1/manifest/dashParser.d.ts

@@ -0,0 +1,23 @@
+import type { ReservedXmlRuleKeys } from '@amazon/vinyl-xml';
+import type { Merged } from '@amazon/vinyl-xml';
+import type { PlayreadyContentProtection } from '../xmlns/microsoft/playready';
+import type { CencContentProtection } from '../xmlns/mpeg/cenc/2013';
+import type { DashManifest, DescriptorType } from '../xmlns/mpeg/dash/schema/mpd/2011';
+import type { DashProtections } from './ext/drm/contentProtection';
+import type { OptionalDeep } from '@amazon/vinyl-util';
+/**
+ * Creates a Dash Manifest parser with supported extensions.
+ *
+ * @module
+ */
+export type DashDrmManifest = Merged<DashManifest & DashProtections<ContentProtection>>;
+export interface ContentProtection extends DescriptorType, CencContentProtection, PlayreadyContentProtection {
+}
+/**
+ * Parses a Dash Manifest, according to the mpd:2011 schema.
+ * @see https://raw.githubusercontent.com/Dash-Industry-Forum/MPEG-Conformance-and-reference-source/master/conformance/MPDValidator/schemas/DASH-MPD.xsd
+ * @param manifest
+ */
+export declare function parseDashManifest(manifest: string): DashDrmManifest;
+export declare function stringifyDashManifest(manifest: OptionalDeep<DashDrmManifest, ReservedXmlRuleKeys>): string;
+//# sourceMappingURL=dashParser.d.ts.map

package/dist/types/ts4.1/manifest/ext/drm/ContentProtectionScheme.d.ts

@@ -0,0 +1,31 @@
+export declare const ContentProtectionScheme: {
+    /**
+     * CENC protection scheme. (Should not be used to create a key session)
+     */
+    readonly CENC: "urn:mpeg:dash:mp4protection:2011";
+    /**
+     * A simple, unencrypted content protection scheme. Not a full DRM solution.
+     */
+    readonly CLEAR_KEY: "urn:uuid:e2719d58-a985-b3c9-781a-b030af78d30e";
+    /**
+     * Apple's FairPlay.
+     */
+    readonly FAIR_PLAY: "urn:uuid:94ce86fb-07ff-4f43-adb8-93d2fa968ca2";
+    /**
+     * Open-standards community initiative by Marlin Developer Community.
+     */
+    readonly MARLIN: "urn:uuid:5e629af5-38da-4063-8977-97ffbd9902d4";
+    /**
+     * Microsoft's PlayReady.
+     */
+    readonly PLAY_READY: "urn:uuid:9a04f079-9840-4286-ab92-e65be0885f95";
+    /**
+     * An old, unused PlayReady scheme id.
+     */
+    readonly PLAY_READY_DEPRECATED: "urn:uuid:79f0049a-4098-8642-ab92-e65be0885f95";
+    /**
+     * Google's Widevine.
+     */
+    readonly WIDEVINE: "urn:uuid:edef8ba9-79d6-4ace-a3c8-27dcd51d21ed";
+};
+//# sourceMappingURL=ContentProtectionScheme.d.ts.map

package/dist/types/ts4.1/manifest/ext/drm/cencXmlRules.d.ts

@@ -0,0 +1,8 @@
+import type { XmlRules } from '@amazon/vinyl-xml';
+import type { CencContentProtection } from '../../../xmlns/mpeg/cenc/2013';
+/**
+ * A parser for ContentProtection elements using the cenc namespace.
+ * @see https://github.com/sannies/rtp2dash/blob/master/src/main/resources/auxxsd/cenc.xsd
+ */
+export declare const cencXmlRules: XmlRules<CencContentProtection>;
+//# sourceMappingURL=cencXmlRules.d.ts.map

package/dist/types/ts4.1/manifest/ext/drm/contentProtection.d.ts

@@ -0,0 +1,32 @@
+import type { XmlRules } from '@amazon/vinyl-xml';
+/**
+ * ContentProtection extension point for Dash manifests.
+ *
+ * @module
+ */
+export interface WithProtections<T> {
+    readonly ContentProtection?: readonly T[];
+}
+export interface RepresentationTypeProtections<T> extends WithProtections<T> {
+    readonly SubRepresentation?: readonly WithProtections<T>[];
+}
+export interface AdaptationSetProtections<T> extends WithProtections<T> {
+    readonly Representation?: readonly RepresentationTypeProtections<T>[];
+}
+export interface PeriodProtections<T> {
+    readonly AdaptationSet?: readonly AdaptationSetProtections<T>[];
+}
+export interface MPDProtections<T> {
+    readonly Period: readonly PeriodProtections<T>[];
+}
+export interface DashProtections<T> {
+    readonly MPD: MPDProtections<T>;
+}
+/**
+ * Creates a dash extension for content protection parsing rules.
+ *
+ * @param contentProtectionRules Rules to be used when processing `ContentProtection` elements.
+ * @return Returns a rules map that should be merged with the dash manifest rules.
+ */
+export declare function createDashProtectionXmlRules<T extends object>(contentProtectionRules: XmlRules<T>): XmlRules<DashProtections<T>>;
+//# sourceMappingURL=contentProtection.d.ts.map

package/dist/types/ts4.1/manifest/ext/drm/playreadyXmlRules.d.ts

@@ -0,0 +1,4 @@
+import type { XmlRules } from '@amazon/vinyl-xml';
+import type { PlayreadyContentProtection } from '../../../xmlns/microsoft/playready';
+export declare const playreadyXmlRules: XmlRules<PlayreadyContentProtection>;
+//# sourceMappingURL=playreadyXmlRules.d.ts.map

package/dist/types/ts4.1/media/byteRange.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A range of bytes, [from, to (optional, inclusive)].
+ */
+export type ByteRange = readonly [
+    number,
+    number | null
+];
+export declare function parseByteRange(str: string): ByteRange;
+/**
+ * Returns the string representation of a {@link ByteRange} value.
+ *
+ * @param value
+ */
+export declare function stringifyByteRange(value: ByteRange): string;
+//# sourceMappingURL=byteRange.d.ts.map

package/dist/types/ts4.1/media/frameRate.d.ts

@@ -0,0 +1,17 @@
+export type FrameRate = readonly [
+    number,
+    number
+];
+/**
+ * Parses a string into a {@link FrameRate}
+ *
+ * @private
+ */
+export declare function parseFrameRate(str: string): FrameRate;
+/**
+ * Returns the string representation of a {@link FrameRate} value.
+ *
+ * @param value
+ */
+export declare function stringifyFrameRate(value: FrameRate): string;
+//# sourceMappingURL=frameRate.d.ts.map

package/dist/types/ts4.1/media/ratio.d.ts

@@ -0,0 +1,27 @@
+/**
+ * A numerator and denominator.
+ */
+export type Ratio = readonly [
+    number,
+    number
+];
+/**
+ * Parses a string representing a ratio into [number, number].
+ * The string must satisfy the pattern: `/^([0-9]*):([0-9]*)$/`
+ * Examples:
+ * ```
+ * parseRatio('4:3') // [4, 3]
+ * parseRatio('16:9') // [16, 9]
+ * parseRatio('2:') // [2, 1]
+ * ```
+ *
+ * @private
+ */
+export declare function parseRatio(str: string): Ratio;
+/**
+ * Returns the string representation of a {@link Ratio} value.
+ *
+ * @param value
+ */
+export declare function stringifyRatio(value: Ratio): string;
+//# sourceMappingURL=ratio.d.ts.map

package/dist/types/ts4.1/xmlns/microsoft/playready.d.ts

@@ -0,0 +1,12 @@
+import type { Base64BinaryType } from '@amazon/vinyl-xml';
+/**
+ * Cenc content protection playready.
+ *
+ * @see https://learn.microsoft.com/en-us/playready/specifications/mpeg-dash-playready#21-dash-contentprotection-descriptor-elements
+ * @module
+ */
+export declare const PLAY_READY_NAMESPACE_URI = "urn:microsoft:playready";
+export interface PlayreadyContentProtection {
+    readonly pro?: Base64BinaryType;
+}
+//# sourceMappingURL=playready.d.ts.map

package/dist/types/ts4.1/xmlns/mpeg/cenc/2013.d.ts

@@ -0,0 +1,19 @@
+import type { Base64BinaryType } from '@amazon/vinyl-xml';
+/**
+ * Cenc content protection xml types.
+ *
+ * @see https://github.com/sannies/rtp2dash/blob/master/src/main/resources/auxxsd/cenc.xsd
+ * @module
+ */
+export declare const CENC_NAMESPACE_URI = "urn:mpeg:cenc:2013";
+/**
+ * A 128-bit integer written in canonical UUID notation.
+ * Must be in the form:
+ * `[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}`
+ */
+export type KeyIdType = string;
+export interface CencContentProtection {
+    readonly default_KID?: readonly KeyIdType[];
+    readonly pssh?: Base64BinaryType;
+}
+//# sourceMappingURL=2013.d.ts.map