You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Automatic caption generation powered by OpenAI Whisper**
4
-
Easily transcribe and generate SRT captions from audio or video files β with a beautiful, modern interface.
4
+
Transcribe audio or video files and generate SRT captions with ease β all through a clean, modern interface.
5
5
6
6
> π‘ If you find this project helpful, please consider giving it a **βοΈ** β it really helps support continued development!
7
7
8
-
**Are you a Mac OS user? Please check [here](https://github.com/jay-bman725/AutoCaption/tree/main?tab=readme-ov-file#-macos-users--app-is-damaged-fix) to make the app run after copying to the Applications directory**
8
+
**π macOS Users:**
9
+
If you encounter an βapp is damagedβ error, [click here for a fix](https://github.com/jay-bman725/AutoCaption/tree/main?tab=readme-ov-file#-macos-users--app-is-damaged-fix).
9
10
10
11
---
11
12
12
13
## β¨ Features
13
14
14
-
- π **Plug & Play** β Just enter your OpenAI API key and you're ready to go
15
-
- π **Wide Format Support** β MP3, WAV, MP4, AVI, MOV, MKV, and more
16
-
- ποΈ **Smart Processing** β Converts videos to MP3, compresses large audio files only when needed
- π§ **Powered by Whisper** β Uses OpenAI Whisper for accurate, high-quality captions
20
+
- π **Preview & Edit** β View and edit captions before exporting (text only)
21
+
- π **Drag & Drop** β Drop in your files or use the file picker
22
+
- π₯ **Cross-platform** β Compatible with Windows, macOS (Intel + Apple Silicon), and Linux
23
+
- π¨ **Modern UI** β Sleek, responsive interface built with Electron
24
+
- π **Customizable Theme** β Choose Light, Dark, or follow your system setting
23
25
24
26
---
25
27
@@ -49,36 +51,36 @@ Easily transcribe and generate SRT captions from audio or video files β with a
49
51
50
52
---
51
53
52
-
### π¦ From GitHub Releases
54
+
### π¦ Prebuilt Installers
53
55
54
-
Prebuilt installers for **Windows, macOS (arm64 + x64), and Linux** are available under the [Releases tab](https://github.com/jay-bman725/AutoCaption/releases/).
55
-
Just download, install, and go.
56
+
Installers for **Windows, macOS, and Linux** are available under the [Releases tab](https://github.com/jay-bman725/AutoCaption/releases).
57
+
Just download, install, and you're good to go.
56
58
57
59
---
58
60
59
61
## π§ͺ Usage
60
62
61
-
1. Launch the app (or run it with `npm start`).
62
-
2. Enter your OpenAI API key when prompted.
63
-
3. Upload an audio or video file via drag-and-drop or file picker.
64
-
4. Click **βGenerate SRT Captions.β**
65
-
5. Preview and download your caption file.
63
+
1. Launch the app (or run with `npm start`)
64
+
2. Enter your OpenAI API key when prompted
65
+
3. Upload an audio or video file via drag-and-drop or the file picker
66
+
4. Click **βGenerate SRT Captionsβ**
67
+
5. Preview and export your SRT file
66
68
67
69
---
68
70
69
71
## π§° Development
70
72
71
-
Start in development mode with hot-reloading and DevTools:
73
+
Run in development mode with hot-reloading and DevTools:
72
74
73
75
```bash
74
76
npm run dev
75
77
```
76
78
77
79
---
78
80
79
-
## π Building
81
+
## π Build for Distribution
80
82
81
-
Create platform-specific builds for distribution:
83
+
Generate platform-specific builds:
82
84
83
85
```bash
84
86
npm run build
@@ -89,51 +91,98 @@ npm run build
89
91
## π Supported Formats
90
92
91
93
**Audio**: MP3, WAV, M4A, AAC, OGG, WMA
94
+
92
95
**Video**: MP4, AVI, MOV, MKV, FLV, WEBM
93
96
94
97
---
95
98
96
99
## π» Requirements
97
100
98
-
* Node.js 16+
99
-
* An OpenAI API key (with Whisper support)
100
-
* FFmpeg installed on your system (for video conversion)
101
-
* macOS, Windows, or Linux
101
+
***Node.js**: Version 16 or higher
102
+
***OpenAI API Key**: With Whisper access
103
+
***FFmpeg**: Installed and accessible in your system's PATH
104
+
***Operating System**:
105
+
106
+
***macOS**: Version 10.15 (Catalina) or later, supporting both Intel and Apple Silicon architectures
107
+
***Windows**: Windows 10 (Build 1809) or newer
108
+
***Linux**:
109
+
110
+
***AppImage Support**: Compatible with most 64-bit Linux distributions, including:
111
+
112
+
* Ubuntu 20.04 LTS or newer
113
+
* Fedora 33 or newer
114
+
* Debian 10 (Buster) or newer
115
+
* openSUSE Leap 15.2 or newer
116
+
***Note**: Ensure that your system has GTK 3 or higher installed, as Electron applications require it for proper functionality.
117
+
118
+
---
119
+
120
+
## π¦ Install FFmpeg
102
121
103
-
### Installing FFmpeg
122
+
**macOS (with Homebrew):**
104
123
105
-
**macOS** (with Homebrew):
106
124
```bash
107
125
brew install ffmpeg
108
126
```
109
127
110
-
**Windows**:
111
-
Download from [https://ffmpeg.org/download.html](https://ffmpeg.org/download.html) or use chocolatey:
128
+
**Windows (with Chocolatey):**
129
+
112
130
```bash
113
131
choco install ffmpeg
114
132
```
115
133
116
-
**Linux** (Ubuntu/Debian):
134
+
**Windows (Installer from FFmpeg)**
135
+
https://ffmpeg.org/download.html
136
+
137
+
**Linux (Debian/Ubuntu):**
138
+
117
139
```bash
118
140
sudo apt update && sudo apt install ffmpeg
119
141
```
120
142
143
+
**For a more in-depth guide, visit [here](https://www.hostinger.com/tutorials/how-to-install-ffmpeg)**
144
+
121
145
---
122
146
123
-
## π macOS Users β βApp is damagedβ Fix
147
+
## π macOS Users β βApp is Damagedβ Fix
124
148
125
-
If you see a message saying **"AutoCaption is damaged and canβt be opened"**, it's just macOS being overly strict with unsigned apps.
149
+
If you get the error:
150
+
**"AutoCaption is damaged and canβt be opened"** β donβt worry. This is due to macOS being strict about unsigned apps.
126
151
127
-
To fix it:
152
+
Fix it with:
128
153
129
154
```bash
130
155
xattr -cr /Applications/AutoCaption.app
131
156
```
132
157
133
-
That removes the quarantine flag. Then it should open just fine.
158
+
That clears the quarantine flag. The app should open normally afterward.
0 commit comments