interSubs

Interactive subtitles for mpv, that was made to help study languages.
Easily tweaked and customizable.

v. 2.10 - Changelog at the bottom.
If Qt version doesn't work for you - use Tk. It was abandoned(2017), but maybe still works.

Supported dictionaries for words:
Supported dictionaries for sentences:
- https://www.deepl.com/translator
- https://translate.google.com/
Supported dictionaries for word pronunciation:
Offline \t separated dictionary. details | pyglossary
http://linguee.com/ redirecting to browser by click.
Can use multiple dictionaries simultaneously.
Reassigning mouse buttons functions in config.
Doesn't work with DVD (picture based) subtitles, only the text-based ones.
- Script to convert picture based subtitles into *.srt; also extracts them from *.mkv
Can extend time of subs showing; for slow readers

    00:02:23,046 --> 00:02:25,990
    bla bla
    00:02:28,020 --> 00:02:33,084
    waka waka
    
    00:02:23,046 --> 00:02:28,020
    bla bla
    00:02:28,020 --> 00:02:33,084
    waka waka

Requirements

mpv 0.27 (I don't know if it will work with mpv front-ends.)
Xorg (ignore for Mac users)
composite manager; xcompmgr or sth. (ignore for Mac users)
python => 3.6
python-pyqt5
python-numpy
python-beautifulsoup4
python-requests
python-lxml
python-httpx
lua
socat
pkill
xdotool (for hiding subtitles when minimizing mpv or switching window)
optional: chromium (for external translation, other browser can be specified)
optional: wget (for listening to pronunciation)

Installation

mv interSubs.py interSubs.lua interSubs_config.py ~/.config/mpv/scripts/;
Edit configuration file interSubs_config.py
Edit interSubs.lua to add option where interSubs will start automatically.
For Mac also edit configuration at interSubs.lua
On KDE(kwin) go to Compositor and uncheck "Allow applications to block compositing". Screenshot.
For Windows - port it yourself. (It does NOT work on Windows. reason) and a possible way to do it). Consider installing VirtualBox and Ubuntu or some other user-friendly distro.

Usage

Start video with mpv & select subtitles.
F5 to start/stop interSubs.
- Starts automatically with files/paths specified in interSubs.lua
Point cursor over the word to get popup with translation.
F6 to hide/show without exiting.

Buttons bellow may be reassigned in config

Left-click - show translation in your browser.
Right-click - listen to pronunciation.
Wheel - scroll through transitions in popup.
Wheel+Ctrl - resize subtitles.
Wheel+Shift - change subtitles' vertical position.
Wheel-click - cycle through auto_pause options.
Wheel-click-left/right - +/- auto_pause_min_words. (fancy mouses)
Back-click - translate whole sentence. (fancy mouses)

Troubleshooting

Does not work at all - launch mpv in a console, then start interSubs and see if there are any errors that might indicate on missing packages and install them.
Background and subtitles are shown as solid black bars - install/launch a compositor.
May have issues working in a multi-monitor system. See the solution.
On KDE subtitles might sometimes be invisible. See the solution.
On KDE subtitles fade instead of appearing immediately. See the solution
Instead of changing system settings you may change --x11-bypass-compositor
Stuttering video during subtitles change might be solved by changing mpv's video output mpv --vo gpu.
On MacOS subtitles are not rendered on top of mpv. See a possible solution
On MacOS subtitles are not rendered on top of mpv only in fullscreen mode. See the solution

Changelog

2.0a
- Configs are incompatible with previous version.
- Tk is abandoned in favor of Qt.
  - Background can be fully transparent or semi/fully opaque.
  - Rendering is faster than with Tk.
  - requires pyqt5 for python 3
    - pip install pyqt5 / pacman -S python-pyqt5
  - requires composite manager for not solid bg; xcompmgr or sth.
  - tested on Openbox, i3, KDE(kwin).
  - On KDE(kwin) go to composite and uncheck "Allow applications to block compositing". screenshot
- No more stalling when pointing on a wrong word; those words will be translated and saved in background.
- R2L isn't ready yet.
- Option to not save translations on the disk was removed.
- Noun colorization was removed.
- Randomization of translations was removed.
- Option to show N of previous subtitles is suspended for now, I might add it in the future.
- Tk version won't be updated unless something critical happens.
2.1
- R2L support (checked on Hebrew; works more or less).
- Minor corrections.
2.2
- Added https://dict.leo.org/ - de<>en/es/fr/it/pl/pt/ru/zh(cn)
- Minor corrections.
2.3
- Added option to limit extension of subtitles during long scenes without talking.
  - extend_subs_duration_limit_sec = 15
- Updated https://translate.google.com/
  - Now it gives complete output instead of single result.
  - mtranslate_google -> google
- Added http://www.morfix.co.il/
  - morfix
- Minor error corrections.
2.4
- Fixed non-working deepl.com
- Minor corrections.
2.5
- Added option to hide/show interSubs without exiting - F6
- Minor corrections.
2.6
- Fixed inability to start after update to pyqt5 5.11.3 or sth in that area. Didn't look for version that causes it specifically.
2.7
- Fixed residual flickering of previous lines during subtitles change. Began to happen at qt5.12 or so.
2.8
- Fixed gtts/pons pronunciation.
- Fixed google-translation.
2.9
- Added google-translation for full sentences(default mouse Back-click):
  - f_translation_full_sentence to bind to mouse instead of f_deepl_translation
  - in config translation_function_name_full_sentence = 'google'
2.10
- Fixed google-translation

oltodosel / interSubs