Metadata-Version: 2.1
Name: mpv-whisper
Version: 0.1.0
Summary: Enhances a local MPV instance with Whisper transcription capabilities
Home-page: https://github.com/alexkoay/mpv-whisper
Author: Alex Koay
Author-email: alexkoay88@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: attrs (>=23.2.0,<24.0.0)
Requires-Dist: cattrs (>=23.2.3,<24.0.0)
Requires-Dist: faster-whisper (>=1.0.1,<2.0.0)
Requires-Dist: more_itertools (>=10.2.0,<11.0.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: pyav (>=12.0.4,<13.0.0)
Requires-Dist: python_mpv_jsonipc (>=1.2.0,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Repository, https://github.com/alexkoay/mpv-whisper
Description-Content-Type: text/markdown

# MPV-Whisper

Adding Whisper audio transcription capabilities to MPV


## Installing

Simply run the following to get started:

```pip install mpv-whisper```

To use the GPU, ensure that the appropriate version of PyTorch is installed.


## Configuration

mpv-whisper searches for configuration in two places, and defaults back to the package-provided default if not found:

- `./mpv-whisper.toml`
- `~/.config/mpv-whisper/config.toml`
- package provided `config.toml`

Refer to the default [`config.toml`](https://github.com/alexkoay/mpv-whisper/blob/master/mpv_whisper/config.toml) for accepted configuration values.

## Roadmap

- Using `dump_cache` or something similar to extract audio instead of running FFmpeg separately

## Credits

- [GhostNaN/whisper-subs](https://github.com/GhostNaN/whisper-subs) for providing pointers on how to add whisper to MPV

