All files / dash.js/src/streaming/utils/baseUrlResolution DVBSelector.js

100% Statements 40/40
96.15% Branches 25/26
100% Functions 10/10
100% Lines 40/40

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                                                                    57x     57x     11x   11x 22x 10x   5x       17x     11x 38x       16x 11x           16x     22x     11x       11x 10x 10x     11x 17x           11x 11x 11x             11x   11x 7x               2x 5x 5x       2x     2x 4x   4x 2x     2x       7x         12x             57x       57x     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';
 
function DVBSelector(config) {
 
    config = config || {};
    let instance;
 
    const blacklistController = config.blacklistController;
 
    function getNonBlacklistedBaseUrls(urls) {
        let removedPriorities = [];
 
        const samePrioritiesFilter = function (el) {
            if (removedPriorities.length) {
                if ((el.dvbPriority) &&
                        (removedPriorities.indexOf(el.dvbPriority) !== -1)) {
                    return false;
                }
            }
 
            return true;
        };
 
        const serviceLocationFilter = function (baseUrl) {
            if (blacklistController.contains(baseUrl.serviceLocation)) {
                // whenever a BaseURL is removed from the available list of
                // BaseURLs, any other BaseURL with the same @priority
                // value as the BaseURL being removed shall also be removed
                if (baseUrl.dvbPriority) {
                    removedPriorities.push(baseUrl.dvbPriority);
                }
 
                // all URLs in the list which have a @serviceLocation
                // attribute matching an entry in the blacklist shall be
                // removed from the available list of BaseURLs
                return false;
            }
 
            return true;
        };
 
        return urls.filter(serviceLocationFilter).filter(samePrioritiesFilter);
    }
 
    function selectByWeight(availableUrls) {
        const prioritySorter = function (a, b) {
            let diff = a.dvbPriority - b.dvbPriority;
            return isNaN(diff) ? 0 : diff;
        };
 
        const topPriorityFilter = function (baseUrl, idx, arr) {
            return !idx || (
                (arr[0].dvbPriority && baseUrl.dvbPriority) &&
                (arr[0].dvbPriority === baseUrl.dvbPriority)
            );
        };
 
        let totalWeight = 0;
        let cumulWeights = [];
        let idx = 0;
        let rn,
            urls;
 
        // It shall begin by taking the set of resolved BaseURLs present or inherited at the current
        // position in the MPD, resolved and filtered as described in 10.8.2.1, that have the lowest
        // @priority attribute value.
        urls = availableUrls.sort(prioritySorter).filter(topPriorityFilter);
 
        if (urls.length) {
            if (urls.length > 1) {
                // If there is more than one BaseURL with this lowest @priority attribute value then the Player
                // shall select one of them at random such that the probability of each BaseURL being chosen
                // is proportional to the value of its @weight attribute. The method described in RFC 2782
                // [26] or picking from a number of weighted entries is suitable for this, but there may be other
                // algorithms which achieve the same effect.
 
                // add all the weights together, storing the accumulated weight per entry
                urls.forEach(baseUrl => {
                    totalWeight += baseUrl.dvbWeight;
                    cumulWeights.push(totalWeight);
                });
 
                // pick a random number between zero and totalWeight
                rn = Math.floor(Math.random() * (totalWeight - 1));
 
                // select the index for the range rn falls within
                cumulWeights.every((limit, index) => {
                    idx = index;
 
                    if (rn < limit) {
                        return false;
                    }
 
                    return true;
                });
            }
 
            return urls[idx];
        }
    }
 
    function select(baseUrls) {
        return baseUrls && selectByWeight(
            getNonBlacklistedBaseUrls(
                baseUrls
            )
        );
    }
 
    instance = {
        select: select
    };
 
    return instance;
}
 
DVBSelector.__dashjs_factory_name = 'DVBSelector';
export default FactoryMaker.getClassFactory(DVBSelector);