Create AudioRecord by reflection as a fallback

Some devices (Vivo phones) fail to create an AudioRecord from an
AudioRecord.Builder (which throw a NullPointerException).

In that case, create an AudioRecord instance directly by reflection.

The AOSP version of AudioRecord constructor code can be found at:
 - Android 11 (R):
   <https://cs.android.com/android/platform/superproject/+/android-11.0.0_r1:frameworks/base/media/java/android/media/AudioRecord.java;l=335;drc=64ed2ec38a511bbbd048985fe413268335e072f8>
 - Android 12 (S):
   <https://cs.android.com/android/platform/superproject/+/android-12.0.0_r1:frameworks/base/media/java/android/media/AudioRecord.java;l=388;drc=2eebf929650e0d320a21f0d13677a27d7ab278e9>
 - Android 13 (T, functionally identical to Android 12):
   <https://cs.android.com/android/platform/superproject/+/android-13.0.0_r1:frameworks/base/media/java/android/media/AudioRecord.java;l=382;drc=ed242da52f975a1dd18671afb346b18853d729f2>
 - Android 14 (U): Not released, but expected to change

PR #3862 <https://github.com/Genymobile/scrcpy/pull/3862>
Fixes #3805 <https://github.com/Genymobile/scrcpy/issues/3805>

Signed-off-by: Romain Vimont <rom@rom1v.com>

app/prebuilt-deps/prepare-ffmpeg.sh

@@ -6,11 +6,11 @@ cd "$DIR"
 mkdir -p "$PREBUILT_DATA_DIR"
 cd "$PREBUILT_DATA_DIR"
 
-VERSION=6.0-scrcpy-3
+VERSION=6.0-scrcpy-4
 DEP_DIR="ffmpeg-$VERSION"
 
 FILENAME="$DEP_DIR".7z
-SHA256SUM=36829d98ac4454d7092c72ddb92faa20b60450bc0fe8873076efb0858cdcbc2c
+SHA256SUM=39274b321491ce83e76cab5d24e7cbe3f402d3ccf382f739b13be5651c146b60
 
 if [[ -d "$DEP_DIR" ]]
 then

app/src/display.c

