add output format strategy interface

ypresto · ypresto · commit c8efee10a0b0 · 2014-11-12T18:40:17.000+09:00
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-AndroidTranscoder
+android-transcoder
 =================
 
 Hardware accelerated transcoder for Android, written in pure Java.
diff --git a/example/src/main/java/net/ypresto/androidtranscoder/example/TranscoderActivity.java b/example/src/main/java/net/ypresto/androidtranscoder/example/TranscoderActivity.java
@@ -14,6 +14,7 @@
 import android.widget.Toast;
 
 import net.ypresto.androidtranscoder.MediaTranscoder;
+import net.ypresto.androidtranscoder.format.MediaFormatStrategyPresets;
 
 import java.io.File;
 import java.io.FileDescriptor;
@@ -60,7 +61,7 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
                     final FileDescriptor fileDescriptor = parcelFileDescriptor.getFileDescriptor();
                     final ProgressBar progressBar = (ProgressBar) findViewById(R.id.progress_bar);
                     progressBar.setMax(1000);
-                    MediaTranscoder.getInstance().transcodeVideo(fileDescriptor, file.getAbsolutePath(), new MediaTranscoder.Listener() {
+                    MediaTranscoder.Listener listener = new MediaTranscoder.Listener() {
                         @Override
                         public void onTranscodeProgress(double progress) {
                             if (progress < 0) {
@@ -96,7 +97,9 @@ public void onTranscodeFailed(Exception exception) {
                                 Log.w("Error while closing", e);
                             }
                         }
-                    });
+                    };
+                    MediaTranscoder.getInstance().transcodeVideo(fileDescriptor, file.getAbsolutePath(),
+                            MediaFormatStrategyPresets.EXPORT_PRESET_960x540, listener);
                     findViewById(R.id.select_video_button).setEnabled(false);
                 }
                 break;
diff --git a/example/src/main/res/values/strings.xml b/example/src/main/res/values/strings.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
 
-    <string name="app_name">AndroidTranscoder</string>
+    <string name="app_name">android-transcoder</string>
     <string name="hello_world">Hello world!</string>
     <string name="action_settings">Settings</string>
 
diff --git a/lib/src/androidTest/java/net/ypresto/androidtranscoder/format/MediaFormatPresetsTest.java b/lib/src/androidTest/java/net/ypresto/androidtranscoder/format/MediaFormatPresetsTest.java
@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2014 Yuya Tanaka
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package net.ypresto.androidtranscoder.format;
+
+import android.media.MediaFormat;
+
+import junit.framework.TestCase;
+
+public class MediaFormatPresetsTest extends TestCase {
+
+    public void testGetExportPreset960x540() throws Exception {
+        assertNull(MediaFormatPresets.getExportPreset960x540(960, 540));
+        assertNull(MediaFormatPresets.getExportPreset960x540(540, 960));
+        assertNull(MediaFormatPresets.getExportPreset960x540(480, 320));
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(1024, 768), 960, 720);
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(768, 1024), 720, 960);
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(768, 1024), 720, 960);
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(1920, 1080), 960, 540);
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(1080, 1920), 540, 960);
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(1280, 720), 960, 540);
+        assertWidthAndHeightEquals(MediaFormatPresets.getExportPreset960x540(720, 1280), 540, 960);
+        try {
+            MediaFormatPresets.getExportPreset960x540(1024, 769);
+            fail("should throw if indivisible");
+        } catch (IllegalArgumentException e) {
+            assertTrue(e.getStackTrace()[0].getClassName().equals(MediaFormatPresets.class.getName()));
+        }
+    }
+
+    private void assertWidthAndHeightEquals(MediaFormat format, int width, int height) throws Exception {
+        assertEquals(width, format.getInteger(MediaFormat.KEY_WIDTH));
+        assertEquals(height, format.getInteger(MediaFormat.KEY_HEIGHT));
+    }
+}
diff --git a/lib/src/main/java/net/ypresto/androidtranscoder/MediaTranscoder.java b/lib/src/main/java/net/ypresto/androidtranscoder/MediaTranscoder.java
@@ -15,14 +15,17 @@
  */
 package net.ypresto.androidtranscoder;
 
