558f738c创建于 2025年11月11日历史提交

图片编码

说明：

当前开发指导使用的接口为Image模块下的C API，可完成图片编解码，图片接收器，处理图像数据等功能。这部分API在API version 11之前发布，在后续的版本不再增加新功能，不再推荐使用。
开发者可使用Image_NativeModule模块下的C API，不仅提供上述图片框架基础功能，还可以完成多图编解码等新特性，相关开发指导请参考图片开发指导(C/C++)节点下的内容。这部分API从API version 12开始支持，并将持续演进，推荐开发者使用。
两套C API不建议同时使用，在部分场景下存在不兼容的问题。

开发者可以调用本模块的Native API接口，完成图片编码，即将PixelMap压缩成不同格式的图片文件。

当前支持编码为JPEG、WebP、PNG和 HEIF（不同硬件设备支持情况不同）格式。

适用场景

图片编码转换。

通过传入ImageSource，封装成想要的格式。
图片编辑。

编辑PixelMap后导出图片文件的场景，需要编码成对应图片格式文件。

开发指导

详细的API说明请参考ImagePacker API参考。

参考以下示例代码，完成图片编码的全流程，包括：创建编码器、初始化资源、编码过程、销毁资源。

在应用开发过程中，开发者应按一定顺序调用方法，执行对应操作，否则系统可能会抛出异常或生成其他未定义的行为。具体顺序可参考下列开发步骤及对应说明。

如下为图片编码调用关系图：

Invoking relationship of image native encode

在 CMake 脚本中链接动态库

target_link_libraries(entry PUBLIC libace_napi.z.so)
target_link_libraries(entry PUBLIC libimage_packer_ndk.z.so)

开发步骤

引入编码器头文件：image_packer_mdk.h。

// 引入编码器image_packer_mdk.h头文件。
#include <multimedia/image_framework/image_packer_mdk.h>

创建编码器实例对象。

应用需要napi_env来创建编码器。

// 使用napi_value 承接创建的编码器对象。
napi_value packer;
// 通过 napi_env 创建编码器，返回result为 IMAGE_RESULT_SUCCESS则创建成功。
int32_t result = OH_ImagePacker_Create(env, &packer);

初始化资源。

通过OH_ImagePacker_InitNative来初始化编码器实例对象。

// 通过 napi_env 及上述创建的编码器对象初始化实例对象。
ImagePacker_Native* nativePacker = OH_ImagePacker_InitNative(env, packer);

编码。

编码接口入参包括：

上述过程中获取的实例对象（ImagePacker_Native）。
需要编码的图像源（napi_value）, PixelMap或ImageSource（未调用过CreatePixelMap）的实例对象均可。
编码参数：包括编码格式与编码质量。

说明： 根据MIME标准，标准编码格式为image/jpeg。当使用image编码时，编码参数中的编码格式format设置为image/jpeg，image编码后的文件扩展名可设为.jpg或.jpeg，可在支持image/jpeg解码的平台上使用。

编码接口可按输出方式分为向缓存区（内存）输出和向文件输出两种接口，入参均为上述内容。应用可根据输出的不同需求选择编码接口。

向缓存区（内存）输出。

#include <cstdlib>
#include <multimedia/image_framework/image_packer_mdk.h>

int32_t packImageToData(napi_env env, napi_callback_info info)
{
    napi_value source;
    // 使用napi_value承接创建的编码器对象。
    napi_value packer;
    // 通过napi_env创建编码器，返回result为IMAGE_RESULT_SUCCESS则创建成功。
    int32_t errorCode = OH_ImagePacker_Create(env, &packer);
    if (errorCode != IMAGE_RESULT_SUCCESS) {
        return errorCode;
    }
    // 通过napi_env及上述创建的编码器对象初始化实例对象。
    ImagePacker_Native* nativePacker = OH_ImagePacker_InitNative(env, packer);
    // 编码参数。
    struct ImagePacker_Opts_ opts;
    // 配置编码格式（必须）。
    opts.format = "image/jpeg";
    // 配置编码质量（必须）。
    opts.quality = 95;
    // 配置输出的缓存区大小为4k（缓存区大小视应用场景定）。
    size_t bufferSize = 4*1024;
    // 申请图片编码缓存区。
    uint8_t* outData = (uint8_t *)(malloc(bufferSize));
    if (outData == NULL) {
        errorCode = OH_ImagePacker_Release(nativePacker);
        if (errorCode != IMAGE_RESULT_SUCCESS) {
            return errorCode;
        } else {
            nativePacker = NULL; // 不可重复destroy。
        }
        return IMAGE_RESULT_MALLOC_ABNORMAL;
    }
    // 开始对输入source进行编码过程，返回result为IMAGE_RESULT_SUCCESS则编码成功，同时bufferSize中包含编码实际使用缓存区大小。
    int32_t result = OH_ImagePacker_PackToData(nativePacker, source, &opts, outData, &bufferSize);
    free(outData);
    outData = NULL;
    errorCode = OH_ImagePacker_Release(nativePacker);
    if (errorCode != IMAGE_RESULT_SUCCESS) {
        return errorCode;
    } else {
        nativePacker = NULL; // 不可重复destroy。
    }
    return result;
}

向文件输出。

#include <fcntl.h>
#include <unistd.h>
#include <cstdlib>
#include <multimedia/image_framework/image_packer_mdk.h>

int32_t packImageToFile(napi_env env, napi_callback_info info)
{
    napi_value source;
    // 使用napi_value承接创建的编码器对象。
    napi_value packer;
    // 通过napi_env创建编码器，返回result为IMAGE_RESULT_SUCCESS则创建成功。
    int32_t errorCode = OH_ImagePacker_Create(env, &packer);
    if (errorCode != IMAGE_RESULT_SUCCESS) {
        return errorCode;
    }
    // 通过napi_env及上述创建的编码器对象初始化实例对象。
    ImagePacker_Native* nativePacker = OH_ImagePacker_InitNative(env, packer);
    // 编码参数。
    struct ImagePacker_Opts_ opts;
    // 配置编码格式（必须）。
    opts.format = "image/jpeg";
    // 配置编码质量（必须）。
    opts.quality = 100;
    // 打开需要输出的文件（请确保应用有权限访问这个路径）。
    int fd = open("/data/test.jpg", O_RDWR | O_CREAT, S_IRUSR | S_IWUSR);
    int result;
    if (fd >= 0) {
        // 开始对输入source进行编码过程，返回result为IMAGE_RESULT_SUCCESS则编码成功。
        result = OH_ImagePacker_PackToFile(nativePacker, source, &opts, fd);
        // 关闭输出文件。
        close(fd);
    }
    errorCode = OH_ImagePacker_Release(nativePacker);
    if (errorCode != IMAGE_RESULT_SUCCESS) {
        return errorCode;
    } else {
        nativePacker = NULL; // 不可重复destroy。
    }
    return result;
}