File size: 16,271 Bytes
045f3f3
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
import logging
import os
import shutil
import tempfile
from pathlib import Path
from typing import Dict

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse, Response
from openai import OpenAI
from pydantic import BaseModel, Field
from pydub import AudioSegment


logger = logging.getLogger(__name__)


def _configure_app_logger() -> None:
    """Ensure INFO logs from this module are emitted (root may stay at WARNING under uvicorn)."""
    if logger.handlers:
        return
    handler = logging.StreamHandler()
    handler.setFormatter(logging.Formatter("%(levelname)s %(name)s: %(message)s"))
    logger.addHandler(handler)
    logger.propagate = False
    level_name = os.environ.get("LOG_LEVEL", "INFO").upper()
    logger.setLevel(getattr(logging, level_name, logging.INFO))


_configure_app_logger()

app = FastAPI()


HF_REPO_ID = "michael-chan-000/tts-v5-step-6000"
HF_REVISION = "2beb3f05d627e5ac12002f0c8ee0b643cefa7ecf"
SAMPLE_RATE = 24000
ADAPTER = "qwen3_tts_repo_snapshot"

# Set this according to your service/model init status.
MODEL_LOADED = True


# OpenAI TTS model.
OPENAI_TTS_MODEL = os.environ.get("OPENAI_TTS_MODEL", "gpt-4o-mini-tts")


# OpenAI TTS voices.
#
# OpenAI requires a voice parameter.
# There is no official "child" voice.
#
# These mappings are practical defaults. You can override any of them with env vars.
#
# Defaults favor voices described in voice.md as conversational, smooth, or
# "less theatrical" (high perceived naturalness). Stylized voices (e.g. onyx,
# echo, fable) remain available via env override when you want stronger character.
VOICE_FEMALE_DEFAULT = os.environ.get("OPENAI_TTS_VOICE_FEMALE_DEFAULT", "nova")
VOICE_FEMALE_SOFT = os.environ.get("OPENAI_TTS_VOICE_FEMALE_SOFT", "shimmer")
VOICE_FEMALE_BRIGHT = os.environ.get("OPENAI_TTS_VOICE_FEMALE_BRIGHT", "coral")

VOICE_MALE_DEFAULT = os.environ.get("OPENAI_TTS_VOICE_MALE_DEFAULT", "ash")
# ash: calm, smooth, "less theatrical" — serious authority comes from instructions.
VOICE_MALE_SERIOUS = os.environ.get("OPENAI_TTS_VOICE_MALE_SERIOUS", "ash")
# Prefer natural male speech; use instructions for energy instead of announcement-style echo.
VOICE_MALE_BRIGHT = os.environ.get("OPENAI_TTS_VOICE_MALE_BRIGHT", "ash")

VOICE_NEUTRAL_DEFAULT = os.environ.get("OPENAI_TTS_VOICE_NEUTRAL_DEFAULT", "alloy")
VOICE_NEUTRAL_FORMAL = os.environ.get("OPENAI_TTS_VOICE_NEUTRAL_FORMAL", "sage")
# Conversational / flexible neutral — livelier than alloy without fable/ballad theatricality.
VOICE_NEUTRAL_EXPRESSIVE = os.environ.get("OPENAI_TTS_VOICE_NEUTRAL_EXPRESSIVE", "verse")
VOICE_NEUTRAL_YOUTHFUL = os.environ.get("OPENAI_TTS_VOICE_NEUTRAL_YOUTHFUL", "verse")
VOICE_STORYLIKE = os.environ.get("OPENAI_TTS_VOICE_STORYLIKE", "fable")


TRAIT_KEYS = {
    "gender",
    "pitch",
    "speed",
    "age_group",
    "emotion",
    "tone",
    "accent",
}


