Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solaoi/voicepeaky
This is a server to use voicepeak as api.
https://github.com/solaoi/voicepeaky
voicepeak wrapper
Last synced: 2 months ago
JSON representation
This is a server to use voicepeak as api.
- Host: GitHub
- URL: https://github.com/solaoi/voicepeaky
- Owner: solaoi
- License: mit
- Created: 2023-07-14T16:04:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-12T05:57:31.000Z (about 1 year ago)
- Last Synced: 2024-08-01T17:37:45.057Z (5 months ago)
- Topics: voicepeak, wrapper
- Language: Nim
- Homepage:
- Size: 23.4 KB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Voicepeaky
[](https://github.com/solaoi/voicepeaky/blob/main/LICENSE)
[](https://github.com/solaoi/voicepeaky/releases)
[](https://github.com/sponsors/solaoi)
This is a server to use voicepeak as api.
For automatic adjustment of emotion, voice pitch, and speed, use [Voicepeaky GPT](https://github.com/solaoi/voicepeaky4gpt).
## Requirements
- [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html)
- [VOICEPEAK 商用可能 ナレーター](https://www.ah-soft.com/voice/narrator/index.html)
## Usage
### Serve
```sh
voicepeaky -p 9999 -s
```
Option is below.
| Option | Description | Default | Required |
| --------- | ---------------------------------------- | ------- | -------- |
| -p,--port | specify the port you want to serve | 8080 | false |
| -s,--skip | skip old text when new text is requested | - | false |
### Request
```sh
curl -X POST -H "Content-Type: application/json" -d '@sample.json' localhost:9999
```
RequestBody (JSON Format) is below.
see a sample [here](https://raw.githubusercontent.com/solaoi/voicepeaky/main/sample.json).
| Field | Type | Default | Required |
| ------------- | ----------------------- | ------------------- | -------- |
| narrator | string*1 | "Japanese Female 1" | false |
| emotion | JSONObject | - | false |
| emotion/happy | number(0 - 100) | 0 | false |
| emotion/fun | number(0 - 100) | 0 | false |
| emotion/angry | number(0 - 100) | 0 | false |
| emotion/sad | number(0 - 100) | 0 | false |
| speed | number(50 - 200) | 100 | false |
| pitch | number(-300 - 300) | 0 | false |
| text | string | - | true |
*1
| Types of Narrators | Requirements |
| --------------------- | ---------------------------------------------------------------------------------- |
| Japanese Male Child | [VOICEPEAK 商用可能 ナレーター](https://www.ah-soft.com/voice/narrator/index.html) |
| Japanese Female Child | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Male 1 | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Male 2 | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Male 3 | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Male4 | [VOICEPEAK 商用可能 ナレーター](https://www.ah-soft.com/voice/narrator/index.html) |
| Japanese Female 1 | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Female 2 | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Female 3 | [VOICEPEAK 商用可能 6ナレーターセット](https://www.ah-soft.com/voice/6nare/index.html) |
| Japanese Female4 | [VOICEPEAK 商用可能 ナレーター](https://www.ah-soft.com/voice/narrator/index.html) |
## Install
### 1. Mac
```
# Install
brew install solaoi/tap/voicepeaky
# Update
brew upgrade voicepeaky
```
### 2. BinaryRelease
```sh
# Install with wget or curl
## set the latest version on releases.
VERSION=v1.0.5
## set the OS you use. (macos)
OS=linux
## case you use wget
wget https://github.com/solaoi/voicepeaky/releases/download/$VERSION/voicepeaky${OS}.tar.gz
## case you use curl
curl -LO https://github.com/voicepeaky/broly/releases/download/$VERSION/voicepeaky${OS}.tar.gz
## extract
tar xvf ./voicepeaky${OS}.tar.gz
## move it to a location in your $PATH, such as /usr/local/bin.
mv ./voicepeaky /usr/local/bin/
```
### 3. Nimble
```sh
# Install & Update
nimble install voicepeaky
```
## Note
Voicepeak occasionally crashes; Voicepeaky will automatically retry, but if an error popup appears, please close it.