Skip to content

Latest commit

 

History

History
509 lines (391 loc) · 27.3 KB

doc.md

File metadata and controls

509 lines (391 loc) · 27.3 KB

Default hotkeys

Context refers to the currently focused widget.

Shortcut Context Command
Ctrl+Shift+N global new
Ctrl+O global open
Ctrl+S global save
Ctrl+Shift+S global save-as
Ctrl+Q global quit
Ctrl+G global sub-select ask-number
Ctrl+Shift+G global sub-select ask-time
Alt+G global seek -p=ask
Ctrl+K global sub-select one-above
Ctrl+J global sub-select one-below
Ctrl+A global sub-select all
Ctrl+Shift+A global sub-select none
Alt+1 global play-region -s=a.s-500ms -e=a.s
Alt+2 global play-region -s=a.s -e=a.s+500ms
Alt+3 global play-region -s=a.e-500ms -e=a.e
Alt+4 global play-region -s=a.e -e=a.e+500ms
Ctrl+R global play-region -s=a.s -e=a.e
Ctrl+T global seek -p=cs.s -U
Ctrl+, global seek -p=-1f -P
Ctrl+. global seek -p=+1f -P
Ctrl+; global seek -p=cs.s -P
Ctrl+' global seek -p=cs.e -P
Ctrl+Shift+, global seek -p=-500ms -P
Ctrl+Shift+. global seek -p=+500ms -P
Ctrl+P global pause toggle
Ctrl+Z global undo
Ctrl+Y global redo
Ctrl+F global search
Ctrl+H global search-and-replace
Ctrl+Shift+Return global sub-insert --before
Ctrl+Return global sub-insert --after
Ctrl+Delete global sub-delete
Ctrl+Shift+1 global audio-set-sel -s=-500ms
Ctrl+Shift+2 global audio-set-sel -s=+500ms
Ctrl+Shift+3 global audio-set-sel -e=-500ms
Ctrl+Shift+4 global audio-set-sel -e=+500ms
Ctrl+1 global audio-set-sel -s=-1f
Ctrl+2 global audio-set-sel -s=+1f
Ctrl+3 global audio-set-sel -e=-1f
Ctrl+4 global audio-set-sel -e=+1f
Ctrl+B global audio-set-sel -s=cf
Ctrl+M global audio-set-sel -e=cf
Ctrl+N global audio-set-sel -s=cf -e=cf+dsd
Ctrl+[ global set-playback-speed '{}-0.1'
Ctrl+] global set-playback-speed '{}+0.1'
Ctrl+{ global set-playback-speed '{}-0.5'
Ctrl+} global set-playback-speed '{}+0.5'
F3 global search-repeat --below
Shift+F3 global search-repeat --above
Alt+A global focus-widget spectrogram
Alt+S global focus-widget subtitles-grid
Alt+D global focus-widget text-editor -s
Alt+Shift+D global focus-widget note-editor -s
Alt+C global focus-widget console-input -s
Alt+Shift+C global focus-widget console-window
Alt+X global sub-split -p=cf
Alt+J global sub-merge --concat
Alt+Up global sub-move --above
Alt+Down global sub-move --below
Alt+Return global file-properties
Ctrl+F5 global reload
Ctrl+F10 global reload-cmds
Shift+1 spectrogram audio-set-sel -s=-500ms
Shift+2 spectrogram audio-set-sel -s=+500ms
Shift+3 spectrogram audio-set-sel -e=-500ms
Shift+4 spectrogram audio-set-sel -e=+500ms
1 spectrogram audio-set-sel -s=-1f
2 spectrogram audio-set-sel -s=+1f
3 spectrogram audio-set-sel -e=-1f
4 spectrogram audio-set-sel -e=+1f
C spectrogram sub-set --start=a.s --end=a.e
K spectrogram sub-select one-above
J spectrogram sub-select one-below
Shift+Return spectrogram sub-insert --before
Return spectrogram sub-insert --after
R spectrogram play-region -s=a.s -e=a.e
T spectrogram seek -p=cs.s -U
P spectrogram pause toggle
A spectrogram audio-scroll-view -d=-0.05
F spectrogram audio-scroll-view -d=0.05
Ctrl+- spectrogram audio-zoom-view -d=1.1
Ctrl+= spectrogram audio-zoom-view -d=0.9
Ctrl++ spectrogram audio-zoom-view -d=0.9
, spectrogram seek -p=-1f -P
. spectrogram seek -p=+1f -P
; spectrogram seek -p=cs.s -P
' spectrogram seek -p=cs.e -P
Ctrl+Shift+, spectrogram seek -p=-1500ms -P
Ctrl+Shift+. spectrogram seek -p=+1500ms -P
Shift+, spectrogram seek -p=-500ms -P
Shift+. spectrogram seek -p=+500ms -P
B spectrogram audio-set-sel -s=cf
M spectrogram audio-set-sel -e=cf
N spectrogram audio-set-sel -s=cf -e=cf+dsd
[ spectrogram set-playback-speed '{}-0.1'
] spectrogram set-playback-speed '{}+0.1'
{ spectrogram set-playback-speed '{}-0.5'
} spectrogram set-playback-speed '{}+0.5'
Alt+Left spectrogram audio-set-sel -s=ps.e
Alt+Right spectrogram audio-set-sel -e=ns.s
Alt+Shift+Left spectrogram audio-set-sel -s=-1kf
Alt+Shift+Right spectrogram audio-set-sel -e=+1kf
Ctrl+C subtitles grid sub-copy
Ctrl+V subtitles grid sub-paste --after
K subtitles grid sub-select one-above
J subtitles grid sub-select one-below
Shift+Return subtitles grid sub-insert --before
Return subtitles grid sub-insert --after
R subtitles grid play-region -s=a.s -e=a.e
T subtitles grid seek -p=cs.s -U
P subtitles grid pause toggle
Delete subtitles grid sub-delete
[ subtitles grid set-playback-speed '{}-0.1'
] subtitles grid set-playback-speed '{}+0.1'
{ subtitles grid set-playback-speed '{}-0.5'
} subtitles grid set-playback-speed '{}+0.5'

