Files
cocos4/cocos/core/load-pipeline/pack-downloader.ts
T
Jare Guo 0319477911 fix decorator warning of ValueTypes (#7553)
* fix decorator warning of ValueTypes (sync #6285)

* refresh copyright
2020-10-21 16:31:41 +08:00

224 lines
7.4 KiB
TypeScript

/*
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2020 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/**
* @packageDocumentation
* @hidden
*/
import {pushToMap} from '../utils/misc';
import {TextureUnpacker, JsonUnpacker} from './unpackers';
import { decompressJson } from './utils';
import { errorID } from '../platform/debug';
import { js } from '../utils';
import { Texture2D } from '../assets/texture-2d';
import { DEBUG, TEST } from 'internal:constants';
import { legacyCC } from '../global-exports';
// when more than one package contains the required asset,
// choose to load from the package with the largest state value.
enum PackState {
Invalid,
Removed,
Downloading,
Loaded,
};
class UnpackerData {
public unpacker;
public state;
constructor () {
this.unpacker = null;
this.state = PackState.Invalid;
}
}
// {assetUuid: packUuid|[packUuid]}
// If value is array of packUuid, then the first one will be prioritized for download,
// so the smallest pack must be at the beginning of the array.
let uuidToPack = {};
// {packUuid: assetIndices}
let packIndices = {};
// {packUuid: UnpackerData}
// We have to cache all packs in global because for now there's no operation context in loader.
let globalUnpackers = {};
function error (uuid, packUuid) {
return new Error('Can not retrieve ' + uuid + ' from packer ' + packUuid);
}
export function initPacks (packs) {
packIndices = packs;
for (var packUuid in packs) {
var uuids = packs[packUuid];
for (var i = 0; i < uuids.length; i++) {
var uuid = uuids[i];
// the smallest pack must be at the beginning of the array to download more first
var pushFront = uuids.length === 1;
pushToMap(uuidToPack, uuid, packUuid, pushFront);
}
}
}
export function _loadNewPack (uuid, packUuid, callback) {
var packUrl = legacyCC.AssetLibrary.getLibUrlNoExt(packUuid) + '.json';
legacyCC.loader.load({ url: packUrl, ignoreMaxConcurrency: true }, function (err, packJson) {
if (err) {
errorID(4916, uuid);
return callback(err);
}
var res = _doLoadNewPack(uuid, packUuid, packJson);
if (res) {
callback(null, res);
}
else {
callback(error(uuid, packUuid));
}
});
}
export function _doPreload (packUuid, packJson) {
var unpackerData = globalUnpackers[packUuid];
if (!unpackerData) {
unpackerData = globalUnpackers[packUuid] = new UnpackerData();
unpackerData.state = PackState.Downloading;
}
if (unpackerData.state !== PackState.Loaded) {
unpackerData.unpacker = new JsonUnpacker();
unpackerData.unpacker.load(packIndices[packUuid], packJson);
unpackerData.state = PackState.Loaded;
}
}
export function _doLoadNewPack (uuid, packUuid, packedJson) {
var unpackerData = globalUnpackers[packUuid];
// double check cache after load
if (unpackerData.state !== PackState.Loaded) {
// init unpacker
if (typeof packedJson === 'string') {
packedJson = JSON.parse(packedJson);
}
if (!DEBUG && packedJson.keys && packedJson.data) {
var keys = packedJson.keys;
packedJson = packedJson.data;
decompressJson(packedJson, keys);
}
if (Array.isArray(packedJson)) {
unpackerData.unpacker = new JsonUnpacker();
}
else if (packedJson.type === js._getClassId(Texture2D)) {
unpackerData.unpacker = new TextureUnpacker();
}
unpackerData.unpacker.load(packIndices[packUuid], packedJson);
unpackerData.state = PackState.Loaded;
}
return unpackerData.unpacker.retrieve(uuid);
}
export function _selectLoadedPack (packUuids) {
var existsPackState = PackState.Invalid;
var existsPackUuid = '';
for (var i = 0; i < packUuids.length; i++) {
var packUuid = packUuids[i];
var unpackerData = globalUnpackers[packUuid];
if (unpackerData) {
var state = unpackerData.state;
if (state === PackState.Loaded) {
return packUuid;
}
else if (state > existsPackState) { // load from the package with the largest state value,
existsPackState = state;
existsPackUuid = packUuid;
}
}
}
// otherwise the first one (smallest one) will be load
return existsPackState !== PackState.Invalid ? existsPackUuid : packUuids[0];
}
/**
* @returns {Object} When returns undefined, the requested item is not in any pack, when returns null, the item is in a loading pack, when item json exists, it will return the result directly.
*/
export function load (item, callback) {
var uuid = item.uuid;
var packUuid = uuidToPack[uuid];
if (!packUuid) {
// Return undefined to let caller know it's not recognized.
// We don't use false here because changing return value type may cause jit fail,
// though return undefined may have the same issue.
return;
}
if (Array.isArray(packUuid)) {
packUuid = _selectLoadedPack(packUuid);
}
var unpackerData = globalUnpackers[packUuid];
if (unpackerData && unpackerData.state === PackState.Loaded) {
// ensure async
var json = unpackerData.unpacker.retrieve(uuid);
if (json) {
return json;
}
else {
return error(uuid, packUuid);
}
}
else {
if (!unpackerData) {
if (!TEST) {
console.log('Create unpacker %s for %s', packUuid, uuid);
}
unpackerData = globalUnpackers[packUuid] = new UnpackerData();
unpackerData.state = PackState.Downloading;
}
_loadNewPack(uuid, packUuid, callback);
}
// Return null to let caller know it's loading asynchronously
return null;
}
if (TEST) {
legacyCC._Test.PackDownloader = {
initPacks,
_loadNewPack,
_doPreload,
_doLoadNewPack,
_selectLoadedPack,
load,
reset () {
uuidToPack = {};
packIndices = {};
globalUnpackers = {};
}
}
}