magic_hour 0.9.5__py3-none-any.whl → 0.44.0__py3-none-any.whl

magic_hour/types/params/v1_auto_subtitle_generator_create_body.py

@@ -0,0 +1,78 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_auto_subtitle_generator_create_body_assets import (
+    V1AutoSubtitleGeneratorCreateBodyAssets,
+    _SerializerV1AutoSubtitleGeneratorCreateBodyAssets,
+)
+from .v1_auto_subtitle_generator_create_body_style import (
+    V1AutoSubtitleGeneratorCreateBodyStyle,
+    _SerializerV1AutoSubtitleGeneratorCreateBodyStyle,
+)
+
+
+class V1AutoSubtitleGeneratorCreateBody(typing_extensions.TypedDict):
+    """
+    V1AutoSubtitleGeneratorCreateBody
+    """
+
+    assets: typing_extensions.Required[V1AutoSubtitleGeneratorCreateBodyAssets]
+    """
+    Provide the assets for auto subtitle generator
+    """
+
+    end_seconds: typing_extensions.Required[float]
+    """
+    The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of video. This value is mainly used for your own identification of the video.
+    """
+
+    start_seconds: typing_extensions.Required[float]
+    """
+    The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.
+    """
+
+    style: typing_extensions.Required[V1AutoSubtitleGeneratorCreateBodyStyle]
+    """
+    Style of the subtitle. At least one of `.style.template` or `.style.custom_config` must be provided. 
+    * If only `.style.template` is provided, default values for the template will be used.
+    * If both are provided, the fields in `.style.custom_config` will be used to overwrite the fields in `.style.template`.
+    * If only `.style.custom_config` is provided, then all fields in `.style.custom_config` will be used.
+    
+    To use custom config only, the following `custom_config` params are required:
+    * `.style.custom_config.font`
+    * `.style.custom_config.text_color`
+    * `.style.custom_config.vertical_position`
+    * `.style.custom_config.horizontal_position`
+    
+    """
+
+
+class _SerializerV1AutoSubtitleGeneratorCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1AutoSubtitleGeneratorCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1AutoSubtitleGeneratorCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    end_seconds: float = pydantic.Field(
+        alias="end_seconds",
+    )
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    start_seconds: float = pydantic.Field(
+        alias="start_seconds",
+    )
+    style: _SerializerV1AutoSubtitleGeneratorCreateBodyStyle = pydantic.Field(
+        alias="style",
+    )

magic_hour/types/params/v1_auto_subtitle_generator_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1AutoSubtitleGeneratorCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for auto subtitle generator
+    """
+
+    video_file_path: typing_extensions.Required[str]
+    """
+    This is the video used to add subtitles. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1AutoSubtitleGeneratorCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1AutoSubtitleGeneratorCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    video_file_path: str = pydantic.Field(
+        alias="video_file_path",
+    )

magic_hour/types/params/v1_auto_subtitle_generator_create_body_style.py

