├── screenshot.png
├── gradle
    └── wrapper
    │   ├── gradle-wrapper.jar
    │   └── gradle-wrapper.properties
├── src
    └── main
    │   ├── resources
    │       ├── assets
    │       │   └── tray_icon.png
    │       └── logback.xml
    │   └── java
    │       └── net
    │           └── brlns
    │               └── livecaptions
    │                   ├── util
    │                       ├── Nullable.java
    │                       └── LoggerUtils.java
    │                   ├── Settings.java
    │                   ├── ScreenSnipper.java
    │                   └── LiveCaptionsLogger.java
├── gradle.properties
├── .gitignore
├── .github
    └── workflows
    │   └── build.yml
├── README.md
├── gradlew.bat
├── pom.xml
├── gradlew
└── LICENSE


/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hstr0100/LiveCaptionsLogger/HEAD/screenshot.png


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hstr0100/LiveCaptionsLogger/HEAD/gradle/wrapper/gradle-wrapper.jar


--------------------------------------------------------------------------------
/src/main/resources/assets/tray_icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/hstr0100/LiveCaptionsLogger/HEAD/src/main/resources/assets/tray_icon.png


--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
 1 | slf4jVersion=2.0.16
 2 | tess4jVersion=5.13.0
 3 | commonsTextVersion=1.12.0
 4 | lombokVersion=1.18.34
 5 | jacksonVersion=2.17.2
 6 | jupiterVersion=5.11.2
 7 | logbackVersion=1.5.11
 8 | 
 9 | shadowPluginVersion=8.3.5
10 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | dependency-reduced-pom.xml
 2 | nb-configuration.xml
 3 | nbactions.xml
 4 | config.json
 5 | *.log
 6 | hs_err_pid*
 7 | replay_pid*
 8 | 
 9 | /target/*
10 | 
11 | # Gradle
12 | .gradle
13 | **/build/
14 | !gradle-wrapper.jar
15 | !gradle-wrapper.properties
16 | 
17 | 


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
4 | networkTimeout=10000
5 | validateDistributionUrl=true
6 | zipStoreBase=GRADLE_USER_HOME
7 | zipStorePath=wrapper/dists
8 | 


--------------------------------------------------------------------------------
/src/main/resources/logback.xml:
--------------------------------------------------------------------------------
 1 | <configuration>
 2 |     <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 3 |         <encoder>
 4 |             <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
 5 |         </encoder>
 6 |     </appender>
 7 | 
 8 |     <root level="INFO">
 9 |         <appender-ref ref="STDOUT" />
10 |     </root>
11 | </configuration>


--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: Build and Package
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |   pull_request:
 8 |     branches:
 9 |       - main