Default commands

audio‑scroll‑view

Aliases: spectrogram-scroll-view

Scrolls the spectrogram horizontally by its width's percentage.

Usage: audio‑scroll‑view -d|--delta=…

  • -d, --delta: factor to shift the viewport by

audio‑set‑sel

Aliases: audio-set-selection, spectrogram-set-sel, spectrogram-set-selection

Sets the spectrogram selection.

Usage: audio‑set‑sel [-s|--start=…] [-e|--end=…] [--no-align]

  • -s, --start: new start of the selection
  • -e, --end: new end of the selection
  • --no-align: don't realign selection to video frames

audio‑set‑view

Aliases: spectrogram-set-view

Sets the spectrogram viewport.

Usage: audio‑set‑view [-s|--start=…] [-e|--end=…] [--no-align]

  • -s, --start: new start of the viewport
  • -e, --end: new end of the viewport
  • --no-align: don't realign viewport to video frames

audio‑zoom‑view

Aliases: spectrogram-zoom-view

Zooms the spectrogram in or out by the specified factor.

Usage: audio‑zoom‑view -d|--delta=…

  • -d, --delta: factor to zoom the viewport by

cycle‑audio

Switches to the next loaded audio stream.

cycle‑video

Switches to the next loaded video stream.

file‑properties

Opens up the metadata editor dialog.

focus‑widget

Focuses given widget.

Usage: focus‑widget target [-s|--select]

  • target: which widget to focus (can be note-editor, video-container, video-controller, video-volume, status, status-frame-label, status-audio-label, text-editor, style-editor, actor-editor, layer-editor, margin-left-editor, margin-right-editor, margin-vertical-editor, start-time-editor, end-time-editor, duration-editor, comment-checkbox, subtitles-grid, spectrogram, console-container, console-window, console-input)
  • -s, --select: whether to select the text

help

Lists available commands.

Usage: help [cmd]

  • cmd: command name to get help for

list‑audio

Lists loaded audio streams in the console.

list‑video

Lists loaded video streams in the console.

load‑audio

Loads an audio file for audio playback. Prompts user to choose where to load the file from if the path wasn't specified in the command arguments.

Usage: load‑audio [-p|--path=…]

  • -p, --path: path to load the audio from

load‑video

Loads a video file for video playback. Prompts user to choose where to load the file from if the path wasn't specified in the command arguments.

Usage: load‑video [-p|--path=…]

  • -p, --path: path to load the video from

manage‑styles

Aliases: styles-manager, style-manager

Opens up the style manager.

mute

Mutes or unmutes the video audio.

Usage: mute operation

  • operation: whether to mute the audio (can be 1, yes, y, on, enable, 0, no, n, off, disable, toggle)

new

Opens a new file. Prompts user to save the current file if there are unsaved changes.

noop

Does nothing.

open

Opens an existing subtitles file. Prompts user to save the current file if there are unsaved changes. Prompts user to choose where to load the file from if the path wasn't specified in the command arguments.

Usage: open [-p|--path=…]

  • -p, --path: path to load the subtitles from

