emsg.js 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. var uint8ToCString = require('../utils/string.js').uint8ToCString;
  2. var getUint64 = require('../utils/numbers.js').getUint64;
  3. /**
  4. * Based on: ISO/IEC 23009 Section: 5.10.3.3
  5. * References:
  6. * https://dashif-documents.azurewebsites.net/Events/master/event.html#emsg-format
  7. * https://aomediacodec.github.io/id3-emsg/
  8. *
  9. * Takes emsg box data as a uint8 array and returns a emsg box object
  10. * @param {UInt8Array} boxData data from emsg box
  11. * @returns A parsed emsg box object
  12. */
  13. var parseEmsgBox = function parseEmsgBox(boxData) {
  14. // version + flags
  15. var offset = 4;
  16. var version = boxData[0];
  17. var scheme_id_uri, value, timescale, presentation_time, presentation_time_delta, event_duration, id, message_data;
  18. if (version === 0) {
  19. scheme_id_uri = uint8ToCString(boxData.subarray(offset));
  20. offset += scheme_id_uri.length;
  21. value = uint8ToCString(boxData.subarray(offset));
  22. offset += value.length;
  23. var dv = new DataView(boxData.buffer);
  24. timescale = dv.getUint32(offset);
  25. offset += 4;
  26. presentation_time_delta = dv.getUint32(offset);
  27. offset += 4;
  28. event_duration = dv.getUint32(offset);
  29. offset += 4;
  30. id = dv.getUint32(offset);
  31. offset += 4;
  32. } else if (version === 1) {
  33. var dv = new DataView(boxData.buffer);
  34. timescale = dv.getUint32(offset);
  35. offset += 4;
  36. presentation_time = getUint64(boxData.subarray(offset));
  37. offset += 8;
  38. event_duration = dv.getUint32(offset);
  39. offset += 4;
  40. id = dv.getUint32(offset);
  41. offset += 4;
  42. scheme_id_uri = uint8ToCString(boxData.subarray(offset));
  43. offset += scheme_id_uri.length;
  44. value = uint8ToCString(boxData.subarray(offset));
  45. offset += value.length;
  46. }
  47. message_data = new Uint8Array(boxData.subarray(offset, boxData.byteLength));
  48. var emsgBox = {
  49. scheme_id_uri: scheme_id_uri,
  50. value: value,
  51. // if timescale is undefined or 0 set to 1
  52. timescale: timescale ? timescale : 1,
  53. presentation_time: presentation_time,
  54. presentation_time_delta: presentation_time_delta,
  55. event_duration: event_duration,
  56. id: id,
  57. message_data: message_data
  58. };
  59. return isValidEmsgBox(version, emsgBox) ? emsgBox : undefined;
  60. };
  61. /**
  62. * Scales a presentation time or time delta with an offset with a provided timescale
  63. * @param {number} presentationTime
  64. * @param {number} timescale
  65. * @param {number} timeDelta
  66. * @param {number} offset
  67. * @returns the scaled time as a number
  68. */
  69. var scaleTime = function scaleTime(presentationTime, timescale, timeDelta, offset) {
  70. return presentationTime || presentationTime === 0 ? presentationTime / timescale : offset + timeDelta / timescale;
  71. };
  72. /**
  73. * Checks the emsg box data for validity based on the version
  74. * @param {number} version of the emsg box to validate
  75. * @param {Object} emsg the emsg data to validate
  76. * @returns if the box is valid as a boolean
  77. */
  78. var isValidEmsgBox = function isValidEmsgBox(version, emsg) {
  79. var hasScheme = emsg.scheme_id_uri !== '\0';
  80. var isValidV0Box = version === 0 && isDefined(emsg.presentation_time_delta) && hasScheme;
  81. var isValidV1Box = version === 1 && isDefined(emsg.presentation_time) && hasScheme; // Only valid versions of emsg are 0 and 1
  82. return !(version > 1) && isValidV0Box || isValidV1Box;
  83. }; // Utility function to check if an object is defined
  84. var isDefined = function isDefined(data) {
  85. return data !== undefined || data !== null;
  86. };
  87. module.exports = {
  88. parseEmsgBox: parseEmsgBox,
  89. scaleTime: scaleTime
  90. };