Files
oak-editor/docs/zh/plans/riir/M8-oaktask.md
T
Mike-Solar 9b25772267 docs: module-split execution manuals for RIIR stage 1 (plans/riir/)
13 files: 00 overview, 01 two-layer adapter spec (init/free/func +
opaque handles + same-name adapter classes, frozen naming/ownership/
error/event rules), 02 dependency matrix + split order M1-M9 (from a
490-file include scan), 03 Google Test spec (per-C-API coverage,
roundtrip tests, leak counters), M1-M9 per-module manuals with frozen
C APIs (common/undo/node/timeline/codec/audio/render/task/plugin) and
the facade assembly-layer verdict.
2026-07-27 00:06:33 +08:00

3.9 KiB
Raw Blame History

M8 · oaktask 拆分手册

内容:engine/task/Task 基类、TaskManager、project/ load/save/import/loadotio/saveotio、cache 任务)。 依赖:node 38、codec 4、render 4、common 4、config 2、timeline 1、 coreengine 2。 拆分顺序第 8 位。

1. 目标形态

oaktask/
  include/oaktask/{task.h, manager.h, project.h, types.h, export.h}
  src/
  tests/  # oaktask_gtest

2. 冻结 C API

2.1 oaktask/task.h(单任务句柄,照 oakengine/task.h 模板对齐)

typedef struct OakTaskTask OakTaskTask;
OAKTK_API void oaktask_task_free(OakTaskTask *t);
OAKTK_API int oaktask_task_start(OakTaskTask *t);       /* 异步 */
OAKTK_API int oaktask_task_start_sync(OakTaskTask *t);
OAKTK_API int oaktask_task_cancel(OakTaskTask *t);
OAKTK_API int oaktask_task_is_finished(const OakTaskTask *t);
OAKTK_API int oaktask_task_succeeded(const OakTaskTask *t);
OAKTK_API int oaktask_task_progress(const OakTaskTask *t, double *out);
OAKTK_API int oaktask_task_title(OakTaskTask *t, char *buf, int n);
OAKTK_API int oaktask_task_error(OakTaskTask *t, char *buf, int n);
/* 事件:STARTED/PROGRESS/FINISHEDid 沿用 oakengine events 段) */
OAKTK_API int64_t oaktask_task_subscribe(OakTaskTask *t, int32_t event_id,
	oaktask_event_fn fn, void *userdata);

2.2 oaktask/project.h(任务工厂 + 结果访问器)

OAKTK_API OakTaskTask *oaktask_create_project_load(const char *filename);
OAKTK_API OakTaskTask *oaktask_create_project_save(OakNodeProject *p,
	const char *filename_or_NULL, int use_compression,
	const void *layout_or_NULL);
OAKTK_API OakTaskTask *oaktask_create_project_import(OakNodeNode *folder,
	const char *const *urls, int url_count);
OAKTK_API OakTaskTask *oaktask_create_project_load_otio(
	const char *filename, const int *sequence_indexes, int count);
OAKTK_API OakTaskTask *oaktask_create_project_save_otio(
	OakNodeProject *p, const char *filename, const int *sequence_indexes,
	int count);
/* import 结果(task 成功后读,borrowed */
OAKTK_API void *oaktask_import_take_command(OakTaskTask *t); /* 所有权转移 */
OAKTK_API int oaktask_import_footage_count(OakTaskTask *t);
OAKTK_API OakNodeNode *oaktask_import_footage_at(OakTaskTask *t, int i);
OAKTK_API int oaktask_import_invalid_count(OakTaskTask *t);
OAKTK_API int oaktask_import_invalid_at(OakTaskTask *t, int i,
	char *buf, int n);
/* load 结果 */
OAKTK_API OakNodeProject *oaktask_load_take_project(OakTaskTask *t);

2.3 oaktask/manager.h

OAKTK_API int oaktask_manager_count(void);
OAKTK_API OakTaskTask *oaktask_manager_at(int i);      /* borrowed */
OAKTK_API void oaktask_manager_delete_finished(void);
/* 事件:TASK_ADDED/REMOVED/FAILED/LIST_CHANGED */
OAKTK_API int64_t oaktask_manager_subscribe(int32_t event_id,
	oaktask_event_fn fn, void *userdata);
OAKTK_API void oaktask_unsubscribe(int64_t id);

3. 切割点

现状 处理
task → node/ 38footage 6、project 5、sequence 3、serializer/layout 3、colormanager 2 等) 全部经 oaknode C ABI + 适配类(M3 已就位)——本手册工作量主体
task → codec/ 4 经 oakcodec C ABIM5
task → render/ 4 经 oakrender C ABIM7
task → timeline/ 1 经 oaktimeline C ABIM4
task → coreengine.h 2 coreengine 的 Task 注册点改为 oaktask_manager 自管(manager 原本就是单例,注册调用内聚进 oaktask)

4. 测试(映射 03 §2/§3

  • 每个工厂 1 个用例:demo.mp4 importfootage_count>0、command 可 入栈)、save/load 往返(临时目录 .oveload 后 project 非空、 root 非空)。
  • start_sync 成功/失败路径(不存在文件 → failed + error 非空)。
  • 事件:STARTED→PROGRESS→FINISHED 序列(导入任务断言至少一次 PROGRESS 且 FINISHED.succeeded==1)。
  • manager:添加/删除/list_changed 事件。
  • oaktask_debug_alive_count() 泄漏断言。