All files / dash.js/src/streaming/utils VTTParser.js

93.4% Statements 85/91
80.43% Branches 37/46
100% Functions 8/8
93.25% Lines 83/89

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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                                                                  1x     46x                   46x 46x 46x 46x 46x       3x       3x 1x     2x 2x 2x   2x 53x   53x 37x 13x 13x 13x 13x 13x 13x   13x 13x 13x   13x                               2x       26x 26x   26x   26x 26x     26x       13x 13x 13x 13x 13x 13x       13x 13x 13x   13x 13x   13x     3x 3x     5x 5x   5x 5x 3x   5x 3x   5x     5x 5x 5x 3x   5x                 13x             13x   13x 13x     13x 16x     13x 13x 3x 6x 6x 6x 6x 3x                 10x 10x 10x     13x     46x         46x 46x     1x    
/**
 * The copyright in this software is being made available under the BSD License,
 * included below. This software may be subject to other third party and contributor
 * rights, including patent rights, and no such rights are granted under this license.
 *
 * Copyright (c) 2013, Dash Industry Forum.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *  * Redistributions of source code must retain the above copyright notice, this
 *  list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation and/or
 *  other materials provided with the distribution.
 *  * Neither the name of Dash Industry Forum nor the names of its
 *  contributors may be used to endorse or promote products derived from this software
 *  without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS AS IS AND ANY
 *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */
import FactoryMaker from '../../core/FactoryMaker.js';
import Debug from '../../core/Debug.js';
 
const WEBVTT = 'WEBVTT';
 
function VTTParser() {
    const context = this.context;
 
    let instance,
        logger,
        regExNewLine,
        regExToken,
        regExWhiteSpace,
        regExWhiteSpaceWordBoundary;
 
    function setup() {
        logger = Debug(context).getInstance().getLogger(instance);
        regExNewLine = /(?:\r\n|\r|\n)/gm;
        regExToken = /-->/;
        regExWhiteSpace = /(^[\s]+|[\s]+$)/g;
        regExWhiteSpaceWordBoundary = /\s\b/g;
    }
 
    function parse(data) {
        const captionArray = [];
        let len,
            lastStartTime;
 
        if (!data) {
            return captionArray;
        }
 
        data = data.split(regExNewLine);
        len = data.length;
        lastStartTime = -1;
 
        for (let i = 0; i < len; i++) {
            let item = data[i];
 
            if (item.length > 0 && item !== WEBVTT) {
                if (item.match(regExToken)) {
                    const attributes = parseItemAttributes(item);
                    const cuePoints = attributes.cuePoints;
                    const styles = attributes.styles;
                    const text = getSublines(data, i + 1);
                    const startTime = convertCuePointTimes(cuePoints[0].replace(regExWhiteSpace, ''));
                    const endTime = convertCuePointTimes(cuePoints[1].replace(regExWhiteSpace, ''));
 
                    if ((!isNaN(startTime) && !isNaN(endTime)) && startTime >= lastStartTime && endTime > startTime) {
                        if (text !== '') {
                            lastStartTime = startTime;
                            //TODO Make VO external so other parsers can use.
                            captionArray.push({
                                start: startTime,
                                end: endTime,
                                data: text,
                                styles: styles
                            });
                        } else E{
                            logger.error('Skipping cue due to empty/malformed cue text');
                        }
                    } else E{
                        logger.error('Skipping cue due to incorrect cue timing');
                    }
                }
            }
        }
 
        return captionArray;
    }
 
    function convertCuePointTimes(time) {
        const timeArray = time.split(':');
        const len = timeArray.length - 1;
 
        time = parseInt(timeArray[len - 1], 10) * 60 + parseFloat(timeArray[len]);
 
        if (len === 2) {
            time += parseInt(timeArray[0], 10) * 3600;
        }
 
        return time;
    }
 
    function parseItemAttributes(data) {
        const vttCuePoints = data.split(regExToken);
        const arr = vttCuePoints[1].split(regExWhiteSpaceWordBoundary);
        arr.shift(); //remove first array index it is empty...
        vttCuePoints[1] = arr[0];
        arr.shift();
        return { cuePoints: vttCuePoints, styles: getCaptionStyles(arr) };
    }
 
    function getCaptionStyles(arr) {
        const styleObject = {};
        arr.forEach(function (element) {
            const parts = element.split(':');
 
            if (parts.length > 1) {
                const [settingName, settingValue] = parts;
 
                switch (settingName) {
                    case 'align':
                    case 'A':
                        styleObject.align = settingValue;
                        break;
                    case 'line':
                    case 'L':
                        const [line, lineAlign] = settingValue.split(',');
                        const isPercentage = line.endsWith('%');
 
                        styleObject.line = line === 'auto' ? line : parseInt(line, 10);
                        if (isPercentage) {
                            styleObject.snapToLines = false;
                        }
                        if (lineAlign) {
                            styleObject.lineAlign = lineAlign;
                        }
                        break;
                    case 'position':
                    case 'P':
                        const [position, positionAlign] = settingValue.split(',');
                        styleObject.position = parseInt(position, 10);
                        if (positionAlign) {
                            styleObject.positionAlign = positionAlign;
                        }
                        break;
                    case 'size':
                    case 'S':
                        styleObject.size = parseInt(settingValue, 10);
                        break;
                }
            }
        });
 
        return styleObject;
    }
 
    /*
    * VTT can have multiple lines to display per cuepoint.
    */
    function getSublines(data, idx) {
        let i = idx;
 
        let subline = '';
        let lineData = '';
        let lineCount;
 
        while (data[i] !== '' && i < data.length) {
            i++;
        }
 
        lineCount = i - idx;
        if (lineCount > 1) {
            for (let j = 0; j < lineCount; j++) {
                lineData = data[(idx + j)];
                if (!lineData.match(regExToken)) {
                    subline += lineData;
                    if (j !== lineCount - 1) {
                        subline += '\n';
                    }
                } else E{
                    // caption text should not have '-->' in it
                    subline = '';
                    break;
                }
            }
        } else {
            lineData = data[idx];
            if (!lineData.match(regExToken)) {
                subline = lineData;
            }
        }
        return subline;
    }
 
    instance = {
        parse: parse,
        getCaptionStyles
    };
 
    setup();
    return instance;
}
 
VTTParser.__dashjs_factory_name = 'VTTParser';
export default FactoryMaker.getSingletonFactory(VTTParser);