使用ImageSource完成图片解码
将所支持格式的图片文件解码成PixelMap,以便在应用或系统中显示或处理图片。当前支持的图片文件格式包括JPEG、PNG、GIF、WebP、BMP、SVG、ICO、DNG、HEIF。不同硬件设备的支持情况可能不同 。
开发步骤
图片解码相关API的详细介绍请参见:图片解码接口说明。
-
全局导入Image模块。
import { image } from '@kit.ImageKit'; -
获取图片。
-
方法一:通过沙箱路径直接获取。该方法仅适用于应用沙箱中的图片。更多细节请参考获取应用文件路径。应用沙箱的介绍及如何向应用沙箱推送文件,请参考文件管理。
function getFilePath(context: Context): string { const filePath: string = context.cacheDir + '/test.jpg'; return filePath; } -
方法二:通过沙箱路径获取图片的文件描述符。具体请参考file.fs API参考文档。该方法需要导入@kit.CoreFileKit模块。
import { fileIo as fs } from '@kit.CoreFileKit'; function getFileFd(context: Context): number | undefined { const filePath: string = context.cacheDir + '/test.jpg'; const file: fs.File = fs.openSync(filePath, fs.OpenMode.READ_WRITE); const fd: number = file?.fd; return fd; } -
方法三:通过资源管理器获取资源文件的ArrayBuffer。具体请参考资源管理器API参考文档。该方法需要导入@kit.LocalizationKit模块。
import { resourceManager } from '@kit.LocalizationKit'; async function getFileBuffer(context: Context): Promise<ArrayBuffer | undefined> { try { const resourceMgr: resourceManager.ResourceManager = context.resourceManager; // 获取资源文件内容,返回Uint8Array。 const fileData: Uint8Array = await resourceMgr.getRawFileContent('test.jpg'); console.info('Successfully got RawFileContent'); // 转为ArrayBuffer并返回。 const buffer: ArrayBuffer = fileData.buffer.slice(0); return buffer; } catch (error) { console.error("Failed to get RawFileContent"); return undefined; } } -
方法四:通过资源管理器获取资源文件的RawFileDescriptor。具体请参考资源管理器API参考文档。该方法需要导入@kit.LocalizationKit模块。
import { resourceManager } from '@kit.LocalizationKit'; async function getRawFd(context: Context): Promise<resourceManager.RawFileDescriptor | undefined> { try { const resourceMgr: resourceManager.ResourceManager = context.resourceManager; const rawFileDescriptor: resourceManager.RawFileDescriptor = await resourceMgr.getRawFd('test.jpg'); console.info('Successfully got RawFileDescriptor'); return rawFileDescriptor; } catch (error) { console.error('Failed to get RawFileDescriptor:'); return undefined; } }
-
-
创建ImageSource实例。
-
方法一:通过沙箱路径创建ImageSource。沙箱路径可以通过步骤2的方法一获取。
// path为已获得的沙箱路径。 const imageSource : image.ImageSource = image.createImageSource(filePath); -
方法二:通过文件描述符fd创建ImageSource。文件描述符可以通过步骤2的方法二获取。
// fd为已获得的文件描述符。 const imageSource : image.ImageSource = image.createImageSource(fd); -
方法三:通过缓冲区数组创建ImageSource。缓冲区数组可以通过步骤2的方法三获取。
const imageSource : image.ImageSource = image.createImageSource(buffer); -
方法四:通过资源文件的RawFileDescriptor创建ImageSource。RawFileDescriptor可以通过步骤2的方法四获取。
const imageSource : image.ImageSource = image.createImageSource(rawFileDescriptor);
-
-
设置解码参数DecodingOptions,解码获取pixelMap图片对象。
- 设置期望的format进行解码:
import { BusinessError } from '@kit.BasicServicesKit'; import { image } from '@kit.ImageKit'; // 创建ImageSource,请选择3中合适的方法替换。 let fd : number = 0; let imageSource : image.ImageSource = image.createImageSource(fd); // 配置解码选项参数。 let decodingOptions : image.DecodingOptions = { editable: true, desiredPixelFormat: image.PixelMapFormat.RGBA_8888, }; // 创建pixelMap。 imageSource.createPixelMap(decodingOptions).then((pixelMap : image.PixelMap) => { console.info("Succeeded in creating PixelMap"); }).catch((err : BusinessError) => { console.error("Failed to create PixelMap"); }); - HDR图片解码
import { BusinessError } from '@kit.BasicServicesKit'; import { image } from '@kit.ImageKit'; // 创建ImageSource,请选择3中合适的方法替换。 let fd : number = 0; let imageSource : image.ImageSource = image.createImageSource(fd); // 配置解码选项参数。 let decodingOptions : image.DecodingOptions = { //设置为AUTO会根据图片资源格式解码,如果图片资源为HDR资源则会解码为HDR的pixelmap。 desiredDynamicRange: image.DecodingDynamicRange.AUTO, }; // 创建pixelMap。 imageSource.createPixelMap(decodingOptions).then((pixelMap : image.PixelMap) => { console.info("Succeeded in creating PixelMap"); // 判断pixelmap是否为hdr内容。 let info = pixelMap.getImageInfoSync(); console.info("pixelmap isHdr:" + info.isHdr); }).catch((err : BusinessError) => { console.error("Failed to create PixelMap"); });
解码完成,获取到pixelMap对象后,可以进行后续图片处理。
- 设置期望的format进行解码:
-
释放pixelMap和imageSource。
需确认pixelMap和imageSource异步方法已经执行完成,不再使用该变量后可按需手动调用下面方法释放。
pixelMap.release(); imageSource.release();
相关实例
针对图片解码开发,有以下相关实例可供参考: