vpeak

vpeak is a tool that allows you to interact with VOICEPEAK from the command line or within your Go applications.

Features

• CLI Tool: Use vpeak from the command line to generate speech audio.
• Go Library: Import vpeak into your Go projects to generate speech programmatically.

---

Handling Audio Files: Platform Differences

About audio files (.wav)

The behavior of audio file handling depends on the options provided:

• On macOS: Temporary .wav files are automatically deleted after playback unless explicitly preserved using the -silent, -o, or -d options.
• On Windows: .wav files are never automatically deleted after playback, ensuring compatibility with Windows' file handling. You may need to manually delete the files after playback if you don't want them to persist.

---

CLI Usage

Installation

To install vpeak as a CLI tool, run the following command:

go install github.com/shinshin86/vpeak/cmd/vpeak@latest

This will download, build, and install the vpeak binary to your $GOBIN directory (usually $HOME/go/bin).

Usage

Execute the following command to have VOICEPEAK speak the string passed as an argument:

# # not option specfied (narrator: Japanese Female Child, emotion: natural)
vpeak こんにちは！

# option (narrator: Japanese Female 1, emotion: happy)
vpeak -n f1 -e happy "こんにちは"

# option (narrator: Japanese Female 1, emotion: happy, output path: ./hello.wav)
# (An audio file will only be generated if the output option is specified, and it will be saved at the designated location.)
vpeak -n f1 -e happy -o ./hello.wav "こんにちは"

Converts all text files(.txt) in the directory specified by the -d option to audio files (.wav).

vpeak -d your-dir

# option (narrator: Japanese Female 1, emotion: happy)
vpeak -n f1 -e happy -d your-dir

# option (narrator: Japanese Female 1, emotion: happy, output dir: your-dir-2)
vpeak -n f1 -e happy -o your-dir-2 -d your-dir

Silent mode

When the -silent option is used, no voice playback is performed, and the generated files are not automatically deleted. This option is useful if you only want to generate audio files.

vpeak -silent "こんにちは"

About audio files(.wav)

The audio file will remain only if outputPath is specified, executed per directory, or silent mode is enabled.

Command infomation

Run the help command for more information.

vpeak -h

---

Library Usage

You can also use vpeak as a Go library in your own applications.

Installation

To install the library, run:

go get github.com/shinshin86/vpeak@latest

Importing the Library

In your Go code, import the vpeak package:

import "github.com/shinshin86/vpeak"

Example Usage

Here's an example of how to use vpeak in your Go program:

package main

import (
    "fmt"
    "log"

    "github.com/shinshin86/vpeak"
)

func main() {
    text := "こんにちは"
    opts := vpeak.Options{
        Narrator: "f1",       // Narrator option (e.g., "f1", "m1")
        Emotion:  "happy",    // Emotion option (e.g., "happy", "sad")
        Output:   "hello.wav",// Output file path
        Silent:   false,      // Silent mode (true or false)
    }

    if err := vpeak.GenerateSpeech(text, opts); err != nil {
        log.Fatalf("Failed to generate speech: %v", err)
    }

    fmt.Println("Speech generated successfully.")
}

Options

• Narrator: Choose the narrator's voice. Available options:
  • f1: Japanese Female 1
  • f2: Japanese Female 2
  • f3: Japanese Female 3
  • m1: Japanese Male 1
  • m2: Japanese Male 2
  • m3: Japanese Male 3
  • c: Japanese Female Child
• Emotion: Choose the emotion. Available options:
  • happy
  • fun
  • angry
  • sad
  • If no option is specified, it will be natural.
• Output: Specify the output file path. If not set, defaults to output.wav.
• Silent: Set to true to disable voice playback.

Processing Text Files in a Directory

You can also process all text files in a directory:

package main

import (
    "fmt"
    "log"

    "github.com/shinshin86/vpeak"
)

func main() {
    dir := "your-dir"
    opts := vpeak.Options{
        Narrator: "f1",
        Emotion:  "happy",
        Output:   "your-dir-2", // Output directory
        Silent:   true,
    }

    if err := vpeak.ProcessTextFiles(dir, opts); err != nil {
        log.Fatalf("Failed to process text files: %v", err)
    }

    fmt.Println("Text files processed successfully.")
}

---

Support

vpeak is currently tested under the following conditions. Compatibility with other environments is not guaranteed.

OS

• M1 or later (arm64) Macs only.

VOICEPEAK

• VOICEPEAK must be updated to the latest version.
• Tested with version 1.2.7.

Notes

• Ensure that VOICEPEAK is installed at the path specified in the code (/Applications/voicepeak.app/Contents/MacOS/voicepeak). If it is installed elsewhere, you may need to adjust the VoicepeakPath constant in the code.
• The library functions provide error handling by returning errors, allowing you to handle them appropriately in your application.

License

MIT

Author

Yuki Shindo