# Closed-enum values expected from validators.
# Unknown values are ignored and never spoken.
ALLOWED_TRAITS = {
    "gender": {
        "male",
        "female",
        "neutral",
        "unknown",
    },
    "pitch": {
        "low",
        "mid",
        "high",
        "normal",
    },
    "speed": {
        "slow",
        "normal",
        "fast",
    },
    "age_group": {
        "child",
        "teen",
        "young_adult",
        "adult",
        "middle_aged",
        "senior",
        "elderly",
    },
    "emotion": {
        "neutral",
        "happy",
        "sad",
        "angry",
        "calm",
        "excited",
        "serious",
        "fearful",
    },
    "tone": {
        "neutral",
        "formal",
        "informal",
        "friendly",
        "serious",
        "warm",
        "cold",
        "urgent",
        "calm",
    },
    "accent": {
        "us",
        "uk",
        "au",
        "ca",
        "indian",
        "irish",
        "scottish",
        "neutral",
    },
}


class SpeakRequest(BaseModel):
    instruction: str = Field(min_length=1)
    text: str = Field(min_length=1)


@app.get("/health")
def health():
    """
    Health check endpoint.

    IMPORTANT:
    Do not change this response shape.

    It must always return:
    status, hf_repo_id, hf_revision, model_loaded, sample_rate, adapter
    """
    return JSONResponse(
        content={
            "status": "healthy",
            "hf_repo_id": HF_REPO_ID,
            "hf_revision": HF_REVISION,
            "model_loaded": MODEL_LOADED,
            "sample_rate": SAMPLE_RATE,
            "adapter": ADAPTER,
        },
        status_code=200,
    )


def require_ffmpeg() -> None:
    """
    pydub needs FFmpeg/ffprobe available on PATH for MP3 decoding.

    If FFmpeg is missing, /speak fails clearly with HTTP 500 instead of
    returning invalid or empty audio.
    """
    if shutil.which("ffmpeg") is None:
        raise RuntimeError(
            "FFmpeg is not installed or not available on PATH. "
            "Install ffmpeg before using /speak."
        )

    if shutil.which("ffprobe") is None:
        raise RuntimeError(
            "ffprobe is not installed or not available on PATH. "
            "Install ffmpeg before using /speak."
        )


def normalize_trait_value(value: str) -> str:
    """
    Normalize validator enum values.

    Examples:
      "young adult" -> "young_adult"
      "Young-Adult" -> "young_adult"
    """
    return value.strip().lower().replace("-", "_").replace(" ", "_")


def parse_trait_tags(instruction: str) -> Dict[str, str]:
    """
    Parse validator instruction tags.

    Expected input:

        | gender: female | pitch: mid | speed: normal | age_group: adult |
          emotion: angry | tone: formal | accent: uk

    Also supports input without the leading pipe:

        gender: female | pitch: mid | speed: normal | age_group: adult |
        emotion: angry | tone: formal | accent: uk

    Important:
    - Only known trait keys are extracted.
    - Only allowed enum values are accepted.
    - Unknown keys/values are ignored.
    - The raw instruction is never spoken.
    """
    traits: Dict[str, str] = {}

    parts = [part.strip() for part in instruction.split("|") if part.strip()]

    for part in parts:
        if ":" not in part:
            continue

        key, value = part.split(":", 1)

        key = key.strip().lower()
        value = normalize_trait_value(value)

        if key not in TRAIT_KEYS:
            continue

        allowed_values = ALLOWED_TRAITS.get(key)

        if allowed_values and value not in allowed_values:
            # Do not allow free-form values into instructions.
            # Invalid values are ignored instead of being spoken.
            continue

        if value:
            traits[key] = value

    return traits


