ControlFoley Audio Generator

A multi-functional audio generation tool powered by the ControlFoley model, integrating video sound effect (SFX) generation, video background music composition, text-to-audio and other functions to realize diversified creative audio generation.

This tool supports four modes: Video-to-Audio (V2A), Text-Controlled Video-to-Audio (TC-V2A), Audio-Controlled Video-to-Audio (AC-V2A), and Text-to-Audio (T2A).

Basic Info

Prerequisites

python3 --version   # Python 3.x
curl --version      # curl for API submission
ffmpeg -version     # optional, for audio format conversion

Modes

Usage (CLI version)

1. Text-to-Audio (T2A, default 8s)

python3 scripts/foley.py t2a "dog barking loudly in a park"

2. Video-to-Audio (V2A)

python3 scripts/foley.py v2a input.mp4

3. Text-Controlled Video-to-Audio (TC-V2A)

python3 scripts/foley.py v2a input.mp4 --prompt "footsteps on gravel with birds chirping"

4. Audio-Controlled Video-to-Audio (AC-V2A)

python3 scripts/foley.py v2a input.mp4 --ref-audio reference.wav

5. Specify duration

python3 scripts/foley.py t2a "A mountain stream murmurs, its gentle current lapping against the pebbles." --duration 15

6. Generate multiple candidates

python3 scripts/foley.py t2a "cat purring softly" --count 3

7. Fixed seed (reproducible results)

python3 scripts/foley.py t2a "rain on a tin roof" --seed 42

8. List available models

python3 scripts/foley.py models

Usage (API version)

POST

curl -X POST "https://controlfoley.ai.xiaomi.com/api/v1/v2a/submit" -F "file=@video_path" -F "prompt=footsteps on gravel with birds chirping"

return

{"taskId": "xxx", "message": "Task submitted successfully"}

GET

1. Available Models

curl -X GET "https://controlfoley.ai.xiaomi.com/api/v1/v2a/models" 

return

{"models":[{"name":"ControlFoley","enabled":true}]}

2. Status Inquiry

curl -X GET "https://controlfoley.ai.xiaomi.com/api/v1/v2a/status/{taskId}" 

return

1. success：

{"urls":["{Domain name}/ControlFoley_output/{taskId}/{filename}"],"status":"success","done":true}

1. processing：

{"status":"processing","done":false}

1. pending:

{"status":"pending","queue_pos":1,"queue_position":1,"total_queue":2,"done":false}

3. Result Download

curl -X GET "https://controlfoley.ai.xiaomi.com/ControlFoley_output/{taskId}/{filename}" --output ./output.flac

4. Status Inquiry & Result Download

curl -X GET "https://controlfoley.ai.xiaomi.com/api/v1/v2a/status_download/{taskId}" --output-dir ./output --output audio.zip

Parameters

T2A (Text-to-Audio)

V2A (Video-to-Audio)

Prompt Tips

• Be specific: "cat footsteps on wooden floor" beats "cat sound"
• Use negative prompts: --negative "human voice, music, noise" to filter unwanted audio
• CFG tuning: high CFG (6.0–7.5) for precise control, low CFG (3.0–4.5) for creative freedom

Output & Post-Processing

• Audio: .flac (44100 Hz, lossless)
• Video: .mp4 (original video + generated audio track)
• Results saved to --outdir, paths printed to stdout

Convert to MP3 for sharing:

ffmpeg -i output.flac -codec:a libmp3lame -qscale:a 2 output.mp3

Error Handling

API Reference

See ./references/api-reference.md for full endpoint documentation.

⚠️ Privacy & Security

• Service Operator: Cloud processing is operated by the Xiaomi LLM Plus Team at https://controlfoley.ai.xiaomi.com
• Data Upload: V2A/TC-V2A/AC-V2A modes upload the full video file to the remote service for processing. Do not upload videos containing sensitive personal or identifiable information
• Data Processing: Uploaded videos and audio are used solely for audio generation. Results are returned via URL. Refer to the Xiaomi LLM Plus Team's terms of service for data retention and access control policies
• No API Key Required: The service requires no authentication — please use it responsibly to avoid unnecessary load
• Recommendation: Before first use, validate with a small, non-sensitive test clip