文档管理中心
您当前浏览的HarmonyOS 5.0.0(API 12)文档归档不再维护,推荐您使用最新版本。详细请参考文档维护策略变更
指南媒体Image Kit(图片处理服务)图片开发指导(ArkTS)使用ImageSource完成图片解码

使用ImageSource完成图片解码

图片解码指将所支持格式的存档图片解码成统一的PixelMap,以便在应用或系统中进行图片显示或图片处理。当前支持的存档图片格式包括JPEG、PNG、GIF、WebP、BMP、SVG、ICO、DNG、HEIF(不同硬件设备支持情况不同)。

开发步骤

图片解码相关API的详细介绍请参见:图片解码接口说明

  1. 全局导入Image模块。

    收起
    自动换行
    深色代码主题
    复制
    1. import { image } from '@kit.ImageKit';
  2. 获取图片。

    • 方法一:获取沙箱路径。具体请参考获取应用文件路径。应用沙箱的介绍及如何向应用沙箱推送文件,请参考文件管理

      收起
      自动换行
      深色代码主题
      复制
      1. const context : Context = getContext(this);
      2. const filePath : string = context.cacheDir + '/test.jpg';
    • 方法二:通过沙箱路径获取图片的文件描述符。具体请参考file.fs API参考文档

      该方法需要先导入@kit.CoreFileKit模块。

      收起
      自动换行
      深色代码主题
      复制
      1. import { fileIo as fs } from '@kit.CoreFileKit';

      然后调用fs.openSync()获取文件描述符。

      收起
      自动换行
      深色代码主题
      复制
      1. const context = getContext(this);
      2. const filePath = context.cacheDir + '/test.jpg';
      3. const file : fs.File = fs.openSync(filePath, fs.OpenMode.READ_WRITE);
      4. const fd : number = file?.fd;
    • 方法三:通过资源管理器获取资源文件的ArrayBuffer。具体请参考ResourceManager API参考文档

      收起
      自动换行
      深色代码主题
      复制
      1. // 导入resourceManager资源管理器
      2. import { resourceManager } from '@kit.LocalizationKit';
      3. const context : Context = getContext(this);
      4. // 获取resourceManager资源管理器
      5. const resourceMgr : resourceManager.ResourceManager = context.resourceManager;

      不同模型获取资源管理器的方式不同,获取资源管理器后,再调用resourceMgr.getRawFileContent()获取资源文件的ArrayBuffer。

      收起
      自动换行
      深色代码主题
      复制
      1. resourceMgr.getRawFileContent('test.jpg').then((fileData : Uint8Array) => {
      2. console.log("Succeeded in getting RawFileContent")
      3. // 获取图片的ArrayBuffer
      4. const buffer = fileData.buffer.slice(0);
      5. }).catch((err : BusinessError) => {
      6. console.error("Failed to get RawFileContent")
      7. });
    • 方法四:通过资源管理器获取资源文件的RawFileDescriptor。具体请参考ResourceManager API参考文档

      收起
      自动换行
      深色代码主题
      复制
      1. // 导入resourceManager资源管理器
      2. import { resourceManager } from '@kit.LocalizationKit';
      3. const context : Context = getContext(this);
      4. // 获取resourceManager资源管理器
      5. const resourceMgr : resourceManager.ResourceManager = context.resourceManager;

      不同模型获取资源管理器的方式不同,获取资源管理器后,再调用resourceMgr.getRawFd()获取资源文件的RawFileDescriptor。

      收起
      自动换行
      深色代码主题
      复制
      1. resourceMgr.getRawFd('test.jpg').then((rawFileDescriptor : resourceManager.RawFileDescriptor) => {
      2. console.log("Succeeded in getting RawFileDescriptor")
      3. }).catch((err : BusinessError) => {
      4. console.error("Failed to get RawFileDescriptor")
      5. });
  3. 创建ImageSource实例。

    • 方法一:通过沙箱路径创建ImageSource。沙箱路径可以通过步骤2的方法一获取。

      收起
      自动换行
      深色代码主题
      复制
      1. // path为已获得的沙箱路径
      2. const imageSource : image.ImageSource = image.createImageSource(filePath);
    • 方法二:通过文件描述符fd创建ImageSource。文件描述符可以通过步骤2的方法二获取。

      收起
      自动换行
      深色代码主题
      复制
      1. // fd为已获得的文件描述符
      2. const imageSource : image.ImageSource = image.createImageSource(fd);
    • 方法三:通过缓冲区数组创建ImageSource。缓冲区数组可以通过步骤2的方法三获取。

      收起
      自动换行
      深色代码主题
      复制
      1. const imageSource : image.ImageSource = image.createImageSource(buffer);
    • 方法四:通过资源文件的RawFileDescriptor创建ImageSource。RawFileDescriptor可以通过步骤2的方法四获取。

      收起
      自动换行
      深色代码主题
      复制
      1. const imageSource : image.ImageSource = image.createImageSource(rawFileDescriptor);
  4. 设置解码参数DecodingOptions,解码获取pixelMap图片对象。

    • 设置期望的format进行解码:
      收起
      自动换行
      深色代码主题
      复制
      1. import { BusinessError } from '@kit.BasicServicesKit';
      2. import { image } from '@kit.ImageKit';
      3. let img = await getContext(this).resourceManager.getMediaContent($r('app.media.image'));
      4. let imageSource:image.ImageSource = image.createImageSource(img.buffer.slice(0));
      5. let decodingOptions : image.DecodingOptions = {
      6. editable: true,
      7. desiredPixelFormat: 3,
      8. }
      9. // 创建pixelMap
      10. imageSource.createPixelMap(decodingOptions).then((pixelMap : image.PixelMap) => {
      11. console.log("Succeeded in creating PixelMap")
      12. }).catch((err : BusinessError) => {
      13. console.error("Failed to create PixelMap")
      14. });
    • HDR图片解码
      收起
      自动换行
      深色代码主题
      复制
      1. import { BusinessError } from '@kit.BasicServicesKit';
      2. import { image } from '@kit.ImageKit';
      3. let img = await getContext(this).resourceManager.getMediaContent($r('app.media.CUVAHdr'));
      4. let imageSource:image.ImageSource = image.createImageSource(img.buffer.slice(0));
      5. let decodingOptions : image.DecodingOptions = {
      6. //设置为AUTO会根据图片资源格式解码,如果图片资源为HDR资源则会解码为HDR的pixelmap。
      7. desiredDynamicRange: image.DecodingDynamicRange.AUTO,
      8. }
      9. // 创建pixelMap
      10. imageSource.createPixelMap(decodingOptions).then((pixelMap : image.PixelMap) => {
      11. console.log("Succeeded in creating PixelMap")
      12. // 判断pixelmap是否为hdr内容
      13. let info = pixelMap.getImageInfoSync();
      14. console.log("pixelmap isHdr:" + info.isHdr);
      15. }).catch((err : BusinessError) => {
      16. console.error("Failed to create PixelMap")
      17. });

    解码完成,获取到pixelMap对象后,可以进行后续图片处理

  5. 释放pixelMap和imageSource。

    需确认pixelMap和imageSource异步方法已经执行完成,不再使用该变量后可按需手动调用下面方法释放。

    收起
    自动换行
    深色代码主题
    复制
    1. pixelMap.release();
    2. imageSource.release();

