pycapcut 0.0.1__py3-none-any.whl

pyJianYingDraft/jianying_controller.py

@@ -0,0 +1,230 @@
+"""剪映自动化控制，主要与自动导出有关"""
+
+import time
+import shutil
+import uiautomation as uia
+
+from enum import Enum
+from typing import Optional, Literal, Callable
+
+from . import exceptions
+from .exceptions import AutomationError
+
+class ExportResolution(Enum):
+    """导出分辨率"""
+    RES_8K = "8K"
+    RES_4K = "4K"
+    RES_2K = "2K"
+    RES_1080P = "1080P"
+    RES_720P = "720P"
+    RES_480P = "480P"
+
+class ExportFramerate(Enum):
+    """导出帧率"""
+    FR_24 = "24fps"
+    FR_25 = "25fps"
+    FR_30 = "30fps"
+    FR_50 = "50fps"
+    FR_60 = "60fps"
+
+class ControlFinder:
+    """控件查找器，封装部分与控件查找相关的逻辑"""
+
+    @staticmethod
+    def desc_matcher(target_desc: str, depth: int = 2, exact: bool = False) -> Callable[[uia.Control, int], bool]:
+        """根据full_description查找控件的匹配器"""
+        target_desc = target_desc.lower()
+        def matcher(control: uia.Control, _depth: int) -> bool:
+            if _depth != depth:
+                return False
+            full_desc: str = control.GetPropertyValue(30159).lower()
+            return (target_desc == full_desc) if exact else (target_desc in full_desc)
+        return matcher
+
+    @staticmethod
+    def class_name_matcher(class_name: str, depth: int = 1, exact: bool = False) -> Callable[[uia.Control, int], bool]:
+        """根据ClassName查找控件的匹配器"""
+        class_name = class_name.lower()
+        def matcher(control: uia.Control, _depth: int) -> bool:
+            if _depth != depth:
+                return False
+            curr_class_name: str = control.ClassName.lower()
+            return (class_name == curr_class_name) if exact else (class_name in curr_class_name)
+        return matcher
+
+class JianyingController:
+    """剪映控制器"""
+
+    app: uia.WindowControl
+    """剪映窗口"""
+    app_status: Literal["home", "edit", "pre_export"]
+
+    def __init__(self):
+        """初始化剪映控制器, 此时剪映应该处于目录页"""
+        self.get_window()
+
+    def export_draft(self, draft_name: str, output_path: Optional[str] = None, *,
+                     resolution: Optional[ExportResolution] = None,
+                     framerate: Optional[ExportFramerate] = None,
+                     timeout: float = 1200) -> None:
+        """导出指定的剪映草稿, **目前仅支持剪映6及以下版本**
+
+        **注意: 需要确认有导出草稿的权限(不使用VIP功能或已开通VIP), 否则可能陷入死循环**
+
+        Args:
+            draft_name (`str`): 要导出的剪映草稿名称
+            output_path (`str`, optional): 导出路径, 支持指向文件夹或直接指向文件, 不指定则使用剪映默认路径.
+            resolution (`Export_resolution`, optional): 导出分辨率, 默认不改变剪映导出窗口中的设置.
+            framerate (`Export_framerate`, optional): 导出帧率, 默认不改变剪映导出窗口中的设置.
+            timeout (`float`, optional): 导出超时时间(秒), 默认为20分钟.
+
+        Raises:
+            `DraftNotFound`: 未找到指定名称的剪映草稿
+            `AutomationError`: 剪映操作失败
+        """
+        print(f"开始导出 {draft_name} 至 {output_path}")
+        self.get_window()
+        self.switch_to_home()
+
+        # 点击对应草稿
+        draft_name_text = self.app.TextControl(
+            searchDepth=2,
+            Compare=ControlFinder.desc_matcher(f"HomePageDraftTitle:{draft_name}", exact=True)
+        )
+        if not draft_name_text.Exists(0):
+            raise exceptions.DraftNotFound(f"未找到名为{draft_name}的剪映草稿")
+        draft_btn = draft_name_text.GetParentControl()
+        assert draft_btn is not None
+        draft_btn.Click(simulateMove=False)
+        time.sleep(10)
+        self.get_window()
+
+        # 点击导出按钮
+        export_btn = self.app.TextControl(searchDepth=2, Compare=ControlFinder.desc_matcher("MainWindowTitleBarExportBtn"))
+        if not export_btn.Exists(0):
+            raise AutomationError("未在编辑窗口中找到导出按钮")
+        export_btn.Click(simulateMove=False)
+        time.sleep(10)
+        self.get_window()
+
+        # 获取原始导出路径（带后缀名）
+        export_path_sib = self.app.TextControl(searchDepth=2, Compare=ControlFinder.desc_matcher("ExportPath"))
+        if not export_path_sib.Exists(0):
+            raise AutomationError("未找到导出路径框")
+        export_path_text = export_path_sib.GetSiblingControl(lambda ctrl: True)
+        assert export_path_text is not None
+        export_path = export_path_text.GetPropertyValue(30159)
+
+        # 设置分辨率
+        if resolution is not None:
+            setting_group = self.app.GroupControl(searchDepth=1,
+                                                  Compare=ControlFinder.class_name_matcher("PanelSettingsGroup_QMLTYPE"))
+            if not setting_group.Exists(0):
+                raise AutomationError("未找到导出设置组")
+            resolution_btn = setting_group.TextControl(searchDepth=2, Compare=ControlFinder.desc_matcher("ExportSharpnessInput"))
+            if not resolution_btn.Exists(0.5):
+                raise AutomationError("未找到导出分辨率下拉框")
+            resolution_btn.Click(simulateMove=False)
+            time.sleep(0.5)
+            resolution_item = self.app.TextControl(
+                searchDepth=2, Compare=ControlFinder.desc_matcher(resolution.value)
+            )
+            if not resolution_item.Exists(0.5):
+                raise AutomationError(f"未找到{resolution.value}分辨率选项")
+            resolution_item.Click(simulateMove=False)
+            time.sleep(0.5)
+
+        # 设置帧率
+        if framerate is not None:
+            setting_group = self.app.GroupControl(searchDepth=1,
+                                                  Compare=ControlFinder.class_name_matcher("PanelSettingsGroup_QMLTYPE"))
+            if not setting_group.Exists(0):
+                raise AutomationError("未找到导出设置组")
+            framerate_btn = setting_group.TextControl(searchDepth=2, Compare=ControlFinder.desc_matcher("FrameRateInput"))
+            if not framerate_btn.Exists(0.5):
+                raise AutomationError("未找到导出帧率下拉框")
+            framerate_btn.Click(simulateMove=False)
+            time.sleep(0.5)
+            framerate_item = self.app.TextControl(
+                searchDepth=2, Compare=ControlFinder.desc_matcher(framerate.value)
+            )
+            if not framerate_item.Exists(0.5):
+                raise AutomationError(f"未找到{framerate.value}帧率选项")
+            framerate_item.Click(simulateMove=False)
+            time.sleep(0.5)
+
+
+        # 点击导出
+        export_btn = self.app.TextControl(searchDepth=2, Compare=ControlFinder.desc_matcher("ExportOkBtn", exact=True))
+        if not export_btn.Exists(0):
+            raise AutomationError("未在导出窗口中找到导出按钮")
+        export_btn.Click(simulateMove=False)
+        time.sleep(5)
+
+        # 等待导出完成
+        st = time.time()
+        while True:
+            self.get_window()
+            if self.app_status != "pre_export": continue
+
+            succeed_close_btn = self.app.TextControl(searchDepth=2, Compare=ControlFinder.desc_matcher("ExportSucceedCloseBtn"))
+            if succeed_close_btn.Exists(0):
+                succeed_close_btn.Click(simulateMove=False)
+                break
+
+            if time.time() - st > timeout:
+                raise AutomationError("导出超时, 时限为%d秒" % timeout)
+
+            time.sleep(1)
+        time.sleep(2)
+
+        # 回到目录页
+        self.get_window()
+        self.switch_to_home()
+        time.sleep(2)
+
+        # 复制导出的文件到指定目录
+        if output_path is not None:
+            shutil.move(export_path, output_path)
+
+        print(f"导出 {draft_name} 至 {output_path} 完成")
+
+    def switch_to_home(self) -> None:
+        """切换到剪映主页"""
+        if self.app_status == "home":
+            return
+        if self.app_status != "edit":
+            raise AutomationError("仅支持从编辑模式切换到主页")
+        close_btn = self.app.GroupControl(searchDepth=1, ClassName="TitleBarButton", foundIndex=3)
+        close_btn.Click(simulateMove=False)
+        time.sleep(2)
+        self.get_window()
+
+    def get_window(self) -> None:
+        """寻找剪映窗口并置顶"""
+        if hasattr(self, "app") and self.app.Exists(0):
+            self.app.SetTopmost(False)
+
+        self.app = uia.WindowControl(searchDepth=1, Compare=self.__jianying_window_cmp)
+        if not self.app.Exists(0):
+            raise AutomationError("剪映窗口未找到")
+
+        # 寻找可能存在的导出窗口
+        export_window = self.app.WindowControl(searchDepth=1, Name="导出")
+        if export_window.Exists(0):
+            self.app = export_window
+            self.app_status = "pre_export"
+
+        self.app.SetActive()
+        self.app.SetTopmost()
+
+    def __jianying_window_cmp(self, control: uia.WindowControl, depth: int) -> bool:
+        if control.Name != "剪映专业版":
+            return False
+        if "HomePage".lower() in control.ClassName.lower():
+            self.app_status = "home"
+            return True
+        if "MainWindow".lower() in control.ClassName.lower():
+            self.app_status = "edit"
+            return True
+        return False

