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

magic_hour/resources/v1/animation/README.md

@@ -1,11 +1,121 @@
+# v1.animation
 
-### create <a name="create"></a>
-Animation
+## Module Functions
+
+<!-- CUSTOM DOCS START -->
+
+### Animation Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.animation.generate(
+    assets={
+        "audio_file_path": "/path/to/1234.mp3",
+        "audio_source": "file",
+        "image_file_path": "/path/to/1234.png",
+    },
+    end_seconds=15.0,
+    fps=12.0,
+    height=960,
+    style={
+        "art_style": "Painterly Illustration",
+        "camera_effect": "Simple Zoom In",
+        "prompt": "Cyberpunk city",
+        "prompt_type": "custom",
+        "transition_speed": 5,
+    },
+    width=512,
+    name="Animation video",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.animation.generate(
+    assets={
+        "audio_file_path": "/path/to/1234.mp3",
+        "audio_source": "file",
+        "image_file_path": "/path/to/1234.png",
+    },
+    end_seconds=15.0,
+    fps=12.0,
+    height=960,
+    style={
+        "art_style": "Painterly Illustration",
+        "camera_effect": "Simple Zoom In",
+        "prompt": "Cyberpunk city",
+        "prompt_type": "custom",
+        "transition_speed": 5,
+    },
+    width=512,
+    name="Animation video",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
+
+### Animation <a name="create"></a>
 
 Create a Animation video. The estimated frame cost is calculated based on the `fps` and `end_seconds` input.
 
 **API Endpoint**: `POST /v1/animation`
 
+#### Parameters
+
+| Parameter             | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                         | Example                                                                                                                                                  |
+| --------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `assets`              |    ✓     | Provide the assets for animation.                                                                                                                                                                                                                                                                                                                                                                                                   | `{"audio_file_path": "api-assets/id/1234.mp3", "audio_source": "file", "image_file_path": "api-assets/id/1234.png"}`                                     |
+| `└─ audio_file_path`  |    ✗     | The path of the input audio. This field is required if `audio_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. | `"api-assets/id/1234.mp3"`                                                                                                                               |
+| `└─ audio_source`     |    ✓     | Optionally add an audio source if you'd like to incorporate audio into your video                                                                                                                                                                                                                                                                                                                                                   | `"file"`                                                                                                                                                 |
+| `└─ image_file_path`  |    ✗     | An initial image to use a the first frame of the video. 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.                          | `"api-assets/id/1234.png"`                                                                                                                               |
+| `└─ youtube_url`      |    ✗     | Using a youtube video as the input source. This field is required if `audio_source` is `youtube`                                                                                                                                                                                                                                                                                                                                    | `"http://www.example.com"`                                                                                                                               |
+| `end_seconds`         |    ✓     | This value determines the duration of the output video.                                                                                                                                                                                                                                                                                                                                                                             | `15.0`                                                                                                                                                   |
+| `fps`                 |    ✓     | The desire output video frame rate                                                                                                                                                                                                                                                                                                                                                                                                  | `12.0`                                                                                                                                                   |
+| `height`              |    ✓     | The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details                                                                                                                                                                                                                                                            | `960`                                                                                                                                                    |
+| `style`               |    ✓     | Defines the style of the output video                                                                                                                                                                                                                                                                                                                                                                                               | `{"art_style": "Painterly Illustration", "camera_effect": "Simple Zoom In", "prompt": "Cyberpunk city", "prompt_type": "custom", "transition_speed": 5}` |
+| `└─ art_style`        |    ✓     | The art style used to create the output video                                                                                                                                                                                                                                                                                                                                                                                       | `"Painterly Illustration"`                                                                                                                               |
+| `└─ art_style_custom` |    ✗     | Describe custom art style. This field is required if `art_style` is `Custom`                                                                                                                                                                                                                                                                                                                                                        | `"string"`                                                                                                                                               |
+| `└─ camera_effect`    |    ✓     | The camera effect used to create the output video                                                                                                                                                                                                                                                                                                                                                                                   | `"Simple Zoom In"`                                                                                                                                       |
+| `└─ prompt`           |    ✗     | The prompt used for the video. Prompt is required if `prompt_type` is `custom`. Otherwise this value is ignored                                                                                                                                                                                                                                                                                                                     | `"Cyberpunk city"`                                                                                                                                       |
+| `└─ prompt_type`      |    ✓     | * `custom` - Use your own prompt for the video. * `use_lyrics` - Use the lyrics of the audio to create the prompt. If this option is selected, then `assets.audio_source` must be `file` or `youtube`. * `ai_choose` - Let AI write the prompt. If this option is selected, then `assets.audio_source` must be `file` or `youtube`.                                                                                                 | `"custom"`                                                                                                                                               |
+| `└─ transition_speed` |    ✓     | Change determines how quickly the video's content changes across frames. * Higher = more rapid transitions. * Lower = more stable visual experience.                                                                                                                                                                                                                                                                                | `5`                                                                                                                                                      |
+| `width`               |    ✓     | The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details                                                                                                                                                                                                                                                              | `512`                                                                                                                                                    |
+| `name`                |    ✗     | The name of video. This value is mainly used for your own identification of the video.                                                                                                                                                                                                                                                                                                                                              | `"Animation video"`                                                                                                                                      |
+
 #### Synchronous Client
 
 ```python
@@ -24,9 +134,9 @@ res = client.v1.animation.create(
     height=960,
     style={
         "art_style": "Painterly Illustration",
-        "camera_effect": "Accelerate",
+        "camera_effect": "Simple Zoom In",
         "prompt": "Cyberpunk city",
-        "prompt_type": "ai_choose",
+        "prompt_type": "custom",
         "transition_speed": 5,
     },
     width=512,
@@ -52,12 +162,24 @@ res = await client.v1.animation.create(
     height=960,
     style={
         "art_style": "Painterly Illustration",
-        "camera_effect": "Accelerate",
+        "camera_effect": "Simple Zoom In",
         "prompt": "Cyberpunk city",
-        "prompt_type": "ai_choose",
+        "prompt_type": "custom",
         "transition_speed": 5,
     },
     width=512,
     name="Animation video",
 )
 ```
+
+#### Response
+
+##### Type
+
+[V1AnimationCreateResponse](/magic_hour/types/models/v1_animation_create_response.py)
+
+##### Example
+
+```python
+{"credits_charged": 450, "estimated_frame_cost": 450, "id": "cuid-example"}
+```

magic_hour/resources/v1/animation/client.py

@@ -1,6 +1,13 @@
 import typing
 
-from magic_hour.core import (
+from magic_hour.helpers.logger import get_sdk_logger
+from magic_hour.resources.v1.files.client import AsyncFilesClient, FilesClient
+from magic_hour.resources.v1.video_projects.client import (
+    AsyncVideoProjectsClient,
+    VideoProjectsClient,
+)
+from magic_hour.types import models, params
+from make_api_request import (
     AsyncBaseClient,
     RequestOptions,
     SyncBaseClient,
@@ -8,27 +15,131 @@ from magic_hour.core import (
     to_encodable,
     type_utils,
 )
-from magic_hour.types import models, params
+
+
+logger = get_sdk_logger(__name__)
 
 
 class AnimationClient:
     def __init__(self, *, base_client: SyncBaseClient):
         self._base_client = base_client
 
+    def generate(
+        self,
+        *,
+        assets: params.V1AnimationGenerateBodyAssets,
+        end_seconds: float,
+        fps: float,
+        height: int,
+        style: params.V1AnimationCreateBodyStyle,
+        width: int,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate animation (alias for create with additional functionality).
+
+        Create a Animation video. The estimated frame cost is calculated based on the `fps` and `end_seconds` input.
+
+        Args:
+            name: The name of video. This value is mainly used for your own identification of the video.
+            assets: Provide the assets for animation.
+            end_seconds: This value determines the duration of the output video.
+            fps: The desire output video frame rate
+            height: The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
+            style: Defines the style of the output video
+            width: The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
+            wait_for_completion: Whether to wait for the video project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1VideoProjectsGetResponseWithDownloads: The response from the Animation API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.animation.generate(
+            assets={
+                "audio_file_path": "path/to/audio.mp3",
+                "audio_source": "file",
+                "image_file_path": "path/to/image.png",
+            },
+            end_seconds=15.0,
+            fps=12.0,
+            height=960,
+            style={
+                "art_style": "Painterly Illustration",
+                "camera_effect": "Simple Zoom In",
+                "prompt": "Cyberpunk city",
+                "prompt_type": "custom",
+                "transition_speed": 5,
+            },
+            width=512,
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = FilesClient(base_client=self._base_client)
+
+        # Upload image file if provided
+        if "image_file_path" in assets and assets["image_file_path"]:
+            image_file_path = assets["image_file_path"]
+            assets["image_file_path"] = file_client.upload_file(file=image_file_path)
+
+        # Upload audio file if audio_source is "file" and audio_file_path is provided
+        if (
+            assets.get("audio_source") == "file"
+            and "audio_file_path" in assets
+            and assets["audio_file_path"]
+        ):
+            audio_file_path = assets["audio_file_path"]
+            assets["audio_file_path"] = file_client.upload_file(file=audio_file_path)
+
+        create_response = self.create(
+            assets=assets,
+            end_seconds=end_seconds,
+            fps=fps,
+            height=height,
+            style=style,
+            width=width,
+            name=name,
+            request_options=request_options,
+        )
+        logger.info(f"Animation response: {create_response}")
+
+        video_projects_client = VideoProjectsClient(base_client=self._base_client)
+        response = video_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     def create(
         self,
         *,
-        assets: params.PostV1AnimationBodyAssets,
+        assets: params.V1AnimationCreateBodyAssets,
         end_seconds: float,
         fps: float,
         height: int,
-        style: params.PostV1AnimationBodyStyle,
+        style: params.V1AnimationCreateBodyStyle,
         width: int,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> models.PostV1AnimationResponse:
+    ) -> models.V1AnimationCreateResponse:
         """
         Animation
 
@@ -37,9 +148,9 @@ class AnimationClient:
         POST /v1/animation
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             assets: Provide the assets for animation.
-            end_seconds: The end time of the input video in seconds
+            end_seconds: This value determines the duration of the output video.
             fps: The desire output video frame rate
             height: The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
             style: Defines the style of the output video
@@ -56,15 +167,19 @@ class AnimationClient:
         Examples:
         ```py
         client.v1.animation.create(
-            assets={"audio_source": "file"},
+            assets={
+                "audio_file_path": "api-assets/id/1234.mp3",
+                "audio_source": "file",
+                "image_file_path": "api-assets/id/1234.png",
+            },
             end_seconds=15.0,
             fps=12.0,
             height=960,
             style={
                 "art_style": "Painterly Illustration",
-                "camera_effect": "Accelerate",
+                "camera_effect": "Simple Zoom In",
                 "prompt": "Cyberpunk city",
-                "prompt_type": "ai_choose",
+                "prompt_type": "custom",
                 "transition_speed": 5,
             },
             width=512,
@@ -82,14 +197,14 @@ class AnimationClient:
                 "style": style,
                 "width": width,
             },
-            dump_with=params._SerializerPostV1AnimationBody,
+            dump_with=params._SerializerV1AnimationCreateBody,
         )
         return self._base_client.request(
             method="POST",
             path="/v1/animation",
             auth_names=["bearerAuth"],
             json=_json,
-            cast_to=models.PostV1AnimationResponse,
+            cast_to=models.V1AnimationCreateResponse,
             request_options=request_options or default_request_options(),
         )
 
@@ -98,20 +213,126 @@ class AsyncAnimationClient:
     def __init__(self, *, base_client: AsyncBaseClient):
         self._base_client = base_client
 
+    async def generate(
+        self,
+        *,
+        assets: params.V1AnimationGenerateBodyAssets,
+        end_seconds: float,
+        fps: float,
+        height: int,
+        style: params.V1AnimationCreateBodyStyle,
+        width: int,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate animation (alias for create with additional functionality).
+
+        Create a Animation video. The estimated frame cost is calculated based on the `fps` and `end_seconds` input.
+
+        Args:
+            name: The name of video. This value is mainly used for your own identification of the video.
+            assets: Provide the assets for animation.
+            end_seconds: This value determines the duration of the output video.
+            fps: The desire output video frame rate
+            height: The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
+            style: Defines the style of the output video
+            width: The width of the final output video. The maximum width depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
+            wait_for_completion: Whether to wait for the video project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1VideoProjectsGetResponseWithDownloads: The response from the Animation API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.animation.generate(
+            assets={
+                "audio_file_path": "path/to/audio.mp3",
+                "audio_source": "file",
+                "image_file_path": "path/to/image.png",
+            },
+            end_seconds=15.0,
+            fps=12.0,
+            height=960,
+            style={
+                "art_style": "Painterly Illustration",
+                "camera_effect": "Simple Zoom In",
+                "prompt": "Cyberpunk city",
+                "prompt_type": "custom",
+                "transition_speed": 5,
+            },
+            width=512,
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = AsyncFilesClient(base_client=self._base_client)
+
+        # Upload image file if provided
+        if "image_file_path" in assets and assets["image_file_path"]:
+            image_file_path = assets["image_file_path"]
+            assets["image_file_path"] = await file_client.upload_file(
+                file=image_file_path
+            )
+
+        # Upload audio file if audio_source is "file" and audio_file_path is provided
+        if (
+            assets.get("audio_source") == "file"
+            and "audio_file_path" in assets
+            and assets["audio_file_path"]
+        ):
+            audio_file_path = assets["audio_file_path"]
+            assets["audio_file_path"] = await file_client.upload_file(
+                file=audio_file_path
+            )
+
+        create_response = await self.create(
+            assets=assets,
+            end_seconds=end_seconds,
+            fps=fps,
+            height=height,
+            style=style,
+            width=width,
+            name=name,
+            request_options=request_options,
+        )
+        logger.info(f"Animation response: {create_response}")
+
+        video_projects_client = AsyncVideoProjectsClient(base_client=self._base_client)
+        response = await video_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     async def create(
         self,
         *,
-        assets: params.PostV1AnimationBodyAssets,
+        assets: params.V1AnimationCreateBodyAssets,
         end_seconds: float,
         fps: float,
         height: int,
-        style: params.PostV1AnimationBodyStyle,
+        style: params.V1AnimationCreateBodyStyle,
         width: int,
         name: typing.Union[
             typing.Optional[str], type_utils.NotGiven
         ] = type_utils.NOT_GIVEN,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> models.PostV1AnimationResponse:
+    ) -> models.V1AnimationCreateResponse:
         """
         Animation
 
@@ -120,9 +341,9 @@ class AsyncAnimationClient:
         POST /v1/animation
 
         Args:
-            name: The name of video
+            name: The name of video. This value is mainly used for your own identification of the video.
             assets: Provide the assets for animation.
-            end_seconds: The end time of the input video in seconds
+            end_seconds: This value determines the duration of the output video.
             fps: The desire output video frame rate
             height: The height of the final output video. The maximum height depends on your subscription. Please refer to our [pricing page](https://magichour.ai/pricing) for more details
             style: Defines the style of the output video
@@ -139,15 +360,19 @@ class AsyncAnimationClient:
         Examples:
         ```py
         await client.v1.animation.create(
-            assets={"audio_source": "file"},
+            assets={
+                "audio_file_path": "api-assets/id/1234.mp3",
+                "audio_source": "file",
+                "image_file_path": "api-assets/id/1234.png",
+            },
             end_seconds=15.0,
             fps=12.0,
             height=960,
             style={
                 "art_style": "Painterly Illustration",
-                "camera_effect": "Accelerate",
+                "camera_effect": "Simple Zoom In",
                 "prompt": "Cyberpunk city",
-                "prompt_type": "ai_choose",
+                "prompt_type": "custom",
                 "transition_speed": 5,
             },
             width=512,
@@ -165,13 +390,13 @@ class AsyncAnimationClient:
                 "style": style,
                 "width": width,
             },
-            dump_with=params._SerializerPostV1AnimationBody,
+            dump_with=params._SerializerV1AnimationCreateBody,
         )
         return await self._base_client.request(
             method="POST",
             path="/v1/animation",
             auth_names=["bearerAuth"],
             json=_json,
-            cast_to=models.PostV1AnimationResponse,
+            cast_to=models.V1AnimationCreateResponse,
             request_options=request_options or default_request_options(),
         )