Source: lib/media/manifest_parser.js

  1. /**
  2.  * @license
  3.  * Copyright 2016 Google Inc.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  18. goog.provide('shaka.media.ManifestParser');
  21. /**
  22.  * @namespace shaka.media.ManifestParser
  23.  * @summary An interface to register manifest parsers.
  24.  * @exportDoc
  25.  */
  28. /**
  29.  * Contains the parser factory functions indexed by MIME type.
  30.  *
  31.  * @type {!Object.<string, shakaExtern.ManifestParser.Factory>}
  32.  */
  33. shaka.media.ManifestParser.parsersByMime = {};
  36. /**
  37.  * Contains the parser factory functions indexed by file extension.
  38.  *
  39.  * @type {!Object.<string, shakaExtern.ManifestParser.Factory>}
  40.  */
  41. shaka.media.ManifestParser.parsersByExtension = {};
  44. /**
  45.  * Registers a manifest parser by file extension.
  46.  *
  47.  * @param {string} extension The file extension of the manifest.
  48.  * @param {shakaExtern.ManifestParser.Factory} parserFactory The factory
  49.  *   used to create parser instances.
  50.  * @export
  51.  */
  52. shaka.media.ManifestParser.registerParserByExtension = function(
  53.     extension, parserFactory) {
  54.   shaka.media.ManifestParser.parsersByExtension[extension] = parserFactory;
  55. };
  58. /**
  59.  * Registers a manifest parser by MIME type.
  60.  *
  61.  * @param {string} mimeType The MIME type of the manifest.
  62.  * @param {shakaExtern.ManifestParser.Factory} parserFactory The factory
  63.  *   used to create parser instances.
  64.  * @export
  65.  */
  66. shaka.media.ManifestParser.registerParserByMime = function(
  67.     mimeType, parserFactory) {
  68.   shaka.media.ManifestParser.parsersByMime[mimeType] = parserFactory;
  69. };
  72. /**
  73.  * Returns a map of manifest support for well-known types.
  74.  *
  75.  * @return {!Object.<string, boolean>}
  76.  */
  77. shaka.media.ManifestParser.support = function() {
  78.   // Every object in the support hierarchy has a "basic" member.
  79.   // All "basic" members must be true for the library to be usable.
  80.   var support = {'basic': true};
  82.   // Make sure all registered parsers are shown.
  83.   for (var type in shaka.media.ManifestParser.parsersByMime) {
  84.     support[type] = true;
  85.   }
  86.   for (var type in shaka.media.ManifestParser.parsersByExtension) {
  87.     support[type] = true;
  88.   }
  90.   // Make sure all well-known types are tested as well, just to show an explicit
  91.   // false for things people might be expecting.
  92.   var testMimeTypes = [
  93.     // DASH
  94.     'application/dash+xml',
  95.     // HLS
  96.     'application/x-mpegurl',
  97.     'application/vnd.apple.mpegurl',
  98.     // SmoothStreaming
  99.     'application/vnd.ms-sstr+xml'
  100.   ];
  101.   var testExtensions = [
  102.     // DASH
  103.     'mpd',
  104.     // HLS
  105.     'm3u8',
  106.     // SmoothStreaming
  107.     'ism'
  108.   ];
  110.   testMimeTypes.forEach(function(type) {
  111.     support[type] = !!shaka.media.ManifestParser.parsersByMime[type];
  112.   });
  113.   testExtensions.forEach(function(type) {
  114.     support[type] = !!shaka.media.ManifestParser.parsersByExtension[type];
  115.   });
  117.   return support;
  118. };