pyJianYingDraft/keyframe.py

@@ -0,0 +1,94 @@
+import uuid
+
+from enum import Enum
+from typing import Dict, List, Any
+
+class Keyframe:
+    """一个关键帧（关键点）, 目前只支持线性插值"""
+
+    kf_id: str
+    """关键帧全局id, 自动生成"""
+    time_offset: int
+    """相对于素材起始点的时间偏移量"""
+    values: List[float]
+    """关键帧的值, 似乎一般只有一个元素"""
+
+    def __init__(self, time_offset: int, value: float):
+        """给定时间偏移量及关键值, 初始化关键帧"""
+        self.kf_id = uuid.uuid4().hex
+
+        self.time_offset = time_offset
+        self.values = [value]
+
+    def export_json(self) -> Dict[str, Any]:
+        return {
+            # 默认值
+            "curveType": "Line",
+            "graphID": "",
+            "left_control": {"x": 0.0, "y": 0.0},
+            "right_control": {"x": 0.0, "y": 0.0},
+            # 自定义属性
+            "id": self.kf_id,
+            "time_offset": self.time_offset,
+            "values": self.values
+        }
+
+class KeyframeProperty(Enum):
+    """关键帧所控制的属性类型"""
+
+    position_x = "KFTypePositionX"
+    """右移为正, 此处的数值应该为`剪映中显示的值` / `草稿宽度`, 也即单位是半个画布宽"""
+    position_y = "KFTypePositionY"
+    """上移为正, 此处的数值应该为`剪映中显示的值` / `草稿高度`, 也即单位是半个画布高"""
+    rotation = "KFTypeRotation"
+    """顺时针旋转的**角度**"""
+
+    scale_x = "KFTypeScaleX"
+    """单独控制X轴缩放比例(1.0为不缩放), 与`uniform_scale`互斥"""
+    scale_y = "KFTypeScaleY"
+    """单独控制Y轴缩放比例(1.0为不缩放), 与`uniform_scale`互斥"""
+    uniform_scale = "UNIFORM_SCALE"
+    """同时控制X轴及Y轴缩放比例(1.0为不缩放), 与`scale_x`和`scale_y`互斥"""
+
+    alpha = "KFTypeAlpha"
+    """不透明度, 1.0为完全不透明, 仅对`VideoSegment`有效"""
+    saturation = "KFTypeSaturation"
+    """饱和度, 0.0为原始饱和度, 范围为-1.0到1.0, 仅对`VideoSegment`有效"""
+    contrast = "KFTypeContrast"
+    """对比度, 0.0为原始对比度, 范围为-1.0到1.0, 仅对`VideoSegment`有效"""
+    brightness = "KFTypeBrightness"
+    """亮度, 0.0为原始亮度, 范围为-1.0到1.0, 仅对`VideoSegment`有效"""
+
+    volume = "KFTypeVolume"
+    """音量, 1.0为原始音量, 仅对`AudioSegment`和`VideoSegment`有效"""
+
+class KeyframeList:
+    """关键帧列表, 记录与某个特定属性相关的一系列关键帧"""
+
+    list_id: str
+    """关键帧列表全局id, 自动生成"""
+    keyframe_property: KeyframeProperty
+    """关键帧对应的属性"""
+    keyframes: List[Keyframe]
+    """关键帧列表"""
+
+    def __init__(self, keyframe_property: KeyframeProperty):
+        """为给定的关键帧属性初始化关键帧列表"""
+        self.list_id = uuid.uuid4().hex
+
+        self.keyframe_property = keyframe_property
+        self.keyframes = []
+
+    def add_keyframe(self, time_offset: int, value: float):
+        """给定时间偏移量及关键值, 向此关键帧列表中添加一个关键帧"""
+        keyframe = Keyframe(time_offset, value)
+        self.keyframes.append(keyframe)
+        self.keyframes.sort(key=lambda x: x.time_offset)
+
+    def export_json(self) -> Dict[str, Any]:
+        return {
+            "id": self.list_id,
+            "keyframe_list": [kf.export_json() for kf in self.keyframes],
+            "material_id": "",
+            "property_type": self.keyframe_property.value
+        }

