rx-player
Version:
Canal+ HTML5 Video Player
534 lines (505 loc) • 17.8 kB
text/typescript
/**
* 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 log from "../../log";
import { isRepresentationPlayable, type IRepresentationMetadata } from "../../manifest";
import type {
ICdnMetadata,
IContentProtections,
IParsedRepresentation,
} from "../../parsers/manifest";
import type { ITrackType, IHDRInformation } from "../../public_types";
import areArraysOfNumbersEqual from "../../utils/are_arrays_of_numbers_equal";
import idGenerator from "../../utils/id_generator";
import { bytesToHex } from "../../utils/string_parsing";
import type codecSupportCache from "./codec_support_cache";
import type { IRepresentationIndex } from "./representation_index";
const generateRepresentationUniqueId = idGenerator();
/**
* Normalized Representation structure.
* @class Representation
*/
class Representation implements IRepresentationMetadata {
/** ID uniquely identifying the Representation in its parent Adaptation. */
public readonly id: string;
/**
* @see IRepresentationMetadata.uniqueId
*/
public readonly uniqueId: string;
/**
* @see IRepresentationMetadata.bitrate
*/
public bitrate: number;
/**
* @see IRepresentationMetadata.frameRate
*/
public frameRate?: number;
/**
* Interface allowing to get information about segments available for this
* Representation.
*/
public index: IRepresentationIndex;
/**
* Information on the CDN(s) on which requests should be done to request this
* Representation's initialization and media segments.
*
* `null` if there's no CDN involved here (e.g. resources are not requested
* through the network).
*
* An empty array means that no CDN are left to request the resource. As such,
* no resource can be loaded in that situation.
*/
public cdnMetadata: ICdnMetadata[] | null;
/**
* @see IRepresentationMetadata.isSpatialAudio
*/
public isSpatialAudio?: boolean | undefined;
/**
* @see IRepresentationMetadata.codecs
*/
public codecs: string[];
/**
* @see IRepresentationMetadata.mimeType
*/
public mimeType?: string;
/**
* @see IRepresentationMetadata.width
*/
public width?: number;
/**
* @see IRepresentationMetadata.height
*/
public height?: number;
/**
* @see IRepresentationMetadata.contentProtections
*/
public contentProtections?: IContentProtections;
/**
* @see IRepresentationMetadata.hdrInfo
*/
public hdrInfo?: IHDRInformation;
/**
* @see IRepresentationMetadata.decipherable
*
* Note that this property should __NEVER__ be updated directly on an
* instanciated `Representation`, you are supposed to rely on
* `Manifest` methods for this.
*/
public decipherable?: boolean | undefined;
/**
* @see IRepresentationMetadata.isSupported
*
* Note that this property should __NEVER__ be updated directly on an
* instanciated `Representation`, you are supposed to rely on
* `Manifest` methods for this.
*/
public isSupported: boolean | undefined;
/**
* @see ITrackType
*/
public trackType: ITrackType;
/**
* When set to `true`, the `Representation` should not be played, unless
* there's no other choice.
*
* Note that this property should __NEVER__ be updated directly on an
* instanciated `Representation`, you are supposed to rely on
* `Manifest` methods for this.
*/
public shouldBeAvoided: boolean;
/** If the codec is supported with MSE in worker */
public isCodecSupportedInWebWorker: boolean | undefined;
/**
* @param {Object} args
* @param {string} trackType
*/
constructor(
args: IParsedRepresentation,
trackType: ITrackType,
cachedCodecSupport: codecSupportCache,
) {
this.id = args.id;
this.uniqueId = generateRepresentationUniqueId();
this.shouldBeAvoided = false;
this.bitrate = args.bitrate;
this.codecs = [];
this.trackType = trackType;
if (args.isSpatialAudio !== undefined) {
this.isSpatialAudio = args.isSpatialAudio;
}
if (args.height !== undefined) {
this.height = args.height;
}
if (args.width !== undefined) {
this.width = args.width;
}
if (args.mimeType !== undefined) {
this.mimeType = args.mimeType;
}
if (args.contentProtections !== undefined) {
this.contentProtections = args.contentProtections;
}
if (args.frameRate !== undefined) {
this.frameRate = args.frameRate;
}
if (args.hdrInfo !== undefined) {
this.hdrInfo = args.hdrInfo;
}
this.cdnMetadata = args.cdnMetadata;
this.index = args.index;
const isEncrypted = this.contentProtections !== undefined;
if (trackType === "audio" || trackType === "video") {
// Supplemental codecs are defined as backwards-compatible codecs enhancing
// the experience of a base layer codec
if (args.supplementalCodecs !== undefined) {
const isSupplementaryCodecSupported = cachedCodecSupport.isSupported(
this.mimeType ?? "",
args.supplementalCodecs ?? "",
isEncrypted,
);
if (isSupplementaryCodecSupported !== false) {
this.codecs = [args.supplementalCodecs];
this.isSupported = isSupplementaryCodecSupported;
}
}
if (this.isSupported !== true) {
if (this.codecs.length > 0) {
// We couldn't check for support of another supplemental codec.
// Just push that codec without testing support yet, we'll check
// support later.
this.codecs.push(args.codecs ?? "");
} else {
this.codecs = args.codecs === undefined ? [] : [args.codecs];
this.isSupported = cachedCodecSupport.isSupported(
this.mimeType ?? "",
args.codecs ?? "",
isEncrypted,
);
}
}
} else {
if (args.codecs !== undefined) {
this.codecs.push(args.codecs);
}
this.isSupported = true;
}
}
/**
* Some environments (e.g. in a WebWorker) may not have the capability to know
* if a mimetype+codec combination is supported on the current platform.
*
* Calling `refreshCodecSupport` manually once the codecs supported are known
* by the current environnement allows to work-around this issue.
*
* If the right mimetype+codec combination is found in the provided object,
* this `Representation`'s `isSupported` property will be updated accordingly.
*
* @param {Array.<Object>} cachedCodecSupport;
*/
public refreshCodecSupport(cachedCodecSupport: codecSupportCache) {
if (this.isSupported !== undefined) {
return;
}
const isEncrypted = this.contentProtections !== undefined;
let isSupported: boolean | undefined = false;
const mimeType = this.mimeType ?? "";
let codecs = this.codecs ?? [];
if (codecs.length === 0) {
codecs = [""];
}
let representationHasUnknownCodecs = false;
for (const codec of codecs) {
isSupported = cachedCodecSupport.isSupported(mimeType, codec, isEncrypted);
if (isSupported === true) {
this.codecs = [codec];
break;
}
if (isSupported === undefined) {
representationHasUnknownCodecs = true;
}
}
/** If any codec is supported, the representation is supported */
if (isSupported === true) {
this.isSupported = true;
} else {
/** If some codecs support are not known it's too early to assume
* representation is unsupported */
if (representationHasUnknownCodecs) {
this.isSupported = undefined;
} else {
/** If all codecs support are known and none are supported,
* the representation is not supported.
*/
this.isSupported = false;
}
}
}
/**
* Returns "mime-type string" which includes both the mime-type and the codec,
* which is often needed when interacting with the browser's APIs.
* @returns {string}
*/
public getMimeTypeString(): string {
return `${this.mimeType ?? ""};codecs="${this.codecs?.[0] ?? ""}"`;
}
/**
* Returns encryption initialization data linked to the given DRM's system ID.
* This data may be useful to decrypt encrypted media segments.
*
* Returns an empty array if there is no data found for that system ID at the
* moment.
*
* When you know that all encryption data has been added to this
* Representation, you can also call the `getAllEncryptionData` method.
* This second function will return all encryption initialization data
* regardless of the DRM system, and might thus be used in all cases.
*
* /!\ Note that encryption initialization data may be progressively added to
* this Representation after `_addProtectionData` calls or Manifest updates.
* Because of this, the return value of this function might change after those
* events.
*
* @param {string} drmSystemId - The hexa-encoded DRM system ID
* @returns {Array.<Object>}
*/
public getEncryptionData(drmSystemId: string): IRepresentationProtectionData[] {
const allInitData = this.getAllEncryptionData();
const filtered = [];
for (let i = 0; i < allInitData.length; i++) {
let createdObjForType = false;
const initData = allInitData[i];
for (let j = 0; j < initData.values.length; j++) {
if (initData.values[j].systemId.toLowerCase() === drmSystemId.toLowerCase()) {
if (!createdObjForType) {
const keyIds = this.contentProtections?.keyIds;
filtered.push({
type: initData.type,
keyIds,
values: [initData.values[j]],
});
createdObjForType = true;
} else {
filtered[filtered.length - 1].values.push(initData.values[j]);
}
}
}
}
return filtered;
}
/**
* Returns all currently-known encryption initialization data linked to this
* Representation.
* Encryption initialization data is generally required to be able to decrypt
* those Representation's media segments.
*
* Unlike `getEncryptionData`, this method will return all available
* encryption data.
* It might as such might be used when either the current drm's system id is
* not known or when no encryption data specific to it was found. In that
* case, providing every encryption data linked to this Representation might
* still allow decryption.
*
* Returns an empty array in two cases:
* - the content is not encrypted.
* - We don't have any decryption data yet.
*
* /!\ Note that new encryption initialization data can be added progressively
* through the `_addProtectionData` method or through Manifest updates.
* It is thus highly advised to only rely on this method once every protection
* data related to this Representation has been known to be added.
*
* The main situation where new encryption initialization data is added is
* after parsing this Representation's initialization segment, if one exists.
* @returns {Array.<Object>}
*/
public getAllEncryptionData(): IRepresentationProtectionData[] {
if (
this.contentProtections === undefined ||
this.contentProtections.initData.length === 0
) {
return [];
}
const keyIds = this.contentProtections?.keyIds;
return this.contentProtections.initData.map((x) => {
return { type: x.type, keyIds, values: x.values };
});
}
/**
* Add new encryption initialization data to this Representation if it was not
* already included.
*
* Returns `true` if new encryption initialization data has been added.
* Returns `false` if none has been added (e.g. because it was already known).
*
* /!\ Mutates the current Representation
*
* TODO better handle use cases like key rotation by not always grouping
* every protection data together? To check.
* @param {string} initDataType
* @param {Uint8Array|undefined} keyId
* @param {Uint8Array} data
* @returns {boolean}
*/
public addProtectionData(
initDataType: string,
keyId: Uint8Array | undefined,
data: Array<{
systemId: string;
data: Uint8Array;
}>,
): boolean {
let hasUpdatedProtectionData = false;
if (this.contentProtections === undefined) {
this.contentProtections = {
keyIds: keyId !== undefined ? [keyId] : [],
initData: [{ type: initDataType, values: data }],
};
return true;
}
if (keyId !== undefined) {
const keyIds = this.contentProtections.keyIds;
if (keyIds === undefined) {
this.contentProtections.keyIds = [keyId];
} else {
let foundKeyId = false;
for (const knownKeyId of keyIds) {
if (areArraysOfNumbersEqual(knownKeyId, keyId)) {
foundKeyId = true;
}
}
if (!foundKeyId) {
log.warn("manifest", "found unanounced key id.", {
keyId: bytesToHex(keyId),
});
keyIds.push(keyId);
}
}
}
const cInitData = this.contentProtections.initData;
for (let i = 0; i < cInitData.length; i++) {
if (cInitData[i].type === initDataType) {
const cValues = cInitData[i].values;
// loop through data
for (let dataI = 0; dataI < data.length; dataI++) {
const dataToAdd = data[dataI];
let cValuesIdx;
for (cValuesIdx = 0; cValuesIdx < cValues.length; cValuesIdx++) {
if (dataToAdd.systemId === cValues[cValuesIdx].systemId) {
if (areArraysOfNumbersEqual(dataToAdd.data, cValues[cValuesIdx].data)) {
// go to next dataToAdd
break;
} else {
log.warn("manifest", "different init data for the same system ID", {
systemId: dataToAdd.systemId,
});
}
}
}
if (cValuesIdx === cValues.length) {
// we didn't break the loop === we didn't already find that value
cValues.push(dataToAdd);
hasUpdatedProtectionData = true;
}
}
return hasUpdatedProtectionData;
}
}
// If we are here, this means that we didn't find the corresponding
// init data type in this.contentProtections.initData.
this.contentProtections.initData.push({ type: initDataType, values: data });
return true;
}
/**
* Returns `true` if the `Representation` has a high chance of being playable on
* the current device (its codec seems supported and we don't consider it to be
* un-decipherable).
*
* Returns `false` if the `Representation` has a high chance of being unplayable
* on the current device (its codec seems unsupported and/or we consider it to
* be un-decipherable).
*
* Returns `undefined` if we don't know as the codec has not been checked yet.
*
* @returns {boolean|undefined}
*/
public isPlayable(): boolean | undefined {
return isRepresentationPlayable(this);
}
/**
* Format the current `Representation`'s properties into a
* `IRepresentationMetadata` format which can better be communicated through
* another thread.
*
* Please bear in mind however that the returned object will not be updated
* when the current `Representation` instance is updated, it is only a
* snapshot at the current time.
*
* If you want to keep that data up-to-date with the current `Representation`
* instance, you will have to do it yourself.
*
* @returns {Object}
*/
public getMetadataSnapshot(): IRepresentationMetadata {
return {
id: this.id,
uniqueId: this.uniqueId,
bitrate: this.bitrate,
codecs: this.codecs,
mimeType: this.mimeType,
width: this.width,
height: this.height,
frameRate: this.frameRate,
isSupported: this.isSupported,
hdrInfo: this.hdrInfo,
contentProtections: this.contentProtections,
decipherable: this.decipherable,
isCodecSupportedInWebWorker: this.isCodecSupportedInWebWorker,
};
}
}
/** Protection data as returned by a Representation. */
export interface IRepresentationProtectionData {
/**
* Initialization data type.
* String describing the format of the initialization data sent through this
* event.
* https://www.w3.org/TR/eme-initdata-registry/
*/
type: string;
/**
* The key ids linked to those initialization data.
* This should be the key ids for the key concerned by the media which have
* the present initialization data.
*
* `undefined` when not known (different from an empty array - which would
* just mean that there's no key id involved).
*/
keyIds: Uint8Array[] | undefined;
/** Every initialization data for that type. */
values: Array<{
/**
* Hex encoded system id, which identifies the key system.
* https://dashif.org/identifiers/content_protection/
*/
systemId: string;
/**
* The initialization data itself for that type and systemId.
* For example, with "cenc" initialization data found in an ISOBMFF file,
* this will be the whole PSSH box.
*/
data: Uint8Array;
}>;
}
export default Representation;