+import android.media.MediaFormat;
 import android.os.Handler;
 import android.os.Looper;
 import android.util.Log;
 
 import net.ypresto.androidtranscoder.engine.MediaTranscoderEngine;
 import net.ypresto.androidtranscoder.format.MediaFormatPresets;
+import net.ypresto.androidtranscoder.format.MediaFormatStrategy;
 
 import java.io.FileDescriptor;
+import java.io.FileInputStream;
 import java.io.IOException;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.ThreadFactory;
@@ -60,12 +63,93 @@ public static MediaTranscoder getInstance() {
 
     /**
      * Transcodes video file asynchronously.
+     * Audio track will be kept unchanged.
      *
      * @param inFileDescriptor FileDescriptor for input.
      * @param outPath          File path for output.
      * @param listener         Listener instance for callback.
+     * @deprecated Use {@link #transcodeVideo(java.io.FileDescriptor, String, android.media.MediaFormat, net.ypresto.androidtranscoder.MediaTranscoder.Listener)} which accepts output video format.
      */
+    @Deprecated
     public void transcodeVideo(final FileDescriptor inFileDescriptor, final String outPath, final Listener listener) {
+        transcodeVideo(inFileDescriptor, outPath, new MediaFormatStrategy() {
+            @Override
+            public MediaFormat createVideoOutputFormat(MediaFormat inputFormat) {
+                return MediaFormatPresets.getExportPreset960x540();
+            }
+
+            @Override
+            public MediaFormat createAudioOutputFormat(MediaFormat inputFormat) {
+                return null;
+            }
+        }, listener);
+    }
+
+    /**
+     * Transcodes video file asynchronously.
+     * Audio track will be kept unchanged.
+     *
+     * @param inPath            File path for input.
+     * @param outPath           File path for output.
+     * @param outFormatStrategy Strategy for output video format.
+     * @param listener          Listener instance for callback.
+     * @throws IOException if input file could not be read.
+     */
+    public void transcodeVideo(final String inPath, final String outPath, final MediaFormatStrategy outFormatStrategy, final Listener listener) throws IOException {
+        FileInputStream fileInputStream = null;
+        FileDescriptor inFileDescriptor;
+        try {
+            fileInputStream = new FileInputStream(inPath);
+            inFileDescriptor = fileInputStream.getFD();
+        } catch (IOException e) {
+            if (fileInputStream != null) {
+                try {
+                    fileInputStream.close();
+                } catch (IOException eClose) {
+                    Log.e(TAG, "Can't close input stream: ", eClose);
+                }
+            }
+            throw e;
+        }
+        final FileInputStream finalFileInputStream = fileInputStream;
+        transcodeVideo(inFileDescriptor, outPath, outFormatStrategy, new Listener() {
+            @Override
+            public void onTranscodeProgress(double progress) {
+                listener.onTranscodeProgress(progress);
+            }
+
+            @Override
+            public void onTranscodeCompleted() {
+                listener.onTranscodeCompleted();
+                closeStream();
+            }
+
+            @Override
+            public void onTranscodeFailed(Exception exception) {
+                listener.onTranscodeFailed(exception);
+                closeStream();
+            }
+
+            private void closeStream() {
+                try {
+                    finalFileInputStream.close();
+                } catch (IOException e) {
+                    Log.e(TAG, "Can't close input stream: ", e);
+                }
+            }
+        });
+    }
+
+    /**
+     * Transcodes video file asynchronously.
+     * Audio track will be kept unchanged.
+     *
+     * @param inFileDescriptor  FileDescriptor for input.
+     * @param outPath           File path for output.
+     * @param outFormatStrategy Strategy for output video format.
+     * @param listener          Listener instance for callback.
+     */
+    public void transcodeVideo(final FileDescriptor inFileDescriptor, final String outPath, final MediaFormatStrategy outFormatStrategy, final Listener listener) {
         Looper looper = Looper.myLooper();
         if (looper == null) looper = Looper.getMainLooper();
         final Handler handler = new Handler(looper);
@@ -87,7 +171,7 @@ public void run() {
                         }
                     });
                     engine.setDataSource(inFileDescriptor);
