feat: enhance setup process for Python runtime and FFmpeg across platforms; update extraction utility to use bundled binaries

Author: LinuxDevil

.github/workflows/build-artifacts.yml

@@ -20,21 +20,23 @@ jobs:
           node-version: '18'
           cache: 'npm'
 
-      - name: Setup Python
+      - name: Setup Python (for setup script)
         uses: actions/setup-python@v4
         with:
-          python-version: '3.9'
+          python-version: '3.11'
 
       - name: Install dependencies
         run: npm ci
 
-      - name: Install Python dependencies
-        run: pip install -r requirements.txt
-
-      - name: Install FFmpeg
+      - name: Setup binary dependencies
+        shell: bash
         run: |
-          choco install ffmpeg -y
-          echo "FFmpeg installed successfully"
+          chmod +x setup-binaries.sh
+          ./setup-binaries.sh windows
+          # Install Python dependencies for Windows
+          cd python-runtime-windows
+          ./python.exe get-pip.py
+          ./Scripts/pip.exe install -r ../requirements.txt
 
       - name: Build Windows application
         run: npm run build:win
@@ -61,21 +63,19 @@ jobs:
           node-version: '18'
           cache: 'npm'
 
-      - name: Setup Python
+      - name: Setup Python (for setup script)
         uses: actions/setup-python@v4
         with:
-          python-version: '3.9'
+          python-version: '3.11'
 
       - name: Install dependencies
         run: npm ci
 
-      - name: Install Python dependencies
-        run: pip install -r requirements.txt
-
-      - name: Install FFmpeg
+      - name: Setup binary dependencies
+        shell: bash
         run: |
-          brew install ffmpeg
-          echo "FFmpeg installed successfully"
+          chmod +x setup-binaries.sh
+          ./setup-binaries.sh macos
 
       - name: Build macOS application
         run: npm run build:mac

.github/workflows/build.yml

@@ -23,28 +23,26 @@ jobs:
           node-version: '18'
           cache: 'npm'
 
-      - name: Setup Python
+      - name: Setup Python (for setup script)
         uses: actions/setup-python@v4
         with:
-          python-version: '3.9'
+          python-version: '3.11'
 
       - name: Install dependencies
         run: npm ci
 
