aboutsummaryrefslogtreecommitdiffstats
path: root/src/js/captions.js
blob: 851bf58d1f12b1649aa0d76fd728817754e0821a (plain)
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
// ==========================================================================
// Plyr Captions
// ==========================================================================

import support from './support';
import utils from './utils';
import controls from './controls';
import storage from './storage';

const captions = {
    // Setup captions
    setup() {
        // Requires UI support
        if (!this.supported.ui) {
            return;
        }

        // Set default language if not set
        if (!utils.is.empty(storage.get.call(this).language)) {
            this.captions.language = storage.get.call(this).language;
        } else if (utils.is.empty(this.captions.language)) {
            this.captions.language = this.config.captions.language.toLowerCase();
        }

        // Set captions enabled state if not set
        if (!utils.is.boolean(this.captions.enabled)) {
            if (!utils.is.empty(storage.get.call(this).language)) {
                this.captions.enabled = storage.get.call(this).captions;
            } else {
                this.captions.enabled = this.config.captions.active;
            }
        }

        // Only Vimeo and HTML5 video supported at this point
        if (!['video', 'vimeo'].includes(this.type) || (this.type === 'video' && !support.textTracks)) {
            this.captions.tracks = null;

            // Clear menu and hide
            if (this.config.controls.includes('settings') && this.config.settings.includes('captions')) {
                controls.setCaptionsMenu.call(this);
            }

            return;
        }

        // Inject the container
        if (!utils.is.htmlElement(this.elements.captions)) {
            this.elements.captions = utils.createElement(
                'div',
                utils.getAttributesFromSelector(this.config.selectors.captions)
            );
            utils.insertAfter(this.elements.captions, this.elements.wrapper);
        }

        // Get tracks from HTML5
        if (this.type === 'video') {
            this.captions.tracks = this.media.textTracks;
        }

        // Set the class hook
        utils.toggleClass(
            this.elements.container,
            this.config.classNames.captions.enabled,
            !utils.is.empty(this.captions.tracks)
        );

        // If no caption file exists, hide container for caption text
        if (utils.is.empty(this.captions.tracks)) {
            return;
        }

        // Enable UI
        captions.show.call(this);

        // Get a track
        const setCurrentTrack = () => {
            // Reset by default
            this.captions.currentTrack = null;

            // Filter doesn't seem to work for a TextTrackList :-(
            Array.from(this.captions.tracks).forEach(track => {
                if (track.language === this.captions.language.toLowerCase()) {
                    this.captions.currentTrack = track;
                }
            });
        };

        // Get current track
        setCurrentTrack();

        // If we couldn't get the requested language, revert to default
        if (!utils.is.track(this.captions.currentTrack)) {
            const { language } = this.config.captions;

            // Reset to default
            // We don't update user storage as the selected language could become available
            this.captions.language = language;

            // Get fallback track
            setCurrentTrack();

            // If no match, disable captions
            if (!utils.is.track(this.captions.currentTrack)) {
                this.toggleCaptions(false);
            }

            controls.updateSetting.call(this, 'captions');
        }

        // Setup HTML5 track rendering
        if (this.type === 'video') {
            // Turn off native caption rendering to avoid double captions
            Array.from(this.captions.tracks).forEach(track => {
                // Remove previous bindings (if we've changed source or language)
                utils.off(track, 'cuechange', event => captions.setCue.call(this, event));

                // Hide captions
                // eslint-disable-next-line
                track.mode = 'hidden';
            });

            // Check if suported kind
            const supported =
                this.captions.currentTrack && ['captions', 'subtitles'].includes(this.captions.currentTrack.kind);

            if (utils.is.track(this.captions.currentTrack) && supported) {
                utils.on(this.captions.currentTrack, 'cuechange', event => captions.setCue.call(this, event));

                // If we change the active track while a cue is already displayed we need to update it
                if (this.captions.currentTrack.activeCues && this.captions.currentTrack.activeCues.length > 0) {
                    captions.setCue.call(this, this.captions.currentTrack);
                }
            }
        } else if (this.type === 'vimeo' && this.captions.active) {
            this.embed.enableTextTrack(this.captions.language);
        }

        // Set available languages in list
        if (this.config.controls.includes('settings') && this.config.settings.includes('captions')) {
            controls.setCaptionsMenu.call(this);
        }
    },

    // Display active caption if it contains text
    setCue(input) {
        // Get the track from the event if needed
        const track = utils.is.event(input) ? input.target : input;
        const active = track.activeCues[0];

        // Display a cue, if there is one
        if (utils.is.cue(active)) {
            captions.set.call(this, active.getCueAsHTML());
        } else {
            captions.set.call(this);
        }

        utils.dispatchEvent.call(this, this.media, 'cuechange');
    },

    // Set the current caption
    set(input) {
        // Requires UI
        if (!this.supported.ui) {
            return;
        }

        if (utils.is.htmlElement(this.elements.captions)) {
            const content = utils.createElement('span');

            // Empty the container
            utils.emptyElement(this.elements.captions);

            // Default to empty
            const caption = !utils.is.undefined(input) ? input : '';

            // Set the span content
            if (utils.is.string(caption)) {
                content.textContent = caption.trim();
            } else {
                content.appendChild(caption);
            }

            // Set new caption text
            this.elements.captions.appendChild(content);
        } else {
            this.warn('No captions element to render to');
        }
    },

    // Display captions container and button (for initialization)
    show() {
        // If there's no caption toggle, bail
        if (!utils.is.htmlElement(this.elements.buttons.captions)) {
            return;
        }

        // Try to load the value from storage
        let active = storage.get.call(this).captions;

        // Otherwise fall back to the default config
        if (!utils.is.boolean(active)) {
            ({ active } = this.config.captions);
        } else {
            this.captions.active = active;
        }

        if (active) {
            utils.toggleClass(this.elements.container, this.config.classNames.captions.active, true);
            utils.toggleState(this.elements.buttons.captions, true);
        }
    },
};

export default captions;