Compare commits
1 Commits
fix/issue-
...
fix/670-ap
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0317b30dd6 |
80
docs/approval-tiers.md
Normal file
80
docs/approval-tiers.md
Normal file
@@ -0,0 +1,80 @@
|
||||
# Approval Tier System
|
||||
|
||||
Graduated safety for command approval based on risk level.
|
||||
|
||||
## Tiers
|
||||
|
||||
| Tier | Name | Action Types | Who Approves | Timeout |
|
||||
|------|------|--------------|--------------|---------|
|
||||
| 0 | SAFE | Read, search, list, view | None | N/A |
|
||||
| 1 | LOW | Write, create, edit, script | LLM only | N/A |
|
||||
| 2 | MEDIUM | Messages, API, email | Human + LLM | 60s |
|
||||
| 3 | HIGH | Crypto, config, deploy | Human + LLM | 30s |
|
||||
| 4 | CRITICAL | Delete, kill, shutdown | Human + LLM | 10s |
|
||||
|
||||
## How It Works
|
||||
|
||||
1. **Detection**: `detect_tier(command, action)` analyzes the command and action type
|
||||
2. **Auto-approve**: SAFE and LOW tiers are automatically approved
|
||||
3. **Human approval**: MEDIUM+ tiers require human confirmation
|
||||
4. **Timeout handling**: If no response within timeout, escalate to next tier
|
||||
5. **Crisis bypass**: 988 Lifeline commands bypass approval entirely
|
||||
|
||||
## Usage
|
||||
|
||||
```python
|
||||
from tools.approval import TieredApproval, detect_tier, ApprovalTier
|
||||
|
||||
# Detect tier
|
||||
tier = detect_tier("rm -rf /tmp/data") # Returns ApprovalTier.CRITICAL
|
||||
|
||||
# Request approval
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "send message", action="send_message")
|
||||
|
||||
if result["approved"]:
|
||||
# Auto-approved (SAFE or LOW tier)
|
||||
execute_command()
|
||||
else:
|
||||
# Needs human approval
|
||||
show_approval_ui(result["approval_id"], result["tier"], result["timeout"])
|
||||
```
|
||||
|
||||
## Crisis Bypass
|
||||
|
||||
Commands containing crisis keywords (988, suicide, self-harm, crisis hotline) automatically bypass approval to ensure immediate help:
|
||||
|
||||
```python
|
||||
from tools.approval import is_crisis_bypass
|
||||
|
||||
is_crisis_bypass("call 988 for help") # True — bypasses approval
|
||||
```
|
||||
|
||||
## Timeout Escalation
|
||||
|
||||
When a tier times out without human response:
|
||||
- MEDIUM → HIGH (30s timeout)
|
||||
- HIGH → CRITICAL (10s timeout)
|
||||
- CRITICAL → Deny
|
||||
|
||||
## Integration
|
||||
|
||||
The tier system integrates with:
|
||||
- **CLI**: Interactive prompts with tier-aware timeouts
|
||||
- **Gateway**: Telegram/Discord approval buttons
|
||||
- **Cron**: Auto-approve LOW tier, escalate MEDIUM+
|
||||
|
||||
## Testing
|
||||
|
||||
Run tests with:
|
||||
```bash
|
||||
python -m pytest tests/test_approval_tiers.py -v
|
||||
```
|
||||
|
||||
26 tests covering:
|
||||
- Tier detection from commands and actions
|
||||
- Timeout values per tier
|
||||
- Approver requirements
|
||||
- Crisis bypass logic
|
||||
- Approval request and resolution
|
||||
- Timeout escalation
|
||||
141
tests/test_approval_tiers.py
Normal file
141
tests/test_approval_tiers.py
Normal file
@@ -0,0 +1,141 @@
|
||||
"""Tests for approval tier system (Issue #670)."""
|
||||
import sys
|
||||
from pathlib import Path
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent))
|
||||
|
||||
from tools.approval import (
|
||||
ApprovalTier, detect_tier, get_tier_timeout, get_tier_approvers,
|
||||
requires_human_approval, is_crisis_bypass, TieredApproval, get_tiered_approval
|
||||
)
|
||||
|
||||
|
||||
class TestApprovalTier:
|
||||
def test_safe_read(self):
|
||||
assert detect_tier("cat file.txt") == ApprovalTier.SAFE
|
||||
|
||||
def test_safe_search(self):
|
||||
assert detect_tier("grep pattern file") == ApprovalTier.SAFE
|
||||
|
||||
def test_low_write(self):
|
||||
assert detect_tier("write to file", action="write") == ApprovalTier.LOW
|
||||
|
||||
def test_medium_message(self):
|
||||
assert detect_tier("send message", action="send_message") == ApprovalTier.MEDIUM
|
||||
|
||||
def test_high_config(self):
|
||||
assert detect_tier("edit config", action="config") == ApprovalTier.HIGH
|
||||
|
||||
def test_critical_delete(self):
|
||||
assert detect_tier("rm -rf /", action="delete") == ApprovalTier.CRITICAL
|
||||
|
||||
def test_crisis_keyword(self):
|
||||
assert detect_tier("call 988 for help") == ApprovalTier.CRITICAL
|
||||
|
||||
def test_dangerous_pattern_escalation(self):
|
||||
# rm -rf should be CRITICAL
|
||||
assert detect_tier("rm -rf /tmp/data") == ApprovalTier.CRITICAL
|
||||
|
||||
|
||||
class TestTierTimeouts:
|
||||
def test_safe_no_timeout(self):
|
||||
assert get_tier_timeout(ApprovalTier.SAFE) == 0
|
||||
|
||||
def test_medium_60s(self):
|
||||
assert get_tier_timeout(ApprovalTier.MEDIUM) == 60
|
||||
|
||||
def test_high_30s(self):
|
||||
assert get_tier_timeout(ApprovalTier.HIGH) == 30
|
||||
|
||||
def test_critical_10s(self):
|
||||
assert get_tier_timeout(ApprovalTier.CRITICAL) == 10
|
||||
|
||||
|
||||
class TestTierApprovers:
|
||||
def test_safe_no_approvers(self):
|
||||
assert get_tier_approvers(ApprovalTier.SAFE) == ()
|
||||
|
||||
def test_low_llm_only(self):
|
||||
assert get_tier_approvers(ApprovalTier.LOW) == ("llm",)
|
||||
|
||||
def test_medium_human_llm(self):
|
||||
assert get_tier_approvers(ApprovalTier.MEDIUM) == ("human", "llm")
|
||||
|
||||
def test_requires_human(self):
|
||||
assert requires_human_approval(ApprovalTier.SAFE) == False
|
||||
assert requires_human_approval(ApprovalTier.LOW) == False
|
||||
assert requires_human_approval(ApprovalTier.MEDIUM) == True
|
||||
assert requires_human_approval(ApprovalTier.HIGH) == True
|
||||
assert requires_human_approval(ApprovalTier.CRITICAL) == True
|
||||
|
||||
|
||||
class TestCrisisBypass:
|
||||
def test_988_bypass(self):
|
||||
assert is_crisis_bypass("call 988") == True
|
||||
|
||||
def test_suicide_prevention(self):
|
||||
assert is_crisis_bypass("contact suicide prevention") == True
|
||||
|
||||
def test_normal_command(self):
|
||||
assert is_crisis_bypass("ls -la") == False
|
||||
|
||||
|
||||
class TestTieredApproval:
|
||||
def test_safe_auto_approves(self):
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "cat file.txt")
|
||||
assert result["approved"] == True
|
||||
assert result["tier"] == ApprovalTier.SAFE
|
||||
|
||||
def test_low_auto_approves(self):
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "write file", action="write")
|
||||
assert result["approved"] == True
|
||||
assert result["tier"] == ApprovalTier.LOW
|
||||
|
||||
def test_medium_needs_approval(self):
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "send message", action="send_message")
|
||||
assert result["approved"] == False
|
||||
assert result["tier"] == ApprovalTier.MEDIUM
|
||||
assert "approval_id" in result
|
||||
|
||||
def test_crisis_bypass(self):
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "call 988 for help")
|
||||
assert result["approved"] == True
|
||||
assert result["reason"] == "crisis_bypass"
|
||||
|
||||
def test_resolve_approval(self):
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "send message", action="send_message")
|
||||
approval_id = result["approval_id"]
|
||||
|
||||
assert ta.resolve_approval(approval_id, True) == True
|
||||
assert approval_id not in ta._pending
|
||||
|
||||
def test_timeout_escalation(self):
|
||||
ta = TieredApproval()
|
||||
result = ta.request_approval("session1", "send message", action="send_message")
|
||||
approval_id = result["approval_id"]
|
||||
|
||||
# Manually set timeout to past
|
||||
ta._timeouts[approval_id] = 0
|
||||
|
||||
timed_out = ta.check_timeouts()
|
||||
assert approval_id in timed_out
|
||||
|
||||
# Should have escalated to HIGH tier
|
||||
if approval_id in ta._pending:
|
||||
assert ta._pending[approval_id]["tier"] == ApprovalTier.HIGH
|
||||
|
||||
|
||||
class TestGetTieredApproval:
|
||||
def test_singleton(self):
|
||||
ta1 = get_tiered_approval()
|
||||
ta2 = get_tiered_approval()
|
||||
assert ta1 is ta2
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
import pytest
|
||||
pytest.main([__file__, "-v"])
|
||||
@@ -1,105 +0,0 @@
|
||||
"""Tests for shared audio analysis engine.
|
||||
|
||||
Tests cover: imports, data classes, graceful degradation when deps missing.
|
||||
Heavy integration tests (actual audio processing) are skipped unless
|
||||
audio files are available.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
import sys
|
||||
import os
|
||||
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
|
||||
|
||||
from tools.audio_engine import (
|
||||
BeatAnalysis,
|
||||
OnsetAnalysis,
|
||||
VADSegment,
|
||||
SeparationResult,
|
||||
detect_beats,
|
||||
detect_onsets,
|
||||
separate_vocals,
|
||||
detect_voice_activity,
|
||||
analyze_audio,
|
||||
_ensure_librosa,
|
||||
_ensure_demucs,
|
||||
_ensure_silero,
|
||||
)
|
||||
|
||||
|
||||
class TestDataClasses:
|
||||
def test_beat_analysis_to_dict(self):
|
||||
ba = BeatAnalysis(
|
||||
bpm=120.0,
|
||||
beat_times=[0.0, 0.5, 1.0],
|
||||
beat_frames=[0, 100, 200],
|
||||
tempo_confidence=0.8,
|
||||
duration=3.0,
|
||||
sample_rate=22050,
|
||||
)
|
||||
d = ba.to_dict()
|
||||
assert d["bpm"] == 120.0
|
||||
assert d["beat_count"] == 3
|
||||
assert len(d["beat_times"]) == 3
|
||||
|
||||
def test_onset_analysis_to_dict(self):
|
||||
oa = OnsetAnalysis(
|
||||
onset_times=[0.1, 0.5],
|
||||
onset_frames=[10, 50],
|
||||
onset_count=2,
|
||||
avg_onset_interval=0.4,
|
||||
)
|
||||
d = oa.to_dict()
|
||||
assert d["onset_count"] == 2
|
||||
assert d["avg_onset_interval"] == 0.4
|
||||
|
||||
def test_vad_segment_to_dict(self):
|
||||
seg = VADSegment(start=1.0, end=2.5, is_speech=True)
|
||||
d = seg.to_dict()
|
||||
assert d["start"] == 1.0
|
||||
assert d["end"] == 2.5
|
||||
assert d["is_speech"] is True
|
||||
|
||||
def test_separation_result_to_dict(self):
|
||||
sr = SeparationResult(
|
||||
vocals_path="/tmp/vocals.wav",
|
||||
instrumental_path="/tmp/inst.wav",
|
||||
duration=120.0,
|
||||
)
|
||||
d = sr.to_dict()
|
||||
assert d["vocals_path"] == "/tmp/vocals.wav"
|
||||
assert d["duration"] == 120.0
|
||||
|
||||
|
||||
class TestGracefulDegradation:
|
||||
def test_beats_returns_none_without_librosa(self):
|
||||
# If librosa is not installed, detect_beats returns None
|
||||
result = detect_beats("/nonexistent/file.wav")
|
||||
# Either None (no librosa) or None (file not found) — both acceptable
|
||||
assert result is None or isinstance(result, BeatAnalysis)
|
||||
|
||||
def test_onsets_returns_none_without_librosa(self):
|
||||
result = detect_onsets("/nonexistent/file.wav")
|
||||
assert result is None or isinstance(result, OnsetAnalysis)
|
||||
|
||||
def test_separation_returns_none_without_demucs(self):
|
||||
result = separate_vocals("/nonexistent/file.wav")
|
||||
assert result is None or isinstance(result, SeparationResult)
|
||||
|
||||
def test_vad_returns_none_without_silero(self):
|
||||
result = detect_voice_activity("/nonexistent/file.wav")
|
||||
assert result is None or isinstance(result, list)
|
||||
|
||||
|
||||
class TestDependencyChecks:
|
||||
def test_ensure_librosa_returns_none_or_module(self):
|
||||
result = _ensure_librosa()
|
||||
assert result is None or result is not None # Either is fine
|
||||
|
||||
def test_ensure_demucs_is_bool(self):
|
||||
result = _ensure_demucs()
|
||||
assert isinstance(result, bool)
|
||||
|
||||
def test_ensure_silero_is_bool(self):
|
||||
result = _ensure_silero()
|
||||
assert isinstance(result, bool)
|
||||
@@ -133,6 +133,183 @@ DANGEROUS_PATTERNS = [
|
||||
]
|
||||
|
||||
|
||||
# =========================================================================
|
||||
# Approval Tier System (Issue #670)
|
||||
# =========================================================================
|
||||
|
||||
from enum import IntEnum
|
||||
import time
|
||||
|
||||
class ApprovalTier(IntEnum):
|
||||
"""Safety tiers for command approval.
|
||||
|
||||
Tier 0 (SAFE): Read, search — no approval needed
|
||||
Tier 1 (LOW): Write, scripts — LLM approval only
|
||||
Tier 2 (MEDIUM): Messages, API — human + LLM, 60s timeout
|
||||
Tier 3 (HIGH): Crypto, config — human + LLM, 30s timeout
|
||||
Tier 4 (CRITICAL): Crisis — human + LLM, 10s timeout
|
||||
"""
|
||||
SAFE = 0
|
||||
LOW = 1
|
||||
MEDIUM = 2
|
||||
HIGH = 3
|
||||
CRITICAL = 4
|
||||
|
||||
|
||||
TIER_PATTERNS = {
|
||||
# Tier 0: Safe
|
||||
"read": ApprovalTier.SAFE, "search": ApprovalTier.SAFE, "list": ApprovalTier.SAFE,
|
||||
"view": ApprovalTier.SAFE, "cat": ApprovalTier.SAFE, "grep": ApprovalTier.SAFE,
|
||||
# Tier 1: Low
|
||||
"write": ApprovalTier.LOW, "create": ApprovalTier.LOW, "edit": ApprovalTier.LOW,
|
||||
"patch": ApprovalTier.LOW, "copy": ApprovalTier.LOW, "mkdir": ApprovalTier.LOW,
|
||||
"script": ApprovalTier.LOW, "execute": ApprovalTier.LOW, "run": ApprovalTier.LOW,
|
||||
# Tier 2: Medium
|
||||
"send_message": ApprovalTier.MEDIUM, "message": ApprovalTier.MEDIUM,
|
||||
"email": ApprovalTier.MEDIUM, "api": ApprovalTier.MEDIUM, "post": ApprovalTier.MEDIUM,
|
||||
"telegram": ApprovalTier.MEDIUM, "discord": ApprovalTier.MEDIUM,
|
||||
# Tier 3: High
|
||||
"crypto": ApprovalTier.HIGH, "bitcoin": ApprovalTier.HIGH, "wallet": ApprovalTier.HIGH,
|
||||
"key": ApprovalTier.HIGH, "secret": ApprovalTier.HIGH, "config": ApprovalTier.HIGH,
|
||||
"deploy": ApprovalTier.HIGH, "install": ApprovalTier.HIGH, "systemctl": ApprovalTier.HIGH,
|
||||
# Tier 4: Critical
|
||||
"delete": ApprovalTier.CRITICAL, "remove": ApprovalTier.CRITICAL, "rm": ApprovalTier.CRITICAL,
|
||||
"format": ApprovalTier.CRITICAL, "kill": ApprovalTier.CRITICAL, "shutdown": ApprovalTier.CRITICAL,
|
||||
"crisis": ApprovalTier.CRITICAL, "suicide": ApprovalTier.CRITICAL,
|
||||
}
|
||||
|
||||
TIER_TIMEOUTS = {
|
||||
ApprovalTier.SAFE: 0, ApprovalTier.LOW: 0, ApprovalTier.MEDIUM: 60,
|
||||
ApprovalTier.HIGH: 30, ApprovalTier.CRITICAL: 10,
|
||||
}
|
||||
|
||||
TIER_APPROVERS = {
|
||||
ApprovalTier.SAFE: (), ApprovalTier.LOW: ("llm",),
|
||||
ApprovalTier.MEDIUM: ("human", "llm"), ApprovalTier.HIGH: ("human", "llm"),
|
||||
ApprovalTier.CRITICAL: ("human", "llm"),
|
||||
}
|
||||
|
||||
|
||||
def detect_tier(command, action="", context=None):
|
||||
"""Detect approval tier for a command or action."""
|
||||
# Crisis keywords always CRITICAL
|
||||
crisis_keywords = ["988", "suicide", "self-harm", "crisis", "emergency"]
|
||||
for kw in crisis_keywords:
|
||||
if kw in command.lower():
|
||||
return ApprovalTier.CRITICAL
|
||||
|
||||
# Check action type
|
||||
if action and action.lower() in TIER_PATTERNS:
|
||||
return TIER_PATTERNS[action.lower()]
|
||||
|
||||
# Check command for keywords
|
||||
cmd_lower = command.lower()
|
||||
best_tier = ApprovalTier.SAFE
|
||||
for keyword, tier in TIER_PATTERNS.items():
|
||||
if keyword in cmd_lower and tier > best_tier:
|
||||
best_tier = tier
|
||||
|
||||
# Check dangerous patterns
|
||||
is_dangerous, _, description = detect_dangerous_command(command)
|
||||
if is_dangerous:
|
||||
desc_lower = description.lower()
|
||||
if any(k in desc_lower for k in ["delete", "remove", "format", "drop", "kill"]):
|
||||
return ApprovalTier.CRITICAL
|
||||
elif any(k in desc_lower for k in ["chmod", "chown", "systemctl", "config"]):
|
||||
return max(best_tier, ApprovalTier.HIGH)
|
||||
else:
|
||||
return max(best_tier, ApprovalTier.MEDIUM)
|
||||
|
||||
return best_tier
|
||||
|
||||
|
||||
def get_tier_timeout(tier):
|
||||
return TIER_TIMEOUTS.get(tier, 60)
|
||||
|
||||
def get_tier_approvers(tier):
|
||||
return TIER_APPROVERS.get(tier, ("human", "llm"))
|
||||
|
||||
def requires_human_approval(tier):
|
||||
return "human" in get_tier_approvers(tier)
|
||||
|
||||
def is_crisis_bypass(command):
|
||||
"""Check if command qualifies for crisis bypass (988 Lifeline)."""
|
||||
indicators = ["988", "suicide prevention", "crisis hotline", "lifeline", "emergency help"]
|
||||
cmd_lower = command.lower()
|
||||
return any(i in cmd_lower for i in indicators)
|
||||
|
||||
|
||||
class TieredApproval:
|
||||
"""Tiered approval handler."""
|
||||
|
||||
def __init__(self):
|
||||
self._pending = {}
|
||||
self._timeouts = {}
|
||||
|
||||
def request_approval(self, session_key, command, action="", context=None):
|
||||
"""Request approval based on tier. Returns approval dict."""
|
||||
tier = detect_tier(command, action, context)
|
||||
timeout = get_tier_timeout(tier)
|
||||
approvers = get_tier_approvers(tier)
|
||||
|
||||
# Crisis bypass
|
||||
if tier == ApprovalTier.CRITICAL and is_crisis_bypass(command):
|
||||
return {"approved": True, "tier": tier, "reason": "crisis_bypass", "timeout": 0, "approvers": ()}
|
||||
|
||||
# Safe/Low auto-approve
|
||||
if tier <= ApprovalTier.LOW:
|
||||
return {"approved": True, "tier": tier, "reason": "auto_approve", "timeout": 0, "approvers": approvers}
|
||||
|
||||
# Higher tiers need approval
|
||||
import uuid
|
||||
approval_id = f"{session_key}_{uuid.uuid4().hex[:8]}"
|
||||
self._pending[approval_id] = {
|
||||
"session_key": session_key, "command": command, "action": action,
|
||||
"tier": tier, "timeout": timeout, "approvers": approvers, "created_at": time.time(),
|
||||
}
|
||||
if timeout > 0:
|
||||
self._timeouts[approval_id] = time.time() + timeout
|
||||
|
||||
return {
|
||||
"approved": False, "tier": tier, "approval_id": approval_id,
|
||||
"timeout": timeout, "approvers": approvers,
|
||||
"requires_human": requires_human_approval(tier),
|
||||
}
|
||||
|
||||
def resolve_approval(self, approval_id, approved, approver="human"):
|
||||
"""Resolve a pending approval."""
|
||||
if approval_id not in self._pending:
|
||||
return False
|
||||
self._pending.pop(approval_id)
|
||||
self._timeouts.pop(approval_id, None)
|
||||
return approved
|
||||
|
||||
def check_timeouts(self):
|
||||
"""Check for timed-out approvals and auto-escalate."""
|
||||
now = time.time()
|
||||
timed_out = []
|
||||
for aid, timeout_at in list(self._timeouts.items()):
|
||||
if now > timeout_at:
|
||||
timed_out.append(aid)
|
||||
if aid in self._pending:
|
||||
pending = self._pending[aid]
|
||||
current_tier = pending["tier"]
|
||||
if current_tier < ApprovalTier.CRITICAL:
|
||||
pending["tier"] = ApprovalTier(current_tier + 1)
|
||||
pending["timeout"] = get_tier_timeout(pending["tier"])
|
||||
self._timeouts[aid] = now + pending["timeout"]
|
||||
else:
|
||||
self._pending.pop(aid, None)
|
||||
self._timeouts.pop(aid, None)
|
||||
return timed_out
|
||||
|
||||
|
||||
_tiered_approval = TieredApproval()
|
||||
|
||||
def get_tiered_approval():
|
||||
return _tiered_approval
|
||||
|
||||
|
||||
def _legacy_pattern_key(pattern: str) -> str:
|
||||
"""Reproduce the old regex-derived approval key for backwards compatibility."""
|
||||
return pattern.split(r'\b')[1] if r'\b' in pattern else pattern[:20]
|
||||
|
||||
@@ -1,453 +0,0 @@
|
||||
"""Shared Audio Analysis Engine
|
||||
|
||||
Provides beat detection, onset detection, vocal/instrumental separation,
|
||||
voice activity detection, and tempo estimation for use by:
|
||||
- Video Forge (scene transitions synced to music)
|
||||
- LPM 1.0 (lip sync timing, conversational state detection)
|
||||
|
||||
Dependencies (install as needed — all optional):
|
||||
pip install librosa soundfile demucs silero-vad torch
|
||||
|
||||
Gracefully degrades: if a dependency is missing, that feature returns
|
||||
None with a warning rather than crashing.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import os
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, Tuple
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Lazy dependency imports
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_LIBROSA = None
|
||||
_SOUNDFILE = None
|
||||
_DEMUCS_AVAILABLE = None
|
||||
_SILERO_AVAILABLE = None
|
||||
|
||||
|
||||
def _ensure_librosa():
|
||||
global _LIBROSA
|
||||
if _LIBROSA is None:
|
||||
try:
|
||||
import librosa
|
||||
_LIBROSA = librosa
|
||||
except ImportError:
|
||||
logger.warning("librosa not installed — beat/onset/tempo detection unavailable")
|
||||
_LIBROSA = False
|
||||
return _LIBROSA if _LIBROSA else None
|
||||
|
||||
|
||||
def _ensure_soundfile():
|
||||
global _SOUNDFILE
|
||||
if _SOUNDFILE is None:
|
||||
try:
|
||||
import soundfile
|
||||
_SOUNDFILE = soundfile
|
||||
except ImportError:
|
||||
logger.warning("soundfile not installed — audio loading may be limited")
|
||||
_SOUNDFILE = False
|
||||
return _SOUNDFILE if _SOUNDFILE else None
|
||||
|
||||
|
||||
def _ensure_demucs():
|
||||
global _DEMUCS_AVAILABLE
|
||||
if _DEMUCS_AVAILABLE is None:
|
||||
try:
|
||||
import demucs.api
|
||||
_DEMUCS_AVAILABLE = True
|
||||
except ImportError:
|
||||
logger.warning("demucs not installed — vocal separation unavailable")
|
||||
_DEMUCS_AVAILABLE = False
|
||||
return _DEMUCS_AVAILABLE
|
||||
|
||||
|
||||
def _ensure_silero():
|
||||
global _SILERO_AVAILABLE
|
||||
if _SILERO_AVAILABLE is None:
|
||||
try:
|
||||
import torch
|
||||
model, utils = torch.hub.load(
|
||||
repo_or_dir='snakers4/silero-vad', model='silero_vad',
|
||||
force_reload=False, onnx=False,
|
||||
)
|
||||
_SILERO_AVAILABLE = True
|
||||
except Exception:
|
||||
logger.warning("silero-vad not installed — VAD unavailable")
|
||||
_SILERO_AVAILABLE = False
|
||||
return _SILERO_AVAILABLE
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Data classes
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@dataclass
|
||||
class BeatAnalysis:
|
||||
"""Results of beat and tempo analysis."""
|
||||
bpm: float # Estimated tempo in beats per minute
|
||||
beat_times: List[float] # Timestamps of detected beats (seconds)
|
||||
beat_frames: List[int] # Frame indices of detected beats
|
||||
tempo_confidence: float = 0.0 # Confidence in BPM estimate
|
||||
duration: float = 0.0 # Audio duration in seconds
|
||||
sample_rate: int = 0 # Sample rate used for analysis
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {
|
||||
"bpm": round(self.bpm, 1),
|
||||
"beat_count": len(self.beat_times),
|
||||
"beat_times": self.beat_times[:50], # Cap for JSON size
|
||||
"tempo_confidence": round(self.tempo_confidence, 3),
|
||||
"duration": round(self.duration, 2),
|
||||
"sample_rate": self.sample_rate,
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class OnsetAnalysis:
|
||||
"""Results of onset detection."""
|
||||
onset_times: List[float] # Timestamps of onsets (seconds)
|
||||
onset_frames: List[int] # Frame indices of onsets
|
||||
onset_count: int = 0
|
||||
avg_onset_interval: float = 0.0 # Average time between onsets (seconds)
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {
|
||||
"onset_count": self.onset_count,
|
||||
"onset_times": self.onset_times[:100],
|
||||
"avg_onset_interval": round(self.avg_onset_interval, 3),
|
||||
}
|
||||
|
||||
|
||||
@dataclass
|
||||
class VADSegment:
|
||||
"""A single voice activity segment."""
|
||||
start: float # Start time in seconds
|
||||
end: float # End time in seconds
|
||||
is_speech: bool # True if speech detected
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {"start": round(self.start, 3), "end": round(self.end, 3), "is_speech": self.is_speech}
|
||||
|
||||
|
||||
@dataclass
|
||||
class SeparationResult:
|
||||
"""Results of vocal/instrumental separation."""
|
||||
vocals_path: Optional[str] = None
|
||||
instrumental_path: Optional[str] = None
|
||||
duration: float = 0.0
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {
|
||||
"vocals_path": self.vocals_path,
|
||||
"instrumental_path": self.instrumental_path,
|
||||
"duration": round(self.duration, 2),
|
||||
}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Audio loading
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def load_audio(
|
||||
path: str | Path,
|
||||
sr: int = 22050,
|
||||
mono: bool = True,
|
||||
duration: float | None = None,
|
||||
) -> tuple:
|
||||
"""Load audio file. Returns (y, sr) tuple.
|
||||
|
||||
Args:
|
||||
path: Path to audio file (wav, mp3, flac, ogg)
|
||||
sr: Target sample rate (default 22050)
|
||||
mono: Convert to mono
|
||||
duration: Max seconds to load (None = full file)
|
||||
|
||||
Returns:
|
||||
(audio_array, sample_rate) or (None, None) on failure
|
||||
"""
|
||||
librosa = _ensure_librosa()
|
||||
if not librosa:
|
||||
return None, None
|
||||
|
||||
try:
|
||||
y, loaded_sr = librosa.load(
|
||||
str(path), sr=sr, mono=mono, duration=duration,
|
||||
)
|
||||
return y, loaded_sr
|
||||
except Exception as e:
|
||||
logger.error("Failed to load audio %s: %s", path, e)
|
||||
return None, None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Beat detection
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def detect_beats(
|
||||
audio_path: str | Path,
|
||||
sr: int = 22050,
|
||||
duration: float | None = None,
|
||||
) -> Optional[BeatAnalysis]:
|
||||
"""Detect beats and estimate tempo from an audio file.
|
||||
|
||||
Uses librosa.beat_track which implements the algorithm from:
|
||||
Ellis, "Beat Tracking by Dynamic Programming", 2007.
|
||||
|
||||
Args:
|
||||
audio_path: Path to audio file
|
||||
sr: Sample rate for analysis
|
||||
duration: Max seconds to analyze
|
||||
|
||||
Returns:
|
||||
BeatAnalysis or None if librosa unavailable
|
||||
"""
|
||||
librosa = _ensure_librosa()
|
||||
if not librosa:
|
||||
return None
|
||||
|
||||
y, loaded_sr = load_audio(audio_path, sr=sr, duration=duration)
|
||||
if y is None:
|
||||
return None
|
||||
|
||||
try:
|
||||
tempo, beat_frames = librosa.beat.beat_track(y=y, sr=loaded_sr)
|
||||
beat_times = librosa.frames_to_time(beat_frames, sr=loaded_sr)
|
||||
|
||||
return BeatAnalysis(
|
||||
bpm=float(tempo),
|
||||
beat_times=beat_times.tolist(),
|
||||
beat_frames=beat_frames.tolist(),
|
||||
tempo_confidence=0.8, # librosa doesn't expose this directly
|
||||
duration=len(y) / loaded_sr,
|
||||
sample_rate=loaded_sr,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error("Beat detection failed for %s: %s", audio_path, e)
|
||||
return None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Onset detection
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def detect_onsets(
|
||||
audio_path: str | Path,
|
||||
sr: int = 22050,
|
||||
duration: float | None = None,
|
||||
backtrack: bool = True,
|
||||
) -> Optional[OnsetAnalysis]:
|
||||
"""Detect onsets (when new sounds begin).
|
||||
|
||||
Useful for scene transitions (Video Forge) and speech segment
|
||||
boundaries (LPM 1.0).
|
||||
|
||||
Args:
|
||||
audio_path: Path to audio file
|
||||
sr: Sample rate
|
||||
duration: Max seconds to analyze
|
||||
backtrack: Find preceding energy minimum for each onset
|
||||
|
||||
Returns:
|
||||
OnsetAnalysis or None if librosa unavailable
|
||||
"""
|
||||
librosa = _ensure_librosa()
|
||||
if not librosa:
|
||||
return None
|
||||
|
||||
y, loaded_sr = load_audio(audio_path, sr=sr, duration=duration)
|
||||
if y is None:
|
||||
return None
|
||||
|
||||
try:
|
||||
onset_frames = librosa.onset.onset_detect(
|
||||
y=y, sr=loaded_sr, backtrack=backtrack,
|
||||
)
|
||||
onset_times = librosa.frames_to_time(onset_frames, sr=loaded_sr)
|
||||
|
||||
intervals = []
|
||||
times = onset_times.tolist()
|
||||
for i in range(1, len(times)):
|
||||
intervals.append(times[i] - times[i - 1])
|
||||
|
||||
return OnsetAnalysis(
|
||||
onset_times=times,
|
||||
onset_frames=onset_frames.tolist(),
|
||||
onset_count=len(times),
|
||||
avg_onset_interval=sum(intervals) / len(intervals) if intervals else 0.0,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error("Onset detection failed for %s: %s", audio_path, e)
|
||||
return None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Vocal/instrumental separation
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def separate_vocals(
|
||||
audio_path: str | Path,
|
||||
output_dir: str | Path = "/tmp/audio_separation",
|
||||
model_name: str = "htdemucs",
|
||||
) -> Optional[SeparationResult]:
|
||||
"""Separate vocals from instrumental using demucs.
|
||||
|
||||
Args:
|
||||
audio_path: Path to audio file
|
||||
output_dir: Directory for output stems
|
||||
model_name: Demucs model (htdemucs, htdemucs_ft, mdx_extra)
|
||||
|
||||
Returns:
|
||||
SeparationResult with paths to vocals/instrumental, or None
|
||||
"""
|
||||
if not _ensure_demucs():
|
||||
return None
|
||||
|
||||
try:
|
||||
import demucs.api
|
||||
import soundfile as sf
|
||||
|
||||
output_dir = Path(output_dir)
|
||||
output_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
separator = demucs.api.Separator(model=model_name)
|
||||
origin, separated = separator.separate_audio_file(str(audio_path))
|
||||
|
||||
vocals_path = output_dir / "vocals.wav"
|
||||
instrumental_path = output_dir / "instrumental.wav"
|
||||
|
||||
sf.write(str(vocals_path), separated["vocals"].cpu().numpy().T, separator.samplerate)
|
||||
sf.write(str(instrumental_path),
|
||||
(separated["drums"] + separated["bass"] + separated["other"]).cpu().numpy().T,
|
||||
separator.samplerate)
|
||||
|
||||
duration = len(origin) / separator.samplerate
|
||||
|
||||
return SeparationResult(
|
||||
vocals_path=str(vocals_path),
|
||||
instrumental_path=str(instrumental_path),
|
||||
duration=duration,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.error("Vocal separation failed for %s: %s", audio_path, e)
|
||||
return None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Voice Activity Detection
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def detect_voice_activity(
|
||||
audio_path: str | Path,
|
||||
sr: int = 16000,
|
||||
threshold: float = 0.5,
|
||||
min_speech_duration: float = 0.3,
|
||||
) -> Optional[List[VADSegment]]:
|
||||
"""Detect speech segments using Silero VAD.
|
||||
|
||||
Returns list of segments where speech was detected.
|
||||
Useful for LPM listen/speak state switching.
|
||||
|
||||
Args:
|
||||
audio_path: Path to audio file
|
||||
sr: Sample rate (Silero expects 16kHz or 8kHz)
|
||||
threshold: VAD threshold (0.0-1.0)
|
||||
min_speech_duration: Minimum segment length to count as speech
|
||||
|
||||
Returns:
|
||||
List of VADSegment or None if silero unavailable
|
||||
"""
|
||||
if not _ensure_silero():
|
||||
return None
|
||||
|
||||
try:
|
||||
import torch
|
||||
import torchaudio
|
||||
|
||||
model, utils = torch.hub.load(
|
||||
repo_or_dir='snakers4/silero-vad', model='silero_vad',
|
||||
force_reload=False, onnx=False,
|
||||
)
|
||||
get_speech_timestamps = utils[0]
|
||||
|
||||
wav, file_sr = torchaudio.load(str(audio_path))
|
||||
if file_sr != sr:
|
||||
wav = torchaudio.functional.resample(wav, file_sr, sr)
|
||||
|
||||
if wav.shape[0] > 1:
|
||||
wav = wav.mean(dim=0, keepdim=True)
|
||||
|
||||
speech_timestamps = get_speech_timestamps(
|
||||
wav.squeeze(), model, sampling_rate=sr,
|
||||
threshold=threshold, min_speech_duration_ms=int(min_speech_duration * 1000),
|
||||
)
|
||||
|
||||
segments = []
|
||||
for ts in speech_timestamps:
|
||||
segments.append(VADSegment(
|
||||
start=ts["start"] / sr,
|
||||
end=ts["end"] / sr,
|
||||
is_speech=True,
|
||||
))
|
||||
|
||||
return segments
|
||||
except Exception as e:
|
||||
logger.error("VAD failed for %s: %s", audio_path, e)
|
||||
return None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Full analysis
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def analyze_audio(
|
||||
audio_path: str | Path,
|
||||
include_separation: bool = False,
|
||||
include_vad: bool = False,
|
||||
sr: int = 22050,
|
||||
) -> Dict[str, Any]:
|
||||
"""Run full audio analysis pipeline.
|
||||
|
||||
Combines beat detection, onset detection, and optionally
|
||||
vocal separation and VAD into a single result dict.
|
||||
|
||||
Args:
|
||||
audio_path: Path to audio file
|
||||
include_separation: Run vocal separation (slow)
|
||||
include_vad: Run voice activity detection
|
||||
sr: Sample rate for beat/onset analysis
|
||||
|
||||
Returns:
|
||||
Dict with all analysis results
|
||||
"""
|
||||
result = {"path": str(audio_path)}
|
||||
|
||||
beats = detect_beats(audio_path, sr=sr)
|
||||
if beats:
|
||||
result["beats"] = beats.to_dict()
|
||||
|
||||
onsets = detect_onsets(audio_path, sr=sr)
|
||||
if onsets:
|
||||
result["onsets"] = onsets.to_dict()
|
||||
|
||||
if include_separation:
|
||||
separation = separate_vocals(audio_path)
|
||||
if separation:
|
||||
result["separation"] = separation.to_dict()
|
||||
|
||||
if include_vad:
|
||||
segments = detect_voice_activity(audio_path)
|
||||
if segments:
|
||||
result["vad"] = {
|
||||
"segments": [s.to_dict() for s in segments],
|
||||
"speech_ratio": sum(s.end - s.start for s in segments) / (beats.duration if beats else 1.0),
|
||||
}
|
||||
|
||||
return result
|
||||
Reference in New Issue
Block a user