@@ -0,0 +1,56 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_auto_subtitle_generator_create_body_style_custom_config import (
+    V1AutoSubtitleGeneratorCreateBodyStyleCustomConfig,
+    _SerializerV1AutoSubtitleGeneratorCreateBodyStyleCustomConfig,
+)
+
+
+class V1AutoSubtitleGeneratorCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    Style of the subtitle. At least one of `.style.template` or `.style.custom_config` must be provided.
+    * If only `.style.template` is provided, default values for the template will be used.
+    * If both are provided, the fields in `.style.custom_config` will be used to overwrite the fields in `.style.template`.
+    * If only `.style.custom_config` is provided, then all fields in `.style.custom_config` will be used.
+
+    To use custom config only, the following `custom_config` params are required:
+    * `.style.custom_config.font`
+    * `.style.custom_config.text_color`
+    * `.style.custom_config.vertical_position`
+    * `.style.custom_config.horizontal_position`
+
+    """
+
+    custom_config: typing_extensions.NotRequired[
+        V1AutoSubtitleGeneratorCreateBodyStyleCustomConfig
+    ]
+    """
+    Custom subtitle configuration.
+    """
+
+    template: typing_extensions.NotRequired[
+        typing_extensions.Literal["cinematic", "highlight", "karaoke", "minimalist"]
+    ]
+    """
+    Preset subtitle templates. Please visit https://magichour.ai/create/auto-subtitle-generator to see the style of the existing templates.
+    """
+
+
+class _SerializerV1AutoSubtitleGeneratorCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1AutoSubtitleGeneratorCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    custom_config: typing.Optional[
+        _SerializerV1AutoSubtitleGeneratorCreateBodyStyleCustomConfig
+    ] = pydantic.Field(alias="custom_config", default=None)
+    template: typing.Optional[
+        typing_extensions.Literal["cinematic", "highlight", "karaoke", "minimalist"]
+    ] = pydantic.Field(alias="template", default=None)

magic_hour/types/params/v1_auto_subtitle_generator_create_body_style_custom_config.py

@@ -0,0 +1,86 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1AutoSubtitleGeneratorCreateBodyStyleCustomConfig(typing_extensions.TypedDict):
+    """
+    Custom subtitle configuration.
+    """
+
+    font: typing_extensions.NotRequired[str]
+    """
+    Font name from Google Fonts. Not all fonts support all languages or character sets. 
+    We recommend verifying language support and appearance directly on https://fonts.google.com before use.
+    """
+
+    font_size: typing_extensions.NotRequired[float]
+    """
+    Font size in pixels. If not provided, the font size is automatically calculated based on the video resolution.
+    """
+
+    font_style: typing_extensions.NotRequired[str]
+    """
+    Font style (e.g., normal, italic, bold)
+    """
+
+    highlighted_text_color: typing_extensions.NotRequired[str]
+    """
+    Color used to highlight the current spoken text
+    """
+
+    horizontal_position: typing_extensions.NotRequired[str]
+    """
+    Horizontal alignment of the text (e.g., left, center, right)
+    """
+
+    stroke_color: typing_extensions.NotRequired[str]
+    """
+    Stroke (outline) color of the text
+    """
+
+    stroke_width: typing_extensions.NotRequired[float]
+    """
+    Width of the text stroke in pixels. If `stroke_color` is provided, but `stroke_width` is not, the `stroke_width` will be calculated automatically based on the font size.
+    """
+
+    text_color: typing_extensions.NotRequired[str]
+    """
+    Primary text color in hex format
+    """
+
+    vertical_position: typing_extensions.NotRequired[str]
+    """
+    Vertical alignment of the text (e.g., top, center, bottom)
+    """
+
+
+class _SerializerV1AutoSubtitleGeneratorCreateBodyStyleCustomConfig(pydantic.BaseModel):
+    """
+    Serializer for V1AutoSubtitleGeneratorCreateBodyStyleCustomConfig handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    font: typing.Optional[str] = pydantic.Field(alias="font", default=None)
+    font_size: typing.Optional[float] = pydantic.Field(alias="font_size", default=None)
+    font_style: typing.Optional[str] = pydantic.Field(alias="font_style", default=None)
+    highlighted_text_color: typing.Optional[str] = pydantic.Field(
+        alias="highlighted_text_color", default=None
+    )
+    horizontal_position: typing.Optional[str] = pydantic.Field(
+        alias="horizontal_position", default=None
+    )
+    stroke_color: typing.Optional[str] = pydantic.Field(
+        alias="stroke_color", default=None
+    )
+    stroke_width: typing.Optional[float] = pydantic.Field(
+        alias="stroke_width", default=None
+    )
+    text_color: typing.Optional[str] = pydantic.Field(alias="text_color", default=None)
+    vertical_position: typing.Optional[str] = pydantic.Field(
+        alias="vertical_position", default=None
+    )

magic_hour/types/params/v1_auto_subtitle_generator_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1AutoSubtitleGeneratorGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for auto subtitle generator
+    """
+
+    video_file_path: typing_extensions.Required[str]
+    """
+    This is the video used to add subtitles. This value is either
+    - a direct URL to the video file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/v1_face_detection_create_body.py

