Readme & examples, fix build

Author: kokorin

README.md

@@ -1,6 +1,6 @@
 # Jaffree
 
-Jaffree stands for [Ja]va [ff]mpeg and [ff]probe [free] command line wrapper. Jaffree supports programmatic video production and consumption (with transparency)
+Jaffree stands for JAva FFmpeg and FFprobe FREE command line wrapper. Jaffree supports programmatic video production and consumption (with transparency)
 
 It integrates with ffmpeg via `java.lang.Process`.
 
@@ -40,7 +40,7 @@ Inspired by [ffmpeg-cli-wrapper](https://github.com/bramp/ffmpeg-cli-wrapper)
 
 ## Checking media streams with ffprobe
 
-See whole example [here](/src/test/java/examples/ffprobe/ShowStreams.java).
+See whole example [here](/src/test/java/examples/ShowStreamsExample.java).
 
 ```java
 FFprobeResult result = FFprobe.atPath()
@@ -59,7 +59,7 @@ for (Stream stream : result.getStreams()) {
 
 Sometimes ffprobe can't show exact duration, use ffmpeg trancoding to NULL output to get it.
 
-See whole example [here](/src/test/java/examples/ffmpeg/ExactDuration.java).
+See whole example [here](/src/test/java/examples/ExactDurationExample.java).
 
 ```java
 final AtomicLong durationMillis = new AtomicLong();
@@ -82,7 +82,7 @@ System.out.println("Exact duration: " + durationMillis.get() + " milliseconds");
 
 ## Re-encode and track progress
 
-See whole example [here](/src/test/java/examples/ffmpeg/ReEncode.java).
+See whole example [here](/src/test/java/examples/ReEncodeExample.java).
 
 ```java
 final AtomicLong duration = new AtomicLong();
@@ -116,7 +116,7 @@ FFmpeg.atPath()
 
 Pay attention that arguments related to Input must be set at Input, not at FFmpeg.
 
-See whole example [here](/src/test/java/examples/ffmpeg/CutAndScale.java).
+See whole example [here](/src/test/java/examples/CutAndScaleExample.java).
 
 ```java
 FFmpeg.atPath()
@@ -136,7 +136,7 @@ FFmpeg.atPath()
 
 ## Custom parsing of ffmpeg output
 
-See whole example [here](/src/test/java/examples/ffmpeg/ParsingOutput.java).
+See whole example [here](/src/test/java/examples/ParsingOutputExample.java).
 
 ```java
 // StringBuffer - because it's thread safe
@@ -162,7 +162,7 @@ System.out.println("Loudnorm report:\n" + loudnormReport);
 Ability to interact with SeekableByteChannel is one of the features, which distinct Jaffree from 
 similar libraries. Under the hood Jaffree uses tiny FTP server to interact with SeekableByteChannel.
 
-See whole example [here](/src/test/java/examples/ffmpeg/UsingChannels.java).
+See whole example [here](/src/test/java/examples/UsingChannelsExample.java).
 ```java
 try (SeekableByteChannel inputChannel =
          Files.newByteChannel(pathToSrc, StandardOpenOption.READ);
@@ -185,7 +185,7 @@ requires seekable output for many formats.
 
 Under the hood pipes are not OS pipes, but TCP Sockets. This allows much higher bandwidth.
 
-See whole example [here](/src/test/java/examples/ffmpeg/UsingStreams.java).
+See whole example [here](/src/test/java/examples/UsingStreamsExample.java).
 
 ```java
 try (InputStream inputStream =
@@ -204,13 +204,140 @@ try (InputStream inputStream =
 }
 ```
 
+## Screen Capture
+
+See whole example [here](/src/test/java/examples/ScreenCaptureExample.java).
+
+```java
+FFmpeg.atPath()
+    .addInput(CaptureInput
+            .captureDesktop()
+            .setCaptureFrameRate(30)
+            .setCaptureCursor(true)
+    )
+    .addOutput(UrlOutput
+            .toPath(pathToVideo)
+            // Record with ultrafast to lower CPU usage
+            .addArguments("-preset", "ultrafast")
+            .setDuration(30, TimeUnit.SECONDS)
+    )
+    .setOverwriteOutput(true)
+    .execute();
+
+//Re-encode when record is completed to optimize file size 
+Path pathToOptimized = pathToVideo.resolveSibling("optimized-" + pathToVideo.getFileName());
+FFmpeg.atPath()
+    .addInput(UrlInput.fromPath(pathToVideo))
+    .addOutput(UrlOutput.toPath(pathToOptimized))
+    .execute();
+
+Files.move(pathToOptimized, pathToVideo, StandardCopyOption.REPLACE_EXISTING);
+```
+
+## Produce Video in Pure Java Code
+
+See whole example [here](/src/test/java/examples/ProduceVideoExample.java). 
+Check also more [advanced example](/src/test/java/examples/BouncingBallExample.java) which produce 
+both audio and video 
+
+```java
+FrameProducer producer = new FrameProducer() {
+    private long frameCounter = 0;
+
+    @Override
+    public List<Stream> produceStreams() {
+        return Collections.singletonList(new Stream()
+                .setType(Stream.Type.VIDEO)
+                .setTimebase(1000L)
+                .setWidth(320)
+                .setHeight(240)
+        );
+    }
+
+    @Override
+    public Frame produce() {
+        if (frameCounter > 30) {
+            return null; // return null when End of Stream is reached
+        }
+
+        BufferedImage image = new BufferedImage(320, 240, BufferedImage.TYPE_3BYTE_BGR);
+        Graphics2D graphics = image.createGraphics();
+        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);
+        frameCounter++;
+
+        return videoFrame;
+    }
+};
+
+FFmpeg.atPath()
+    .addInput(FrameInput.withProducer(producer))
+    .addOutput(UrlOutput.toUrl(pathToVideo))
+    .execute();
+```
+
+Here is an output of the above example:
+
+![example output](/src/test/resources/examples/programmatic.gif)
+
+### Consume Video in Pure Java Code
+
+See whole example [here](/src/test/java/examples/ExtractFramesExample.java).
+
+```java
+FFmpeg.atPath()
+        .addInput(UrlInput
+                .fromPath(pathToSrc)
+        )
+        .addOutput(FrameOutput
+                .withConsumer(
+                        new FrameConsumer() {
+                            private long num = 1;
+
+                            @Override
+                            public void consumeStreams(List<Stream> streams) {
+                                // All stream type except video are disabled. just ignore
+                            }
+
+                            @Override
+                            public void consume(Frame frame) {
+                                // End of Stream
+                                if (frame == null) {
+                                    return;
+                                }
+
+                                try {
+                                    String filename = "frame_" + num++ + ".png";
+                                    Path output = pathToDstDir.resolve(filename);
+                                    ImageIO.write(frame.getImage(), "png", output.toFile());
+                                } catch (Exception e) {
+                                    e.printStackTrace();
+                                }
+                            }
+                        }
+                )
+                // No more then 100 frames
+                .setFrameCount(StreamType.VIDEO, 100L)
+                // 1 frame every 10 seconds
+                .setFrameRate(0.1)
+                // Disable all streams except video
+                .disableStream(StreamType.AUDIO)
+                .disableStream(StreamType.SUBTITLE)
+                .disableStream(StreamType.DATA)
+        )
+        .execute();
+```
+
+
 ## FFmpeg stop
 
-See whole examples [here](/src/test/java/examples/ffmpeg/Stop.java).
+See whole examples [here](/src/test/java/examples/StopExample.java).
 
 ### Grace stop
 
-Start ffmpeg with FFmpeg#executeAsync and stop it with FFmpegResultFuture#graceStop (ffmpeg only).
+Start ffmpeg with `FFmpeg#executeAsync` and stop it with `FFmpegResultFuture#graceStop` (ffmpeg only).
 This will pass `q` symbol to ffmpeg's stdin.
 
 **Note** output media finalization may take some time - up to several seconds.
@@ -222,38 +349,37 @@ Thread.sleep(5_000);
 future.graceStop();
 ```
 
-
 ### Force stop
 
 There are 3 ways to stop ffmpeg forcefully.
 
 **Note**: ffmpeg may not (depending on output format) correctly finalize output. 
 It's very likely that produced media will be corrupted with force stop.
 
-* Throw an exception in ProgressListener (ffmpeg only)
+* Throw an exception in `ProgressListener` (ffmpeg only)
 ```java
 final AtomicBoolean stopped = new AtomicBoolean();
 ffmpeg.setProgressListener(
         new ProgressListener() {
             @Override
             public void onProgress(FFmpegProgress progress) {
                 if (stopped.get()) {
-                    throw new RuntimeException("Stooped with exception!");
+                    throw new RuntimeException("Stopped with exception!");
                 }
             }
         }
 );
 ```
 
-* Start ffmpeg with FFmpeg#executeAsync and stop it with FFmpegResultFuture#forceStop (ffmpeg only)
+* Start ffmpeg with `FFmpeg#executeAsync` and stop it with `FFmpegResultFuture#forceStop` (ffmpeg only)
 ```java
 FFmpegResultFuture future = ffmpeg.executeAsync();
 
 Thread.sleep(5_000);
 future.forceStop();
 ```
 
-* Start ffmpeg with FFmpeg#execute (or ffprobe with FFprobe#execute) and interrupt thread
+* Start ffmpeg with `FFmpeg#execute` (or ffprobe with `FFprobe#execute`) and interrupt thread
 ```java
 Thread thread = new Thread() {
     @Override
@@ -267,9 +393,11 @@ Thread.sleep(5_000);
 thread.interrupt();
 ```
 
-## Complex filtergraph (mosaic video)
+## Complex Filtergraph (mosaic video)
+
+More details about this example can be found on ffmpeg wiki:
+[Create a mosaic out of several input videos](https://trac.ffmpeg.org/wiki/Create%20a%20mosaic%20out%20of%20several%20input%20videos)
 
-More details about this example can be found on ffmpeg wiki: [Create a mosaic out of several input videos](https://trac.ffmpeg.org/wiki/Create%20a%20mosaic%20out%20of%20several%20input%20videos)
 ```java
 FFmpegResult result = FFmpeg.atPath(BIN)
         .addInput(UrlInput.fromPath(VIDEO1_MP4).setDuration(10, TimeUnit.SECONDS))
@@ -352,119 +480,7 @@ FFmpegResult result = FFmpeg.atPath(BIN)
         .execute();
 ```
 
-## Programmatic video
-
-
-### Producing video
-
-Jaffree allows creation of video in pure java code.
-
-See whole example [here](/src/test/java/examples/programmatic/ProduceGif.java).
-
-```java
-Path output = Paths.get("test.gif");
-
-FrameProducer producer = new FrameProducer() {
-    private long frameCounter = 0;
-
-    @Override
-    public List<Stream> produceStreams() {
-        return Collections.singletonList(new Stream()
-                .setType(Stream.Type.VIDEO)
-                .setTimebase(1000L)
-                .setWidth(320)
-                .setHeight(240)
-        );
-    }
-
-    @Override
-    public Frame produce() {
-        if (frameCounter > 30) {
-            return null;
-        }
-        System.out.println("Creating frame " + frameCounter);
-
-        BufferedImage image = new BufferedImage(320, 240, BufferedImage.TYPE_3BYTE_BGR);
-        Graphics2D graphics = image.createGraphics();
-        graphics.setPaint(new Color(frameCounter * 1.0f / 30, 0, 0));
-        graphics.fillRect(0, 0, 320, 240);
-
-        Frame videoFrame = new Frame()
-                .setStreamId(0)
-                .setPts(frameCounter * 1000 / 10)
-                .setImage(image);
-        frameCounter++;
-
-        return videoFrame;
-    }
-};
-
-FFmpegResult result = FFmpeg.atPath(BIN)
-        .addInput(
-                FrameInput.withProducer(producer)
-        )
-        .addOutput(
-                UrlOutput.toPath(output)
-        )
-        .execute();
-```
-
-Here is an output of the above example:
-
-![example output](programmatic.gif)
-
-Jaffree also allows producing of audio tracks, see BouncingBall [example](examples/src/main/java/BouncingBall.java) for more details.
-
-
-### Consuming video
-
-Jaffree allows consumption of video in the similar manner.
-
-See whole example [here](/src/test/java/examples/programmatic/ExtractFrames.java).
-
-```java
-final Path tempDir = Files.createTempDirectory("jaffree");
-System.out.println("Will write to " + tempDir);
-
-final AtomicLong trackCounter = new AtomicLong();
-final AtomicLong frameCounter = new AtomicLong();
-
-FrameConsumer consumer = new FrameConsumer() {
-    @Override
-    public void consumeStreams(List<Stream> tracks) {
-        trackCounter.set(tracks.size());
-    }
-
-    @Override
-    public void consume(Frame frame) {
-        if (frame == null) {
-            return;
-        }
-
-        long n = frameCounter.incrementAndGet();
-        String filename = String.format("frame%05d.png", n);
-        try {
-            ImageIO.write(frame.getImage(), "png", tempDir.resolve(filename).toFile());
-        } catch (IOException e) {
-            throw new RuntimeException(e);
-        }
-    }
-};
-
-FFmpegResult result = FFmpeg.atPath(BIN)
-        .addInput(
-                UrlInput.fromPath(VIDEO_MP4)
-                        .setDuration(1, TimeUnit.SECONDS)
-        )
-        .addOutput(
-                FrameOutput.withConsumer(consumer)
-                        .extractVideo(true)
-                        .extractAudio(false)
-        )
-        .execute();
-```
-
 ### Programmatic mosaic video creation
 
 Jaffree allows simultaneous reading from several sources (with one instance per every source and target).
-You can find details in  Mosaic [example](/src/test/java/examples/programmatic/Mosaic.java).
+You can find details in  Mosaic [example](/src/test/java/examples/MosaicExample.java).