Files
cocos4/cocos/core/load-pipeline/loader.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

440 lines
13 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
* @module loader
*/
import {mixin} from '../utils/js';
import {ImageAsset} from '../assets/image-asset';
import plistParser from './plist-parser';
import { Pipeline, IPipe } from './pipeline';
import {loadUuid} from './uuid-loader';
import {loadFont} from './font-loader';
import { legacyCC } from '../global-exports';
import { PixelFormat } from '../assets/asset-enum';
function loadNothing () {
return null;
}
function loadJSON (item) {
if (typeof item.content !== 'string') {
return new Error('JSON Loader: Input item doesn\'t contain string content');
}
try {
let result = JSON.parse(item.content);
return result;
}
catch (e) {
return new Error('JSON Loader: Parse json [' + item.id + '] failed : ' + e);
}
}
function loadImage (item) {
let loadByDeserializedAsset = (item._owner instanceof legacyCC.Asset);
if (loadByDeserializedAsset) {
// already has cc.Asset
return null;
}
let image = item.content;
if (legacyCC.sys.platform !== legacyCC.sys.FB_PLAYABLE_ADS && !(image instanceof Image)) {
return new Error('Image Loader: Input item doesn\'t contain Image content');
}
// load cc.ImageAsset
let rawUrl = item.rawUrl;
let imageAsset = item.imageAsset || new ImageAsset();
imageAsset._uuid = item.uuid;
imageAsset._url = rawUrl;
imageAsset._setRawAsset(rawUrl, false);
imageAsset._nativeAsset = image;
return imageAsset;
}
// If audio is loaded by url directly, than this loader will wrap it into a new cc.AudioClip object.
// If audio is loaded by deserialized AudioClip, than this loader will be skipped.
function loadAudioAsAsset (item, callback) {
let loadByDeserializedAsset = (item._owner instanceof legacyCC.Asset);
if (loadByDeserializedAsset) {
// already has cc.Asset
return null;
}
let audioClip = new legacyCC.AudioClip();
audioClip._setRawAsset(item.rawUrl, false);
audioClip._nativeAsset = item.content;
return audioClip;
}
function loadVideoAsAsset (item, callback) {
let loadByDeserializedAsset = (item._owner instanceof legacyCC.Asset);
if (loadByDeserializedAsset) {
// already has cc.Asset
return null;
}
let videoClip = new legacyCC.VideoClip();
videoClip._setRawAsset(item.rawUrl, false);
videoClip._nativeAsset = item.content;
return videoClip;
}
function loadPlist (item) {
if (typeof item.content !== 'string') {
return new Error('Plist Loader: Input item doesn\'t contain string content');
}
let result = plistParser.parse(item.content);
if (result) {
return result;
}
else {
return new Error('Plist Loader: Parse [' + item.id + '] failed');
}
}
function loadBinary (item) {
// Invoke custom handle
if (item.load) {
return item.load(item.content);
}
else {
return item.content;
}
}
//===============//
// PVR constants //
//===============//
// https://github.com/toji/texture-tester/blob/master/js/webgl-texture-util.js#L424
const PVR_HEADER_LENGTH = 13; // The header length in 32 bit ints.
const PVR_MAGIC = 0x03525650; //0x50565203;
// Offsets into the header array.
const PVR_HEADER_MAGIC = 0;
const PVR_HEADER_FORMAT = 2;
const PVR_HEADER_HEIGHT = 6;
const PVR_HEADER_WIDTH = 7;
const PVR_HEADER_MIPMAPCOUNT = 11;
const PVR_HEADER_METADATA = 12;
function loadPVRTex (item) {
let buffer = item.content instanceof ArrayBuffer ? item.content : item.content.buffer;
// Get a view of the arrayBuffer that represents the DDS header.
let header = new Int32Array(buffer, 0, PVR_HEADER_LENGTH);
// Do some sanity checks to make sure this is a valid DDS file.
if(header[PVR_HEADER_MAGIC] === PVR_MAGIC) {
// Gather other basic metrics and a view of the raw the DXT data.
let width = header[PVR_HEADER_WIDTH];
let height = header[PVR_HEADER_HEIGHT];
let dataOffset = header[PVR_HEADER_METADATA] + 52;
// todo: use new Uint8Array(buffer, dataOffset) instead
buffer = buffer.slice(dataOffset, buffer.byteLength);
let pvrtcData = new Uint8Array(buffer);
let pvrAsset = {
_data: pvrtcData,
_compressed: true,
width: width,
height: height,
};
return pvrAsset;
}
else if (header[11] === 0x21525650) {
let headerLength = header[0],
height = header[1],
width = header[2]
// todo: use new Uint8Array(buffer, headerLength) instead
buffer = buffer.slice(headerLength, buffer.byteLength);
let pvrtcData = new Uint8Array(buffer);
let pvrAsset = {
_data: pvrtcData,
_compressed: true,
width: width,
height: height,
};
return pvrAsset;
}
else {
return new Error("Invalid magic number in PVR header");
}
}
//===============//
// ETC constants //
//===============//
const ETC_PKM_HEADER_SIZE = 16;
const ETC_PKM_FORMAT_OFFSET = 6;
const ETC_PKM_ENCODED_WIDTH_OFFSET = 8;
const ETC_PKM_ENCODED_HEIGHT_OFFSET = 10;
const ETC_PKM_WIDTH_OFFSET = 12;
const ETC_PKM_HEIGHT_OFFSET = 14;
const ETC1_RGB_NO_MIPMAPS = 0;
const ETC2_RGB_NO_MIPMAPS = 1;
const ETC2_RGBA_NO_MIPMAPS = 3;
function readBEUint16(header, offset) {
return (header[offset] << 8) | header[offset+1];
}
function loadPKMTex(item) {
let buffer = item.content instanceof ArrayBuffer ? item.content : item.content.buffer;
let header = new Uint8Array(buffer);
let format = readBEUint16(header, ETC_PKM_FORMAT_OFFSET);
if (format !== ETC1_RGB_NO_MIPMAPS && format !== ETC2_RGB_NO_MIPMAPS && format !== ETC2_RGBA_NO_MIPMAPS) {
return new Error("Invalid magic number in ETC header");
}
let width = readBEUint16(header, ETC_PKM_WIDTH_OFFSET);
let height = readBEUint16(header, ETC_PKM_HEIGHT_OFFSET);
let encodedWidth = readBEUint16(header, ETC_PKM_ENCODED_WIDTH_OFFSET);
let encodedHeight = readBEUint16(header, ETC_PKM_ENCODED_HEIGHT_OFFSET);
// todo: use new Uint8Array(buffer, ETC_PKM_HEADER_SIZE) instead
buffer = buffer.slice(ETC_PKM_HEADER_SIZE, buffer.byteLength);
let etcData = new Uint8Array(buffer);
let etcAsset = {
_data: etcData,
_compressed: true,
width: width,
height: height
};
return etcAsset;
}
//===============//
// ASTC constants //
//===============//
// struct astc_header
// {
// uint8_t magic[4];
// uint8_t blockdim_x;
// uint8_t blockdim_y;
// uint8_t blockdim_z;
// uint8_t xsize[3]; // x-size = xsize[0] + xsize[1] + xsize[2]
// uint8_t ysize[3]; // x-size, y-size and z-size are given in texels;
// uint8_t zsize[3]; // block count is inferred
// };
const ASTC_MAGIC = 0x5CA1AB13;
const ASTC_HEADER_LENGTH = 16; // The header length
const ASTC_HEADER_MAGIC = 4;
const ASTC_HEADER_BLOCKDIM = 3;
const ASTC_HEADER_SIZE_X_BEGIN = 7;
const ASTC_HEADER_SIZE_Y_BEGIN = 10;
const ASTC_HEADER_SIZE_Z_BEGIN = 13;
function loadASTCTex (item) {
let buffer = item.content instanceof ArrayBuffer ? item.content : item.content.buffer;
const header = new Uint8Array(buffer);
const magicval = header[0] + (header[1] << 8) + (header[2] << 16) + (header[3] << 24);
if (magicval !== ASTC_MAGIC) {
return new Error('Invalid magic number in ASTC header');
}
const xdim = header[ASTC_HEADER_MAGIC];
const ydim = header[ASTC_HEADER_MAGIC + 1];
const zdim = header[ASTC_HEADER_MAGIC + 2];
if ((xdim < 3 || xdim > 6 || ydim < 3 || ydim > 6 || zdim < 3 || zdim > 6) &&
(xdim < 4 || xdim === 7 || xdim === 9 || xdim === 11 || xdim > 12 ||
ydim < 4 || ydim === 7 || ydim === 9 || ydim === 11 || ydim > 12 || zdim !== 1)) {
return new Error('Invalid block number in ASTC header');
}
const format = getASTCFormat(xdim,ydim);
const xsize = header[ASTC_HEADER_SIZE_X_BEGIN] + (header[ASTC_HEADER_SIZE_X_BEGIN + 1] << 8) + (header[ASTC_HEADER_SIZE_X_BEGIN + 2] << 16);
const ysize = header[ASTC_HEADER_SIZE_Y_BEGIN] + (header[ASTC_HEADER_SIZE_Y_BEGIN + 1] << 8) + (header[ASTC_HEADER_SIZE_Y_BEGIN + 2] << 16);
const zsize = header[ASTC_HEADER_SIZE_Z_BEGIN] + (header[ASTC_HEADER_SIZE_Z_BEGIN + 1] << 8) + (header[ASTC_HEADER_SIZE_Z_BEGIN + 2] << 16);
buffer = buffer.slice(ASTC_HEADER_LENGTH, buffer.byteLength);
const astcData = new Uint8Array(buffer);
const astcAsset = {
_data: astcData,
_compressed: true,
width: xsize,
height: ysize,
format: format
};
return astcAsset;
}
function getASTCFormat (xdim,ydim) {
if (xdim === 4) {
return PixelFormat.RGBA_ASTC_4x4;
} else if (xdim === 5) {
if (ydim === 4) {
return PixelFormat.RGBA_ASTC_5x4;
} else {
return PixelFormat.RGBA_ASTC_5x5;
}
} else if (xdim === 6) {
if (ydim === 5) {
return PixelFormat.RGBA_ASTC_6x5;
} else {
return PixelFormat.RGBA_ASTC_6x6;
}
} else if (xdim === 8) {
if (ydim === 5) {
return PixelFormat.RGBA_ASTC_8x5;
} else if (ydim === 6) {
return PixelFormat.RGBA_ASTC_8x6;
} else {
return PixelFormat.RGBA_ASTC_8x8;
}
} else if (xdim === 10) {
if (ydim === 5) {
return PixelFormat.RGBA_ASTC_10x5;
} else if (ydim === 6) {
return PixelFormat.RGBA_ASTC_10x6;
} else if (ydim === 8) {
return PixelFormat.RGBA_ASTC_10x8;
} else {
return PixelFormat.RGBA_ASTC_10x10;
}
} else {
if (ydim === 10) {
return PixelFormat.RGBA_ASTC_12x10;
} else {
return PixelFormat.RGBA_ASTC_12x12;
}
}
}
let defaultMap = {
// Images
'png' : loadImage,
'jpg' : loadImage,
'bmp' : loadImage,
'jpeg' : loadImage,
'gif' : loadImage,
'ico' : loadImage,
'tiff' : loadImage,
'webp' : loadImage,
'image' : loadImage,
'pvr' : loadPVRTex,
'pkm' : loadPKMTex,
'astc' : loadASTCTex,
// Audio
'mp3' : loadAudioAsAsset,
'ogg' : loadAudioAsAsset,
'wav' : loadAudioAsAsset,
'm4a' : loadAudioAsAsset,
// video
'mp4' : loadVideoAsAsset,
// json
'json' : loadJSON,
'ExportJson' : loadJSON,
// plist
'plist' : loadPlist,
// asset
'uuid' : loadUuid,
'prefab' : loadUuid,
'fire' : loadUuid,
'scene' : loadUuid,
// binary
'binary' : loadBinary,
'bin': loadBinary,
// Font
'font' : loadFont,
'eot' : loadFont,
'ttf' : loadFont,
'woff' : loadFont,
'svg' : loadFont,
'ttc' : loadFont,
'default' : loadNothing
};
let ID = 'Loader';
/**
* @en The loader pipe in {{loader}}, it can load several types of files:
* 1. Images
* 2. JSON
* 3. Plist
* 4. Audio
* 5. Font
* 6. Binary
* 7. Cocos Assets
* It will not interfere with items of unknown type.
* You can pass custom supported types in the {{loader.addLoadHandlers}}.
* @zh {{loader}} 中的解析加载管线,可以解析加载下列类型的资源:
* 1. Images
* 2. JSON
* 3. Plist
* 4. Audio
* 5. Font
* 6. Binary
* 7. Cocos Assets
* 所有未知类型不会被处理,也可以通过 {{loader.addLoadHandlers}} 来定制加载行为
*/
export default class Loader implements IPipe {
static ID = ID;
public id = ID;
public async = true;
public pipeline: Pipeline | null = null;
private extMap: object;
constructor (extMap?) {
this.extMap = mixin(extMap, defaultMap);
}
/**
* @en Add custom supported types handler or modify existing type handler.
* @zh 添加自定义支持的类型处理程序或修改现有的类型处理程序。
* @param extMap Custom supported types with corresponded handler
* @param extMap Custom supported types with corresponded handler
*/
addHandlers (extMap: Map<string, Function>) {
this.extMap = mixin(this.extMap, extMap);
}
handle (item, callback) {
let loadFunc = this.extMap[item.type] || this.extMap['default'];
return loadFunc.call(this, item, callback);
}
}
// @ts-ignore
Pipeline.Loader = Loader;