Skip to content

Latest commit

 

History

History
172 lines (107 loc) · 3.66 KB

README.md

File metadata and controls

172 lines (107 loc) · 3.66 KB

Bodymovin Renderer

Bodymovin Renderer is a Rust library for rendering frames from Bodymovin JSON data and handling video frames. This library provides utilities for processing animations, converting image buffers to video frames, and more.

Features

  • Parse Bodymovin JSON data to extract animation details.
  • Render frames from animations using image buffers.
  • Convert image buffers into video frames with timestamp handling.
  • Easily customizable frame rate and time base for accurate video rendering.

Installation

Installation

Installing Rust on macOS

To install Rust on macOS, follow these steps:

  1. Install Homebrew (if you don't already have it):

    Open a terminal and run:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  2. Install Rust using Homebrew:

    brew install rust

  3. Verify the installation:

    rustc --version

    You should see the Rust version printed in the terminal.

Installing Rust on Linux

To install Rust on Linux, follow these steps:

  1. Install Rust using rustup:

    Open a terminal and run:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

    Follow the on-screen instructions to complete the installation.

  2. Configure your current shell:

    source $HOME/.cargo/env

  3. Verify the installation:

    rustc --version

    You should see the Rust version printed in the terminal.

Updating Rust

To update Rust to the latest version, run:

rustup update

Build

To build the project, run:

cargo build

Run

To run the project, run:

cargo run

Test

To test the project, run:

cargo test

Formatting

To format the code, run:

cargo fmt

Usage

To use this library, add the following to your Cargo.toml:

[dependencies]
image = "0.24" # Or the latest version
num-rational = "0.4" # Or the latest version
rayon = "1.7" # Or the latest version
serde = { version = "1.0", features = ["derive"] }

Below is a basic example demonstrating how to render frames from Bodymovin JSON and convert them into video frames:

use bodymovin_renderer::bodymovin::{get_all_frames, save_frame, BodymovinError};

fn main() -> Result<(), BodymovinError> {
    // Paths to the necessary files and directories
    let bodymovin_json = "path/to/bodymovin.json";
    let assets_dir = "path/to/bodymovin/assets";
    let output_dir = "path/to/output";

    // Render all frames from Bodymovin JSON
    let frames = get_all_frames(&bodymovin_json, &assets_dir)?;

    
    // Save each frame
    for (frame_number, frame) in frames.into_iter().enumerate() {
        save_frame(&frame, output_dir, frame_number as u32)?;
    }

    Ok(())
}

Example Code

This example code demonstrates how to use the library to process frames and convert them into a video-friendly format:

  1. Rendering Frames: Using get_all_frames to render frames from a Bodymovin JSON file.
  2. Saving Frames: Using the save_frame function to store processed frames in a specified directory.

Important Types and Functions

  • get_all_frames: Function to render frames from Bodymovin JSON.

Contributing

We welcome contributions! Feel free to submit issues or pull requests to improve the library.

To Do

  • Implement additional features for more animation effects.
  • Improve error handling and performance optimizations.
  • Enhance documentation with more examples and use cases.

License

This project is licensed under the MIT License. See the LICENSE file for details.