-                    engine.transcodeVideo(outPath, MediaFormatPresets.getExportPreset960x540());
+                    engine.transcodeVideo(outPath, outFormatStrategy);
                 } catch (IOException e) {
                     Log.w(TAG, "Transcode failed: input file (fd: " + inFileDescriptor.toString() + ") not found"
                             + " or could not open output file ('" + outPath + "') .", e);
diff --git a/lib/src/main/java/net/ypresto/androidtranscoder/engine/MediaTranscoderEngine.java b/lib/src/main/java/net/ypresto/androidtranscoder/engine/MediaTranscoderEngine.java
@@ -21,24 +21,33 @@
 import android.media.MediaMuxer;
 import android.util.Log;
 
+import net.ypresto.androidtranscoder.format.MediaFormatStrategy;
 import net.ypresto.androidtranscoder.utils.MediaExtractorUtils;
 
 import java.io.FileDescriptor;
 import java.io.IOException;
 
+/**
+ * Internal engine, do not use this directly.
+ */
 // TODO: treat encrypted data
 public class MediaTranscoderEngine {
     private static final String TAG = "MediaTranscoderEngine";
+    private static final double PROGRESS_UNKNOWN = -1.0;
     private static final long SLEEP_TO_WAIT_TRACK_TRANSCODERS = 10;
     private static final long PROGRESS_INTERVAL_STEPS = 10;
     private FileDescriptor mInputFileDescriptor;
     private TrackTranscoder mVideoTrackTranscoder;
     private TrackTranscoder mAudioTrackTranscoder;
     private MediaExtractor mExtractor;
     private MediaMuxer mMuxer;
+    private volatile double mProgress;
     private ProgressCallback mProgressCallback;
     private long mDurationUs;
 
+    /**
+     * Do not use this constructor unless you know what you are doing.
+     */
     public MediaTranscoderEngine() {
     }
 
@@ -54,15 +63,22 @@ public void setProgressCallback(ProgressCallback progressCallback) {
         mProgressCallback = progressCallback;
     }
 
+    /**
+     * NOTE: This method is thread safe.
+     */
+    public double getProgress() {
+        return mProgress;
+    }
+
     /**
      * Run video transcoding. Blocks current thread.
      * Audio data will not be transcoded; original stream will be wrote to output file.
      *
-     * @param outputPath  File path to output transcoded video file.
-     * @param videoFormat Output video format.
+     * @param outputPath     File path to output transcoded video file.
+     * @param formatStrategy Output format strategy.
      * @throws IOException when input or output file could not be opened.
      */
-    public void transcodeVideo(String outputPath, MediaFormat videoFormat) throws IOException {
+    public void transcodeVideo(String outputPath, MediaFormatStrategy formatStrategy) throws IOException {
         if (outputPath == null) {
             throw new NullPointerException("Output path cannot be null.");
         }
@@ -75,7 +91,7 @@ public void transcodeVideo(String outputPath, MediaFormat videoFormat) throws IO
             mExtractor.setDataSource(mInputFileDescriptor);
             mMuxer = new MediaMuxer(outputPath, MediaMuxer.OutputFormat.MUXER_OUTPUT_MPEG_4);
             setupMetadata();
-            setupTrackTranscoders(videoFormat);
+            setupTrackTranscoders(formatStrategy);
             mMuxer.start();
             runPipelines();
             mMuxer.stop();
@@ -132,11 +148,21 @@ private void setupMetadata() throws IOException {
         Log.d(TAG, "Duration (us): " + mDurationUs);
     }
 
-    private void setupTrackTranscoders(MediaFormat outputFormat) {
+    private void setupTrackTranscoders(MediaFormatStrategy formatStrategy) {
         MediaExtractorUtils.TrackResult trackResult = MediaExtractorUtils.getFirstVideoAndAudioTrack(mExtractor);
-        mVideoTrackTranscoder = new VideoTrackTranscoder(mExtractor, trackResult.mVideoTrackIndex, outputFormat, mMuxer);
+        MediaFormat videoOutputFormat = formatStrategy.createVideoOutputFormat(trackResult.mVideoTrackFormat);
+        MediaFormat audioOutputFormat = formatStrategy.createAudioOutputFormat(trackResult.mAudioTrackFormat);
+        if (videoOutputFormat == null) {
+            mVideoTrackTranscoder = new PassThroughTrackTranscoder(mExtractor, trackResult.mVideoTrackIndex, mMuxer);
+        } else {
+            mVideoTrackTranscoder = new VideoTrackTranscoder(mExtractor, trackResult.mVideoTrackIndex, videoOutputFormat, mMuxer);
+        }
         mVideoTrackTranscoder.setup();
-        mAudioTrackTranscoder = new PassThroughTrackTranscoder(mExtractor, trackResult.mAudioTrackIndex, mMuxer);
+        if (audioOutputFormat == null) {
+            mAudioTrackTranscoder = new PassThroughTrackTranscoder(mExtractor, trackResult.mAudioTrackIndex, mMuxer);
+        } else {
+            throw new UnsupportedOperationException("Transcoding audio tracks currently not supported.");
+        }
         mAudioTrackTranscoder.setup();
         mVideoTrackTranscoder.determineFormat();
         mAudioTrackTranscoder.determineFormat();
@@ -148,17 +174,21 @@ private void setupTrackTranscoders(MediaFormat outputFormat) {
 
     private void runPipelines() {
         long loopCount = 0;
-        if (mDurationUs <= 0 && mProgressCallback != null) {
-            mProgressCallback.onProgress(-1.0); // unknown
+        if (mDurationUs <= 0) {
+            double progress = PROGRESS_UNKNOWN;
+            mProgress = progress;
+            if (mProgressCallback != null) mProgressCallback.onProgress(progress); // unknown
         }
         while (!(mVideoTrackTranscoder.isFinished() && mAudioTrackTranscoder.isFinished())) {
             boolean stepped = mVideoTrackTranscoder.stepPipeline()
                     || mAudioTrackTranscoder.stepPipeline();
             loopCount++;
-            if (mDurationUs > 0 && mProgressCallback != null && loopCount % PROGRESS_INTERVAL_STEPS == 0) {
+            if (mDurationUs > 0 && loopCount % PROGRESS_INTERVAL_STEPS == 0) {
                 double videoProgress = mVideoTrackTranscoder.isFinished() ? 1.0 : Math.min(1.0, (double) mVideoTrackTranscoder.getWrittenPresentationTimeUs() / mDurationUs);
                 double audioProgress = mAudioTrackTranscoder.isFinished() ? 1.0 : Math.min(1.0, (double) mAudioTrackTranscoder.getWrittenPresentationTimeUs() / mDurationUs);
-                mProgressCallback.onProgress((videoProgress + audioProgress) / 2.0);
+                double progress = (videoProgress + audioProgress) / 2.0;
+                mProgress = progress;
+                if (mProgressCallback != null) mProgressCallback.onProgress(progress);
             }
             if (!stepped) {
                 try {
diff --git a/lib/src/main/java/net/ypresto/androidtranscoder/format/MediaFormatPresets.java b/lib/src/main/java/net/ypresto/androidtranscoder/format/MediaFormatPresets.java
@@ -22,14 +22,54 @@
 // Refer for preferred parameters: https://developer.apple.com/library/ios/documentation/networkinginternet/conceptual/streamingmediaguide/UsingHTTPLiveStreaming/UsingHTTPLiveStreaming.html#//apple_ref/doc/uid/TP40008332-CH102-SW8
 // Refer for available keys: (ANDROID ROOT)/media/libstagefright/ACodec.cpp
 public class MediaFormatPresets {
+    private static final int LONGER_LENGTH_960x540 = 960;
 
     private MediaFormatPresets() {
     }
 
     // preset similar to iOS SDK's AVAssetExportPreset960x540
+    @Deprecated
     public static MediaFormat getExportPreset960x540() {
         MediaFormat format = MediaFormat.createVideoFormat("video/avc", 960, 540);
-        format.setInteger(MediaFormat.KEY_BIT_RATE, 5400 * 1000);
+        format.setInteger(MediaFormat.KEY_BIT_RATE, 5500 * 1000);
+        format.setInteger(MediaFormat.KEY_COLOR_FORMAT, MediaCodecInfo.CodecCapabilities.COLOR_FormatSurface);
+        format.setInteger(MediaFormat.KEY_FRAME_RATE, 30);
+        format.setInteger(MediaFormat.KEY_I_FRAME_INTERVAL, 1);
+        return format;
+    }
+
+    /**
+     * Preset similar to iOS SDK's AVAssetExportPreset960x540
+     * @param originalWidth Input video width.
+     * @param originalHeight Input video height.
+     * @return MediaFormat instance, or null if pass through.
+     */
+    public static MediaFormat getExportPreset960x540(int originalWidth, int originalHeight) {
+        int longerLength = Math.max(originalWidth, originalHeight);
+        int shorterLength = Math.min(originalWidth, originalHeight);
+
+        if (longerLength <= LONGER_LENGTH_960x540) return null; // don't upscale
+
+        int residue = LONGER_LENGTH_960x540 * shorterLength % longerLength;
+        if (residue != 0) {
+            double ambiguousShorter = (double) LONGER_LENGTH_960x540 * shorterLength / longerLength;
+            throw new IllegalArgumentException(String.format(
+                    "Could not fit to integer, original: (%d, %d), scaled: (%d, %f)",
+                    longerLength, shorterLength, LONGER_LENGTH_960x540, ambiguousShorter));
+        }
+
+        int scaledShorter = LONGER_LENGTH_960x540 * shorterLength / longerLength;
+        int width, height;
+        if (originalWidth >= originalHeight) {
+            width = LONGER_LENGTH_960x540;
+            height = scaledShorter;
+        } else {
+            width = scaledShorter;
+            height = LONGER_LENGTH_960x540;
+        }
+
+        MediaFormat format = MediaFormat.createVideoFormat("video/avc", width, height);
+        format.setInteger(MediaFormat.KEY_BIT_RATE, 5500 * 1000);
         format.setInteger(MediaFormat.KEY_COLOR_FORMAT, MediaCodecInfo.CodecCapabilities.COLOR_FormatSurface);
         format.setInteger(MediaFormat.KEY_FRAME_RATE, 30);
         format.setInteger(MediaFormat.KEY_I_FRAME_INTERVAL, 1);
diff --git a/lib/src/main/java/net/ypresto/androidtranscoder/format/MediaFormatStrategy.java b/lib/src/main/java/net/ypresto/androidtranscoder/format/MediaFormatStrategy.java
diff --git a/lib/src/main/java/net/ypresto/androidtranscoder/format/MediaFormatStrategyPresets.java b/lib/src/main/java/net/ypresto/androidtranscoder/format/MediaFormatStrategyPresets.java
diff --git a/lib/src/main/res/values/strings.xml b/lib/src/main/res/values/strings.xml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-AndroidTranscoder`
	`1`	`+android-transcoder`
`2`	`2`	`=================`
`3`	`3`
`4`	`4`	`Hardware accelerated transcoder for Android, written in pure Java.`