pause

Pauses or unpauses the video playback.

Usage: pause operation

  • operation: whether to pause the video (can be 1, yes, y, on, enable, 0, no, n, off, disable, toggle)

play‑region

Seeks to region start and plays audio/video until region end.

Usage: play‑region [-s|--start=cf] [-e|--end=…]

  • -s, --start: start of region to play
  • -e, --end: end of region to play

quit

Quits the application. Prompts user to save the current file if there are unsaved changes.

redo

Redoes last edit operation.

reload‑cmds

Rescans filesystem for commands.

reopen

Aliases: reload

Reloads the currently loaded subtitles file from disk. Prompts user to save the current file if there are unsaved changes. Resets undo stack.

Usage: reopen [-p|--path=…]

  • -p, --path: path to load the subtitles from

save

Saves the current subtitles to an ASS file. If the currently loaded subtitles weren't ever saved, prompts user to choose where to save the file to.

save‑as

Saves the current subtitles to an ASS file. Prompts user to choose where to save the file to if the path wasn't specified in the command arguments.

Usage: save‑as [-p|--path=…]

  • -p, --path: optional path to save the subtitles to

save‑audio‑sample

Saves given subtitles to a WAV file. Prompts user to choose where to save the file to if the path wasn't specified in the command arguments.

Usage: save‑audio‑sample [-s|--start=a.s] [-e|--end=a.e] [-p|--path=…]

  • -s, --start: start of the audio sample
  • -e, --end: end of the audio sample
  • -p, --path: path to save the sample to

save‑screenshot

Makes a screenshot of given video frame. Prompts user to choose where to save the file to if the path wasn't specified in the command arguments.

Usage: save‑screenshot [--pts=cf] [-p|--path=…] [-i|--include-subs] [--width=…] [--height=…]

  • --pts: which frame to make screenshot of
  • -p, --path: path to save the screenshot to
  • -i, --include-subs: whether to "burn" the subtitles into the screenshot
  • --width: width of the screenshot (by default, original video width)
  • --height: height of the screenshot (by default, original video height)

search

Opens up the search dialog.

search‑and‑replace

Opens up the search and replace dialog.

search‑repeat

Aliases: search-again

Repeats last search operation.

Usage: search‑repeat [--above] [--below]

  • --above: search forward
  • --below: search backward

seek

Changes the video playback position to desired place.

Usage: seek -p|--pos=… [--precise] [-P|--pause] [-U|--unpause]

  • -p, --pos: where to seek
  • --precise: whether to use precise seeking at the expense of performance
  • -P, --pause: pause after seeking
  • -U, --unpause: unpause after seeking

set‑audio‑delay

Sets a delay to the currently loaded audio stream. Positive delay values will cause the audio to play later, while negative ones will cause it to play earlier.

Usage: set‑audio‑delay delay

  • delay: amount to dealy the stream

set‑playback‑speed

Adjusts the video playback speed.

Usage: set‑playback‑speed expression

  • expression: expression to calculate new playback speed

set‑theme

Changes the GUI color theme.

Usage: set‑theme theme_name

  • theme_name: name of the theme to change to (can be dark, light, system-dark, system-light)

set‑volume

Adjusts the video volume.

Usage: set‑volume expression

  • expression: expression to calculate new volume

show‑view

Switches to a different view layout.

Usage: show‑view view

  • view: which view to show (can be full, audio, video, subs)

show‑widget

Shows or hides given widget.

Usage: show‑widget target [-m|--mode=toggle]

  • target: target widget (can be note-editor, video-container, video-controller, video-volume, status, status-frame-label, status-audio-label, text-editor, style-editor, actor-editor, layer-editor, margin-left-editor, margin-right-editor, margin-vertical-editor, start-time-editor, end-time-editor, duration-editor, comment-checkbox, subtitles-grid, spectrogram, console-container, console-window, console-input)
  • -m, --mode: whether to show or hide the widget (can be show, hide, toggle)

spell‑check

Opens up the spell check dialog.

sub‑clone

Aliases: sub-duplicate

Duplicates given subtitles. Duplicated subtitles are interleaved with the source subtitles.

Usage: sub‑clone [-t|--target=selected]

  • -t, --target: subtitles to clone

sub‑copy

Copies given subtitles to clipboard.

Usage: sub‑copy [-t|--target=selected] [-s|--subject=all]

  • -t, --target: subtitles to paste into
  • -s, --subject: subject to copy (can be text, notes, times, all)

sub‑delete

Deletes given subtitles.

Usage: sub‑delete [-t|--target=selected]

  • -t, --target: subtitles to delete

