implement custom ffmpeg-kit protocols for android, fixes #39

Author: tanersener

android.sh

@@ -121,6 +121,9 @@ while [ ! $# -eq 0 ]; do
 
     export API=${API_LEVEL}
     ;;
+  --no-ffmpeg-kit-protocols)
+    export NO_FFMPEG_KIT_PROTOCOLS="1"
+    ;;
   *)
     print_unknown_option "$1"
     ;;

android/ffmpeg-kit-android-lib/src/main/cpp/ffmpegkit.c

@@ -25,6 +25,7 @@
 #include "config.h"
 #include "libavcodec/jni.h"
 #include "libavutil/bprint.h"
+#include "libavutil/file.h"
 #include "fftools_ffmpeg.h"
 #include "ffmpegkit.h"
 #include "ffprobekit.h"
@@ -560,12 +561,13 @@ void *callbackThreadFunction() {
 }
 
 /**
- * Used by saf_wrapper; is expected to be called from a Java thread, therefore we don't need attach/detach
+ * Used by fd and saf protocols; is expected to be called from a Java thread, therefore we don't need attach/detach
  */
-void closeParcelFileDescriptor(int fd) {
+int close_parcel_file_descriptor(int fd) {
     JNIEnv *env = NULL;
     (*globalVm)->GetEnv(globalVm, (void**) &env, JNI_VERSION_1_6);
     (*env)->CallStaticVoidMethod(env, configClass, closeParcelFileDescriptorMethod, fd);
+    return 0;
 }
 
 /**
@@ -643,6 +645,8 @@ jint JNI_OnLoad(JavaVM *vm, void *reserved) {
 
     redirectionEnabled = 0;
 
+    av_set_fd_close(close_parcel_file_descriptor);
+
     return JNI_VERSION_1_6;
 }
 

android/ffmpeg-kit-android-lib/src/main/cpp/fftools_cmdutils.h

@@ -51,8 +51,6 @@
 #include "libavformat/avformat.h"
 #include "libswscale/swscale.h"
 
-#include "saf_wrapper.h"
-
 #ifdef _WIN32
 #undef main /* We don't want SDL to override our main() */
 #endif

android/ffmpeg-kit-android-lib/src/main/cpp/saf_wrapper.c

@@ -40,6 +40,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
+import java.util.StringTokenizer;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
@@ -831,6 +832,20 @@ public static void setLogLevel(final Level level) {
         }
     }
 
