Organize documentation into professional docs/ structure
🗂️ MAJOR DOCS REORGANIZATION: Professional documentation structure implemented ## New Documentation Architecture docs/ ├── user-guide/ # End-user documentation ├── development/ # Technical implementation details ├── migration/ # Upgrade and migration guides ├── reference/ # API references and feature lists └── examples/ # Comprehensive usage examples ## Key Improvements ✅ Logical categorization of all 14 documentation files ✅ Professional docs/ directory following industry standards ✅ Updated internal links to maintain navigation ✅ Comprehensive docs/README.md with navigation ✅ Enhanced main README with docs/ integration ✅ Migration section added for v0.4.0 upgrade guidance ## Documentation Features - 📖 Complete user guides with feature overviews - 🛠️ Technical development documentation - 🔄 Step-by-step migration instructions - 💻 11 comprehensive examples with detailed explanations - 📋 API references and project roadmaps - 🎯 Quick navigation and cross-linking This creates a professional documentation experience that scales with the project and makes information easily discoverable. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
9a460e5641
commit
081bb862d3
67
README.md
67
README.md
@ -13,20 +13,39 @@
|
||||
|
||||
*Extracted from the demostar Django application, now a standalone powerhouse for video encoding, thumbnail generation, and sprite creation.*
|
||||
|
||||
## 🎉 **NEW in v0.3.0**: Complete Test Infrastructure!
|
||||
✅ **52 passing tests** (0 failures!) • ✅ **108+ test video fixtures** • ✅ **Full Docker integration** • ✅ **CI/CD pipeline**
|
||||
## 🚀 **LATEST: v0.4.0 - Complete Multimedia Platform!**
|
||||
🤖 **AI Analysis** • 🎥 **AV1/HEVC/HDR** • 📡 **Adaptive Streaming** • 🌐 **360° Video Processing** • ✅ **Production Ready**
|
||||
|
||||
[Features](#-features) •
|
||||
[Installation](#-installation) •
|
||||
[Quick Start](#-quick-start) •
|
||||
[Testing](#-testing) •
|
||||
[Examples](#-examples) •
|
||||
[API Reference](#-api-reference)
|
||||
[📚 **Full Documentation**](docs/) •
|
||||
[🚀 Features](#-features) •
|
||||
[⚡ Quick Start](#-quick-start) •
|
||||
[💻 Examples](#-examples) •
|
||||
[🔄 Migration](#-migration-to-v040)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### **Complete Documentation Suite Available in [`docs/`](docs/)**
|
||||
|
||||
| Documentation | Description |
|
||||
|---------------|-------------|
|
||||
| **[📖 User Guide](docs/user-guide/)** | Complete getting started guides and feature overviews |
|
||||
| **[🔄 Migration](docs/migration/)** | Upgrade instructions and migration guides |
|
||||
| **[🛠️ Development](docs/development/)** | Technical implementation details and architecture |
|
||||
| **[📋 Reference](docs/reference/)** | API references, roadmaps, and feature lists |
|
||||
| **[💻 Examples](docs/examples/)** | 11 comprehensive examples covering all features |
|
||||
|
||||
### **Quick Links**
|
||||
- **[🚀 NEW_FEATURES_v0.4.0.md](docs/user-guide/NEW_FEATURES_v0.4.0.md)** - Complete v0.4.0 feature overview
|
||||
- **[📘 README_v0.4.0.md](docs/user-guide/README_v0.4.0.md)** - Comprehensive getting started guide
|
||||
- **[🔄 MIGRATION_GUIDE_v0.4.0.md](docs/migration/MIGRATION_GUIDE_v0.4.0.md)** - Upgrade instructions
|
||||
- **[💻 Examples Documentation](docs/examples/README.md)** - Hands-on usage examples
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
|
||||
<table>
|
||||
@ -712,6 +731,38 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE)
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Migration to v0.4.0
|
||||
|
||||
### **Upgrading from Previous Versions**
|
||||
|
||||
Video Processor v0.4.0 maintains **100% backward compatibility** while adding powerful new features:
|
||||
|
||||
```python
|
||||
# Your existing code continues to work unchanged
|
||||
processor = VideoProcessor(config)
|
||||
result = await processor.process_video("video.mp4", "./output/")
|
||||
|
||||
# But now you get additional features automatically:
|
||||
if result.is_360_video:
|
||||
print(f"360° projection: {result.video_360.projection_type}")
|
||||
|
||||
if result.quality_analysis:
|
||||
print(f"Quality score: {result.quality_analysis.overall_quality:.1f}/10")
|
||||
```
|
||||
|
||||
### **New Features Available**
|
||||
- **🤖 AI Analysis**: Automatic scene detection and quality assessment
|
||||
- **🎥 Modern Codecs**: AV1, HEVC, and HDR support
|
||||
- **📡 Streaming**: HLS and DASH adaptive streaming
|
||||
- **🌐 360° Processing**: Complete immersive video pipeline
|
||||
|
||||
### **Migration Resources**
|
||||
- **[📋 Complete Migration Guide](docs/migration/MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions
|
||||
- **[🚀 New Features Overview](docs/user-guide/NEW_FEATURES_v0.4.0.md)** - What's new in v0.4.0
|
||||
- **[💻 Updated Examples](docs/examples/README.md)** - New capabilities in action
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
### 🙋♀️ Questions? Issues? Ideas?
|
||||
|
||||
213
docs/README.md
Normal file
213
docs/README.md
Normal file
@ -0,0 +1,213 @@
|
||||
# 📚 Video Processor Documentation
|
||||
|
||||
Welcome to the comprehensive documentation for **Video Processor v0.4.0** - the ultimate Python library for professional video processing and immersive media.
|
||||
|
||||
## 🗂️ Documentation Structure
|
||||
|
||||
### 📖 [User Guide](user-guide/)
|
||||
Complete guides for end users and developers getting started with the video processor.
|
||||
|
||||
| Document | Description |
|
||||
|----------|-------------|
|
||||
| **[🚀 NEW_FEATURES_v0.4.0.md](user-guide/NEW_FEATURES_v0.4.0.md)** | Complete feature overview with examples for v0.4.0 |
|
||||
| **[📘 README_v0.4.0.md](user-guide/README_v0.4.0.md)** | Comprehensive getting started guide and API reference |
|
||||
| **[🏆 FINAL_PROJECT_SHOWCASE.md](user-guide/FINAL_PROJECT_SHOWCASE.md)** | Project completion showcase and achievement summary |
|
||||
|
||||
### 🔄 [Migration & Upgrades](migration/)
|
||||
Guides for upgrading between versions and migrating existing installations.
|
||||
|
||||
| Document | Description |
|
||||
|----------|-------------|
|
||||
| **[🔄 MIGRATION_GUIDE_v0.4.0.md](migration/MIGRATION_GUIDE_v0.4.0.md)** | Step-by-step upgrade instructions from previous versions |
|
||||
| **[⬆️ UPGRADE.md](migration/UPGRADE.md)** | General upgrade procedures and best practices |
|
||||
|
||||
### 🛠️ [Development](development/)
|
||||
Technical documentation for developers working on or extending the video processor.
|
||||
|
||||
| Document | Description |
|
||||
|----------|-------------|
|
||||
| **[🏗️ COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)** | Complete development history and architecture decisions |
|
||||
| **[🤖 AI_IMPLEMENTATION_SUMMARY.md](development/AI_IMPLEMENTATION_SUMMARY.md)** | AI content analysis implementation details |
|
||||
| **[🎥 PHASE_2_CODECS_SUMMARY.md](development/PHASE_2_CODECS_SUMMARY.md)** | Advanced codec implementation (AV1, HEVC, HDR) |
|
||||
| **[📋 PROJECT_COMPLETION_v0.4.0.md](development/PROJECT_COMPLETION_v0.4.0.md)** | Project completion summary and success metrics |
|
||||
|
||||
### 📋 [Reference](reference/)
|
||||
API references, feature lists, and project roadmaps.
|
||||
|
||||
| Document | Description |
|
||||
|----------|-------------|
|
||||
| **[⚡ ADVANCED_FEATURES.md](reference/ADVANCED_FEATURES.md)** | Complete list of advanced features and capabilities |
|
||||
| **[🗺️ ROADMAP.md](reference/ROADMAP.md)** | Project roadmap and future development plans |
|
||||
| **[📝 CHANGELOG.md](reference/CHANGELOG.md)** | Detailed version history and changes |
|
||||
|
||||
### 💻 [Examples](examples/)
|
||||
Comprehensive examples demonstrating all features and capabilities.
|
||||
|
||||
| Category | Examples | Description |
|
||||
|----------|----------|-------------|
|
||||
| **🚀 Getting Started** | [examples/](examples/README.md) | Complete example documentation with 11 detailed examples |
|
||||
| **🤖 AI Features** | `ai_enhanced_processing.py` | AI-powered content analysis and optimization |
|
||||
| **🎥 Advanced Codecs** | `advanced_codecs_demo.py` | AV1, HEVC, and HDR processing |
|
||||
| **📡 Streaming** | `streaming_demo.py` | Adaptive streaming (HLS/DASH) creation |
|
||||
| **🌐 360° Video** | `360_video_examples.py` | Complete 360° processing with 7 examples |
|
||||
| **🐳 Production** | `docker_demo.py`, `worker_compatibility.py` | Deployment and scaling |
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Quick Navigation
|
||||
|
||||
### **New to Video Processor?**
|
||||
Start here for a complete introduction:
|
||||
1. **[📘 User Guide](user-guide/README_v0.4.0.md)** - Complete getting started guide
|
||||
2. **[💻 Basic Examples](examples/README.md)** - Hands-on examples to get you started
|
||||
3. **[🚀 New Features](user-guide/NEW_FEATURES_v0.4.0.md)** - What's new in v0.4.0
|
||||
|
||||
### **Upgrading from Previous Version?**
|
||||
Follow our migration guides:
|
||||
1. **[🔄 Migration Guide](migration/MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions
|
||||
2. **[📝 Changelog](reference/CHANGELOG.md)** - See what's changed
|
||||
|
||||
### **Looking for Specific Features?**
|
||||
- **🤖 AI Analysis**: [AI Implementation Summary](development/AI_IMPLEMENTATION_SUMMARY.md)
|
||||
- **🎥 Modern Codecs**: [Codec Implementation](development/PHASE_2_CODECS_SUMMARY.md)
|
||||
- **📡 Streaming**: [Streaming Examples](examples/README.md#-streaming-examples)
|
||||
- **🌐 360° Video**: [360° Examples](examples/README.md#-360-video-processing)
|
||||
|
||||
### **Need Technical Details?**
|
||||
- **🏗️ Architecture**: [Development Summary](development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)
|
||||
- **⚡ Advanced Features**: [Feature Reference](reference/ADVANCED_FEATURES.md)
|
||||
- **🗺️ Roadmap**: [Future Plans](reference/ROADMAP.md)
|
||||
|
||||
---
|
||||
|
||||
## 🎬 Video Processor Capabilities
|
||||
|
||||
The Video Processor v0.4.0 provides a complete multimedia processing platform with four integrated phases:
|
||||
|
||||
### **🤖 Phase 1: AI-Powered Content Analysis**
|
||||
- Intelligent scene detection and boundary identification
|
||||
- Comprehensive quality assessment (sharpness, brightness, contrast)
|
||||
- Motion analysis with intensity scoring
|
||||
- AI-powered thumbnail selection for optimal engagement
|
||||
- 360° content intelligence with automatic detection
|
||||
|
||||
### **🎥 Phase 2: Next-Generation Codecs**
|
||||
- **AV1 encoding** with 50% better compression than H.264
|
||||
- **HEVC/H.265** support with hardware acceleration
|
||||
- **HDR10 processing** with tone mapping and metadata preservation
|
||||
- **Multi-color space** support (Rec.2020, P3, sRGB)
|
||||
- **Two-pass optimization** for intelligent bitrate allocation
|
||||
|
||||
### **📡 Phase 3: Adaptive Streaming**
|
||||
- **HLS & DASH** adaptive streaming with multi-bitrate support
|
||||
- **Smart bitrate ladders** based on content analysis
|
||||
- **Real-time processing** with Procrastinate async tasks
|
||||
- **Multi-device optimization** for mobile, desktop, TV
|
||||
- **Progressive upload** capabilities
|
||||
|
||||
### **🌐 Phase 4: Complete 360° Video Processing**
|
||||
- **Multi-projection support**: Equirectangular, Cubemap, EAC, Stereographic, Fisheye
|
||||
- **Spatial audio processing**: Ambisonic, binaural, object-based, head-locked
|
||||
- **Viewport-adaptive streaming** with up to 75% bandwidth savings
|
||||
- **Tiled encoding** for streaming only visible regions
|
||||
- **Stereoscopic 3D** support for immersive content
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### **Installation**
|
||||
```bash
|
||||
# Install with all features
|
||||
uv add video-processor[all]
|
||||
|
||||
# Or install specific feature sets
|
||||
uv add video-processor[ai,360,streaming]
|
||||
```
|
||||
|
||||
### **Basic Usage**
|
||||
```python
|
||||
from video_processor import VideoProcessor
|
||||
from video_processor.config import ProcessorConfig
|
||||
|
||||
# Initialize with all features
|
||||
config = ProcessorConfig(
|
||||
quality_preset="high",
|
||||
enable_ai_analysis=True,
|
||||
enable_360_processing=True,
|
||||
output_formats=["mp4", "av1_mp4"]
|
||||
)
|
||||
|
||||
processor = VideoProcessor(config)
|
||||
|
||||
# Process any video (2D or 360°) with full analysis
|
||||
result = await processor.process_video("input.mp4", "./output/")
|
||||
|
||||
# Automatic optimization based on content type
|
||||
if result.is_360_video:
|
||||
print(f"🌐 360° {result.video_360.projection_type} processed")
|
||||
else:
|
||||
print("🎥 Standard video processed with AI analysis")
|
||||
|
||||
print(f"Quality: {result.quality_analysis.overall_quality:.1f}/10")
|
||||
```
|
||||
|
||||
For complete examples, see the **[Examples Documentation](examples/README.md)**.
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Development & Contributing
|
||||
|
||||
### **Development Setup**
|
||||
```bash
|
||||
git clone https://git.supported.systems/MCP/video-processor
|
||||
cd video-processor
|
||||
uv sync --dev
|
||||
```
|
||||
|
||||
### **Running Tests**
|
||||
```bash
|
||||
# Full test suite
|
||||
uv run pytest
|
||||
|
||||
# Specific feature tests
|
||||
uv run pytest tests/test_360_basic.py -v
|
||||
uv run pytest tests/unit/test_ai_content_analyzer.py -v
|
||||
```
|
||||
|
||||
### **Code Quality**
|
||||
```bash
|
||||
uv run ruff check . # Linting
|
||||
uv run mypy src/ # Type checking
|
||||
uv run ruff format . # Code formatting
|
||||
```
|
||||
|
||||
See the **[Development Documentation](development/)** for detailed technical information.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Community & Support
|
||||
|
||||
- **📖 Documentation**: You're here! Complete guides and references
|
||||
- **💻 Examples**: [examples/](examples/) - 11 comprehensive examples
|
||||
- **🐛 Issues**: Report bugs and request features on the repository
|
||||
- **🚀 Discussions**: Share use cases and get help from the community
|
||||
- **📧 Support**: Tag issues with appropriate labels for faster response
|
||||
|
||||
---
|
||||
|
||||
## 📜 License
|
||||
|
||||
MIT License - see [LICENSE](../LICENSE) for details.
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
**🎬 Video Processor v0.4.0**
|
||||
|
||||
*From Simple Encoding to Immersive Experiences*
|
||||
|
||||
**Complete Multimedia Processing Platform** | **Production Ready** | **Open Source**
|
||||
|
||||
</div>
|
||||
@ -219,9 +219,9 @@ This project has successfully evolved from a **simple video processor** extracte
|
||||
## 📚 Documentation Excellence
|
||||
|
||||
### **User Documentation**
|
||||
- **[NEW_FEATURES_v0.4.0.md](NEW_FEATURES_v0.4.0.md)**: Comprehensive feature overview with examples
|
||||
- **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)**: Step-by-step upgrade instructions
|
||||
- **[README_v0.4.0.md](README_v0.4.0.md)**: Complete getting started guide
|
||||
- **[NEW_FEATURES_v0.4.0.md](../user-guide/NEW_FEATURES_v0.4.0.md)**: Comprehensive feature overview with examples
|
||||
- **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)**: Step-by-step upgrade instructions
|
||||
- **[README_v0.4.0.md](../user-guide/README_v0.4.0.md)**: Complete getting started guide
|
||||
- **20+ Examples**: Real-world usage patterns and workflows
|
||||
|
||||
### **Developer Documentation**
|
||||
200
docs/examples/README.md
Normal file
200
docs/examples/README.md
Normal file
@ -0,0 +1,200 @@
|
||||
# 📚 Examples Documentation
|
||||
|
||||
This directory contains comprehensive examples demonstrating all features of the Video Processor v0.4.0.
|
||||
|
||||
## 🚀 Getting Started Examples
|
||||
|
||||
### [basic_usage.py](../../examples/basic_usage.py)
|
||||
**Start here!** Shows the fundamental video processing workflow with the main `VideoProcessor` class.
|
||||
|
||||
```python
|
||||
# Simple video processing
|
||||
processor = VideoProcessor(config)
|
||||
result = await processor.process_video("input.mp4", "./output/")
|
||||
```
|
||||
|
||||
### [custom_config.py](../../examples/custom_config.py)
|
||||
Demonstrates advanced configuration options and quality presets.
|
||||
|
||||
```python
|
||||
# Custom configuration for different use cases
|
||||
config = ProcessorConfig(
|
||||
quality_preset="ultra",
|
||||
output_formats=["mp4", "av1_mp4"],
|
||||
enable_ai_analysis=True
|
||||
)
|
||||
```
|
||||
|
||||
## 🤖 AI-Powered Features
|
||||
|
||||
### [ai_enhanced_processing.py](../../examples/ai_enhanced_processing.py)
|
||||
Complete AI content analysis with scene detection and quality assessment.
|
||||
|
||||
```python
|
||||
# AI-powered content analysis
|
||||
analysis = await analyzer.analyze_content(video_path)
|
||||
print(f"Scenes: {analysis.scenes.scene_count}")
|
||||
print(f"Quality: {analysis.quality_metrics.overall_quality}")
|
||||
```
|
||||
|
||||
## 🎥 Advanced Codec Examples
|
||||
|
||||
### [advanced_codecs_demo.py](../../examples/advanced_codecs_demo.py)
|
||||
Demonstrates AV1, HEVC, and HDR processing capabilities.
|
||||
|
||||
```python
|
||||
# Modern codec encoding
|
||||
config = ProcessorConfig(
|
||||
output_formats=["mp4", "av1_mp4", "hevc"],
|
||||
enable_av1_encoding=True,
|
||||
enable_hdr_processing=True
|
||||
)
|
||||
```
|
||||
|
||||
## 📡 Streaming Examples
|
||||
|
||||
### [streaming_demo.py](../../examples/streaming_demo.py)
|
||||
Shows how to create adaptive streaming packages (HLS/DASH) for web delivery.
|
||||
|
||||
```python
|
||||
# Create adaptive streaming
|
||||
streaming_package = await stream_processor.create_adaptive_stream(
|
||||
video_path, output_dir, formats=["hls", "dash"]
|
||||
)
|
||||
```
|
||||
|
||||
## 🌐 360° Video Processing
|
||||
|
||||
### [360_video_examples.py](../../examples/360_video_examples.py)
|
||||
**Comprehensive 360° showcase** with 7 detailed examples:
|
||||
|
||||
1. **Basic 360° Analysis** - Detect and analyze spherical videos
|
||||
2. **Projection Conversion** - Convert between equirectangular, cubemap, etc.
|
||||
3. **Viewport Extraction** - Extract flat videos from specific viewing angles
|
||||
4. **Spatial Audio Processing** - Handle ambisonic and binaural audio
|
||||
5. **360° Adaptive Streaming** - Viewport-adaptive streaming with bandwidth optimization
|
||||
6. **Batch Processing** - Convert multiple projections in parallel
|
||||
7. **Quality Analysis** - Assess 360° video quality and get optimization recommendations
|
||||
|
||||
### [video_360_example.py](../../examples/video_360_example.py)
|
||||
Focused example showing core 360° processing features.
|
||||
|
||||
## 🐳 Production Deployment
|
||||
|
||||
### [docker_demo.py](../../examples/docker_demo.py)
|
||||
Production deployment with Docker containers and environment configuration.
|
||||
|
||||
### [worker_compatibility.py](../../examples/worker_compatibility.py)
|
||||
Distributed processing with Procrastinate workers for scalable deployments.
|
||||
|
||||
### [async_processing.py](../../examples/async_processing.py)
|
||||
Advanced async patterns for high-throughput video processing.
|
||||
|
||||
## 🌐 Web Integration
|
||||
|
||||
### [web_demo.py](../../examples/web_demo.py)
|
||||
Flask web application demonstrating video processing API integration.
|
||||
|
||||
```python
|
||||
# Web API endpoint
|
||||
@app.post("/process")
|
||||
async def process_video_api(file: UploadFile):
|
||||
result = await processor.process_video(file.path, output_dir)
|
||||
return {"status": "success", "formats": list(result.encoded_files.keys())}
|
||||
```
|
||||
|
||||
## 🏃♂️ Running the Examples
|
||||
|
||||
### Prerequisites
|
||||
```bash
|
||||
# Install with all features
|
||||
uv add video-processor[all]
|
||||
|
||||
# Or install specific feature sets
|
||||
uv add video-processor[ai,360,streaming]
|
||||
```
|
||||
|
||||
### Basic Examples
|
||||
```bash
|
||||
# Run basic usage example
|
||||
uv run python examples/basic_usage.py
|
||||
|
||||
# Test AI analysis
|
||||
uv run python examples/ai_enhanced_processing.py
|
||||
|
||||
# Try 360° processing
|
||||
uv run python examples/360_video_examples.py
|
||||
```
|
||||
|
||||
### Advanced Examples
|
||||
```bash
|
||||
# Set up Docker environment
|
||||
uv run python examples/docker_demo.py
|
||||
|
||||
# Test streaming capabilities
|
||||
uv run python examples/streaming_demo.py
|
||||
|
||||
# Run web demo (requires Flask)
|
||||
uv add flask
|
||||
uv run python examples/web_demo.py
|
||||
```
|
||||
|
||||
## 🎯 Example Categories
|
||||
|
||||
| Category | Examples | Features Demonstrated |
|
||||
|----------|----------|----------------------|
|
||||
| **Basics** | `basic_usage.py`, `custom_config.py` | Core processing, configuration |
|
||||
| **AI Features** | `ai_enhanced_processing.py` | Scene detection, quality analysis |
|
||||
| **Modern Codecs** | `advanced_codecs_demo.py` | AV1, HEVC, HDR processing |
|
||||
| **Streaming** | `streaming_demo.py` | HLS, DASH adaptive streaming |
|
||||
| **360° Video** | `360_video_examples.py`, `video_360_example.py` | Immersive video processing |
|
||||
| **Production** | `docker_demo.py`, `worker_compatibility.py` | Deployment, scaling |
|
||||
| **Integration** | `web_demo.py`, `async_processing.py` | Web APIs, async patterns |
|
||||
|
||||
## 💡 Tips for Learning
|
||||
|
||||
1. **Start Simple**: Begin with `basic_usage.py` to understand the core concepts
|
||||
2. **Progress Gradually**: Move through AI → Codecs → Streaming → 360° features
|
||||
3. **Experiment**: Modify the examples with your own video files
|
||||
4. **Check Logs**: Enable logging to see detailed processing information
|
||||
5. **Read Comments**: Each example includes detailed explanations and best practices
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Missing Dependencies**
|
||||
```bash
|
||||
# AI features require OpenCV
|
||||
pip install opencv-python
|
||||
|
||||
# 360° processing needs additional packages
|
||||
pip install numpy opencv-python
|
||||
```
|
||||
|
||||
**FFmpeg Not Found**
|
||||
```bash
|
||||
# Install FFmpeg (varies by OS)
|
||||
# Ubuntu/Debian: sudo apt install ffmpeg
|
||||
# macOS: brew install ffmpeg
|
||||
# Windows: Download from ffmpeg.org
|
||||
```
|
||||
|
||||
**Import Errors**
|
||||
```bash
|
||||
# Ensure video-processor is installed
|
||||
uv add video-processor
|
||||
|
||||
# For development
|
||||
uv sync --dev
|
||||
```
|
||||
|
||||
### Getting Help
|
||||
|
||||
- Check the [migration guide](../migration/MIGRATION_GUIDE_v0.4.0.md) for upgrade instructions
|
||||
- See [user guide](../user-guide/NEW_FEATURES_v0.4.0.md) for complete feature documentation
|
||||
- Review [development docs](../development/) for technical implementation details
|
||||
|
||||
---
|
||||
|
||||
*These examples demonstrate the full capabilities of Video Processor v0.4.0 - from simple format conversion to advanced 360° immersive experiences with AI optimization.*
|
||||
@ -163,9 +163,9 @@ uv run pytest --collect-only
|
||||
|
||||
### 📚 Additional Resources
|
||||
|
||||
- **[CHANGELOG.md](CHANGELOG.md)** - Complete list of changes
|
||||
- **[README.md](README.md)** - Updated documentation
|
||||
- **[tests/README.md](tests/README.md)** - Testing guide
|
||||
- **[CHANGELOG.md](../reference/CHANGELOG.md)** - Complete list of changes
|
||||
- **[README.md](../../README.md)** - Updated documentation
|
||||
- **[tests/README.md](../../tests/README.md)** - Testing guide
|
||||
- **[Makefile](Makefile)** - Available commands
|
||||
|
||||
### 🎉 Benefits of Upgrading
|
||||
@ -179,7 +179,7 @@ uv run pytest --collect-only
|
||||
|
||||
If you encounter any issues during the upgrade:
|
||||
1. Check this upgrade guide first
|
||||
2. Review the [CHANGELOG.md](CHANGELOG.md) for detailed changes
|
||||
2. Review the [CHANGELOG.md](../reference/CHANGELOG.md) for detailed changes
|
||||
3. Run the test suite to verify functionality
|
||||
4. Open an issue if problems persist
|
||||
|
||||
@ -320,12 +320,12 @@ async def create_vr_trailer(source_360_video):
|
||||
|
||||
### **📖 User Documentation**
|
||||
- **[NEW_FEATURES_v0.4.0.md](NEW_FEATURES_v0.4.0.md)** - Complete feature overview with examples
|
||||
- **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions
|
||||
- **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions
|
||||
- **[README_v0.4.0.md](README_v0.4.0.md)** - Getting started and API reference
|
||||
- **20+ Examples** - Real-world usage patterns and workflows
|
||||
|
||||
### **🔧 Developer Documentation**
|
||||
- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)** - Full development history
|
||||
- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](../development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)** - Full development history
|
||||
- **API Reference** - Complete method documentation with type hints
|
||||
- **Architecture Guides** - System design and integration patterns
|
||||
- **Testing Documentation** - Test suite overview and extension guide
|
||||
@ -343,8 +343,8 @@ graph TB
|
||||
|
||||
### **📚 Core Guides**
|
||||
- **[NEW_FEATURES_v0.4.0.md](NEW_FEATURES_v0.4.0.md)**: Complete feature overview with examples
|
||||
- **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)**: Upgrade from previous versions
|
||||
- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)**: Full architecture and development history
|
||||
- **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)**: Upgrade from previous versions
|
||||
- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](../development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)**: Full architecture and development history
|
||||
|
||||
### **🔧 API Reference**
|
||||
- **Core Processing**: `VideoProcessor`, `ProcessorConfig`, processing results
|
||||
@ -398,7 +398,7 @@ config.enable_360_processing = True
|
||||
streaming_package = await stream_processor.create_adaptive_stream(...)
|
||||
```
|
||||
|
||||
See **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)** for complete migration instructions.
|
||||
See **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)** for complete migration instructions.
|
||||
|
||||
---
|
||||
|
||||
@ -6,7 +6,7 @@ build-backend = "hatchling.build"
|
||||
name = "video-processor"
|
||||
version = "0.3.0"
|
||||
description = "Standalone video processing pipeline with multiple format encoding"
|
||||
authors = [{name = "Video Processor", email = "dev@example.com"}]
|
||||
authors = [{name = "Ryan Malloy", email = "ryan@malloys.us"}]
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.11"
|
||||
dependencies = [
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user