@@ -0,0 +1,44 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_detection_create_body_assets import (
+    V1FaceDetectionCreateBodyAssets,
+    _SerializerV1FaceDetectionCreateBodyAssets,
+)
+
+
+class V1FaceDetectionCreateBody(typing_extensions.TypedDict):
+    """
+    V1FaceDetectionCreateBody
+    """
+
+    assets: typing_extensions.Required[V1FaceDetectionCreateBodyAssets]
+    """
+    Provide the assets for face detection
+    """
+
+    confidence_score: typing_extensions.NotRequired[float]
+    """
+    Confidence threshold for filtering detected faces. 
+    * Higher values (e.g., 0.9) include only faces detected with high certainty, reducing false positives. 
+    * Lower values (e.g., 0.3) include more faces, but may increase the chance of incorrect detections.
+    """
+
+
+class _SerializerV1FaceDetectionCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1FaceDetectionCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1FaceDetectionCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    confidence_score: typing.Optional[float] = pydantic.Field(
+        alias="confidence_score", default=None
+    )

magic_hour/types/params/v1_face_detection_create_body_assets.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceDetectionCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face detection
+    """
+
+    target_file_path: typing_extensions.Required[str]
+    """
+    This is the image or video where the face will be detected. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+
+class _SerializerV1FaceDetectionCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1FaceDetectionCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    target_file_path: str = pydantic.Field(
+        alias="target_file_path",
+    )

