Source: lib/util/mime_utils.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.util.MimeUtils');
  9. goog.require('shaka.transmuxer.TransmuxerEngine');
  10. goog.require('shaka.util.ManifestParserUtils');
  12. /**
  13.  * @summary A set of utility functions for dealing with MIME types.
  14.  * @export
  15.  */
  16. shaka.util.MimeUtils = class {
  17.   /**
  18.    * Takes a MIME type and optional codecs string and produces the full MIME
  19.    * type. Also remove the codecs for raw formats.
  20.    *
  21.    * @param {string} mimeType
  22.    * @param {string=} codecs
  23.    * @return {string}
  24.    * @export
  25.    */
  26.   static getFullType(mimeType, codecs) {
  27.     let fullMimeType = mimeType;
  28.     if (codecs && !shaka.util.MimeUtils.RAW_FORMATS.includes(mimeType)) {
  29.       fullMimeType += '; codecs="' + codecs + '"';
  30.     }
  31.     return fullMimeType;
  32.   }
  34.   /**
  35.    * Takes a MIME type and optional codecs string and produces the full MIME
  36.    * type.
  37.    *
  38.    * @param {string} mimeType
  39.    * @param {string=} codecs
  40.    * @return {string}
  41.    * @export
  42.    */
  43.   static getFullTypeWithAllCodecs(mimeType, codecs) {
  44.     let fullMimeType = mimeType;
  45.     if (codecs) {
  46.       fullMimeType += '; codecs="' + codecs + '"';
  47.     }
  48.     return fullMimeType;
  49.   }
  51.   /**
  52.    * Takes a MIME type and a codecs string and produces the full MIME
  53.    * type. If it's a transport stream, convert its codecs to MP4 codecs.
  54.    * Otherwise for multiplexed content, convert the video MIME types to
  55.    * their audio equivalents if the content type is audio.
  56.    *
  57.    * @param {string} mimeType
  58.    * @param {string} codecs
  59.    * @param {string} contentType
  60.    * @return {string}
  61.    */
  62.   static getFullOrConvertedType(mimeType, codecs, contentType) {
  63.     const MimeUtils = shaka.util.MimeUtils;
  64.     const fullMimeType = MimeUtils.getFullType(mimeType, codecs);
  65.     const fullMimeTypeWithAllCodecs = MimeUtils.getFullTypeWithAllCodecs(
  66.         mimeType, codecs);
  67.     const ContentType = shaka.util.ManifestParserUtils.ContentType;
  68.     const TransmuxerEngine = shaka.transmuxer.TransmuxerEngine;
  70.     if (TransmuxerEngine.isSupported(fullMimeTypeWithAllCodecs, contentType)) {
  71.       return TransmuxerEngine.convertCodecs(
  72.           contentType, fullMimeTypeWithAllCodecs);
  73.     } else if (mimeType != 'video/mp2t' && contentType == ContentType.AUDIO) {
  74.       // video/mp2t is the correct mime type for TS audio, so only replace the
  75.       // word "video" with "audio" for non-TS audio content.
  76.       return fullMimeType.replace('video', 'audio');
  77.     }
  78.     return fullMimeType;
  79.   }
  82.   /**
  83.    * Takes a Stream object and produces an extended MIME type with information
  84.    * beyond the container and codec type, when available.
  85.    *
  86.    * @param {shaka.extern.Stream} stream
  87.    * @param {string} mimeType
  88.    * @param {string} codecs
  89.    * @return {string}
  90.    */
  91.   static getExtendedType(stream, mimeType, codecs) {
  92.     const components = [mimeType];
  94.     const extendedMimeParams = shaka.util.MimeUtils.EXTENDED_MIME_PARAMETERS_;
  95.     extendedMimeParams.forEach((mimeKey, streamKey) => {
  96.       const value = stream[streamKey];
  97.       if (streamKey == 'codecs') {
  98.         if (shaka.util.MimeUtils.RAW_FORMATS.includes(stream.mimeType)) {
  99.           // Skip codecs for raw formats
  100.         } else {
  101.           components.push('codecs="' + codecs + '"');
  102.         }
  103.       } else if (value) {
  104.         components.push(mimeKey + '="' + value + '"');
  105.       }
  106.     });
  107.     if (stream.hdr == 'PQ') {
  108.       components.push('eotf="smpte2084"');
  109.     }
  111.     return components.join(';');
  112.   }
  114.   /**
  115.    * Takes a full MIME type (with codecs) or basic MIME type (without codecs)
  116.    * and returns a container type string ("mp2t", "mp4", "webm", etc.)
  117.    *
  118.    * @param {string} mimeType
  119.    * @return {string}
  120.    */
  121.   static getContainerType(mimeType) {
  122.     return mimeType.split(';')[0].split('/')[1];
  123.   }
  125.   /**
  126.    * Split a list of codecs encoded in a string into a list of codecs.
  127.    * @param {string} codecs
  128.    * @return {!Array<string>}
  129.    */
  130.   static splitCodecs(codecs) {
  131.     return codecs.split(',');
  132.   }
  134.   /**
  135.    * Get the normalized codec from a codec string,
  136.    * independently of their container.
  137.    *
  138.    * @param {string} codecString
  139.    * @return {string}
  140.    */
  141.   static getNormalizedCodec(codecString) {
  142.     const parts =
  143.       shaka.util.MimeUtils.getCodecParts_(codecString);
  144.     const base = parts[0].toLowerCase();
  145.     const profile = parts[1].toLowerCase();
  146.     switch (true) {
  147.       case base === 'mp4a' && profile === '69':
  148.       case base === 'mp4a' && profile === '6b':
  149.       case base === 'mp4a' && profile === '40.34':
  150.         return 'mp3';
  151.       case base === 'mp4a' && profile === '66':
  152.       case base === 'mp4a' && profile === '67':
  153.       case base === 'mp4a' && profile === '68':
  154.       case base === 'mp4a' && profile === '40.2':
  155.       case base === 'mp4a' && profile === '40.02':
  156.       case base === 'mp4a' && profile === '40.5':
  157.       case base === 'mp4a' && profile === '40.05':
  158.       case base === 'mp4a' && profile === '40.29':
  159.       case base === 'mp4a' && profile === '40.42': // Extended HE-AAC
  160.         return 'aac';
  161.       case base === 'mp4a' && profile === 'a5':
  162.       case base === 'ac3':
  163.       case base === 'ac-3':
  164.         return 'ac-3'; // Dolby Digital
  165.       case base === 'mp4a' && profile === 'a6':
  166.       case base === 'eac3':
  167.       case base === 'ec-3':
  168.         return 'ec-3'; // Dolby Digital Plus
  169.       case base === 'ac-4':
  170.         return 'ac-4'; // Dolby AC-4
  171.       case base === 'mp4a' && profile === 'b2':
  172.         return 'dtsx'; // DTS:X
  173.       case base === 'mp4a' && profile === 'a9':
  174.         return 'dtsc'; // DTS Digital Surround
  175.       case base === 'vp09':
  176.         return 'vp9';
  177.       case base === 'avc1':
  178.       case base === 'avc3':
  179.         return 'avc'; // H264
  180.       case base === 'hvc1':
  181.       case base === 'hev1':
  182.         return 'hevc'; // H265
  183.       case base === 'vvc1':
  184.       case base === 'vvi1':
  185.         return 'vvc'; // H266
  186.       case base === 'dvh1':
  187.       case base === 'dvhe':
  188.         if (profile && profile.startsWith('05')) {
  189.           return 'dovi-p5'; // Dolby Vision profile 5
  190.         }
  191.         return 'dovi-hevc'; // Dolby Vision based in HEVC
  192.       case base === 'dvav':
  193.       case base === 'dva1':
  194.         return 'dovi-avc'; // Dolby Vision based in AVC
  195.       case base === 'dav1':
  196.         return 'dovi-av1'; // Dolby Vision based in AV1
  197.       case base === 'dvc1':
  198.       case base === 'dvi1':
  199.         return 'dovi-vvc'; // Dolby Vision based in VVC
  200.     }
  201.     return base;
  202.   }
  204.   /**
  205.    * Get the base codec from a codec string.
  206.    *
  207.    * @param {string} codecString
  208.    * @return {string}
  209.    */
  210.   static getCodecBase(codecString) {
  211.     const codecsBase = [];
  212.     for (const codec of codecString.split(',')) {
  213.       const parts = shaka.util.MimeUtils.getCodecParts_(codec);
  214.       codecsBase.push(parts[0]);
  215.     }
  216.     return codecsBase.sort().join(',');
  217.   }
  219.   /**
  220.    * Takes a full MIME type (with codecs) or basic MIME type (without codecs)
  221.    * and returns a basic MIME type (without codecs or other parameters).
  222.    *
  223.    * @param {string} mimeType
  224.    * @return {string}
  225.    */
  226.   static getBasicType(mimeType) {
  227.     return mimeType.split(';')[0];
  228.   }
  230.   /**
  231.    * Takes a MIME type and returns the codecs parameter, or an empty string if
  232.    * there is no codecs parameter.
  233.    *
  234.    * @param {string} mimeType
  235.    * @return {string}
  236.    */
  237.   static getCodecs(mimeType) {
  238.     // Parse the basic MIME type from its parameters.
  239.     const pieces = mimeType.split(/ *; */);
  240.     pieces.shift();  // Remove basic MIME type from pieces.
  242.     const codecs = pieces.find((piece) => piece.startsWith('codecs='));
  243.     if (!codecs) {
  244.       return '';
  245.     }
  247.     // The value may be quoted, so remove quotes at the beginning or end.
  248.     const value = codecs.split('=')[1].replace(/^"|"$/g, '');
  249.     return value;
  250.   }
  252.   /**
  253.    * Checks if the given MIME type is HLS MIME type.
  254.    *
  255.    * @param {string} mimeType
  256.    * @return {boolean}
  257.    */
  258.   static isHlsType(mimeType) {
  259.     return mimeType === 'application/x-mpegurl' ||
  260.         mimeType === 'application/vnd.apple.mpegurl';
  261.   }
  263.   /**
  264.    * Checks if the given MIME type is DASH MIME type.
  265.    *
  266.    * @param {string} mimeType
  267.    * @return {boolean}
  268.    */
  269.   static isDashType(mimeType) {
  270.     return mimeType === 'application/dash+xml' ||
  271.         mimeType === 'video/vnd.mpeg.dash.mpd';
  272.   }
  274.   /**
  275.    * Get the base and profile of a codec string. Where [0] will be the codec
  276.    * base and [1] will be the profile.
  277.    * @param {string} codecString
  278.    * @return {!Array<string>}
  279.    * @private
  280.    */
  281.   static getCodecParts_(codecString) {
  282.     const parts = codecString.split('.');
  284.     const base = parts[0];
  286.     parts.shift();
  287.     const profile = parts.join('.');
  289.     // Make sure that we always return a "base" and "profile".
  290.     return [base, profile];
  291.   }
  292. };
  295. /**
  296.  * A map from Stream object keys to MIME type parameters.  These should be
  297.  * ignored by platforms that do not recognize them.
  298.  *
  299.  * This initial set of parameters are all recognized by Chromecast.
  300.  *
  301.  * @const {!Map<string, string>}
  302.  * @private
  303.  */
  304. shaka.util.MimeUtils.EXTENDED_MIME_PARAMETERS_ = new Map()
  305.     .set('codecs', 'codecs')
  306.     .set('frameRate', 'framerate')  // Ours is camelCase, theirs is lowercase.
  307.     .set('bandwidth', 'bitrate')  // They are in the same units: bits/sec.
  308.     .set('width', 'width')
  309.     .set('height', 'height')
  310.     .set('channelsCount', 'channels');
  313. /**
  314.  * A mimetype created for CEA-608 closed captions.
  315.  * @const {string}
  316.  */
  317. shaka.util.MimeUtils.CEA608_CLOSED_CAPTION_MIMETYPE = 'application/cea-608';
  319. /**
  320.  * A mimetype created for CEA-708 closed captions.
  321.  * @const {string}
  322.  */
  323. shaka.util.MimeUtils.CEA708_CLOSED_CAPTION_MIMETYPE = 'application/cea-708';
  325. /**
  326.  * MIME types of raw formats.
  327.  *
  328.  * @const {!Array<string>}
  329.  */
  330. shaka.util.MimeUtils.RAW_FORMATS = [
  331.   'audio/aac',
  332.   'audio/ac3',
  333.   'audio/ec3',
  334.   'audio/mpeg',
  335. ];