@svta/cml-cmaf-ham 0.19.0 → 0.20.0

package/dist/index.d.ts

@@ -1,52 +1,1274 @@
-export type * from './types/model/AlignedSwitchingSet.js';
-export type * from './types/model/AudioTrack.js';
-export type * from './types/model/FrameRate.js';
-export type * from './types/model/Ham.js';
-export type * from './types/model/Presentation.js';
-export type * from './types/model/Segment.js';
-export type * from './types/model/SelectionSet.js';
-export type * from './types/model/SwitchingSet.js';
-export type * from './types/model/TextTrack.js';
-export type * from './types/model/Track.js';
-export type * from './types/model/TrackType.js';
-export type * from './types/model/VideoTrack.js';
-export type * from './types/manifest/Manifest.js';
-export type * from './types/manifest/ManifestFormat.js';
-export type * from './types/mapper/dash/AdaptationSet.js';
-export type * from './types/mapper/dash/AudioChannelConfiguration.js';
-export type * from './types/mapper/dash/ContentComponent.js';
-export type * from './types/mapper/dash/DashManifest.js';
-export type * from './types/mapper/dash/Initialization.js';
-export type * from './types/mapper/dash/Period.js';
-export type * from './types/mapper/dash/Representation.js';
-export type * from './types/mapper/dash/Role.js';
-export type * from './types/mapper/dash/SegmentBase.js';
-export type * from './types/mapper/dash/SegmentList.js';
-export type * from './types/mapper/dash/SegmentTemplate.js';
-export type * from './types/mapper/dash/SegmentUrl.js';
-export type * from './types/mapper/hls/Byterange.js';
-export type * from './types/mapper/hls/HlsManifest.js';
-export type * from './types/mapper/hls/MediaGroups.js';
-export type * from './types/mapper/hls/Playlist.js';
-export type * from './types/mapper/hls/SegmentHls.js';
-export type * from './types/Validation.js';
-export * from './services/converters/dashToHam.js';
-export * from './services/converters/hamToDash.js';
-export * from './services/converters/hamToHls.js';
-export * from './services/converters/hlsToHam.js';
-export * from './services/getters/getTracksFromPresentation.js';
-export * from './services/getters/getTracksFromSelectionSet.js';
-export * from './services/getters/getTracksFromSwitchingSet.js';
-export * from './services/validators/validatePresentation.js';
-export * from './services/validators/validateSegment.js';
-export * from './services/validators/validateSegments.js';
-export * from './services/validators/validateSelectionSet.js';
-export * from './services/validators/validateSelectionSets.js';
-export * from './services/validators/validateSwitchingSet.js';
-export * from './services/validators/validateSwitchingSets.js';
-export * from './services/validators/validateTrack.js';
-export * from './services/validators/validateTracks.js';
-export * from './utils/dash/parseDashManifest.js';
-export * from './utils/dash/serializeDashManifest.js';
-export * from './utils/hls/parseHlsManifest.js';
+//#region src/types/model/Ham.d.ts
+/**
+* CMAF-HAM base HAM type
+* 
+* id - Identifier of the object
+* 
+* @alpha
+*/
+type Ham = {
+  id: string;
+};
+//#endregion
+//#region src/types/model/Segment.d.ts
+/**
+* CMAF-HAM Segment type
+*
+* @alpha
+*/
+type Segment = {
+  duration: number;
+  url: string;
+  byteRange?: string;
+};
+//#endregion
+//#region src/types/model/TrackType.d.ts
+/**
+* CMAF-HAM TrackType type
+* This can be 'audio' or 'video' or 'text'
+*
+* @alpha
+*/
+type TrackType = "audio" | "video" | "text";
+//#endregion
+//#region src/types/model/Track.d.ts
+/**
+* CMAF-HAM Track type
+* Used as a base for the audio, video and text tracks
+*
+* type - The TrackType
+* fileName - File name of the track.
+* codec - Codec of the track.
+* duration - Duration of the track in seconds
+* language - Language of the track.
+* bandwidth - Bandwidth of the track.
+* byteRange - Byte range of the track.
+* segments - List of segments of the track.
+*
+* @alpha
+*/
+type Track = Ham & {
+  /** Track type */
+  type: TrackType;
+  fileName?: string;
+  codec: string;
+  duration: number;
+  language: string;
+  bandwidth: number;
+  byteRange?: string;
+  /** URL of the initialization segment */
+  urlInitialization?: string;
+  segments: Segment[];
+};
+//#endregion
+//#region src/types/model/SwitchingSet.d.ts
+/**
+* CMAF-HAM SwitchingSet type
+*
+* @alpha
+*/
+type SwitchingSet = Ham & {
+  tracks: Track[];
+};
+//#endregion
+//#region src/types/model/AlignedSwitchingSet.d.ts
+/**
+* CMAF-HAM Aligned Switching Set type
+*
+* @alpha
+*/
+type AlignedSwitchingSet = {
+  switchingSets: SwitchingSet[];
+};
+//#endregion
+//#region src/types/model/AudioTrack.d.ts
+/**
+* CMAF-HAM Audio Track type
+*
+* sampleRate - The sample rate of the audio track. It defines the number of samples per second in the audio.
+*              For example, if the sample rate is 44100, it means there are 44100 samples in each second of the audio.
+*
+* channels - The number of channels in the audio track. It defines the number of separate audio signals that are encoded in the audio.
+*            For example, if the channels is 2, it means the audio is stereo with a separate signal for left and right.
+*
+* @alpha
+*/
+type AudioTrack = Track & {
+  sampleRate: number;
+  channels: number;
+};
+//#endregion
+//#region src/types/model/FrameRate.d.ts
+/**
+* Video Frame Rate
+* Used to express the framerate as numerator and denominator.
+*
+* frameRateNumerator - Numerator.
+* frameRateDenominator - Denominator.
+*
+* @alpha
+*/
+type FrameRate = {
+  frameRateNumerator: number;
+  frameRateDenominator?: number;
+};
+//#endregion
+//#region src/types/model/SelectionSet.d.ts
+/**
+* CMAF-HAM SelectionSet type
+*
+* @alpha
+*/
+type SelectionSet = Ham & {
+  switchingSets: SwitchingSet[];
+  alignedSwitchingSets?: AlignedSwitchingSet[];
+};
+//#endregion
+//#region src/types/model/Presentation.d.ts
+/**
+* CMAF-HAM Presentation type
+*
+* selectionSets - List of SelectionSets
+*
+* @alpha
+*/
+type Presentation = Ham & {
+  selectionSets: SelectionSet[];
+};
+//#endregion
+//#region src/types/model/TextTrack.d.ts
+/**
+* CMAF-HAM Text Track type
+*
+* @alpha
+*/
+type TextTrack = Track;
+//#endregion
+//#region src/types/model/VideoTrack.d.ts
+/**
+* CMAF-HAM Track type
+*
+* width - Video width in pixels.
+* height - Video height in pixels.
+* frameRate - Video framerate in FrameRate type;
+* par - Pixel Aspect Ratio of the video track as string.
+* sar - Sample Aspect Ratio of the video track in string.
+* scanType - The method used to display the video track.
+*
+* @alpha
+*/
+type VideoTrack = Track & {
+  width: number;
+  height: number;
+  frameRate: FrameRate;
+  par: string;
+  sar: string;
+  scanType: string;
+};
+//#endregion
+//#region src/types/manifest/ManifestFormat.d.ts
+/**
+* The format of the manifest.
+*
+* @alpha
+*/
+type ManifestFormat = "hls" | "dash";
+//#endregion
+//#region src/types/manifest/Manifest.d.ts
+/**
+* Manifest object received as an input by the conversion to HAM object
+*
+* @alpha
+*/
+type Manifest = {
+  manifest: string;
+  fileName?: string;
+  ancillaryManifests?: Manifest[];
+  type: ManifestFormat;
+  metadata?: Map<string, string>;
+};
+//#endregion
+//#region src/types/mapper/dash/AudioChannelConfiguration.d.ts
+/**
+* DASH Audio Channel Configuration
+*
+* @alpha
+*/
+type AudioChannelConfiguration = {
+  $: {
+    schemeIdUri: string;
+    value: string;
+  };
+};
+//#endregion
+//#region src/types/mapper/dash/ContentComponent.d.ts
+/**
+*
+* @alpha
+*/
+type ContentComponent = {
+  $: {
+    contentType: string;
+    id: string;
+  };
+};
+//#endregion
+//#region src/types/mapper/dash/Initialization.d.ts
+/**
+* DASH Initialization
+*
+* @alpha
+*/
+type Initialization = {
+  $: {
+    range?: string;
+    sourceURL?: string;
+  };
+};
+//#endregion
+//#region src/types/mapper/dash/SegmentBase.d.ts
+/**
+* DASH Segment Base
+*
+* @alpha
+*/
+type SegmentBase = {
+  $: {
+    indexRange: string;
+    indexRangeExact: string;
+    timescale: string;
+  };
+  Initialization: Initialization[];
+};
+//#endregion
+//#region src/types/mapper/dash/SegmentUrl.d.ts
+/**
+* DASH Segment URL
+*
+* @alpha
+*/
+type SegmentURL = {
+  $: {
+    media?: string;
+  };
+};
+//#endregion
+//#region src/types/mapper/dash/SegmentList.d.ts
+/**
+* DASH Segment List
+*
+* @alpha
+*/
+type SegmentList = {
+  $: {
+    duration: string;
+    timescale: string;
+  };
+  Initialization: Initialization[];
+  SegmentURL?: SegmentURL[];
+};
+//#endregion
+//#region src/types/mapper/dash/SegmentTemplate.d.ts
+/**
+* DASH Segment template
+*
+* It is used as a template to create the actual templates
+*
+* @alpha
+*/
+type SegmentTemplate = {
+  $: {
+    duration: string;
+    initialization: string;
+    media: string;
+    startNumber: string;
+    timescale: string;
+  };
+};
+//#endregion
+//#region src/types/mapper/dash/Representation.d.ts
+/**
+* DASH Representation
+*
+* @alpha
+*/
+type Representation = {
+  $: {
+    audioSamplingRate?: string;
+    bandwidth: string;
+    codecs?: string;
+    frameRate?: string;
+    height?: string;
+    id: string;
+    mimeType?: string;
+    sar?: string;
+    scanType?: string;
+    startWithSAP?: string;
+    width?: string;
+  };
+  AudioChannelConfiguration?: AudioChannelConfiguration[];
+  BaseURL?: string[];
+  SegmentBase?: SegmentBase[];
+  SegmentList?: SegmentList[];
+  SegmentTemplate?: SegmentTemplate[];
+};
+//#endregion
+//#region src/types/mapper/dash/Role.d.ts
+/**
+* Role
+*
+* @alpha
+*/
+type Role = {
+  $: {
+    schemeIdUri: string;
+    value: string;
+  };
+};
+//#endregion
+//#region src/types/mapper/dash/AdaptationSet.d.ts
+/**
+* DASH Adaptation Set
+*
+* @alpha
+*/
+type AdaptationSet = {
+  $: {
+    audioSamplingRate?: string;
+    codecs?: string;
+    contentType?: string;
+    frameRate?: string;
+    group?: string;
+    id?: string;
+    lang?: string;
+    maxBandwidth?: string;
+    maxFrameRate?: string;
+    maxHeight?: string;
+    maxWidth?: string;
+    mimeType?: string;
+    minBandwidth?: string;
+    par?: string;
+    sar?: string;
+    segmentAlignment: string;
+    startWithSAP?: string;
+    subsegmentAlignment?: string;
+    subsegmentStartsWithSAP?: string;
+  };
+  AudioChannelConfiguration?: AudioChannelConfiguration[];
+  ContentComponent?: ContentComponent[];
+  Role?: Role[];
+  Representation: Representation[];
+  SegmentTemplate?: SegmentTemplate[];
+  SegmentList?: SegmentList[];
+};
+//#endregion
+//#region src/types/mapper/dash/Period.d.ts
+/**
+* DASH Period
+*
+* @alpha
+*/
+type Period = {
+  $: {
+    duration: string;
+    id?: string;
+    start?: string;
+  };
+  AdaptationSet: AdaptationSet[];
+};
+//#endregion
+//#region src/types/mapper/dash/DashManifest.d.ts
+/**
+* Json representation of the DASH Manifest
+*
+* @alpha
+*/
+type DashManifest = {
+  MPD: {
+    $?: {
+      maxSegmentDuration?: string;
+      mediaPresentationDuration?: string;
+      minBufferTime?: string;
+      profiles?: string;
+      type?: string;
+      xmlns?: string;
+    };
+    Period: Period[];
+  };
+};
+//#endregion
+//#region src/types/mapper/hls/Byterange.d.ts
+/**
+* Byterange
+*
+*
+* @alpha
+*/
+type Byterange = {
+  length: number;
+  offset: number;
+};
+//#endregion
+//#region src/types/mapper/hls/MediaGroups.d.ts
+/**
+* HLS Media Groups
+*
+* @alpha
+*/
+type MediaGroups = {
+  AUDIO: {
+    [key: string]: {
+      [key: string]: {
+        language: string;
+      };
+    };
+  };
+  SUBTITLES: {
+    [key: string]: {
+      [key: string]: {
+        language: string;
+      };
+    };
+  };
+};
+//#endregion
+//#region src/types/mapper/hls/Playlist.d.ts
+/**
+* HLS Playlist
+*
+* @alpha
+*/
+type PlayList = {
+  uri: string;
+  attributes: {
+    FRAME_RATE: number;
+    CODECS: string;
+    BANDWIDTH: number;
+    RESOLUTION: {
+      width: number;
+      height: number;
+    };
+  };
+};
+//#endregion
+//#region src/types/mapper/hls/SegmentHls.d.ts
+/**
+* HLS Segments
+*
+* @alpha
+*/
+type SegmentHls = {
+  title?: string;
+  duration: number;
+  byterange?: Byterange;
+  uri?: string;
+  timeline?: number;
+  map?: {
+    uri: string;
+    byterange: Byterange;
+  };
+};
+//#endregion
+//#region src/types/mapper/hls/HlsManifest.d.ts
+/**
+* HLS manifest
+*
+* @alpha
+*/
+type HlsManifest = {
+  playlists: PlayList[];
+  mediaGroups: MediaGroups;
+  segments: SegmentHls[];
+  targetDuration?: number;
+};
+//#endregion
+//#region src/types/Validation.d.ts
+/**
+* CMAF-HAM Validation type
+*
+* @alpha
+*/
+type Validation = {
+  status: boolean;
+  errorMessages: string[];
+};
+//#endregion
+//#region src/mapper/dash/mapDashToHam/mapSegmentBase.d.ts
+/**
+* @internal
+*
+* Maps SegmentBase from dash to Segment list from ham.
+*
+* @param representation - Representation to get the SegmentBase from
+* @param duration - Duration of the segment
+* @returns list of ham segments
+*/
+declare function mapSegmentBase(representation: Representation, duration: number): Segment[];
+//#endregion
+//#region src/mapper/dash/mapDashToHam/mapSegmentList.d.ts
+/**
+* @internal
+*
+* Maps SegmentList from dash to Segment list from ham.
+*
+* @param segmentList - SegmentList list from dash
+* @returns list of ham segments
+*/
+declare function mapSegmentList(segmentList: SegmentList[]): Segment[];
+//#endregion
+//#region src/mapper/dash/mapDashToHam/mapSegments.d.ts
+/**
+* @internal
+*
+* Maps dash segments to ham segment.
+*
+* Checks the type of dash segments used to map them accordingly.
+* @see mapSegmentBase
+* @see mapSegmentList
+* @see mapSegmentTemplate
+*
+* @param adaptationSet - AdaptationSet to get the segments from
+* @param representation - Representation to get the segments from
+* @param duration - Duration of the segments
+* @returns list of ham segments
+*/
+declare function mapSegments(adaptationSet: AdaptationSet, representation: Representation, duration: number): Segment[];
+//#endregion
+//#region src/mapper/dash/mapDashToHam/mapSegmentTemplate.d.ts
+/**
+* @internal
+*
+* Maps SegmentTemplate from dash to Segment list from ham.
+*
+* @param representation - Representation to generate the urls
+* @param duration - Duration of the segments
+* @param segmentTemplate - SegmentTemplate to get the properties from
+* @returns list of ham segments
+*/
+declare function mapSegmentTemplate(representation: Representation, duration: number, segmentTemplate: SegmentTemplate): Segment[];
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/calculateDuration.d.ts
+/**
+* @internal
+*
+* Calculates the duration of a segment.
+*
+* segmentDuration = duration / timescale
+*
+* @param duration - Duration of the segment
+* @param timescale - Timescale of the segment
+* @returns Segment duration
+*/
+declare function calculateDuration(duration: string | undefined, timescale: string | undefined): number;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getChannels.d.ts
+/**
+* @internal
+*
+* Get the channels value (audio). It can be present on adaptationSet or representation.
+*
+* @param adaptationSet - AdaptationSet to try to get the channels from
+* @param representation - Representation to try to get the channels from
+* @returns Channels value
+*/
+declare function getChannels(adaptationSet: AdaptationSet, representation: Representation): number;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getCodec.d.ts
+/**
+* @internal
+*
+* Get the codec value (video and audio). It can be present on adaptationSet or representation.
+*
+* @param adaptationSet - AdaptationSet to try to get the codec from
+* @param representation - Representation to try to get the codec from
+* @returns Content codec
+*/
+declare function getCodec(adaptationSet: AdaptationSet, representation: Representation): string;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getContentType.d.ts
+/**
+* @internal
+*
+* Get the type of the content. It can be obtained directly from AdaptationSet or Representation
+* or can be inferred with the existing properties.
+*
+* @param adaptationSet - AdaptationSet to get the type from
+* @param representation - Representation to get the type from
+* @returns type of the content
+*/
+declare function getContentType(adaptationSet: AdaptationSet, representation?: Representation): string;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getFrameRate.d.ts
+/**
+* @internal
+*
+* Get the frame rate from a dash manifest.
+*
+* This functions assumes the adaptationSet and representation set are type video
+*
+* @param adaptationSet - To try to get the frameRate from
+* @param representation - To try to get the frameRate from
+* @returns object containing numerator and denominator
+*/
+declare function getFrameRate(adaptationSet: AdaptationSet, representation: Representation): FrameRate;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getGroup.d.ts
+/**
+* @internal
+*/
+declare function getGroup(adaptationSet: AdaptationSet): string;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getLanguage.d.ts
+/**
+* @internal
+*
+* Get the language from an adaptation set.
+*
+* @param adaptationSet - AdaptationSet to get the language from
+* @returns language of the content
+*/
+declare function getLanguage(adaptationSet: AdaptationSet): string;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getNumberOfSegments.d.ts
+/**
+* @internal
+*
+* Calculates the number of segments that a track has to use SegmentTemplate.
+*
+* Equation used:
+* segments = total duration / (segment duration / timescale)
+*
+* **This equation might be wrong, please double-check it**
+*
+* @param segmentTemplate - SegmentTemplate object
+* @param duration - Total duration of the content
+* @returns Number of segments
+*/
+declare function getNumberOfSegments(segmentTemplate: SegmentTemplate, duration: number): number;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getPresentationId.d.ts
+/**
+* @internal
+*
+* Generates a presentation id. It uses the period id as default or creates one
+* if none is present.
+*
+* @param period - Period to try to get the id from
+* @param duration - Duration of the content
+* @returns Presentation id
+*/
+declare function getPresentationId(period: Period, duration: number): string;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getSampleRate.d.ts
+/**
+* @internal
+*
+* Get sample rate (audio).
+*
+* @param adaptationSet - AdaptationSet to try to get the sampleRate from
+* @param representation - Representation to try to get the sampleRate from
+* @returns Sample rate. In case it is not presents, it returns 0.
+*/
+declare function getSampleRate(adaptationSet: AdaptationSet, representation: Representation): number;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getSar.d.ts
+/**
+* @internal
+*
+* Get the sar value. It can be present on adaptationSet or representation.
+*
+* @param adaptationSet - AdaptationSet to try to get the sar from
+* @param representation - AdaptationSet to try to get the sar from
+* @returns sar value. In case it is not present, returns empty string.
+*/
+declare function getSar(adaptationSet: AdaptationSet, representation: Representation): string;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getTrackDuration.d.ts
+/**
+* @internal
+*
+* Calculate the duration of a track.
+*
+* This is calculated using the sum of the duration of all the segments from the
+* track.
+*
+* An alternative to this could be number of segments * duration of a segment.
+*
+* @param segments - Segments to calculate the sum of the durations
+* @returns Duration of the track
+*/
+declare function getTrackDuration(segments: Segment[]): number;
+//#endregion
+//#region src/mapper/dash/mapDashToHam/utils/getUrlFromTemplate.d.ts
+/**
+* @internal
+*
+* Create the url from a segment template.
+*
+* Searches for substrings with the format `$value$` and replaces it with the correct value.
+* - RepresentationID: id of the representation
+* - Number: id of the segment. `%0Xd` defines the number `X` of digits it needs to have
+*
+* @param representation - Representation of the template
+* @param segmentTemplate - Segment template
+* @param segmentId - Segment id
+* @returns url from the segment template
+*/
+declare function getUrlFromTemplate(representation: Representation, segmentTemplate: SegmentTemplate, segmentId: number): string;
+//#endregion
+//#region src/mapper/dash/mapHamToDash/utils/getTimescale.d.ts
+/**
+* @internal
+*
+* This function tries to recreate the timescale value.
+*
+* This value is not stored on the ham object, so it is not possible (for now)
+* to get the original one.
+*
+* Just the audio tracks have this value stored on the `sampleRate` key.
+*
+* @param track - Track to get the timescale from
+* @returns Timescale in numbers
+*/
+declare function getTimescale(track: Track): number;
+//#endregion
+//#region src/mapper/hls/mapHamToHls/utils/encodeByteRange.d.ts
+/**
+* @internal
+*
+* Get the byterange in hls format from ham track.
+*
+* @param track - Track to get the byterange from
+* @returns string containing the byterange in the hls format
+*
+* @alpha
+*/
+declare function encodeByteRange(track: VideoTrack | AudioTrack): string;
+//#endregion
+//#region src/mapper/hls/mapHamToHls/utils/getPlaylistData.d.ts
+/**
+* @internal
+*
+* Get the playlist data in hls format from ham track.
+*
+* @param track - Track to get the playlist data from
+* @returns string containing the playlist data in the hls format
+*
+* @alpha
+*/
+declare function getPlaylistData(track: AudioTrack | VideoTrack): string;
+//#endregion
+//#region src/mapper/hls/mapHamToHls/utils/getSegments.d.ts
+/**
+* @internal
+*
+* Format the ham segments to hls.
+*
+* @param segments - Segments to be formatted
+* @returns string containing the segments in the hls format
+*
+* @alpha
+*/
+declare function getSegments(segments: Segment[]): string;
+//#endregion
+//#region src/mapper/hls/mapHamToHls/utils/getUrlInitialization.d.ts
+/**
+* @internal
+*
+* Get url initialization from ham track.
+*
+* @param track - Track to get the url initialization from
+* @returns string containing the url initialization in the hls format
+*
+* @alpha
+*/
+declare function getUrlInitialization(track: VideoTrack | AudioTrack): string;
+//#endregion
+//#region src/mapper/hls/mapHlsToHam/utils/decodeByteRange.d.ts
+/**
+* @internal
+*
+* Get byterange from HLS Manifest.
+*
+* @param byteRange - Byterange object containing length and offset
+* @returns string containing the byterange. If byterange is undefined, it returns undefined
+*
+* @alpha
+*/
+declare function decodeByteRange(byteRange: Byterange | undefined): string;
+//#endregion
+//#region src/mapper/hls/mapHlsToHam/utils/formatSegments.d.ts
+/**
+* @internal
+*
+* Format the hls segments into the ham segments.
+*
+* @param segments - List of HLS segments
+* @returns ham formatted list of segments
+*
+* @alpha
+*/
+declare function formatSegments(segments: SegmentHls[]): Segment[];
+//#endregion
+//#region src/mapper/hls/mapHlsToHam/utils/getDuration.d.ts
+/**
+* @internal
+*
+* Calculate the duration of a track.
+*
+* `target duration * number of segments`
+*
+* @param manifest - Manifest of the track
+* @param segments - Array of segments in a track
+* @returns duration of a track
+*
+* @alpha
+*/
+declare function getDuration(manifest: HlsManifest, segments: SegmentHls[]): number | null;
+//#endregion
+//#region src/mapper/hls/mapHlsToHam/utils/getHlsCodec.d.ts
+/**
+* @internal
+*
+* Get the codec for a type of content.
+*
+* @param type - Type of the content to get the codecs from
+* @param codecs - String containing multiple codecs separated with commas
+* @returns string containing codec
+*
+* @alpha
+*/
+declare function getHlsCodec(type: string, codecs?: string): string;
+//#endregion
+//#region src/services/converters/dashToHam.d.ts
+/**
+* Convert dash manifest into a ham object.
+*
+* @example
+* Example on how to import the cmaf module and convert the dash `manifest`
+* into the ham manifest.
+* ```ts
+* import cmaf from '@svta/common-media-library/cmaf-ham';
+*
+* const manifest = cmaf.dashToHam(dashManifest);
+* ```
+*
+* @param manifest - String of the XML Dash manifest
+* @returns List of presentations from ham
+*
+* @alpha
+*/
+declare function dashToHam(manifest: string): Presentation[];
+//#endregion
+//#region src/services/converters/hamToDash.d.ts
+/**
+* Convert HAM object into Dash Manifest.
+*
+* @example
+* Example on how to import the cmaf module and convert the ham `presentations`
+* array into the dash manifest.
+* ```ts
+* import cmaf from '@svta/common-media-library/cmaf-ham';
+*
+* const manifest = cmaf.hamToDash(presentations);
+* ```
+*
+* @param presentation - List of presentations from ham
+* @returns Manifest object containing the Dash manifest as string
+*
+* @alpha
+*/
+declare function hamToDash(presentation: Presentation[]): Manifest;
+//#endregion
+//#region src/services/converters/hamToHls.d.ts
+/**
+* Convert ham object into a hls manifest.
+*
+* @example
+* Example on how to import the cmaf module and convert the ham `presentations`
+* array into the hls manifest.
+* ```ts
+* import cmaf from '@svta/common-media-library/cmaf-ham';
+*
+* const manifest = cmaf.hamToHls(presentations);
+* ```
+*
+* @param presentation - List of presentations from ham
+* @returns Manifest object containing the Hls manifest as string and its playlists
+*
+* @alpha
+*/
+declare function hamToHls(presentation: Presentation[]): Manifest;
+//#endregion
+//#region src/services/converters/hlsToHam.d.ts
+/**
+* Convert hls manifest into a ham object.
+*
+* @example
+* Example on how to import the cmaf module and convert the hls `manifest` and
+* `ancillaryManifests` array into the ham manifest.
+* ```ts
+* import cmaf from '@svta/common-media-library/cmaf-ham';
+*
+* const manifest = cmaf.hlsToHam(hlsManifest);
+* ```
+*
+* @param manifest - String of the Main manifest
+* @param ancillaryManifests - Ancillary Manifests . Must be in order, first audio, subtitle and video
+* @returns List of presentations from ham
+*
+* @alpha
+*/
+declare function hlsToHam(manifest: string, ancillaryManifests: string[]): Presentation[];
+//#endregion
+//#region src/services/getters/getTracksFromPresentation.d.ts
+/**
+* Get a list of Tracks contained on a Presentation
+*
+* @param presentation - Presentation object from HAM
+* @param predicate - Filtering function
+* @returns Track[]
+*
+* @alpha
+*/
+declare function getTracksFromPresentation(presentation: Presentation, predicate?: (track: Track) => boolean): Track[];
+//#endregion
+//#region src/services/getters/getTracksFromSelectionSet.d.ts
+/**
+* Get a list of Tracks contained on a SelectionSet
+*
+* @param selectionSet - SelectionSet object from HAM
+* @param predicate - Filtering function
+* @returns Track[]
+*
+* @alpha
+*/
+declare function getTracksFromSelectionSet(selectionSet: SelectionSet, predicate?: (track: Track) => boolean): Track[];
+//#endregion
+//#region src/services/getters/getTracksFromSwitchingSet.d.ts
+/**
+* Get a list of Tracks contained on a SwitchingSet
+*
+* @param switchingSet - SwitchingSet object from HAM
+* @param predicate - Filtering function
+* @returns Track[]
+*
+* @alpha
+*/
+declare function getTracksFromSwitchingSet(switchingSet: SwitchingSet, predicate?: (track: Track) => boolean): Track[];
+//#endregion
+//#region src/services/validators/validatePresentation.d.ts
+/**
+* Validate a presentation.
+* It validates in cascade, calling each child validation method.
+*
+* Validations:
+* - Presentation has id
+*
+* @example
+* ```ts
+* import cmaf, { Presentation } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const presentation: Presentation = ...;
+*
+* const validation = cmaf.validatePresentation(presentation);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param presentation - Presentation from cmaf ham model
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validatePresentation(presentation: Presentation): Validation;
+//#endregion
+//#region src/services/validators/validateSegment.d.ts
+/**
+* Validate a segment.
+*
+* Validations:
+* - segment has duration
+* - segment has url
+*
+* @param segment - Segment from cmaf ham model
+* @param trackId - Optional: parent track id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*/
+declare function validateSegment(segment: Segment, trackId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateSegments.d.ts
+/**
+* Validate a list of segments.
+*
+* @example
+* ```ts
+* import cmaf, { Segment } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const segments: Segment[] = ...;
+*
+* const validation = cmaf.validateSegments(segments);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param segments - List of Segment from cmaf ham model
+* @param trackId - Optional: parent track id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateSegments(segments: Segment[], trackId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateSelectionSet.d.ts
+/**
+* Validate a selection set.
+* It validates in cascade, calling each child validation method.
+*
+* Validations:
+* - SelectionSet has id
+*
+* @example
+* ```ts
+* import cmaf, { SelectionSet } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const selectionSet: SelectionSet = ...;
+*
+* const validation = cmaf.validateSelectionSet(selectionSet);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param selectionSet - SelectionSet from cmaf ham model
+* @param presentationId - Optional: parent presentation id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateSelectionSet(selectionSet: SelectionSet, presentationId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateSelectionSets.d.ts
+/**
+* Validate a list of selection set.
+* It validates in cascade, calling each child validation method.
+*
+* @example
+* ```ts
+* import cmaf, { SelectionSet } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const selectionSets: SelectionSet[] = ...;
+*
+* const validation = cmaf.validateSelectionSets(selectionSets);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param selectionSets - List of SelectionSet from cmaf ham model
+* @param presentationId - Optional: parent presentation id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateSelectionSets(selectionSets: SelectionSet[], presentationId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateSwitchingSet.d.ts
+/**
+* Validate a switching set.
+* It validates in cascade, calling each child validation method.
+*
+* Validations:
+* - SwitchingSet has id
+*
+* @example
+* ```ts
+* import cmaf, { SwitchingSet } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const switchingSet: SwitchingSet = ...;
+*
+* const validation = cmaf.validateSwitchingSet(switchingSet);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param switchingSet - SwitchingSet from cmaf ham model
+* @param selectionSetId - Optional: parent selection set id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateSwitchingSet(switchingSet: SwitchingSet, selectionSetId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateSwitchingSets.d.ts
+/**
+* Validate a list of switching set.
+* It validates in cascade, calling each child validation method.
+*
+* @example
+* ```ts
+* import cmaf, { SwitchingSet } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const switchingSets: SwitchingSet[] = ...;
+*
+* const validation = cmaf.validateSwitchingSets(switchingSets);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param switchingSets - List of SwitchingSets from cmaf ham model
+* @param selectionSetId - Optional: parent selection set id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateSwitchingSets(switchingSets: SwitchingSet[], selectionSetId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateTrack.d.ts
+/**
+* Validate a track.
+* It validates in cascade, calling each child validation method.
+*
+* Validations:
+* - track has id
+* - Invokes specific audio, video and text validations
+*
+* @example
+* ```ts
+* import cmaf, { Track } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const track: Track = ...;
+*
+* const validation = cmaf.validateTrack(track);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param track - Track from cmaf ham model
+* @param switchingSetId - Optional: parent switching set id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateTrack(track: Track, switchingSetId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/services/validators/validateTracks.d.ts
+/**
+* Validate a list of tracks.
+* It validates in cascade, calling each child validation method.
+*
+* @example
+* ```ts
+* import cmaf, { Track } from '@svta/common-media-library/cmaf-ham';
+* ...
+*
+* // const tracks: Track[] = ...;
+*
+* const validation = cmaf.validateTracks(tracks);
+* ```
+*
+* Example output: `{ status: true|false, errorMessages: [...] }`
+*
+* @param tracks - List of Track from cmaf ham model
+* @param switchingSetId - Optional: parent switching set id
+* @param prevValidation - Optional: validation object from parent previous validate method call
+* @returns Validation
+*
+* @alpha
+*
+*/
+declare function validateTracks(tracks: Track[], switchingSetId?: string, prevValidation?: Validation): Validation;
+//#endregion
+//#region src/utils/dash/iso8601DurationToNumber.d.ts
+/**
+* @internal
+*/
+declare function iso8601DurationToNumber(isoDuration: string): number;
+//#endregion
+//#region src/utils/dash/numberToIso8601Duration.d.ts
+/**
+* @internal
+*/
+declare function numberToIso8601Duration(duration: number): string;
+//#endregion
+//#region src/utils/dash/parseDashManifest.d.ts
+/**
+* @internal
+*/
+type DashParser = (raw: string) => DashManifest;
+/**
+* @internal
+*/
+declare function setDashParser(parser: DashParser): void;
+/**
+* @internal
+*/
+declare function getDashParser(): DashParser;
+/**
+* @internal
+* Parse XML to Json
+*
+* @param raw - Raw string containing the xml from the Dash Manifest
+* @returns json with the Dash Manifest structure
+*/
+declare function parseDashManifest(raw: string): DashManifest;
+//#endregion
+//#region src/utils/dash/serializeDashManifest.d.ts
+/**
+* @internal
+*/
+type DashSerializer = (json: DashManifest) => string;
+/**
+* @internal
+*/
+declare function setDashSerializer(serializer: DashSerializer): void;
+/**
+* @internal
+*/
+declare function getDashSerializer(): DashSerializer;
+/**
+* @internal
+*/
+declare function serializeDashManifest(json: DashManifest): string;
+//#endregion
+//#region src/utils/hls/parseHlsManifest.d.ts
+/**
+* @internal
+*/
+type HlsParser = (text: string) => HlsManifest;
+/**
+* @internal
+*/
+declare function setHlsParser(parser: HlsParser): void;
+/**
+* @internal
+*/
+declare function getHlsParser(): HlsParser;
+/**
+* @internal
+*/
+declare function parseHlsManifest(text?: string): HlsManifest;
+//#endregion
+export { AdaptationSet, AlignedSwitchingSet, AudioChannelConfiguration, AudioTrack, Byterange, ContentComponent, DashManifest, DashParser, DashSerializer, FrameRate, Ham, HlsManifest, HlsParser, Initialization, Manifest, ManifestFormat, MediaGroups, Period, PlayList, Presentation, Representation, Role, Segment, SegmentBase, SegmentHls, SegmentList, SegmentTemplate, SegmentURL, SelectionSet, SwitchingSet, TextTrack, Track, TrackType, Validation, VideoTrack, calculateDuration, dashToHam, decodeByteRange, encodeByteRange, formatSegments, getChannels, getCodec, getContentType, getDashParser, getDashSerializer, getDuration, getFrameRate, getGroup, getHlsCodec, getHlsParser, getLanguage, getNumberOfSegments, getPlaylistData, getPresentationId, getSampleRate, getSar, getSegments, getTimescale, getTrackDuration, getTracksFromPresentation, getTracksFromSelectionSet, getTracksFromSwitchingSet, getUrlFromTemplate, getUrlInitialization, hamToDash, hamToHls, hlsToHam, iso8601DurationToNumber, mapSegmentBase, mapSegmentList, mapSegmentTemplate, mapSegments, numberToIso8601Duration, parseDashManifest, parseHlsManifest, serializeDashManifest, setDashParser, setDashSerializer, setHlsParser, validatePresentation, validateSegment, validateSegments, validateSelectionSet, validateSelectionSets, validateSwitchingSet, validateSwitchingSets, validateTrack, validateTracks };
 //# sourceMappingURL=index.d.ts.map