pyJianYingDraft/local_materials.py

@@ -0,0 +1,198 @@
+import os
+import uuid
+import pymediainfo
+
+from typing import Optional, Literal
+from typing import Dict, Any
+
+class CropSettings:
+    """素材的裁剪设置, 各属性均在0-1之间, 注意素材的坐标原点在左上角"""
+
+    upper_left_x: float
+    upper_left_y: float
+    upper_right_x: float
+    upper_right_y: float
+    lower_left_x: float
+    lower_left_y: float
+    lower_right_x: float
+    lower_right_y: float
+
+    def __init__(self, *, upper_left_x: float = 0.0, upper_left_y: float = 0.0,
+                 upper_right_x: float = 1.0, upper_right_y: float = 0.0,
+                 lower_left_x: float = 0.0, lower_left_y: float = 1.0,
+                 lower_right_x: float = 1.0, lower_right_y: float = 1.0):
+        """初始化裁剪设置, 默认参数表示不裁剪"""
+        self.upper_left_x = upper_left_x
+        self.upper_left_y = upper_left_y
+        self.upper_right_x = upper_right_x
+        self.upper_right_y = upper_right_y
+        self.lower_left_x = lower_left_x
+        self.lower_left_y = lower_left_y
+        self.lower_right_x = lower_right_x
+        self.lower_right_y = lower_right_y
+
+    def export_json(self) -> Dict[str, Any]:
+        return {
+            "upper_left_x": self.upper_left_x,
+            "upper_left_y": self.upper_left_y,
+            "upper_right_x": self.upper_right_x,
+            "upper_right_y": self.upper_right_y,
+            "lower_left_x": self.lower_left_x,
+            "lower_left_y": self.lower_left_y,
+            "lower_right_x": self.lower_right_x,
+            "lower_right_y": self.lower_right_y
+        }
+
+class VideoMaterial:
+    """本地视频素材（视频或图片）, 一份素材可以在多个片段中使用"""
+
+    material_id: str
+    """素材全局id, 自动生成"""
+    local_material_id: str
+    """素材本地id, 意义暂不明确"""
+    material_name: str
+    """素材名称"""
+    path: str
+    """素材文件路径"""
+    duration: int
+    """素材时长, 单位为微秒"""
+    height: int
+    """素材高度"""
+    width: int
+    """素材宽度"""
+    crop_settings: CropSettings
+    """素材裁剪设置"""
+    material_type: Literal["video", "photo"]
+    """素材类型: 视频或图片"""
+
+    def __init__(self, path: str, material_name: Optional[str] = None, crop_settings: CropSettings = CropSettings()):
+        """从指定位置加载视频（或图片）素材
+
+        Args:
+            path (`str`): 素材文件路径, 支持mp4, mov, avi等常见视频文件及jpg, jpeg, png等图片文件.
+            material_name (`str`, optional): 素材名称, 如果不指定, 默认使用文件名作为素材名称.
+            crop_settings (`CropSettings`, optional): 素材裁剪设置, 默认不裁剪.
+
+        Raises:
+            `FileNotFoundError`: 素材文件不存在.
+            `ValueError`: 不支持的素材文件类型.
+        """
+        path = os.path.abspath(path)
+        postfix = os.path.splitext(path)[1]
+        if not os.path.exists(path):
+            raise FileNotFoundError(f"找不到 {path}")
+
+        self.material_name = material_name if material_name else os.path.basename(path)
+        self.material_id = uuid.uuid3(uuid.NAMESPACE_DNS, self.material_name).hex
+        self.path = path
+        self.crop_settings = crop_settings
+        self.local_material_id = ""
+
+        if not pymediainfo.MediaInfo.can_parse():
+            raise ValueError(f"不支持的视频素材类型 '{postfix}'")
+
+        info: pymediainfo.MediaInfo = \
+            pymediainfo.MediaInfo.parse(path, mediainfo_options={"File_TestContinuousFileNames": "0"})  # type: ignore
+        # 有视频轨道的视为视频素材
+        if len(info.video_tracks):
+            self.material_type = "video"
+            self.duration = int(info.video_tracks[0].duration * 1e3)  # type: ignore
+            self.width, self.height = info.video_tracks[0].width, info.video_tracks[0].height  # type: ignore
+        # gif文件使用imageio库获取长度
+        elif postfix.lower() == ".gif":
+            import imageio
+            gif = imageio.get_reader(path)
+
+            self.material_type = "video"
+            self.duration = int(round(gif.get_meta_data()['duration'] * gif.get_length() * 1e3))
+            self.width, self.height = info.image_tracks[0].width, info.image_tracks[0].height  # type: ignore
+            gif.close()
+        elif len(info.image_tracks):
+            self.material_type = "photo"
+            self.duration = 10800000000  # 相当于3h
+            self.width, self.height = info.image_tracks[0].width, info.image_tracks[0].height  # type: ignore
+        else:
+            raise ValueError(f"输入的素材文件 {path} 没有视频轨道或图片轨道")
+
+    def export_json(self) -> Dict[str, Any]:
+        video_material_json = {
+            "audio_fade": None,
+            "category_id": "",
+            "category_name": "local",
+            "check_flag": 63487,
+            "crop": self.crop_settings.export_json(),
+            "crop_ratio": "free",
+            "crop_scale": 1.0,
+            "duration": self.duration,
+            "height": self.height,
+            "id": self.material_id,
+            "local_material_id": self.local_material_id,
+            "material_id": self.material_id,
+            "material_name": self.material_name,
+            "media_path": "",
+            "path": self.path,
+            "type": self.material_type,
+            "width": self.width
+        }
+        return video_material_json
+
+class AudioMaterial:
+    """本地音频素材"""
+
+    material_id: str
+    """素材全局id, 自动生成"""
+    material_name: str
+    """素材名称"""
+    path: str
+    """素材文件路径"""
+
+    duration: int
+    """素材时长, 单位为微秒"""
+
+    def __init__(self, path: str, material_name: Optional[str] = None):
+        """从指定位置加载音频素材, 注意视频文件不应该作为音频素材使用
+
+        Args:
+            path (`str`): 素材文件路径, 支持mp3, wav等常见音频文件.
+            material_name (`str`, optional): 素材名称, 如果不指定, 默认使用文件名作为素材名称.
+
+        Raises:
+            `FileNotFoundError`: 素材文件不存在.
+            `ValueError`: 不支持的素材文件类型.
+        """
+        path = os.path.abspath(path)
+        if not os.path.exists(path):
+            raise FileNotFoundError(f"找不到 {path}")
+
+        self.material_name = material_name if material_name else os.path.basename(path)
+        self.material_id = uuid.uuid3(uuid.NAMESPACE_DNS, self.material_name).hex
+        self.path = path
+
+        if not pymediainfo.MediaInfo.can_parse():
+            raise ValueError("不支持的音频素材类型 %s" % os.path.splitext(path)[1])
+        info: pymediainfo.MediaInfo = pymediainfo.MediaInfo.parse(path)  # type: ignore
+        if len(info.video_tracks):
+            raise ValueError("音频素材不应包含视频轨道")
+        if not len(info.audio_tracks):
+            raise ValueError(f"给定的素材文件 {path} 没有音频轨道")
+        self.duration = int(info.audio_tracks[0].duration * 1e3)  # type: ignore
+
+    def export_json(self) -> Dict[str, Any]:
+        return {
+            "app_id": 0,
+            "category_id": "",
+            "category_name": "local",
+            "check_flag": 3,
+            "copyright_limit_type": "none",
+            "duration": self.duration,
+            "effect_id": "",
+            "formula_id": "",
+            "id": self.material_id,
+            "local_material_id": self.material_id,
+            "music_id": self.material_id,
+            "name": self.material_name,
+            "path": self.path,
+            "source_platform": 0,
+            "type": "extract_music",
+            "wave_points": []
+        }