+    static String extractExtensionFromSafDisplayName(final String safDisplayName) {
+        String rawExtension = safDisplayName;
+        if (safDisplayName.lastIndexOf(".") >= 0) {
+            rawExtension = safDisplayName.substring(safDisplayName.lastIndexOf("."));
+        }
+        try {
+            // workaround for https://issuetracker.google.com/issues/162440528: ANDROID_CREATE_DOCUMENT generating file names like "transcode.mp3 (2)"
+            return new StringTokenizer(rawExtension, " .").nextToken();
+        } catch (final Exception e) {
+            android.util.Log.w(TAG, String.format("Failed to extract extension from saf display name: %s.%s", safDisplayName, Exceptions.getStackTraceString(e)));
+            return "raw";
+        }
+    }
+
     /**
      * <p>Converts the given Structured Access Framework Uri (<code>"content:…"</code>) into an
      * input/output url that can be used in FFmpeg and FFprobe commands.
@@ -863,14 +878,7 @@ private static String getSafParameter(final Context context, final Uri uri, fina
             android.util.Log.e(TAG, String.format("Failed to obtain %s parcelFileDescriptor for %s.%s", openMode, uri.toString(), Exceptions.getStackTraceString(t)));
         }
 
-        // workaround for https://issuetracker.google.com/issues/162440528: ANDROID_CREATE_DOCUMENT generating file names like "transcode.mp3 (2)"
-        if (displayName.lastIndexOf('.') > 0 && displayName.lastIndexOf(' ') > displayName.lastIndexOf('.')) {
-            String extension = displayName.substring(displayName.lastIndexOf('.'), displayName.lastIndexOf(' '));
-            displayName += extension;
-        }
-        // spaces can break argument list parsing, see https://github.com/alexcohn/mobile-ffmpeg/pull/1#issuecomment-688643836
-        final char NBSP = (char) 0xa0;
-        return "saf:" + fd + "/" + displayName.replace(' ', NBSP);
+        return "saf:" + fd + "." + FFmpegKitConfig.extractExtensionFromSafDisplayName(displayName);
     }
 
     /**
@@ -880,7 +888,7 @@ private static String getSafParameter(final Context context, final Uri uri, fina
      * <p>Requires API Level &ge; 19. On older API levels it returns an empty url.
      *
      * @param context application context
-     * @param uri saf uri
+     * @param uri     saf uri
      * @return input url that can be passed to FFmpegKit or FFprobeKit
      */
     public static String getSafParameterForRead(final Context context, final Uri uri) {
@@ -894,7 +902,7 @@ public static String getSafParameterForRead(final Context context, final Uri uri
      * <p>Requires API Level &ge; 19. On older API levels it returns an empty url.
      *
      * @param context application context
-     * @param uri saf uri
+     * @param uri     saf uri
      * @return output url that can be passed to FFmpegKit or FFprobeKit
      */
     public static String getSafParameterForWrite(final Context context, final Uri uri) {

android/ffmpeg-kit-android-lib/src/main/cpp/saf_wrapper.h

@@ -32,6 +32,10 @@
  */
 public class FFmpegKitConfigTest {
 
+    static {
+        System.setProperty("enable.ffmpeg.kit.test.mode", "true");
+    }
+
     private static final String externalLibrariesCommandOutput = "   configuration:\n" +
             "                          --cross-prefix=i686-linux-android-\n" +
             "                          --sysroot=/Users/taner/Library/Android/sdk/ndk-bundle/toolchains/ffmpeg-kit-i686/sysroot\n" +
@@ -152,6 +156,21 @@ public void getPackageName() {
         Assert.assertEquals("https-gpl", listToPackageName(Arrays.asList("gnutls", "xvidcore")));
     }
 
+    @Test
+    public void extractExtensionFromSafDisplayName() {
+        String extension = FFmpegKitConfig.extractExtensionFromSafDisplayName("video.mp4 (2)");
+        Assert.assertEquals("mp4", extension);
+
+        extension = FFmpegKitConfig.extractExtensionFromSafDisplayName("video file name.mp3 (2)");
+        Assert.assertEquals("mp3", extension);
+
+        extension = FFmpegKitConfig.extractExtensionFromSafDisplayName("file.mp4");
+        Assert.assertEquals("mp4", extension);
+
+        extension = FFmpegKitConfig.extractExtensionFromSafDisplayName("file name.mp4");
+        Assert.assertEquals("mp4", extension);
+    }
+
     private String listToPackageName(final List<String> externalLibraryList) {
         boolean speex = externalLibraryList.contains("speex");
         boolean fribidi = externalLibraryList.contains("fribidi");

android/ffmpeg-kit-android-lib/src/main/java/com/arthenica/ffmpegkit/FFmpegKitConfig.java

@@ -63,7 +63,7 @@ include $(BUILD_SHARED_LIBRARY)
 
 $(call import-module, cpu-features)
 
-MY_SRC_FILES := ffmpegkit.c ffprobekit.c ffmpegkit_exception.c fftools_cmdutils.c fftools_ffmpeg.c fftools_ffprobe.c fftools_ffmpeg_opt.c fftools_ffmpeg_hw.c fftools_ffmpeg_filter.c saf_wrapper.c
+MY_SRC_FILES := ffmpegkit.c ffprobekit.c ffmpegkit_exception.c fftools_cmdutils.c fftools_ffmpeg.c fftools_ffprobe.c fftools_ffmpeg_opt.c fftools_ffmpeg_hw.c fftools_ffmpeg_filter.c
 
 ifeq ($(TARGET_PLATFORM),android-16)
     MY_SRC_FILES += android_lts_support.c

android/ffmpeg-kit-android-lib/src/test/java/com/arthenica/ffmpegkit/FFmpegKitConfigTest.java

@@ -350,6 +350,12 @@ export CFLAGS="${HIGH_PRIORITY_INCLUDES} ${CFLAGS}"
 ulimit -n 2048 1>>"${BASEDIR}"/build.log 2>&1
 
 ########################### CUSTOMIZATIONS #######################
+cd "${BASEDIR}" 1>>"${BASEDIR}"/build.log 2>&1 || exit 1
+git checkout android/ffmpeg-kit-android-lib/src/main/cpp/ffmpegkit.c 1>>"${BASEDIR}"/build.log 2>&1
+cd "${BASEDIR}"/src/"${LIB_NAME}" 1>>"${BASEDIR}"/build.log 2>&1 || exit 1
+git checkout libavformat/file.c 1>>"${BASEDIR}"/build.log 2>&1
+git checkout libavformat/protocols.c 1>>"${BASEDIR}"/build.log 2>&1
+git checkout libavutil 1>>"${BASEDIR}"/build.log 2>&1
 
 # 1. Use thread local log levels
 ${SED_INLINE} 's/static int av_log_level/__thread int av_log_level/g' "${BASEDIR}"/src/"${LIB_NAME}"/libavutil/log.c 1>>"${BASEDIR}"/build.log 2>&1 || exit 1
@@ -358,6 +364,19 @@ ${SED_INLINE} 's/static int av_log_level/__thread int av_log_level/g' "${BASEDIR
 FFMPEG_VERSION="v$(get_user_friendly_ffmpeg_version)"
 ${SED_INLINE} "s/\$version/$FFMPEG_VERSION/g" "${BASEDIR}"/src/"${LIB_NAME}"/ffbuild/version.sh 1>>"${BASEDIR}"/build.log 2>&1 || exit 1
 
+# 3. Enable ffmpeg-kit protocols
+if [[ ${NO_FFMPEG_KIT_PROTOCOLS} == "1" ]]; then
+  ${SED_INLINE} "s/ av_set_fd_close/\/\/av_set_fd_close/g" "${BASEDIR}"/android/ffmpeg-kit-android-lib/src/main/cpp/ffmpegkit.c 1>>"${BASEDIR}"/build.log 2>&1
+  echo -e "\nINFO: Disabled custom ffmpeg-kit protocols\n" 1>>"${BASEDIR}"/build.log 2>&1
+else
+  cat ../../tools/protocols/libavformat_file.c >> libavformat/file.c
+  cat ../../tools/protocols/libavutil_file.h >> libavutil/file.h
+  cat ../../tools/protocols/libavutil_file.c >> libavutil/file.c
+  awk '{gsub(/ff_file_protocol;/,"ff_file_protocol;\nextern const URLProtocol ff_saf_protocol;")}1' libavformat/protocols.c > libavformat/protocols.c.tmp
+  awk '{gsub(/ff_file_protocol;/,"ff_file_protocol;\nextern const URLProtocol ff_fd_protocol;")}1' libavformat/protocols.c.tmp > libavformat/protocols.c
+  echo -e "\nINFO: Enabled custom ffmpeg-kit protocols\n" 1>>"${BASEDIR}"/build.log 2>&1
+fi
+
 ###################################################################
 
 ./configure \

android/jni/Android.mk

@@ -423,6 +423,9 @@ if [[ -z ${NO_WORKSPACE_CLEANUP_ffmpeg} ]]; then
 fi
 
 ########################### CUSTOMIZATIONS #######################
+git checkout libavformat/file.c 1>>"${BASEDIR}"/build.log 2>&1
+git checkout libavformat/protocols.c 1>>"${BASEDIR}"/build.log 2>&1
+git checkout libavutil 1>>"${BASEDIR}"/build.log 2>&1
 
 # 1. Workaround to prevent adding of -mdynamic-no-pic flag
 ${SED_INLINE} 's/check_cflags -mdynamic-no-pic && add_asflags -mdynamic-no-pic;/check_cflags -mdynamic-no-pic;/g' ./configure 1>>"${BASEDIR}"/build.log 2>&1 || exit 1

scripts/android/ffmpeg.sh

@@ -31,7 +31,7 @@ under the prebuilt folder.\n"
   echo -e "Usage: ./$COMMAND [OPTION]... [VAR=VALUE]...\n"
   echo -e "Specify environment variables as VARIABLE=VALUE to override default build options.\n"
 
-  display_help_options "  -l, --lts\t\t\tbuild lts packages to support API 16+ devices" "      --api-level=api\t\toverride Android api level [${API}]"
+  display_help_options "  -l, --lts\t\t\tbuild lts packages to support API 16+ devices" "      --api-level=api\t\toverride Android api level" "      --no-ffmpeg-kit-protocols\tdisable custom ffmpeg-kit protocols (fd, saf)"
   display_help_licensing
 
   echo -e "Architectures:"