Home Reference Source

src/utils/texttrack-utils.ts

  1. import { logger } from './logger';
  2.  
  3. export function sendAddTrackEvent(track: TextTrack, videoEl: HTMLMediaElement) {
  4. let event: Event;
  5. try {
  6. event = new Event('addtrack');
  7. } catch (err) {
  8. // for IE11
  9. event = document.createEvent('Event');
  10. event.initEvent('addtrack', false, false);
  11. }
  12. (event as any).track = track;
  13. videoEl.dispatchEvent(event);
  14. }
  15.  
  16. export function addCueToTrack(track: TextTrack, cue: VTTCue) {
  17. // Sometimes there are cue overlaps on segmented vtts so the same
  18. // cue can appear more than once in different vtt files.
  19. // This avoid showing duplicated cues with same timecode and text.
  20. const mode = track.mode;
  21. if (mode === 'disabled') {
  22. track.mode = 'hidden';
  23. }
  24. if (track.cues && !track.cues.getCueById(cue.id)) {
  25. try {
  26. track.addCue(cue);
  27. if (!track.cues.getCueById(cue.id)) {
  28. throw new Error(`addCue is failed for: ${cue}`);
  29. }
  30. } catch (err) {
  31. logger.debug(`[texttrack-utils]: ${err}`);
  32. const textTrackCue = new (self.TextTrackCue as any)(
  33. cue.startTime,
  34. cue.endTime,
  35. cue.text
  36. );
  37. textTrackCue.id = cue.id;
  38. track.addCue(textTrackCue);
  39. }
  40. }
  41. if (mode === 'disabled') {
  42. track.mode = mode;
  43. }
  44. }
  45.  
  46. export function clearCurrentCues(track: TextTrack) {
  47. // When track.mode is disabled, track.cues will be null.
  48. // To guarantee the removal of cues, we need to temporarily
  49. // change the mode to hidden
  50. const mode = track.mode;
  51. if (mode === 'disabled') {
  52. track.mode = 'hidden';
  53. }
  54. if (!track.cues) {
  55. return;
  56. }
  57. for (let i = track.cues.length; i--; ) {
  58. track.removeCue(track.cues[i]);
  59. }
  60. if (mode === 'disabled') {
  61. track.mode = mode;
  62. }
  63. }
  64.  
  65. export function removeCuesInRange(
  66. track: TextTrack,
  67. start: number,
  68. end: number
  69. ) {
  70. const mode = track.mode;
  71. if (mode === 'disabled') {
  72. track.mode = 'hidden';
  73. }
  74. if (!track.cues || !track.cues.length) {
  75. return;
  76. }
  77. const cues = getCuesInRange(track.cues, start, end);
  78. for (let i = 0; i < cues.length; i++) {
  79. track.removeCue(cues[i]);
  80. }
  81. if (mode === 'disabled') {
  82. track.mode = mode;
  83. }
  84. }
  85.  
  86. // Find first cue starting after given time.
  87. // Modified version of binary search O(log(n)).
  88. function getFirstCueIndexAfterTime(
  89. cues: TextTrackCueList | TextTrackCue[],
  90. time: number
  91. ): number {
  92. // If first cue starts after time, start there
  93. if (time < cues[0].startTime) {
  94. return 0;
  95. }
  96. // If the last cue ends before time there is no overlap
  97. const len = cues.length - 1;
  98. if (time > cues[len].endTime) {
  99. return -1;
  100. }
  101.  
  102. let left = 0;
  103. let right = len;
  104.  
  105. while (left <= right) {
  106. const mid = Math.floor((right + left) / 2);
  107.  
  108. if (time < cues[mid].startTime) {
  109. right = mid - 1;
  110. } else if (time > cues[mid].startTime && left < len) {
  111. left = mid + 1;
  112. } else {
  113. // If it's not lower or higher, it must be equal.
  114. return mid;
  115. }
  116. }
  117. // At this point, left and right have swapped.
  118. // No direct match was found, left or right element must be the closest. Check which one has the smallest diff.
  119. return cues[left].startTime - time < time - cues[right].startTime
  120. ? left
  121. : right;
  122. }
  123.  
  124. export function getCuesInRange(
  125. cues: TextTrackCueList | TextTrackCue[],
  126. start: number,
  127. end: number
  128. ): TextTrackCue[] {
  129. const cuesFound: TextTrackCue[] = [];
  130. const firstCueInRange = getFirstCueIndexAfterTime(cues, start);
  131. if (firstCueInRange > -1) {
  132. for (let i = firstCueInRange, len = cues.length; i < len; i++) {
  133. const cue = cues[i];
  134. if (cue.startTime >= start && cue.endTime <= end) {
  135. cuesFound.push(cue);
  136. } else if (cue.startTime > end) {
  137. return cuesFound;
  138. }
  139. }
  140. }
  141. return cuesFound;
  142. }