magic_hour 0.35.0__py3-none-any.whl → 0.36.1__py3-none-any.whl

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_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

@@ -6,6 +6,10 @@ 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):
@@ -44,6 +48,11 @@ class V1FaceSwapCreateBody(typing_extensions.TypedDict):
     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.
@@ -77,4 +86,7 @@ class _SerializerV1FaceSwapCreateBody(pydantic.BaseModel):
     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_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. (Recommended)
+    * `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)
+    )

magic_hour/types/params/v1_face_swap_generate_body_assets.py

@@ -0,0 +1,56 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_generate_body_assets_face_mappings_item import (
+    V1FaceSwapGenerateBodyAssetsFaceMappingsItem,
+)
+
+
+class V1FaceSwapGenerateBodyAssets(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[V1FaceSwapGenerateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    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 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.
+    """
+
+    video_file_path: typing_extensions.NotRequired[str]
+    """
+    Required if `video_source` is `file`. 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.
+    """
+
+    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`
+    """

magic_hour/types/params/v1_face_swap_generate_body_assets_face_mappings_item.py

@@ -0,0 +1,25 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapGenerateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapGenerateBodyAssetsFaceMappingsItem
+    """
+
+    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 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.
+    """
+
+    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.
+    """

magic_hour/types/params/v1_face_swap_photo_generate_body_assets.py

@@ -0,0 +1,47 @@
+import pydantic
+import typing
+import typing_extensions
+
+from .v1_face_swap_photo_generate_body_assets_face_mappings_item import (
+    V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem,
+)
+
+
+class V1FaceSwapPhotoGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for face swap photo
+    """
+
+    face_mappings: typing_extensions.NotRequired[
+        typing.List[V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem]
+    ]
+    """
+    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.
+    """
+
+    source_file_path: typing_extensions.NotRequired[str]
+    """
+    This is the image from which the face is extracted. The value is required if `face_swap_mode` is `all-faces`. 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.
+    """
+
+    target_file_path: typing_extensions.Required[str]
+    """
+    This is the image where the face from the source image will be placed. 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_photo_generate_body_assets_face_mappings_item.py

@@ -0,0 +1,25 @@
+import pydantic
+import typing_extensions
+
+
+class V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem(typing_extensions.TypedDict):
+    """
+    V1FaceSwapPhotoGenerateBodyAssetsFaceMappingsItem
+    """
+
+    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 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.
+    """
+
+    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.
+    """

magic_hour/types/params/v1_image_background_remover_generate_body_assets.py

@@ -0,0 +1,27 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1ImageBackgroundRemoverGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for background removal
+    """
+
+    background_image_file_path: typing_extensions.NotRequired[str]
+    """
+    The image used as the new background for the image_file_path. This image will be resized to match the image in image_file_path. Please make sure the resolution between the images are similar. 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.
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image to remove the background. 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_image_to_video_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1ImageToVideoGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for image-to-video.
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The path of the image file. 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_lip_sync_generate_body_assets.py

@@ -0,0 +1,36 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1LipSyncGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    audio_file_path: typing_extensions.Required[str]
+    """
+    The path of the audio file. 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.
+    """
+
+    video_file_path: typing_extensions.NotRequired[str]
+    """
+    Required if `video_source` is `file`. 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.
+    """
+
+    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`
+    """

magic_hour/types/params/v1_photo_colorizer_generate_body_assets.py

@@ -0,0 +1,17 @@
+import pydantic
+import typing_extensions
+
+
+class V1PhotoColorizerGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for photo colorization
+    """
+
+    image_file_path: typing_extensions.Required[str]
+    """
+    The image used to generate the colorized image. 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_video_to_video_generate_body_assets.py

@@ -0,0 +1,27 @@
+import pydantic
+import typing
+import typing_extensions
+
+
+class V1VideoToVideoGenerateBodyAssets(typing_extensions.TypedDict):
+    """
+    Provide the assets for video-to-video. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+    """
+
+    video_file_path: typing_extensions.NotRequired[str]
+    """
+    Required if `video_source` is `file`. 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.
+    """
+
+    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`
+    """