ASB-Auto-Subgen - GitLite

KO | EN

gitlite — search

#ai-agents #awesome-list #agent #monitoring #bash #developer-tools #security #cpp #windows #generative-ai

ASB-Auto-Subgen

(★ 29)

Based off of https://huggingface.co/spaces/Nick088/Fast-Subtitle-Maker/tree/main

File Explorer

ZIP Download

- FUNDING.yml
- __init__.py
- main.py
- shared.py
- watcher.py
.gitignore
.gitmodules
.python-version
asbplayer
MANIFEST.in
publish.ps1
pyproject.toml
README.md
run_groq_gen.bat
uv.lock

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`ffmpeg`

View Details ▼

Video conversion tool.
See also: `gst-launch-1.0`.

ffmpeg -i {{path/to/video.mp4}} -vn {{path/to/sound.mp3}}

Extract the sound from a video and save it as MP3:

ffmpeg -i {{path/to/input_audio.flac}} -ar 44100 -sample_fmt s16 {{path/to/output_audio.wav}}

Transcode a FLAC file to Red Book CD format (44100kHz, 16bit):

ffmpeg -i {{path/to/video.mp4}} {{[-vf|-filter:v]}} 'scale=-1:1000' -r 15 {{path/to/output.gif}}

Save a video as GIF, scaling the height to 1000px and setting framerate to 15:

🔍

`pip install`

View Details ▼

Install Python packages.

pip install {{package1 package2 ...}}

Install one or more packages:

pip install {{package1 package2 ...}} {{[-U|--upgrade]}}

Upgrade all specified packages to the latest version, installing any that are not already present:

pip install {{package}}=={{version}}

Install a specific version of a package:

🔍

`uv tool`

View Details ▼

Install and run commands provided by Python packages.

uv tool run {{command}}

Run a command from a package, without installing it:

uv tool install {{package}}

Install a Python package system-wide:

uv tool upgrade {{package}}

Upgrade an installed Python package:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ASB Auto Subs

ASB Auto Subs is a tool for generating subtitles from YouTube videos using whisper locally, or groq remotely. It monitors the clipboard for YouTube links, as well as file path (shift right click "copy as path" on windows), gets the audio, and generates subtitles in `.srt` format. The project also integrates with the ASBPlayer WebSocket server for automatically loading subtitles.

https://pypi.org/project/asb-auto-subgen/

## Getting Started

### Install the Package

To get started, pip install the package:

pip
```bash
pip install asb-auto-subgen
```

OR
```bash
uv tool install asb-auto-subgen
```

If you want to run whisper locally...

```bash
pip install asb-auto-subgen[local]
```
OR
```bash
uv tool install asb-auto-subgen[local]
```

### Updating

If you already have the tool installed, update it with the same method you used to install it:

```bash
pip install --upgrade asb-auto-subgen
```

```bash
uv tool upgrade asb-auto-subgen
```

If you use local Whisper support, update with:

```bash
pip install --upgrade "asb-auto-subgen[local]"
```

```bash
uv tool install --upgrade "asb-auto-subgen[local]"
```

### Requirements

- Python 3.11+
- `ffmpeg` installed and available in your system's PATH
- `go` installed and available in your system's PATH (for the asbplayer websocket server)

### Configure `config.yaml`

Before running the project, you need to configure the `config.yaml` file. This file contains essential settings, changing how asb-auto-subs will behave.

This will be generated on first run if it doesn't exist (idk where).

1. Open the `config.yaml` file in a text editor .
2. Update the configuration values as needed. For example:
   ```yaml
   process_locally: false
   whisper_model: "small"
   GROQ_API_KEY: ""
   RUN_ASB_WEBSOCKET_SERVER: true
   model: "whisper-large-v3-turbo"
   output_dir: "output"
   language: "ja"
   skip_language_check: false
   cookies: ""
   ```
3. Save the file.

#### What Each Config Does:

- `process_locally`: Determines if the transcription is done locally or via the groq API. Set this to `true` only if you installed `asb-auto-subgen[local]`.
- `whisper_model`: The whisper model to use for local transcription.
- `GROQ_API_KEY`: Your API key for accessing Groq's services.
- `RUN_ASB_WEBSOCKET_SERVER`: Whether to run the ASBPlayer WebSocket server.
- `model`: The groq transcription model to use.
- `output_dir`: Directory where output files are saved.
- `language`: Language code for transcription. Also used to check if the video's language is what we want.
- `skip_language_check`: When `true`, bypasses YouTube metadata language validation entirely.
- `cookies`: Cookies for authenticated yt-dlp requests.

## Setup API Usage

### Where to get Groq API Key? (REQUIRED)

Can sign up here https://console.groq.com/ and after sign up it will ask you to generate an api key.

## Run the Script

The script monitors your clipboard for YouTube links. When a valid YouTube link is detected, it automatically downloads the audio, generates subtitles, saves them, and then sends them to the ASBPlayer WebSocket server.

To start the script:

```bash
asb-auto-subgen
```

## ASBPlayer WebSocket Server

This project integrates with the ASBPlayer WebSocket server for subtitle synchronization. You can find more information about ASBPlayer and its WebSocket server [here](https://github.com/killergerbah/asbplayer).

## Contact

If you run into issues, you can make an issue [here](https://github.com/bpwhelan/ASB-Auto-Subs/issues).

## Credits

- https://github.com/killergerbah/asbplayer
- https://huggingface.co/spaces/Nick088/Fast-Subtitle-Maker/tree/main
- https://github.com/m1guelpf/yt-whisper for the yt-download logic/idea

## Donations

If you've benefited from this or any of my other projects, please consider supporting my work
via [Github Sponsors](https://github.com/sponsors/bpwhelan) or [Ko-fi.](https://ko-fi.com/beangate)