Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pierretom/autoselect-forced-sub
Automatically select forced subtitles in a different way
https://github.com/pierretom/autoselect-forced-sub
automatic forced lua mpv mpv-player mpv-script script subtitle
Last synced: 4 months ago
JSON representation
Automatically select forced subtitles in a different way
- Host: GitHub
- URL: https://github.com/pierretom/autoselect-forced-sub
- Owner: pierretom
- License: unlicense
- Created: 2023-11-01T11:54:23.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2023-12-03T14:06:39.000Z (7 months ago)
- Last Synced: 2023-12-03T15:22:37.617Z (7 months ago)
- Topics: automatic, forced, lua, mpv, mpv-player, mpv-script, script, subtitle
- Language: Lua
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-mpv - autoselect-forced-sub - Automatically select forced subtitles in a different way. (Subtitle)
README
# autoselect-forced-sub
A Lua script for [mpv](https://mpv.io) to automatically select forced subtitles in a different way.
Forced subtitles are a type of subtitle that must be provided in a video just to make it understandable. Such as when a foreign or alien language is spoken, or when a sign or flag is shown.
The script does not download any subtitles and will also do nothing if no subtitles are available.
## Installation
Use `autoselect-forced-sub.lua` for the stable version of mpv (0.37.x).
Place it in the corresponding mpv `scripts` folder of your operating system:
* Linux & BSD:
- `$XDG_CONFIG_HOME/mpv/scripts` or
- `~/.config/mpv/scripts` or
- `/home//.config/mpv/scripts`
* macOS:
- `$HOME/.config/mpv/scripts` or
- `~/.config/mpv/scripts` or
- `/Users//.config/mpv/scripts`
* Windows:
- `%APPDATA%\mpv\scripts` or
- `c:\users\\AppData\Roaming\mpv\scripts`
## Options
This script uses some [mpv options](#mpv) and its [own options](#script).
### mpv
| Option | Value | Action |
| :------------------------- | :--------------- | :-------------------------------------------- |
| `track-auto-selection` | `no` | Disable this script at startup or at runtime. |
| `sid` *or* `sub` | *all but* `auto` | Disable this script at startup only. |
| `slang` | *optional but __recommended__* | Used to select forced and non-forced subs with the specified language codes. |
#### Notes
1. When setting up `--slang`, for better results, use [ISO 639-1, 639-2/T and 639-2/B codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
Examples:
* `--slang=ja,jpn,en,eng`
* `--slang=es,spa`
* `--slang=fr,fre,fra`
* `--slang=sq,alb,sqi`
2. All other mpv options are ignored.
### Script
| Option | Value | Action |
| :--------------------- | :--------------- | :-------------------------------------------- |
| `afs-enable` | `no` | Disable this script at startup or at runtime. Default value: `yes`.|
| `afs-sub_forced_only` | `yes` | Select only detected forced subtitles. Default value: `yes`.
If no forced subtitles match the language codes specified with `--slang`:
1. The first one that matches the language of the current audio track will be selected.
2. Otherwise it selects the forced subtitle with the lowest ID. |
| `afs-sub_forced_only` | `no ` | Select detected forced subtitles in priority.
If not found select another subtitle in that order:
1. First subtitle with the default flag that matches language codes.
2. First subtitle that matches language codes.
3. First subtitle that matches the language of the current audio track.
4. First subtitle with the default flag that not matches language codes.
5. The subtitle with the first ID. |
#### Notes
1. With `--script-opts=afs-sub_forced_only=no`, you are sure to select one forced or non-forced subtitle track.
#### Examples to set the script options
Options are read in that order:
##### 1. On the command line
```
mpv --script-opts=afs-enable=no
mpv --script-opts=afs-sub_forced_only=no
mpv --script-opts=afs-enable=yes,afs-sub_forced_only=yes
```
##### 2. In mpv.conf
```
script-opts=afs-enable=yes,afs-sub_forced_only=no
```
##### 3. In afs.conf
This file can be placed in the `script-opts` folder (same location as the [scripts](#installation) folder).
```
enable=yes
sub_forced_only=no
```
##### 4. In autoselect-forced-sub.lua
The options are located at the beginning of the script, below `our_opts =`.
```
enable = true
sub_forced_only = true
```
##### 5. For key bindings and the mpv console
```
change-list script-opts append afs-enable=no
change-list script-opts append afs-sub_forced_only=no
set script-opts afs-enable=yes,afs-sub_forced_only=yes
```