magic_hour/types/params/v1_face_detection_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceDetectionGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face detection
+    """
+
+    target_file_path: typing_extensions.Required[str]
+    """
+    This is the image or video where the face will be detected. This value is either
+    - a direct URL to the image file
+    - a path to a local file
+
+    Note: if the path begins with `api-assets`, it will be assumed to already be uploaded to Magic Hour's storage, and will not be uploaded again.
+    """

magic_hour/types/params/v1_face_swap_create_body.py

@@ -0,0 +1,92 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_create_body_assets import (
+    V1FaceSwapCreateBodyAssets,
+    _SerializerV1FaceSwapCreateBodyAssets,
+)
+from .v1_face_swap_create_body_style import (
+    V1FaceSwapCreateBodyStyle,
+    _SerializerV1FaceSwapCreateBodyStyle,
+)
+
+
+class V1FaceSwapCreateBody(typing_extensions.TypedDict):
+    """
+    V1FaceSwapCreateBody
+    """
+
+    assets: typing_extensions.Required[V1FaceSwapCreateBodyAssets]
+    """
+    Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    end_seconds: typing_extensions.Required[float]
+    """
+    The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.
+    """
+
+    height: typing_extensions.NotRequired[typing.Optional[int]]
+    """
+    `height` is deprecated and no longer influences the output video's resolution.
+    
+    Output resolution is determined by the **minimum** of:
+    - The resolution of the input video
+    - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
+    
+    This field is retained only for backward compatibility and will be removed in a future release.
+    """
+
+    name: typing_extensions.NotRequired[str]
+    """
+    The name of video. This value is mainly used for your own identification of the video.
+    """
+
+    start_seconds: typing_extensions.Required[float]
+    """
+    The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.
+    """
+
+    style: typing_extensions.NotRequired[V1FaceSwapCreateBodyStyle]
+    """
+    Style of the face swap video.
+    """
+
+    width: typing_extensions.NotRequired[typing.Optional[int]]
+    """
+    `width` is deprecated and no longer influences the output video's resolution.
+    
+    Output resolution is determined by the **minimum** of:
+    - The resolution of the input video
+    - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
+    
+    This field is retained only for backward compatibility and will be removed in a future release.
+    """
+
+
+class _SerializerV1FaceSwapCreateBody(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapCreateBody handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    assets: _SerializerV1FaceSwapCreateBodyAssets = pydantic.Field(
+        alias="assets",
+    )
+    end_seconds: float = pydantic.Field(
+        alias="end_seconds",
+    )
+    height: typing.Optional[int] = pydantic.Field(alias="height", default=None)
+    name: typing.Optional[str] = pydantic.Field(alias="name", default=None)
+    start_seconds: float = pydantic.Field(
+        alias="start_seconds",
+    )
+    style: typing.Optional[_SerializerV1FaceSwapCreateBodyStyle] = pydantic.Field(
+        alias="style", default=None
+    )
+    width: typing.Optional[int] = pydantic.Field(alias="width", default=None)

magic_hour/types/params/v1_face_swap_create_body_assets.py

@@ -0,0 +1,91 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_create_body_assets_face_mappings_item import (
+    V1FaceSwapCreateBodyAssetsFaceMappingsItem,
+    _SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem,
+)
+
+
+class V1FaceSwapCreateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face swap. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    face_mappings: typing_extensions.NotRequired[
+        typing.List[V1FaceSwapCreateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    This is the array of face mappings used for multiple face swap. The value is required if `face_swap_mode` is `individual-faces`.
+    """
+
+    face_swap_mode: typing_extensions.NotRequired[
+        typing_extensions.Literal["all-faces", "individual-faces"]
+    ]
+    """
+    The mode of face swap.
+    * `all-faces` - Swap all faces in the target image or video. `source_file_path` is required.
+    * `individual-faces` - Swap individual faces in the target image or video. `source_faces` is required.
+    """
+
+    image_file_path: typing_extensions.NotRequired[str]
+    """
+    The path of the input image with the face to be swapped.  The value is required if `face_swap_mode` is `all-faces`.
+    
+    This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+    video_file_path: typing_extensions.NotRequired[str]
+    """
+    Required if `video_source` is `file`. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+    video_source: typing_extensions.Required[
+        typing_extensions.Literal["file", "youtube"]
+    ]
+
+    youtube_url: typing_extensions.NotRequired[str]
+    """
+    Using a youtube video as the input source. This field is required if `video_source` is `youtube`
+    """
+
+
+class _SerializerV1FaceSwapCreateBodyAssets(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapCreateBodyAssets handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    face_mappings: typing.Optional[
+        typing.List[_SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem]
+    ] = pydantic.Field(alias="face_mappings", default=None)
+    face_swap_mode: typing.Optional[
+        typing_extensions.Literal["all-faces", "individual-faces"]
+    ] = pydantic.Field(alias="face_swap_mode", default=None)
+    image_file_path: typing.Optional[str] = pydantic.Field(
+        alias="image_file_path", default=None
+    )
+    video_file_path: typing.Optional[str] = pydantic.Field(
+        alias="video_file_path", default=None
+    )
+    video_source: typing_extensions.Literal["file", "youtube"] = pydantic.Field(
+        alias="video_source",
+    )
+    youtube_url: typing.Optional[str] = pydantic.Field(
+        alias="youtube_url", default=None
+    )

magic_hour/types/params/v1_face_swap_create_body_assets_face_mappings_item.py

@@ -0,0 +1,44 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapCreateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapCreateBodyAssetsFaceMappingsItem
+    """
+
+    new_face: typing_extensions.Required[str]
+    """
+    The face image that will be used to replace the face in the `original_face`. This value is either
+    - a direct URL to the video file
+    - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).
+    
+    Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.
+    
+    """
+
+    original_face: typing_extensions.Required[str]
+    """
+    The face detected from the image in `target_file_path`. The file name is in the format of `<face_frame>-<face_index>.png`. This value is corresponds to the response in the [face detection API](https://docs.magichour.ai/api-reference/files/get-face-detection-details).
+    
+    * The face_frame is the frame number of the face in the target image. For images, the frame number is always 0.
+    * The face_index is the index of the face in the target image, starting from 0 going left to right.
+    """
+
+
+class _SerializerV1FaceSwapCreateBodyAssetsFaceMappingsItem(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapCreateBodyAssetsFaceMappingsItem handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    new_face: str = pydantic.Field(
+        alias="new_face",
+    )
+    original_face: str = pydantic.Field(
+        alias="original_face",
+    )

magic_hour/types/params/v1_face_swap_create_body_style.py

@@ -0,0 +1,33 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1FaceSwapCreateBodyStyle(typing_extensions.TypedDict):
+    """
+    Style of the face swap video.
+    """
+
+    version: typing_extensions.NotRequired[
+        typing_extensions.Literal["default", "v1", "v2"]
+    ]
+    """
+    * `v1` - May preserve skin detail and texture better, but weaker identity preservation.
+    * `v2` - Faster, sharper, better handling of hair and glasses. stronger identity preservation.
+    * `default` - Use the version we recommend, which will change over time. This is recommended unless you need a specific earlier version. This is the default behavior.
+    """
+
+
+class _SerializerV1FaceSwapCreateBodyStyle(pydantic.BaseModel):
+    """
+    Serializer for V1FaceSwapCreateBodyStyle handling case conversions
+    and file omissions as dictated by the API
+    """
+
+    model_config = pydantic.ConfigDict(
+        populate_by_name=True,
+    )
+
+    version: typing.Optional[typing_extensions.Literal["default", "v1", "v2"]] = (
+        pydantic.Field(alias="version", default=None)
+    )