def choose_openai_voice(traits: Dict[str, str]) -> str:
    """
    Choose OpenAI's required base voice from structured validator traits.

    Why this exists:
    - OpenAI TTS requires voice=...
    - The instructions field does not reliably change the speaker identity.
    - Therefore, gender-like characteristics should influence the selected base voice.

    Naturalness:
    - Prefer voices that read as conversational, smooth, or balanced (see voice.md).
    - Trait buckets (serious / soft / bright / youthful) still pick different defaults,
      but each default is the most natural fit in that bucket unless env overrides say otherwise.

    Important:
    - There is no official OpenAI child voice.
    - age_group can influence the style instruction, but not perfectly control age.
    - This function never changes the spoken text.
    """
    gender = traits.get("gender", "unknown")
    emotion = traits.get("emotion", "neutral")
    tone = traits.get("tone", "neutral")
    age_group = traits.get("age_group", "adult")
    pitch = traits.get("pitch", "mid")
    speed = traits.get("speed", "normal")

    serious_like = emotion in {"serious", "angry"} or tone in {"formal", "serious", "urgent", "cold"}
    soft_like = emotion in {"calm", "sad", "fearful"} or tone in {"calm", "warm"}
    bright_like = emotion in {"happy", "excited"} or tone in {"friendly", "informal"} or speed == "fast"
    youthful_like = age_group in {"child", "teen", "young_adult"} or pitch == "high"

    if gender == "female":
        # Female: coral (conversational), nova (smooth/polished), shimmer (gentle) — see voice.md.
        if bright_like or youthful_like:
            return VOICE_FEMALE_BRIGHT

        if soft_like:
            return VOICE_FEMALE_SOFT

        if serious_like:
            return VOICE_FEMALE_DEFAULT

        return VOICE_FEMALE_DEFAULT

    if gender == "male":
        # Male: default ash for natural, composed delivery; env can restore onyx/echo if desired.
        if serious_like:
            return VOICE_MALE_SERIOUS

        if bright_like or youthful_like:
            return VOICE_MALE_BRIGHT

        if soft_like:
            return VOICE_MALE_DEFAULT

        return VOICE_MALE_DEFAULT

    # Neutral/unknown: alloy / sage / verse — balanced or conversational, not stylized characters.
    if serious_like:
        return VOICE_NEUTRAL_FORMAL

    if bright_like:
        return VOICE_NEUTRAL_EXPRESSIVE

    if age_group in {"child", "teen"}:
        # Not a real child voice; conversational neutral works better than highly stylized fable here.
        return VOICE_NEUTRAL_YOUTHFUL

    return VOICE_NEUTRAL_DEFAULT


def build_openai_tts_instructions(traits: Dict[str, str]) -> str:
    """
    Convert structured validator tags into OpenAI TTS style guidance.

    Critical rule:
    - These instructions describe delivery/style only.
    - They are not the content to speak.
    - The spoken content remains req.text only.
    """
    guidance = [
        "Use the following metadata only as voice and delivery guidance.",
        "Do not read, say, mention, or paraphrase the metadata.",
        "Speak only the input text.",
        "Prioritize natural, human-sounding speech with clear articulation.",
        "Keep delivery conversational and believable; avoid robotic delivery.",
        "Do not add cartoonish or exaggerated theatricality unless the metadata clearly demands a strong stylistic effect.",
    ]

    gender = traits.get("gender")
    pitch = traits.get("pitch")
    speed = traits.get("speed")
    age_group = traits.get("age_group")
    emotion = traits.get("emotion")
    tone = traits.get("tone")
    accent = traits.get("accent")

    if gender and gender not in {"unknown", "neutral"}:
        guidance.append(f"Use a {gender} vocal presentation.")

    if age_group:
        if age_group == "child":
            guidance.append(
                "Use a youthful, childlike delivery where possible, while keeping speech natural and clear."
            )
        elif age_group == "teen":
            guidance.append(
                "Use a teenage-sounding delivery where possible, while keeping speech natural and clear."
            )
        elif age_group == "young_adult":
            guidance.append("Use a young adult delivery.")
        elif age_group in {"senior", "elderly"}:
            guidance.append("Use a mature older-speaker delivery.")
        else:
            guidance.append(f"Sound like a {age_group.replace('_', ' ')} speaker.")

    if pitch:
        if pitch in {"mid", "normal"}:
            guidance.append("Use a medium pitch.")
        else:
            guidance.append(f"Use a {pitch} pitch.")

    if speed:
        if speed == "normal":
            guidance.append("Use a normal speaking speed.")
        else:
            guidance.append(f"Use a {speed} speaking speed.")

    if emotion:
        guidance.append(f"Convey a {emotion} emotion.")

    if tone:
        guidance.append(f"Use a {tone} tone.")

    if accent:
        if accent == "uk":
            guidance.append("Use a UK English accent.")
        elif accent == "us":
            guidance.append("Use a US English accent.")
        elif accent == "au":
            guidance.append("Use an Australian English accent.")
        elif accent == "ca":
            guidance.append("Use a Canadian English accent.")
        elif accent == "indian":
            guidance.append("Use an Indian English accent.")
        elif accent == "irish":
            guidance.append("Use an Irish English accent.")
        elif accent == "scottish":
            guidance.append("Use a Scottish English accent.")
        elif accent == "neutral":
            guidance.append("Use a neutral English accent.")
        else:
            guidance.append(f"Use a {accent.replace('_', ' ')} accent.")

    return " ".join(guidance)