pyJianYingDraft/metadata/__init__.py

@@ -0,0 +1,51 @@
+"""记录各种特效/音效/滤镜等的元数据"""
+
+from .effect_meta import EffectMeta, EffectParamInstance
+from .effect_meta import AnimationMeta
+
+# 视频特效
+from .video_scene_effect import VideoSceneEffectType
+from .video_character_effect import VideoCharacterEffectType
+
+# 视频动画
+from .video_intro import IntroType
+from .video_outro import OutroType
+from .video_group_animation import GroupAnimationType
+
+# 音频特效
+from .audio_scene_effect import AudioSceneEffectType
+from .tone_effect import ToneEffectType
+from .speech_to_song import SpeechToSongType
+
+# 文本动画
+from .text_intro import TextIntro
+from .text_outro import TextOutro
+from .text_loop import TextLoopAnim
+
+# 其它
+from .font_meta import FontType
+from .mask_meta import MaskType, MaskMeta
+from .filter_meta import FilterType
+from .transition_meta import TransitionType
+
+__all__ = [
+    "AnimationMeta",
+    "EffectMeta",
+    "EffectParamInstance",
+    "MaskType",
+    "MaskMeta",
+    "FilterType",
+    "FontType",
+    "TransitionType",
+    "IntroType",
+    "OutroType",
+    "GroupAnimationType",
+    "TextIntro",
+    "TextOutro",
+    "TextLoopAnim",
+    "AudioSceneEffectType",
+    "ToneEffectType",
+    "SpeechToSongType",
+    "VideoSceneEffectType",
+    "VideoCharacterEffectType"
+]