Delete README.md

README.md

@@ -1,280 +0,0 @@
----
-title: Ffmpeg
-emoji: 👀
-colorFrom: green
-colorTo: yellow
-sdk: docker
-pinned: false
-license: mit
----
-
-# Basyx FFmpeg Automation Hub
-
-FastAPI + Gradio app for common FFmpeg media tasks. It can run directly in
-Docker/Hugging Face Spaces and exposes both a browser UI and HTTP API.
-
-## Features
-
-- Task-specific Gradio controls for video, audio, subtitle, image, and social presets.
-- File and URL inputs, including `yt-dlp` downloads.
-- Input validation with `python-magic`, upload size limits, and temp-file cleanup.
-- Synchronous execution at `/execute/{task_id}`.
-- Background jobs at `/jobs/{task_id}` with `/status/{job_id}` and `/download/{job_id}`.
-- Recent output history at `/history` with per-item download URLs.
-- Configurable FFmpeg options: CRF, preset, resolution, audio bitrate, trim times,
-  aspect ratio, GIF settings, watermark settings, speed, frame rate, and text styling.
-- Persistent SQLite job/history state.
-- FFmpeg execution timeout, production readiness checks, and URL download limits.
-- Faceless short-video automation for quote cards, story slides, image narration,
-  b-roll narration, and vertical montage generation.
-- TikTok/Reels mini-series packaging with numbered episodes, recap cards, and
-  ZIP exports containing publish-order manifests.
-- Built-in MCP server exposing task discovery and media processing as AI tools.
-
-## Tasks
-
-Call `GET /tasks` to list the current task registry with file requirements.
-
-The registry currently contains 90 allowlisted tasks. Major groups include:
-
-- Timeline editing: `trim`, `split_video`, `remove_section`, `concat`,
-  `reverse_video`, `freeze_frame`, `boomerang`, `loop_video`, and `speed`.
-- Audio post: `audio_trim`, `audio_merge`, `audio_mix`, `audio_normalize`,
-  `audio_fade`, `audio_delay`, `audio_speed`, `audio_channels`, and `audio_denoise`.
-- Images/slideshows: `image_process`, `image_watermark`, `slideshow`,
-  `crossfade_slideshow`, `ken_burns_slideshow`, and `narrated_slideshow`.
-- Subtitles: `add_subtitles`, `burn_lyrics`, `soft_subtitles`,
-  `remove_subtitles`, and SRT/ASS/VTT conversion tasks.
-- Series production: `episode_assembly`, `create_trailer`, `create_teaser`,
-  faceless content tasks, and mini-series packaging tasks.
-- Effects/rendering: `video_transition`, `video_animation`, `video_effect`,
-  `render_image_sequence`, `render_alpha_webm`, and `video_enhance`.
-- Delivery: `social_format`, `encode_video`, `encode_webm`, MOV/MKV/AVI
-  conversion, AAC/MP3/FLAC/WAV/OGG/Opus/AC3 audio, and `streaming_compress`.
-
-See the [capability matrix](n8n/FEATURE_MATRIX.md) for the full mapping and
-n8n parameters for every multimedia category.
-
-## MCP Server
-
-MCP is enabled by default. The mounted Gradio application serves Streamable HTTP
-at:
-
-```text
-http://localhost:7860/gradio_api/mcp/
-```
-
-Inspect its generated tool schemas at
-`http://localhost:7860/gradio_api/mcp/schema`. It exposes:
-
-- `list_ffmpeg_tasks`: returns all task IDs and file requirements.
-- `run_ffmpeg_task`: runs a task with files, a media URL, standard controls, and
-  an allowlisted advanced-options JSON object.
-- one fixed tool for each of the 90 task IDs, such as `compress`, `trim`,
-  `video_effect`, and `audio_mix`. These tools accept `files`, `url`, and an
-  `options` JSON object without requiring a separate task selector.
-
-Every MCP tool description includes a fenced JSON payload example. The fixed
-task descriptions also document file-count requirements, accepted media types,
-output extension, and upload order.
-
-Set `GRADIO_MCP_SERVER=False` to disable MCP. When `API_AUTH_TOKEN` is set, MCP
-clients must send the same bearer token or `X-API-Key` used by the REST API.
-See [MCP.md](MCP.md) for connection and usage examples.
-
-## API Examples
-
-Run a task immediately and download the returned file:
-
-```bash
-curl -X POST \
-  -F "files=@input.mp4" \
-  -F "resolution=720p" \
-  -F "crf=28" \
-  http://localhost:7860/execute/compress \
-  --output compressed.mp4
-```
-
-Run a background job:
-
-```bash
-curl -X POST \
-  -F "files=@input.mp4" \
-  -F "text=Launch caption" \
-  -F "callback_url=https://example.com/ffmpeg-callback" \
-  http://localhost:7860/jobs/text_overlay
-```
-
-Check the job:
-
-```bash
-curl http://localhost:7860/status/<job_id>
-```
-
-Download a completed background job:
-
-```bash
-curl http://localhost:7860/download/<job_id> --output result.mp4
-```
-
-Use a URL input:
-
-```bash
-curl -X POST \
-  -F "url=https://example.com/video.mp4" \
-  http://localhost:7860/execute/thumbnail \
-  --output thumbnail.jpg
-```
-
-The standard multipart endpoints and browser UI also accept advanced task
-options as an allowlisted JSON object:
-
-```bash
-curl -X POST \
-  -F "files=@scene.mp4" \
-  -F 'options_json={"effect":"vhs"}' \
-  http://localhost:7860/jobs/video_effect
-```
-
-## n8n Inputs
-
-Use `POST /n8n/execute/{task_id}` for immediate file output or
-`POST /n8n/jobs/{task_id}` for background jobs. These endpoints accept common
-n8n HTTP Request node payload styles:
-
-- multipart form-data with any binary field name
-- form-data URL fields: `url`, `urls`, `file_url`, `source_url`, `download_url`
-- JSON base64 files in `files`, `binary`, or `data`
-- JSON URL lists
-- raw binary body for single-file tasks, with optional `X-Filename` header
-
-For a ready-to-run n8n + API stack and node-by-node setup, see
-[`n8n/README.md`](n8n/README.md):
-
-```bash
-cp .env.example .env
-export N8N_ENCRYPTION_KEY="$(openssl rand -hex 32)"
-docker compose -f compose.n8n.yml up --build
-```
-
-`GET /n8n` returns a machine-readable integration manifest. Background job
-responses contain absolute `status_url` and, when complete, `download_url`
-values. Set `PUBLIC_BASE_URL` in reverse-proxy or container deployments so those
-URLs are reachable from n8n.
-
-Send an `Idempotency-Key` header when creating a job. Repeated requests with the
-same task and key return the original job for 24 hours rather than running
-FFmpeg twice:
-
-```bash
-curl -X POST \
-  -H "Idempotency-Key: n8n-execution-123-item-0" \
-  -H "Content-Type: application/json" \
-  -d '{"url":"https://example.com/video.mp4","crf":"25"}' \
-  http://localhost:7860/n8n/jobs/compress
-```
-
-Multipart binary from n8n:
-
-```bash
-curl -X POST \
-  -F "myBinary=@input.mp4" \
-  -F "text=Episode 1" \
-  http://localhost:7860/n8n/execute/series_episode_badge \
-  --output episode.mp4
-```
-
-JSON base64:
-
-```json
-{
-  "text": "Episode title",
-  "files": [
-    {
-      "fileName": "input.mp4",
-      "mimeType": "video/mp4",
-      "data": "<base64>"
-    }
-  ]
-}
-```
-
-JSON URLs:
-
-```json
-{
-  "urls": ["https://example.com/input.mp4"],
-  "text": "Mini series title",
-  "duration": "60",
-  "callback_url": "https://example.com/ffmpeg-callback"
-}
-```
-
-Template preset:
-
-```json
-{
-  "template_id": "faceless_motivation",
-  "text": "Small steps compound when you stay consistent."
-}
-```
-
-Raw binary:
-
-```bash
-curl -X POST \
-  -H "Content-Type: application/octet-stream" \
-  -H "X-Filename: input.mp4" \
-  --data-binary @input.mp4 \
-  http://localhost:7860/n8n/execute/reels_blur_fit \
-  --output output.mp4
-```
-
-## Configuration
-
-Environment variables:
-
-- `TEMP_DIR`: working directory for uploads and outputs. Default: `temp`.
-- `STATE_DB_PATH`: SQLite path for job/history state. Default: `TEMP_DIR/state.sqlite3`.
-- `FONT_PATH`: font used by FFmpeg `drawtext`. Default:
-  `/usr/share/fonts/truetype/dejavu/DejaVuSans-Bold.ttf`.
-- `MAX_UPLOAD_MB`: max upload size per file. Default: `500`.
-- `MAX_URL_DOWNLOAD_MB`: max URL download size. Default: same as `MAX_UPLOAD_MB`.
-- `ALLOW_URL_INPUTS`: enable/disable URL downloads. Default: `true`.
-- `FFMPEG_TIMEOUT_SECONDS`: max runtime for an FFmpeg command. Default: `1800`.
-- `CALLBACK_TIMEOUT_SECONDS`: callback POST timeout. Default: `15`.
-- `CALLBACK_RETRIES`: callback attempts after a completed/failed job. Default: `3`.
-- `N8N_CALLBACK_TOKEN`: optional bearer token sent to callback webhooks.
-- `PUBLIC_BASE_URL`: externally reachable API base used in job/callback URLs.
-- `IDEMPOTENCY_TTL_SECONDS`: duplicate n8n job suppression window. Default: `86400`.
-- `FILE_TTL_SECONDS`: temp file lifetime. Default: `3600`.
-- `HISTORY_LIMIT`: number of recent output records to keep. Default: `50`.
-- `API_AUTH_TOKEN`: optional bearer/API-key token for all endpoints except health checks.
-- `GRADIO_MCP_SERVER`: enable the Gradio MCP server. Default: `True`.
-- `MAX_MEDIA_DURATION_SECONDS`: max input audio/video duration. Default: `7200`.
-- `MAX_OUTPUT_MB`: max generated output size. Default: `1000`.
-- `MAX_BATCH_JOBS`: max files accepted by unlimited multi-file tasks. Default: `20`.
-- `WHISPER_MODEL`, `WHISPER_DEVICE`, `WHISPER_COMPUTE_TYPE`: optional
-  faster-whisper settings for deployments that add transcription support.
-
-## Production Checks
-
-- `GET /healthz`: process health and dependency check details.
-- `GET /readyz`: returns `503` if required runtime dependencies are missing.
-
-Required runtime dependencies:
-
-- `ffmpeg`
-- `ffprobe`
-- writable `TEMP_DIR`
-- writable SQLite state database
-- readable `FONT_PATH`
-
-## Local Run
-
-```bash
-pip install -r requirements.txt
-python app.py
-```
-
-The app listens on `http://localhost:7860`.