chore: Deprecate setStartOffset and move readAtNativeFrameRate

Author: Euklios

src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegInputBuilder.java

@@ -10,6 +10,8 @@
 public abstract class AbstractFFmpegInputBuilder<T extends AbstractFFmpegInputBuilder<T>> extends AbstractFFmpegStreamBuilder<T> {
     private final FFmpegProbeResult probeResult;
 
+    private boolean readAtNativeFrameRate;
+
     public AbstractFFmpegInputBuilder() {
         this(null, null);
     }
@@ -25,6 +27,11 @@ public AbstractFFmpegInputBuilder(FFmpegBuilder parent, FFmpegProbeResult probeR
         this.probeResult = probeResult;
     }
 
+    public T readAtNativeFrameRate() {
+        this.readAtNativeFrameRate = true;
+        return getThis();
+    }
+
     public FFmpegProbeResult getProbeResult() {
         return probeResult;
     }
@@ -54,5 +61,14 @@ protected List<String> build(FFmpegBuilder parent, int pass) {
         return args.build();
     }
 
+    @Override
+    protected void addGlobalFlags(FFmpegBuilder parent, ImmutableList.Builder<String> args) {
+        if (this.readAtNativeFrameRate) {
+            args.add("-re");
+        }
+
+        super.addGlobalFlags(parent, args);
+    }
+
     protected abstract List<String> buildInputString();
 }

src/main/java/net/bramp/ffmpeg/builder/FFmpegBuilder.java

@@ -125,6 +125,12 @@ public FFmpegBuilder setUserAgent(String userAgent) {
     return this;
   }
 
