interSubs_config.py

#! /usr/bin/env python

# v. 2.3
# Interactive subtitles for `mpv` for language learners.

#########################################
# all *_B variables are boolean
######

# make sure selected translation function supports your language and so that codes of your languages are correct
# for instance Pons doesn't support Hebrew, Google and Reverso do, but their codes are different: 'iw' and 'he' respectively
# translate from language
lang_from = 'en'
# translate to language
lang_to = 'ml'

# dictionaries to use, one or more
# or other function's name you might write that will return ([[word, translation]..], [morphology = '', gender = ''])
# available:
#	pons
#	reverso
#	dict_cc
#	leo
#	google
#	morfix (he/en en/he)
#	redensarten (redensarten-index.de - German idioms etc.)
#	tab_divided_dict - simple offline dictionary with word \t translation per line
translation_function_names = ['tab_divided_dict']
# for automatic switch to Hebrew. Skip if it isn't your language.
translation_function_names_2 = ['google', 'morfix']

# number of translations in popup
number_of_translations = 4
# number of translations to save in files for each word; 0 - to save all
number_of_translations_to_save = 50

# gtts|pons|forvo # gtts is google-text-to-speech
listen_via = 'gtts'

# path to the offline dictionary
tab_divided_dict_fname = '~/.config/mpv/scripts/dicml.dict'
# strip <.*?>
tab_divided_dict_remove_tags_B = True

pause_during_translation_B = True
# don't hide subtitle when its time is up and keep it on screen until the next line
extend_subs_duration2max_B = True
# limit extension duration in seconds; N == 0: do not limit
extend_subs_duration_limit_sec = 15
# show interSubs only in fullscreen
hide_when_not_fullscreen_B = False

# interval between checking for the next subtitle; in seconds
update_time = .01
# interval in seconds between checking if mpv is in focus using `xdotool` and/or in fullscreen; in seconds
focus_checking_time = .1

# firefox "https://en.wiktionary.org/wiki/${word}"
show_in_browser = 'chromium "http://www.linguee.com/german-english/search?source=german&query=${word}"'

# filename where to save words if needed by bound to mouse-button function f_save_word_to_file; checks if the word is already there.
save_word_to_file_fname = '~/saved_words_by_interSubs'

# for going through lines step by step
# skip pausing when subs are less then X words
auto_pause_min_words = 10
# 0 - don't pause
# 1 - pause after subs change
# 2 - pause before subs change
# wheel click on interSubs cycles through options
auto_pause = 0

# translated language is written right-to-left, e.g Hebrew/Arabic
R2L_from_B = False
# translation is written right-to-left, e.g Hebrew/Arabic
R2L_to_B = False

#########################################################
#########################################################
### LOOKS ###
#########################################################
#########################################################

# show subtitles at the top of the screen
subs_top_placement_B = False
# distance to the edge; in px
subs_screen_edge_padding = 1
subs_padding_between_lines = 0

# when subtitle consists of only one overly long line - splitting into two
split_long_lines_B = True
# split when there are more than N words in line
split_long_lines_words_min = 8

# Qt's line wrapping doesn't work well
split_long_lines_in_popup_B = True
# split when there are more than N symbols in given line
split_long_lines_in_popup_symbols_min = 80

# ~ http://doc.qt.io/qt-5/stylesheet-reference.html
'''
/* Examples of css: */

background: transparent;				/* fully transparent */
background: black;						/* black background*/
background: #ffffff;					/* white background*/
background: rgba(0, 0, 0, 20%);			/* semi-opaque black 20% */
background: rgba(0, 0, 0, 50%);			/* semi-opaque black 50% */
background: rgba(0, 0, 0, 80%);			/* semi-opaque black 80% */
background: rgba(255, 255, 255, 40%);	/* semi-opaque white 40% */
background: rgba(44, 44, 44, 90%);		/* semi-opaque dark-grey 90% */

/* Font colors: */
color: white;
color: #BAC4D6;
color: rgb(217, 49, 49);				/* red */
color: rgba(217, 49, 49, 70%);			/* semi-opaque red 70% */

font-family: "Trebuchet MS";
font-weight: bold;
font-size: 33px;

font: bold italic large "Times New Roman" 34px;
'''

# CSS styles for subtitles
style_subs = '''
	/* looks of subtitles */
	QFrame {
		background: transparent;
		color: white;

		font-family: "Trebuchet MS";
		font-weight: bold;
		font-size: 43px;
	}
'''

