PyJianYingDraft
轻量、灵活、易上手的Python剪映草稿生成及导出工具，构建全自动化视频剪辑/混剪流水线。本项目的CapCut版本正于 https://github.com/GuanYixuan/pyCapCut 内开发
Install / Use
/learn @GuanYixuan/PyJianYingDraftREADME
pyJianYingDraft
轻量、灵活、易上手的Python剪映草稿生成及导出工具，构建全自动视频剪辑/混剪流水线！
🧪 本项目的CapCut版本正在开发中，欢迎关注CapCut版本仓库
📢 欢迎加入Discord服务器进行用法或新功能的讨论
使用思路
功能清单
ℹ 如未额外注明，一般仅在5.9版本上测试过
标注☑️的特性已实现，标注⬜的特性待实现
模板模式
⚠️ 剪映6+版本对
draft_content.json文件进行了加密，故本系列功能目前仅支持剪映5.9及以下版本
ℹ 欢迎为本项目补充6+版本草稿文件的解密方式
- ☑️ 加载（未加密的）
draft_content.json文件作为模板 - ☑️ 替换音视频片段的素材
- ☑️ 修改文本片段的文本内容
- ☑️ 将模板草稿中的音视频/文本轨道整体导入到另一草稿中
- ☑️ 提取模板中出现的贴纸/气泡/花字等元信息
批量导出
⚠️ 剪映7+版本隐藏了控件，故本系列功能目前仅支持剪映6及以下版本
- ☑️ 控制剪映打开指定草稿
- ☑️ 导出草稿至指定位置
- ☑️ 调节导出分辨率和帧率
视频与图片
ℹ 以下草稿生成功能（音视频、贴纸、文本、特效等）支持剪映5及以上的所有版本
- ☑️ 添加本地视频/图片素材，并自定义片段的时间、持续时长或播放速度
- ☑️ 视频片段的音频淡入淡出效果
- ☑️ 视频整体调节（旋转、缩放、亮度等）以及关键帧生成
- ☑️ 视频片段的入场/出场/组合动画
- ☑️ 添加蒙版、片段特效和滤镜
- ☑️ （项目700⭐️回馈功能）视频背景填充(示例代码)
- ☑️ （项目2k⭐️回馈功能）视频混合模式（正片叠底、滤色、叠加等）
贴纸
音频
轨道
- ☑️ 添加轨道以及将片段添加到指定轨道
- ☑️ 自定义视频/滤镜/特效轨道的层级关系
特效、滤镜和转场
- ☑️ 吸附于片段上的特效、滤镜和动画
- ☑️ 位于独立轨道的特效和滤镜
- ☑️ 添加转场(示例代码)，并自定义其时长
文本及字幕
- ☑️ 添加文本、设置字体及样式、修改文本片段的位置及旋转设置
- ☑️ 文本的关键帧以及动画
- ☑️ 文字描边、背景和阴影
- ☑️ 文字气泡效果和花字效果(示例代码)
- ☑️ 文本自动换行，支持设置最大行宽
- ☑️ 导入
.srt文件生成字幕并批量设置格式
安装
pyJianYingDraft现已支持pip安装（不含demo），推荐使用开发时测试的Python版本3.8或3.11
pip install pyJianYingDraft
ℹ 关于剪映5.9版本的自动升级问题，可参见相关issue
跨平台兼容性
- Windows：支持包括草稿生成、模板模式和自动导出在内的所有功能（具体可能受到剪映版本限制）
- Linux/MacOS：支持草稿生成和模板模式，但不支持自动导出，且注意生成的草稿仍然需要在Windows版剪映下导出。
快速上手
例程demo.py将创建包含音视频素材和一行文本的剪映草稿文件，并且添加了音频淡入、视频入场动画、转场效果和文本气泡/花字。
这个例程的操作方法如下：
- 找到剪映的草稿文件夹路径（类似
.../JianyingPro Drafts），用其替换代码中的<你的草稿文件夹> - 运行
demo.py - 在剪映中找到并打开新创建的
demo草稿（可能需要进入再退出某个已有草稿，或重启剪映以刷新草稿列表），你应该看到类似如下的时间轴：
你可以仔细检查音频片段的音量设置、淡入效果时长以及视频片段的入场动画效果等，看看是否符合上述代码的设置
用法文档
ℹ 文档部分推荐从功能清单一节中选取感兴趣的功能阅读，而非直接按顺序阅读
模板模式
为了保留部分复杂特性（文本特效、复合片段...），可以加载一个已有的剪映草稿作为模板，然后将其中内容导入到另一的草稿中，或直接替换其中部分片段的内容。
目前提供了三种替换功能：
除此之外，对于某些没有特定名称的特性（贴纸、花字等），提供了提取素材元数据的功能以提取其resource_id
⚠️ 由于剪映6+版本对草稿文件进行了加密，故暂不支持加载来自6+版本的草稿文件作为模板
ℹ 若出现模板内容丢失的情况，欢迎反馈
加载模板
推荐使用DraftFolder来管理剪映的草稿文件夹（可以在剪映的全局设置-草稿位置中查询），这样能够方便地根据已有模板生成新草稿。
import pyJianYingDraft as draft
draft_folder = draft.DraftFolder("<剪映草稿文件夹>") # 一般形如 ".../JianyingPro Drafts"
script = draft_folder.duplicate_as_template("模板草稿", "新草稿") # 复制"模板草稿"，并命名为"新草稿"，同时打开新草稿供编辑
# 对返回的ScriptFile对象进行编辑，如替换素材、添加轨道、片段等
script.save() # 保存你的"新草稿"
为了最大限度地兼容模板中的复杂特性，导入的轨道与pyJianYingDraft创建的轨道是分离开的，具体地讲：
- 除下述替换功能外，不能在导入的轨道上添加片段、转场、淡入淡出、特效等
- 仍然可以创建新的轨道，并在其上添加片段等，就像非模板模式一样
ℹ 导入轨道的限制也许会在后续版本中逐渐取消
提取素材元数据
对导入的ScriptFile对象，可以调用inspect_material方法提取部分素材的resource_id。
DraftFolder也有相应的方法来提取指定草稿的素材元数据。
import pyJianYingDraft as draft
draft_folder = draft.DraftFolder("<剪映草稿文件夹>")
draft_folder.inspect_material("草稿名称")
# 或者
script = draft_folder.load_template("草稿名称")
script.inspect_material()
上述代码的输出可能类似于
贴纸素材:
Resource id: 7405878923323641129 '秋日手绘-枫叶'
Resource id: 7429353555447893260 '电商购物促销/哇哦'
Resource id: 7437707455267671315 '冬日涂鸦winter雪花冬天vlog装饰文字'
Resource id: 7343931192204463401 '爱心'
文字气泡效果:
Effect id: 763870 ,Resource id: 6838834573413978631 '标题59'
花字效果:
Resource id: 7342020000812731658 '彩色手绘线条花字'
其中的元数据可用于添加相应素材（例如通过StickerSegment的resource_id参数）
根据名称替换素材
这种方法将替换素材本身，而不对片段进行直接修改。
ℹ 由于素材有名称（默认是本地文件的名称），这种替换方式的定位比较方便
ℹ 由于不涉及时间范围的修改，这种替换方式尤其适合图像素材，且几乎不会产生兼容性的问题
以快速上手中的草稿为例，假如我们希望换用新的音频素材，可以：
new_material = draft.AudioMaterial("<新的音频素材路径>")
script.replace_material_by_name("audio.mp3", new_material) # 替换名称为"audio.mp3"的素材
替换新素材后，片段所截取的部分仍是素材前5秒，且音量、淡入淡出、播放速度等仍保持不变。
根据片段替换素材
这种方法将替换某个特定片段的素材，同时可以重新选取其引用的素材范围并根据新时长在时间轴上伸缩片段。
ℹ 由于片段没有名称，故通常需要依靠片段的下标来定位
此过程分为两步：选取轨道和替换素材，以上方音频素材的替换为例：
from pyJianYingDraft import trange, ShrinkMode, ExtendMode
audio_track = script.get_imported_track(
draft.TrackType.audio, # 选取导入的音频轨道
#name="audio", # 假如轨道有名称，最好利用名称来定位
index=0 # 也可用下标定位, 0表示最底层的同类型轨道
)
script.replace_material_by_seg(
audio_track, 0, new_material, # 选取audio_track中下标为0的片段，也即第一个片段
#source_timerange=None, # 若不指定，则默认使用整个素材
source_timerange=trange("0s", "10s"), # 此处指定截取素材前10秒(注意原片段时长为5秒)
handle_shrink=ShrinkMode.cut_tail, # 片段若要缩短，则依靠前移终止点来实现
handle_extend=ExtendMode.push_tail # 片段若要延长，则依靠后移终止点来实现，必要时允许后移后续片段
)
从例子中可见，此替换方法可能会造成片段的时长变化，故可以利用handle_shrink和handle_extend参数指定片段在缩短和延长时的处理方式。
ℹ 不显式指定
handle_shrink和handle_extend时，默认的处理方式如下：
- 新素材比原素材短，则前移片段终止点，使得片段长度与新素材长度一致
- 新素材比原素材长，则裁剪素材范围，保持片段原长不变
具体的处理方式列表可参见枚举类ShrinkMode和ExtendMode的定义。
ℹ 目前已知替换带有组合出入场动画的片段不会自动刷新动画时间
替换文本片段的内容
这种方法将替换某个特定文本片段的内容，但保留其所有格式。
此过程同样分为选取轨道和替换内容两个步骤：其中“选取轨道”可参考根据片段替换素材中的示例。
以下假定我们已经选取了合适的文本轨道text_track，则只需：
script.replace_text(
text_track, 0, # 选取text_track中下标为0的片段，也即第一个片段
"新文本内容" # 新的文本内容
)
导入模板草稿中的轨道
此功能会字面意义地复制模板草稿中的指定轨道到新草稿中, 适合用于拼接多个模板草稿。
ℹ 目前仅支持导入音视频/文本轨道, 支持的范围将来会继续扩展
⚠️ 本方法会保留各片段及其素材的id, 因而不支持向同一草稿多次导入同一轨道
例如
source_script = draft_folder.load_template("<模板草稿名称>") # 加载模板草稿
target_script = draft_folder.create_draft("新草稿", 1920, 1080) # 创建新草稿
# 选取模板中的一个文本轨道
text_track = source_script.get_imported_track(
draft.TrackType.text, # 选取导入的文本轨道
#name="text", # 假如轨道有名称，最好利用名称来定位
index=0 # 也可用下标定位, 0表示最底层的同类型轨道
)
# 导入文本轨道到新草稿
target_script.import_track(
source_script, text_track,
offset=target_script.duration, # 导入的轨道将放在新草稿末尾
new_name="imported_text", # 可选的新轨道名
relative_index=1, # 相对于所有文本轨道的位置, 值越大越接近前景, 可以是负数
)
批量导出草稿
作为整个自动化流程中的最后一步，本项目提供了基础的草稿批量导出功能。
⚠️ 剪映7+版本对控件进行了隐藏，故本功能目前仅支持剪映6及以下版本
⚠️ 本部分功能依赖于
uiautomation库，故目前仅支持在Windows系统下运行
ℹ 导出程序会将剪映窗口置顶，且需要控制光标进行点击，建议在闲时/夜间运行
ℹ 本部分功能在剪映专业版5.9和6.8中测试通过
ℹ 有用户反映部分Python版本(如3.13)下
uiautomation会出现依赖问题, 推荐使用3.8、3.10或3.11, 详见此处
⚠️ 请确认有导出草稿的相关权限(不使用VIP功能或已开通VIP), 否则可能陷入死循环
导出利用JianyingController类进行，具体用法如下：
import pyJianYingDraft as draft
from pyJianYingDraft import ExportResolution, ExportFramerate
# 此前需要将剪映打开，并位于目录页
ctrl = draft.JianyingController()
# 然后即可导出指定名称的草稿, 注意导出结束后视频才会被剪切(重命名)至指定位置
ctrl.export_draft("要导出的草稿名称", "<导出路径>") # "导出路径"可以指向文件夹或直接指向文件
# 若希望调节分辨率或帧率, 可使用`resolution`和`framerate`参数
ctrl.export_draft("要导出的草稿名称", "<导出路径>",
resolution=ExportResolution.RES_1080P,
framerate=ExportFramerate.FR_24)
重复上述单次导出操作即可实现批量导出，类似如下代码：
draft_names = ...
export_folder = ...
for name in draft_names:
ctrl.export_draft(name, os.path.join(export_folder, name, ".mp4"))
时间与轨道
时间格式
剪映（和本项目）内部均采用微秒为单位保存时间，但这不便于输入，故我们增加了一种“字符串形式”的时间，大部分时间参数均同时支持这两种形式：
- 微秒形式：用
int表达，适于计算 - 字符串形式：用
str表达，如"1.5s"、"1h3m12s"等，易于输入
如果你希望显式地将字符串形式转换为微秒形式，可以使用tim函数；trange函数则是支持字符串形式输入的Timerange便捷构造函数。
⚠️ 注意
trange的第二个参数是持续时长，而不是结束时间
例如：
import pyJianYingDraft as draft
from pyJianYingDraft import SEC, tim, trange
# 1秒钟
assert 1000000 == SEC == tim("1s") == tim("0.01666667m")
# 0~1分钟
assert draft.Timerange(0, 60*SEC) == trange("0s", "1m") == trange("0s", "0.5m30s")
# 片段开始后2秒
seg: draft.VideoSegment
assert seg.target_timerange.start + 2*SEC == seg.target_timerange.start + tim("2s")
素材截取与整体变速
截取和变速均在Segment创建时设置完成，具体是通过target_timerange、source_timerange和speed参数来共同实现的。
ℹ 目前暂不支持设置曲线变速
以下以VideoSegment为例，AudioSegment的用法相同，此二者支持两种构造方式：
- 便捷构造：直接传入素材路径字符串，自动构造素材实例
- 传统构造：先创建素材实例，再传入片段构造函数。若需要设置素材的图像裁剪属性请使用此方式
import os
import pyJianYingDraft as draft
from pyJianYingDraft import trange, SEC
# 假定已有草稿文件script（参见“快速上手”），创建三个轨道
for i in range(3, 0, -1): # 倒序
script.add_track(draft.TrackType.video, "%d" % i)
# 以下部分讲解素材与片段的创建
# 方式一：便捷构造（推荐）
tutorial_asset_dir = os.path.join(os.path.dirname(__file__), 'readme_assets', 'tutorial')
video_path = os.path.join(tutorial_asset_dir, 'video.mp4')
# 直接传入素材路径
seg1 = draft.VideoSegment(video_path, trange("0s", "4s")) # 截取素材的前4秒
# 方式二：传统构造
mat = draft.VideoMaterial(video_path) # 先创建素材实例
seg2 = draft.VideoSegment(mat, trange("0s", "4s")) # 再传入片段构造函数
# 视频素材长度为 5s
print("Video material length: %f s" % (mat.duration / SEC))
# 以下部分讲解素材的时间截取与变速
# 不指定source_timerange，则自动从头截取素材等长片段
seg11 = draft.VideoSegment(video_path, trange("0s", "4s")) # 自动截取素材的前4秒（4s表示持续时长）
seg2 = draft.VideoSegment(video_path, trange("0s", "4s"), speed=1.25) # 自动截取素材的前4*1.25=5秒
seg4 = draft.VideoSegment(video_path, trange("0s", "3s"), speed=3.0) # 截取前3*3.0=9秒，素材不够长故报错
# 指定source_timerange，则截取素材的指定片段，自动设置速度
seg12 = draft.VideoSegment(video_path, trange("4s", "1s"),
source_timerange=trange(0, "4s")) # 将素材在1s内放完，速度自动设置为5.0
# 同时指定source_timerange和speed，则截取素材的指定片段，并根据播放速度覆盖target_timerange的duration
seg3 = draft.VideoSegment(video_path, trange("1s", "66666h"),