10 | 
11 | jobs:
12 |   build:
13 |     runs-on: ubuntu-latest
14 | 
15 |     strategy:
16 |       matrix:
17 |         java-version: [11]
18 | 
19 |     steps:
20 |       - name: Checkout repository
21 |         uses: actions/checkout@v3
22 | 
23 |       - name: Set up JDK
24 |         uses: actions/setup-java@v3
25 |         with:
26 |           java-version: ${{ matrix.java-version }}
27 |           distribution: 'temurin'
28 | 
29 |       - name: Cache Gradle packages
30 |         uses: actions/cache@v3
31 |         with:
32 |           path: ~/.gradle/caches
33 |           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
34 |           restore-keys: ${{ runner.os }}-gradle
35 | 
36 |       - name: Make gradlew executable
37 |         run: chmod +x ./gradlew
38 | 
39 |       - name: Build with Gradle
40 |         run: ./gradlew clean build
41 | 
42 |       - name: Upload Zipped Shaded JAR
43 |         uses: actions/upload-artifact@v3
44 |         with:
45 |           name: LiveCaptionsLogger.zip
46 |           path: build/distributions/*shadow*.zip
47 | 


--------------------------------------------------------------------------------
/src/main/java/net/brlns/livecaptions/util/Nullable.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Copyright (C) 2024 hstr0100
 3 |  *
 4 |  * This program is free software: you can redistribute it and/or modify
 5 |  * it under the terms of the GNU General Public License as published by
 6 |  * the Free Software Foundation, either version 3 of the License, or
 7 |  * (at your option) any later version.
 8 |  *
 9 |  * This program is distributed in the hope that it will be useful,
10 |  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 |  * GNU General Public License for more details.
13 |  *
14 |  * You should have received a copy of the GNU General Public License
15 |  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 |  */
17 | package net.brlns.livecaptions.util;
18 | 
19 | import java.lang.annotation.ElementType;
20 | import java.lang.annotation.Retention;
21 | import java.lang.annotation.RetentionPolicy;
22 | import java.lang.annotation.Target;
23 | 
24 | /**
25 |  * @author Gabriel / hstr0100 / vertx010
26 |  */
27 | @Retention(RetentionPolicy.RUNTIME)
28 | @Target({
29 |     ElementType.FIELD,
30 |     ElementType.METHOD,
31 |     ElementType.PARAMETER,
32 |     ElementType.LOCAL_VARIABLE
33 | })
34 | public @interface Nullable {
35 | 
36 | }
37 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # LiveCaptionsLogger
 2 | 
 3 | This software was developed as a response to [this Microsoft Forums question](https://answers.microsoft.com/en-us/windows/forum/all/is-it-possible-to-save-a-transcript-of-live/3474cc04-1d34-4e51-bf99-aa7dc0e0fdd0)
 4 | 
 5 | Windows 11 offers a very good accessibility option called Live Captions, however, Microsoft does not offer a way for users to log a transcript of what the live captions are generating at any given moment,
 6 | these transcripts could be useful for users in a number of ways, but due to the closed source nature of Windows we would have to wait for Microsoft to come up with a solution for this, if ever.
 7 | 
 8 | Enter this attempt at providing rudimentary support for live caption transcriptions.
 9 | ![Screenshot](screenshot.png)
10 | 
11 | # How it Works
12 | 
13 | This small Java software relies on [Tesseract OCR](https://github.com/tesseract-ocr/tesseract) to perform an Optical Character Recognition (OCR) of the usual live captioning area each second.\
14 | We then apply some filtering to write down only the finalized line after Windows finishes generating it.\
15 | The lines are then written to the LiveCaptions folder inside your Documents library. Each time the captions window disappears, a new log file is generated.
16 | 
17 | # Installation
18 | 
19 | Follow these steps to install and run the program:
20 | 
21 | 1. Ensure you have Java 11 or a newer version installed. We recommend using the Eclipse Temurin OpenJDK implementation, which you can download from: 
22 | [Eclipse Temurin](https://adoptium.net/temurin/releases/)\
23 | For Windows 11, scroll down and select the x64 JRE .msi, then download and install it.
24 | 
25 | 2. If you are using Linux, ensure you have 'tesseract-ocr' installed.
26 | 
27 | 3. Download the latest version of this program from the [releases page](https://github.com/hstr0100/LiveCaptionsLogger/releases).
28 | 
29 | 4. Extract the contents to any directory where you would like the program to run from.
30 | 
31 | 5. We provide a pre-compiled JAR of the program. Navigate to the bin/ directory and run the LiveCaptionsLogger.bat script to start the program.
32 | 
33 | 6. Right-click the tray icon to set up auto-start, capture area, or toggle transcriptions on and off.
34 | 
35 | # Building
36 | 
37 | If you want to compile this program yourself:
38 | 
39 | 1. Ensure you have OpenJDK 11 or a newer version installed. Please note that this requirement differs from the one needed to run precompiled binaries, which only necessitate a JRE.
40 | 
41 | 2. Clone this repository:
42 |    ```bash
43 |    git clone https://github.com/hstr0100/LiveCaptionsLogger.git
44 |    ```
45 | 
46 | 3. Navigate to the project directory:
47 |    ```bash
48 |    cd LiveCaptionsLogger
49 |    ```
50 |    
51 | 4. Build the project using Gradle:
52 |    ```bash
53 |    ./gradlew clean build
54 |    ```
55 |    
56 | 


--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
 1 | @rem
 2 | @rem Copyright 2015 the original author or authors.
 3 | @rem
 4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
 5 | @rem you may not use this file except in compliance with the License.
 6 | @rem You may obtain a copy of the License at
 7 | @rem
 8 | @rem      https://www.apache.org/licenses/LICENSE-2.0
 9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | 
17 | @if "%DEBUG%"=="" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem  Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 | 
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 | 
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%"=="" set DIRNAME=.
29 | @rem This is normally unused
30 | set APP_BASE_NAME=%~n0
31 | set APP_HOME=%DIRNAME%
32 | 
33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
35 | 
36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
38 | 
39 | @rem Find java.exe
40 | if defined JAVA_HOME goto findJavaFromJavaHome
41 | 
42 | set JAVA_EXE=java.exe
43 | %JAVA_EXE% -version >NUL 2>&1
44 | if %ERRORLEVEL% equ 0 goto execute
45 | 
46 | echo. 1>&2
47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
48 | echo. 1>&2
49 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
50 | echo location of your Java installation. 1>&2
51 | 
52 | goto fail
53 | 
54 | :findJavaFromJavaHome
55 | set JAVA_HOME=%JAVA_HOME:"=%
56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
57 | 
58 | if exist "%JAVA_EXE%" goto execute
59 | 
60 | echo. 1>&2
61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
62 | echo. 1>&2
63 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
64 | echo location of your Java installation. 1>&2
65 | 
66 | goto fail
67 | 
68 | :execute
69 | @rem Setup the command line
70 | 
71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
72 | 
73 | 
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
76 | 
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if %ERRORLEVEL% equ 0 goto mainEnd
80 | 
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | set EXIT_CODE=%ERRORLEVEL%
85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
87 | exit /b %EXIT_CODE%
88 | 
89 | :mainEnd
90 | if "%OS%"=="Windows_NT" endlocal
91 | 
92 | :omega
93 | 


--------------------------------------------------------------------------------
/src/main/java/net/brlns/livecaptions/util/LoggerUtils.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Copyright (C) 2024 @hstr0100
 3 |  *
 4 |  * This program is free software: you can redistribute it and/or modify
 5 |  * it under the terms of the GNU General Public License as published by
 6 |  * the Free Software Foundation, either version 3 of the License, or
 7 |  * (at your option) any later version.
 8 |  *
 9 |  * This program is distributed in the hope that it will be useful,
10 |  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 |  * GNU General Public License for more details.
13 |  *
14 |  * You should have received a copy of the GNU General Public License
15 |  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 |  */
17 | package net.brlns.livecaptions.util;
18 | 
19 | import ch.qos.logback.classic.Level;
20 | import ch.qos.logback.classic.Logger;
21 | import ch.qos.logback.classic.LoggerContext;
22 | import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
23 | import ch.qos.logback.classic.spi.ILoggingEvent;
24 | import ch.qos.logback.core.FileAppender;
25 | import java.io.File;
26 | import lombok.extern.slf4j.Slf4j;
27 | import org.slf4j.LoggerFactory;
28 | 
29 | /**
30 |  * Utility class for configuring the application logger.
31 |  *
32 |  * @author Gabriel / hstr0100 / vertx010
33 |  */
34 | @Slf4j
35 | public class LoggerUtils {
36 | 
37 |     private static final String LOG_PATTERN = "%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n";
38 | 
39 |     private static final Level DEFAULT_LOG_LEVEL = Level.INFO;
40 | 
41 |     /**
42 |      * Sets the log file
43 |      *
44 |      * This method creates a new file appender with a specified log file
45 |      * location and attaches it to the root logger.
46 |      *
47 |      * @param logFile the file where logs will be written
48 |      */
49 |     public static void setLogFile(File logFile) {
50 |         LoggerContext loggerContext = (LoggerContext)LoggerFactory.getILoggerFactory();
51 |         Logger logger = loggerContext.getLogger("ROOT");
52 | 
53 |         FileAppender<ILoggingEvent> fileAppender = new FileAppender<>();
54 |         fileAppender.setContext(loggerContext);
55 |         fileAppender.setName("LOG_FILE");
56 |         fileAppender.setFile(logFile.getPath());
57 | 
58 |         PatternLayoutEncoder encoder = new PatternLayoutEncoder();
59 |         encoder.setContext(loggerContext);
60 |         encoder.setPattern(LOG_PATTERN);
61 |         encoder.start();
62 | 
63 |         fileAppender.setEncoder(encoder);
64 |         fileAppender.start();
65 | 
66 |         logger.addAppender(fileAppender);
67 |     }
68 | 
69 |     /**
70 |      * Sets the logging level
71 |      *
72 |      * @param debug if true, sets the log level to DEBUG;
73 |      * otherwise, sets it to INFO.
74 |      */
75 |     public static void setDebugLogLevel(boolean debug) {
76 |         LoggerContext loggerContext = (LoggerContext)LoggerFactory.getILoggerFactory();
77 |         Logger logger = loggerContext.getLogger("ROOT");
78 | 
79 |         if (debug && logger.getLevel() != Level.DEBUG) {
80 |             logger.setLevel(Level.DEBUG);
81 | 
82 |             log.info("Log level changed to: {}", logger.getLevel());
83 |         } else if (!debug && logger.getLevel() != DEFAULT_LOG_LEVEL) {
84 |             logger.setLevel(DEFAULT_LOG_LEVEL);
85 | 
86 |             log.info("Log level changed to: {}", logger.getLevel());
87 |         }
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 | 
  5 |     <!--
  6 |     Maven POM Configuration
  7 | 
  8 |     While we could have utilized a Maven wrapper for this project, we opted for Gradle due to its more convenient tools for packaging end-user releases.
  9 |     -->
 10 | 
 11 |     <groupId>net.brlns</groupId>
 12 |     <artifactId>LiveCaptionsLogger</artifactId>
 13 |     <version>1.1.1</version>
 14 |     <packaging>jar</packaging>
 15 | 
 16 |     <properties>
 17 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 18 |         <maven.compiler.source>11</maven.compiler.source>
 19 |         <maven.compiler.target>11</maven.compiler.target>
 20 |         <maven.compiler.release>11</maven.compiler.release>
 21 |     </properties>
 22 | 
 23 |     <dependencies>
 24 |         <dependency>
 25 |             <groupId>org.slf4j</groupId>
 26 |             <artifactId>slf4j-api</artifactId>
 27 |             <version>2.0.16</version>
 28 |             <scope>compile</scope>
 29 |         </dependency>
 30 |         <dependency>
 31 |             <groupId>ch.qos.logback</groupId>
 32 |             <artifactId>logback-classic</artifactId>
 33 |             <version>1.5.11</version>
 34 |             <scope>compile</scope>
 35 |         </dependency>
 36 |         <dependency>
 37 |             <groupId>net.sourceforge.tess4j</groupId>
 38 |             <artifactId>tess4j</artifactId>
 39 |             <version>5.13.0</version>
 40 |         </dependency>
 41 |         <dependency>
 42 |             <groupId>org.apache.commons</groupId>
 43 |             <artifactId>commons-text</artifactId>
 44 |             <version>1.12.0</version>
 45 |         </dependency>
 46 |         <dependency>
 47 |             <groupId>org.projectlombok</groupId>
 48 |             <artifactId>lombok</artifactId>
 49 |             <version>1.18.34</version>
 50 |             <scope>provided</scope>
 51 |         </dependency>
 52 |         <dependency>
 53 |             <groupId>com.fasterxml.jackson.core</groupId>
 54 |             <artifactId>jackson-databind</artifactId>
 55 |             <version>2.17.2</version>
 56 |         </dependency>
 57 |     </dependencies>
 58 | 
 59 |     <build>
 60 |         <finalName>${project.artifactId}</finalName>
 61 |         <plugins>
 62 |             <plugin>
 63 |                 <groupId>org.apache.maven.plugins</groupId>
 64 |                 <artifactId>maven-shade-plugin</artifactId>
 65 |                 <version>3.5.1</version>
 66 |                 <executions>
 67 |                     <execution>
 68 |                         <phase>package</phase>
 69 |                         <goals>
 70 |                             <goal>shade</goal>
 71 |                         </goals>
 72 |                     </execution>
 73 |                 </executions>
 74 |                 <configuration>
 75 |                     <transformers>
 76 |                         <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
 77 |                             <mainClass>net.brlns.livecaptions.LiveCaptionsLogger</mainClass>
 78 |                         </transformer>
 79 |                     </transformers>
 80 |                 </configuration>
 81 |             </plugin>
 82 | 
 83 |             <plugin>
 84 |                 <groupId>org.apache.maven.plugins</groupId>
 85 |                 <artifactId>maven-compiler-plugin</artifactId>
 86 |                 <version>3.12.1</version>
 87 |                 <configuration>
 88 |                     <annotationProcessorPaths>
 89 |                         <path>
 90 |                             <groupId>org.projectlombok</groupId>
 91 |                             <artifactId>lombok</artifactId>
 92 |                             <version>1.18.34</version>
 93 |                         </path>
 94 |                     </annotationProcessorPaths>
 95 |                 </configuration>
 96 |             </plugin>
 97 |         </plugins>
 98 |     </build>
 99 | </project>
100 | 


--------------------------------------------------------------------------------
/src/main/java/net/brlns/livecaptions/Settings.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * Copyright (C) 2024 hstr0100
  3 |  *
  4 |  * This program is free software: you can redistribute it and/or modify
  5 |  * it under the terms of the GNU General Public License as published by
  6 |  * the Free Software Foundation, either version 3 of the License, or
  7 |  * (at your option) any later version.
  8 |  *
  9 |  * This program is distributed in the hope that it will be useful,
 10 |  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 11 |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 12 |  * GNU General Public License for more details.
 13 |  *
 14 |  * You should have received a copy of the GNU General Public License
 15 |  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 16 |  */
 17 | package net.brlns.livecaptions;
 18 | 
 19 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 20 | import com.fasterxml.jackson.annotation.JsonProperty;
 21 | import lombok.Data;
 22 | 
 23 | /**
 24 |  * Program Settings
 25 |  *
 26 |  * @author Gabriel / hstr0100 / vertx010
 27 |  */
 28 | @Data
 29 | @JsonIgnoreProperties(ignoreUnknown = true)
 30 | public class Settings {
 31 | 
 32 |     /**
 33 |      * Screen coordinates for the live captions
 34 |      *
 35 |      * Ships with default settings for 1080p at 125% scale
 36 |      * If you have a different resolution make sure
 37 |      * to configure the capture area via the system tray menu.
 38 |      */
 39 |     @JsonProperty("PixelStartX")
 40 |     private int boxStartX = 15;
 41 |     @JsonProperty("PixelStartY")
 42 |     private int boxStartY = 15;
 43 | 
 44 |     @JsonProperty("PixelEndX")
 45 |     private int boxEndX = 1795;
 46 |     @JsonProperty("PixelEndY")
 47 |     private int boxEndY = 103;
 48 | 
 49 |     /**
 50 |      * Output directory for logs and debug images.
 51 |      */
 52 |     @JsonProperty("OutputPath")
 53 |     private String outputPath = "";
 54 | 
 55 |     /**
 56 |      * If you are exclusively using this program with Windows 11's Live Captions,
 57 |      * this setting enables you to determine whether to automatically toggle
 58 |      * logging on or off when Live Captions is running.
 59 |      */
 60 |     @JsonProperty("LiveCaptionsSensing")
 61 |     private boolean liveCaptionsSensing = false;
 62 | 
 63 |     /**
 64 |      * This option should be set to true if you're trying to capture anything
 65 |      * else that is not Windows 11's LiveCaptions with theme set to white on black.
 66 |      */
 67 |     @JsonProperty("CaptureAnyText")
 68 |     private boolean captureAnyText = false;
 69 | 
 70 |     /**
 71 |      * Improves Tesseract's readability when dealing with white text on dynamic
 72 |      * backgrounds
 73 |      * e.g youtube's closed captions
 74 |      *
 75 |      * if CaptureAnyText is set true this should probably also be set to true.
 76 |      */
 77 |     @JsonProperty("ContrastMode")
 78 |     private boolean contrastMode = false;
 79 | 
 80 |     /**
 81 |      * If true, outputs debugging information to the console when started via cmd,
 82 |      * Also outputs debug images to OutputPath showing the current capture area.
 83 |      */
 84 |     @JsonProperty("DebugMode")
 85 |     private boolean debugMode = false;
 86 | 
 87 |     /**
 88 |      * Current logging state during startup.
 89 |      */
 90 |     @JsonProperty("LogAtStartup")
 91 |     private boolean currentlyLogging = true;
 92 | 
 93 |     /**
 94 |      * If the lines being generated are very short, we may not be able
 95 |      * to capture it in time, if you run into this problem and has CPU power
 96 |      * to spare, lower this value, 500ms (half a second) should be plenty
 97 |      *
 98 |      * Accepted range 50ms ~ 2500ms.
 99 |      */
100 |     @JsonProperty("CaptureRateMs")
101 |     private int captureRateMs = 1000;
102 | 
103 |     /**
104 |      * should be a value between 0-255
105 |      * 255 is the same as CaptureAnyText = true
106 |      * 30 makes sure only gray~black caption boxes will work with this program
107 |      * this value is checked against the RGB components of the pixels around the four corners.
108 |      *
109 |      * This value is ignored if CaptureAnyText is set to true.
110 |      */
111 |     @JsonProperty("CaptionWindowDetectColorThreshold")
112 |     private int captionWindowColorThreshold = 30;
113 | 
114 |     /**
115 |      * If you need to use languages other than English,
116 |      * download tesseract from https://github.com/UB-Mannheim/tesseract/wiki
117 |      * and point this to your own tessdata folder,
118 |      * Typically that would be C:\Program Files\Tesseract-OCR\tessdata.
119 |      */
120 |     @JsonProperty("CustomTessDataPath")
121 |     private String customTessDataPath = "";
122 | 
123 |     /**
124 |      * Available languages:
125 |      * https://tesseract-ocr.github.io/tessdoc/Data-Files#data-files-for-version-400-november-29-2016
126 |      * Only change this if your CustomTessDataPath contains the required
127 |      * language training files.
128 |      */
129 |     @JsonProperty("TesseractLanguage")
130 |     private String tessLanguage = "eng";
131 | 
132 | }
133 | 


--------------------------------------------------------------------------------
/src/main/java/net/brlns/livecaptions/ScreenSnipper.java:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * Copyright (C) 2024 hstr0100
  3 |  *
  4 |  * This program is free software: you can redistribute it and/or modify
  5 |  * it under the terms of the GNU General Public License as published by
  6 |  * the Free Software Foundation, either version 3 of the License, or
  7 |  * (at your option) any later version.
  8 |  *
  9 |  * This program is distributed in the hope that it will be useful,
 10 |  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 11 |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 12 |  * GNU General Public License for more details.
 13 |  *
 14 |  * You should have received a copy of the GNU General Public License
 15 |  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 16 |  */
 17 | package net.brlns.livecaptions;
 18 | 
 19 | import java.awt.*;
 20 | import java.awt.event.MouseAdapter;
 21 | import java.awt.event.MouseEvent;
 22 | import java.awt.image.BufferedImage;
 23 | import lombok.extern.slf4j.Slf4j;
 24 | 
 25 | /**
 26 |  * Allows users to select a region of the screen to watch for live captions.
 27 |  *
 28 |  * @author Gabriel / hstr0100 / vertx010
 29 |  */
 30 | @Slf4j
 31 | public class ScreenSnipper extends Window {
 32 | 
 33 |     private static final int X_INDEX = 0;
 34 |     private static final int Y_INDEX = 1;
 35 | 
 36 |     private final LiveCaptionsLogger main;
 37 |     private final double shadowRatio;
 38 | 
 39 |     private int[] screenStateCache;
 40 |     private int[] screenShadowCache;
 41 |     private BufferedImage screenBuffer;
 42 |     private Rectangle screenRect;
 43 |     private int startX;
 44 |     private int startY;
 45 |     private int endX;
 46 |     private int endY;
 47 | 
 48 |     private static final Font TEXT_FONT = new Font("SansSerif", Font.BOLD, 25);
 49 |     private static final Color TEXT_COLOR = Color.WHITE;
 50 | 
 51 |     public ScreenSnipper(LiveCaptionsLogger mainIn, Window ownerIn) {
 52 |         super(ownerIn);
 53 | 
 54 |         main = mainIn;
 55 |         shadowRatio = 0.6;
 56 |     }
 57 | 
 58 |     /**
 59 |      * Initializes the screen snipper.
 60 |      */
 61 |     public void init() {
 62 |         screenRect = getScreenBounds();
 63 |         captureReferenceScreenState();
 64 | 
 65 |         main.stopLiveCaptions();
 66 | 
 67 |         SnippingMouseListener sml = new SnippingMouseListener();
 68 |         addMouseListener(sml);
 69 |         addMouseMotionListener(sml);
 70 | 
 71 |         setAlwaysOnTop(true);
 72 |         setBounds(screenRect);
 73 |         setCursor(new Cursor(Cursor.CROSSHAIR_CURSOR));
 74 |         setVisible(true);
 75 |     }
 76 | 
 77 |     @Override
 78 |     public void paint(Graphics g) {
 79 |         super.paint(g);
 80 | 
 81 |         if (screenStateCache != null) {
 82 |             if (screenBuffer == null) {
 83 |                 screenBuffer = selectRegion(screenStateCache, screenShadowCache, screenRect.width, screenRect.height, startX, startY, endX, endY);
 84 |                 drawTextOnImage(screenBuffer, "Drag the cursor to select the live captions area");
 85 |             }
 86 | 
 87 |             g.drawImage(screenBuffer, 0, 0, null);
 88 |         }
 89 |     }
 90 | 
 91 |     @Override
 92 |     public void update(Graphics g) {
 93 |         screenBuffer = selectRegion(screenStateCache, screenShadowCache, screenRect.width, screenRect.height, startX, startY, endX, endY);
 94 | 
 95 |         paint(g);
 96 |     }
 97 | 
 98 |     private void captureReferenceScreenState() {
 99 |         try {
100 |             Robot robot = new Robot();
101 |             BufferedImage screenshot = robot.createScreenCapture(screenRect);
102 |             int width = screenRect.width, height = screenRect.height;
103 |             screenStateCache = screenshot.getRGB(0, 0, width, height, null, 0, width);
104 |             screenShadowCache = getShadow(screenStateCache, width, height);
105 |         } catch (AWTException e) {
106 |             main.handleException(e);
107 |         }
108 |     }
109 | 
110 |     private void setupZone(int startX, int startY, int endX, int endY) {
111 |         try {
112 |             main.setBounds(startX, startY, endX, endY);
113 |         } finally {
114 |             main.closeSnipper();
115 |         }
116 |     }
117 | 
118 |     private void drawTextOnImage(BufferedImage image, String text) {
119 |         Graphics2D g = image.createGraphics();
120 |         g.setFont(TEXT_FONT);
121 |         FontMetrics metrics = g.getFontMetrics(TEXT_FONT);
122 |         int x = (image.getWidth() - metrics.stringWidth(text)) / 2;
123 |         int y = image.getHeight() / 2;
124 |         g.setColor(TEXT_COLOR);
125 |         g.drawString(text, x, y);
126 |         g.dispose();
127 |     }
128 | 
129 |     private BufferedImage selectRegion(int[] img, int[] imgShadow, int width, int height, int startX, int startY, int endX, int endY) {
130 |         int[] copyImg = new int[width * height];
131 |         int[] llc = {Math.min(startX, endX), Math.min(startY, endY)};
132 |         int[] urc = {Math.max(startX, endX), Math.max(startY, endY)};
133 |         System.arraycopy(imgShadow, 0, copyImg, 0, width * height);
134 | 
135 |         for (int y = llc[Y_INDEX]; y < urc[Y_INDEX]; y++) {
136 |             System.arraycopy(img, y * width + llc[X_INDEX], copyImg, y * width + llc[X_INDEX], urc[X_INDEX] - llc[X_INDEX]);
137 |         }
138 | 
139 |         BufferedImage finalImg = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
140 |         finalImg.getRaster().setDataElements(0, 0, width, height, copyImg);
141 | 
142 |         return finalImg;
143 |     }
144 | 
145 |     private int[] getShadow(int[] img, int width, int height) {
146 |         int[] copyImg = new int[width * height];
147 |         for (int i = 0; i < copyImg.length; i++) {
148 |             copyImg[i] = createShadow(img[i], shadowRatio);
149 |         }
150 | 
151 |         return copyImg;
152 |     }
153 | 
154 |     private int createShadow(int rgb, double ratio) {
155 |         int red = Math.min(255, (int)(((rgb >> 16) & 0xFF) * ratio));
156 |         int blue = Math.min(255, (int)(((rgb >> 8) & 0xFF) * ratio));
157 |         int green = Math.min(255, (int)((rgb & 0xFF) * ratio));
158 | 
159 |         return (red << 16) + (blue << 8) + green;
160 |     }
161 | 
162 |     private void setStartingPoint(int x, int y) {
163 |         startX = x;
164 |         startY = y;
165 |     }
166 | 
167 |     private void setEndPoint(int x, int y) {
168 |         endX = x;
169 |         endY = y;
170 |     }
171 | 
172 |     /**
173 |      * Retrieves the bounds of all screens combined.
174 |      */
175 |     private Rectangle getScreenBounds() {
176 |         Rectangle bounds = new Rectangle(0, 0, 0, 0);
177 |         for (GraphicsDevice gd : GraphicsEnvironment.getLocalGraphicsEnvironment().getScreenDevices()) {
178 |             bounds = bounds.union(gd.getDefaultConfiguration().getBounds());
179 |         }
180 | 
181 |         return bounds;
182 |     }
183 | 
184 |     /**
185 |      * Mouse listener for selecting the screen region.
186 |      */
187 |     private class SnippingMouseListener extends MouseAdapter {
188 | 
189 |         @Override
190 |         public void mousePressed(MouseEvent e) {
191 |             setStartingPoint(e.getX(), e.getY());
192 |         }
193 | 
194 |         @Override
195 |         public void mouseDragged(MouseEvent e) {
196 |             setEndPoint(e.getX(), e.getY());
197 |             update(getGraphics());
198 |         }
199 | 
200 |         @Override
201 |         public void mouseReleased(MouseEvent e) {
202 |             setEndPoint(e.getX(), e.getY());
203 |             setupZone(startX, startY, endX, endY);
204 |         }
205 |     }
206 | }
207 | 


--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | #
  4 | # Copyright © 2015-2021 the original authors.
  5 | #
  6 | # Licensed under the Apache License, Version 2.0 (the "License");
  7 | # you may not use this file except in compliance with the License.
  8 | # You may obtain a copy of the License at
  9 | #
 10 | #      https://www.apache.org/licenses/LICENSE-2.0
 11 | #
 12 | # Unless required by applicable law or agreed to in writing, software
 13 | # distributed under the License is distributed on an "AS IS" BASIS,
 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 | # See the License for the specific language governing permissions and
 16 | # limitations under the License.
 17 | #
 18 | 
 19 | ##############################################################################
 20 | #
 21 | #   Gradle start up script for POSIX generated by Gradle.
 22 | #
 23 | #   Important for running:
 24 | #
 25 | #   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
 26 | #       noncompliant, but you have some other compliant shell such as ksh or
 27 | #       bash, then to run this script, type that shell name before the whole
 28 | #       command line, like:
 29 | #
 30 | #           ksh Gradle
 31 | #
 32 | #       Busybox and similar reduced shells will NOT work, because this script
 33 | #       requires all of these POSIX shell features:
 34 | #         * functions;
 35 | #         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
 36 | #           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
 37 | #         * compound commands having a testable exit status, especially «case»;
 38 | #         * various built-in commands including «command», «set», and «ulimit».
 39 | #
 40 | #   Important for patching:
 41 | #
 42 | #   (2) This script targets any POSIX shell, so it avoids extensions provided
 43 | #       by Bash, Ksh, etc; in particular arrays are avoided.
 44 | #
 45 | #       The "traditional" practice of packing multiple parameters into a
 46 | #       space-separated string is a well documented source of bugs and security
 47 | #       problems, so this is (mostly) avoided, by progressively accumulating
 48 | #       options in "$@", and eventually passing that to Java.
 49 | #
 50 | #       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
 51 | #       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
 52 | #       see the in-line comments for details.
 53 | #
 54 | #       There are tweaks for specific operating systems such as AIX, CygWin,
 55 | #       Darwin, MinGW, and NonStop.
 56 | #
 57 | #   (3) This script is generated from the Groovy template
 58 | #       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 59 | #       within the Gradle project.
 60 | #
 61 | #       You can find Gradle at https://github.com/gradle/gradle/.
 62 | #
 63 | ##############################################################################
 64 | 
 65 | # Attempt to set APP_HOME
 66 | 
 67 | # Resolve links: $0 may be a link
 68 | app_path=$0
 69 | 
 70 | # Need this for daisy-chained symlinks.
 71 | while
 72 |     APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
 73 |     [ -h "$app_path" ]
 74 | do
 75 |     ls=$( ls -ld "$app_path" )
 76 |     link=${ls#*' -> '}
 77 |     case $link in             #(
 78 |       /*)   app_path=$link ;; #(
 79 |       *)    app_path=$APP_HOME$link ;;
 80 |     esac
 81 | done
 82 | 
 83 | # This is normally unused
 84 | # shellcheck disable=SC2034
 85 | APP_BASE_NAME=${0##*/}
 86 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
 87 | APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 88 | 
 89 | # Use the maximum available, or set MAX_FD != -1 to use that value.
 90 | MAX_FD=maximum
 91 | 
 92 | warn () {
 93 |     echo "$*"
 94 | } >&2
 95 | 
 96 | die () {
 97 |     echo
 98 |     echo "$*"
 99 |     echo
100 |     exit 1
101 | } >&2
102 | 
103 | # OS specific support (must be 'true' or 'false').
104 | cygwin=false
105 | msys=false
106 | darwin=false
107 | nonstop=false
108 | case "$( uname )" in                #(
109 |   CYGWIN* )         cygwin=true  ;; #(
110 |   Darwin* )         darwin=true  ;; #(
111 |   MSYS* | MINGW* )  msys=true    ;; #(
112 |   NONSTOP* )        nonstop=true ;;
113 | esac
114 | 
115 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
116 | 
117 | 
118 | # Determine the Java command to use to start the JVM.
119 | if [ -n "$JAVA_HOME" ] ; then
120 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
121 |         # IBM's JDK on AIX uses strange locations for the executables
122 |         JAVACMD=$JAVA_HOME/jre/sh/java
123 |     else
124 |         JAVACMD=$JAVA_HOME/bin/java
125 |     fi
126 |     if [ ! -x "$JAVACMD" ] ; then
127 |         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
128 | 
129 | Please set the JAVA_HOME variable in your environment to match the
130 | location of your Java installation."
131 |     fi
132 | else
133 |     JAVACMD=java
134 |     if ! command -v java >/dev/null 2>&1
135 |     then
136 |         die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 | 
138 | Please set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 |     fi
141 | fi
142 | 
143 | # Increase the maximum file descriptors if we can.
144 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
145 |     case $MAX_FD in #(
146 |       max*)
147 |         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
148 |         # shellcheck disable=SC2039,SC3045
149 |         MAX_FD=$( ulimit -H -n ) ||
150 |             warn "Could not query maximum file descriptor limit"
151 |     esac
152 |     case $MAX_FD in  #(
153 |       '' | soft) :;; #(
154 |       *)
155 |         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
156 |         # shellcheck disable=SC2039,SC3045
157 |         ulimit -n "$MAX_FD" ||
158 |             warn "Could not set maximum file descriptor limit to $MAX_FD"
159 |     esac
160 | fi
161 | 
162 | # Collect all arguments for the java command, stacking in reverse order:
163 | #   * args from the command line
164 | #   * the main class name
165 | #   * -classpath
166 | #   * -D...appname settings
167 | #   * --module-path (only if needed)
168 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
169 | 
170 | # For Cygwin or MSYS, switch paths to Windows format before running java
171 | if "$cygwin" || "$msys" ; then
172 |     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
173 |     CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
174 | 
175 |     JAVACMD=$( cygpath --unix "$JAVACMD" )
176 | 
177 |     # Now convert the arguments - kludge to limit ourselves to /bin/sh
178 |     for arg do
179 |         if
180 |             case $arg in                                #(
181 |               -*)   false ;;                            # don't mess with options #(
182 |               /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
183 |                     [ -e "$t" ] ;;                      #(
184 |               *)    false ;;
185 |             esac
186 |         then
187 |             arg=$( cygpath --path --ignore --mixed "$arg" )
188 |         fi
189 |         # Roll the args list around exactly as many times as the number of
190 |         # args, so each arg winds up back in the position where it started, but
191 |         # possibly modified.
192 |         #
193 |         # NB: a `for` loop captures its iteration list before it begins, so
194 |         # changing the positional parameters here affects neither the number of
195 |         # iterations, nor the values presented in `arg`.
196 |         shift                   # remove old arg
197 |         set -- "$@" "$arg"      # push replacement arg
198 |     done
199 | fi
200 | 
201 | 
202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
204 | 
205 | # Collect all arguments for the java command:
206 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
207 | #     and any embedded shellness will be escaped.
208 | #   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
209 | #     treated as '${Hostname}' itself on the command line.
210 | 
211 | set -- \
212 |         "-Dorg.gradle.appname=$APP_BASE_NAME" \
213 |         -classpath "$CLASSPATH" \
214 |         org.gradle.wrapper.GradleWrapperMain \
215 |         "$@"
216 | 
217 | # Stop when "xargs" is not available.
218 | if ! command -v xargs >/dev/null 2>&1
219 | then
220 |     die "xargs is not available"
221 | fi
222 | 
223 | # Use "xargs" to parse quoted args.
224 | #
225 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
226 | #
227 | # In Bash we could simply go:
228 | #
229 | #   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
230 | #   set -- "${ARGS[@]}" "$@"
231 | #
232 | # but POSIX shell has neither arrays nor command substitution, so instead we
233 | # post-process each arg (as a line of input to sed) to backslash-escape any
234 | # character that might be a shell metacharacter, then use eval to reverse
235 | # that process (while maintaining the separation between arguments), and wrap
236 | # the whole thing up as a single "set" statement.
237 | #
238 | # This will of course break if any of these variables contains a newline or
239 | # an unmatched quote.
240 | #
241 | 
242 | eval "set -- $(
243 |         printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
244 |         xargs -n1 |
245 |         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
246 |         tr '\n' ' '
247 |     )" '"$@"'
248 | 
249 | exec "$JAVACMD" "$@"
250 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 
676 | 


