summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2025-11-04 14:35:50 -0600
committerCraig Jennings <c@cjennings.net>2025-11-04 14:35:50 -0600
commit45cab5c38dc089935416a89d36b461d9127094ac (patch)
treeccfb33579de009c8c8694f2a79d10e487d74de8f /modules
parentefbcd0b7de7993b9fde29297daad1154711a3e81 (diff)
feat: Add complete async audio transcription workflow
Implemented full transcription system with local Whisper and OpenAI API support. Includes comprehensive test suite (60 tests) and reorganized keybindings for better discoverability. Features: - Async transcription (non-blocking workflow) - Desktop notifications (started/complete/error) - Output: audio.txt (transcript) + audio.log (process logs) - Modeline integration showing active transcription count - Dired integration (press T on audio files) - Process management and tracking Scripts: - install-whisper.sh: Install Whisper via AUR or pip - uninstall-whisper.sh: Clean removal with cache cleanup - local-whisper: Offline transcription using installed Whisper - oai-transcribe: Cloud transcription via OpenAI API Tests (60 passing): - Audio file detection (16 tests) - Path generation logic (11 tests) - Log cleanup behavior (5 tests) - Duration formatting (9 tests) - Active counter & modeline (11 tests) - Integration workflows (8 tests) Keybindings: - Reorganized gcal to C-; g submenu (s/t/r/c) - Added C-; t transcription submenu (t/b/k) - Dired: T to transcribe file at point 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Diffstat (limited to 'modules')
-rw-r--r--modules/org-gcal-config.el95
-rw-r--r--modules/transcription-config.el326
-rw-r--r--modules/user-constants.el8
3 files changed, 413 insertions, 16 deletions
diff --git a/modules/org-gcal-config.el b/modules/org-gcal-config.el
index dc083efe..28cc1933 100644
--- a/modules/org-gcal-config.el
+++ b/modules/org-gcal-config.el
@@ -13,9 +13,9 @@
;; - Events are managed by Org (changes in org file push back to Google Calendar)
;; This is controlled by org-gcal-managed-newly-fetched-mode and
;; org-gcal-managed-update-existing-mode set to "org"
-;; - Initial automatic sync post Emacs startup. No auto resync'ing.
-;; (my calendar doesn't change hourly and I want fewer distractions and slowdowns).
-;; if you need it: https://github.com/kidd/org-gcal.el?tab=readme-ov-file#sync-automatically-at-regular-times
+;; - Automatic sync timer (configurable via cj/org-gcal-sync-interval-minutes)
+;; Default: 30 minutes, set to nil to disable
+;; See: https://github.com/kidd/org-gcal.el?tab=readme-ov-file#sync-automatically-at-regular-times
;; - Validates existing oath2-auto.plist file or creates it to avoid the issue mentioned here:
;; https://github.com/kidd/org-gcal.el?tab=readme-ov-file#note
;;
@@ -27,7 +27,10 @@
;; 3. Define `gcal-file' in user-constants (location of org file to hold sync'd events).
;;
;; Usage:
-;; - Manual sync: C-; g (or M-x org-gcal-sync)
+;; - Manual sync: C-; g s (or M-x org-gcal-sync)
+;; - Toggle auto-sync on/off: C-; g t
+;; - Restart auto-sync (e.g., after changing interval): C-; g r
+;; - Clear sync lock (if sync gets stuck): C-; g c
;;
;; Note:
;; This configuration creates oauth2-auto.plist on first run to prevent sync errors.
@@ -43,6 +46,17 @@
(defvar org-gcal--sync-lock))
(declare-function org-gcal-reload-client-id-secret "org-gcal")
+;; User configurable sync interval
+(defvar cj/org-gcal-sync-interval-minutes 30
+ "Interval in minutes for automatic Google Calendar sync.
+Set to nil to disable automatic syncing.
+Changes take effect after calling `cj/org-gcal-restart-auto-sync'.")
+
+;; Internal timer object
+(defvar cj/org-gcal-sync-timer nil
+ "Timer object for automatic org-gcal sync.
+Use `cj/org-gcal-start-auto-sync' and `cj/org-gcal-stop-auto-sync' to control.")
+
(defun cj/org-gcal-clear-sync-lock ()
"Clear the org-gcal sync lock.
Useful when a sync fails and leaves the lock in place, preventing future syncs."
@@ -66,6 +80,50 @@ enabling bidirectional sync so changes push back to Google Calendar."
(save-buffer))
(message "Converted %d event(s) to Org-managed" count)))
+(defun cj/org-gcal-start-auto-sync ()
+ "Start automatic Google Calendar sync timer.
+Uses the interval specified in `cj/org-gcal-sync-interval-minutes'.
+Does nothing if interval is nil or timer is already running."
+ (interactive)
+ (when (and cj/org-gcal-sync-interval-minutes
+ (not (and cj/org-gcal-sync-timer
+ (memq cj/org-gcal-sync-timer timer-list))))
+ (let ((interval-seconds (* cj/org-gcal-sync-interval-minutes 60)))
+ (setq cj/org-gcal-sync-timer
+ (run-with-timer
+ 120 ;; Initial delay: 2 minutes after startup
+ interval-seconds
+ (lambda ()
+ (condition-case err
+ (org-gcal-sync)
+ (error (message "org-gcal: Auto-sync failed: %s" err))))))
+ (message "org-gcal: Auto-sync started (every %d minutes)"
+ cj/org-gcal-sync-interval-minutes))))
+
+(defun cj/org-gcal-stop-auto-sync ()
+ "Stop automatic Google Calendar sync timer."
+ (interactive)
+ (when (and cj/org-gcal-sync-timer
+ (memq cj/org-gcal-sync-timer timer-list))
+ (cancel-timer cj/org-gcal-sync-timer)
+ (setq cj/org-gcal-sync-timer nil)
+ (message "org-gcal: Auto-sync stopped")))
+
+(defun cj/org-gcal-toggle-auto-sync ()
+ "Toggle automatic Google Calendar sync timer on/off."
+ (interactive)
+ (if (and cj/org-gcal-sync-timer
+ (memq cj/org-gcal-sync-timer timer-list))
+ (cj/org-gcal-stop-auto-sync)
+ (cj/org-gcal-start-auto-sync)))
+
+(defun cj/org-gcal-restart-auto-sync ()
+ "Restart automatic Google Calendar sync timer.
+Useful after changing `cj/org-gcal-sync-interval-minutes'."
+ (interactive)
+ (cj/org-gcal-stop-auto-sync)
+ (cj/org-gcal-start-auto-sync))
+
;; Deferred library required by org-gcal
(use-package deferred
:ensure t)
@@ -77,8 +135,6 @@ enabling bidirectional sync so changes push back to Google Calendar."
(use-package org-gcal
:vc (:url "https://github.com/cjennings/org-gcal" :rev :newest)
:defer t ;; unless idle timer is set below
- :bind (("C-; g" . org-gcal-sync)
- ("C-; G" . cj/org-gcal-clear-sync-lock))
:init
;; Retrieve credentials from authinfo.gpg BEFORE package loads
@@ -133,19 +189,26 @@ enabling bidirectional sync so changes push back to Google Calendar."
;; Advise org-gcal--sync-unlock which is called when sync completes
(advice-add 'org-gcal--sync-unlock :after #'cj/org-gcal-save-files-after-sync))
-;; Set up automatic initial sync on boot with error handling
-;;(run-with-idle-timer
-;; 2 nil
-;; (lambda ()
-;; (condition-case err
-;; (org-gcal-sync)
-;; (error (message "org-gcal: Initial sync failed: %s" err)))))
+;; Start automatic sync timer based on user configuration
+;; Set cj/org-gcal-sync-interval-minutes to nil to disable
+(cj/org-gcal-start-auto-sync)
+
+;; Google Calendar keymap and keybindings
+(defvar-keymap cj/gcal-map
+ :doc "Keymap for Google Calendar operations"
+ "s" #'org-gcal-sync
+ "t" #'cj/org-gcal-toggle-auto-sync
+ "r" #'cj/org-gcal-restart-auto-sync
+ "c" #'cj/org-gcal-clear-sync-lock)
+(keymap-set cj/custom-keymap "g" cj/gcal-map)
-;; which-key labels
(with-eval-after-load 'which-key
(which-key-add-key-based-replacements
- "C-; g" "gcal sync"
- "C-; G" "clear sync lock"))
+ "C-; g" "gcal menu"
+ "C-; g s" "sync"
+ "C-; g t" "toggle auto-sync"
+ "C-; g r" "restart auto-sync"
+ "C-; g c" "clear sync lock"))
(provide 'org-gcal-config)
;;; org-gcal-config.el ends here
diff --git a/modules/transcription-config.el b/modules/transcription-config.el
new file mode 100644
index 00000000..4c7d4943
--- /dev/null
+++ b/modules/transcription-config.el
@@ -0,0 +1,326 @@
+;;; transcription-config.el --- Audio transcription workflow -*- lexical-binding: t; -*-
+
+;; Author: Craig Jennings <c@cjennings.net>
+;; Created: 2025-11-04
+
+;;; Commentary:
+;;
+;; Audio transcription workflow using OpenAI Whisper (API or local).
+;;
+;; USAGE:
+;; In dired: Press `T` on an audio file to transcribe
+;; Anywhere: M-x cj/transcribe-audio
+;; View active: M-x cj/transcriptions-buffer
+;;
+;; OUTPUT FILES:
+;; audio.m4a → audio.txt (transcript)
+;; → audio.log (process logs, conditionally kept)
+;;
+;; BACKENDS:
+;; - 'openai-api: Fast cloud transcription (requires OPENAI_API_KEY)
+;; - 'local-whisper: Local transcription (requires whisper installed)
+;;
+;; NOTIFICATIONS:
+;; - "Transcription started on <file>"
+;; - "Transcription complete. Transcript in <file.txt>"
+;; - "Transcription errored. Logs in <file.log>"
+;;
+;; MODELINE:
+;; Shows active transcription count: ⏺2
+;; Click to view *Transcriptions* buffer
+;;
+;;; Code:
+
+(require 'dired)
+(require 'notifications)
+
+;; ----------------------------- Configuration ---------------------------------
+
+(defvar cj/transcribe-backend 'local-whisper
+ "Transcription backend to use.
+- `openai-api': Fast cloud transcription via OpenAI API
+- `local-whisper': Local transcription using installed Whisper")
+
+(defvar cj/transcription-keep-log-when-done nil
+ "Whether to keep log files after successful transcription.
+If nil, log files are deleted after successful completion.
+If t, log files are always kept.
+Log files are always kept on error regardless of this setting.")
+
+(defvar cj/transcriptions-list '()
+ "List of active transcriptions.
+Each entry: (process audio-file start-time status)
+Status: running, complete, error")
+
+;; ----------------------------- Pure Functions --------------------------------
+
+(defun cj/--audio-file-p (file)
+ "Return non-nil if FILE is an audio file based on extension."
+ (when (and file (stringp file))
+ (when-let ((ext (file-name-extension file)))
+ (member (downcase ext) cj/audio-file-extensions))))
+
+(defun cj/--transcription-output-files (audio-file)
+ "Return cons cell of (TXT-FILE . LOG-FILE) for AUDIO-FILE."
+ (let ((base (file-name-sans-extension audio-file)))
+ (cons (concat base ".txt")
+ (concat base ".log"))))
+
+(defun cj/--transcription-duration (start-time)
+ "Return duration string (MM:SS) since START-TIME."
+ (let* ((elapsed (float-time (time-subtract (current-time) start-time)))
+ (minutes (floor (/ elapsed 60)))
+ (seconds (floor (mod elapsed 60))))
+ (format "%02d:%02d" minutes seconds)))
+
+(defun cj/--should-keep-log (success-p)
+ "Return non-nil if log file should be kept.
+SUCCESS-P indicates whether transcription succeeded."
+ (or (not success-p) ; Always keep on error
+ cj/transcription-keep-log-when-done))
+
+(defun cj/--transcription-script-path ()
+ "Return absolute path to transcription script based on backend."
+ (let ((script-name (pcase cj/transcribe-backend
+ ('openai-api "oai-transcribe")
+ ('local-whisper "local-whisper"))))
+ (expand-file-name (concat "scripts/" script-name) user-emacs-directory)))
+
+;; ---------------------------- Process Management -----------------------------
+
+(defun cj/--notify (title message &optional urgency)
+ "Send desktop notification and echo area message.
+TITLE and MESSAGE are strings. URGENCY is normal or critical."
+ (message "%s: %s" title message)
+ (when (and (fboundp 'notifications-notify)
+ (getenv "DISPLAY"))
+ (notifications-notify
+ :title title
+ :body message
+ :urgency (or urgency 'normal))))
+
+(defun cj/--start-transcription-process (audio-file)
+ "Start async transcription process for AUDIO-FILE.
+Returns the process object."
+ (unless (file-exists-p audio-file)
+ (user-error "Audio file does not exist: %s" audio-file))
+
+ (unless (cj/--audio-file-p audio-file)
+ (user-error "Not an audio file: %s" audio-file))
+
+ (let* ((script (cj/--transcription-script-path))
+ (outputs (cj/--transcription-output-files audio-file))
+ (txt-file (car outputs))
+ (log-file (cdr outputs))
+ (buffer-name (format " *transcribe-%s*" (file-name-nondirectory audio-file)))
+ (process-name (format "transcribe-%s" (file-name-nondirectory audio-file))))
+
+ (unless (file-executable-p script)
+ (user-error "Transcription script not found or not executable: %s" script))
+
+ ;; Create log file
+ (with-temp-file log-file
+ (insert (format "Transcription started: %s\n" (current-time-string))
+ (format "Backend: %s\n" cj/transcribe-backend)
+ (format "Audio file: %s\n" audio-file)
+ (format "Script: %s\n\n" script)))
+
+ ;; Start process
+ (let ((process (make-process
+ :name process-name
+ :buffer (get-buffer-create buffer-name)
+ :command (list script audio-file)
+ :sentinel (lambda (proc event)
+ (cj/--transcription-sentinel proc event audio-file txt-file log-file))
+ :stderr log-file)))
+
+ ;; Track transcription
+ (push (list process audio-file (current-time) 'running) cj/transcriptions-list)
+ (force-mode-line-update t)
+
+ ;; Notify user
+ (cj/--notify "Transcription"
+ (format "Started on %s" (file-name-nondirectory audio-file)))
+
+ process)))
+
+(defun cj/--transcription-sentinel (process event audio-file txt-file log-file)
+ "Sentinel for transcription PROCESS.
+EVENT is the process event string.
+AUDIO-FILE, TXT-FILE, and LOG-FILE are the associated files."
+ (let* ((success-p (and (string-match-p "finished" event)
+ (= 0 (process-exit-status process))))
+ (process-buffer (process-buffer process))
+ (entry (assq process cj/transcriptions-list)))
+
+ ;; Write process output to txt file
+ (when (and success-p (buffer-live-p process-buffer))
+ (with-current-buffer process-buffer
+ (write-region (point-min) (point-max) txt-file nil 'silent)))
+
+ ;; Append process output to log file
+ (when (buffer-live-p process-buffer)
+ (with-temp-buffer
+ (insert-file-contents log-file)
+ (goto-char (point-max))
+ (insert "\n" (format-time-string "[%Y-%m-%d %H:%M:%S] ") event "\n")
+ (insert-buffer-substring process-buffer)
+ (write-region (point-min) (point-max) log-file nil 'silent)))
+
+ ;; Update transcription status
+ (when entry
+ (setf (nth 3 entry) (if success-p 'complete 'error)))
+
+ ;; Cleanup log file if successful and configured to do so
+ (when (and success-p (not (cj/--should-keep-log t)))
+ (delete-file log-file))
+
+ ;; Kill process buffer
+ (when (buffer-live-p process-buffer)
+ (kill-buffer process-buffer))
+
+ ;; Notify user
+ (if success-p
+ (cj/--notify "Transcription"
+ (format "Complete. Transcript in %s" (file-name-nondirectory txt-file)))
+ (cj/--notify "Transcription"
+ (format "Errored. Logs in %s" (file-name-nondirectory log-file))
+ 'critical))
+
+ ;; Clean up completed transcriptions after 10 minutes
+ (run-at-time 600 nil #'cj/--cleanup-completed-transcriptions)
+
+ ;; Update modeline
+ (force-mode-line-update t)))
+
+(defun cj/--cleanup-completed-transcriptions ()
+ "Remove completed/errored transcriptions from tracking list."
+ (setq cj/transcriptions-list
+ (seq-filter (lambda (entry)
+ (eq (nth 3 entry) 'running))
+ cj/transcriptions-list))
+ (force-mode-line-update t))
+
+(defun cj/--count-active-transcriptions ()
+ "Return count of running transcriptions."
+ (length (seq-filter (lambda (entry)
+ (eq (nth 3 entry) 'running))
+ cj/transcriptions-list)))
+
+;; ----------------------------- Modeline Integration --------------------------
+
+(defun cj/--transcription-modeline-string ()
+ "Return modeline string for active transcriptions."
+ (let ((count (cj/--count-active-transcriptions)))
+ (when (> count 0)
+ (propertize (format " ⏺%d " count)
+ 'face 'warning
+ 'help-echo (format "%d active transcription%s (click to view)"
+ count (if (= count 1) "" "s"))
+ 'mouse-face 'mode-line-highlight
+ 'local-map (let ((map (make-sparse-keymap)))
+ (define-key map [mode-line mouse-1]
+ #'cj/transcriptions-buffer)
+ map)))))
+
+;; Add to mode-line-format (will be activated when module loads)
+(add-to-list 'mode-line-misc-info
+ '(:eval (cj/--transcription-modeline-string))
+ t)
+
+;; --------------------------- Interactive Commands ----------------------------
+
+;;;###autoload
+(defun cj/transcribe-audio (audio-file)
+ "Transcribe AUDIO-FILE asynchronously.
+Creates AUDIO.txt with transcript and AUDIO.log with process logs.
+Uses backend specified by `cj/transcribe-backend'."
+ (interactive (list (read-file-name "Audio file to transcribe: "
+ nil nil t nil
+ #'cj/--audio-file-p)))
+ (cj/--start-transcription-process (expand-file-name audio-file)))
+
+;;;###autoload
+(defun cj/transcribe-audio-at-point ()
+ "Transcribe audio file at point in dired."
+ (interactive)
+ (unless (derived-mode-p 'dired-mode)
+ (user-error "Not in dired-mode"))
+ (let ((file (dired-get-filename nil t)))
+ (unless file
+ (user-error "No file at point"))
+ (cj/transcribe-audio file)))
+
+;;;###autoload
+(defun cj/transcriptions-buffer ()
+ "Show buffer with active transcriptions."
+ (interactive)
+ (let ((buffer (get-buffer-create "*Transcriptions*")))
+ (with-current-buffer buffer
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (insert (propertize "Active Transcriptions\n" 'face 'bold)
+ (propertize (make-string 50 ?─) 'face 'shadow)
+ "\n\n")
+ (if (null cj/transcriptions-list)
+ (insert "No active transcriptions.\n")
+ (dolist (entry cj/transcriptions-list)
+ (let* ((process (nth 0 entry))
+ (audio-file (nth 1 entry))
+ (start-time (nth 2 entry))
+ (status (nth 3 entry))
+ (duration (cj/--transcription-duration start-time))
+ (status-face (pcase status
+ ('running 'warning)
+ ('complete 'success)
+ ('error 'error))))
+ (insert (propertize (format "%-10s" status) 'face status-face)
+ " "
+ (file-name-nondirectory audio-file)
+ (format " (%s)\n" duration))))))
+ (goto-char (point-min))
+ (special-mode))
+ (display-buffer buffer)))
+
+;;;###autoload
+(defun cj/transcription-kill (process)
+ "Kill transcription PROCESS."
+ (interactive
+ (list (let ((choices (mapcar (lambda (entry)
+ (cons (file-name-nondirectory (nth 1 entry))
+ (nth 0 entry)))
+ cj/transcriptions-list)))
+ (unless choices
+ (user-error "No active transcriptions"))
+ (cdr (assoc (completing-read "Kill transcription: " choices nil t)
+ choices)))))
+ (when (process-live-p process)
+ (kill-process process)
+ (message "Killed transcription process")))
+
+;; ------------------------------- Dired Integration ---------------------------
+
+(with-eval-after-load 'dired
+ (define-key dired-mode-map (kbd "T") #'cj/transcribe-audio-at-point))
+
+;; Dirvish inherits dired-mode-map, so T works automatically
+
+;; ------------------------------- Global Keybindings --------------------------
+
+;; Transcription keymap
+(defvar-keymap cj/transcribe-map
+ :doc "Keymap for transcription operations"
+ "t" #'cj/transcribe-audio
+ "b" #'cj/transcriptions-buffer
+ "k" #'cj/transcription-kill)
+(keymap-set cj/custom-keymap "t" cj/transcribe-map)
+
+(with-eval-after-load 'which-key
+ (which-key-add-key-based-replacements
+ "C-; t" "transcription menu"
+ "C-; t t" "transcribe audio"
+ "C-; t b" "show transcriptions buffer"
+ "C-; t k" "kill transcription"))
+
+(provide 'transcription-config)
+;;; transcription-config.el ends here
diff --git a/modules/user-constants.el b/modules/user-constants.el
index ba52cec2..2a6d0ca2 100644
--- a/modules/user-constants.el
+++ b/modules/user-constants.el
@@ -47,6 +47,14 @@ Example: (setq cj/debug-modules '(org-agenda mail))
"Alist mapping buffer states to their colors.
Used by cursor color, modeline, and other UI elements.")
+;; --------------------------- Media File Extensions ---------------------------
+
+(defvar cj/audio-file-extensions
+ '("m4a" "mp3" "wav" "flac" "ogg" "opus" "aac"
+ "aiff" "aif" "wma" "ape" "alac" "weba")
+ "File extensions recognized as audio files.
+Used by transcription module and other audio-related functionality.")
+
;; ------------------------ Directory And File Constants -----------------------
;; DIRECTORIES