Skip to content

Commit

Permalink
readmes part2
Browse files Browse the repository at this point in the history
  • Loading branch information
zymos committed Aug 2, 2022
1 parent f15dab0 commit b263860
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 15 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Current snapshot (may not always work)

## Royalroads web-novels chapter's links (get-royalroad-chapter-links)
- Description: gets royalroads chapter links and saves to 'links.txt', which can be used 'web-novel-to-text'
- [more details](https://github.com/zymos/audiobook_tools/tree/master/docs/aaxconverter.md)
- [more details](https://github.com/zymos/audiobook_tools/tree/master/docs/get_royalroad_chapter_links.md)


## Other tools
Expand All @@ -113,12 +113,12 @@ Current snapshot (may not always work)
- Requirements:
- ffmpeg
- Google Cloud SDK
- [more details](https://github.com/zymos/audiobook_tools/tree/master/audiobook_tools/google_cloud_tts)
- [more details](https://github.com/zymos/audiobook_tools/tree/master/docs/google_cloud_tts.md)


# Usage Examples

## Convert royalroad web-novel to audiobook
## Convert Royalroad web-novel to audiobook
This example converts Void Herald's, 'THe Perfect Run' web-novel to an audiobook. Downloads links to all chapters.
Downloads the contents of all chapters. Converts the first chapter to mp3. To convert the rest of the novel by repeating
the last command for each chapter's txt file.
Expand Down
6 changes: 4 additions & 2 deletions docs/aaxconverter.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Description: convert AAX(Audible) files to mp3, m4b, single or chapter files, removing DRM. This almost a copy of KrumpetPirate's [AAXtoMP3](https://github.com/KrumpetPirate/AAXtoMP3)
- Reqirements:
# Description:
convert AAX(Audible) files to mp3, m4b, single or chapter files, removing DRM. This almost a copy of KrumpetPirate's [AAXtoMP3](https://github.com/KrumpetPirate/AAXtoMP3)
# Reqirements:
- ffmpeg
- bash
- your Audible activation/authorization code

# Usage
<pre>
Usage: aaxconverter [--flac] [--aac] [--opus ] [--single] [--chaptered]
[-e:mp3] [-e:m4a] [-e:m4b] [--authcode <AUTHCODE>] [--no-clobber]
Expand Down
14 changes: 10 additions & 4 deletions docs/audiobook_reencoder.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
- Description: Re-encodes all MP3/M4B files in a directory, recursivly.
- Features:
# Audiobook ReEncoder

## Description:
Re-encodes all MP3/M4B files in a directory, recursivly.

## Features:
- Encodes using ffmpeg
- Accepts mp3, m4b, m4a
- Grabs audio files data using ffprobe, for re-encoding and embedding cover art
Expand All @@ -13,10 +17,12 @@
- Embeds cover art to each audiofile (can be disabled)
- If directory contains multiple different audiobooks it won't try extract/embed cover art
- Can delete original image file, after embedding (not default)
- Requirments

## Requirments
- ffmpeg and ffprobe
- python

## Usage
<pre>
usage: audiobook-reencoder [-h] [--disable-extract-cover-art]
[--disable-embed-cover-art] [--only-extract-cover-art]
Expand Down Expand Up @@ -90,7 +96,7 @@ optional arguments:
--debug prints debug info
</pre>

Feature Descriptions
## Feature Descriptions

- Input/Output files/directories
- Input: single file or directory
Expand Down
10 changes: 5 additions & 5 deletions docs/audiobook_tts.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ optional arguments:
- python-gtts (optional, for google_translate_tts)


=Mimic3 TTS (software)=
### Mimic3 TTS (software)
Quality varies depending on voices. 'en_UK/apope_low' is the best, it sounds natural but flat and unemotional.

Requirements
Expand All @@ -78,22 +78,22 @@ Voices(en)
- Male (American) - en_US/m-ailabs_low - (not-great, recomended speed 1.1)
- Female (American) - en_US/vctk_low - (bad, very fast)

=VoiceRSS TTS (online service)=
### VoiceRSS TTS (online service)
Free limited service or paid full service. Voice quality is average (between robotic and natural).


=MS Azure TTS (online serice)=
### MS Azure TTS (online serice)
requires a subsciption or free testing period


=Google Translate TTS=
### Google Translate TTS
This is not Google cloud TTS, it uses Google translate's option for TTS output. Voice quality is robotic.

Requirements
- python gtts module


=Alterative (unimplemented) TTS engines=
## Alterative (unimplemented) TTS engines
I have not created APIs for these serices yet, but you can add you own in the APIs folder, then add to config file. Examples/samples of various engins can be found here https://synesthesiam.github.io/opentts

- marytts (software) - pitch warbles between words
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/online_tts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Description:
Text to Speech (TTS) program which interfaces with online/cloud TTS services, and is optimized for audiobooks and web-novels

#*# Supported service
## Supported service
- Microsoft Azure TTS
- VoiceRSS TTS
- Google translate TTS (not Google cloud TTS)
Expand Down

0 comments on commit b263860

Please sign in to comment.