# CSS styles for translations(popup)
style_popup = '''
	/* main */
	QFrame {
		background: rgba(44, 44, 44);

		font-family: "Trebuchet MS";
		font-weight: bold;
		font-size: 36px;
	}
	/* original language */
	QLabel#first_line {
		color: #DCDCCC;
	}

	/* original language - underlining exact word */
	QLabel#first_line_emphasize_word {
		color: #DCDCCC;
		text-decoration: underline;
	}

	/* translation */
	QLabel#second_line {
		color: #8B8F88;
	}

	/* colorizing morphology */
	[morphology=""]		{ color: #CA8200; }
	[morphology="m"]	{ color: #5EB0FF; }
	[morphology="f"]	{ color: #E34840; }
	[morphology="nt"]	{ color: #8BC34A; }

	/* delimiter between dictionaries */
	QFrame#delimiter {
		background: #8B8F88;
		font-size: 4px;	/* emulating thickness */
	}
'''

# for subtitles to be visible on background with similar color
# might look ugly with some fonts
outline_B = True
outline_color = '#000000'
# ~ N/2.5 == size in px; here it's 2px of outline + another ~ 3px of blur
outline_thickness = 5
outline_blur = 7
# change if outline is cropped from top/bottom of some letters depending on font
# in px; can take negative values
outline_top_padding = -2
outline_bottom_padding = 2

# highlighting the word under cursor
hover_color = '#F44336'
hover_hightlight = False	# may look ugly due to only int precision of QFontMetrics
hover_underline = True
hover_underline_thickness = 5

#########################################################
#########################################################
### reassigning mouse buttons ###
#########################################################
#########################################################

# functions' names are self-explanatory
# ['mouse_event', 'modifier_key', 'self_explanatory_function_name'],

# to one button multiple functions can be assigned
# by left-click this will open word in browser and save it to file.
# ['LeftButton', 'NoModifier', 'f_show_in_browser'],
# ['LeftButton', 'NoModifier', 'f_save_word_to_file'],

# https://doc.qt.io/qt-5/qt.html#MouseButton-enum
# mouse_event:
	# LeftButton
	# RightButton
	# MiddleButton (wheel-click)
	# BackButton (Typically present on the 'thumb' side of a mouse with extra buttons. This is NOT the tilt wheel.)
	# ForwardButton

	# wheel scroll up/down left/right names' are arbitrary and not from Qt
	# ScrollUp
	# ScrollDown
	# ScrollLeft (This is the tilt wheel.)
	# ScrollRight

# Note: On macOS, the ControlModifier value corresponds to the Command keys on the keyboard.
# https://doc.qt.io/qt-5/qt.html#KeyboardModifier-enum
# modifier_key:
	# NoModifier
	# ControlModifier
	# ShiftModifier
	# AltModifier

# self_explanatory_function_name:
	# f_show_in_browser
	# f_auto_pause_options
	# f_listen
	# f_scroll_translations_down
	# f_scroll_translations_up
	# f_subs_screen_edge_padding_decrease
	# f_subs_screen_edge_padding_increase
	# f_font_size_decrease
	# f_font_size_increase
	# f_auto_pause_min_words_decrease
	# f_auto_pause_min_words_increase
	# f_deepl_translation
	# f_save_word_to_file

mouse_buttons = [
	['LeftButton',		'NoModifier',		'f_show_in_browser'],
	['RightButton',		'NoModifier',		'f_listen'],
	['MiddleButton',	'NoModifier',		'f_auto_pause_options'],

	['BackButton',		'NoModifier',		'f_deepl_translation'],

	['ScrollDown',		'NoModifier',		'f_scroll_translations_down'],
	['ScrollUp',		'NoModifier',		'f_scroll_translations_up'],

	['ScrollDown',		'ControlModifier',		'f_font_size_decrease'],
	['ScrollUp',		'ControlModifier',		'f_font_size_increase'],

	['ScrollLeft',		'NoModifier',		'f_auto_pause_min_words_decrease'],
	['ScrollRight',		'NoModifier',		'f_auto_pause_min_words_increase'],

	['ScrollDown',		'ShiftModifier',		'f_subs_screen_edge_padding_decrease'],
	['ScrollUp',		'ShiftModifier',		'f_subs_screen_edge_padding_increase'],
]

# http://culmus.sourceforge.net/summary.html
he_fonts = ['Miriam', 'Miriam Mono', 'Ellinia', 'Drugulin', 'David', 'Frank Ruehl', 'Shofar']

# obsolete vars
hover_underline_width = hover_underline_thickness