@@ -237,9 +237,11 @@ sc_display_render(struct sc_display *display, const SDL_Rect *geometry,
                   unsigned rotation) {
     SDL_RenderClear(display->renderer);
 
-    bool ok = sc_display_apply_pending(display);
-    if (!ok) {
-        return SC_DISPLAY_RESULT_PENDING;
+    if (display->pending.flags) {
+        bool ok = sc_display_apply_pending(display);
+        if (!ok) {
+            return SC_DISPLAY_RESULT_PENDING;
+        }
     }
 
     SDL_Renderer *renderer = display->renderer;

cross_win32.txt

@@ -16,6 +16,6 @@ cpu = 'i686'
 endian = 'little'
 
 [properties]
-prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-3/win32'
+prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-4/win32'
 prebuilt_sdl2 = 'SDL2-2.26.4/i686-w64-mingw32'
 prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-Win32'

cross_win64.txt

@@ -16,6 +16,6 @@ cpu = 'x86_64'
 endian = 'little'
 
 [properties]
-prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-3/win64'
+prebuilt_ffmpeg = 'ffmpeg-6.0-scrcpy-4/win64'
 prebuilt_sdl2 = 'SDL2-2.26.4/x86_64-w64-mingw32'
 prebuilt_libusb = 'libusb-1.0.26/libusb-MinGW-x64'

release.mk

@@ -94,11 +94,10 @@ dist-win32: build-server build-win32
 	cp app/data/scrcpy-noconsole.vbs "$(DIST)/$(WIN32_TARGET_DIR)"
 	cp app/data/icon.png "$(DIST)/$(WIN32_TARGET_DIR)"
 	cp app/data/open_a_terminal_here.bat "$(DIST)/$(WIN32_TARGET_DIR)"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win32/bin/avutil-58.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win32/bin/avcodec-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win32/bin/avformat-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win32/bin/swresample-4.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win32/bin/zlib1.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avutil-58.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avcodec-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/avformat-60.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win32/bin/swresample-4.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
 	cp app/prebuilt-deps/data/platform-tools-34.0.1/adb.exe "$(DIST)/$(WIN32_TARGET_DIR)/"
 	cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinApi.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
 	cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinUsbApi.dll "$(DIST)/$(WIN32_TARGET_DIR)/"
@@ -113,11 +112,10 @@ dist-win64: build-server build-win64
 	cp app/data/scrcpy-noconsole.vbs "$(DIST)/$(WIN64_TARGET_DIR)"
 	cp app/data/icon.png "$(DIST)/$(WIN64_TARGET_DIR)"
 	cp app/data/open_a_terminal_here.bat "$(DIST)/$(WIN64_TARGET_DIR)"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win64/bin/avutil-58.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win64/bin/avcodec-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win64/bin/avformat-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win64/bin/swresample-4.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
-	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-3/win64/bin/zlib1.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avutil-58.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avcodec-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/avformat-60.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
+	cp app/prebuilt-deps/data/ffmpeg-6.0-scrcpy-4/win64/bin/swresample-4.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
 	cp app/prebuilt-deps/data/platform-tools-34.0.1/adb.exe "$(DIST)/$(WIN64_TARGET_DIR)/"
 	cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinApi.dll "$(DIST)/$(WIN64_TARGET_DIR)/"
 	cp app/prebuilt-deps/data/platform-tools-34.0.1/AdbWinUsbApi.dll "$(DIST)/$(WIN64_TARGET_DIR)/"

server/src/main/java/com/genymobile/scrcpy/AudioCapture.java

@@ -18,10 +18,12 @@ import java.nio.ByteBuffer;
 
 public final class AudioCapture {
 
+    public static final int SOURCE = MediaRecorder.AudioSource.REMOTE_SUBMIX;
     public static final int SAMPLE_RATE = 48000;
     public static final int CHANNEL_CONFIG = AudioFormat.CHANNEL_IN_STEREO;
     public static final int CHANNELS = 2;
-    public static final int FORMAT = AudioFormat.ENCODING_PCM_16BIT;
+    public static final int CHANNEL_MASK = AudioFormat.CHANNEL_IN_LEFT | AudioFormat.CHANNEL_IN_RIGHT;
+    public static final int ENCODING = AudioFormat.ENCODING_PCM_16BIT;
     public static final int BYTES_PER_SAMPLE = 2;
 
     private AudioRecord recorder;
@@ -36,7 +38,7 @@ public final class AudioCapture {
 
     private static AudioFormat createAudioFormat() {
         AudioFormat.Builder builder = new AudioFormat.Builder();
-        builder.setEncoding(FORMAT);
+        builder.setEncoding(ENCODING);
         builder.setSampleRate(SAMPLE_RATE);
         builder.setChannelMask(CHANNEL_CONFIG);
         return builder.build();
@@ -50,9 +52,9 @@ public final class AudioCapture {
             // On older APIs, Workarounds.fillAppInfo() must be called beforehand
             builder.setContext(FakeContext.get());
         }
-        builder.setAudioSource(MediaRecorder.AudioSource.REMOTE_SUBMIX);
+        builder.setAudioSource(SOURCE);
         builder.setAudioFormat(createAudioFormat());
-        int minBufferSize = AudioRecord.getMinBufferSize(SAMPLE_RATE, CHANNEL_CONFIG, FORMAT);
+        int minBufferSize = AudioRecord.getMinBufferSize(SAMPLE_RATE, CHANNEL_CONFIG, ENCODING);
         // This buffer size does not impact latency
         builder.setBufferSizeInBytes(8 * minBufferSize);
         return builder.build();
@@ -97,7 +99,14 @@ public final class AudioCapture {
     }
 
     private void startRecording() {
-        recorder = createAudioRecord();
+        try {
+            recorder = createAudioRecord();
+        } catch (NullPointerException e) {
+            // Creating an AudioRecord using an AudioRecord.Builder does not work on Vivo phones:
+            // - <https://github.com/Genymobile/scrcpy/issues/3805>
+            // - <https://github.com/Genymobile/scrcpy/pull/3862>
+            recorder = Workarounds.createAudioRecord(SOURCE, SAMPLE_RATE, CHANNEL_CONFIG, CHANNELS, CHANNEL_MASK, ENCODING);
+        }
         recorder.startRecording();
     }
 

server/src/main/java/com/genymobile/scrcpy/Workarounds.java

@@ -1,13 +1,22 @@
 package com.genymobile.scrcpy;
 
 import android.annotation.SuppressLint;
+import android.annotation.TargetApi;
 import android.app.Application;
+import android.content.AttributionSource;
 import android.content.ContextWrapper;
 import android.content.pm.ApplicationInfo;
+import android.media.AudioAttributes;
+import android.media.AudioManager;
+import android.media.AudioRecord;
+import android.os.Build;
 import android.os.Looper;
+import android.os.Parcel;
 
+import java.lang.ref.WeakReference;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
+import java.lang.reflect.Method;
 
 public final class Workarounds {
 
@@ -95,4 +104,140 @@ public final class Workarounds {
             Ln.d("Could not fill app context: " + throwable.getMessage());
         }
     }
+
+    @TargetApi(Build.VERSION_CODES.R)
+    @SuppressLint({"WrongConstant", "MissingPermission", "BlockedPrivateApi", "SoonBlockedPrivateApi"})
+    public static AudioRecord createAudioRecord(int source, int sampleRate, int channelConfig, int channels, int channelMask, int encoding) {
+        // Vivo (and maybe some other third-party ROMs) modified `AudioRecord`'s constructor, requiring `Context`s from real App environment.
+        //
+        // This method invokes the `AudioRecord(long nativeRecordInJavaObj)` constructor to create an empty `AudioRecord` instance, then uses
+        // reflections to initialize it like the normal constructor do (or the `AudioRecord.Builder.build()` method do).
+        // As a result, the modified code was not executed.
+        try {
+            // AudioRecord audioRecord = new AudioRecord(0L);
+            Constructor<AudioRecord> audioRecordConstructor = AudioRecord.class.getDeclaredConstructor(long.class);
+            audioRecordConstructor.setAccessible(true);
+            AudioRecord audioRecord = audioRecordConstructor.newInstance(0L);
+
+            // audioRecord.mRecordingState = RECORDSTATE_STOPPED;
+            Field mRecordingStateField = AudioRecord.class.getDeclaredField("mRecordingState");
+            mRecordingStateField.setAccessible(true);
+            mRecordingStateField.set(audioRecord, AudioRecord.RECORDSTATE_STOPPED);
+
+            Looper looper = Looper.myLooper();
+            if (looper == null) {
+                looper = Looper.getMainLooper();
+            }
+
+            // audioRecord.mInitializationLooper = looper;
+            Field mInitializationLooperField = AudioRecord.class.getDeclaredField("mInitializationLooper");
+            mInitializationLooperField.setAccessible(true);
+            mInitializationLooperField.set(audioRecord, looper);
+
+            // Create `AudioAttributes` with fixed capture preset
+            int capturePreset = source;
+            AudioAttributes.Builder audioAttributesBuilder = new AudioAttributes.Builder();
+            Method setInternalCapturePresetMethod = AudioAttributes.Builder.class.getMethod("setInternalCapturePreset", int.class);
+            setInternalCapturePresetMethod.invoke(audioAttributesBuilder, capturePreset);
+            AudioAttributes attributes = audioAttributesBuilder.build();
+
+            // audioRecord.mAudioAttributes = attributes;
+            Field mAudioAttributesField = AudioRecord.class.getDeclaredField("mAudioAttributes");
+            mAudioAttributesField.setAccessible(true);
+            mAudioAttributesField.set(audioRecord, attributes);
+
+            // audioRecord.audioParamCheck(capturePreset, sampleRate, encoding);
+            Method audioParamCheckMethod = AudioRecord.class.getDeclaredMethod("audioParamCheck", int.class, int.class, int.class);
+            audioParamCheckMethod.setAccessible(true);
+            audioParamCheckMethod.invoke(audioRecord, capturePreset, sampleRate, encoding);
+
+            // audioRecord.mChannelCount = channels
+            Field mChannelCountField = AudioRecord.class.getDeclaredField("mChannelCount");
+            mChannelCountField.setAccessible(true);
+            mChannelCountField.set(audioRecord, channels);
+
+            // audioRecord.mChannelMask = channelMask
+            Field mChannelMaskField = AudioRecord.class.getDeclaredField("mChannelMask");
+            mChannelMaskField.setAccessible(true);
+            mChannelMaskField.set(audioRecord, channelMask);
+
+            int minBufferSize = AudioRecord.getMinBufferSize(sampleRate, channelConfig, encoding);
+            int bufferSizeInBytes = minBufferSize * 8;
+
+            // audioRecord.audioBuffSizeCheck(bufferSizeInBytes)
+            Method audioBuffSizeCheckMethod = AudioRecord.class.getDeclaredMethod("audioBuffSizeCheck", int.class);
+            audioBuffSizeCheckMethod.setAccessible(true);
+            audioBuffSizeCheckMethod.invoke(audioRecord, bufferSizeInBytes);
+
+            final int channelIndexMask = 0;
+
+            int[] sampleRateArray = new int[]{sampleRate};
+            int[] session = new int[]{AudioManager.AUDIO_SESSION_ID_GENERATE};
+
+            int initResult;
+            if (Build.VERSION.SDK_INT < Build.VERSION_CODES.S) {
+                // private native final int native_setup(Object audiorecord_this,
+                // Object /*AudioAttributes*/ attributes,
+                // int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat,
+                // int buffSizeInBytes, int[] sessionId, String opPackageName,
+                // long nativeRecordInJavaObj);
+                Method nativeSetupMethod = AudioRecord.class.getDeclaredMethod("native_setup", Object.class, Object.class, int[].class, int.class,
+                        int.class, int.class, int.class, int[].class, String.class, long.class);
+                nativeSetupMethod.setAccessible(true);
+                initResult = (int) nativeSetupMethod.invoke(audioRecord, new WeakReference<AudioRecord>(audioRecord), attributes, sampleRateArray,
+                        channelMask, channelIndexMask, audioRecord.getAudioFormat(), bufferSizeInBytes, session, FakeContext.get().getOpPackageName(),
+                        0L);
+            } else {
+                // Assume `context` is never `null`
+                AttributionSource attributionSource = FakeContext.get().getAttributionSource();
+
+                // Assume `attributionSource.getPackageName()` is never null
+
+                // ScopedParcelState attributionSourceState = attributionSource.asScopedParcelState()
+                Method asScopedParcelStateMethod = AttributionSource.class.getDeclaredMethod("asScopedParcelState");
+                asScopedParcelStateMethod.setAccessible(true);
+
+                try (AutoCloseable attributionSourceState = (AutoCloseable) asScopedParcelStateMethod.invoke(attributionSource)) {
+                    Method getParcelMethod = attributionSourceState.getClass().getDeclaredMethod("getParcel");
+                    Parcel attributionSourceParcel = (Parcel) getParcelMethod.invoke(attributionSourceState);
+
+                    // private native int native_setup(Object audiorecordThis,
+                    // Object /*AudioAttributes*/ attributes,
+                    // int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat,
+                    // int buffSizeInBytes, int[] sessionId, @NonNull Parcel attributionSource,
+                    // long nativeRecordInJavaObj, int maxSharedAudioHistoryMs);
+                    Method nativeSetupMethod = AudioRecord.class.getDeclaredMethod("native_setup", Object.class, Object.class, int[].class, int.class,
+                            int.class, int.class, int.class, int[].class, Parcel.class, long.class, int.class);
+                    nativeSetupMethod.setAccessible(true);
+                    initResult = (int) nativeSetupMethod.invoke(audioRecord, new WeakReference<AudioRecord>(audioRecord), attributes, sampleRateArray,
+                            channelMask, channelIndexMask, audioRecord.getAudioFormat(), bufferSizeInBytes, session, attributionSourceParcel, 0L, 0);
+                }
+            }
+
+            if (initResult != AudioRecord.SUCCESS) {
+                Ln.e("Error code " + initResult + " when initializing native AudioRecord object.");
+                throw new RuntimeException("Cannot create AudioRecord");
+            }
+
+            // mSampleRate = sampleRate[0]
+            Field mSampleRateField = AudioRecord.class.getDeclaredField("mSampleRate");
+            mSampleRateField.setAccessible(true);
+            mSampleRateField.set(audioRecord, sampleRateArray[0]);
+
+            // audioRecord.mSessionId = session[0]
+            Field mSessionIdField = AudioRecord.class.getDeclaredField("mSessionId");
+            mSessionIdField.setAccessible(true);
+            mSessionIdField.set(audioRecord, session[0]);
+
+            // audioRecord.mState = AudioRecord.STATE_INITIALIZED
+            Field mStateField = AudioRecord.class.getDeclaredField("mState");
+            mStateField.setAccessible(true);
+            mStateField.set(audioRecord, AudioRecord.STATE_INITIALIZED);
+
+            return audioRecord;
+        } catch (Exception e) {
+            Ln.e("Failed to invoke AudioRecord.<init>.", e);
+            throw new RuntimeException("Cannot create AudioRecord");
+        }
+    }
 }