# multimedia_image_effect **Repository Path**: geek-prince/multimedia_image_effect ## Basic Information - **Project Name**: multimedia_image_effect - **Description**: 图像的效果处理框架 - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://gitee.com/openharmony-sig/multimedia_image_effect - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 99 - **Created**: 2024-03-22 - **Last Updated**: 2024-03-22 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # ImageEffect框架 - [ImageEffect框架](#ImageEffect框架) - [简介](#简介) - [基本概念](#基本概念) - [目录](#目录) - [使用说明](#使用说明) - [标准滤镜](#标准滤镜) - [简易滤镜](#简易滤镜) - [自定义滤镜](#自定义滤镜) ## 简介 相图片编辑框架支持图片编辑业务的开发，开发者可以通过已开放的接口实现图片编辑相关功能开发，最常见的功能如：标准滤镜、简易滤镜、自定义滤镜、uri(单输入场景)等。 ### 基本概念 - 标准滤镜 此功能用于图片编辑的标准滤镜调节。 - 简易滤镜 此功能用于图片编辑的简易滤镜调节。 - 自定义滤镜 此功能用于图片编辑的自定义滤镜调节。 ## 目录 仓目录结构如下： ``` /foundation/multimedia/image_effect # 图片编辑框架业务代码 ├── frameworks # 框架代码 │ ├── native # 内部接口实现 │ │ ├── common_effect # 公共效果 │ │ └── filter_operator # 元数据实现 │ │ └── pipeline # 管线实现 │ │ └── utils # 工具类 ├── interfaces # 接口代码 │ ├── inner_api # 内部接口 │ └── kits # 外部接口 ├── LICENSE # 证书文件 ├── ohos.build # 构建文件 ├── sa_profile # 服务配置文件 └── services # 服务实现 ``` ## 使用说明 ### 标准滤镜 标准滤镜使用步骤: 1. 初始化 ``` napi_value result = nullptr; napi_get_undefined(env,&result); size_t argc = 2; napi_value args[2] = {nullptr}; napi_status status = napi_get_cb_info(env,info,&argc,args,nullptr,nullptr); CHECK_AND_RETURN_LOG(status == napi_ok, result, "napi_get_cb_info fail! status = %{public}d" ,status); NativePixelMap *inputPixel = OH_PixelMap_InitNativePixelMap(env,args[0]); NativePixelMap *outPixel = OH_PixelMap_InitNativePixelMap(env,args[1]); ``` 2. 示例代码：创建ImageEffect对象，“imageEdit”为ImageEffect对象别名 ``` OH_ImageEffect *imageEffect = OH_ImageEffectCreate("imageEdit"); CHECK_AND_RETURN_LOG(imageEffect != nullptr, result, "OH_ImageEffect_Create fail!"); ``` 3. 示例代码：将滤镜添加到ImageEffect容器中，可以添加多个滤镜，返回创建EFilter滤镜对象 ``` OH_EFilter *filter = OH_ImageEffect_AddFilter(imageEffect,"Brightness"); CHECK_AND_RETURN_LOG(filter != nullptr, result, "OH_ImageEffect_AddFilter fail!"); ``` 4. 示例代码：设置滤镜参数 ``` OH_Any value{ .dataType = OH_DataType::TYPE_FLOAT, .dataValue.floatValue = 100.f }; OH_EffectErrorCode errorCode = OH_EFilter_SetValue(filter, "FILTER_INTENSITY", &value); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_EFilter_SetValue fail, errorCode = % {public}d" ,errorCode); ``` 5. 示例代码：设置待处理的输入pixelMap ``` errorCode = OH_ImageEffect_SetInputPixelMap(imageEffect, inputPixel); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_ImageEffect_SetInputPixelMap fail, errorCode = %{public}d" ,errorCode); ``` 6. 示例代码：设置待处理的输出pixelMap,可以不设置，当不设置时会直接在输入pixelMap上进行滤镜处理 ``` errorCode = OH_ImageEffect_SetOutputPixelMap(imageEffect, outPixel); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_ImageEffect_SetOutputPixelMap fail, errorCode = %{public}d" ,errorCode); ``` 7. 示例代码：执行生效滤镜算法 ``` errorCode = OH_ImageEffect_Start(imageEffect); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_ImageEffect_Start fail, errorCode = %{public}d" ,errorCode); ``` 8. 示例代码：释放资源 ``` OH_ImageEffect_Release(imageEffect); return result; ``` ### 简易滤镜 1. 初始化 ``` napi_value result = nullptr; napi_get_undefined(env,&result); size_t argc = 2; napi_value args[2] = {nullptr}; napi_status status = napi_get_cb_info(env,info,&argc,args,nullptr,nullptr); CHECK_AND_RETURN_LOG(status == napi_ok, result, "napi_get_cb_info fail! status = %{public}d" ,status); NativePixelMap *inputPixel = OH_PixelMap_InitNativePixelMap(env,args[0]); NativePixelMap *outPixel = OH_PixelMap_InitNativePixelMap(env,args[1]); napi_value result = nullptr; napi_get_undefined(env,&result); size_t argc = 2; napi_value args[2] = {nullptr}; napi_status status = napi_get_cb_info(env,info,&argc,args,nullptr,nullptr); CHECK_AND_RETURN_LOG(status == napi_ok, result, "napi_get_cb_info fail! status = %{public}d" ,status); NativePixelMap *inputPixel = OH_PixelMap_InitNativePixelMap(env,args[0]); NativePixelMap *outPixel = OH_PixelMap_InitNativePixelMap(env,args[1]); ``` 2. 示例代码：创建EFiter滤镜对象，"Brightness"为滤镜名 ``` OH_EFilter *filter = OH_EFilter_Create("Brightness"); CHECK_AND_RETURN_LOG(filter != nullptr, result, "OH_EFilter_Create fail!"); ``` 3. 示例代码：设置滤镜参数 ``` OH_Any value{ .dataType = OH_DataType::TYPE_FLOAT, .dataValue.floatValue = 100.f }; OH_EffectErrorCode errorCode = OH_EFilter_SetValue(filter, "FILTER_INTENSITY", &value); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_EFilter_SetValue fail, errorCode = %{public}d" ,errorCode); ``` 4. 示例代码：执行生效滤镜算 ``` errorCode = OH_EFilter_Render(filter, inputPixel, outPixel); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_EFilter_Render fail, errorCode = %{public}d" ,errorCode); ``` 5. 示例代码：释放资源 ``` OH_ImageEffect_Release(imageEffect) return result; ``` ### 自定义滤镜 1. 初始化 ``` napi_value result = nullptr; napi_get_undefined(env,&result); size_t argc = 2; napi_value args[2] = {nullptr}; napi_status status = napi_get_cb_info(env,info,&argc,args,nullptr,nullptr); CHECK_AND_RETURN_LOG(status == napi_ok, result, "napi_get_cb_info fail! status = %{public}d" ,status); NativePixelMap *inputPixel = OH_PixelMap_InitNativePixelMap(env,args[0]); NativePixelMap *outPixel = OH_PixelMap_InitNativePixelMap(env,args[1]); ``` 2. 自定义算子实现接口 ``` OH_EFilterDelegate delegate = { .setValue = [](OH_EFilter *filter, const *key, const OH_Any *value){return SetValue(filter, key, value);}, .render = [](OH_EFilter *filter, OH_EffectBuffer *src, OH_EFilterDelegate_PushData pushData){return Apply(filter, src, pushData);}, .save = [](OH_EFilter *filter, char **info){return Save(filter, info);}, .restore = [](const char *info){return Restore(info);} }; ``` 3. 自定义算子信息 ``` OH_EffectInfo effectInfo = { .name = "CustomBrightness", .category = OH_Category::COLOR_ADJUST, .bufferTypes = OH_BufferType::PIXEL, .formats = OH_IEffectFormat::RGBA8888 } ``` 4. 示例代码：注册自定义滤镜算子 ``` OH_EffectErrorCode errorCode = OH_EFilter_Register(&effectInfo, &delegate); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_EFilter_Register fail, errorCode = %{public}d" ,errorCode); ``` 5. 示例代码：创建ImageEffect对象，“imageEdit”为ImageEffect对象别名 ``` OH_ImageEffect *imageEffect = OH_ImageEffectCreate("imageEdit"); CHECK_AND_RETURN_LOG(imageEffect != nullptr, result, "OH_ImageEffect_Create fail!"); ``` 6. 示例代码：将滤镜添加到ImageEffect容器中，可以添加多个滤镜，返回创建EFilter滤镜对象 ``` OH_EFilter *filter = OH_ImageEffect_AddFilter(imageEffect,"CustomBrightness"); CHECK_AND_RETURN_LOG(filter != nullptr, result, "OH_ImageEffect_AddFilter fail!"); ``` 7. 示例代码：设置滤镜参数 ``` OH_Any value{ .dataType = OH_DataType::TYPE_FLOAT, .dataValue.floatValue = 100.f }; errorCode = OH_EFilter_SetValue(filter, "brightness", &value); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_EFilter_SetValue fail, errorCode = %{public}d" ,errorCode); ``` 8. 示例代码：执行生效滤镜算法 ``` errorCode = OH_Efilter_Render(filter, inputPixel, outPixel ); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_Efilter_Render fail, errorCode = %{public}d" ,errorCode); ``` 9. 示例代码：释放资源 ``` OH_ImageEffect_Release(imageEffect); return result; ``` 10. 自定义算子接口实现示例 ``` static bool SetValue(OH_EFilter *filter, const *key, const OH_Any *value); // 自定义滤镜参数校验 static bool SetValue(OH_EFilter *filter, const *key, const OH_Any *value) { //参数校验 CHECK_AND_RETURN_LOG(std::string("brightness").compare(key) ==0, false,"key is not match! key=%{public}s" key); CHECK_AND_RETURN_LOG(value->dataType == OH_DataType::TYPE_FLOAT, false,"dataType is not int! key=%{public}d" value->dataType); float brightness = value->dataValue.floatValue; CHECK_AND_RETURN_LOG(brightness <= 100.f && brightness >= -00.f, false," brightness is out range! brightness=%{public}f" brightness); return true; } ``` ``` static bool Apply(OH_EFilter *filter, OH_EffectBuffer *src, OH_EFilterDelegate_PushData pushData); //执行自定义滤镜 static bool Apply(OH_EFilter *filter, OH_EffectBuffer *src, OH_EFilterDelegate_PushData pushData) { // 获取滤镜算子需要的参数 OH_Any value; OH_EffectErrorCode errorCode = OH_EFilter_GetValue(filter, "brightness", &value) CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS && value.dataType == OH_DataType::TYPE_FLOAT, result, "OH_EFilter_GetValue fail, errorCode = %{public}d" ,errorCode); CustomAdjustBrightness(src, src, value.dataValue.floatValue); pushData(filter, src); return true; } ``` ``` static bool Save(OH_EFilter *filter, char **info); // 序列化滤镜 static bool Save(OH_EFilter *filter, char **info){ // 获取滤镜的参数 OH_Any value; OH_EffectErrorCode errorCode = OH_EFilter_GetValue(filter, "brightness", &value) CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS && value.dataType == OH_DataType::TYPE_FLOAT, result, "OH_EFilter_GetValue fail, errorCode = %{public}d" ,errorCode); float brightness = any.dataValue.floatValue; nlohmann::json values; value["brightness"] = brightness; // 生成键值对信息 nlohmann::json root; root["name"] = "CustomBrightness"; root["values"] = values; // 获取json字串，注意infoChar对象的最终释放 std::string infoStr = root.dump(); char *infoChar new char[infoStr.length() + 1]{0}; std::strcpy(infoChar, infoStr.c_str()); *info = infoChar; return true; } ``` ``` static OH_EFilter *Restore(const char *info) // 反序列化滤镜 static OH_EFilter *Restore(const char *info) { // 解析滤镜名 std::string infoStr = info; nlohmann::json jsonObject = nlohmann::json::parse(infoStr, nullptr, false); CHECK_AND_RETURN_LOG(jsonObject.find("name") != jsonObject.end() && jsonObject.at("name").is_string(), nullptr, "name not find"); std::string name = jsonObject.at("name").get(); // 示例代码: 创建EFilter对象 OH_EFilter *filter = OH_EFilter_Create(name.c_str()); CHECK_AND_RETURN_LOG(filter != nullptr, result, "OH_EFilter_Create fail!"); // 解析滤镜参数 CHECK_AND_RETURN_LOG(jsonObject.find("values") != jsonObject.end() && jsonObject.at("values").is_object(), nullptr, "values not find"); const nlohmann::json values= *(jsonObject.find("values")); CHECK_AND_RETURN_LOG(values.find("brightness") != values.end() && values.at("brightness").is_number(), nullptr, "brightness not find"); //设置滤镜参数 float brightness = values.at("brightness").get(); OH_Any value{ .dataType = OH_DataType::TYPE_FLOAT, .dataValue.floatValue = brightness }; OH_EffectErrorCode errorCode = OH_EFilter_SetValue(filter, "brightness", &value); CHECK_AND_RETURN_LOG(errorCode == OH_EffectErrorCode::EFFECT_ERR_SUCCESS, result, "OH_EFilter_SetValue fail, errorCode = %{public}d" ,errorCode); return filter; } ```