+  /**
+   * Makes ffmpeg read the first input at the native frame read
+   * @return this
+   * @deprecated Use {@link AbstractFFmpegInputBuilder#readAtNativeFrameRate()} instead
+   */
+  @Deprecated
   public FFmpegBuilder readAtNativeFrameRate() {
     this.read_at_native_frame_rate = true;
     return this;
@@ -184,12 +190,26 @@ public FFmpegBuilder setThreads(int threads) {
     return this;
   }
 
+  /**
+   * Sets the format for the first input stream
+   * @param format
+   * @return this
+   * @deprecated Specify this option on an input stream using {@link AbstractFFmpegStreamBuilder#setFormat(String)}
+   */
   @Deprecated
   public FFmpegBuilder setFormat(String format) {
     this.format = checkNotNull(format);
     return this;
   }
 
+  /**
+   * Sets the start offset for the first input stream
+   * @param duration
+   * @param units
+   * @return this
+   * @deprecated Specify this option on an input or output stream using {@link AbstractFFmpegStreamBuilder#setStartOffset(long, TimeUnit)}
+   */
+  @Deprecated
   public FFmpegBuilder setStartOffset(long duration, TimeUnit units) {
     checkNotNull(units);
 
@@ -208,6 +228,7 @@ public FFmpegBuilder addProgress(URI uri) {
    *
    * @param filter the complex filter string
    * @return this
+   * @deprecated Use {@link AbstractFFmpegOutputBuilder#setComplexFilter(String)} instead
    */
   @Deprecated
   public FFmpegBuilder setComplexFilter(String filter) {
@@ -353,6 +374,7 @@ public List<String> build() {
     }
 
     if (startOffset != null) {
+      log.warn("Using FFmpegBuilder#setStartOffset is deprecated. Specify it on the inputStream or outputStream instead");
       args.add("-ss", FFmpegUtils.toTimecode(startOffset, TimeUnit.MILLISECONDS));
     }
 
@@ -366,6 +388,7 @@ public List<String> build() {
     }
 
     if (read_at_native_frame_rate) {
+      log.warn("Using FFmpegBuilder#readAtNativeFrameRate is deprecated. Specify it on the inputStream instead");
       args.add("-re");
     }
 

src/test/java/net/bramp/ffmpeg/ExamplesTest.java

@@ -45,9 +45,9 @@ public void testExample1() throws IOException {
         new FFmpegBuilder()
             .addExtraArgs("-rtbufsize", "1500M")
             .addExtraArgs("-re")
-            .setFormat("dshow")
             .setInput(
                 "video=\"Microsoft Camera Rear\":audio=\"Microphone Array (Realtek High Definition Audio(SST))\"")
+            .setFormat("dshow")
             .done()
             .addOutput("rtmp://a.rtmp.youtube.com/live2/1234-5678")
             .setFormat("flv")
@@ -69,7 +69,7 @@ public void testExample1() throws IOException {
 
     String expected =
         "ffmpeg\\win64\\bin\\ffmpeg.exe -y -v error"
-            + " -f dshow -rtbufsize 1500M -re"
+            + " -rtbufsize 1500M -re -f dshow"
             + " -i video=\"Microsoft Camera Rear\":audio=\"Microphone Array (Realtek High Definition Audio(SST))\""
             + " -f flv"
             + " -vcodec libx264 -pix_fmt yuv420p -s 426x240 -r 30/1 -b:v 2000000"

src/test/java/net/bramp/ffmpeg/FFmpegExecutorTest.java

@@ -220,8 +220,8 @@ public void testProgress() throws InterruptedException, ExecutionException, IOEx
 
     FFmpegBuilder builder =
         new FFmpegBuilder()
-            .readAtNativeFrameRate() // Slows the test down
             .setInput(in)
+            .readAtNativeFrameRate() // Slows the test down
             .done()
             .overrideOutputFiles(true)
             .addOutput(Samples.output_mp4)

src/test/java/net/bramp/ffmpeg/InputOutputTest.java

@@ -0,0 +1,133 @@
+package net.bramp.ffmpeg;
+
+import com.google.common.collect.ImmutableList;
+import net.bramp.ffmpeg.builder.FFmpegBuilder;
+import net.bramp.ffmpeg.lang.NewProcessAnswer;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+import static net.bramp.ffmpeg.FFmpegTest.argThatHasItem;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.core.Is.is;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class InputOutputTest {
+    @Mock
+    ProcessFunction runFunc;
+
+    FFmpeg ffmpeg;
+
+    @Before
+    public void before() throws IOException {
+        when(runFunc.run(argThatHasItem("-version")))
+                .thenAnswer(new NewProcessAnswer("avconv-version"));
+
+        ffmpeg = new FFmpeg(runFunc);
+    }
+
+    @Test
+    public void setInputFormat() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .setFormat("mp4")
+                .done()
+                .addOutput("output.mp4")
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-f", "mp4", "-i", "input.mp4", "output.mp4")));
+    }
+
+    @Test
+    public void setInputFormatMultiple() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .setFormat("mp4")
+                .done()
+                .addInput("input.mkv")
+                .setFormat("matroschka")
+                .done()
+                .addOutput("output.mp4")
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-f", "mp4", "-i", "input.mp4", "-f", "matroschka", "-i", "input.mkv", "output.mp4")));
+    }
+
+    @Test
+    public void setStartOffsetOnInput() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .setStartOffset(10, TimeUnit.SECONDS)
+                .done()
+                .addOutput("output.mp4")
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-ss", "00:00:10", "-i", "input.mp4", "output.mp4")));
+    }
+
+    @Test
+    public void setStartOffsetOnOutput() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .done()
+                .addOutput("output.mp4")
+                .setStartOffset(10, TimeUnit.SECONDS)
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-i", "input.mp4", "-ss", "00:00:10", "output.mp4")));
+    }
+
+    @Test
+    public void setStartOffsetOnInputAndOutput() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .setStartOffset(1, TimeUnit.SECONDS)
+                .done()
+                .addOutput("output.mp4")
+                .setStartOffset(10, TimeUnit.SECONDS)
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-ss", "00:00:01", "-i", "input.mp4", "-ss", "00:00:10", "output.mp4")));
+    }
+
+    @Test
+    public void readAtNativeFrameRate() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .readAtNativeFrameRate()
+                .done()
+                .addOutput("output.mp4")
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-re", "-i", "input.mp4", "output.mp4")));
+    }
+
+    @Test
+    public void readAtNativeFrameRateMultiple() {
+        List<String> command = new FFmpegBuilder()
+                .addInput("input.mp4")
+                .readAtNativeFrameRate()
+                .done()
+                .addInput("input.mkv")
+                .readAtNativeFrameRate()
+                .done()
+                .addOutput("output.mp4")
+                .done()
+                .build();
+
+        assertThat(command, is(ImmutableList.of("-y", "-v", "error", "-re", "-i", "input.mp4", "-re", "-i", "input.mkv", "output.mp4")));
+    }
+}