fix(Android): CSD ignored for flac recording.

fixes #540

Author: llfbandit

record_android/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.4.2
+* fix: Flac recording failure by isolating CSD frame skipping.
+
 ## 1.4.1
 * fix: Calling stop never ends when not recording.
 * fix: Update max amplitude when streaming.

record_android/android/src/main/kotlin/com/llfbandit/record/record/container/FlacContainer.kt

@@ -17,7 +17,7 @@ class FlacContainer(path: String) : IContainerWriter {
 
   override fun start() {
     if (isStarted) {
-      throw IllegalStateException("Container already started")
+      throw Exception("Container already started")
     }
 
     Os.lseek(file.fd, 0, OsConstants.SEEK_SET)
@@ -27,7 +27,9 @@ class FlacContainer(path: String) : IContainerWriter {
   }
 
   override fun stop() {
-    check(isStarted) { "Container not started" }
+    if (!isStarted) {
+      throw Exception("Container not started")
+    }
 
     isStarted = false
 
@@ -46,9 +48,9 @@ class FlacContainer(path: String) : IContainerWriter {
 
   override fun addTrack(mediaFormat: MediaFormat): Int {
     if (isStarted) {
-      throw IllegalStateException("Container already started")
+      throw Exception("Container already started")
     } else if (track >= 0) {
-      throw IllegalStateException("Track already added")
+      throw Exception("Track already added")
     }
 
     track = 0
@@ -61,11 +63,11 @@ class FlacContainer(path: String) : IContainerWriter {
     bufferInfo: MediaCodec.BufferInfo
   ) {
     if (!isStarted) {
-      throw IllegalStateException("Container not started")
+      throw Exception("Container not started")
     } else if (track < 0) {
-      throw IllegalStateException("No track has been added")
+      throw Exception("No track has been added")
     } else if (track != trackIndex) {
-      throw IllegalStateException("Invalid track: $trackIndex")
+      throw Exception("Invalid track: $trackIndex")
     }
 
     Os.write(file.fd, byteBuffer)

record_android/android/src/main/kotlin/com/llfbandit/record/record/container/IContainerWriter.kt

@@ -82,4 +82,9 @@ interface IContainerWriter {
 
     return out
   }
+
+  /**
+   * If true, ignores samples flagged as [MediaCodec.BUFFER_FLAG_CODEC_CONFIG].
+   */
+  fun ignoreCodecSpecificData(): Boolean = false
 }

record_android/android/src/main/kotlin/com/llfbandit/record/record/container/MuxerContainer.kt

@@ -10,9 +10,14 @@ import java.util.concurrent.atomic.AtomicBoolean
  * Wrapper around [MediaMuxer].
  *
  * @param path            Output file path.
+ * @param ignoreCodecSpecificData If true, ignores samples flagged as [MediaCodec.BUFFER_FLAG_CODEC_CONFIG].
  * @param containerFormat A valid [MediaMuxer.OutputFormat] value for the output container format.
  */
-class MuxerContainer(val path: String, private val containerFormat: Int) : IContainerWriter {
+class MuxerContainer(
+  val path: String,
+  val ignoreCodecSpecificData: Boolean,
+  private val containerFormat: Int
+) : IContainerWriter {
   private var mMuxer: MediaMuxer? = null
   private var mStarted = AtomicBoolean(false)
   private var mStopped = AtomicBoolean(false)
@@ -58,4 +63,8 @@ class MuxerContainer(val path: String, private val containerFormat: Int) : ICont
     mMuxer?.release()
     mMuxer = null
   }
+
+  override fun ignoreCodecSpecificData(): Boolean {
+    return ignoreCodecSpecificData
+  }
 }

record_android/android/src/main/kotlin/com/llfbandit/record/record/encoder/MediaCodecEncoder.kt

@@ -155,18 +155,21 @@ class MediaCodecEncoder(
 
   private fun processOutputBuffer(codec: MediaCodec, index: Int, info: MediaCodec.BufferInfo) {
     try {
-      // The CSD (Codec-specific Data) is passed to muxer in MediaFormat. So we ignore it.
-      val isCodecData = info.flags and MediaCodec.BUFFER_FLAG_CODEC_CONFIG != 0
-
-      if (!isCodecData && info.size != 0) {
-        val out = codec.getOutputBuffer(index)
-        val container = mContainer
-
-        if (out != null && container != null) {
-          if (container.isStream()) {
-            listener.onEncoderStream(container.writeStream(mContainerTrack, out, info))
-          } else {
-            container.writeSampleData(mContainerTrack, out, info)
+      val container = mContainer
+
+      if (container != null && info.size != 0) {
+        // The CSD (Codec-specific Data) is passed to muxer in MediaFormat. So we ignore it.
+        val ignoreSample = container.ignoreCodecSpecificData() && info.flags and MediaCodec.BUFFER_FLAG_CODEC_CONFIG != 0
+
+        if (!ignoreSample) {
+          val out = codec.getOutputBuffer(index)
+
+          if (out != null) {
+            if (container.isStream()) {
+              listener.onEncoderStream(container.writeStream(mContainerTrack, out, info))
+            } else {
+              container.writeSampleData(mContainerTrack, out, info)
+            }
           }
         }
       }

record_android/android/src/main/kotlin/com/llfbandit/record/record/format/AacFormat.kt

@@ -70,6 +70,6 @@ class AacFormat : Format() {
       return AdtsContainer(sampleRate, numChannels, aacProfile)
     }
 
-    return MuxerContainer(path, MediaMuxer.OutputFormat.MUXER_OUTPUT_MPEG_4)
+    return MuxerContainer(path, true, MediaMuxer.OutputFormat.MUXER_OUTPUT_MPEG_4)
   }
 }

record_android/android/src/main/kotlin/com/llfbandit/record/record/format/AmrNbFormat.kt

@@ -34,6 +34,6 @@ class AmrNbFormat : Format() {
       throw IllegalAccessException("AmrNb requires min API version: " + Build.VERSION_CODES.O)
     }
 
-    return MuxerContainer(path, MediaMuxer.OutputFormat.MUXER_OUTPUT_3GPP)
+    return MuxerContainer(path, false, MediaMuxer.OutputFormat.MUXER_OUTPUT_3GPP)
   }
 }

record_android/android/src/main/kotlin/com/llfbandit/record/record/format/AmrWbFormat.kt

@@ -34,6 +34,6 @@ class AmrWbFormat : Format() {
       throw IllegalAccessException("AmrWb requires min API version: " + Build.VERSION_CODES.O)
     }
 
-    return MuxerContainer(path, MediaMuxer.OutputFormat.MUXER_OUTPUT_3GPP)
+    return MuxerContainer(path, false, MediaMuxer.OutputFormat.MUXER_OUTPUT_3GPP)
   }
 }

record_android/android/src/main/kotlin/com/llfbandit/record/record/format/OpusFormat.kt

@@ -34,6 +34,6 @@ class OpusFormat : Format() {
       throw IllegalAccessException("Opus requires min API version: " + Build.VERSION_CODES.Q)
     }
 
-    return MuxerContainer(path, MediaMuxer.OutputFormat.MUXER_OUTPUT_OGG)
+    return MuxerContainer(path, false, MediaMuxer.OutputFormat.MUXER_OUTPUT_OGG)
   }
 }

record_android/pubspec.yaml

@@ -1,6 +1,6 @@
 name: record_android
 description: Android specific implementation for record package called by record_platform_interface.
-version: 1.4.1
+version: 1.4.2
 homepage: https://github.com/llfbandit/record/tree/master/record_android
 
 environment: