giggle-generation-speech

Files (3)

• SKILL.md
• requirements.txt
• text_to_audio_api.py · scripts/

SKILL.md (first lines)

# Text-to-Audio

Synthesizes text into AI voice/voiceover via giggle.pro. Supports multiple voice tones, emotions, and speaking rates.

## ⚠️ Review Before Installing

**Please review the following before installing.** This skill will:

1. **Write** to `~/.openclaw/skills/giggle-generation-speech/logs/` – Task state files for Cron deduplication
2. **Register Cron** (30s interval) – Async polling when user initiates speech generation; removed when complete
3. **Forward raw stdout** – Script output (audio links, status) is passed to the user as-is

**Requirements**: `python3`, `GIGGLE_API_KEY` (system environment variable), pip packages: `requests`

---

**API Key**: Set system environment variable `GIGGLE_API_KEY`. Obtain it at [giggle.pro](https://giggle.pro/) while logged in: **left sidebar** → **API Key** (**API 密钥**). The script will prompt if not configured.

> **No inline Python**: All commands must be executed via the `exec` tool. **Never** use heredoc inline code.

> **No Retry on Error**: If script execution encounters an error, **do not retry**. Report the error to the user directly and stop.

## Execution Flow (Phase 1 Submit + Phase 2 Cron + Phase 3 Sync Fallback)

Speech generation typically takes 10–30 seconds. Uses "fast submit + Cron poll + sync fallback" three-phase architecture.

> **Important**: **Never** pass `GIGGLE_API_KEY` in exec's `env` parameter. API Key is read from system environment variable.

---

## Continuous progress updates (default; user need not put this in their prompt)

TTS is usually **10–30 seconds**; Phase 3 sync wait can run up to **`--max-wait` (default 120s)**. The user does **not** need to nag for progress.

1. **After Phase 1 submit**, say the task is submitted, give `task_id`, and set expectation: **usually 10–30s**, may need up to ~2 minutes on slow runs.
2. **Keep polling without being asked**: register **Cron ~30s** for `--query`, and always run **Phase 3** `--query --poll` as fallback—**do not** wait for the user to say “check now.”
3. **On each poll** (Cron or `--query`): if still JSON/`processing`, paraphrase and say you are still waiting; from the **2nd** JSON poll onward, on **every other** Cron tick you may send one minimal line (e.g. “Still generating…”) so the thread is not dead silent.
4. **When done**: forward full **signed audio** links (plain-text success from script); on failure, forward the error. If nothing completes after **~15 minutes** of wall-clock retries/Cron, explain, give `task_id`, remove Cron, suggest retry.
5. **If the user explicitly opts out** of Cron pings, skip Cron but still run `--query` when they ask; Phase 3 `--poll` can remain your primary path if appropriate.

---

### Phase 0: Guide User to Select Voice and Emotion (required)

**Before submitting, you must guide the user to select voice and emotion. Do not use defaults.**

1. Run `--list-voices` to get available voices:

```bash
python3 scripts/text_to_audio_api.py --list-voices
```

2. Display the voice list to the user in a readable format (voice_id, name, style, gender, etc.) and guide them to pick one
3. Ask the user's preferred emotion (e.g. joy, sad, neutral, angry, surprise). Use neutral if no preference
4. Only after the user confirms voice and emotion, proceed to Phase 1 submit

---

### Phase 1: Submit Task (exec completes in ~10 seconds)

**First send a message to the user**: Speech task submitted; usually finishes in 10–30 seconds. **You will query automatically and send the link as soon as it is ready**—no need to nag for progress.

```bash
# Must specify user-selected voice and emotion
python3 scripts/text_to_audio_api.py \
  --text "The weather is nice today" \
  --voice-id "Calm_Woman" \
  --emotion "joy" \
  --speed 1.2 \
  --no-wait --json

# View available voices
python3 scripts/text_to_audio_api.py --list-voices
```

Response example:

```json
{"status": "started", "task_id": "xxx"}
```

**Immediately store task_id in memory** (`addMemory`):

```
giggle-generation-speech task_id: xxx (submitted: YYYY-MM-DD HH:mm)
```

---

### Phase 2: Register Cron (30 second interval)

Use the `cron` tool to register the polling job. **Strictly follow the parameter format**:

```json
{
  "action": "add",
  "job": {
    "name": "giggle-generation-speech-<first 8 chars of task_id>",
    "schedule": {
      "kind": "every",
      "everyMs": 30000
    },
    "payload": {
      "kind": "systemEvent",
      "text": "Speech task poll: exec python3 scripts/text_to_audio_api.py --query --task-id <full task_id>, handle stdout per Cron logic. If stdout is non-JSON plain text, forward to user and remove Cron. If stdout is JSON (still processing), keep Cron; from the 2nd JSON poll onward, alternate: every other poll send user one brief line (e.g. Speech still generating…). If stdout is empty, remove Cron immediately, do not send message."
    },
    "sessionTarget": "main"
  }
}
```

**Cron trigger handling** (based on exec stdout):

| stdout pattern | Action |
|----------------|--------|
| Non-empty plain text (not starting with `{`) | **Forward to user as-is**, **remove Cron** |
| stdout empty | Already pushed, **remove Cron immediately, do not send message** |
| JSON (starts with `{`, has `"status"` field) | Keep Cron; per this section, from 2nd JSON poll onward send a brief line every other poll |

From giggle-official/skills, MIT.

More from giggle-official/skills