rx-player/dist/es2017/parsers/containers/isobmff/utils.d.ts

Canal+ HTML5 Video Player

/**
 * Copyright 2015 CANAL+ Group
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { getPlayReadyKIDFromPrivateData } from "./drm";
/** Information related to a PSSH box. */
export interface IISOBMFFPSSHInfo {
    /** Corresponding DRM's system ID, as an hexadecimal string. */
    systemId: string;
    /** Additional data contained in the PSSH Box. */
    privateData: Uint8Array;
}
/**
 * Inband event data when the data was contained inside an ISOBMFF box.
 * The value and their name corresponds to the same one than in the
 * corresponding ISOBMFF specification.
 */
export interface IEMSG {
    schemeIdUri: string;
    value: string;
    timescale: number;
    presentationTimeDelta: number;
    eventDuration: number;
    id: number;
    messageData: Uint8Array;
}
/** Segment information from a parsed sidx. */
export interface ISidxSegment {
    /** This segment start time, timescaled. */
    time: number;
    /** This segment difference between its end and start time, timescaled. */
    duration: number;
    /** Dividing `time` or `duration` with this value allows to obtain seconds. */
    timescale: number;
    /**
     * Start and ending bytes (included) for the segment in the whole ISOBMFF
     * buffer.
     */
    range: [number, number];
}
/**
 * Parse the sidx part (segment index) of an ISOBMFF buffer and construct a
 * corresponding Array of available segments.
 *
 * Returns `null` if not found.
 * @param {Uint8Array} buf
 * @param {Number} sidxOffsetInWholeSegment
 * @returns {Object|null} {Array.<Object>} - Information about each subsegment.
 */
declare function getSegmentsFromSidx(buf: Uint8Array, sidxOffsetInWholeSegment: number): ISidxSegment[] | null;
/**
 * Parse track Fragment Decode Time to get a precize initial time for this
 * segment (in the media timescale).
 *
 * Stops at the first tfdt encountered from the beginning of the file.
 * Returns this time.
 * `undefined` if not found.
 * @param {Uint8Array} buffer
 * @returns {Number | undefined}
 */
declare function getTrackFragmentDecodeTime(buffer: Uint8Array): number | undefined;
/** Describe the metadata of a sample found inside a trun sample. */
interface ITrunSampleInfo {
    /** `duration` of the sample, timescaled. */
    duration: number;
    /** "Composition" time offset for that sample, timescaled. */
    compositionTimeOffset: number | undefined;
    /** Size for that sample, in bytes. */
    size: number | undefined;
    /** Flags for that sample as per the ISOBMFF spec, in decimal form. */
    flags: number | undefined;
}
/**
 *  Parse all trun boxes found in the given ISOBMFF file into "trun sample"
 *  objects.
 *  @param {Uint8Array} buffer
 *  @returns {Array.<Object>}
 */
declare function getTrunSamples(buffer: Uint8Array): ITrunSampleInfo[];
/**
 * Calculate segment duration approximation by additioning the duration from
 * every samples in a trun ISOBMFF box.
 *
 * Returns `undefined` if we could not parse the duration.
 * @param {Uint8Array} buffer
 * @returns {number | undefined}
 */
declare function getDurationFromTrun(buffer: Uint8Array): number | undefined;
/**
 * Get timescale information from a movie header box. Found in init segments.
 * `undefined` if not found or not parsed.
 *
 * This timescale is the default timescale used for segments.
 * @param {Uint8Array} buffer
 * @returns {Number | undefined}
 */
declare function getMDHDTimescale(buffer: Uint8Array): number | undefined;
/**
 * Update ISOBMFF given to add a "pssh" box in the "moov" box for every content
 * protection in the psshList array given.
 * @param {Uint8Array} buf - the ISOBMFF file
 * @param {Array.<Object>} psshList
 * @returns {Uint8Array} - The new ISOBMFF generated.
 */
declare function patchPssh(buf: Uint8Array, psshList: IISOBMFFPSSHInfo[]): Uint8Array;
/**
 * Returns a new version of the given box with the size updated
 * so it reflects its actual size.
 *
 * You can use this function after modifying a ISOBMFF box so its size is
 * updated.
 *
 * /!\ Please consider that this function might mutate the given Uint8Array
 * in place or might create a new one, depending on the current conditions.
 * @param {Uint8Array} buf - The ISOBMFF box
 * @returns {Uint8Array}
 */
declare function updateBoxLength(buf: Uint8Array<ArrayBuffer>): Uint8Array<ArrayBuffer>;
/**
 * Parse EMSG boxes from ISOBMFF data.
 * @param {Uint8Array} buffer
 * @returns {Array.<Object> | undefined}
 */
declare function parseEmsgBoxes(buffer: Uint8Array): IEMSG[] | undefined;
/**
 * @param {Uint8Array} segment
 * @returns {Uint8Array|null}
 */
declare function getKeyIdFromInitSegment<T extends ArrayBufferLike>(segment: Uint8Array<T>): Uint8Array<T> | null;
export type { ITrunSampleInfo };
export { getKeyIdFromInitSegment, getMDHDTimescale, getPlayReadyKIDFromPrivateData, getTrackFragmentDecodeTime, getDurationFromTrun, getSegmentsFromSidx, patchPssh, updateBoxLength, parseEmsgBoxes, getTrunSamples, };
//# sourceMappingURL=utils.d.ts.map