react-native-compressor 1.18.2 → 2.0.0

package/android/src/main/java/com/reactnativecompressor/Video/VideoCompressor/compressor/Compressor.kt

@@ -2,6 +2,8 @@ package com.reactnativecompressor.Video.VideoCompressor.compressor
 
 import android.content.Context
 import android.media.MediaCodec
+import android.media.MediaCodecInfo
+import android.media.MediaCodecList
 import android.media.MediaExtractor
 import android.media.MediaFormat
 import android.media.MediaMetadataRetriever
@@ -9,6 +11,7 @@ import android.net.Uri
 import android.os.Build
 import android.util.Log
 import com.reactnativecompressor.Video.VideoCompressor.CompressionProgressListener
+import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.ensureDecodableVideoFormat
 import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.findTrack
 import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.hasQTI
 import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.prepareVideoHeight
@@ -16,6 +19,7 @@ import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.pre
 import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.printException
 import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.setOutputFileParameters
 import com.reactnativecompressor.Video.VideoCompressor.utils.CompressorUtils.setUpMP4Movie
+import com.reactnativecompressor.Video.VideoCompressor.utils.LocationExtractor
 import com.reactnativecompressor.Video.VideoCompressor.utils.StreamableVideo
 import com.reactnativecompressor.Video.VideoCompressor.video.InputSurface
 import com.reactnativecompressor.Video.VideoCompressor.video.MP4Builder