@app.post("/speak")
def speak(req: SpeakRequest):
    """
    Generate speech and return raw WAV bytes.

    Validator sends:

        {
          "text": "The transcription to speak.",
          "instruction": "| gender: female | pitch: mid | speed: normal | age_group: adult | emotion: angry | tone: formal | accent: uk"
        }

    Important:
    - req.text is the only spoken content.
    - req.instruction is structured style metadata only.
    - voice is selected from parsed traits because OpenAI requires voice=...
    - The raw instruction string is never spoken.

    Response:
    - raw WAV bytes
    - Content-Type: audio/wav

    This endpoint does not return:
    - base64
    - JSON-wrapped audio
    - file paths
    """
    api_key = os.environ.get("OPENAI_API_KEY")

    if not api_key:
        raise HTTPException(
            status_code=500,
            detail="OPENAI_API_KEY is not set",
        )

    try:
        require_ffmpeg()

        traits = parse_trait_tags(req.instruction)

        # Preprocess instruction into:
        # 1. OpenAI base voice
        # 2. OpenAI style instructions
        #
        # Only req.text is used as spoken input.
        voice = choose_openai_voice(traits)
        tts_instructions = build_openai_tts_instructions(traits)

        logger.info(
            "Instruction pipeline: raw=%r | parsed_traits=%s | chosen_voice=%r | openai_instructions=%r",
            req.instruction,
            traits,
            voice,
            tts_instructions,
        )
        logger.info(
            "OpenAI audio.speech.create payload: model=%r voice=%r response_format=%r input=%r instructions=%r",
            OPENAI_TTS_MODEL,
            voice,
            "mp3",
            req.text,
            tts_instructions,
        )

        client = OpenAI(api_key=api_key)

        with tempfile.TemporaryDirectory() as tmpdir:
            tmpdir_path = Path(tmpdir)

            mp3_path = tmpdir_path / "speech.mp3"
            wav_path = tmpdir_path / "speech.wav"

            speech = client.audio.speech.create(
                model=OPENAI_TTS_MODEL,
                voice=voice,
                input=req.text,
                instructions=tts_instructions,
                response_format="mp3",
            )

            speech.stream_to_file(mp3_path)

            if not mp3_path.exists():
                raise RuntimeError("OpenAI TTS did not create an MP3 file")

            if mp3_path.stat().st_size == 0:
                raise RuntimeError("OpenAI TTS created an empty MP3 file")

            audio = AudioSegment.from_file(mp3_path, format="mp3")

            # Normalize WAV output for validator compatibility.
            audio = (
                audio
                .set_frame_rate(SAMPLE_RATE)
                .set_channels(1)
                .set_sample_width(2)
            )

            audio.export(wav_path, format="wav")

            if not wav_path.exists():
                raise RuntimeError("MP3 to WAV conversion failed: WAV file missing")

            if wav_path.stat().st_size == 0:
                raise RuntimeError("MP3 to WAV conversion failed: WAV file is empty")

            wav_bytes = wav_path.read_bytes()

        return Response(
            content=wav_bytes,
            media_type="audio/wav",
            headers={
                "Content-Disposition": 'inline; filename="speech.wav"',
            },
        )

    except HTTPException:
        raise

    except Exception as e:
        raise HTTPException(
            status_code=500,
            detail=f"TTS generation failed: {str(e)}",
        )