使用ImageSource完成多图对象解码

将所支持格式的图片文件解码成Picture。当前支持的图片文件格式包括JPEG、HEIF。

开发步骤

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

  1. 全局导入Image模块。

    // 导入相关模块包。
    import { image } from '@kit.ImageKit';
    import { BusinessError } from '@kit.BasicServicesKit';
    import { common } from '@kit.AbilityKit';
    import { fileIo as fs } from '@kit.CoreFileKit';
    import { resourceManager } from '@kit.LocalizationKit';
    
  2. 获取图片。

    • 方法一:通过沙箱路径直接获取。该方法仅适用于应用沙箱中的图片。更多细节请参考获取应用文件路径。应用沙箱的介绍及如何向应用沙箱推送文件,请参考文件管理

      function getFilePath(context: Context, fileName: string): string {
        const filePath: string = context.cacheDir + '/' + fileName;
        return filePath;
      }
      
    • 方法二:通过沙箱路径获取图片的文件描述符。具体请参考file.fs API参考文档。该方法需要导入@kit.CoreFileKit模块。

      function getFileFd(context: Context, fileName: string): number | undefined {
        const filePath: string = context.cacheDir + '/' + fileName;
        const file: fs.File = fs.openSync(filePath, fs.OpenMode.READ_ONLY);
        const fd: number = file?.fd;
        return fd;
      }
      
    • 方法三:通过资源管理器获取资源文件的ArrayBuffer。具体请参考资源管理器API参考文档。该方法需要导入@kit.LocalizationKit模块。

      async function getFileBuffer(context: Context, fileName: string): Promise<ArrayBuffer | undefined> {
        try {
          const resourceMgr: resourceManager.ResourceManager = context.resourceManager;
          // 获取资源文件内容,返回Uint8Array。
          const fileData: Uint8Array = await resourceMgr.getRawFileContent(fileName);
          console.info('Successfully get the RawFileContent.');
          // 转为ArrayBuffer并返回。
          const buffer: ArrayBuffer = fileData.buffer.slice(0);
          return buffer;
        } catch (error) {
          console.error(`Failed to get the RawFileContent with error: ${error}.`);
          return undefined;
        }
      }
      
    • 方法四:通过资源管理器获取资源文件的RawFileDescriptor。具体请参考资源管理器API参考文档。该方法需要导入@kit.LocalizationKit模块。

      async function getRawFd(context: Context, fileName: string): Promise<resourceManager.RawFileDescriptor | undefined> {
        try {
          const resourceMgr: resourceManager.ResourceManager = context.resourceManager;
          const rawFileDescriptor: resourceManager.RawFileDescriptor = await resourceMgr.getRawFd(fileName);
          console.info('Successfully get the RawFileDescriptor.');
          return rawFileDescriptor;
        } catch (error) {
          console.error(`Failed to get the RawFileDescriptor with error: ${error}.`);
          return undefined;
        }
      }
      
  3. 创建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);
      
  4. 设置解码参数DecodingOptions,解码获取picture多图对象。并对picture进行操作,如获取辅助图等。对于picture和辅助图的操作具体请参考Image API参考文档

    配置解码选项参数进行解码:

    async createPicture(imageSource : image.ImageSource | undefined, isReturnAux: Boolean)
      : Promise<image.PixelMap | undefined | image.Picture> {
      // 配置解码选项参数。
      let options: image.DecodingOptionsForPicture = {
        desiredAuxiliaryPictures: [image.AuxiliaryPictureType.GAINMAP] // GAINMAP为需要解码的辅助图类型。
      };
      let returnPixelMap: image.PixelMap | undefined = undefined;
      // 创建picture。
      try {
        let picture = await imageSource?.createPicture(options);
        if (picture) {
          // 返回解码后获取到的辅助图
          if (isReturnAux) {
            // type为解码参数中包含的辅助图类型
            let type: image.AuxiliaryPictureType = image.AuxiliaryPictureType.GAINMAP;
            let auxPicture: image.AuxiliaryPicture | null = picture.getAuxiliaryPicture(type);
            // 获取辅助图信息。
            if (auxPicture != null) {
              let auxInfo: image.AuxiliaryPictureInfo = auxPicture.getAuxiliaryPictureInfo();
              console.info('GetAuxiliaryPictureInfo type: ' + auxInfo.auxiliaryPictureType +
                ' height: ' + auxInfo.size.height + ' width: ' + auxInfo.size.width +
                ' rowStride: ' + auxInfo.rowStride + ' pixelFormat: ' + auxInfo.pixelFormat +
                ' colorSpace: ' + auxInfo.colorSpace);
              // 将辅助图数据读到ArrayBuffer。
              try {
                let pixelsBuffer = await auxPicture.readPixelsToBuffer();
                let opts: image.InitializationOptions = { size: auxInfo.size };
                try {
                  returnPixelMap = image.createPixelMapSync(pixelsBuffer, opts) as image.PixelMap;
                  console.info(`Create PixelMap with buffer successfully.`);
                } catch (error) {
                  console.error(`Create PixelMap failed with ${error}.`);
                }
              } catch (error) {
                console.error(`Read pixels to buffer failed, error.code: ${error.code},
                  error.message: ${error.message}`);
              }
              auxPicture.release();
            }
            return returnPixelMap;
          } else {
            return picture; // 返回解码后获取到的picture
          }
        }
        return returnPixelMap;
      } catch (error) {
        console.error(`Create picture failed: ${error}.`);
      }
      return returnPixelMap;
    }
    
  5. 释放picture。

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

    async release(picture: image.Picture) {
      picture?.release();
    }