All files / dash.js/src/dash/utils TemplateSegmentsGetter.js

80.43% Statements 37/46
80.64% Branches 25/31
100% Functions 6/6
80.43% Lines 37/46

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                                                                          19x 19x         3x 3x       3x 3x 1x   2x     3x       23x 1x     22x 22x   22x 3x       22x   22x                     22x 2x     20x       12x       12x   12x 1x       11x   11x 11x 11x 11x             11x       33x         11x 11x                                         19x           19x     1x 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 {
    getIndexBasedSegment,
    getTotalNumberOfPartialSegments,
} from './SegmentsUtils.js';
 
function TemplateSegmentsGetter(config, isDynamic) {
    config = config || {};
    const timelineConverter = config.timelineConverter;
 
    let instance;
 
    function getMediaFinishedInformation(representation) {
        const mediaFinishedInformation = { numberOfSegments: 0, mediaTimeOfLastSignaledSegment: NaN }
        Iif (!representation) {
            return mediaFinishedInformation
        }
 
        const duration = representation.segmentDuration;
        if (isNaN(duration)) {
            mediaFinishedInformation.numberOfSegments = 1;
        } else {
            mediaFinishedInformation.numberOfSegments = Math.ceil(representation.adaptation.period.duration / duration);
        }
 
        return mediaFinishedInformation;
    }
 
    function getSegmentByIndex(representation, indexWithoutStartNumber, subNumberOfPartialSegmentToRequest) {
        if (!representation) {
            return null;
        }
 
        const template = _getSegmentTemplateElement(representation);
        const totalNumberOfPartialSegments = getTotalNumberOfPartialSegments(template);
 
        if (totalNumberOfPartialSegments !== undefined && totalNumberOfPartialSegments >= 0) {
            subNumberOfPartialSegmentToRequest = subNumberOfPartialSegmentToRequest !== undefined && subNumberOfPartialSegmentToRequest < totalNumberOfPartialSegments ? subNumberOfPartialSegmentToRequest : 0;
        }
 
        // This is the index without @startNumber
        indexWithoutStartNumber = Math.max(indexWithoutStartNumber, 0);
 
        const seg = getIndexBasedSegment({
            index: indexWithoutStartNumber,
            isDynamic,
            mediaTime: Math.round(indexWithoutStartNumber * representation.segmentDuration * representation.timescale, 10),
            mediaUrl: template.media,
            representation,
            subNumberOfPartialSegmentToRequest,
            timelineConverter,
            totalNumberOfPartialSegments,
        });
 
        if (seg && representation.endNumber && seg.replacementNumber > representation.endNumber) {
            return null;
        }
 
        return seg;
    }
 
    function getSegmentByTime(representation, requestedTime) {
        Iif (!representation) {
            return null;
        }
 
        const duration = representation.segmentDuration;
 
        if (isNaN(duration)) {
            return null;
        }
 
        // Calculate the relative time for the requested time in this period
        let requestedTimeRelativeToPeriodStart = timelineConverter.calcPeriodRelativeTimeFromMpdRelativeTime(representation, requestedTime);
 
        const template = _getSegmentTemplateElement(representation);
        const indexWithoutStartNumber = Math.floor(requestedTimeRelativeToPeriodStart / duration);
        const totalNumberOfPartialSegments = getTotalNumberOfPartialSegments(template);
        const subNumberOfPartialSegmentToRequest = _getSubNumberOfPartialSegmentToRequestByTime({
            totalNumberOfPartialSegments,
            representation,
            requestedTimeRelativeToPeriodStart,
            indexWithoutStartNumber
        })
 
        return getSegmentByIndex(representation, indexWithoutStartNumber, subNumberOfPartialSegmentToRequest);
    }
 
    function _getSegmentTemplateElement(representation) {
        return representation.adaptation.period.mpd.manifest.Period[representation.adaptation.period.index].AdaptationSet[representation.adaptation.index].Representation[representation.index].SegmentTemplate;
 
    }
 
    function _getSubNumberOfPartialSegmentToRequestByTime(data) {
        if (!data || data.totalNumberOfPartialSegments === undefined || isNaN(data.totalNumberOfPartialSegments) || data.totalNumberOfPartialSegments < 1) {
            return undefined;
        }
        const {
            totalNumberOfPartialSegments,
            representation,
            requestedTimeRelativeToPeriodStart,
            indexWithoutStartNumber
        } = data;
 
        const startTimeOfSegment = indexWithoutStartNumber * representation.segmentDuration;
        const partialSegmentDuration = representation.segmentDuration / totalNumberOfPartialSegments;
 
        const offset = requestedTimeRelativeToPeriodStart - startTimeOfSegment;
        let subNumberOfPartialSegmentToRequest = Math.floor(offset / partialSegmentDuration);
 
        subNumberOfPartialSegmentToRequest = Math.max(0, Math.min(subNumberOfPartialSegmentToRequest, totalNumberOfPartialSegments - 1));
 
        return subNumberOfPartialSegmentToRequest;
    }
 
 
    instance = {
        getMediaFinishedInformation,
        getSegmentByIndex,
        getSegmentByTime,
    };
 
    return instance;
}
 
TemplateSegmentsGetter.__dashjs_factory_name = 'TemplateSegmentsGetter';
const factory = FactoryMaker.getClassFactory(TemplateSegmentsGetter);
export default factory;