lattifai 1.2.1__py3-none-any.whl → 1.2.2__py3-none-any.whl

lattifai/youtube/types.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+from typing import Any, List, Optional
+
+
+@dataclass
+class VideoMetadata:
+    video_id: str
+    title: str
+    description: str
+    duration: float  # seconds
+    thumbnail_url: str
+    channel_name: str
+    view_count: int
+    upload_date: Optional[str] = None
+
+
+@dataclass
+class CaptionTrack:
+    language_code: str
+    language_name: str
+    kind: str  # 'manual' | 'asr'
+    ext: str  # 'vtt', 'srv3' etc
+    url: Optional[str] = None

lattifai-1.2.2.dist-info/METADATA

@@ -0,0 +1,615 @@
+Metadata-Version: 2.4
+Name: lattifai
+Version: 1.2.2
+Summary: Lattifai Python SDK: Seamless Integration with Lattifai's Speech and Video AI Services
+Author-email: Lattifai Technologies <tech@lattifai.com>
+Maintainer-email: Lattice <tech@lattifai.com>
+License: MIT License
+        
+        Copyright (c) 2025 LattifAI.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/lattifai/lattifai-python
+Project-URL: Documentation, https://github.com/lattifai/lattifai-python/blob/main/README.md
+Project-URL: Bug Tracker, https://github.com/lattifai/lattifai-python/issues
+Project-URL: Discussions, https://github.com/lattifai/lattifai-python/discussions
+Project-URL: Changelog, https://github.com/lattifai/lattifai-python/blob/main/CHANGELOG.md
+Keywords: lattifai,speech recognition,video analysis,ai,sdk,api client
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lattifai[core]
+Requires-Dist: lattifai[alignment]
+Requires-Dist: lattifai[transcription]
+Requires-Dist: lattifai[workflow]
+Requires-Dist: lattifai[server]
+Provides-Extra: core
+Requires-Dist: k2py>=0.2.1; extra == "core"
+Requires-Dist: lattifai-core>=0.6.0; extra == "core"
+Requires-Dist: lattifai-run>=1.0.1; extra == "core"
+Requires-Dist: python-dotenv; extra == "core"
+Requires-Dist: msgpack; extra == "core"
+Requires-Dist: scipy!=1.16.3; extra == "core"
+Requires-Dist: av; extra == "core"
+Provides-Extra: alignment
+Requires-Dist: lhotse>=1.26.0; extra == "alignment"
+Requires-Dist: colorful>=0.5.6; extra == "alignment"
+Requires-Dist: pysubs2; extra == "alignment"
+Requires-Dist: praatio; extra == "alignment"
+Requires-Dist: tgt; extra == "alignment"
+Requires-Dist: onnx>=1.16.0; extra == "alignment"
+Requires-Dist: onnxruntime; extra == "alignment"
+Requires-Dist: g2p-phonemizer>=0.4.0; extra == "alignment"
+Requires-Dist: wtpsplit>=2.1.7; extra == "alignment"
+Requires-Dist: modelscope>=1.33.0; extra == "alignment"
+Requires-Dist: error-align-fix>=0.1.4; extra == "alignment"
+Provides-Extra: transcription
+Requires-Dist: OmniSenseVoice>=0.4.2; extra == "transcription"
+Requires-Dist: nemo_toolkit_asr[asr]>=2.7.0rc4; extra == "transcription"
+Requires-Dist: google-genai>=1.22.0; extra == "transcription"
+Requires-Dist: pyannote-audio-notorchdeps>=4.0.2; extra == "transcription"
+Provides-Extra: workflow
+Requires-Dist: questionary>=2.0; extra == "workflow"
+Requires-Dist: yt-dlp; extra == "workflow"
+Requires-Dist: pycryptodome; extra == "workflow"
+Provides-Extra: server
+Requires-Dist: fastapi>=0.111.0; extra == "server"
+Requires-Dist: uvicorn>=0.30.0; extra == "server"
+Requires-Dist: python-multipart>=0.0.9; extra == "server"
+Requires-Dist: jinja2>=3.1.4; extra == "server"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/lattifai/lattifai-python/main/assets/logo.png" width=256>
+
+[![PyPI version](https://badge.fury.io/py/lattifai.svg)](https://badge.fury.io/py/lattifai)
+[![Python Versions](https://img.shields.io/pypi/pyversions/lattifai.svg)](https://pypi.org/project/lattifai)
+[![PyPI Status](https://pepy.tech/badge/lattifai)](https://pepy.tech/project/lattifai)
+</div>
+
+<p align="center">
+   🌐 <a href="https://lattifai.com"><b>Official Website</b></a> &nbsp&nbsp | &nbsp&nbsp 🖥️ <a href="https://github.com/lattifai/lattifai-python">GitHub</a> &nbsp&nbsp | &nbsp&nbsp 🤗 <a href="https://huggingface.co/Lattifai/Lattice-1">Model</a> &nbsp&nbsp | &nbsp&nbsp 📑 <a href="https://lattifai.com/blogs">Blog</a> &nbsp&nbsp | &nbsp&nbsp <a href="https://discord.gg/kvF4WsBRK8"><img src="https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white" alt="Discord" style="vertical-align: middle;"></a>
+</p>
+
+
+# LattifAI: Precision Alignment, Infinite Possibilities
+
+Advanced forced alignment and subtitle generation powered by [ 🤗 Lattice-1](https://huggingface.co/Lattifai/Lattice-1) model.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [CLI Reference](#cli-reference)
+- [Python SDK](#python-sdk)
+- [Advanced Features](#advanced-features)
+- [Supported Formats & Languages](#supported-formats--languages)
+- [Roadmap](#roadmap)
+- [Development](#development)
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Forced Alignment** | Word-level and segment-level audio-text synchronization powered by [Lattice-1](https://huggingface.co/Lattifai/Lattice-1) |
+| **Multi-Model Transcription** | Gemini (100+ languages), Parakeet (24 languages), SenseVoice (5 languages) |
+| **Speaker Diarization** | Multi-speaker identification with label preservation |
+| **Streaming Mode** | Process audio up to 20 hours with minimal memory |
+| **Universal Format Support** | 30+ caption/subtitle formats |
+
+### Alignment Models
+
+| Model | Languages | Description |
+|-------|-----------|-------------|
+| **Lattice-1** | English, Chinese, German | Production model with mixed-language alignment support |
+| **Lattice-1-Alpha** | English | Initial release with English forced alignment |
+
+**Model Hub**: Models can be downloaded from `huggingface` (default) or `modelscope` (recommended for users in China):
+
+```bash
+# Use ModelScope (faster in China)
+lai alignment align audio.wav caption.srt output.srt alignment.model_hub=modelscope
+```
+
+```python
+from lattifai import LattifAI, AlignmentConfig
+
+client = LattifAI(alignment_config=AlignmentConfig(model_hub="modelscope"))
+```
+
+---
+
+## Installation
+
+### Using uv (Recommended)
+
+[uv](https://github.com/astral-sh/uv) is a fast Python package manager (10-100x faster than pip).
+
+```bash
+# Install uv
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Quick start (run without installing)
+uvx --from lattifai lai --help
+
+# Or create a project
+mkdir my-project && cd my-project
+uv init --bare && uv add lattifai
+uv run lai alignment align audio.wav caption.srt output.srt
+```
+
+### Using pip
+
+```bash
+pip install lattifai
+```
+
+### API Keys
+
+**LattifAI API Key (Required)** - Get your free key at [lattifai.com/dashboard/api-keys](https://lattifai.com/dashboard/api-keys)
+
+```bash
+export LATTIFAI_API_KEY="lf_your_api_key_here"
+```
+
+**Gemini API Key (Optional)** - For transcription with Gemini models, get key at [aistudio.google.com/apikey](https://aistudio.google.com/apikey)
+
+```bash
+export GEMINI_API_KEY="your_gemini_api_key_here"
+```
+
+Or use a `.env` file:
+```bash
+LATTIFAI_API_KEY=lf_your_api_key_here
+GEMINI_API_KEY=your_gemini_api_key_here
+```
+
+---
+
+## Quick Start
+
+### Command Line
+
+```bash
+# Align audio with subtitle
+lai alignment align audio.wav subtitle.srt output.srt
+
+# YouTube video
+lai alignment youtube "https://youtube.com/watch?v=VIDEO_ID"
+```
+
+### Python SDK
+
+```python
+from lattifai import LattifAI
+
+client = LattifAI()
+caption = client.alignment(
+    input_media="audio.wav",
+    input_caption="subtitle.srt",
+    output_caption_path="aligned.srt",
+)
+```
+
+---
+
+## CLI Reference
+
+| Command | Description | Example |
+|---------|-------------|---------|
+| `lai alignment align` | Align audio/video with caption | `lai alignment align audio.wav caption.srt output.srt` |
+| `lai alignment youtube` | Download & align YouTube | `lai alignment youtube "https://youtube.com/watch?v=ID"` |
+| `lai transcribe run` | Transcribe audio/video | `lai transcribe run audio.wav output.srt` |
+| `lai transcribe align` | Transcribe and align | `lai transcribe align audio.wav output.srt` |
+| `lai caption convert` | Convert caption formats | `lai caption convert input.srt output.vtt` |
+| `lai caption shift` | Shift timestamps | `lai caption shift input.srt output.srt 2.0` |
+
+### Common Options
+
+```bash
+# Device selection
+alignment.device=cuda          # cuda, mps, cpu
+
+# Caption options
+caption.split_sentence=true    # Smart sentence splitting
+caption.word_level=true        # Word-level timestamps
+
+# Streaming for long audio
+media.streaming_chunk_secs=600
+
+# Channel selection
+media.channel_selector=left    # left, right, average, or index
+```
+
+### Transcription Models
+
+```bash
+# Gemini (100+ languages, requires GEMINI_API_KEY)
+transcription.model_name=gemini-2.5-pro
+
+# Parakeet (24 European languages)
+transcription.model_name=nvidia/parakeet-tdt-0.6b-v3
+
+# SenseVoice (zh, en, ja, ko, yue)
+transcription.model_name=iic/SenseVoiceSmall
+```
+
+### lai transcribe run
+
+Transcribe audio/video files or YouTube URLs to generate timestamped captions.
+
+```bash
+# Local file
+lai transcribe run audio.wav output.srt
+
+# YouTube URL
+lai transcribe run "https://youtube.com/watch?v=VIDEO_ID" output_dir=./output
+
+# With model selection
+lai transcribe run audio.wav output.srt \
+    transcription.model_name=gemini-2.5-pro \
+    transcription.device=cuda
+```
+
+**Parameters:**
+- `input`: Path to audio/video file or YouTube URL
+- `output_caption`: Output caption file path (for local files)
+- `output_dir`: Output directory (for YouTube URLs, defaults to current directory)
+- `channel_selector`: Audio channel - `average` (default), `left`, `right`, or channel index
+
+### lai transcribe align
+
+Transcribe and align in a single step - produces precisely aligned captions.
+
+```bash
+# Basic usage
+lai transcribe align audio.wav output.srt
+
+# With options
+lai transcribe align audio.wav output.srt \
+    transcription.model_name=nvidia/parakeet-tdt-0.6b-v3 \
+    alignment.device=cuda \
+    caption.split_sentence=true \
+    caption.word_level=true
+```
+
+---
+
+## Python SDK
+
+### Configuration Objects
+
+```python
+from lattifai import (
+    LattifAI,
+    ClientConfig,
+    AlignmentConfig,
+    CaptionConfig,
+    DiarizationConfig,
+    MediaConfig,
+)
+
+client = LattifAI(
+    client_config=ClientConfig(api_key="lf_xxx", timeout=60.0),
+    alignment_config=AlignmentConfig(device="cuda"),
+    caption_config=CaptionConfig(split_sentence=True, word_level=True),
+)
+
+caption = client.alignment(
+    input_media="audio.wav",
+    input_caption="subtitle.srt",
+    output_caption_path="output.json",
+)
+
+# Access results
+for segment in caption.supervisions:
+    print(f"{segment.start:.2f}s - {segment.end:.2f}s: {segment.text}")
+```
+
+### YouTube Processing
+
+```python
+caption = client.youtube(
+    url="https://youtube.com/watch?v=VIDEO_ID",
+    output_dir="./downloads",
+    output_caption_path="aligned.srt",
+)
+```
+
+### CaptionConfig Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `split_sentence` | `False` | Smart sentence splitting, separates non-speech elements |
+| `word_level` | `False` | Include word-level timestamps in output |
+| `normalize_text` | `True` | Clean HTML entities and special characters |
+| `include_speaker_in_text` | `True` | Include speaker labels in text output |
+
+```python
+from lattifai import LattifAI, CaptionConfig
+
+client = LattifAI(
+    caption_config=CaptionConfig(
+        split_sentence=True,
+        word_level=True,
+        normalize_text=True,
+        include_speaker_in_text=False,
+    )
+)
+```
+
+---
+
+## Advanced Features
+
+### Streaming Mode (Long Audio)
+
+Process audio up to 20 hours with minimal memory:
+
+```python
+caption = client.alignment(
+    input_media="long_audio.wav",
+    input_caption="subtitle.srt",
+    streaming_chunk_secs=600.0,  # 10-minute chunks
+)
+```
+
+### Word-Level Alignment
+
+```python
+client = LattifAI(caption_config=CaptionConfig(word_level=True))
+caption = client.alignment(
+    input_media="audio.wav",
+    input_caption="subtitle.srt",
+    output_caption_path="output.json",  # JSON preserves word-level data
+)
+```
+
+### Speaker Diarization
+
+Automatically identify and label different speakers in audio.
+
+**Capabilities:**
+- **Multi-Speaker Detection**: Automatically detect speaker changes
+- **Smart Labeling**: Assign labels (SPEAKER_00, SPEAKER_01, etc.)
+- **Label Preservation**: Maintain existing speaker names from input captions
+- **Gemini Integration**: Extract speaker names from transcription context
+
+**Label Handling:**
+- Without existing labels → Generic labels (SPEAKER_00, SPEAKER_01)
+- With existing labels (`[Alice]`, `>> Bob:`, `SPEAKER_01:`) → Preserved during alignment
+- Gemini transcription → Names extracted from context (e.g., "Hi, I'm Alice" → `Alice`)
+
+```python
+from lattifai import LattifAI, DiarizationConfig
+
+client = LattifAI(
+    diarization_config=DiarizationConfig(
+        enabled=True,
+        device="cuda",
+        min_speakers=2,
+        max_speakers=4,
+    )
+)
+caption = client.alignment(...)
+
+for segment in caption.supervisions:
+    print(f"[{segment.speaker}] {segment.text}")
+```
+
+**CLI:**
+```bash
+lai alignment align audio.wav subtitle.srt output.srt \
+    diarization.enabled=true \
+    diarization.device=cuda
+```
+
+### Data Flow
+
+```
+Input Media → AudioLoader → Aligner → (Diarizer) → Caption
+                              ↑
+Input Caption → Reader → Tokenizer
+```
+
+---
+
+## Supported Formats & Languages
+
+### Media Formats
+
+| Type | Formats |
+|------|---------|
+| **Audio** | WAV, MP3, M4A, AAC, FLAC, OGG, OPUS, AIFF, and more |
+| **Video** | MP4, MKV, MOV, WEBM, AVI, and more |
+| **Caption** | SRT, VTT, ASS, SSA, JSON, TextGrid, TSV, CSV, LRC, TTML, and more |
+
+### JSON Format
+
+JSON is the most flexible format for storing caption data with full word-level timing support:
+
+```json
+[
+    {
+        "text": "Hello beautiful world",
+        "start": 0.0,
+        "end": 2.5,
+        "speaker": "Speaker 1",
+        "words": [
+            {"word": "Hello", "start": 0.0, "end": 0.5},
+            {"word": "beautiful", "start": 0.6, "end": 1.4},
+            {"word": "world", "start": 1.5, "end": 2.5}
+        ]
+    }
+]
+```
+
+**Features:**
+- Word-level timestamps preserved in `words` array
+- Round-trip compatible (read/write without data loss)
+- Optional `speaker` field for multi-speaker content
+
+### Word-Level and Karaoke Output
+
+| Format | `word_level=True` | `word_level=True` + `karaoke=True` |
+|--------|-------------------|-----------------------------------|
+| **JSON** | Includes `words` array | Same as word_level=True |
+| **SRT** | One word per segment | One word per segment |
+| **VTT** | One word per segment | YouTube VTT style: `<00:00:00.000><c> word</c>` |
+| **ASS** | One word per segment | `{\kf}` karaoke tags (sweep effect) |
+| **LRC** | One word per line | Enhanced `<timestamp>` tags |
+| **TTML** | One word per `<p>` element | `<span>` with `itunes:timing="Word"` |
+
+### VTT Format (YouTube VTT Support)
+
+The VTT format handler supports both standard WebVTT and YouTube VTT with word-level timestamps.
+
+**Reading**: VTT automatically detects YouTube VTT format (with `<timestamp><c>` tags) and extracts word-level alignment data:
+
+```
+WEBVTT
+
+00:00:00.000 --> 00:00:02.000
+<00:00:00.000><c> Hello</c><00:00:00.500><c> world</c>
+```
+
+**Writing**: Use `word_level=True` with `karaoke_config` to output YouTube VTT style:
+
+```python
+from lattifai import Caption
+from lattifai.config.caption import KaraokeConfig
+
+caption = Caption.read("input.vtt")
+caption.write(
+    "output.vtt",
+    word_level=True,
+    karaoke_config=KaraokeConfig(enabled=True)
+)
+```
+
+```bash
+# CLI: Convert to YouTube VTT with word-level timestamps
+lai caption convert input.json output.vtt \
+    caption.word_level=true \
+    caption.karaoke.enabled=true
+```
+
+### Transcription Language Support
+
+#### Gemini Models (100+ Languages)
+
+**Models**: `gemini-2.5-pro`, `gemini-3-pro-preview`, `gemini-3-flash-preview`
+
+English, Chinese (Mandarin & Cantonese), Spanish, French, German, Italian, Portuguese, Japanese, Korean, Arabic, Russian, Hindi, Bengali, Turkish, Dutch, Polish, Swedish, Danish, Norwegian, Finnish, Greek, Hebrew, Thai, Vietnamese, Indonesian, Malay, Filipino, Ukrainian, Czech, Romanian, Hungarian, and 70+ more.
+
+> Requires Gemini API key from [Google AI Studio](https://aistudio.google.com/apikey)
+
+#### NVIDIA Parakeet (24 European Languages)
+
+**Model**: `nvidia/parakeet-tdt-0.6b-v3`
+
+| Region | Languages |
+|--------|-----------|
+| Western Europe | English (en), French (fr), German (de), Spanish (es), Italian (it), Portuguese (pt), Dutch (nl) |
+| Nordic | Danish (da), Swedish (sv), Norwegian (no), Finnish (fi) |
+| Eastern Europe | Polish (pl), Czech (cs), Slovak (sk), Hungarian (hu), Romanian (ro), Bulgarian (bg), Ukrainian (uk), Russian (ru) |
+| Others | Croatian (hr), Estonian (et), Latvian (lv), Lithuanian (lt), Slovenian (sl), Maltese (mt), Greek (el) |
+
+#### Alibaba SenseVoice (5 Asian Languages)
+
+**Model**: `iic/SenseVoiceSmall`
+
+Chinese/Mandarin (zh), English (en), Japanese (ja), Korean (ko), Cantonese (yue)
+
+---
+
+## Roadmap
+
+Visit [lattifai.com/roadmap](https://lattifai.com/roadmap) for updates.
+
+| Date | Release | Features |
+|------|---------|----------|
+| **Oct 2025** | Lattice-1-Alpha | ✅ English forced alignment, multi-format support |
+| **Nov 2025** | Lattice-1 | ✅ EN+ZH+DE, speaker diarization, multi-model transcription |
+| **Q1 2026** | Lattice-2 | ✅ Streaming mode, 🔮 40+ languages, real-time alignment |
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/lattifai/lattifai-python.git
+cd lattifai-python
+
+# Using uv (recommended)
+uv sync && source .venv/bin/activate
+
+# Or pip
+pip install -e ".[test]"
+
+# Run tests
+pytest
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make changes and add tests
+4. Run `pytest` and `pre-commit run --all-files`
+5. Commit your changes (`git commit -m 'Add amazing feature'`)
+6. Push to branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+---
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/lattifai/lattifai-python/issues)
+- **Discord**: [Join our community](https://discord.gg/kvF4WsBRK8)
+
+## License
+
+Apache License 2.0