rx-player/src/parsers/manifest/dash/common/get_hdr_information.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.
 */

/**
 * Information about the HDR characteristic of a content.
 */
export interface IParsedWEBMHDRInformation {
  /**
   * It is the bit depth used for encoding color for a pixel.
   *
   * It is used to ask to the user agent if the color depth is supported by the
   * output device.
   */
  colorDepth: number;
  /**
   * It is the HDR eotf. It is the transfer function having the video signal as
   * input and converting it into the linear light output of the display. The
   * conversion is done within the display device.
   *
   * It may be used here to ask the MediaSource if it supported.
   */
  eotf: "pq" | "hlg";
  /**
   * It is the video color space used for encoding. An HDR content may not have
   * a wide color gamut.
   *
   * It may be used to ask about output device color space support.
   */
  colorSpace: "rec2020" | undefined;
}

/**
 * Extract the webm HDR information out of the codec string.
 * The syntax of the codec string is defined in VP Codec ISO Media File Format
 * Binding, in the section Codecs Parameter String.
 * @param {string} codecString
 * @returns {Object | undefined}
 */
export function getWEBMHDRInformation(
  codecString: string,
): undefined | IParsedWEBMHDRInformation {
  // cccc.PP.LL.DD.CC[.cp[.tc[.mc[.FF]]]]
  const [cccc, _PP, _LL, DD, _CC, cp, tc, mc] = codecString.split(".");
  if (cccc !== "vp08" && cccc !== "vp09" && cccc !== "vp10") {
    return undefined;
  }

  let colorDepth: number | undefined;
  let eotf: "pq" | "hlg" | undefined;
  let colorSpace: "rec2020" | undefined;

  if ((DD !== undefined && DD === "10") || DD === "12") {
    colorDepth = parseInt(DD, 10);
  }

  if (tc !== undefined) {
    // 1: ITU-R BT.709
    // 2: Unspecified
    // 4: Gamma 2.2 curve
    // 5: Gamma 2.8 curve
    // 6: SMPTE 170M
    // 7: SMPTE 240M
    // 8: Linear
    // 9: Logarithmic (100:1 range)
    // 10: Logarithmic (100 * Sqrt(10) : 1 range)
    // 11: IEC 61966-2-4
    // 12: ITU-R BT.1361 Extended Colour Gamut
    // 13: IEC 61966-2-1 (sRGB or sYCC)
    // 14: ITU-R BT.2020 10-bit system
    // 15: ITU-R BT.2020 12-bit system
    // 16: SMPTE ST 2084, ITU-R BT.2100 PQ
    // 17: SMPTE ST 428-1
    // 18: ARIB STD-B67 (HLG)
    if (tc === "16") {
      eotf = "pq";
    } else if (tc === "18") {
      eotf = "hlg";
    }
  }

  if (cp !== undefined && mc !== undefined && cp === "09" && mc === "09") {
    colorSpace = "rec2020";
  }

  if (colorDepth === undefined || eotf === undefined) {
    return undefined;
  }

  return { colorDepth, eotf, colorSpace };
}