Repository navigation
Expand file tree
/
Copy pathcaption.js
More file actions
451 lines (421 loc) · 15.8 KB
/
Copy pathcaption.js
File metadata and controls
451 lines (421 loc) · 15.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
import $ from 'jquery';
function addCaptionFunctions(AblePlayer) {
AblePlayer.prototype.updateCaption = function (time) {
if (
!this.usingYouTubeCaptions &&
!this.usingVimeoCaptions &&
typeof this.$captionsWrapper !== "undefined"
) {
if (this.captionsOn) {
this.$captionsWrapper.show();
if (typeof time !== "undefined") {
this.showCaptions(time);
}
} else if (this.$captionsWrapper) {
this.$captionsWrapper.hide();
this.prefCaptions = 0;
}
}
};
AblePlayer.prototype.updateCaptionsMenu = function (lang) {
// uncheck all previous menu items
this.captionsPopup.find("li").attr("aria-checked", "false");
if (typeof lang === "undefined") {
// check the last menu item (captions off)
this.captionsPopup.find("li").last().attr("aria-checked", "true");
} else {
// check the newly selected lang
this.captionsPopup
.find("li[lang=" + lang + "]")
.attr("aria-checked", "true");
}
};
AblePlayer.prototype.getCaptionClickFunction = function (track) {
// Returns the function used when a caption is clicked in the captions menu.
// Not called if user clicks "Captions off". Instead, that triggers getCaptionOffFunction()
var thisObj = this;
return function () {
thisObj.selectedCaptions = track;
thisObj.captionLang = track.language;
thisObj.currentCaption = -1;
if (thisObj.usingYouTubeCaptions) {
if (thisObj.captionsOn) {
// Two things must be true in order for setOption() to work:
// The YouTube caption module must be loaded
// and the video must have started playing
if (
thisObj.youTubePlayer.getOptions("captions") &&
thisObj.startedPlaying
) {
thisObj.youTubePlayer.setOption("captions", "track", {
languageCode: thisObj.captionLang,
});
} else {
// the two conditions were not met
// try again to set the language after onApiChange event is triggered
// meanwhile, the following variable will hold the value
thisObj.captionLangPending = thisObj.captionLang;
}
} else {
if (thisObj.youTubePlayer.getOptions("captions")) {
thisObj.youTubePlayer.setOption("captions", "track", {
languageCode: thisObj.captionLang,
});
} else {
thisObj.youTubePlayer.loadModule("captions");
thisObj.captionLangPending = thisObj.captionLang;
}
}
} else if (thisObj.usingVimeoCaptions) {
thisObj.vimeoPlayer
.enableTextTrack(thisObj.captionLang)
.then(function (track) {
// track.language = the iso code for the language
// track.kind = 'captions' or 'subtitles'
// track.label = the human-readable label
})
.catch(function (error) {
switch (error.name) {
case "InvalidTrackLanguageError":
// no track was available with the specified language
console.log(
"No " +
track.kind +
" track is available in the specified language (" +
track.label +
")"
);
break;
case "InvalidTrackError":
// no track was available with the specified language and kind
console.log(
"No " +
track.kind +
" track is available in the specified language (" +
track.label +
")"
);
break;
default:
// some other error occurred
console.log(
"Error loading " + track.label + " " + track.kind + " track"
);
break;
}
});
} else {
// using local track elements for captions/subtitles
thisObj.syncTrackLanguages("captions", thisObj.captionLang);
if (!thisObj.swappingSrc) {
thisObj.updateCaption(thisObj.elapsed);
thisObj.showDescription(thisObj.elapsed);
}
}
thisObj.captionsOn = true;
// stopgap to prevent spacebar in Firefox from reopening popup
// immediately after closing it (used in handleCaptionToggle())
thisObj.hidingPopup = true;
thisObj.captionsPopup.hide();
thisObj.$ccButton.attr("aria-expanded", "false");
if (thisObj.mediaType === "audio") {
thisObj.$captionsContainer.removeClass("captions-off");
}
// Ensure stopgap gets cancelled if handleCaptionToggle() isn't called
// e.g., if user triggered button with Enter or mouse click, not spacebar
setTimeout(function () {
thisObj.hidingPopup = false;
}, 100);
thisObj.updateCaptionsMenu(thisObj.captionLang);
thisObj.waitThenFocus(thisObj.$ccButton);
// save preference to cookie
thisObj.prefCaptions = 1;
thisObj.updatePreferences("prefCaptions");
thisObj.refreshControls("captions");
};
};
// Returns the function used when the "Captions Off" button is clicked in the captions tooltip.
AblePlayer.prototype.getCaptionOffFunction = function () {
var thisObj = this;
return function () {
if (thisObj.player == "youtube") {
thisObj.youTubePlayer.unloadModule("captions");
} else if (thisObj.usingVimeoCaptions) {
thisObj.vimeoPlayer.disableTextTrack();
}
thisObj.captionsOn = false;
thisObj.currentCaption = -1;
if (thisObj.mediaType === "audio") {
thisObj.$captionsContainer.addClass("captions-off");
}
// stopgap to prevent spacebar in Firefox from reopening popup
// immediately after closing it (used in handleCaptionToggle())
thisObj.hidingPopup = true;
thisObj.captionsPopup.hide();
thisObj.$ccButton.attr("aria-expanded", "false");
// Ensure stopgap gets cancelled if handleCaptionToggle() isn't called
// e.g., if user triggered button with Enter or mouse click, not spacebar
setTimeout(function () {
thisObj.hidingPopup = false;
}, 100);
thisObj.updateCaptionsMenu();
thisObj.waitThenFocus(thisObj.$ccButton);
// save preference to cookie
thisObj.prefCaptions = 0;
thisObj.updatePreferences("prefCaptions");
if (!this.swappingSrc) {
thisObj.refreshControls("captions");
thisObj.updateCaption();
}
};
};
AblePlayer.prototype.showCaptions = function (now) {
var c, thisCaption, captionText;
var cues;
if (this.selectedCaptions.cues.length) {
cues = this.selectedCaptions.cues;
} else if (this.captions.length >= 1) {
cues = this.captions[0].cues;
} else {
cues = [];
}
for (c = 0; c < cues.length; c++) {
if (cues[c].start <= now && cues[c].end > now) {
thisCaption = c;
break;
}
}
if (typeof thisCaption !== "undefined") {
if (this.currentCaption !== thisCaption) {
// it's time to load the new caption into the container div
captionText = this.flattenCueForCaption(cues[thisCaption]).replace( /\n/g, "<br>" );
this.$captionsDiv.html(captionText);
this.currentCaption = thisCaption;
if (captionText.length === 0) {
// hide captionsDiv; otherwise background-color is visible due to padding
this.$captionsDiv.css("display", "none");
} else {
this.$captionsDiv.css("display", "inline-block");
}
}
} else {
this.$captionsDiv.html("").css("display", "none");
this.currentCaption = -1;
}
};
AblePlayer.prototype.flattenCueForCaption = function (cue) {
// Takes a cue and returns the caption text to display
// Also used for chapters
// Support for 'i' and 'b' tags added in 2.3.66
// TODO: Add support for 'c' (class) and 'ruby'
// c (class): <c.myClass1.myClass2>Some text</c>
// Classes can be used to modify other tags too (e.g., <v.loud>)
// If <c> tag, should be rendered as a <span>
// ruby: http://www.w3schools.com/tags/tag_ruby.asp
// WebVTT also supports 'u' (underline)
// I see no reason to support that in Able Player.
// If it's available authors are likely to use it incorrectly
// where <i> or <b> should be used instead
// Here are the rare use cases where an underline is appropriate on the web:
// http://html5doctor.com/u-element/
var result = [];
var flattenComponent = function (component) {
var result = [],
ii;
if (component.type === "string") {
result.push(component.value);
} else if (component.type === "v") {
result.push("(" + component.value + ")");
for (ii = 0; ii < component.children.length; ii++) {
result.push(flattenComponent(component.children[ii]));
}
} else if (component.type === "i") {
result.push("<em>");
for (ii = 0; ii < component.children.length; ii++) {
result.push(flattenComponent(component.children[ii]));
}
result.push("</em>");
} else if (component.type === "b") {
result.push("<strong>");
for (ii = 0; ii < component.children.length; ii++) {
result.push(flattenComponent(component.children[ii]));
}
result.push("</strong>");
} else {
for (ii = 0; ii < component.children.length; ii++) {
result.push(flattenComponent(component.children[ii]));
}
}
return result.join("");
};
if (typeof cue.components !== "undefined") {
for (var ii = 0; ii < cue.components.children.length; ii++) {
result.push(flattenComponent(cue.components.children[ii]));
}
}
return result.join("");
};
AblePlayer.prototype.getCaptionsOptions = function (pref) {
var options = [];
switch (pref) {
case "prefCaptionsFont":
options[0] = ["serif", this.translate( 'serif', 'serif' )];
options[1] = ["sans-serif", this.translate( 'sans', 'sans-serif' )];
options[2] = ["cursive", this.translate( 'cursive', 'cursive' )];
options[3] = ["fantasy", this.translate( 'fantasy', 'fantasy' )];
options[4] = ["monospace", this.translate( 'monospace', 'monospace' )];
break;
case "prefCaptionsColor":
case "prefCaptionsBGColor":
// HTML color values must be in English
options[0] = ["white", this.translate( 'white', 'white' )];
options[1] = ["yellow", this.translate( 'yellow', 'yellow' )];
options[2] = ["green", this.translate( 'green', 'green' )];
options[3] = ["cyan", this.translate( 'cyan', 'cyan' )];
options[4] = ["blue", this.translate( 'blue', 'blue' )];
options[5] = ["magenta", this.translate( 'magenta', 'magenta' )];
options[6] = ["red", this.translate( 'red', 'red' )];
options[7] = ["black", this.translate( 'black', 'black' )];
break;
case "prefCaptionsSize":
options[0] = "75%";
options[1] = "100%";
options[2] = "125%";
options[3] = "150%";
options[4] = "200%";
break;
case "prefCaptionsOpacity":
options[0] = "0%";
options[1] = "25%";
options[2] = "50%";
options[3] = "75%";
options[4] = "100%";
break;
case "prefCaptionsStyle":
options[0] = this.translate( 'captionsStylePopOn', 'Pop-on' );
options[1] = this.translate( 'captionsStyleRollUp', 'Roll-up' );
break;
case "prefCaptionsPosition":
options[0] = "overlay";
options[1] = "below";
break;
}
return options;
};
AblePlayer.prototype.translatePrefs = function (pref, value, outputFormat) {
// translate current value of pref to a value supported by outputformat
if (outputFormat == "youtube") {
if (pref === "size") {
// YouTube font sizes are a range from -1 to 3 (0 = default)
switch (value) {
case "75%":
return -1;
case "100%":
return 0;
case "125%":
return 1;
case "150%":
return 2;
case "200%":
return 3;
}
}
}
return false;
};
AblePlayer.prototype.stylizeCaptions = function ($element, pref) {
// $element is the jQuery element containing the captions
// this function handles stylizing of the sample caption text in the Prefs dialog
// plus the actual production captions
// TODO: consider applying the same user prefs to visible text-based description
var property, newValue, opacity;
if (typeof $element !== "undefined") {
if (pref == "prefCaptionsPosition") {
this.positionCaptions();
} else if (typeof pref !== "undefined") {
// just change the one property that user just changed
if (pref === "prefCaptionsFont") {
property = "font-family";
} else if (pref === "prefCaptionsSize") {
property = "font-size";
} else if (pref === "prefCaptionsColor") {
property = "color";
} else if (pref === "prefCaptionsBGColor") {
property = "background-color";
} else if (pref === "prefCaptionsOpacity") {
property = "opacity";
}
if (pref === "prefCaptionsOpacity") {
newValue =
parseFloat($("#" + this.mediaId + "_" + pref).val()) / 100.0;
} else {
newValue = $("#" + this.mediaId + "_" + pref).val();
}
$element.css(property, newValue);
} else {
// no property was specified, update all styles with current saved prefs
opacity = parseFloat(this.prefCaptionsOpacity) / 100.0;
$element.css({
"font-family": this.prefCaptionsFont,
color: this.prefCaptionsColor,
"background-color": this.prefCaptionsBGColor,
opacity: opacity,
});
if ($element === this.$captionsDiv) {
if (typeof this.$captionsDiv !== "undefined") {
this.$captionsDiv.css({
"font-size": this.prefCaptionsSize,
});
}
}
if (this.prefCaptionsPosition === "below") {
// also need to add the background color to the wrapper div
if (typeof this.$captionsWrapper !== "undefined") {
this.$captionsWrapper.css({
"background-color": this.prefCaptionsBGColor,
opacity: "1",
});
}
} else if (this.prefCaptionsPosition === "overlay") {
// no background color for overlay wrapper, captions are displayed in-line
if (typeof this.$captionsWrapper !== "undefined") {
this.$captionsWrapper.css({
"background-color": "transparent",
opacity: "",
});
}
}
this.positionCaptions();
}
}
};
AblePlayer.prototype.positionCaptions = function (position) {
// set caption position to either 'overlay' or 'below'
// if position parameter was passed to this function, use that
// otherwise use user preference
if (typeof position === "undefined") {
position = this.prefCaptionsPosition;
}
if (typeof this.$captionsWrapper !== "undefined") {
if (position == "below") {
this.$captionsWrapper
.removeClass("able-captions-overlay")
.addClass("able-captions-below");
// also need to update in-line styles
this.$captionsWrapper.css({
"background-color": this.prefCaptionsBGColor,
opacity: "1",
});
} else {
this.$captionsWrapper
.removeClass("able-captions-below")
.addClass("able-captions-overlay");
this.$captionsWrapper.css({
"background-color": "transparent",
opacity: "",
});
}
}
};
}
export default addCaptionFunctions;