NonGNU ELPA - subed

subed

Description
A major mode for editing subtitles
Latest
subed-1.2.4.tar, 2023-Sep-11, 1.16 MiB
Maintainer
Sacha Chua <sacha@sachachua.com>
Website
https://github.com/sachac/subed
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package from Emacs, use package-install or list-packages.

Full description

subed

subed is an Emacs major mode for editing subtitles while playing the corresponding media file with mpv. At the moment, the only supported formats are:

  • SubRip ( .srt)
  • WebVTT ( .vtt )
  • Advanced SubStation Alpha ( .ass, experimental )
  • Tab-separated values ( .tsv, experimental ) - as exported by Audacity for labels. TSVs are not recognized automatically because it's a common data format, but you can use subed-tsv-mode to turn it on in a buffer.

screenshot.jpg

Features

  • Jump to next (M-n) and previous (M-p) subtitle text.
  • Jump to the beginning (C-M-a) and end (C-M-e) of the current subtitle's text.
  • Merge subtitles with M-m (subed-merge-dwim) and split them with M-. (subed-split-subtitle). If the media file is playing in MPV, use the current playback position. If not, use the relative position in the subtitle text, or other functions listed in subed-split-subtitle-timestamp-functions.
  • Insert subtitles evenly spaced throughout the available space (M-i) or right next to the current subtitle (C-M-i). A prefix argument controls how many subtitles to insert and whether they are inserted before or after the current subtitle.
  • Kill subtitles (M-k).
  • Adjust subtitle start (M-[ / M-]) and stop (M-{ / M-}) time. A prefix argument sets the number of milliseconds for the current session (e.g. C-u 1000 M-[ M-[ M-[ decreases start time by 3 seconds).
  • Move the current subtitle or all marked subtitles (subed-move-subtitles) forward (C-M-n) or backward (C-M-p) in time without changing subtitle duration. A prefix argument sets the number of milliseconds for the current session (e.g. C-u 500 C-M-n C-M-n moves the current subtitle 1 second forward).
  • Shift the current subtitle forward (C-M-f) or backward (C-M-b) together with all following subtitles. This is basically a convenience shortcut for C-SPC M-> C-M-n/p.
  • Scale all subtitles or all marked subtitles forward (C-M-x) or backward (C-M-S-x) in time without changing subtitle duration. A prefix argument sets the number of milliseconds for the current session (e.g. C-u 500 C-M-x moves the last [or last marked] subtitle forward 500ms and proportionally scales all [or all marked] subtitles based on this time extension. Similarly, C-u 500 C-M-S-x moves the last [or last marked] subtitle backward 500ms and proportionally scales all [or all marked] subtitles based on this time contraction). This can be extremely useful to correct synchronization issues in existing subtitle files. First, adjust the starting time if necessary (e.g. C-M-f), then adjust the ending and scale constituent subtitles (e.g. C-M-x).
  • Show CPS (characters per second) for the current subtitle.
  • Insert HTML-like tags (C-c C-t C-t, with an optional attribute when prefixed by C-u), in particular italics (C-c C-t C-i) or boldface (C-c C-t C-b).
  • SRT: Sort and re-number subtitles and remove any extra spaces and newlines (M-s). This is done automatically every time the buffer is saved.
  • Trim subtitle overlaps with M-x subed-trim-overlaps. By default, this adjusts the stop time of overlapping subtitles to subed-subtitle-spacing milliseconds before the next subtitle starts. Use M-x customize-group subed to configure trimming to happen automatically when buffers are loaded or saved, which time is adjusted, and how much time to leave between subtitles.
  • Convert between formats with M-x subed-convert.
  • Show the waveform (M-x subed-waveform-minor-mode, off by default) extracted from the media file using ffmpeg with the start/stop positions of the current subtitle and the current position in MPV marked along with the subtitle. Change the "volume" of the waveform (i.e., the visible amplitude) with C-c C-- and C-c C-=. Redisplay the waveform with C-c |. Left/right-click on the waveform to set the start/stop timestamps. If you would like to display the waveform automatically when you open a file, you can add (add-hook 'subed-mode-hook 'subed-waveform-minor-mode) to your configuration.
  • Load word timing data (ex: SRV2) using M-x subed-word-data-load-from-file. This will be used for splitting words at timestamps when available.
  • Use M-x subed-align and aeneas to align your text or subtitles with an audio file in order to get timestamps.
mpv integration (optional)

Using network sockets to control MPV works on Linux and on Mac OS X, but not on Microsoft Windows due to the lack of Unix-style sockets. On Microsoft Windows, you will not be able to synchronize with MPV.

  • Automatically open the associated media file in MPV based on the filename, open a media file manually with C-c C-v (subed-mpv-play-from-file), or play media directly from a URL with C-c C-u (subed-mpv-play-from-url) . You can customize the automatic detection of files by changing subed-video-extensions and subed-audio-extensions.
  • Pause and resume playback without leaving Emacs (M-SPC).
  • Jump to the current subtitle in the MPV player with M-j (subed-mpv-jump-to-current-subtitle). Toggle looping over the current subtitle with C-c C-l (subed-toggle-loop-over-current-subtitle). Control how many seconds to loop before or after the current subtitles by customizing subed-loop-seconds-before and subed-loop-seconds-after.
  • Use C-c . (subed-toggle-sync-point-to-player) to toggle whether the point should move to the currently playing subtitle.
  • Use C-c , (subed-toggle-sync-player-to-point) to toggle whether mpv should seek to the position of the current subtitle when the point moves between subtitles.
  • Subtitles are automatically reloaded in mpv when the buffer is saved.
  • Copy the current playback position as start (C-c [) or stop (C-c ]) time of the current subtitle.
  • Playback is paused or slowed down when a subtitle's text is edited (C-c C-p, subed-toggle-pause-while-typing).
  • Loop over the current subtitle in mpv (C-c C-l).
  • When a subtitle's start or stop time changes, mpv seeks to the subtitle's start time (C-c C-r, subed-toggle-replay-adjusted-subtitle).
  • Move one frame forward or backward (C-c C-f . and C-c C-f ,; pressing , or . afterwards moves by frames until any other key is pressed).

Installation

Installing the subed package from NonGNU Elpa

subed is now on NonGNU ELPA. On Emacs 28 and later, you can install it with M-x package-install subed.

To install it on Emacs 27 or earlier, add the following to your Emacs configuration file: 

(with-eval-after-load 'package (add-to-list 'package-archives '("nongnu" . "https://elpa.nongnu.org/nongnu/")))

Use M-x eval-buffer to run the code, use M-x package-refresh-contents to load the package archives, and then use M-x package-install subed.

Sample configuration: 

(with-eval-after-load 'subed-mode
	;; Remember cursor position between sessions
	(add-hook 'subed-mode-hook 'save-place-local-mode)
	;; Break lines automatically while typing
	(add-hook 'subed-mode-hook 'turn-on-auto-fill)
	;; Break lines at 40 characters
	(add-hook 'subed-mode-hook (lambda () (setq-local fill-column 40)))
	;; Some reasonable defaults
	(add-hook 'subed-mode-hook 'subed-enable-pause-while-typing)
	;; As the player moves, update the point to show the current subtitle
	(add-hook 'subed-mode-hook 'subed-enable-sync-point-to-player)
	;; As your point moves in Emacs, update the player to start at the current subtitle
	(add-hook 'subed-mode-hook 'subed-enable-sync-player-to-point)
	;; Replay subtitles as you adjust their start or stop time with M-[, M-], M-{, or M-}
	(add-hook 'subed-mode-hook 'subed-enable-replay-adjusted-subtitle)
	;; Loop over subtitles
	(add-hook 'subed-mode-hook 'subed-enable-loop-over-current-subtitle)
	;; Show characters per second
	(add-hook 'subed-mode-hook 'subed-enable-show-cps))
Manual installation

If that doesn't work, you can install it manually. To install from the main branch: 

git clone https://github.com/sachac/subed.git

This will create a subed directory with the code.

If you have the make utility, you can regenerate the autoload definitions with 

make autoloads

If you don't have make installed, you can generate the autoloads with: 

emacs --quick --batch --eval "(progn (setq generated-autoload-file (expand-file-name \"subed-autoloads.el\" \"subed\") backup-inhibited t) \
	(update-directory-autoloads \"./subed\"))"

Then you can add the following to your Emacs configuration (typically ~/.config/emacs/init.el, ~/.emacs.d/init.el, or ~/.emacs; you can create this file if it doesn't exist yet). Here's a configuration example: 

;; Note the reference to the subed subdirectory, instead of the one at the root of the checkout
(add-to-list 'load-path "/path/to/subed/subed")
(require 'subed-autoloads)

(with-eval-after-load 'subed-mode
	;; Remember cursor position between sessions
	(add-hook 'subed-mode-hook 'save-place-local-mode)
	;; Break lines automatically while typing
	(add-hook 'subed-mode-hook 'turn-on-auto-fill)
	;; Break lines at 40 characters
	(add-hook 'subed-mode-hook (lambda () (setq-local fill-column 40)))
	;; Some reasonable defaults
	(add-hook 'subed-mode-hook 'subed-enable-pause-while-typing)
	;; As the player moves, update the point to show the current subtitle
	(add-hook 'subed-mode-hook 'subed-enable-sync-point-to-player)
	;; As your point moves in Emacs, update the player to start at the current subtitle
	(add-hook 'subed-mode-hook 'subed-enable-sync-player-to-point)
	;; Replay subtitles as you adjust their start or stop time with M-[, M-], M-{, or M-}
	(add-hook 'subed-mode-hook 'subed-enable-replay-adjusted-subtitle)
	;; Loop over subtitles
	(add-hook 'subed-mode-hook 'subed-enable-loop-over-current-subtitle)
	;; Show characters per second
	(add-hook 'subed-mode-hook 'subed-enable-show-cps))

You can reload your configuration with M-x eval-buffer or restart Emacs.

If you want to try a branch (ex: derived-mode), you can use the following command inside the subed directory: 

git checkout branchname
use-package configuration

Here's an example setup if you use use-package: 

(use-package subed
	:ensure t
	:config
	;; Remember cursor position between sessions
	(add-hook 'subed-mode-hook 'save-place-local-mode)
	;; Break lines automatically while typing
	(add-hook 'subed-mode-hook 'turn-on-auto-fill)
	;; Break lines at 40 characters
	(add-hook 'subed-mode-hook (lambda () (setq-local fill-column 40)))
	;; Some reasonable defaults
	(add-hook 'subed-mode-hook 'subed-enable-pause-while-typing)
	;; As the player moves, update the point to show the current subtitle
	(add-hook 'subed-mode-hook 'subed-enable-sync-point-to-player)
	;; As your point moves in Emacs, update the player to start at the current subtitle
	(add-hook 'subed-mode-hook 'subed-enable-sync-player-to-point)
	;; Replay subtitles as you adjust their start or stop time with M-[, M-], M-{, or M-}
	(add-hook 'subed-mode-hook 'subed-enable-replay-adjusted-subtitle)
	;; Loop over subtitles
	(add-hook 'subed-mode-hook 'subed-enable-loop-over-current-subtitle)
	;; Show characters per second
	(add-hook 'subed-mode-hook 'subed-enable-show-cps)
	)
straight configuration

If you use straight.el, you can install subed with the following recipe: 

(straight-use-package '(subed :type git :host github :repo "sachac/subed" :files ("subed/*.el")))

Getting started

C-h f subed-mode should get you started. This is the parent mode for subed-srt-mode, subed-vtt-mode, and subed-ass-mode. When manually loading a mode, use those specific format modes instead of subed-mode.

Troubleshooting

subed-mpv: Service name too long

If subed-mpv-client reports (error "Service name too long"), this is probably because the path to the socket used to communicate with MPV is too long for your operating system. You can use M-x customize to set subed-mpv-socket-dir to a shorter path.

Important change in v1.0.0

subed now uses subed-srt-mode, subed-vtt-mode, and subed-ass-mode instead of directly using subed-mode. These modes should be automatically associated with the .vtt, .srt, and .ass extensions. If the generic subed-mode is loaded instead of the format-specific mode, you may get an error such as: 

Error in post-command-hook (subed--post-command-handler): (cl-no-applicable-method subed--subtitle-id)

If you set auto-mode-alist manually in your config, please make sure you associate extensions the appropriate format-specific mode instead of subed-mode. The specific backend functions (ex: subed-srt--jump-to-subtitle-id) are also deprecated in favor of using generic functions such as subed-jump-to-subtitle-id.

Contributions

Contributions would be really appreciated! subed conforms to the REUSE Specification; this means that every file has copyright and license information. If you modify a file, please update the year shown after SPDX-FileCopyrightText. Thank you!

There's a list of authors in the file AUTHORS.org. If you have at any point contributed to subed, you are most welcome to add your name (and email address if you like) to the list.

License

subed is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Old versions

subed-1.2.3.tar.lz2023-Jun-18 180 KiB
subed-1.2.2.tar.lz2023-Apr-10 176 KiB
subed-1.2.1.tar.lz2023-Mar-21 176 KiB
subed-1.2.0.tar.lz2023-Mar-10 175 KiB
subed-1.1.0.tar.lz2023-Mar-08 175 KiB
subed-1.0.29.tar.lz2022-Dec-30 171 KiB
subed-1.0.19.tar.lz2022-Nov-12 168 KiB
subed-1.0.9.tar.lz2022-Sep-15 160 KiB
subed-1.0.8.tar.lz2022-Sep-08 160 KiB
subed-1.0.7.tar.lz2022-Jul-25 159 KiB
subed-1.0.6.tar.lz2022-Jul-22 159 KiB
subed-1.0.5.tar.lz2022-Apr-17 158 KiB
subed-1.0.4.tar.lz2022-Apr-16 158 KiB
subed-1.0.3.tar.lz2022-Feb-07 158 KiB
subed-1.0.2.tar.lz2022-Feb-02 157 KiB
subed-1.0.1.tar.lz2022-Feb-01 157 KiB
subed-0.0.4.tar.lz2022-Jan-24 156 KiB
subed-0.0.3.tar.lz2021-Dec-30 156 KiB
subed-0.0.2.tar.lz2021-Dec-07 154 KiB
subed-0.0.1.tar.lz2021-Dec-03 139 KiB

News

1. subed news

1.1. Version 1.2.4 - 2023-09-11 - Sacha Chua

Guess the format when the generic subed-mode is loaded. Also, require svg when subed-waveform is loaded.

1.2. Version 1.2.3 - 2023-06-18 - Sacha Chua

Added subed-waveform, which you can enable with subed-waveform-minor-mode. This makes it easier to review the waveform for the current subtitle so that you can use it to adjust the start or stop time. It requires the ffmpeg executable. Thanks, mbork!

1.3. Version 1.2.2 - 2023-04-09 - Sacha Chua

subed should not autoplay media over TRAMP.

1.4. Version 1.2.1 - 2023-03-21 - Sacha Chua

Adjusting the starting or stopping timestamp (including via merges) should now also update the looping start and stop times.

1.5. Version 1.2.0 - 2023-03-10 - Sacha Chua

I changed subed-mode so that it doesn't add functions to local hooks, because that seems to mess up configuring hooks from your Emacs init file. Please see README.org for recommended code to add to your subed-mode-hook. I decided to suggest each line separately so that it's easier for people to disable specific behaviors instead of hiding it in subed-setup-defaults.

1.6. Version 1.1.0 - 2023-03-07 - Sacha Chua

There are new customizable values for subed-enforce-time-boundaries that affect setting or adjusting the start or stop times if a subtitle will end up overlapping with the previous or next subtitle (based on subed-subtitle-spacing), or if a subtitle will have negative duration.

  • 'adjust: the new default. If a subtitle will have invalid times, adjust the other time to resolve the conflict.
  • 'clip: set the current time to at most (or at least) the other time, taking spacing into account.
  • 'error: report an error when trying to set an invalid time.
  • nil: don't perform any checks, just set the time.

By default, you can adjust times with M-[ (decrease-start-time), M-] (increase-start-time), M-{ (decrease-stop-time), and M-} (increase-stop-time).

I've been writing more tests to cover the behavior, but I might've missed stuff, so please let me know if things turn up!

1.7. Version 1.0.29 - 2022-12-29 - Sacha Chua

subed-toggle-sync-point-to-player should not confuse subed when it is already looping over a subtitle. Also, subed-loop-seconds-before and subed-loop-seconds-after now default to 0 for less confusion.

1.8. Version 1.0.28 - 2022-12-22 - Sacha Chua

subed-parse-file should handle nil filenames now. Also, it should not try to autoplay media.

1.9. Version 1.0.27 - 2022-12-16 - Sacha Chua

Bugfix: Actually include VTT comments when inserting subtitles programmatically.

1.10. Version 1.0.26 - 2022-11-30 - Sacha Chua

subed-align now keeps VTT comments. It also doesn't remove silences by default now, since aeneas turned out to be a little too aggressive about silence detection.

1.11. Version 1.0.25 - 2022-11-30 - Sacha Chua

subed-move-subtitles and subed-scale-subtitles are now interactive commands. The documentation for subed-scale-subtitles now mentions subed-move-subtitles, and I've updated the README to mention them.

1.12. Version 1.0.24 - 2022-11-18 - Sacha Chua

subed should compile without checkdoc warnings or obsolete functions now.

1.13. Version 1.0.23 - 2022-11-18 - Sacha Chua

You can now use subed-copy-region-text to copy the text from subtitles in a region. Call it with a prefix argument (C-u M-x subed-copy-region-text) to include comments.

Calling C-u M-x subed-convert will retain comments in the TXT output.

1.14. Version 1.0.22 - 2022-11-17 - Sacha Chua

VTT comments are now parsed and returned as part of subed-subtitle and subed-subtitle-list. This makes it easier to build workflows that use the comment information, such as adding NOTE lines for chapters and then creating a new file based on those lines and the subtitles following them.

A new function subed-create-file helps create a file with a list of subtitles.

Sanitizing VTT files with subed-sanitize should retain comments now.

subed-convert should now create a buffer instead of a file if the … …

Last refreshed on 2023-Sep-11 21:06 GMT

Copyright 2016-2023 Free Software Foundation, Inc.

Design provided by Nicolas Petton

This website is licensed under the CC BY-SA 4.0 International License.

JavaScript Licenses