--------------------------------------------------------------------------------
/src/main/java/net/brlns/livecaptions/LiveCaptionsLogger.java:
--------------------------------------------------------------------------------
   1 | /*
   2 |  * Copyright (C) 2024 hstr0100
   3 |  *
   4 |  * This program is free software: you can redistribute it and/or modify
   5 |  * it under the terms of the GNU General Public License as published by
   6 |  * the Free Software Foundation, either version 3 of the License, or
   7 |  * (at your option) any later version.
   8 |  *
   9 |  * This program is distributed in the hope that it will be useful,
  10 |  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 |  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 |  * GNU General Public License for more details.
  13 |  *
  14 |  * You should have received a copy of the GNU General Public License
  15 |  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 |  */
  17 | package net.brlns.livecaptions;
  18 | 
  19 | import com.fasterxml.jackson.databind.JsonNode;
  20 | import com.fasterxml.jackson.databind.ObjectMapper;
  21 | import java.awt.*;
  22 | import java.awt.color.ColorSpace;
  23 | import java.awt.event.ActionEvent;
  24 | import java.awt.event.ActionListener;
  25 | import java.awt.geom.AffineTransform;
  26 | import java.awt.image.BufferedImage;
  27 | import java.awt.image.ColorConvertOp;
  28 | import java.io.File;
  29 | import java.io.FileWriter;
  30 | import java.io.IOException;
  31 | import java.io.PrintWriter;
  32 | import java.net.URI;
  33 | import java.net.URISyntaxException;
  34 | import java.nio.file.Path;
  35 | import java.nio.file.Paths;
  36 | import java.text.SimpleDateFormat;
  37 | import java.util.ArrayList;
  38 | import java.util.Arrays;
  39 | import java.util.Calendar;
  40 | import java.util.List;
  41 | import java.util.concurrent.CompletableFuture;
  42 | import java.util.concurrent.ExecutorService;
  43 | import java.util.concurrent.Executors;
  44 | import java.util.concurrent.ScheduledExecutorService;
  45 | import java.util.concurrent.TimeUnit;
  46 | import java.util.concurrent.atomic.AtomicBoolean;
  47 | import java.util.concurrent.atomic.AtomicInteger;
  48 | import java.util.concurrent.locks.ReentrantLock;
  49 | import javax.imageio.ImageIO;
  50 | import javax.swing.JFileChooser;
  51 | import javax.swing.JOptionPane;
  52 | import javax.swing.UIManager;
  53 | import javax.swing.filechooser.FileSystemView;
  54 | import lombok.extern.slf4j.Slf4j;
  55 | import net.brlns.livecaptions.util.LoggerUtils;
  56 | import net.brlns.livecaptions.util.Nullable;
  57 | import net.sourceforge.tess4j.Tesseract;
  58 | import net.sourceforge.tess4j.TesseractException;
  59 | import net.sourceforge.tess4j.util.LoadLibs;
  60 | import org.apache.commons.text.similarity.JaroWinklerDistance;
  61 | 
  62 | /**
  63 |  * LiveCaptionsLogger
  64 |  *
  65 |  * @author Gabriel / hstr0100 / vertx010
  66 |  */
  67 | @Slf4j
  68 | public class LiveCaptionsLogger {
  69 | 
  70 |     /**
  71 |      * Constants and application states
  72 |      */
  73 |     private static final String REGISTRY_APP_NAME = "LiveCaptionsLogger";// Don't change
  74 | 
  75 |     private static final SimpleDateFormat FORMATTER = new SimpleDateFormat("yyyy-MM-dd_HH-mm-ss");
  76 | 
  77 |     private final ReentrantLock tesseractLock = new ReentrantLock();
  78 | 
  79 |     private File currentFile;
  80 |     private String lastPrintedLine;
  81 |     private final List<String> lastLines = new ArrayList<>();
  82 | 
  83 |     private final SystemTray tray;
  84 |     private TrayIcon trayIcon = null;
  85 | 
  86 |     private Rectangle screenZone;
  87 | 
  88 |     private File configFile;
  89 |     private Settings config;
  90 | 
  91 |     private ObjectMapper objectMapper = new ObjectMapper();
  92 | 
  93 |     private ScreenSnipper snipper = null;
  94 | 
  95 |     private final AtomicInteger currentTick = new AtomicInteger(0);
  96 |     private final AtomicBoolean liveCaptionsRunning = new AtomicBoolean(true);
  97 |     private int ticksSinceLastRunning = 0;
  98 | 
  99 |     @SuppressWarnings("this-escape") // TODO: properly deal with this, the issue lies in openSnipper()
 100 |     public LiveCaptionsLogger() {
 101 |         File workDir = getWorkDirectory();
 102 | 
 103 |         // TODO: move log rotation to utils
 104 |         File logFile = new File(workDir, "application_log.txt");
 105 |         File previousLogFile = new File(workDir, "application_log_previous.txt");
 106 | 
 107 |         if (logFile.exists()) {
 108 |             if (previousLogFile.exists()) {
 109 |                 previousLogFile.delete();
 110 |             }
 111 | 
 112 |             logFile.renameTo(previousLogFile);
 113 |         }
 114 | 
 115 |         LoggerUtils.setLogFile(logFile);
 116 | 
 117 |         // Initialize the config file
 118 |         configFile = new File(workDir, "config.json");
 119 | 
 120 |         if (!configFile.exists()) {
 121 |             config = new Settings();
 122 |             updateConfig();
 123 |         }
 124 | 
 125 |         try {
 126 |             config = objectMapper.readValue(configFile, Settings.class);
 127 |         } catch (IOException e) {
 128 |             config = new Settings();
 129 |             updateConfig();
 130 | 
 131 |             handleException(e, true);
 132 |         }
 133 | 
 134 |         log.info("Loaded config file");
 135 | 
 136 |         tray = SystemTray.getSystemTray();
 137 | 
 138 |         try {
 139 |             // Register to the system tray
 140 |             Image image = Toolkit.getDefaultToolkit().createImage(this.getClass().getResource("/assets/tray_icon.png"));
 141 |             trayIcon = new TrayIcon(image, REGISTRY_APP_NAME, buildPopupMenu());
 142 |             trayIcon.setImageAutoSize(true);
 143 | 
 144 |             trayIcon.addActionListener((ActionEvent e) -> {
 145 |                 try {
 146 |                     File file = getOrCreateOutputDirectory();
 147 | 
 148 |                     Desktop.getDesktop().open(file);
 149 |                 } catch (IOException e1) {
 150 |                     handleException(e1);
 151 |                 }
 152 |             });
 153 | 
 154 |             tray.add(trayIcon);
 155 | 
 156 |             // Initialize the capture area bounds
 157 |             updateScreenZone();
 158 | 
 159 |             // Initialize the capture tool for Tesseract
 160 |             Robot robot = new Robot();
 161 | 
 162 |             // Initialize Tesseract
 163 |             File tessDataFolder;
 164 |             if (config.getCustomTessDataPath().isEmpty()) {
 165 |                 tessDataFolder = LoadLibs.extractTessResources("tessdata");
 166 |             } else {
 167 |                 tessDataFolder = new File(config.getCustomTessDataPath());
 168 |             }
 169 | 
 170 |             if (!tessDataFolder.exists()) {
 171 |                 throw new RuntimeException("tessdata folder not found!");
 172 |             }
 173 | 
 174 |             log.debug("Tesseract initialized");
 175 | 
 176 |             // Initialize the string comparison tool
 177 |             JaroWinklerDistance jaroWinklerDistance = new JaroWinklerDistance();
 178 | 
 179 |             Runnable captureAndProcess = () -> {
 180 |                 int tick = currentTick.incrementAndGet();
 181 | 
 182 |                 if (config.isDebugMode()) {
 183 |                     log.debug("Tick #" + tick);
 184 |                 }
 185 | 
 186 |                 if (!config.isCurrentlyLogging()) {
 187 |                     if (config.isDebugMode()) {
 188 |                         log.debug("Logging is off");
 189 |                     }
 190 | 
 191 |                     return;
 192 |                 }
 193 | 
 194 |                 if (isWindows() && config.isLiveCaptionsSensing()) {
 195 |                     // We would check if CaptureAnyText is off before running this. However, until we have mouse tooltips to explain why this setting conflicts with the other, this should do.
 196 |                     if (tick % 5 == 0) {// Lets not call isLiveCaptionsRunning() every second, 5 should be fine.
 197 |                         long timeNow = System.currentTimeMillis();
 198 | 
 199 |                         // This method can be expensive depending on the system, so lets offload it to another thread
 200 |                         CompletableFuture<Boolean> isRunningTask = CompletableFuture.supplyAsync(this::isLiveCaptionsRunning);
 201 | 
 202 |                         isRunningTask.thenAcceptAsync((isRunning) -> {
 203 |                             if (config.isDebugMode()) {
 204 |                                 log.debug("Took " + (System.currentTimeMillis() - timeNow) + "ms. running: " + isRunning);
 205 |                             }
 206 | 
 207 |                             if (isRunning) {
 208 |                                 liveCaptionsRunning.set(true);
 209 |                                 ticksSinceLastRunning = 0;
 210 |                             } else {
 211 |                                 if (++ticksSinceLastRunning == 4) { // ~20 seconds of inactivity, varies based on the set tick rate
 212 |                                     liveCaptionsRunning.set(false);
 213 |                                     closeLogger();
 214 |                                 }
 215 |                             }
 216 |                         }).exceptionally((e) -> {
 217 |                             handleException(e);
 218 |                             return null;
 219 |                         });
 220 |                     }
 221 | 
 222 |                     // This is not exactly mission-critical, LiveCaptions takes time to start up or wind down.
 223 |                     // If the async future takes too long, it's acceptable for this to be updated around the next tick.
 224 |                     if (!liveCaptionsRunning.get()) {
 225 |                         if (config.isDebugMode()) {
 226 |                             log.debug("Sensed that LiveCaptions is not running, logging is off");
 227 |                         }
 228 | 
 229 |                         return;
 230 |                     }
 231 |                 }
 232 | 
 233 |                 BufferedImage screenshot = robot.createScreenCapture(screenZone);
 234 | 
 235 |                 if (config.isDebugMode() && tick % 10 == 0) {
 236 |                     try {
 237 |                         log.debug("Captured at " + screenZone);
 238 | 
 239 |                         saveDebugImage(screenshot, "cc_debug.png");
 240 | 
 241 |                         log.debug("Saved debug image");
 242 |                     } catch (IOException e) {
 243 |                         handleException(e);
 244 |                     }
 245 |                 }
 246 | 
 247 |                 if (!inCaptionBox(screenshot)) {
 248 |                     if (config.isDebugMode()) {
 249 |                         log.debug("CC Window not detected");
 250 |                     }
 251 | 
 252 |                     closeLogger();
 253 |                     return;
 254 |                 }
 255 | 
 256 |                 BufferedImage filteredImage = filterWhite(screenshot);
 257 | 
 258 |                 if (tesseractLock.tryLock()) {
 259 |                     try {
 260 |                         // This needs a more elegant solution, Tesseract keeps hanging with random images
 261 |                         ExecutorService executorService = Executors.newSingleThreadExecutor();
 262 | 
 263 |                         executorService.execute(() -> {
 264 |                             try {
 265 |                                 Tesseract tesseract = new Tesseract();
 266 | 
 267 |                                 tesseract.setDatapath(tessDataFolder.getAbsolutePath());
 268 |                                 tesseract.setLanguage(config.getTessLanguage());
 269 | 
 270 |                                 // Start the OCR process
 271 |                                 String text = tesseract.doOCR(filteredImage);
 272 | 
 273 |                                 text = text.replace("|", "I"); // This one is particularly common
 274 | 
 275 |                                 if (text.contains("(") || text.contains(")")) {// Not sure if these actually ever show up in closed captions?
 276 |                                     return;
 277 |                                 }
 278 | 
 279 |                                 if (config.isDebugMode()) {
 280 |                                     log.debug("OCR Saw: " + text);
 281 |                                 }
 282 | 
 283 |                                 // Process the results
 284 |                                 String[] lines = text.split("\\n");
 285 | 
 286 |                                 synchronized (lastLines) {
 287 |                                     for (String line : lines) {
 288 |                                         boolean contains = false;
 289 |                                         for (String oldLine : lastLines) {
 290 |                                             // This checks if more than 80% of a line matches the other
 291 |                                             double distance = jaroWinklerDistance.apply(oldLine, line);
 292 |                                             if (config.isDebugMode()) {
 293 |                                                 log.debug("Distance between previous line " + distance + " " + oldLine + ":" + line);
 294 |                                             }
 295 | 
 296 |                                             if (distance <= 0.20 || oldLine.contains(line)) {
 297 |                                                 contains = true;
 298 |                                             }
 299 |                                         }
 300 | 
 301 |                                         if (!contains && !lastLines.isEmpty()) {
 302 |                                             String oldestEntry = lastLines.remove(0);
 303 | 
 304 |                                             double distance = jaroWinklerDistance.apply(oldestEntry,
 305 |                                                 lastPrintedLine != null ? lastPrintedLine : "");
 306 |                                             if (config.isDebugMode()) {
 307 |                                                 log.debug("Distance from the last line " + distance);
 308 |                                             }
 309 | 
 310 |                                             if (distance > 0.20) {
 311 |                                                 lastPrintedLine = oldestEntry;
 312 |                                                 logToFile(oldestEntry);
 313 |                                             }
 314 |                                         }
 315 |                                     }
 316 | 
 317 |                                     lastLines.clear();
 318 |                                     lastLines.addAll(Arrays.asList(lines));
 319 |                                 }
 320 |                             } catch (TesseractException e) {
 321 |                                 // Seems safe to just ignore this
 322 |                                 handleException(e, false);
 323 |                             }
 324 |                         });
 325 | 
 326 |                         executorService.shutdown();
 327 | 
 328 |                         try {
 329 |                             // TODO: At least on linux, libtesseract.so can randomly crash the JVM when the thread is interrupted
 330 |                             // We can't cancel OCR when it decides to hang at a native level, and this workaround is not safe either
 331 |                             // This is something that should be addressed by Tesseract or tess4j's team
 332 |                             if (!executorService.awaitTermination(3000, TimeUnit.MILLISECONDS)) {
 333 |                                 if (config.isDebugMode()) {
 334 |                                     log.error("Skipping a tick, OCR took too long");
 335 |                                 }
 336 |                             }
 337 |                         } catch (InterruptedException e) {
 338 |                             // Nothing
 339 |                         }
 340 |                     } finally {
 341 |                         tesseractLock.unlock();
 342 |                     }
 343 |                 } else {
 344 |                     if (config.isDebugMode()) {
 345 |                         log.debug("Could not acquire lock. Skipping OCR.");
 346 |                     }
 347 |                 }
 348 |             };
 349 | 
 350 |             // Schedule the main program loop, we do not rely on the main thread here.
 351 |             ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
 352 | 
 353 |             int clampedRateMs = clamp(config.getCaptureRateMs(), 50, 2500);
 354 | 
 355 |             scheduler.scheduleAtFixedRate(captureAndProcess, 0, clampedRateMs, TimeUnit.MILLISECONDS);// 1 Second? seems ok
 356 |         } catch (Exception e) {
 357 |             handleException(e);
 358 |         }
 359 |     }
 360 | 
 361 |     /**
 362 |      * Builds the system tray menu.
 363 |      *
 364 |      * TODO: move this to its own class, migrate to JPopupMenu to add mouse over tooltips
 365 |      */
 366 |     private PopupMenu buildPopupMenu() {
 367 |         PopupMenu popup = new PopupMenu();
 368 | 
 369 |         popup.add(buildMenuItem("Toggle LiveCaptions Logging", (ActionEvent e) -> {
 370 |             config.setCurrentlyLogging(!config.isCurrentlyLogging());
 371 | 
 372 |             if (!config.isCurrentlyLogging()) {
 373 |                 closeLogger();
 374 |             }
 375 | 
 376 |             updateConfig();
 377 | 
 378 |             trayIcon.displayMessage(REGISTRY_APP_NAME, "Live caption logging is now " + (config.isCurrentlyLogging() ? "ON" : "OFF"), TrayIcon.MessageType.INFO);
 379 |         }));
 380 | 
 381 |         if (isWindows()) {
 382 |             popup.add(buildMenuItem("Toggle LiveCaptions Sensing", (ActionEvent e) -> {
 383 |                 config.setLiveCaptionsSensing(!config.isLiveCaptionsSensing());
 384 | 
 385 |                 updateConfig();
 386 | 
 387 |                 trayIcon.displayMessage(REGISTRY_APP_NAME, "LiveCaptions sensing (stops and starts logging automatically when LiveCaptions is running) is now " + (config.isLiveCaptionsSensing() ? "ON" : "OFF"), TrayIcon.MessageType.INFO);
 388 |             }));
 389 |         }
 390 | 
 391 |         popup.add(buildMenuItem("Toggle Contrast Mode", (ActionEvent e) -> {
 392 |             config.setContrastMode(!config.isContrastMode());
 393 | 
 394 |             updateConfig();
 395 | 
 396 |             trayIcon.displayMessage(REGISTRY_APP_NAME, "Contrast mode is now " + (config.isContrastMode() ? "ON" : "OFF"), TrayIcon.MessageType.INFO);
 397 |         }));
 398 | 
 399 |         popup.add(buildMenuItem("Toggle Logging of Any Text", (ActionEvent e) -> {
 400 |             config.setCaptureAnyText(!config.isCaptureAnyText());
 401 | 
 402 |             updateConfig();
 403 | 
 404 |             trayIcon.displayMessage(REGISTRY_APP_NAME, "Logging of any text within the capture window is now " + (config.isCaptureAnyText() ? "ON" : "OFF"), TrayIcon.MessageType.INFO);
 405 |         }));
 406 | 
 407 |         if (isWindows()) {
 408 |             popup.add(buildMenuItem("Toggle Auto Start", (ActionEvent e) -> {
 409 |                 boolean result = checkStartupStatusAndToggle();
 410 | 
 411 |                 trayIcon.displayMessage(REGISTRY_APP_NAME, "Application auto start is now " + (result ? "ON" : "OFF"), TrayIcon.MessageType.INFO);
 412 |             }));
 413 |         }
 414 | 
 415 |         popup.add(buildMenuItem("Toggle Debug Mode", (ActionEvent e) -> {
 416 |             config.setDebugMode(!config.isDebugMode());
 417 | 
 418 |             updateConfig();
 419 | 
 420 |             trayIcon.displayMessage(REGISTRY_APP_NAME, "Debug mode is now " + (config.isDebugMode() ? "ON" : "OFF"), TrayIcon.MessageType.INFO);
 421 |         }));
 422 | 
 423 |         popup.add(buildMenuItem("Configure Captions Area", (ActionEvent e) -> {
 424 |             openSnipper();
 425 |         }));
 426 | 
 427 |         popup.add(buildMenuItem("Configure Output Folder", (ActionEvent e) -> {
 428 |             openDirectoryPicker();
 429 |         }));
 430 | 
 431 |         popup.add(buildMenuItem("Restore Default Settings", (ActionEvent e) -> {
 432 |             int option = JOptionPane.showConfirmDialog(null,
 433 |                 "Are you sure you want to restore default settings?",
 434 |                 "Restore Default Settings",
 435 |                 JOptionPane.YES_NO_OPTION);
 436 | 
 437 |             if (option == JOptionPane.YES_OPTION) {
 438 |                 config = new Settings();
 439 | 
 440 |                 updateConfig();
 441 |                 updateScreenZone();
 442 |                 closeLogger();
 443 | 
 444 |                 trayIcon.displayMessage(REGISTRY_APP_NAME, "Settings have been restored to default", TrayIcon.MessageType.INFO);
 445 |             }
 446 |         }));
 447 | 
 448 |         popup.add(buildMenuItem("Start Live Captions", (ActionEvent e) -> {
 449 |             startLiveCaptions();
 450 |         }));
 451 | 
 452 |         popup.add(buildMenuItem("Exit", (ActionEvent e) -> {
 453 |             log.info("Exiting....");
 454 | 
 455 |             try {
 456 |                 closeLogger();
 457 |             } catch (Exception e1) {
 458 |                 handleException(e1);
 459 |             } finally {
 460 |                 System.exit(0);
 461 |             }
 462 |         }));
 463 | 
 464 |         return popup;
 465 |     }
 466 | 
 467 |     /**
 468 |      * Helper for building system tray menu entries.
 469 |      */
 470 |     private MenuItem buildMenuItem(String name, ActionListener actionListener) {
 471 |         MenuItem menuItem = new MenuItem(name);
 472 |         menuItem.addActionListener(actionListener);
 473 | 
 474 |         return menuItem;
 475 |     }
 476 | 
 477 |     /**
 478 |      * Opens a dialog window for selecting a custom output directory
 479 |      *
 480 |      * @see getOrCreateOutputDirectory()
 481 |      */
 482 |     private void openDirectoryPicker() {
 483 |         try {
 484 |             JFileChooser fileChooser = new JFileChooser(FileSystemView.getFileSystemView().getHomeDirectory());
 485 |             fileChooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
 486 | 
 487 |             int result = fileChooser.showOpenDialog(null);
 488 | 
 489 |             if (result == JFileChooser.APPROVE_OPTION) {
 490 |                 String selectedDirectory = fileChooser.getSelectedFile().getAbsolutePath();
 491 | 
 492 |                 log.debug("Selected Directory: " + selectedDirectory);
 493 | 
 494 |                 trayIcon.displayMessage(REGISTRY_APP_NAME, "Output path set to " + selectedDirectory, TrayIcon.MessageType.INFO);
 495 | 
 496 |                 config.setOutputPath(selectedDirectory);
 497 | 
 498 |                 updateConfig();
 499 |                 closeLogger();
 500 |             }
 501 |         } catch (HeadlessException e) {
 502 |             handleException(e);
 503 |         }
 504 |     }
 505 | 
 506 |     /**
 507 |      * Updates the capture area based on the current configuration, accounting
 508 |      * for the current display scale.
 509 |      */
 510 |     private void updateScreenZone() {
 511 |         AffineTransform transform = getGraphicsTransformAt(config.getBoxStartX(), config.getBoxStartY());
 512 |         double scaleX = transform.getScaleX();
 513 |         double scaleY = transform.getScaleY();
 514 | 
 515 |         int scaledBoxStartX = (int)(config.getBoxStartX() / scaleX);
 516 |         int scaledBoxStartY = (int)(config.getBoxStartY() / scaleY);
 517 |         int scaledBoxEndX = (int)(config.getBoxEndX() / scaleX);
 518 |         int scaledBoxEndY = (int)(config.getBoxEndY() / scaleY);
 519 | 
 520 |         if (config.isDebugMode()) {
 521 |             log.info("Scaling Factor 1: " + "X " + scaleX + " Y " + scaleY);
 522 | 
 523 |             log.info("Real Rectangle Coordinates:");
 524 |             log.info("StartX: " + config.getBoxStartX());
 525 |             log.info("StartY: " + config.getBoxStartY());
 526 |             log.info("EndX: " + config.getBoxEndX());
 527 |             log.info("EndY: " + config.getBoxEndY());
 528 | 
 529 |             log.info("Scaled Rectangle Coordinates:");
 530 |             log.info("StartX: " + scaledBoxStartX);
 531 |             log.info("StartY: " + scaledBoxStartY);
 532 |             log.info("EndX: " + scaledBoxEndX);
 533 |             log.info("EndY: " + scaledBoxEndY);
 534 |         }
 535 | 
 536 |         screenZone = new Rectangle(scaledBoxStartX, scaledBoxStartY,
 537 |             scaledBoxEndX - scaledBoxStartX,
 538 |             scaledBoxEndY - scaledBoxStartY);
 539 |     }
 540 | 
 541 |     /**
 542 |      * Updates the capture area based on the output generated by ScreenSnipper
 543 |      * and scales/downscales it based on the current screen scale.
 544 |      */
 545 |     public final void setBounds(int startX, int startY, int endX, int endY) {
 546 |         AffineTransform transform = getGraphicsTransformAt(config.getBoxStartX(), config.getBoxStartY());
 547 |         double scaleX = transform.getScaleX();
 548 |         double scaleY = transform.getScaleY();
 549 | 
 550 |         int scaledStartX = (int)(startX * scaleX);
 551 |         int scaledStartY = (int)(startY * scaleY);
 552 |         int scaledEndX = (int)(endX * scaleX);
 553 |         int scaledEndY = (int)(endY * scaleY);
 554 | 
 555 |         if (config.isDebugMode()) {
 556 |             log.info("Scaling Factor 2: " + "X " + scaleX + " Y " + scaleY);
 557 | 
 558 |             log.info("Provided Rectangle Coordinates:");
 559 |             log.info("StartX: " + startX);
 560 |             log.info("StartY: " + startY);
 561 |             log.info("EndX: " + endX);
 562 |             log.info("EndY: " + endY);
 563 | 
 564 |             log.info("Provided Scaled Rectangle Coordinates:");
 565 |             log.info("StartX: " + scaledStartX);
 566 |             log.info("StartY: " + scaledStartY);
 567 |             log.info("EndX: " + scaledEndX);
 568 |             log.info("EndY: " + scaledEndY);
 569 |         }
 570 | 
 571 |         if (Math.abs(scaledEndX - scaledStartX) > 5 && Math.abs(scaledEndY - scaledStartY) > 5) {
 572 |             config.setBoxStartX(scaledStartX);
 573 |             config.setBoxStartY(scaledStartY);
 574 |             config.setBoxEndX(scaledEndX);
 575 |             config.setBoxEndY(scaledEndY);
 576 | 
 577 |             updateScreenZone();
 578 |             updateConfig();
 579 | 
 580 |             trayIcon.displayMessage(REGISTRY_APP_NAME, "The capture area has been updated", TrayIcon.MessageType.INFO);
 581 |         } else {
 582 |             trayIcon.displayMessage(REGISTRY_APP_NAME,
 583 |                 "Please select a larger area", TrayIcon.MessageType.INFO);
 584 |         }
 585 |     }
 586 | 
 587 |     /**
 588 |      * Retrieves the graphics transform at the specified screen coordinates
 589 |      *
 590 |      * If the coordinates are not within any specific screen device,
 591 |      * the default screen device's graphics transform is returned.
 592 |      */
 593 |     private AffineTransform getGraphicsTransformAt(int x, int y) {
 594 |         GraphicsEnvironment environment = GraphicsEnvironment.getLocalGraphicsEnvironment();
 595 | 
 596 |         GraphicsDevice device = null;
 597 |         for (GraphicsDevice gd : environment.getScreenDevices()) {
 598 |             if (gd.getDefaultConfiguration().getBounds().contains(x, y)) {
 599 |                 device = gd;
 600 |             }
 601 |         }
 602 | 
 603 |         if (device == null) {
 604 |             device = environment.getDefaultScreenDevice();
 605 |         }
 606 | 
 607 |         GraphicsConfiguration graphicsConfig = device.getDefaultConfiguration();
 608 |         AffineTransform tx = graphicsConfig.getDefaultTransform();
 609 | 
 610 |         return tx;
 611 |     }
 612 | 
 613 |     /**
 614 |      * Opens the tool to manually select the captions capture area.
 615 |      */
 616 |     public final void openSnipper() {
 617 |         if (snipper != null) {
 618 |             closeSnipper();
 619 |             return;
 620 |         }
 621 | 
 622 |         snipper = new ScreenSnipper(this, new Window(null));
 623 | 
 624 |         try {
 625 |             snipper.init();
 626 |         } catch (Exception e) {
 627 |             handleException(e);
 628 |         }
 629 |     }
 630 | 
 631 |     /**
 632 |      * Closes the tool to manually select the captions capture area
 633 |      * when called by ScreenSnipper itself.
 634 |      */
 635 |     public final void closeSnipper() {
 636 |         if (snipper != null) {
 637 |             snipper.setVisible(false);
 638 |             snipper.dispose();
 639 |         }
 640 | 
 641 |         snipper = null;
 642 | 
 643 |         startLiveCaptions();
 644 |     }
 645 | 
 646 |     /**
 647 |      * Saves debug images (for troubleshooting) to the output
 648 |      * folder if debugMode = true.
 649 |      */
 650 |     private void saveDebugImage(BufferedImage image, String fileName) throws IOException {
 651 |         File picturesDirectory = getOrCreateOutputDirectory();
 652 | 
 653 |         File destinationFile = new File(picturesDirectory, fileName);
 654 | 
 655 |         ImageIO.write(image, "png", destinationFile);
 656 |     }
 657 | 
 658 |     /**
 659 |      * This shortcut is specific to Windows 11.
 660 |      */
 661 |     public final void startLiveCaptions() {
 662 |         if (isWindows11()) {
 663 |             try {
 664 |                 ProcessBuilder processBuilder = new ProcessBuilder(
 665 |                     "taskkill", "/f", "/im", "LiveCaptions.exe");
 666 | 
 667 |                 processBuilder.start();
 668 |             } catch (IOException e) {
 669 |                 handleException(e);
 670 |             }
 671 |         }
 672 |     }
 673 | 
 674 |     /**
 675 |      * This shortcut is specific to Windows 11.
 676 |      */
 677 |     public final void stopLiveCaptions() {
 678 |         if (isWindows11()) {
 679 |             try {
 680 |                 // It gets in the way due to the always on top nature of live captions
 681 |                 // this only runs on Windows 11
 682 |                 ProcessBuilder processBuilder = new ProcessBuilder(
 683 |                     "taskkill", "/f", "/im", "LiveCaptions.exe");
 684 | 
 685 |                 Process process = processBuilder.start();
 686 |                 int exitCode = process.waitFor();
 687 | 
 688 |                 if (exitCode == 0) {
 689 |                     log.info("Process killed successfully.");
 690 |                 } else {
 691 |                     log.error("Failed to kill the process. Exit code: {}", exitCode);
 692 |                 }
 693 |             } catch (IOException e) {
 694 |                 handleException(e);
 695 |             } catch (InterruptedException e) {
 696 |                 // Nothing
 697 |             }
 698 |         }
 699 |     }
 700 | 
 701 |     private void updateConfig() {
 702 |         updateConfig(config);
 703 |     }
 704 | 
 705 |     /**
 706 |      * Writes changes made to the Settings class to disk.
 707 |      */
 708 |     private void updateConfig(Settings configIn) {
 709 |         try {
 710 |             objectMapper.writerWithDefaultPrettyPrinter().writeValue(configFile, configIn);
 711 | 
 712 |             JsonNode jsonNode = objectMapper.valueToTree(configIn);
 713 | 
 714 |             objectMapper.readerForUpdating(config).readValue(jsonNode);
 715 | 
 716 |             objectMapper.writerWithDefaultPrettyPrinter().writeValue(configFile, configIn);
 717 | 
 718 |             LoggerUtils.setDebugLogLevel(configIn.isDebugMode());
 719 |         } catch (IOException e) {
 720 |             handleException(e);
 721 |         }
 722 |     }
 723 | 
 724 |     /**
 725 |      * Checks whether LiveCaptions is currently running.
 726 |      * This is specific to Windows 11.
 727 |      */
 728 |     private boolean isLiveCaptionsRunning() {
 729 |         if (!isWindows11()) {
 730 |             return false;
 731 |         }
 732 | 
 733 |         return ProcessHandle.allProcesses()
 734 |             .anyMatch((processHandle)
 735 |                 -> processHandle.info().command().map((command)
 736 |                 -> command.contains("LiveCaptions.exe")).orElse(false));
 737 |     }
 738 | 
 739 |     /**
 740 |      * Retrieves the absolute path of the currently running JAR file.
 741 |      * or null if not a JAR.
 742 |      */
 743 |     @Nullable
 744 |     private static String getJarLocation() {
 745 |         try {
 746 |             URI jarPath = LiveCaptionsLogger.class.getProtectionDomain().getCodeSource().getLocation().toURI();
 747 | 
 748 |             if (jarPath.toString().endsWith(".jar")) {
 749 |                 return new File(jarPath).getAbsolutePath();
 750 |             }
 751 |         } catch (URISyntaxException e) {
 752 |             // Ignore
 753 |         }
 754 | 
 755 |         return null;
 756 |     }
 757 | 
 758 |     /**
 759 |      * Constructs the launch command for the currently running JAR file.
 760 |      */
 761 |     @Nullable
 762 |     private List<String> getLaunchCommand() {
 763 |         List<String> launchString = null;
 764 | 
 765 |         String jarLocation = getJarLocation();
 766 |         if (jarLocation != null) {
 767 |             String javaHome = System.getProperty("java.home");
 768 | 
 769 |             if (javaHome == null || javaHome.isEmpty()) {
 770 |                 javaHome = System.getenv("JAVA_HOME");
 771 |             }
 772 | 
 773 |             if (javaHome != null && !javaHome.isEmpty()) {
 774 |                 if (!javaHome.endsWith(File.separator)) {
 775 |                     javaHome = javaHome + File.separator;
 776 |                 }
 777 | 
 778 |                 String javaPath;
 779 |                 String os = System.getProperty("os.name").toLowerCase();
 780 |                 if (os.contains("win")) {
 781 |                     javaPath = javaHome + "bin" + File.separator + "javaw.exe";
 782 |                 } else {
 783 |                     javaPath = javaHome + "bin" + File.separator + "java";
 784 |                 }
 785 | 
 786 |                 String jarString = new File(jarLocation).getAbsolutePath();
 787 | 
 788 |                 launchString = List.of(javaPath, "-jar", jarString);
 789 |             } else {
 790 |                 log.error("Runtime type is .jar but JAVA_HOME is not set. Cannot restart program if necessary.");
 791 |             }
 792 |         }
 793 | 
 794 |         if (launchString == null || launchString.isEmpty()) {
 795 |             return null;
 796 |         }
 797 | 
 798 |         log.debug("Launching from {}", launchString);
 799 | 
 800 |         return launchString;
 801 |     }
 802 | 
 803 |     /**
 804 |      * Toggles the status of automatic startup
 805 |      *
 806 |      * Currently only Windows is implemented, the Auto Start option
 807 |      * is not present in the tray menu if not running under Windows.
 808 |      */
 809 |     private boolean checkStartupStatusAndToggle() {
 810 |         try {
 811 |             List<String> launchString = getLaunchCommand();
 812 | 
 813 |             log.debug("Launch command is: {}", launchString);
 814 | 
 815 |             if (launchString == null || launchString.isEmpty()) {
 816 |                 log.error("Cannot locate runtime binary.");
 817 |                 return false;
 818 |             }
 819 | 
 820 |             ProcessBuilder checkBuilder = new ProcessBuilder("reg", "query",
 821 |                 "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run",
 822 |                 "/v", REGISTRY_APP_NAME);
 823 | 
 824 |             Process checkProcess = checkBuilder.start();
 825 |             checkProcess.waitFor();
 826 | 
 827 |             int checkExitValue = checkProcess.exitValue();
 828 | 
 829 |             log.debug("Check startup status: {}", checkExitValue);
 830 | 
 831 |             if (checkExitValue == 0) {
 832 |                 ProcessBuilder deleteBuilder = new ProcessBuilder("reg", "delete",
 833 |                     "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run",
 834 |                     "/v", REGISTRY_APP_NAME, "/f");
 835 | 
 836 |                 Process updateProcess = deleteBuilder.start();
 837 |                 updateProcess.waitFor();
 838 | 
 839 |                 if (config.isDebugMode()) {
 840 |                     int updateExitValue = updateProcess.exitValue();
 841 |                     if (updateExitValue == 0) {
 842 |                         log.info("Startup entry updated successfully.");
 843 |                     } else {
 844 |                         log.error("Failed to update startup entry.");
 845 |                     }
 846 |                 }
 847 | 
 848 |                 return false;
 849 |             } else {
 850 |                 List<String> regArgs = new ArrayList<>(List.of("reg", "add",
 851 |                     "HKCU\\Software\\Microsoft\\Windows\\CurrentVersion\\Run",
 852 |                     "/v", REGISTRY_APP_NAME,
 853 |                     "/t", "REG_SZ",
 854 |                     "/d"));
 855 | 
 856 |                 List<String> programArgs = new ArrayList<>(launchString);
 857 |                 programArgs.add("--no-gui");
 858 | 
 859 |                 StringBuilder builder = new StringBuilder();
 860 |                 builder.append("\"");
 861 | 
 862 |                 for (String arg : programArgs) {
 863 |                     if (arg.contains(File.separator)) {
 864 |                         builder.append("\\\"").append(arg).append("\\\"").append(" ");
 865 |                     } else {
 866 |                         builder.append(arg).append(" ");
 867 |                     }
 868 |                 }
 869 | 
 870 |                 if (builder.charAt(builder.length() - 1) == ' ') {
 871 |                     builder.deleteCharAt(builder.length() - 1);
 872 |                 }
 873 | 
 874 |                 builder.append("\"");
 875 | 
 876 |                 regArgs.add(builder.toString());
 877 |                 regArgs.add("/f");
 878 | 
 879 |                 ProcessBuilder createBuilder = new ProcessBuilder(regArgs);
 880 | 
 881 |                 Process process = createBuilder.start();
 882 |                 int exitCode = process.waitFor();
 883 | 
 884 |                 if (config.isDebugMode()) {
 885 |                     log.info("Program args: {}", programArgs);
 886 |                     log.info("Startup command args: {}", regArgs);
 887 | 
 888 |                     if (exitCode == 0) {
 889 |                         log.info("Registry entry added successfully.");
 890 |                     } else {
 891 |                         log.error("Failed to add registry entry. Exit code: {} Command list: {}",
 892 |                             exitCode, createBuilder.command());
 893 |                     }
 894 |                 }
 895 | 
 896 |                 return true;
 897 |             }
 898 |         } catch (Exception e) {
 899 |             handleException(e);
 900 |             return false;
 901 |         }
 902 |     }
 903 | 
 904 |     /**
 905 |      * Flushes current lines to disk, even if they are not finished,
 906 |      * and closes the current log file.
 907 |      *
 908 |      * This method is called before exit or when the CC window goes away.
 909 |      */
 910 |     private void closeLogger() {
 911 |         synchronized (lastLines) {
 912 |             while (!lastLines.isEmpty()) {
 913 |                 String oldestEntry = lastLines.remove(0);
 914 | 
 915 |                 if (!oldestEntry.equals(lastPrintedLine)) {
 916 |                     lastPrintedLine = oldestEntry;
 917 |                     logToFile(oldestEntry);
 918 |                 }
 919 |             }
 920 | 
 921 |             currentFile = null;
 922 |             lastPrintedLine = "";
 923 |         }
 924 |     }
 925 | 
 926 |     /**
 927 |      * Filters out non-white pixels for better visibility,
 928 |      * This is specifically tailored for white text.
 929 |      */
 930 |     private BufferedImage filterWhite(BufferedImage image) {
 931 |         if (config.isContrastMode()) {
 932 |             BufferedImage result = new BufferedImage(image.getWidth(), image.getHeight(), BufferedImage.TYPE_INT_RGB);
 933 |             Graphics g = result.getGraphics();
 934 |             g.drawImage(image, 0, 0, null);
 935 |             g.dispose();
 936 | 
 937 |             ColorConvertOp colorConvert = new ColorConvertOp(ColorSpace.getInstance(ColorSpace.CS_GRAY), null);
 938 |             colorConvert.filter(result, result);
 939 | 
 940 |             int threshold = 180;
 941 |             int[] pixels = result.getRGB(0, 0, result.getWidth(), result.getHeight(), null, 0, result.getWidth());
 942 |             for (int i = 0; i < pixels.length; i++) {
 943 |                 int alpha = (pixels[i] >> 24) & 0xFF;
 944 |                 int red = (pixels[i] >> 16) & 0xFF;
 945 |                 int green = (pixels[i] >> 8) & 0xFF;
 946 |                 int blue = pixels[i] & 0xFF;
 947 | 
 948 |                 int gray = (red + green + blue) / 3;
 949 |                 int color = (gray < threshold) ? 0x000000 : 0xFFFFFF;
 950 | 
 951 |                 pixels[i] = (alpha << 24) | color;
 952 |             }
 953 | 
 954 |             result.setRGB(0, 0, result.getWidth(), result.getHeight(), pixels, 0, result.getWidth());
 955 |             return result;
 956 |         } else {
 957 |             return image;
 958 |         }
 959 |     }
 960 | 
 961 |     /**
 962 |      * Ignore capturing if we aren't seeing the caption box
 963 |      *
 964 |      * This method checks if all four corners of the selected
 965 |      * screen area are darker than the set RGB threshold.
 966 |      */
 967 |     private boolean inCaptionBox(BufferedImage image) {
 968 |         if (config.isCaptureAnyText()) {// Results might not be the best, toggle contrast mode on and do NOT select the whole screen unless you have a really good CPU
 969 |             return true;
 970 |         }
 971 | 
 972 |         List<Integer> corners = Arrays.asList(
 973 |             image.getRGB(0, 0),
 974 |             image.getRGB(image.getWidth() - 1, 0),
 975 |             image.getRGB(0, image.getHeight() - 1),
 976 |             image.getRGB(image.getWidth() - 1, image.getHeight() - 1)
 977 |         );
 978 | 
 979 |         return corners.stream().allMatch((colour) -> {
 980 |             int red = (colour >> 16) & 0xFF;
 981 |             int green = (colour >> 8) & 0xFF;
 982 |             int blue = colour & 0xFF;
 983 | 
 984 |             if (config.isDebugMode()) {
 985 |                 log.debug("Corner RGB: " + red + ":" + green + ":" + blue);
 986 |             }
 987 | 
 988 |             int threshold = config.getCaptionWindowColorThreshold();
 989 | 
 990 |             return red <= threshold && green <= threshold && blue <= threshold;// All mostly black! seems to vary a bit. This has to be tweaked if not black & white
 991 |         });
 992 |     }
 993 | 
 994 |     /**
 995 |      * Logs finished lines to disk.
 996 |      */
 997 |     private void logToFile(String line) {
 998 |         if (config.isDebugMode()) {
 999 |             log.info("Line Finished: " + line);
1000 |         }
1001 | 
1002 |         if (currentFile == null) {
1003 |             Calendar now = Calendar.getInstance();
1004 | 
1005 |             File file = getOrCreateOutputDirectory();
1006 | 
1007 |             currentFile = new File(file, "LiveCaptions_" + FORMATTER.format(now.getTime()) + ".txt");
1008 |         }
1009 | 
1010 |         // Open and close immediatelly so we don't keep a lock on the file
1011 |         try (FileWriter fw = new FileWriter(currentFile, true);
1012 |              PrintWriter pw = new PrintWriter(fw)) {
1013 |             pw.println(line);
1014 |         } catch (IOException e) {// Shenanigans happened
1015 |             handleException(e);
1016 |         }
1017 |     }
1018 | 
1019 |     /**
1020 |      * Retrieves, or if it does not exist, creates an output directory
1021 |      * for the logger and debug images.
1022 |      */
1023 |     private File getOrCreateOutputDirectory() {
1024 |         File file;
1025 |         if (!config.getOutputPath().isEmpty()) {
1026 |             file = new File(config.getOutputPath());
1027 |         } else {
1028 |             file = new File(getDocumentsPath(), "LiveCaptions");
1029 |         }
1030 | 
1031 |         if (!file.exists()) {
1032 |             file.mkdirs();
1033 |         }
1034 | 
1035 |         return file;
1036 |     }
1037 | 
1038 |     private static File _cachedWorkDir;
1039 | 
1040 |     /**
1041 |      * Retrieves the default save path for log and configuration files.
1042 |      *
1043 |      * @return File
1044 |      */
1045 |     public static File getWorkDirectory() {
1046 |         if (_cachedWorkDir == null) {
1047 |             Path appDir;
1048 | 
1049 |             String os = System.getProperty("os.name").toLowerCase();
1050 |             String userHome = System.getProperty("user.home");
1051 | 
1052 |             if (os.contains("win")) {
1053 |                 String appData = System.getenv("APPDATA");
1054 | 
1055 |                 if (appData != null) {
1056 |                     appDir = Paths.get(appData, REGISTRY_APP_NAME);
1057 |                 } else {
1058 |                     appDir = Paths.get(userHome, "AppData", "Roaming", REGISTRY_APP_NAME);
1059 |                 }
1060 |             } else if (os.contains("mac")) {
1061 |                 appDir = Paths.get(userHome, "Library", "Application Support", REGISTRY_APP_NAME);
1062 |             } else {
1063 |                 appDir = Paths.get(userHome, "." + REGISTRY_APP_NAME.toLowerCase());
1064 |             }
1065 | 
1066 |             _cachedWorkDir = appDir.toFile();
1067 | 
1068 |             if (!_cachedWorkDir.exists()) {
1069 |                 _cachedWorkDir.mkdirs();
1070 |             }
1071 |         }
1072 | 
1073 |         return _cachedWorkDir;
1074 |     }
1075 | 
1076 |     /**
1077 |      * Returns the Documents path used as default save location.
1078 |      */
1079 |     private String getDocumentsPath() {
1080 |         return System.getProperty("user.home") + File.separator + "Documents";
1081 |     }
1082 | 
1083 |     public final void handleException(Throwable e) {
1084 |         handleException(e, true);
1085 |     }
1086 | 
1087 |     /**
1088 |      * Just some rudimentary exception handling.
1089 |      */
1090 |     public final void handleException(Throwable e, boolean displayToUser) {
1091 |         log.error("An exception has been caught", e);
1092 | 
1093 |         if (displayToUser && trayIcon != null) {
1094 |             trayIcon.displayMessage(REGISTRY_APP_NAME,
1095 |                 "An error occurred: " + e.getLocalizedMessage(), TrayIcon.MessageType.INFO);
1096 |         }
1097 |     }
1098 | 
1099 |     /**
1100 |      * In Java 21 we finally don't need to bring this method to every program we build.
1101 |      *
1102 |      * @see Math.clamp(int, int, int)
1103 |      */
1104 |     public static int clamp(int value, int min, int max) {
1105 |         return Math.max(min, Math.min(value, max));
1106 |     }
1107 | 
1108 |     /**
1109 |      * Checks if the current platform is Windows.
1110 |      *
1111 |      * This is used to filter out Windows-specific features when
1112 |      * running the program on other platforms.
1113 |      *
1114 |      * This program can run in other OSs for capturing captions other than
1115 |      * Windows 11's LiveCaptions such as Youtube's.
1116 |      */
1117 |     public static boolean isWindows() {
1118 |         String osName = System.getProperty("os.name").toLowerCase();
1119 |         return osName.contains("windows");
1120 |     }
1121 | 
1122 |     /**
1123 |      * Checks if the current platform is Windows 11.
1124 |      *
1125 |      * This method verifies if the version is 10.0.22000 or higher,
1126 |      * which indicates Windows 11
1127 |      */
1128 |     public static boolean isWindows11() {
1129 |         String osName = System.getProperty("os.name").toLowerCase();
1130 |         String osVersion = System.getProperty("os.version").toLowerCase();
1131 | 
1132 |         if (osName.contains("win")) {
1133 |             if (osVersion.startsWith("10.0")) {// Yes, 10. ¯\_(ツ)_/¯
1134 |                 String[] versionParts = osVersion.split("\\.");
1135 | 
1136 |                 if (versionParts.length > 2 && Integer.parseInt(versionParts[2]) >= 22000) {
1137 |                     return true;
1138 |                 }
1139 |             }
1140 |         }
1141 | 
1142 |         return false;
1143 |     }
1144 | 
1145 |     public static void main(String[] args) {
1146 |         if (SystemTray.isSupported()) {
1147 |             log.info("Starting...");
1148 | 
1149 |             try {
1150 |                 UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
1151 |             } catch (Exception e) {
1152 |                 // Default to Java's look and feel
1153 |             }
1154 | 
1155 |             LiveCaptionsLogger instance = new LiveCaptionsLogger();
1156 |             log.info("Started");
1157 | 
1158 |             Thread.setDefaultUncaughtExceptionHandler((Thread t, Throwable e) -> {
1159 |                 instance.handleException(e);
1160 |             });
1161 |         } else {
1162 |             log.error("System tray not supported???? did you run this on a calculator?");
1163 |         }
1164 |     }
1165 | }
1166 | 


--------------------------------------------------------------------------------