Clarisse 配置文件文档¶
分析：我们将场景中需要的信息分析出来并保存到task.json, asset.json, upload.json, tips.json中，以便进一步解析和处理
1.task.json解析¶
说明: 存放场景分析结果、渲染设置等信息
task.json示例
{
"scene_info_render": {
"image_node": [
{
"frames": "0-50[1]",
"renderable": "0",
"output": "D:\\temp\\cam02",
"format": "exr16",
"LUT": "linear",
"save_to_disk": "1",
"name": "project://scene/cam02",
"layers": [
{
"frames": "0-50[1]",
"renderable": "1",
"output": "D:\\temp\\cam02_layer02",
"format": "exr16",
"enable_deep_output": "1",
"save_to_disk": "1",
"enable_deep_output_path": "D:\\temp\\cam02_layer02_deep",
"name": "project://scene/cam02.cam02_layer02"
}
]
}
]
},
"software_config":{
"plugins":{},
"cg_version":"clarisse_ifx_4.0_sp3",
"cg_name":"Clarisse"
},
"task_info":{
"task_stop_time":"259200",
"frames_per_task":"1",
"channel":"4",
"task_id":"11022523",
"project_name":"Project1",
"platform":"2",
"tiles":"1",
"is_picture":"0",
"project_id":"200953",
"job_stop_time":"86400",
"distribute_render_node":"3",
"stop_after_test":"2",
"clone_original_id":"",
"ram":"64",
"render_layer_type":"0",
"test_frames":"000",
"graphics_cards_num":"2",
"edit_name":"",
"pre_frames":"000",
"input_project_path":"",
"is_layer_rendering":"1",
"is_distribute_render":"0",
"time_out":"43200",
"tiles_type":"block",
"user_id":"100150764",
"cg_id":"2013",
"input_cg_file":"E:/copy/DHGB_sc05_zhuta_610-1570_v0102.project",
"os_name":"1",
"hardwareConfigId": ""
},
"scene_info":{
"image_node": [
{
"frames": "0-50[1]",
"renderable": "0",
"output": "D:\\temp\\cam02",
"format": "exr16",
"LUT": "linear",
"save_to_disk": "1",
"name": "project://scene/cam02",
"layers": [
{
"frames": "0-50[1]",
"renderable": "1",
"output": "D:\\temp\\cam02_layer02",
"format": "exr16",
"enable_deep_output": "1",
"save_to_disk": "1",
"enable_deep_output_path": "D:\\temp\\cam02_layer02_deep",
"name": "project://scene/cam02.cam02_layer02"
}
]
}
]
}
}
task.json参数解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| software_config | object | 渲染环境（软件类型、版本和用到的插件等） | 见software_config对象解析 |
| task_info | object | 渲染设置（优先帧、渲染帧数、超时时间等） | 见task_info对象解析 |
| scene_info_render | object | 场景的分析结果（场景中的渲染节点、输出路径等） | 见scene_info_render对象解析 |
software_config对象解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| cg_name | string | 软件名称 | "Clarisse" |
| cg_version | string | 软件版本 | "clarisse_ifx_4.0_sp3" |
| plugins | object | 插件对象: key为插件名称，value为插件版本 |
{} |
task_info对象部分解析
| 参数 | 类型 | 是否必须 | 说明 | 默认值 | 示例 |
|---|---|---|---|---|---|
| graphics_cards_num | string | Y | 1: 开启单卡渲染 2: 开启双卡渲染 | "2" | “2” |
| enable_layered | string | Y | 是否开启分层提交, "0":关闭 "1":开启 | "0" | "0" |
| cg_id | string | Y | 渲染软件id."2013": Clarisse | "2013" | |
| ram | string | Y | 内存要求: 64 / 128 | “64” | "64" |
| os_name | string | Y | 渲染操作系统: "0":Linux; "1": Windows | “1” | "1" |
| render_layer_type | string | N | 渲染层方式选择(支持maya): "0"：renderlayer方式 "1"：rendersetup方式 | “0” | "0" |
| is_distribute_render | string | N | 是否开启分布式渲染: "0":关闭 "1":开启 | “0” | "0" |
| input_cg_file | string | Y | 渲染场景本地路径 | "E:/copy/DHGB_sc05_zhuta_610-1570_v0102.project" | |
| input_project_path | string | Y | 项目路径，如用户未设置传空字符串 | " " | |
| job_stop_time | string | Y | 设置帧的超时时间，只会影响当前帧, 单位秒 | “259200” | "28800" |
| user_id | string | Y | 用户ID | ||
| pre_frames | string | Y | 优先渲染(优先帧不建议自定义多个单独帧) | “000” | "000:1,3-4[1]" 表示： 优先渲染首帧：否 优先渲染中间帧：否 优先渲染末帧：否 优先渲染自定义帧：1,3-4[1] |
| platform | string | Y | 提交平台: "2": "www2", "3": "www3", "6": "www4", "21": "gpu", | "2" | |
| is_picture | string | Y | “0: 效果图 "1": 动画图 | “0” | "0" |
| channel | string | Y | 1:web本地分析(动画扣费); 2:web云端分析; 3:效果图插件提交； 4：API/SDK提交; 8：动画插件提交 | “4” | "4" |
| tiles_type | string | Y | "block(分块),strip(分条)" | “block” | "block" |
| tiles | string | Y | 分块数量，大于1就分块或者分条，等于1 就是单机 | "1" | "1" |
| project_id | string | Y | 项目id | "200953" | |
| project_name | string | Y | 项目名称 | " " | "Project1" |
| distribute_render_node | string | N | 分布式渲染机器数 | "3" | "3" |
| frames_per_task | string | Y | 一机渲多帧的帧数量 | "1" | "1" |
| stop_after_test | string | Y | 优先渲染完成后是否暂停任务 "1":优先渲染完成后暂停任务 "2".优先渲染完成后不暂停任务 | "2" | “2” |
| task_id | string | Y | 任务号 | ||
| task_stop_time | string | Y | 大任务超时停止 单位秒,"0"表示不限制 | "0" | "86400" |
| time_out | string | Y | 超时时间 单位秒 | “43200” | "43200" |
注意: Clarisse暂时不支持分布式渲染(is_distribute_render)和分块渲染(tiles)
scene_info_render对象解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| image_node | List | 在clarisse IFX中包括了场景中所有的image和image下的3dlayer，在clarisse BUiLDER中包括了场景中所有的VariableRange和VariableRange下的ImageNodeWrite | 见scene_info_render.image_node对象解析 |
scene_info_render.image_node对象解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| renderable | string | "0", 不开启渲染，“1”:开启渲染（这个不是场景中的值，平台默认是不开的，平台不建议直接渲染image和VariableRange） | "0" |
| output | string | clarisse IFX中为当前image的输出路径, clarisse BUiLDER下无 | "D:\temp\cam02" |
| format | string | clarisse IFX中为当前image的输出格式，非必须值，clarisse BUiLDER下无 | "exr16" |
| LUT | string | IFX中为当前image的输出颜色管理 非必须值，clarisse BUiLDER下无 | "linear" |
| save_to_disk | string | clarisse IFX中当前image的是否要开启保存输出，clarisse BUiLDER下无 | "1" |
| name | string | clarisse IFX中为当前image的名字，clarisse BUiLDER中为当前VariableRange的名字，也是两者在场景中的路径 | "project://scene/cam02" |
| layers | string | IFX中为当前image的中的3dlayer，值是list，list的值是dict,当前image中有多少layer,就有几个layer的dict，clarisse BUiLDER中为当前VariableRange的中的ImageNodeWrite，值是list，list的值是dict,当前VariableRange中有多少ImageNodeWrite,就有几个ImageNodeWrite的dict 见scene_info_render.image_node.layers对象解析 | 见scene_info_render.image_node.layers对象解析 |
| frames | string | clarisse IFX中为当前image的帧范围，clarisse BUiLDER中为当前VariableRange的F或Frame变量的值 | "0-50[1]" |
scene_info_render.image_node.layers对象解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| frames | string | clarisse IFX中为当前3dlayer起始帧结束帧，clarisse BUiLDER中为当前VariableRange下的ImageNodeWrite的覆盖值 | "0-50[1]" |
| renderable | string | "0", 不开启渲染 “1”:开启渲染 | "1" |
| output | string | clarisse IFX中为当前layer的输出路径，clarisse BUiLDER下无 | "D:\temp\cam02_layer02" |
| inw_output | string | clarisse BUiLDER中为当前ImageNodeWrite的输出路径，clarisse IFX下无 | |
| format | string | 当前layer或ImageNodeWrite的输出格式 | "exr16" |
| enable_deep_output | string | clarisse IFX中为当前layer的是否要开启deep保存输出，clarisse BUiLDER下暂无 | "1" |
| save_to_disk | string | clarisse IFX中为当前layer的是否要开启保存输出,clarisse BUiLDER下无 | "1" |
| enable_deep_output_path | string | clarisse IFX中为当前layer的deep输出路径，clarisse BUiLDER下暂无 | "D:\temp\cam02_layer02_deep" |
| name | string | 1：clarisse IFX中为当前当前layer的名字，也是在场景中的路径； 2：clarisse BUiLDER中为当前ImageNodeWrite的名字, 值为当前VariableRange的场景中的路径和当前ImageNodeWrite在场景中的路径，以 ===链接 |
1："project://scene/cam02.cam02_layer02" 2：“build://yt_0080===build://cloudShadow” |
2.upload.json解析¶
说明: 存放需要上传的资产路径信息
upload.json示例
{
"scene": [
{
"local": "E:\\work\\Trex\\ep\\ani_fly\\clarisse\\trex_fly_env_songshu.project",
"server": "/E/work/Trex/ep/ani_fly/clarisse/trex_fly_env_songshu.project"
}
],
"asset": [
{
"local": "E:\\work\\Trex\\ep\\ani_fly\\clarisse\\assets\\speedtree\\guanmu01\\LeafHD2.png",
"server": "/E/work/Trex/ep/ani_fly/clarisse/assets/speedtree/guanmu01/LeafHD2.png"
},
{
"local": "E:\\work\\Trex\\ep\\ani_fly\\clarisse\\assets\\speedtree\\tree_far\\tree_far08\\HuangshanPineBark_Normal.png",
"server": "/E/work/Trex/ep/ani_fly/clarisse/assets/speedtree/tree_far/tree_far08/HuangshanPineBark_Normal.png"
}
]
}
upload.json参数解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| asset | object | 需要上传的资产路径信息 | 见asset对象解析 |
| scene | object | 场景文件信息 | 见scene对象解析 |
asset对象解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| local | string | 场景本地路径 | "E:\work\Trex\ep\ani_fly\clarisse\assets\speedtree\guanmu01\LeafHD2.png" |
| server | string | 服务器端相对路径，一般与local保持一致 | "/E/work/Trex/ep/ani_fly/clarisse/assets/speedtree/guanmu01/LeafHD2.png" |
scene对象解析
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| local | string | 资产本地路径 | "E:\work\Trex\ep\ani_fly\clarisse\trex_fly_env_songshu.project" |
| server | string | 资产服务端路径，一把与local保持一致 | "/E/work/Trex/ep/ani_fly/clarisse/trex_fly_env_songshu.project" |
3.tips.json解析¶
说明: 存放分析出的错误、警告信息
{
"50001":[
"Nodes: /obj/flattank_fluid/compressed_cache/file_mode File name: $HIP/geo/$HIPNAME.$OS.$F.bgeo.sc miss file: /geo/flip_test_slice4.compressed_cache.1.bgeo.sc "
]
}