pavo-engine-py

Install dependencies

pip install -r requirements.txt

System Requirements

• Python: 3.9 or higher
• FFmpeg: Latest version
• RAM: 4GB minimum (8GB recommended)
• Storage: 1GB free space

Python Dependencies

```bash

Core dependencies

ffmpeg-python==0.2.0 # FFmpeg integration requests==2.32.3 # HTTP requests retrying==1.3.4 # Retry logic tqdm==4.66.4 # Progress bars pillow==10.4.0 # Image processing

Installation

```bash

Install FFmpeg (required)

🛠️ Installation Details

Development Installation

```bash

Install in development mode

pip install -e .

Build package

python setup.py sdist bdist_wheel ```

🚀 Quick Start

Basic Usage

```python from pavo import render_video

🎯 Use Cases

🔧 Advanced Usage

📚 Examples

Check the docs/example/ directory for comprehensive examples:

• VIDEO_CONVERTER_EXAMPLE.py - Video format conversion
• AUDIO_CONVERTER_EXAMPLE.py - Audio processing
• SPEECH_TRANSCRIBER_EXAMPLE.py - Speech-to-text
• SPEAKER_DIARIZATION_EXAMPLE.py - Speaker identification
• OBJECT_DETECTION_EXAMPLE.py - Object recognition
• SCENE_DETECTION_EXAMPLE.py - Scene change detection

Development Guidelines

• Follow PEP 8 style guide
• Write comprehensive docstrings
• Include unit tests for new features
• Update documentation accordingly

Sample Timeline JSON

Save the following as timeline.json and pass its path to render_video:

{
  "timeline": {
    "n_frames": 75,
    "background": "#1a1a2e",
    "soundtrack": {
      "src": "path/to/background_music.mp3",
      "effect": "fadeOut"
    },
    "tracks": [
      {
        "track_id": 0,
        "strips": [
          {
            "asset": {
              "type": "image",
              "src": "path/to/intro.jpg"
            },
            "start": 0,
            "video_start_frame": 0,
            "length": 25,
            "effect": "zoomIn",
            "transition": {"in": "fade", "out": "fade"}
          },
          {
            "asset": {
              "type": "video",
              "src": "path/to/clip.mp4"
            },
            "start": 25,
            "video_start_frame": 0,
            "length": 50,
            "effect": null,
            "transition": {"in": "fade", "out": "fade"}
          }
        ]
      }
    ]
  },
  "output": {
    "format": "mp4",
    "fps": 25,
    "width": 1280,
    "height": 720
  }
}

Audio Ducking

Enable the audio_ducking flag in the output section to automatically lower the soundtrack volume whenever speech is detected in video clips:

{
  "timeline": {
    "n_frames": 75,
    "background": "#1a1a2e",
    "soundtrack": {
      "src": "path/to/background_music.mp3"
    },
    "tracks": [
      {
        "track_id": 0,
        "strips": [
          {
            "asset": {
              "type": "video",
              "src": "path/to/narration.mp4"
            },
            "start": 0,
            "video_start_frame": 0,
            "length": 75,
            "effect": null,
            "transition": {}
          }
        ]
      }
    ]
  },
  "output": {
    "format": "mp4",
    "fps": 25,
    "width": 1280,
    "height": 720,
    "audio_ducking": true,
    "ducking_reduction_db": 10
  }
}

from pavo import render_video

render_video('timeline.json', 'output/video.mp4')

Video Trimming

Specify optional trim_start / trim_end (seconds) or trim_start_frame / trim_end_frame (integer frame numbers) inside a video asset to use only a sub-segment of the source file. If only one boundary is given the other defaults to the natural start/end of the source.

{
  "timeline": {
    "n_frames": 50,
    "background": "#000000",
    "tracks": [
      {
        "track_id": 0,
        "strips": [
          {
            "asset": {
              "type": "video",
              "src": "path/to/long_clip.mp4",
              "trim_start": 5.0,
              "trim_end": 15.0
            },
            "start": 0,
            "length": 50
          }
        ]
      }
    ]
  },
  "output": {
    "format": "mp4",
    "fps": 25,
    "width": 1280,
    "height": 720
  }
}

Frame-based trimming example (equivalent to the above at 25 fps):

{
  "asset": {
    "type": "video",
    "src": "path/to/long_clip.mp4",
    "trim_start_frame": 125,
    "trim_end_frame": 375
  }
}

Error handling

render_video raises descriptive exceptions for common mistakes:

from pavo import render_video

try:
    render_video('timeline.json', 'output/video.mp4')
except FileNotFoundError as exc:
    print(f"JSON file missing: {exc}")
except ValueError as exc:
    print(f"Invalid timeline JSON: {exc}")

Convert with custom settings

converter.convert( 'input.mov', 'output.mp4', scale='1920:1080', fps=30, bitrate='5000k' ) ```

☁️ Cloud Integration

• S3 Support: Direct asset loading from cloud storage
• CDN Ready: Optimized for distributed content delivery
• Batch Processing: Parallel video rendering
• Progress Tracking: Real-time status updates

Cloud integration

boto3==1.26.109 # AWS S3 botocore==1.29.109 # AWS core

Run specific test module

python -m pytest tests/test_render.py