-      - name: Install Python dependencies
-        run: pip install -r requirements.txt
-
-      - name: Install FFmpeg (Windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          choco install ffmpeg -y
-          echo "FFmpeg installed successfully"
-
-      - name: Install FFmpeg (macOS)
-        if: matrix.os == 'macos-latest'
+      - name: Setup binary dependencies
+        shell: bash
         run: |
-          brew install ffmpeg
-          echo "FFmpeg installed successfully"
+          chmod +x setup-binaries.sh
+          if [ "${{ matrix.os }}" = "windows-latest" ]; then
+            ./setup-binaries.sh windows
+            cd python-runtime-windows
+            ./python.exe get-pip.py
+            ./Scripts/pip.exe install -r ../requirements.txt
+          else
+            ./setup-binaries.sh macos
+          fi
 
       - name: Build Windows application
         if: matrix.os == 'windows-latest'

.gitignore

@@ -11,4 +11,10 @@ build
 .env.local
 .env.development.local
 .env.test.local
-.env.production.local
+.env.production.local
+
+# Binary dependencies (downloaded by setup script)
+python-runtime/
+python-runtime-windows/
+ffmpeg-bin/
+ffmpeg-bin-windows/

README.md

@@ -15,6 +15,7 @@ A powerful desktop application for recording meetings, lectures, and presentatio
 - **👀 Live Preview** - See what you're recording in real-time
 - **🔄 Cross-Platform** - Works seamlessly on Windows, macOS, and Linux
 - **🔒 Privacy-First** - All processing happens locally, no data sent to external servers
+- **⚡ Automated Setup** - One-command setup for all binary dependencies
 
 ## 📸 Screenshots
 
@@ -72,7 +73,77 @@ npm run dev
 | **Ollama**          | Local AI model for summarization |
 | **Python packages** | Speech-to-text processing        |
 
-## 🛠️ Installation Guide
+## 🛠️ Setup Guide
+
+### Automated Setup (Recommended)
+
+The easiest way to set up all binary dependencies:
+
+```bash
+# Setup for current platform (recommended)
+./setup-binaries.sh
+
+# Or setup for all platforms
+./setup-binaries.sh all
+
+# Or setup for specific platform
+./setup-binaries.sh macos 
+./setup-binaries.sh windows
+./setup-binaries.sh linux
+```
+
+### What the Setup Script Does
+
+#### macOS Setup
+- Creates a Python virtual environment in `python-runtime/`
+- Installs all dependencies from `requirements.txt`
+- Downloads FFmpeg binary to `ffmpeg-bin/`
+
+#### Windows Setup
+- Downloads Python embeddable package to `python-runtime-windows/`
+- Sets up pip and prepares for dependency installation
+- Downloads FFmpeg binary to `ffmpeg-bin-windows/`
+
+#### Linux Setup
+- Creates a Python virtual environment in `python-runtime/`
+- Installs all dependencies from `requirements.txt`
+- Downloads static FFmpeg binary to `ffmpeg-bin/`
+
+### Directory Structure After Setup
+
+After running the setup script, you'll have:
+
+```
+├── python-runtime/          # macOS/Linux Python environment
+├── python-runtime-windows/  # Windows Python environment
+├── ffmpeg-bin/             # macOS/Linux FFmpeg binary
+├── ffmpeg-bin-windows/     # Windows FFmpeg binary
+├── audio_extractor.py      # Python script for audio processing
+├── requirements.txt        # Python dependencies
+└── setup-binaries.sh       # Setup script
+```
+
+### Windows Post-Setup
+
+After running the Windows setup, manually install Python dependencies:
+
+```bash
+cd python-runtime-windows
+python get-pip.py
+Scripts/pip install -r ../requirements.txt
+```
+
+### Cross-Platform Builds
+
+- Run `./setup-binaries.sh all` to set up binaries for all platforms
+- Use the appropriate npm script for your target platform:
+  ```bash
+  npm run build:mac 
+  npm run build:win 
+  npm run build:linux
+  ```
+
+## 🛠️ Manual Installation Guide
 
 ### FFmpeg Setup
 
@@ -144,6 +215,59 @@ ffmpeg -version
 ollama list  # if installed
 ```
 
+### Setup Troubleshooting
+
+#### "Python not found" error
+- Make sure you've run `./setup-binaries.sh` first
+- Check that the Python runtime was created successfully
+- Verify the paths in `transcript.utils.ts` match your setup
+
+#### "FFmpeg not found" error
+- Ensure FFmpeg was downloaded by the setup script
+- Check that the FFmpeg binary has execute permissions
+- Verify the FFmpeg path is correct for your platform
+
+### Manual Binary Setup (Alternative)
+
+If the automated setup doesn't work, you can manually set up the binaries:
+
+#### Python Runtime
+1. Create a virtual environment: `python3 -m venv python-runtime`
+2. Activate it: `source python-runtime/bin/activate` (macOS/Linux)
+3. Install dependencies: `pip install -r requirements.txt`
+4. Deactivate: `deactivate`
+
+#### FFmpeg
+1. Download from [FFmpeg website](https://ffmpeg.org/download.html)
+2. Extract to `ffmpeg-bin/` directory
+3. Ensure the binary is executable: `chmod +x ffmpeg-bin/ffmpeg`
+
+### Python Dependencies
+
+The app requires these Python packages (from `requirements.txt`):
+- `openai-whisper>=20231117` - For speech-to-text conversion
+- `SpeechRecognition>=3.10.0` - Alternative speech recognition
+- `pydub>=0.25.1` - Audio processing
+- `torch>=2.0.0` - Machine learning backend
+- `numpy>=1.24.0` - Numerical computations
+
+### Important Notes
+
+#### Development vs Production
+
+- **Development mode**: Uses system Python and FFmpeg
+- **Packaged app**: Uses bundled Python runtime and FFmpeg
+
+#### Gitignore
+
+The binary directories are automatically ignored by git:
+- `python-runtime/`
+- `python-runtime-windows/`
+- `ffmpeg-bin/`
+- `ffmpeg-bin-windows/`
+
+This keeps the repository clean while allowing developers to set up their own binaries.
+
 ## 🎯 Usage
 
 ### Basic Recording Workflow

audio_extractor.py

@@ -14,7 +14,7 @@
 from pydub import AudioSegment
 import whisper
 
-def extract_audio_from_video(video_path, output_audio_path=None):
+def extract_audio_from_video(video_path, ffmpeg_path, output_audio_path=None):
     """
     Extract audio from video file using ffmpeg
     """
@@ -24,7 +24,7 @@ def extract_audio_from_video(video_path, output_audio_path=None):
             output_audio_path = os.path.join(temp_dir, f"extracted_audio_{os.path.basename(video_path)}.wav")
 
         cmd = [
-            'ffmpeg', '-i', video_path,
+            ffmpeg_path, '-i', video_path,
             '-vn',
             '-acodec', 'pcm_s16le',
             '-ar', '16000',
@@ -91,14 +91,15 @@ def main():
         sys.exit(1)
 
     video_path = sys.argv[1]
-    output_audio_path = sys.argv[2] if len(sys.argv) > 2 else None
+    ffmpeg_path = sys.argv[2]
+    output_audio_path = sys.argv[3] if len(sys.argv) > 3 else None
 
     if not os.path.exists(video_path):
         print(f"Error: Video file '{video_path}' not found", file=sys.stderr)
         sys.exit(1)
 
     print(f"Extracting audio from: {video_path}", file=sys.stderr)
-    audio_path = extract_audio_from_video(video_path, output_audio_path)
+    audio_path = extract_audio_from_video(video_path, ffmpeg_path, output_audio_path)
 
     if audio_path is None:
         print("Failed to extract audio", file=sys.stderr)

electron-builder.yml

@@ -17,10 +17,25 @@ extraResources:
     to: 'requirements.txt'
   - from: 'setup.py'
     to: 'setup.py'
+  # For macOS (current setup)
+  - from: 'python-runtime'
+    to: 'python-runtime'
+    filter: '**/*'
+  - from: 'ffmpeg-bin'
+    to: 'ffmpeg-bin'
+    filter: '**/*'
 asarUnpack:
   - resources/**
 win:
   executableName: meetingvideo-transrecorder
+  extraResources:
+    # Windows-specific binaries (if available)
+    - from: 'python-runtime-windows'
+      to: 'python-runtime'
+      filter: '**/*'
+    - from: 'ffmpeg-bin-windows'
+      to: 'ffmpeg-bin'
+      filter: '**/*'
 nsis:
   artifactName: ${name}-${version}-setup.${ext}
   shortcutName: ${productName}

package.json

@@ -11,6 +11,8 @@
     "typecheck:node": "tsc --noEmit -p tsconfig.node.json --composite false",
     "typecheck:web": "tsc --noEmit -p tsconfig.web.json --composite false",
     "typecheck": "npm run typecheck:node && npm run typecheck:web",
+    "setup": "./setup-binaries.sh",
+    "setup:all": "./setup-binaries.sh all",
     "start": "electron-vite preview",
     "dev": "electron-vite dev",
     "build": "npm run typecheck && electron-vite build",

scripts/release.sh

@@ -14,20 +14,17 @@ VERSION=$1
 
 echo "🚀 Creating release for version $VERSION"
 
-# Check if we're on main/master branch
 BRANCH=$(git branch --show-current)
 if [ "$BRANCH" != "main" ] && [ "$BRANCH" != "master" ]; then
     echo "❌ Error: You must be on main or master branch to create a release"
     exit 1
 fi
 
-# Check if working directory is clean
 if [ -n "$(git status --porcelain)" ]; then
     echo "❌ Error: Working directory is not clean. Please commit or stash changes."
     exit 1
 fi
 
-# Create and push tag
 echo "📝 Creating tag v$VERSION..."
 git tag "v$VERSION"
 git push origin "v$VERSION"