Frame static factory methods, remove some todos

kokorin · kokorin · commit 8b9bc01c935f · 2021-04-13T08:24:06.000+03:00
diff --git a/README.md b/README.md
@@ -265,7 +265,7 @@ FrameProducer producer = new FrameProducer() {
         graphics.setPaint(new Color(frameCounter * 1.0f / 30, 0, 0));
         graphics.fillRect(0, 0, 320, 240);
         long pts = frameCounter * 1000 / 10; // Frame PTS in Stream Timebase
-        Frame videoFrame = new Frame(0, pts, image);
+        Frame videoFrame = Frame.createVideoFrame(0, pts, image);
         frameCounter++;
 
         return videoFrame;
diff --git a/src/main/java/com/github/kokorin/jaffree/ffmpeg/CaptureInput.java b/src/main/java/com/github/kokorin/jaffree/ffmpeg/CaptureInput.java
@@ -106,7 +106,6 @@ public CaptureInput<T> setCaptureVideoSize(String size) {
      */
     public abstract CaptureInput<T> setCaptureCursor(boolean captureCursor);
 
-    // TODO check static method references
     public static CaptureInput<?> captureDesktop() {
         CaptureInput<?> result = null;
         if (OS.IS_LINUX) {
diff --git a/src/main/java/com/github/kokorin/jaffree/ffmpeg/FFmpeg.java b/src/main/java/com/github/kokorin/jaffree/ffmpeg/FFmpeg.java
@@ -411,8 +411,6 @@ protected StdReader<FFmpegResult> createStdErrReader(OutputListener outputListen
      * @return this
      */
     protected StdReader<FFmpegResult> createStdOutReader() {
-        // TODO ffmpeg normally doesn't write to Std OUT, stdOutReader should throw an error
-        // if it reads any byte
         return new LoggingStdReader<>();
     }
 
diff --git a/src/main/java/com/github/kokorin/jaffree/ffmpeg/FFmpegResultFuture.java b/src/main/java/com/github/kokorin/jaffree/ffmpeg/FFmpegResultFuture.java
@@ -111,12 +111,10 @@ public FFmpegResult get(long timeout, TimeUnit unit) throws InterruptedException
         return resultFuture.get(timeout, unit);
     }
 
-    // TODO check if required or replace with more suitable method
     public boolean isCancelled() {
         return resultFuture.isCancelled();
     }
 
-    // TODO check if required or replace with more suitable method
     public boolean isDone() {
         return resultFuture.isDone();
     }
diff --git a/src/main/java/com/github/kokorin/jaffree/ffmpeg/Frame.java b/src/main/java/com/github/kokorin/jaffree/ffmpeg/Frame.java
@@ -32,32 +32,6 @@ public class Frame {
     private final BufferedImage image;
     private final int[] samples;
 
-    /**
-     * Creates video {@link Frame}, samples are set to null.
-     *
-     * @param streamId stream id (starting with 0)
-     * @param pts      pts in {@link Stream} timebase
-     * @param image    video frame image
-     * @see Stream#getTimebase()
-     */
-    // TODO make static method
-    public Frame(final int streamId, final long pts, final BufferedImage image) {
-        this(streamId, pts, image, null);
-    }
-
-    /**
-     * Creates audio {@link Frame}, image is set to null.
-     *
-     * @param streamId streamId
-     * @param pts      pts in {@link Stream} timebase
-     * @param samples  audio samples in PCM S32BE format
-     * @see Stream#getTimebase()
-     */
-    // TODO make static method
-    public Frame(final int streamId, final long pts, final int[] samples) {
-        this(streamId, pts, null, samples);
-    }
-
     /**
      * Creates {@link Frame}.
      *
@@ -67,7 +41,7 @@ public Frame(final int streamId, final long pts, final int[] samples) {
      * @param samples  audio samples in PCM S32BE format
      * @see Stream#getTimebase()
      */
-    public Frame(final int streamId, final long pts, final BufferedImage image,
+    protected Frame(final int streamId, final long pts, final BufferedImage image,
                  final int[] samples) {
         if (image != null && samples != null) {
             throw new IllegalArgumentException(
@@ -133,4 +107,29 @@ public String toString() {
                 + ", samples?=" + (samples != null)
                 + '}';
     }
+
+    /**
+     * Creates video {@link Frame}, samples are set to null.
+     *
+     * @param streamId stream id (starting with 0)
+     * @param pts      pts in {@link Stream} timebase
+     * @param image    video frame image
+     * @see Stream#getTimebase()
+     */
+    public static Frame createVideoFrame(final int streamId, final long pts, final BufferedImage image) {
+        return new Frame(streamId, pts, image, null);
+    }
+
+    /**
+     * Creates audio {@link Frame}, image is set to null.
+     *
+     * @param streamId streamId
+     * @param pts      pts in {@link Stream} timebase
+     * @param samples  audio samples in PCM S32BE format
+     * @see Stream#getTimebase()
+     */
+    public static Frame createAudioFrame(final int streamId, final long pts, final int[] samples) {
+        return new Frame(streamId, pts, null, samples);
+    }
+
 }
diff --git a/src/main/java/com/github/kokorin/jaffree/ffmpeg/NutFrameWriter.java b/src/main/java/com/github/kokorin/jaffree/ffmpeg/NutFrameWriter.java
@@ -198,7 +198,6 @@ private void write(final NutWriter writer) throws IOException {
 
                 case AUDIO:
                     data = new byte[frame.getSamples().length * 4];
-                    // TODO check number of samples provided
                     ByteBuffer.wrap(data).asIntBuffer().put(frame.getSamples());
                     break;
 
diff --git a/src/main/java/com/github/kokorin/jaffree/nut/DataItem.java b/src/main/java/com/github/kokorin/jaffree/nut/DataItem.java
@@ -60,7 +60,6 @@
 public class DataItem {
     public final String name;
     public final Object value;
-    // TODO: introduce type enum?
     public final String type;
 
     /**
diff --git a/src/main/java/com/github/kokorin/jaffree/process/LoggingStdReader.java b/src/main/java/com/github/kokorin/jaffree/process/LoggingStdReader.java
@@ -40,13 +40,10 @@ public class LoggingStdReader<T> implements StdReader<T> {
      */
     @Override
     public T read(final InputStream stdOut) {
-        // TODO use line iterator?
         BufferedReader reader = new BufferedReader(new InputStreamReader(stdOut));
 
         try {
             String line;
-            // TODO log message with the same logging level
-            // for example if message starts with [DEBUG] output it to debug.
             while ((line = reader.readLine()) != null) {
                 LOGGER.info(line);
             }
diff --git a/src/main/java/com/github/kokorin/jaffree/util/LineIterator.java b/src/main/java/com/github/kokorin/jaffree/util/LineIterator.java
@@ -27,7 +27,6 @@
 /**
  * Adapts {@link BufferedReader} to line {@link Iterator}.
  */
-// TODO: move to util package
 public class LineIterator implements Iterator<String> {
     private final BufferedReader reader;
     private String nextLine = null;
diff --git a/src/test/java/com/github/kokorin/jaffree/ffmpeg/FrameIOTest.java b/src/test/java/com/github/kokorin/jaffree/ffmpeg/FrameIOTest.java
@@ -270,10 +270,10 @@ public Frame produce() {
                 }
 
                 if (videoPts <= audioPts) {
-                    return new Frame(0, videoPts++, flag);
+                    return Frame.createVideoFrame(0, videoPts++, flag);
                 }
 
-                return new Frame(1, audioPts++, samples);
+                return Frame.createAudioFrame(1, audioPts++, samples);
             }
         };
 
@@ -406,10 +406,10 @@ public Frame produce() {
                 }
 
                 if (videoPts <= audioPts) {
-                    return new Frame(0, videoPts++, redCross);
+                    return Frame.createVideoFrame(0, videoPts++, redCross);
                 }
 
-                return new Frame(1, audioPts++, samples);
+                return Frame.createAudioFrame(1, audioPts++, samples);
             }
         };
 
@@ -504,7 +504,6 @@ private void testNutGenerationAndConsumption(final int duration, final int fps,
 
         final AtomicReference<FFmpegProgress> progressRef = new AtomicReference<>();
 
-        // TODO: convert outputPath to MP4 with ffmpeg and check how long will it take
         FFmpeg.atPath(BIN)
                 .addInput(FrameInput.withProducer(
                         new FrameProducer() {
@@ -546,7 +545,7 @@ public Frame produce() {
                                     lastSecond = currentSecond;
                                 }
 
-                                Frame result = new Frame(0, frame * timebase / fps, image);
+                                Frame result = Frame.createVideoFrame(0, frame * timebase / fps, image);
                                 frame++;
 
                                 return result;
diff --git a/src/test/java/examples/BouncingBallExample.java b/src/test/java/examples/BouncingBallExample.java
@@ -125,7 +125,7 @@ public Frame produce() {
                     graphics.setPaint(ballColor);
                     graphics.fillOval(ballCenterX - BALL_RADIUS, ballCenterY - BALL_RADIUS, BALL_RADIUS * 2, BALL_RADIUS * 2);
 
-                    Frame videoFrame = new Frame(0, nextVideoTimecode, image);
+                    Frame videoFrame = Frame.createVideoFrame(0, nextVideoTimecode, image);
 
                     if (collisionVideoTimecode <= nextVideoTimecode) {
                         Random random = new Random();
@@ -152,7 +152,7 @@ public Frame produce() {
                     }
 
 
-                    Frame audioFrame = new Frame(1, nextAudioTimecode, samples);
+                    Frame audioFrame = Frame.createAudioFrame(1, nextAudioTimecode, samples);
 
                     nextAudioTimecode += 1000 / FPS;
                     return audioFrame;
diff --git a/src/test/java/examples/MosaicExample.java b/src/test/java/examples/MosaicExample.java
@@ -235,7 +235,7 @@ public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, in
                     return null;
                 }
 
-                Frame result = new Frame(0, nextVideoFrameTimecode, mosaic);
+                Frame result = Frame.createVideoFrame(0, nextVideoFrameTimecode, mosaic);
 
                 nextVideoFrameTimecode += videoFrameDuration;
 
@@ -273,7 +273,7 @@ private Frame produceAudioFrame() {
                 if (aFrame == null) {
                     return null;
                 }
-                aFrame = new Frame(1 + minI, aFrame.getPts(), aFrame.getSamples());
+                aFrame = Frame.createAudioFrame(1 + minI, aFrame.getPts(), aFrame.getSamples());
 
                 if (nextPts != Long.MAX_VALUE) {
                     nextAudioFrameTimecode = 1000L * nextPts / sampleRate;
diff --git a/src/test/java/examples/ProduceVideoExample.java b/src/test/java/examples/ProduceVideoExample.java
@@ -54,7 +54,7 @@ public Frame produce() {
                 graphics.setPaint(new Color(frameCounter * 1.0f / 30, 0, 0));
                 graphics.fillRect(0, 0, 320, 240);
                 long pts = frameCounter * 1000 / 10; // Frame PTS in Stream Timebase
-                Frame videoFrame = new Frame(0, pts, image);
+                Frame videoFrame = Frame.createVideoFrame(0, pts, image);
                 frameCounter++;
 
                 return videoFrame;

Original file line number	Diff line number	Diff line change
`@@ -411,8 +411,6 @@ protected StdReader<FFmpegResult> createStdErrReader(OutputListener outputListen`
`411`	`411`	`* @return this`
`412`	`412`	`*/`
`413`	`413`	`protected StdReader<FFmpegResult> createStdOutReader() {`
`414`		`- // TODO ffmpeg normally doesn't write to Std OUT, stdOutReader should throw an error`
`415`		`- // if it reads any byte`
`416`	`414`	`return new LoggingStdReader<>();`
`417`	`415`	`}`
`418`	`416`
Original file line number	Diff line number	Diff line change
`@@ -111,12 +111,10 @@ public FFmpegResult get(long timeout, TimeUnit unit) throws InterruptedException`
`111`	`111`	`return resultFuture.get(timeout, unit);`
`112`	`112`	`}`
`113`	`113`
`114`		`- // TODO check if required or replace with more suitable method`
`115`	`114`	`public boolean isCancelled() {`
`116`	`115`	`return resultFuture.isCancelled();`
`117`	`116`	`}`
`118`	`117`
`119`		`- // TODO check if required or replace with more suitable method`
`120`	`118`	`public boolean isDone() {`
`121`	`119`	`return resultFuture.isDone();`
`122`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -270,10 +270,10 @@ public Frame produce() {`
`270`	`270`	`}`
`271`	`271`
`272`	`272`	`if (videoPts <= audioPts) {`
`273`		`- return new Frame(0, videoPts++, flag);`
	`273`	`+ return Frame.createVideoFrame(0, videoPts++, flag);`
`274`	`274`	`}`
`275`	`275`
`276`		`- return new Frame(1, audioPts++, samples);`
	`276`	`+ return Frame.createAudioFrame(1, audioPts++, samples);`
`277`	`277`	`}`
`278`	`278`	`};`
`279`	`279`
`@@ -406,10 +406,10 @@ public Frame produce() {`
`406`	`406`	`}`
`407`	`407`
`408`	`408`	`if (videoPts <= audioPts) {`
`409`		`- return new Frame(0, videoPts++, redCross);`
	`409`	`+ return Frame.createVideoFrame(0, videoPts++, redCross);`
`410`	`410`	`}`
`411`	`411`
`412`		`- return new Frame(1, audioPts++, samples);`
	`412`	`+ return Frame.createAudioFrame(1, audioPts++, samples);`
`413`	`413`	`}`
`414`	`414`	`};`
`415`	`415`
`@@ -504,7 +504,6 @@ private void testNutGenerationAndConsumption(final int duration, final int fps,`
`504`	`504`
`505`	`505`	`final AtomicReference<FFmpegProgress> progressRef = new AtomicReference<>();`
`506`	`506`
`507`		`- // TODO: convert outputPath to MP4 with ffmpeg and check how long will it take`
`508`	`507`	`FFmpeg.atPath(BIN)`
`509`	`508`	`.addInput(FrameInput.withProducer(`
`510`	`509`	`new FrameProducer() {`
`@@ -546,7 +545,7 @@ public Frame produce() {`
`546`	`545`	`lastSecond = currentSecond;`
`547`	`546`	`}`
`548`	`547`
`549`		`- Frame result = new Frame(0, frame * timebase / fps, image);`
	`548`	`+ Frame result = Frame.createVideoFrame(0, frame * timebase / fps, image);`
`550`	`549`	`frame++;`
`551`	`550`
`552`	`551`	`return result;`
Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ public boolean imageUpdate(Image img, int infoflags, int x, int y, int width, in`
`235`	`235`	`return null;`
`236`	`236`	`}`
`237`	`237`
`238`		`- Frame result = new Frame(0, nextVideoFrameTimecode, mosaic);`
	`238`	`+ Frame result = Frame.createVideoFrame(0, nextVideoFrameTimecode, mosaic);`
`239`	`239`
`240`	`240`	`nextVideoFrameTimecode += videoFrameDuration;`
`241`	`241`
`@@ -273,7 +273,7 @@ private Frame produceAudioFrame() {`
`273`	`273`	`if (aFrame == null) {`
`274`	`274`	`return null;`
`275`	`275`	`}`
`276`		`- aFrame = new Frame(1 + minI, aFrame.getPts(), aFrame.getSamples());`
	`276`	`+ aFrame = Frame.createAudioFrame(1 + minI, aFrame.getPts(), aFrame.getSamples());`
`277`	`277`
`278`	`278`	`if (nextPts != Long.MAX_VALUE) {`
`279`	`279`	`nextAudioFrameTimecode = 1000L * nextPts / sampleRate;`