开发示例-对资源文件中的图片进行解码

  1. 获取resourceManager资源管理。

    收起
    自动换行
    深色代码主题
    复制
    1. // 导入resourceManager资源管理器
    2. import { resourceManager } from '@kit.LocalizationKit';
    3. const context : Context = getContext(this);
    4. // 获取resourceManager资源管理
    5. const resourceMgr : resourceManager.ResourceManager = context.resourceManager;
  2. 创建ImageSource。

    • 方式一:通过rawfile文件夹下test.jpg的ArrayBuffer创建。

      收起
      自动换行
      深色代码主题
      复制
      1. import { BusinessError } from '@kit.BasicServicesKit';
      2. resourceMgr.getRawFileContent('test.jpg').then((fileData : Uint8Array) => {
      3. console.log("Succeeded in getting RawFileContent")
      4. // 获取图片的ArrayBuffer
      5. const buffer = fileData.buffer.slice(0);
      6. const imageSource : image.ImageSource = image.createImageSource(buffer);
      7. }).catch((err : BusinessError) => {
      8. console.error("Failed to get RawFileContent")
      9. });
    • 方式二:通过rawfile文件夹下test.jpg的RawFileDescriptor创建。

      收起
      自动换行
      深色代码主题
      复制
      1. import { BusinessError } from '@kit.BasicServicesKit';
      2. resourceMgr.getRawFd('test.jpg').then((rawFileDescriptor : resourceManager.RawFileDescriptor) => {
      3. console.log("Succeeded in getting RawFd")
      4. const imageSource : image.ImageSource = image.createImageSource(rawFileDescriptor);
      5. }).catch((err : BusinessError) => {
      6. console.error("Failed to get RawFd")
      7. });
  3. 创建pixelMap。

    收起
    自动换行
    深色代码主题
    复制
    1. imageSource.createPixelMap().then((pixelMap: image.PixelMap) => {
    2. console.log("Succeeded in creating PixelMap")
    3. }).catch((err : BusinessError) => {
    4. console.error("Failed to creating PixelMap")
    5. });
  4. 释放pixelMap和imageSource。

    需确认pixelMap和imageSource异步方法已经执行完成,不再使用该变量后可按需手动调用下面方法释放。

    收起
    自动换行
    深色代码主题
    复制
    1. pixelMap.release();
    2. imageSource.release();

示例代码

在 指南 中进行搜索
请输入您想要搜索的关键词