diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml index c49e241a..8f686b44 100644 --- a/checkstyle-suppressions.xml +++ b/checkstyle-suppressions.xml @@ -11,12 +11,13 @@ files="FF|CRC32"/> - - + diff --git a/pom.xml b/pom.xml index 93e215eb..c1afba34 100644 --- a/pom.xml +++ b/pom.xml @@ -292,7 +292,7 @@ com.puppycrawl.tools checkstyle - 10.23.1 + 13.4.0 @@ -544,19 +544,6 @@ - - org.apache.maven.plugins - maven-checkstyle-plugin - - - checkstyle - verify - - check - - - - @@ -593,6 +580,22 @@ + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + checkstyle + verify + + check + + + + + diff --git a/src/main/java/net/bramp/commons/lang3/math/gson/FractionAdapter.java b/src/main/java/net/bramp/commons/lang3/math/gson/FractionAdapter.java index 71a93883..f612ba4f 100644 --- a/src/main/java/net/bramp/commons/lang3/math/gson/FractionAdapter.java +++ b/src/main/java/net/bramp/commons/lang3/math/gson/FractionAdapter.java @@ -18,12 +18,12 @@ public class FractionAdapter extends TypeAdapter { /** If set, 0/0 returns this value, instead of throwing a ArithmeticException. */ @SuppressWarnings( - "Immutable") // TODO Remove when https://github.com/google/error-prone/issues/512 is fixed + "Immutable") // TODO: Remove when https://github.com/google/error-prone/issues/512 is fixed private final Fraction zeroByZero; /** If set, N/0 returns this value, instead of throwing a ArithmeticException. */ @SuppressWarnings( - "Immutable") // TODO Remove when https://github.com/google/error-prone/issues/512 is fixed + "Immutable") // TODO: Remove when https://github.com/google/error-prone/issues/512 is fixed private final Fraction divideByZero; /** Constructs a FractionAdapter with default zero values for edge cases. */ diff --git a/src/main/java/net/bramp/ffmpeg/FFcommon.java b/src/main/java/net/bramp/ffmpeg/FFcommon.java index 4c570c49..d5696784 100644 --- a/src/main/java/net/bramp/ffmpeg/FFcommon.java +++ b/src/main/java/net/bramp/ffmpeg/FFcommon.java @@ -72,7 +72,7 @@ protected BufferedReader wrapErrorInReader(Process p) { protected void throwOnError(Process p) throws IOException { try { if (ProcessUtils.waitForWithTimeout(p, 1, TimeUnit.SECONDS) != 0) { - // TODO Parse the error + // TODO: Parse the error throw new IOException(path + " returned non-zero exit status. Check stdout."); } } catch (TimeoutException e) { @@ -83,7 +83,7 @@ protected void throwOnError(Process p) throws IOException { protected void throwOnError(Process p, FFmpegProbeResult result) throws IOException { try { if (ProcessUtils.waitForWithTimeout(p, 1, TimeUnit.SECONDS) != 0) { - // TODO Parse the error + // TODO: Parse the error final FFmpegError ffmpegError = null == result ? null : result.getError(); throw new FFmpegException( path + " returned non-zero exit status. Check stdout.", ffmpegError); @@ -143,7 +143,7 @@ public void run(List args) throws IOException { assert (p != null); try { - // TODO Move the copy onto a thread, so that FFmpegProgressListener can be on this thread. + // TODO: Move the copy onto a thread, so that FFmpegProgressListener can be on this thread. // Now block reading ffmpeg's stdout. We are effectively throwing away the output. CharStreams.copy(wrapInReader(p), processOutputStream); diff --git a/src/main/java/net/bramp/ffmpeg/FFmpeg.java b/src/main/java/net/bramp/ffmpeg/FFmpeg.java index 6a0e98bb..760317e7 100644 --- a/src/main/java/net/bramp/ffmpeg/FFmpeg.java +++ b/src/main/java/net/bramp/ffmpeg/FFmpeg.java @@ -293,7 +293,7 @@ public synchronized List channelLayouts() throws IOException { /** Creates a progress parser for the given listener. */ protected ProgressParser createProgressParser(ProgressListener listener) throws IOException { - // TODO In future create the best kind for this OS, unix socket, named pipe, or TCP. + // TODO: In future create the best kind for this OS, unix socket, named pipe, or TCP. try { // Default to TCP because it is supported across all OSes, and is better than UDP because it // provides good properties such as in-order packets, reliability, error checking, etc. diff --git a/src/main/java/net/bramp/ffmpeg/FFmpegUtils.java b/src/main/java/net/bramp/ffmpeg/FFmpegUtils.java index 4ee61258..8e855457 100644 --- a/src/main/java/net/bramp/ffmpeg/FFmpegUtils.java +++ b/src/main/java/net/bramp/ffmpeg/FFmpegUtils.java @@ -63,7 +63,7 @@ public static String toTimecode(long duration, TimeUnit units) { duration = Math.abs(duration); } - long nanoseconds = units.toNanos(duration); // TODO This will clip at Long.MAX_VALUE + long nanoseconds = units.toNanos(duration); // TODO: This will clip at Long.MAX_VALUE long seconds = units.toSeconds(duration); long ns = nanoseconds - SECONDS.toNanos(seconds); diff --git a/src/main/java/net/bramp/ffmpeg/FFprobe.java b/src/main/java/net/bramp/ffmpeg/FFprobe.java index 0eb7e607..e33e1b9e 100644 --- a/src/main/java/net/bramp/ffmpeg/FFprobe.java +++ b/src/main/java/net/bramp/ffmpeg/FFprobe.java @@ -74,7 +74,7 @@ public FFmpegProbeResult probe( this.builder().setInput(mediaPath).setUserAgent(userAgent).addExtraArgs(extraArgs).build()); } - // TODO Add Probe Inputstream + // TODO: Add Probe Inputstream /** Probes media using the supplied arguments and returns the result. */ public FFmpegProbeResult probe(List args) throws IOException { checkIfFFprobe(); diff --git a/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegOutputBuilder.java b/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegOutputBuilder.java index 8f0b4b39..c5dac478 100644 --- a/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegOutputBuilder.java +++ b/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegOutputBuilder.java @@ -288,7 +288,7 @@ public T setAudioFilter(String filter) { @CheckReturnValue @Override public EncodingOptions buildOptions() { - // TODO When/if modelmapper supports @ConstructorProperties, we map this + // TODO: When/if modelmapper supports @ConstructorProperties, we map this // object, instead of doing new XXX(...) // https://github.com/jhalterman/modelmapper/issues/44 return new EncodingOptions( @@ -351,13 +351,13 @@ protected List build(FFmpegBuilder parent, int pass) { checkState(input != null, "Target size must be used with setInput(FFmpegProbeResult)"); - // TODO factor in start time and/or number of frames + // TODO: factor in start time and/or number of frames double durationInSeconds = input.format.duration; long totalBitRate = (long) Math.floor((targetSize * 8) / durationInSeconds) - pass_padding_bitrate; - // TODO Calculate audioBitRate + // TODO: Calculate audioBitRate if (video_enabled && video_bit_rate == 0) { // Video (and possibly audio) diff --git a/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegStreamBuilder.java b/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegStreamBuilder.java index 531f2bd3..82412b35 100644 --- a/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegStreamBuilder.java +++ b/src/main/java/net/bramp/ffmpeg/builder/AbstractFFmpegStreamBuilder.java @@ -104,7 +104,7 @@ public abstract class AbstractFFmpegStreamBuilder args.add("-s", String.format("%dx%d", video_width, video_height)); } - // TODO What if width is set but heigh isn't. We don't seem to do anything + // TODO: What if width is set but heigh isn't. We don't seem to do anything if (video_frame_rate != null) { args.add("-r", video_frame_rate.toString()); diff --git a/src/main/java/net/bramp/ffmpeg/builder/AudioCodec.java b/src/main/java/net/bramp/ffmpeg/builder/AudioCodec.java index 663c1caf..b54ab709 100644 --- a/src/main/java/net/bramp/ffmpeg/builder/AudioCodec.java +++ b/src/main/java/net/bramp/ffmpeg/builder/AudioCodec.java @@ -213,10 +213,10 @@ public class AudioCodec { /** Monkey's Audio. */ public static final String APE = "ape"; - /** aptX (Audio Processing Technology for Bluetooth). */ + /** AptX (Audio Processing Technology for Bluetooth). */ public static final String APTX = "aptx"; - /** aptX HD (Audio Processing Technology for Bluetooth). */ + /** AptX HD (Audio Processing Technology for Bluetooth). */ public static final String APTX_HD = "aptx_hd"; /** ATRAC1 (Adaptive TRansform Acoustic Coding). */ @@ -260,7 +260,7 @@ public class AudioCodec { /** Constrained Energy Lapped Transform (CELT). */ public static final String CELT = "celt"; - /** codec2 (very low bitrate speech codec). */ + /** Codec2 (very low bitrate speech codec). */ public static final String CODEC2 = "codec2"; /** RFC 3389 Comfort Noise. */ @@ -344,7 +344,7 @@ public class AudioCodec { /** IAC (Indeo Audio Coder). */ public static final String IAC = "iac"; - /** iLBC (Internet Low Bitrate Codec). */ + /** ILBC (Internet Low Bitrate Codec). */ public static final String ILBC = "ilbc"; /** IMC (Intel Music Coder). */ diff --git a/src/main/java/net/bramp/ffmpeg/builder/FFmpegHlsOutputBuilder.java b/src/main/java/net/bramp/ffmpeg/builder/FFmpegHlsOutputBuilder.java index 184a88dc..9838a675 100644 --- a/src/main/java/net/bramp/ffmpeg/builder/FFmpegHlsOutputBuilder.java +++ b/src/main/java/net/bramp/ffmpeg/builder/FFmpegHlsOutputBuilder.java @@ -58,7 +58,7 @@ public FFmpegHlsOutputBuilder setHlsTime(long duration, TimeUnit units) { } /** - * hls_segment_filename Examples
+ * Sets the HLS segment filename ({@code hls_segment_filename}). Examples:
*
* "file%03d.ts" segment files: file000.ts, file001.ts, file002.ts, etc. * diff --git a/src/main/java/net/bramp/ffmpeg/builder/VideoCodec.java b/src/main/java/net/bramp/ffmpeg/builder/VideoCodec.java index daaf4a24..b34316fb 100644 --- a/src/main/java/net/bramp/ffmpeg/builder/VideoCodec.java +++ b/src/main/java/net/bramp/ffmpeg/builder/VideoCodec.java @@ -299,10 +299,10 @@ public class VideoCodec { /** HuffYUV MT. */ public static final String HYMT = "hymt"; - /** id Quake II CIN video (decoders: idcinvideo). */ + /** Id Quake II CIN video (decoders: idcinvideo). */ public static final String IDCIN = "idcin"; - /** iCEDraw text. */ + /** ICEDraw text. */ public static final String IDF = "idf"; /** IFF ACBM/ANIM/DEEP/ILBM/PBM/RGB8/RGBN (decoders: iff). */ @@ -548,19 +548,19 @@ public class VideoCodec { /** RemotelyAnywhere Screen Capture. */ public static final String RASC = "rasc"; - /** raw video. */ + /** Raw video. */ public static final String RAWVIDEO = "rawvideo"; /** RL2 video. */ public static final String RL2 = "rl2"; - /** id RoQ video (decoders: roqvideo) (encoders: roqvideo). */ + /** Id RoQ video (decoders: roqvideo) (encoders: roqvideo). */ public static final String ROQ = "roq"; /** QuickTime video (RPZA). */ public static final String RPZA = "rpza"; - /** innoHeim/Rsupport Screen Capture Codec. */ + /** InnoHeim/Rsupport Screen Capture Codec. */ public static final String RSCC = "rscc"; /** RTV1 (RivaTuner Video). */ @@ -731,7 +731,7 @@ public class VideoCodec { /** Sierra VMD video. */ public static final String VMDVIDEO = "vmdvideo"; - /** vMix Video. */ + /** VMix Video. */ public static final String VMIX = "vmix"; /** VMware Screen Codec / VMware Video. */ @@ -809,7 +809,7 @@ public class VideoCodec { /** Wing Commander IV / Xxan. */ public static final String XAN_WC4 = "xan_wc4"; - /** eXtended BINary text. */ + /** EXtended BINary text. */ public static final String XBIN = "xbin"; /** XBM (X BitMap) image. */ diff --git a/src/main/java/net/bramp/ffmpeg/io/LoggingFilterReader.java b/src/main/java/net/bramp/ffmpeg/io/LoggingFilterReader.java index 9c511546..25531282 100644 --- a/src/main/java/net/bramp/ffmpeg/io/LoggingFilterReader.java +++ b/src/main/java/net/bramp/ffmpeg/io/LoggingFilterReader.java @@ -26,7 +26,7 @@ public LoggingFilterReader(Reader in, Logger logger) { /** Logs the contents of the buffer and resets it. */ protected void log() { if (buffer.length() > 0) { - // TODO Change from debug, to a user defined level + // TODO: Change from debug, to a user defined level logger.debug(buffer.toString()); buffer.setLength(0); } diff --git a/src/main/java/net/bramp/ffmpeg/nut/Frame.java b/src/main/java/net/bramp/ffmpeg/nut/Frame.java index 5925fe40..7d58deeb 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/Frame.java +++ b/src/main/java/net/bramp/ffmpeg/nut/Frame.java @@ -10,7 +10,7 @@ /** A video or audio frame. */ public class Frame { - // TODO Change this to a enum + // TODO: Change this to a enum static final long FLAG_KEY = 1 << 0; static final long FLAG_EOR = 1 << 1; static final long FLAG_CODED_PTS = 1 << 3; @@ -47,7 +47,7 @@ protected Map readMetaData(NutDataInputStream in) throws IOExcep } else if (type == -2) { String k = new String(in.readVarArray(), StandardCharsets.UTF_8); String v = new String(in.readVarArray(), StandardCharsets.UTF_8); - value = k + "=" + v; // TODO Change this some how + value = k + "=" + v; // TODO: Change this some how } else if (type == -3) { value = in.readSignedVarInt(); @@ -57,7 +57,7 @@ protected Map readMetaData(NutDataInputStream in) throws IOExcep * t (v coded universal timestamp) tmp v id= tmp % time_base_count value= (tmp / * time_base_count) * timeBase[id] */ - value = in.readVarLong(); // TODO Convert to timestamp + value = in.readVarLong(); // TODO: Convert to timestamp } else if (type < -4) { long denominator = -type - 4; @@ -117,7 +117,7 @@ public void read(NutReader nut, NutDataInputStream in, int code) throws IOExcept pts = coded_pts - (1L << stream.header.msbPtsShift); } } else { - // TODO Test this code path + // TODO: Test this code path pts = stream.last_pts + fc.ptsDelta; } stream.last_pts = pts; @@ -149,7 +149,7 @@ public void read(NutReader nut, NutDataInputStream in, int code) throws IOExcept if ((flags & FLAG_CHECKSUM) == FLAG_CHECKSUM) { @SuppressWarnings("unused") long checksum = in.readInt(); - // TODO Test checksum + // TODO: Test checksum } if (size > 4096) { @@ -158,7 +158,7 @@ public void read(NutReader nut, NutDataInputStream in, int code) throws IOExcept // Now data if ((flags & FLAG_SM_DATA) == FLAG_SM_DATA) { - // TODO Test this path. + // TODO: Test this path. if (nut.header.version < 4) { throw new IOException("Frame SM Data not allowed in version 4 or less"); @@ -178,7 +178,7 @@ public void read(NutReader nut, NutDataInputStream in, int code) throws IOExcept metaData = null; } - // TODO Use some kind of byte pool + // TODO: Use some kind of byte pool data = new byte[size]; byte[] elision = nut.header.elision.get(header_idx); diff --git a/src/main/java/net/bramp/ffmpeg/nut/IndexPacket.java b/src/main/java/net/bramp/ffmpeg/nut/IndexPacket.java index 50e7a99a..32156c19 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/IndexPacket.java +++ b/src/main/java/net/bramp/ffmpeg/nut/IndexPacket.java @@ -1,5 +1,5 @@ package net.bramp.ffmpeg.nut; /** Represents an index packet in the NUT multimedia container format. */ -// TODO +// TODO: public class IndexPacket {} diff --git a/src/main/java/net/bramp/ffmpeg/nut/InfoPacket.java b/src/main/java/net/bramp/ffmpeg/nut/InfoPacket.java index 8d1f851c..a0f63795 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/InfoPacket.java +++ b/src/main/java/net/bramp/ffmpeg/nut/InfoPacket.java @@ -1,5 +1,5 @@ package net.bramp.ffmpeg.nut; /** Represents an info packet in the NUT multimedia container format. */ -// TODO +// TODO: public class InfoPacket {} diff --git a/src/main/java/net/bramp/ffmpeg/nut/NutDataInputStream.java b/src/main/java/net/bramp/ffmpeg/nut/NutDataInputStream.java index 5ec23ede..72d9d3ae 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/NutDataInputStream.java +++ b/src/main/java/net/bramp/ffmpeg/nut/NutDataInputStream.java @@ -49,7 +49,7 @@ public int readVarInt() throws IOException { more = (b & 0x80) == 0x80; result = 128 * result + (b & 0x7F); - // TODO Check for int overflow + // TODO: Check for int overflow } while (more); return result; @@ -64,7 +64,7 @@ public long readVarLong() throws IOException { more = (b & 0x80) == 0x80; result = 128 * result + (b & 0x7F); - // TODO Check for long overflow + // TODO: Check for long overflow } while (more); return result; diff --git a/src/main/java/net/bramp/ffmpeg/nut/Packet.java b/src/main/java/net/bramp/ffmpeg/nut/Packet.java index 5ecd32d8..24a60273 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/Packet.java +++ b/src/main/java/net/bramp/ffmpeg/nut/Packet.java @@ -86,7 +86,7 @@ public void seekToPacketFooter(NutDataInputStream in) throws IOException { if (current > header.end) { throw new IOException("Can not seek backwards at:" + current + " end:" + header.end); } - // TODO Fix this to not cast longs to ints + // TODO: Fix this to not cast longs to ints in.skipBytes((int) (header.end - current)); } diff --git a/src/main/java/net/bramp/ffmpeg/nut/PacketHeader.java b/src/main/java/net/bramp/ffmpeg/nut/PacketHeader.java index f3a1f103..6ce62fc9 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/PacketHeader.java +++ b/src/main/java/net/bramp/ffmpeg/nut/PacketHeader.java @@ -20,7 +20,7 @@ public void read(NutDataInputStream in, long startcode) throws IOException { long expected = in.getCRC(); checksum = in.readInt(); if (checksum != expected) { - // TODO This code path has never been tested. + // TODO: This code path has never been tested. throw new IOException( String.format("invalid header checksum %X want %X", expected, checksum)); } diff --git a/src/main/java/net/bramp/ffmpeg/nut/RawHandler.java b/src/main/java/net/bramp/ffmpeg/nut/RawHandler.java index 6d2fd2a0..1225b031 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/RawHandler.java +++ b/src/main/java/net/bramp/ffmpeg/nut/RawHandler.java @@ -38,12 +38,12 @@ public static BufferedImage toBufferedImage(Frame frame) { // streamHeader.width, streamHeader.height, 1); // Raster raster = new Raster(sample, buffer, new Point(0,0)); - int type = BufferedImage.TYPE_INT_ARGB; // TODO Use the type defined in the stream header. + int type = BufferedImage.TYPE_INT_ARGB; // TODO: Use the type defined in the stream header. BufferedImage img = new BufferedImage(header.width, header.height, type); - // TODO Avoid this conversion. + // TODO: Avoid this conversion. int[] data = bytesToInts(frame.data); - int stride = header.width; // TODO Check this is true + int stride = header.width; // TODO: Check this is true img.setRGB(0, 0, header.width, header.height, data, 0, stride); return img; diff --git a/src/main/java/net/bramp/ffmpeg/nut/StreamHeaderPacket.java b/src/main/java/net/bramp/ffmpeg/nut/StreamHeaderPacket.java index 58baf1fc..fabd74a1 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/StreamHeaderPacket.java +++ b/src/main/java/net/bramp/ffmpeg/nut/StreamHeaderPacket.java @@ -14,7 +14,7 @@ public class StreamHeaderPacket extends Packet { public static final int USER_DATA = 3; int id; - long type; // One of VIDEO/AUDIO/SUBTITLE/USER_DATA // TODO Convert to enum. + long type; // One of VIDEO/AUDIO/SUBTITLE/USER_DATA // TODO: Convert to enum. byte[] fourcc; int timeBaseId; int msbPtsShift; @@ -47,7 +47,7 @@ protected void readBody(NutDataInputStream in) throws IOException { fourcc = in.readVarArray(); if (fourcc.length != 2 && fourcc.length != 4) { - // TODO In future fourcc could be a different size, but for sanity checking lets leave this + // TODO: In future fourcc could be a different size, but for sanity checking lets leave this // check in. throw new IOException("Unexpected fourcc length: " + fourcc.length); } diff --git a/src/main/java/net/bramp/ffmpeg/nut/SyncPointPacket.java b/src/main/java/net/bramp/ffmpeg/nut/SyncPointPacket.java index 04ab247b..63900b98 100644 --- a/src/main/java/net/bramp/ffmpeg/nut/SyncPointPacket.java +++ b/src/main/java/net/bramp/ffmpeg/nut/SyncPointPacket.java @@ -1,5 +1,5 @@ package net.bramp.ffmpeg.nut; /** Represents a sync point packet in the NUT multimedia container format. */ -// TODO +// TODO: public class SyncPointPacket {} diff --git a/src/main/java/net/bramp/ffmpeg/probe/FFmpegFormat.java b/src/main/java/net/bramp/ffmpeg/probe/FFmpegFormat.java index 8fd018d2..1a27184f 100644 --- a/src/main/java/net/bramp/ffmpeg/probe/FFmpegFormat.java +++ b/src/main/java/net/bramp/ffmpeg/probe/FFmpegFormat.java @@ -13,7 +13,7 @@ public class FFmpegFormat { public String format_long_name; public double start_time; - // TODO Change this to java.time.Duration + // TODO: Change this to java.time.Duration /** Duration in seconds. */ public double duration; diff --git a/src/main/java/net/bramp/ffmpeg/probe/FFmpegStream.java b/src/main/java/net/bramp/ffmpeg/probe/FFmpegStream.java index d88698a8..0dcf8d93 100644 --- a/src/main/java/net/bramp/ffmpeg/probe/FFmpegStream.java +++ b/src/main/java/net/bramp/ffmpeg/probe/FFmpegStream.java @@ -25,7 +25,7 @@ public class FFmpegStream { public int has_b_frames; - public String sample_aspect_ratio; // TODO Change to a Ratio/Fraction object + public String sample_aspect_ratio; // TODO: Change to a Ratio/Fraction object public String display_aspect_ratio; public String pix_fmt; diff --git a/src/main/java/net/bramp/ffmpeg/progress/Progress.java b/src/main/java/net/bramp/ffmpeg/progress/Progress.java index e44ea4e4..91ad798f 100644 --- a/src/main/java/net/bramp/ffmpeg/progress/Progress.java +++ b/src/main/java/net/bramp/ffmpeg/progress/Progress.java @@ -11,7 +11,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -// TODO Change to be immutable +// TODO: Change to be immutable /** Represents progress data reported by FFmpeg during encoding. */ public class Progress { static final Logger LOG = LoggerFactory.getLogger(Progress.class); @@ -62,7 +62,7 @@ public static Status of(String status) { /** Output file size (in bytes). */ public long total_size = 0; - // TODO Change this to a java.time.Duration + // TODO: Change this to a java.time.Duration /** Output time (in nanoseconds). */ public long out_time_ns = 0; @@ -184,13 +184,13 @@ protected boolean parseLine(String line) { return false; case "progress": - // TODO After "end" stream is closed + // TODO: After "end" stream is closed status = Status.of(value); return true; // The status field is always last in the record default: if (key.startsWith("stream_")) { - // TODO handle stream_0_0_q=0.0: + // TODO: handle stream_0_0_q=0.0: // stream_%d_%d_q= file_index, index, quality // stream_%d_%d_psnr_%c=%2.2f, file_index, index, type{Y, U, V}, quality // Enable with // AV_CODEC_FLAG_PSNR diff --git a/src/main/java/net/bramp/ffmpeg/progress/ProgressListener.java b/src/main/java/net/bramp/ffmpeg/progress/ProgressListener.java index 22dddce9..0cdb1213 100644 --- a/src/main/java/net/bramp/ffmpeg/progress/ProgressListener.java +++ b/src/main/java/net/bramp/ffmpeg/progress/ProgressListener.java @@ -1,7 +1,7 @@ package net.bramp.ffmpeg.progress; /** Captures output from the ffmpeg command line as status occurs. */ -// TODO Consider adding other stats. Start, end, stream, error +// TODO: Consider adding other stats. Start, end, stream, error public interface ProgressListener { /** Called on each progress update, typically once per second, and at the end of processing. */ void progress(Progress progress); diff --git a/src/main/java/net/bramp/ffmpeg/progress/TcpProgressParserRunnable.java b/src/main/java/net/bramp/ffmpeg/progress/TcpProgressParserRunnable.java index 50a7feeb..4963c347 100644 --- a/src/main/java/net/bramp/ffmpeg/progress/TcpProgressParserRunnable.java +++ b/src/main/java/net/bramp/ffmpeg/progress/TcpProgressParserRunnable.java @@ -41,7 +41,7 @@ public void run() { } catch (IOException e) { // We have no good way to report this back to the user... yet - // TODO Report to the user that this failed in some way + // TODO: Report to the user that this failed in some way } } } diff --git a/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParser.java b/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParser.java index afec8f85..d9997854 100644 --- a/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParser.java +++ b/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParser.java @@ -31,7 +31,7 @@ public UdpProgressParser(ProgressListener listener, int port, InetAddress addr) this.address = createUri("udp", socket.getLocalAddress(), socket.getLocalPort()); this.socket.setBroadcast(false); - // this.socket.setSoTimeout(); // TODO Setup timeouts + // this.socket.setSoTimeout(); // TODO: Setup timeouts } @Override diff --git a/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParserRunnable.java b/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParserRunnable.java index 002860fd..0440390a 100644 --- a/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParserRunnable.java +++ b/src/main/java/net/bramp/ffmpeg/progress/UdpProgressParserRunnable.java @@ -33,7 +33,7 @@ public void run() { startSignal.countDown(); try { - // TODO This doesn't handle the case of a progress being split across two packets + // TODO: This doesn't handle the case of a progress being split across two packets socket.receive(packet); if (packet.getLength() == 0) { @@ -49,7 +49,7 @@ public void run() { } catch (IOException e) { // We have no good way to report this back to the user... yet - // TODO Report to the user that this failed in some way + // TODO: Report to the user that this failed in some way } } }