@@ -97,6 +101,29 @@ object Compressor {
     val rotationData = mediaMetadataRetriever.extractMetadata(MediaMetadataRetriever.METADATA_KEY_VIDEO_ROTATION)
     val bitrateData = mediaMetadataRetriever.extractMetadata(MediaMetadataRetriever.METADATA_KEY_BITRATE)
     val durationData = mediaMetadataRetriever.extractMetadata(MediaMetadataRetriever.METADATA_KEY_DURATION)
+    // ISO 6709 string (e.g. "+37.4220-122.0840/"). Forwarded into the
+    // output udta/©xyz box so GPS metadata survives the rewrite.
+    //
+    // Some Samsung firmwares (S10 / Android 12) place "©xyz" in the
+    // per-track udta, or use a 'loci' box, or iTunes-style meta/keys+ilst.
+    // MediaMetadataRetriever only reads moov/udta/©xyz — returning null
+    // (or empty) and dropping GPS. Fall back to a raw MP4 walker that
+    // scans the whole file for every known location encoding.
+    val retrievedLocation =
+      mediaMetadataRetriever.extractMetadata(MediaMetadataRetriever.METADATA_KEY_LOCATION)
+    val locationData = if (!retrievedLocation.isNullOrEmpty()) {
+      retrievedLocation
+    } else {
+      LocationExtractor.extract(context, srcUri)
+    }
+    // Never log the resolved ISO 6709 string — it is the user's exact GPS
+    // coordinates. Log only presence and which mechanism resolved it.
+    val locationSource = when {
+      !retrievedLocation.isNullOrEmpty() -> "retriever"
+      !locationData.isNullOrEmpty() -> "extractor"
+      else -> "none"
+    }
+    Log.i("Compressor", "source location resolved: hasLocation=${!locationData.isNullOrEmpty()} source=$locationSource")
 
     // Check if any metadata is missing
     if (rotationData.isNullOrEmpty() || bitrateData.isNullOrEmpty() || durationData.isNullOrEmpty()) {
@@ -142,7 +169,8 @@ object Compressor {
       extractor,
       listener,
       duration,
-      rotation
+      rotation,
+      locationData,
     )
   }
 
@@ -160,31 +188,50 @@ object Compressor {
     extractor: MediaExtractor,
     compressionProgressListener: CompressionProgressListener,
     duration: Long,
-    rotation: Int
+    rotation: Int,
+    location: String?,
   ): Result {
     // Check if newWidth and newHeight are valid
     if (newWidth != 0 && newHeight != 0) {
       // Create a cache file for the compressed video
       val cacheFile = File(destination)
 
+      // Hoisted so the outer catch can close the muxer even though the val
+      // below is scoped to the try. Stays null until createMovie() succeeds.
+      var muxer: MP4Builder? = null
+
       try {
         // MediaCodec accesses encoder and decoder components and processes the new video
         // input to generate a compressed/smaller size video
         val bufferInfo = MediaCodec.BufferInfo()
 
-        // Setup mp4 movie
-        val movie = setUpMP4Movie(rotation, cacheFile)
-
-        // MediaMuxer outputs MP4 in this app
-        val mediaMuxer = MP4Builder().createMovie(movie)
-
-        // Start with the video track
+        // Resolve the source video track and its format BEFORE allocating the
+        // muxer, encoder or EGL surfaces. Dolby Vision profile 5 has no HEVC
+        // base layer and cannot be transcoded; rejecting it here — instead of
+        // inside prepareDecoder, after the muxer file stream, encoder and EGL
+        // surfaces are already live — avoids leaking those resources on bail-out.
         val videoIndex = findTrack(extractor, isVideo = true)
 
         extractor.selectTrack(videoIndex)
         extractor.seekTo(0, MediaExtractor.SEEK_TO_PREVIOUS_SYNC)
         val inputFormat = extractor.getTrackFormat(videoIndex)
 
+        if (isUnsupportedDolbyVision(inputFormat)) {
+          runCatching { extractor.release() }
+          return Result(
+            id,
+            success = false,
+            failureMessage = "Dolby Vision profile 5 has no HEVC base layer; cannot transcode"
+          )
+        }
+
+        // Setup mp4 movie
+        val movie = setUpMP4Movie(rotation, cacheFile, location)
+
+        // MediaMuxer outputs MP4 in this app
+        val mediaMuxer = MP4Builder().createMovie(movie)
+        muxer = mediaMuxer
+
         val outputFormat: MediaFormat =
           MediaFormat.createVideoFormat(MIME_TYPE, newWidth, newHeight)
 
@@ -196,16 +243,31 @@ object Compressor {
           outputFrameRate,
         )
 
-        val decoder: MediaCodec
-
         // Check if QTI hardware acceleration is available
         val hasQTI = hasQTI()
 
-        // Prepare the video encoder
-        val encoder = prepareEncoder(outputFormat, hasQTI)
+        // Prepare the video encoder. If the encoder rejects the throughput-tuned
+        // format at configure() time, prepareEncoder reconfigures using this
+        // baseline format (same params, no VBR/priority/operating-rate keys).
+        val encoder = prepareEncoder(outputFormat, hasQTI) {
+          MediaFormat.createVideoFormat(MIME_TYPE, newWidth, newHeight).also {
+            setOutputFileParameters(
+              inputFormat,
+              it,
+              newBitrate,
+              outputFrameRate,
+              applyThroughputTuning = false,
+            )
+          }
+        }
 
-        val inputSurface: InputSurface
-        val outputSurface: OutputSurface
+        // Track pipeline handles as they come up so a failure mid-setup
+        // (EGL/GL init, decoder configure, encoder.start) releases whatever was
+        // already created instead of leaking it. The encoder above is always
+        // non-null by this point.
+        var decoderRef: MediaCodec? = null
+        var inputSurfaceRef: InputSurface? = null
+        var outputSurfaceRef: OutputSurface? = null
 
         try {
           var inputDone = false
@@ -213,32 +275,58 @@ object Compressor {
 
           var videoTrackIndex = -5
 
-          inputSurface = InputSurface(encoder.createInputSurface())
+          // Frame dropping: when source fps is higher than target output fps,
+          // skip decoded frames whose PTS falls before the next target slot.
+          // Saves GL render + encoder work proportional to the drop ratio
+          // (e.g. 60fps → 30fps cuts pipeline work roughly in half).
+          //
+          // Only enable dropping when the source frame rate is reliably
+          // higher than the target. If the source advertises 30 fps and the
+          // target is 30 fps, even tiny PTS jitter can push a frame just
+          // before its slot, get it dropped, and turn 30 fps output into
+          // 20 fps — the choppy playback users reported.
+          val sourceFrameRate: Int = if (inputFormat.containsKey(MediaFormat.KEY_FRAME_RATE)) {
+            inputFormat.getInteger(MediaFormat.KEY_FRAME_RATE)
+          } else 0
+          val shouldDropFrames = outputFrameRate > 0 &&
+            sourceFrameRate > 0 &&
+            outputFrameRate < sourceFrameRate
+          val targetFrameIntervalUs: Long =
+            if (shouldDropFrames) 1_000_000L / outputFrameRate else 0L
+          var nextTargetPtsUs: Long = 0L
+
+          val inputSurface = InputSurface(encoder.createInputSurface())
+          inputSurfaceRef = inputSurface
           inputSurface.makeCurrent()
           // Move to executing state
           encoder.start()
 
-          outputSurface = OutputSurface()
+          val outputSurface = OutputSurface()
+          outputSurfaceRef = outputSurface
 
-          decoder = prepareDecoder(inputFormat, outputSurface)
+          val decoder = prepareDecoder(inputFormat, outputSurface)
+          decoderRef = decoder
 
           // Move to executing state
           decoder.start()
 
           while (!outputDone) {
             if (!inputDone) {
-
-                            val index = extractor.sampleTrackIndex
-
-                            if (index == videoIndex) {
-                                val inputBufferIndex =
-                                    decoder.dequeueInputBuffer(MEDIACODEC_TIMEOUT_DEFAULT)
-                                if (inputBufferIndex >= 0) {
+                            // Feed the decoder until it has no free input slots or the
+                            // extractor is empty. HW codecs typically have 4-8 input
+                            // slots; queuing only one sample per outer iteration starves
+                            // the pipeline and forces serial decode-render-encode.
+                            feedLoop@ while (!inputDone) {
+                                val index = extractor.sampleTrackIndex
+
+                                if (index == videoIndex) {
+                                    val inputBufferIndex =
+                                        decoder.dequeueInputBuffer(0L)
+                                    if (inputBufferIndex < 0) break@feedLoop
                                     val inputBuffer = decoder.getInputBuffer(inputBufferIndex)
                                     val chunkSize = extractor.readSampleData(inputBuffer!!, 0)
                                     when {
                                         chunkSize < 0 -> {
-
                                             decoder.queueInputBuffer(
                                                 inputBufferIndex,
                                                 0,
@@ -249,7 +337,6 @@ object Compressor {
                                             inputDone = true
                                         }
                                         else -> {
-
                                             decoder.queueInputBuffer(
                                                 inputBufferIndex,
                                                 0,
@@ -258,15 +345,12 @@ object Compressor {
                                                 0
                                             )
                                             extractor.advance()
-
                                         }
                                     }
-                                }
-
-                            } else if (index == -1) { //end of file
-                                val inputBufferIndex =
-                                    decoder.dequeueInputBuffer(MEDIACODEC_TIMEOUT_DEFAULT)
-                                if (inputBufferIndex >= 0) {
+                                } else if (index == -1) { //end of file
+                                    val inputBufferIndex =
+                                        decoder.dequeueInputBuffer(0L)
+                                    if (inputBufferIndex < 0) break@feedLoop
                                     decoder.queueInputBuffer(
                                         inputBufferIndex,
                                         0,
@@ -275,6 +359,9 @@ object Compressor {
                                         MediaCodec.BUFFER_FLAG_END_OF_STREAM
                                     )
                                     inputDone = true
+                                } else {
+                                    // Different track type at head of extractor (audio etc.).
+                                    break@feedLoop
                                 }
                             }
                         }
@@ -353,7 +440,27 @@ object Compressor {
                                 }
                                 decoderStatus < 0 -> throw RuntimeException("unexpected result from decoder.dequeueOutputBuffer: $decoderStatus")
                                 else -> {
-                                    val doRender = bufferInfo.size != 0
+                                    val isEos = (bufferInfo.flags and MediaCodec.BUFFER_FLAG_END_OF_STREAM) != 0
+                                    var doRender = bufferInfo.size != 0 && !isEos
+
+                                    // Drop frames whose PTS falls before the next target slot.
+                                    // Anchor the next slot to the ideal grid (previous slot +
+                                    // interval) instead of to the actual PTS — anchoring to PTS
+                                    // lets source-side jitter compound into extra drops, which
+                                    // collapses the output frame rate well below the target.
+                                    if (doRender && targetFrameIntervalUs > 0L) {
+                                        if (bufferInfo.presentationTimeUs < nextTargetPtsUs) {
+                                            doRender = false
+                                        } else {
+                                            nextTargetPtsUs += targetFrameIntervalUs
+                                            // Snap forward when the source skips past a slot
+                                            // (gap, seek, very low source fps) so the gate doesn't
+                                            // burst-emit every following frame.
+                                            if (bufferInfo.presentationTimeUs >= nextTargetPtsUs) {
+                                                nextTargetPtsUs = bufferInfo.presentationTimeUs + targetFrameIntervalUs
+                                            }
+                                        }
+                                    }
 
                                     decoder.releaseOutputBuffer(decoderStatus, doRender)
                                     if (doRender) {
@@ -392,16 +499,32 @@ object Compressor {
 
         } catch (exception: Throwable) {
           printException(exception)
+          // Release whatever was initialized before the failure. Setup errors
+          // (EGL/GL init, decoder configure, encoder.start) and in-loop throws
+          // land here; without this the encoder + EGL surfaces would leak and
+          // break the next compression. dispose() tolerates the null handles
+          // that occur when the failure happens mid-setup.
+          dispose(
+            videoIndex,
+            decoderRef,
+            encoder,
+            inputSurfaceRef,
+            outputSurfaceRef,
+            extractor
+          )
+          // finishMovie() never runs on this path, so close the MP4Builder
+          // streams explicitly or the output file handle leaks.
+          mediaMuxer.close()
           return Result(id, success = false, failureMessage = exception.message)
         }
 
         // Release resources
         dispose(
           videoIndex,
-          decoder,
+          decoderRef,
           encoder,
-          inputSurface,
-          outputSurface,
+          inputSurfaceRef,
+          outputSurfaceRef,
           extractor
         )
 
@@ -418,18 +541,27 @@ object Compressor {
           mediaMuxer.finishMovie()
         } catch (e: Throwable) {
           printException(e)
+          // finishMovie() may throw before it closes its own streams; close
+          // them here so a finalize failure doesn't leak the file handle.
+          mediaMuxer.close()
           return Result(id, success = false, failureMessage = e.message ?: "Failed to finalize compressed video")
         }
 
       } catch (exception: Throwable) {
         printException(exception)
+        // Covers throws after the inner pipeline closed (e.g. processAudio,
+        // extractor.release) where the MP4Builder is still open. close() is
+        // idempotent, so calling it after a successful finishMovie() is a no-op.
+        muxer?.close()
         return Result(id, success = false, failureMessage = exception.message)
       }
 
       var resultFile = cacheFile
 
       try {
-        // Keep default outputs browser-compatible by moving the MP4 metadata before media data.
+        // Keep default outputs browser/progressive-playback compatible by moving the
+        // MP4 moov atom in front of the media data. This runs for every output; when
+        // no explicit streamableFile is requested, the rewritten copy replaces cacheFile.
         val targetFile = streamableFile?.let { File(it) } ?: getStreamableOutputFile(cacheFile)
         val outputFile = if (targetFile.absolutePath == cacheFile.absolutePath) {
           getStreamableOutputFile(cacheFile)
@@ -547,25 +679,109 @@ object Compressor {
     }
 
   // Function to prepare the video encoder
-    private fun prepareEncoder(outputFormat: MediaFormat, hasQTI: Boolean): MediaCodec {
-
-        // This seems to cause an issue with certain phones
-        // val encoderName = MediaCodecList(REGULAR_CODECS).findEncoderForFormat(outputFormat)
-        // val encoder: MediaCodec = MediaCodec.createByCodecName(encoderName)
-        // Log.i("encoderName", encoder.name)
-        // c2.qti.avc.encoder results in a corrupted .mp4 video that does not play in
-        // Mac and iphones
-        val encoder = if (hasQTI) {
+    private fun prepareEncoder(
+        outputFormat: MediaFormat,
+        hasQTI: Boolean,
+        baselineFormatProvider: () -> MediaFormat,
+    ): MediaCodec {
+        // Prefer hardware AVC encoder while skipping known-broken QTI codec that
+        // produces files unplayable on Mac/iOS (c2.qti.avc.encoder).
+        val encoder = pickAvcEncoder(outputFormat, hasQTI)
+        try {
+            encoder.configure(
+                outputFormat, null, null,
+                MediaCodec.CONFIGURE_FLAG_ENCODE
+            )
+            Log.i("Compressor", "encoder selected: ${encoder.name}")
+            return encoder
+        } catch (e: Exception) {
+            // Some encoders reject the throughput-tuning keys (VBR bitrate mode,
+            // priority, operating rate) at configure() time. A codec that throws
+            // from configure() is unusable, so release it and retry on a fresh
+            // codec with a baseline format (default rate control) rather than
+            // failing the whole compression.
+            Log.w(
+                "Compressor",
+                "encoder.configure rejected tuned format; retrying with default settings",
+                e
+            )
+            runCatching { encoder.release() }
+        }
+
+        val baseline = baselineFormatProvider()
+        val fallback = pickAvcEncoder(baseline, hasQTI)
+        try {
+            fallback.configure(
+                baseline, null, null,
+                MediaCodec.CONFIGURE_FLAG_ENCODE
+            )
+        } catch (e: Exception) {
+            // Even the baseline format was rejected; release the codec so it
+            // doesn't leak, then let start()'s outer catch report the failure.
+            runCatching { fallback.release() }
+            throw e
+        }
+        Log.i("Compressor", "encoder selected (fallback, default rate control): ${fallback.name}")
+        return fallback
+    }
+
+    private fun pickAvcEncoder(outputFormat: MediaFormat, hasQTI: Boolean): MediaCodec {
+        // ALL_CODECS surfaces vendor codecs that REGULAR_CODECS hides (e.g. some
+        // Exynos / MTK HW encoders). We still filter blacklisted / SW codecs below.
+        val codecList = MediaCodecList(MediaCodecList.ALL_CODECS)
+        val candidates = codecList.codecInfos.filter { info ->
+            info.isEncoder && info.supportedTypes.any { it.equals(MIME_TYPE, ignoreCase = true) }
+        }
+
+        fun isBlacklisted(name: String): Boolean {
+            val lower = name.lowercase()
+            return lower.contains("c2.qti.avc.encoder") || lower.contains("omx.qcom.video.encoder.avc.secure")
+        }
+
+        fun isSoftware(info: MediaCodecInfo): Boolean {
+            val name = info.name.lowercase()
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+                if (info.isSoftwareOnly) return true
+            }
+            return name.startsWith("omx.google.") ||
+                name.startsWith("c2.android.") ||
+                name.contains(".sw.")
+        }
+
+        val supportsFormat = candidates.filter { info ->
+            runCatching {
+                info.getCapabilitiesForType(MIME_TYPE).isFormatSupported(outputFormat)
+            }.getOrDefault(false) && !isBlacklisted(info.name)
+        }
+
+        val hardwareFirst = supportsFormat.firstOrNull { !isSoftware(it) }
+        val chosen = hardwareFirst ?: supportsFormat.firstOrNull()
+
+        if (chosen != null) {
+            return MediaCodec.createByCodecName(chosen.name)
+        }
+
+        // Fallback: keep historical QTI-safe path when format probing fails.
+        return if (hasQTI) {
             MediaCodec.createByCodecName("c2.android.avc.encoder")
         } else {
             MediaCodec.createEncoderByType(MIME_TYPE)
         }
-        encoder.configure(
-            outputFormat, null, null,
-            MediaCodec.CONFIGURE_FLAG_ENCODE
-        )
+    }
 
-        return encoder
+  // Dolby Vision profile 5 (0x20) carries no HEVC base layer, so no standard
+  // Android decoder can render it. Detect it up front so start() can reject the
+  // input before allocating the muxer/encoder/EGL surfaces. Profiles 8.x do carry
+  // an HEVC base layer and are remapped to HEVC in prepareDecoder.
+    private fun isUnsupportedDolbyVision(inputFormat: MediaFormat): Boolean {
+        val mime = inputFormat.getString(MediaFormat.KEY_MIME) ?: return false
+        if (!mime.equals("video/dolby-vision", ignoreCase = true)) return false
+        val profile = if (inputFormat.containsKey(MediaFormat.KEY_PROFILE)) {
+            inputFormat.getInteger(MediaFormat.KEY_PROFILE)
+        } else {
+            -1
+        }
+        return profile == 0x20
     }
 
   // Function to prepare the video decoder
@@ -573,42 +789,61 @@ object Compressor {
         inputFormat: MediaFormat,
         outputSurface: OutputSurface,
     ): MediaCodec {
-        // This seems to cause an issue with certain phones
-        // val decoderName =
-        //    MediaCodecList(REGULAR_CODECS).findDecoderForFormat(inputFormat)
-        // val decoder = MediaCodec.createByCodecName(decoderName)
-        // Log.i("decoderName", decoder.name)
 
-        // val decoder = if (hasQTI) {
-        // MediaCodec.createByCodecName("c2.android.avc.decoder")
-        //} else {
+        // Some inputs (e.g. iPhone .MOV files) report a "video/dolby-vision" MIME
+        // type that many devices cannot decode. Remap to a decodable base-layer
+        // codec, or fail with a clear error, before creating the decoder (#398).
+        ensureDecodableVideoFormat(inputFormat)
+
+        // Clear Dolby Vision specific profile and level to prevent configuration failures
+        // when the MIME type has been remapped to AVC/HEVC.
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+            inputFormat.removeKey(MediaFormat.KEY_PROFILE)
+            inputFormat.removeKey(MediaFormat.KEY_LEVEL)
+        }
 
         val decoder = MediaCodec.createDecoderByType(inputFormat.getString(MediaFormat.KEY_MIME)!!)
-        //}
 
         decoder.configure(inputFormat, outputSurface.getSurface(), null, 0)
 
         return decoder
     }
 
-  // Function to release resources
+  // Function to release resources.
+  // Every call is wrapped in runCatching so a failure in one teardown step
+  // does not skip the others (leaking codec handles + GL surfaces). Order:
+  // detach extractor → stop+release decoder → stop+release encoder →
+  // release input EGL surface → release output surface (joins its
+  // HandlerThread). Releasing surfaces last avoids the encoder asking a
+  // freed EGL surface for buffers during its own shutdown.
+  //
+  // decoder / inputSurface / outputSurface are nullable so this also serves the
+  // partial-init cleanup path, where a setup failure leaves some handles
+  // uncreated. The encoder is always created before teardown is reachable.
     private fun dispose(
         videoIndex: Int,
-        decoder: MediaCodec,
+        decoder: MediaCodec?,
         encoder: MediaCodec,
-        inputSurface: InputSurface,
-        outputSurface: OutputSurface,
+        inputSurface: InputSurface?,
+        outputSurface: OutputSurface?,
         extractor: MediaExtractor
     ) {
-        extractor.unselectTrack(videoIndex)
-
-        decoder.stop()
-        decoder.release()
-
-        encoder.stop()
-        encoder.release()
-
-        inputSurface.release()
-        outputSurface.release()
+        runCatching { extractor.unselectTrack(videoIndex) }
+            .onFailure { Log.w("Compressor", "extractor.unselectTrack failed", it) }
+
+        runCatching { decoder?.stop() }
+            .onFailure { Log.w("Compressor", "decoder.stop failed", it) }
+        runCatching { decoder?.release() }
+            .onFailure { Log.w("Compressor", "decoder.release failed", it) }
+
+        runCatching { encoder.stop() }
+            .onFailure { Log.w("Compressor", "encoder.stop failed", it) }
+        runCatching { encoder.release() }
+            .onFailure { Log.w("Compressor", "encoder.release failed", it) }
+
+        runCatching { inputSurface?.release() }
+            .onFailure { Log.w("Compressor", "inputSurface.release failed", it) }
+        runCatching { outputSurface?.release() }
+            .onFailure { Log.w("Compressor", "outputSurface.release failed", it) }
     }
 }