Issue 355: Allow an application developer to override the default Exe…

…cutor Timeout value
kokorin · Sep 9, 2023 · 0d4817e · 0d4817e
1 parent 5cb4b57
commit 0d4817e
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 3 deletions.
diff --git a/src/main/java/com/github/kokorin/jaffree/ffmpeg/FFmpeg.java b/src/main/java/com/github/kokorin/jaffree/ffmpeg/FFmpeg.java
@@ -59,6 +59,7 @@ public class FFmpeg {
 
     private LogLevel logLevel = LogLevel.INFO;
     private String contextName = null;
+    private Integer executorTimeoutMillis = null;
 
     private final Path executable;
 
@@ -387,6 +388,23 @@ public FFmpeg setContextName(final String contextName) {
         return this;
     }
 
+    /**
+     * Overrides the default {@link com.github.kokorin.jaffree.process.Executor} timeout.
+     * <p>
+     * Most normal use cases will easily complete within the default timeout. It is not recommended
+     * to set an explicit timeout value unless you have actually experienced unwanted timeouts.
+     *
+     * @param executorTimeoutMillis the custom executor timeout in milliseconds
+     * @return this
+     */
+    public FFmpeg setExecutorTimeoutMillis(final int executorTimeoutMillis) {
+        if (executorTimeoutMillis < 0) {
+            throw new IllegalArgumentException("Executor timeout cannot be negative");
+        }
+        this.executorTimeoutMillis = executorTimeoutMillis;
+        return this;
+    }
+
     /**
      * Starts synchronous ffmpeg execution.
      * <p>
@@ -484,7 +502,8 @@ protected ProcessHandler<FFmpegResult> createProcessHandler() {
                 .setStdErrReader(createStdErrReader(outputListener))
                 .setStdOutReader(createStdOutReader())
                 .setHelpers(helpers)
-                .setArguments(buildArguments());
+                .setArguments(buildArguments())
+                .setExecutorTimeoutMillis(executorTimeoutMillis);
     }
 
     /**

diff --git a/src/main/java/com/github/kokorin/jaffree/process/ProcessHandler.java b/src/main/java/com/github/kokorin/jaffree/process/ProcessHandler.java
@@ -49,8 +49,9 @@ public class ProcessHandler<T> {
     private List<ProcessHelper> helpers = null;
     private Stopper stopper = null;
     private List<String> arguments = Collections.emptyList();
+    private int executorTimeoutMillis = DEFAULT_EXECUTOR_TIMEOUT_MILLIS;
 
-    private static final int EXECUTOR_TIMEOUT_MILLIS = 10_000;
+    private static final int DEFAULT_EXECUTOR_TIMEOUT_MILLIS = 10_000;
     private static final Logger LOGGER = LoggerFactory.getLogger(ProcessHandler.class);
 
     /**
@@ -120,6 +121,24 @@ public synchronized ProcessHandler<T> setArguments(final List<String> arguments)
         return this;
     }
 
+    /**
+     * Overrides the default Executor timeout.
+     * <p>
+     * A null value is interpreted as "use default timeout".
+     *
+     * @param executorTimeoutMillis the new Executor timeout in milliseconds
+     * @return this
+     */
+    public ProcessHandler<T> setExecutorTimeoutMillis(final Integer executorTimeoutMillis) {
+        if (executorTimeoutMillis != null) {
+            if (executorTimeoutMillis < 0) {
+                throw new IllegalArgumentException("Executor timeout cannot be negative");
+            }
+            this.executorTimeoutMillis = executorTimeoutMillis;
+        }
+        return this;
+    }
+
     /**
      * Executes a program.
      * <p>
@@ -180,7 +199,9 @@ protected T interactWithProcess(final Process process) {
             status = process.waitFor();
             LOGGER.info("Process has finished with status: {}", status);
 
-            waitForExecutorToStop(executor, EXECUTOR_TIMEOUT_MILLIS);
+            if (executorTimeoutMillis > 0) {
+                waitForExecutorToStop(executor, executorTimeoutMillis);
+            }
         } catch (InterruptedException e) {
             LOGGER.warn("Process has been interrupted");
             if (stopper != null) {