Fix javadoc build

Author: natario1

README.md

@@ -1,102 +1,25 @@
-# Note
+# Transcoder
 
-This project was forked recently from great [ypresto/android-transcoder](https://github.com/ypresto/android-transcoder). 
-Lots of changes were made, so the information in this README is mostly false at the moment.
+This project is an improved fork of [ypresto/android-transcoder](https://github.com/ypresto/android-transcoder).
+Lots of changes were made, so the documentation must be rewritten. You can, however, take a look at the
+demo app which provides a working example of the new API.
 
+```groovy
+implementation 'com.otaliastudios:transcoder:0.1.0'
+```
 
-android-transcoder
-=================
-
-Hardware accelerated transcoder for Android, written in pure Java.
-
-## Why?
-
-Android does not offer straight forward way to transcode video.
-
-FFmpeg is the most famous solution for transcoding. But using [FFmpeg binary on Android](https://github.com/WritingMinds/ffmpeg-android) can cause GPL and/or patent issues. Also using native code for Android development can be troublesome because of cross-compiling, architecture compatibility, build time and binary size.
-
-To transcode without any hassle written above, I created this library to provide hardware accelerated transcoding of H.264 (mp4) video without ffmpeg by using [MediaCodec](https://developer.android.com/intl/ja/reference/android/media/MediaCodec.html).
-
-## Requirements
+## Setup
 
-API Level 18 (Android 4.3, JELLY_BEAN_MR2) or later.
-If your app targets older Android, you should add below line to AndroidManifest.xml:
+This library requires API level 18 (Android 4.3, JELLY_BEAN_MR2) or later.
+If your app targets older versions, you can override the minSdkVersion by
+adding this line to your manifest file:
 
 ```xml
-<!-- Only supports API >= 18 -->
 <uses-sdk tools:overrideLibrary="com.otaliastudios.transcoder" />
 ```
 
-Please ensure checking Build.VERSION by your self.
-
-## Usage
-
-```java
-@Override
-protected void onActivityResult(int requestCode, int resultCode, Intent data) {
-    ParcelFileDescriptor parcelFileDescriptor = resolver.openFileDescriptor(data.getData(), "r");
-    FileDescriptor fileDescriptor = parcelFileDescriptor.getFileDescriptor();
-    MediaTranscoder.Listener listener = new MediaTranscoder.Listener() {
-        @Override
-        public void onTranscodeProgress(double progress) {
-            ...
-        }
-
-        @Override
-        public void onTranscodeCompleted() {
-            startActivity(new Intent(Intent.ACTION_VIEW).setDataAndType(Uri.fromFile(file), "video/mp4"));
-            ...
-        }
-
-        @Override
-        public void onTranscodeFailed(Exception exception) {
-            ...
-        }
-    };
-    MediaTranscoder.getInstance().transcodeVideo(fileDescriptor, file.getAbsolutePath(),
-            MediaFormatStrategyPresets.createAndroid720pStrategy(), listener); // or createAndroid720pStrategy([your bitrate here])
-}
-```
-
-See `TranscoderActivity.java` in example directory for ready-made transcoder app.
-
-## Quick Setup
-
-### Gradle
-
-Available from [JCenter](https://bintray.com/bintray/jcenter), which is default repo of gradle script generated by recent android studio.
-
-```groovy
-repositories {
-   jcenter()
-}
-```
-
-```groovy
-compile 'net.ypresto.androidtranscoder:android-transcoder:0.2.0'
-```
-
-## Note (PLEASE READ FIRST)
-
-- This library raises `RuntimeException`s (like `IlleagalStateException`) in various situations. Please catch it and provide alternate logics. I know this is bad design according to Effective Java; just is TODO.
-- Currently this library does not generate streaming-aware mp4 file.
-Use [qtfaststart-java](https://github.com/ypresto/qtfaststart-java) to place moov atom at beginning of file.
-- Android does not gurantees that all devices have bug-free codecs/accelerators for your codec parameters (especially, resolution). Refer [supported media formats](http://developer.android.com/guide/appendix/media-formats.html) for parameters guaranteed by [CTS](https://source.android.com/compatibility/cts-intro.html).
-- This library does not support video files recorded by other device like digital cameras, iOS (mov files, including non-baseline profile h.264), etc.
-
-
-## More information about internals
-
-There is a blog post about this library written in Japanese.
-http://qiita.com/yuya_presto/items/d48e29c89109b746d000
-
-While it is Japanese, diagrams would be useful for understanding internals of this library.
-
-## References for Android Low-Level Media APIs
-
-- http://bigflake.com/mediacodec/
-- https://github.com/google/grafika
-- https://android.googlesource.com/platform/frameworks/av/+/lollipop-release/media/libstagefright
+In this case you should check at runtime that API level is at least 18, before
+calling any method here.
 
 ## License
 

lib/src/main/java/com/otaliastudios/transcoder/MediaTranscoder.java

@@ -102,6 +102,7 @@ public static MediaTranscoderOptions.Builder into(@NonNull String outPath) {
      * Transcodes video file asynchronously.
      *
      * @param options The transcoder options.
+     * @return a Future that completes when transcoding is completed
      */
     @SuppressWarnings("WeakerAccess")
     public Future<Void> transcode(@NonNull final MediaTranscoderOptions options) {
@@ -173,6 +174,7 @@ public interface Listener {
 
         /**
          * Called when transcode failed.
+         * @param exception the failure exception
          */
         void onTranscodeFailed(@NonNull Throwable exception);
     }

lib/src/main/java/com/otaliastudios/transcoder/engine/MediaTranscoderEngine.java

@@ -78,6 +78,7 @@ public void setProgressCallback(ProgressCallback progressCallback) {
 
     /**
      * NOTE: This method is thread safe.
+     * @return the current progress
      */
     public double getProgress() {
         return mProgress;

lib/src/main/java/com/otaliastudios/transcoder/engine/TrackStatus.java

@@ -8,6 +8,8 @@ public enum TrackStatus {
      * in MediaExtractor, and add this track to MediaMuxer.
      * Basically if it should be read and written or not
      * (no point in just reading without writing).
+     *
+     * @return true if transcoding
      */
     public boolean isTranscoding() {
         switch (this) {

lib/src/main/java/com/otaliastudios/transcoder/strategy/DefaultVideoStrategies.java

@@ -11,6 +11,8 @@ private DefaultVideoStrategies() {}
      * A {@link DefaultVideoStrategy} that uses 720x1280.
      * This preset is ensured to work on any Android >=4.3 devices by Android CTS,
      * assuming that the codec is available.
+     *
+     * @return a default video strategy
      */
     public static DefaultVideoStrategy for720x1280() {
         return DefaultVideoStrategy.exact(720, 1280)
@@ -24,6 +26,8 @@ public static DefaultVideoStrategy for720x1280() {
      * A {@link DefaultVideoStrategy} that uses 360x480 (3:4),
      * ensured to work for 3:4 videos as explained by
      * https://developer.android.com/guide/topics/media/media-formats
+     *
+     * @return a default video strategy
      */
     public static DefaultVideoStrategy for360x480() {
         return DefaultVideoStrategy.exact(360, 480)

lib/src/main/java/com/otaliastudios/transcoder/strategy/DefaultVideoStrategy.java

@@ -45,6 +45,9 @@ private Options() {}
     /**
      * Creates a new {@link Builder} with an {@link ExactResizer}
      * using given dimensions.
+     *
+     * @param firstSize the exact first size
+     * @param secondSize the exact second size
      * @return a strategy builder
      */
     public static Builder exact(int firstSize, int secondSize) {
@@ -54,6 +57,8 @@ public static Builder exact(int firstSize, int secondSize) {
     /**
      * Creates a new {@link Builder} with a {@link FractionResizer}
      * using given downscale fraction.
+     *
+     * @param fraction the downscale fraction
      * @return a strategy builder
      */
     public static Builder fraction(float fraction) {
@@ -63,6 +68,8 @@ public static Builder fraction(float fraction) {
     /**
      * Creates a new {@link Builder} with an {@link AtMostResizer}
      * using given constraint.
+     *
+     * @param atMostSize size constraint
      * @return a strategy builder
      */
     public static Builder atMost(int atMostSize) {
@@ -72,6 +79,9 @@ public static Builder atMost(int atMostSize) {
     /**
      * Creates a new {@link Builder} with an {@link AtMostResizer}
      * using given constraints.
+     *
+     * @param atMostMajor constraint for the major dimension
+     * @param atMostMinor constraint for the minor dimension
      * @return a strategy builder
      */
     public static Builder atMost(int atMostMinor, int atMostMajor) {

lib/src/main/java/com/otaliastudios/transcoder/strategy/OutputStrategy.java

@@ -18,7 +18,7 @@ public interface OutputStrategy {
      * Create the output format for this track (either audio or video).
      * Implementors can:
      * - throw a {@link OutputStrategyException} if the whole transcoding should be aborted
-     * - return {@param inputFormat} for remuxing this track as-is
+     * - return {@code inputFormat} for remuxing this track as-is
      * - returning {@code null} for removing this track from output
      *
      * @param inputFormat the input format

lib/src/main/java/com/otaliastudios/transcoder/transcode/opengl/InputSurface.java

@@ -38,8 +38,10 @@ public class InputSurface {
     private EGLContext mEGLContext = EGL14.EGL_NO_CONTEXT;
     private EGLSurface mEGLSurface = EGL14.EGL_NO_SURFACE;
     private Surface mSurface;
+
     /**
      * Creates an InputSurface from a Surface.
+     * @param surface the surface
      */
     public InputSurface(Surface surface) {
         if (surface == null) {
@@ -48,6 +50,7 @@ public InputSurface(Surface surface) {
         mSurface = surface;
         eglSetup();
     }
+
     /**
      * Prepares EGL.  We want a GLES 2.0 context and a surface that supports recording.
      */
@@ -132,38 +135,47 @@ public void makeUnCurrent() {
     }
     /**
      * Calls eglSwapBuffers.  Use this to "publish" the current frame.
+     * @return the output of eglSwapBuffers
      */
     public boolean swapBuffers() {
         return EGL14.eglSwapBuffers(mEGLDisplay, mEGLSurface);
     }
+
     /**
      * Returns the Surface that the MediaCodec receives buffers from.
+     * @return the surface
      */
     public Surface getSurface() {
         return mSurface;
     }
+
     /**
      * Queries the surface's width.
+     * @return surface width
      */
     public int getWidth() {
         int[] value = new int[1];
         EGL14.eglQuerySurface(mEGLDisplay, mEGLSurface, EGL14.EGL_WIDTH, value, 0);
         return value[0];
     }
+
     /**
      * Queries the surface's height.
+     * @return surface height
      */
     public int getHeight() {
         int[] value = new int[1];
         EGL14.eglQuerySurface(mEGLDisplay, mEGLSurface, EGL14.EGL_HEIGHT, value, 0);
         return value[0];
     }
+
     /**
      * Sends the presentation time stamp to EGL.  Time is expressed in nanoseconds.
      */
     public void setPresentationTime(long nsecs) {
         EGLExt.eglPresentationTimeANDROID(mEGLDisplay, mEGLSurface, nsecs);
     }
+
     /**
      * Checks for EGL errors.
      */

lib/src/main/java/com/otaliastudios/transcoder/transcode/opengl/OutputSurface.java

@@ -55,9 +55,12 @@ public class OutputSurface implements SurfaceTexture.OnFrameAvailableListener {
     private boolean mFrameAvailable;
     private TextureRender mTextureRender;
     /**
-     * Creates an OutputSurface backed by a pbuffer with the specifed dimensions.  The new
+     * Creates an OutputSurface backed by a pbuffer with the specified dimensions.  The new
      * EGL context and surface will be made current.  Creates a Surface that can be passed
      * to MediaCodec.configure().
+     *
+     * @param width surface width
+     * @param height surface height
      */
     public OutputSurface(int width, int height) {
         if (width <= 0 || height <= 0) {
@@ -185,12 +188,17 @@ public void makeCurrent() {
     }
     /**
      * Returns the Surface that we draw onto.
+     *
+     * @return the output surface
      */
     public Surface getSurface() {
         return mSurface;
     }
+
     /**
      * Replaces the fragment shader.
+     *
+     * @param fragmentShader the new shader
      */
     public void changeFragmentShader(String fragmentShader) {
         mTextureRender.changeFragmentShader(fragmentShader);
@@ -223,9 +231,10 @@ public void awaitNewImage() {
         mTextureRender.checkGlError("before updateTexImage");
         mSurfaceTexture.updateTexImage();
     }
+
     /**
      * Wait up to given timeout until new image become available.
-     * @param timeoutMs
+     * @param timeoutMs timeout in ms
      * @return true if new image is available. false for no new image until timeout.
      */
     public boolean checkForNewImage(int timeoutMs) {

lib/src/main/java/com/otaliastudios/transcoder/utils/AvcCsdUtils.java

@@ -32,6 +32,7 @@ public class AvcCsdUtils {
     private static final byte AVC_SPS_NAL_3 = 71; // 0<<7 + 2<<5 + 7<<0
 
     /**
+     * @param format the input format
      * @return ByteBuffer contains SPS without NAL header.
      */
     public static ByteBuffer getSpsBuffer(MediaFormat format) {