sub‑insert

Inserts one empty subtitle.

Usage: sub‑insert [-o|--origin=selected] [--no-align] [--before] [--after]

  • -o, --origin: where to insert the subtitle
  • --no-align: don't realign the subtitle to video frames
  • --before: insert before origin
  • --after: insert after origin

sub‑merge

Aliases: sub-join

Merges given subtitles together.

Usage: sub‑merge [-t|--target=selected] [--concat|--concatenate] [--separator=newline]

  • -t, --target: subtitles to merge
  • --concat, --concatenate: merge the subtitles text and notes (otherwise keep only the first subtitle)
  • --separator: separator to merge the text with (can be none, space, newline)

sub‑merge‑karaoke

Aliases: sub-join-karaoke

Merges given subtitles adding karaoke timing tags inbetween.

Usage: sub‑merge‑karaoke [-t|--target=selected] [--invisible]

  • -t, --target: subtitles to merge
  • --invisible: use alternative karaoke transformation

sub‑move

Moves given subtitles around.

Usage: sub‑move [-t|--target=selected] [--above] [--below] [--gui]

  • -t, --target: subtitles to move
  • --above: move subtitles up
  • --below: move subtitles down
  • --gui: prompt user for placement position with a GUI dialog

sub‑paste

Pastes subtitles from clipboard.

Usage: sub‑paste [-o|--origin=selected] [--before] [--after]

  • -o, --origin: where to paste the subtitles
  • --before: paste before origin
  • --after: paste after origin

sub‑paste‑into

Pastes text or times into the given subtitles.

Usage: sub‑paste‑into [-t|--target=selected] -s|--subject=…

  • -t, --target: subtitles to paste the subject into
  • -s, --subject: subject to copy (can be text, notes, times)

sub‑select

Selects given subtitles.

Usage: sub‑select target

  • target: subtitles to select

sub‑set

Updates given subtitles parameters.

Usage: sub‑set [-t|--target=selected] [--text=…] [--note=…] [--actor=…] [--style=…] [--comment] [--no-comment] [--layer=…] [-s|--start=…] [-e|--end=…] [--no-align]

  • -t, --target: subtitles to change
  • --text: new subtitles text
  • --note: new subtitles note
  • --actor: new subtitles actor
  • --style: new subtitles style
  • --comment: mark subtitles as a comment
  • --no-comment: mark subtitles as a non-comment
  • --layer: new subtitles layer
  • -s, --start: new subtitles start
  • -e, --end: new subtitles end
  • --no-align: don't realign subtitles to video frames

sub‑shift

Shifts given subtitles. Prompts user to provide amount to shift by.

Usage: sub‑shift [-t|--target=selected] [--no-align]

  • -t, --target: subtitles to shift
  • --no-align: don't realign subtitles to video frames

sub‑sort

Sorts all subtitles by their start time.

Usage: sub‑sort [-t|--target=selected] [-s|--style=start]

  • -t, --target: subtitles to process
  • -s, --style: how to sort the subtitles (can be start, end, actor, style, layer)

sub‑split

Splits given subtitles at specified time.

Usage: sub‑split [-t|--target=selected] [--no-align] [-p|--position=…]

  • -t, --target: subtitles to split
  • --no-align: don't align split position to video frames
  • -p, --position: position to split the subtitles at

sub‑split‑karaoke

Splits given subtitles according to the karaoke tags inside.

Usage: sub‑split‑karaoke [-t|--target=selected]

  • -t, --target: subtitles to split

sub‑stretch

Stretches given subtitles to fit between new timestamp range.

Usage: sub‑stretch [-t|--target=selected] [--no-align] -s|--start=… -e|--end=…

  • -t, --target: subtitles to stretch
  • --no-align: don't realign subtitles to video frames
  • -s, --start: starting subtitle new start timestamp
  • -e, --end: ending subtitle new start timestamp

switch‑audio

Switches to the chosen loaded audio stream.

Usage: switch‑audio index

  • index: index of the stream to switch to

switch‑video

Switches to the chosen loaded video stream.

Usage: switch‑video index

  • index: index of the stream to switch to

undo

Undoes last edit operation.

unload‑audio

Unloads currently loaded audio file.

unload‑video

Unloads currently loaded video file.

video‑pan

Pans the video to specific position.

Usage: video‑pan expr_x expr_y

  • expr_x: expr to calculate new pan x position
  • expr_y: expr to calculate new pan y position

video‑zoom

Zooms the video in or out by the specified factor.

Usage: video‑zoom expression

  • expression: expression to calculate new zoom