RecordingActivity.java

  1package eu.siacs.conversations.ui;
  2
  3import android.app.Activity;
  4import android.content.Intent;
  5import android.content.SharedPreferences;
  6import android.media.MediaRecorder;
  7import android.net.Uri;
  8import android.os.Build;
  9import android.os.Bundle;
 10import android.os.Environment;
 11import android.os.FileObserver;
 12import android.os.Handler;
 13import android.os.SystemClock;
 14import android.preference.PreferenceManager;
 15import android.util.Log;
 16import android.view.View;
 17import android.view.WindowManager;
 18import android.widget.Toast;
 19
 20import androidx.appcompat.app.AppCompatActivity;
 21import androidx.databinding.DataBindingUtil;
 22
 23import com.google.common.collect.ImmutableSet;
 24
 25import java.io.File;
 26import java.lang.ref.WeakReference;
 27import java.text.SimpleDateFormat;
 28import java.util.Date;
 29import java.util.Locale;
 30import java.util.Objects;
 31import java.util.concurrent.CountDownLatch;
 32import java.util.concurrent.TimeUnit;
 33import java.util.Set;
 34
 35import eu.siacs.conversations.Config;
 36import eu.siacs.conversations.R;
 37import eu.siacs.conversations.databinding.ActivityRecordingBinding;
 38import eu.siacs.conversations.ui.util.SettingsUtils;
 39import eu.siacs.conversations.utils.TimeFrameUtils;
 40
 41public class RecordingActivity extends BaseActivity implements View.OnClickListener {
 42
 43    private ActivityRecordingBinding binding;
 44
 45    private MediaRecorder mRecorder;
 46    private long mStartTime = 0;
 47
 48    private final CountDownLatch outputFileWrittenLatch = new CountDownLatch(1);
 49
 50    private final Handler mHandler = new Handler();
 51    private final Runnable mTickExecutor =
 52            new Runnable() {
 53                @Override
 54                public void run() {
 55                    tick();
 56                    mHandler.postDelayed(mTickExecutor, 100);
 57                }
 58            };
 59
 60    private File mOutputFile;
 61
 62    private FileObserver mFileObserver;
 63
 64    @Override
 65    protected void onCreate(Bundle savedInstanceState) {
 66        super.onCreate(savedInstanceState);
 67        this.binding = DataBindingUtil.setContentView(this, R.layout.activity_recording);
 68        this.binding.cancelButton.setOnClickListener(this);
 69        this.binding.shareButton.setOnClickListener(this);
 70        this.setFinishOnTouchOutside(false);
 71        getWindow().addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON);
 72    }
 73    @Override
 74    public void onStart() {
 75        super.onStart();
 76        if (!startRecording()) {
 77            this.binding.shareButton.setEnabled(false);
 78            this.binding.timer.setTextAppearance(com.google.android.material.R.style.TextAppearance_Material3_BodyMedium);
 79            // TODO reset font family. make red?
 80            this.binding.timer.setText(R.string.unable_to_start_recording);
 81        }
 82    }
 83
 84    @Override
 85    protected void onStop() {
 86        super.onStop();
 87        if (mRecorder != null) {
 88            mHandler.removeCallbacks(mTickExecutor);
 89            stopRecording(false);
 90        }
 91        if (mFileObserver != null) {
 92            mFileObserver.stopWatching();
 93        }
 94    }
 95
 96    protected SharedPreferences getPreferences() {
 97        return PreferenceManager.getDefaultSharedPreferences(getApplicationContext());
 98    }
 99
100    private static final Set<String> AAC_SENSITIVE_DEVICES =
101            new ImmutableSet.Builder<String>()
102                    .add("FP4")             // Fairphone 4 https://codeberg.org/monocles/monocles_chat/issues/133
103                    .add("ONEPLUS A6000")   // OnePlus 6 https://github.com/iNPUTmice/Conversations/issues/4329
104                    .add("ONEPLUS A6003")   // OnePlus 6 https://github.com/iNPUTmice/Conversations/issues/4329
105                    .add("ONEPLUS A6010")   // OnePlus 6T https://codeberg.org/monocles/monocles_chat/issues/133
106                    .add("ONEPLUS A6013")   // OnePlus 6T https://codeberg.org/monocles/monocles_chat/issues/133
107                    .add("Pixel 4a")        // Pixel 4a https://github.com/iNPUTmice/Conversations/issues/4223
108                    .add("WP12 Pro")        // Oukitel WP 12 Pro https://github.com/iNPUTmice/Conversations/issues/4223
109                    .add("Volla Phone X")   // Volla Phone X https://github.com/iNPUTmice/Conversations/issues/4223
110                    .build();
111
112    private boolean startRecording() {
113        mRecorder = new MediaRecorder();
114        mRecorder.setAudioSource(MediaRecorder.AudioSource.MIC);
115        final String userChosenCodec = getPreferences().getString("voice_message_codec", "");
116        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
117            mRecorder.setPrivacySensitive(true);
118        }
119        final int outputFormat;
120        if (("opus".equals(userChosenCodec) || ("".equals(userChosenCodec) && Config.USE_OPUS_VOICE_MESSAGES)) && Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
121            outputFormat = MediaRecorder.OutputFormat.OGG;
122            mRecorder.setOutputFormat(outputFormat);
123            mRecorder.setAudioEncoder(MediaRecorder.AudioEncoder.OPUS);
124            mRecorder.setAudioEncodingBitRate(32000);
125        } else if ("mpeg4".equals(userChosenCodec) || !Config.USE_OPUS_VOICE_MESSAGES) {
126            outputFormat = MediaRecorder.OutputFormat.MPEG_4;
127            mRecorder.setOutputFormat(outputFormat);
128            if (AAC_SENSITIVE_DEVICES.contains(Build.MODEL) && Build.VERSION.SDK_INT <= Build.VERSION_CODES.TIRAMISU) {
129                // Changing these three settings for AAC sensitive devices for Android<=13 might lead to sporadically truncated (cut-off) voice messages.
130                mRecorder.setAudioEncoder(MediaRecorder.AudioEncoder.HE_AAC);
131                mRecorder.setAudioSamplingRate(24_000);
132                mRecorder.setAudioEncodingBitRate(28_000);
133            } else {
134                mRecorder.setAudioEncoder(MediaRecorder.AudioEncoder.AAC);
135                mRecorder.setAudioSamplingRate(44_100);
136                mRecorder.setAudioEncodingBitRate(64_000);
137            }
138        } else {
139            outputFormat = MediaRecorder.OutputFormat.THREE_GPP;
140            mRecorder.setOutputFormat(outputFormat);
141            mRecorder.setAudioEncoder(MediaRecorder.AudioEncoder.AMR_WB);
142            mRecorder.setAudioEncodingBitRate(23850);
143            mRecorder.setAudioSamplingRate(16000);
144        }
145        setupOutputFile(outputFormat);
146        mRecorder.setOutputFile(mOutputFile.getAbsolutePath());
147
148        try {
149            mRecorder.prepare();
150            mRecorder.start();
151            mStartTime = SystemClock.elapsedRealtime();
152            mHandler.postDelayed(mTickExecutor, 100);
153            Log.d(Config.LOGTAG, "started recording to " + mOutputFile.getAbsolutePath());
154            return true;
155        } catch (Exception e) {
156            Log.e(Config.LOGTAG, "prepare() failed ", e);
157            return false;
158        }
159    }
160
161    protected void stopRecording(final boolean saveFile) {
162        try {
163            mRecorder.stop();
164            mRecorder.release();
165        } catch (Exception e) {
166            if (saveFile) {
167                Toast.makeText(this, R.string.unable_to_save_recording, Toast.LENGTH_SHORT).show();
168                return;
169            }
170        } finally {
171            mRecorder = null;
172            mStartTime = 0;
173        }
174        if (!saveFile && mOutputFile != null) {
175            if (mOutputFile.delete()) {
176                Log.d(Config.LOGTAG, "deleted canceled recording");
177            }
178        }
179        if (saveFile) {
180            new Thread(new Finisher(outputFileWrittenLatch, mOutputFile, this)).start();
181        }
182    }
183
184    private static class Finisher implements Runnable {
185
186        private final CountDownLatch latch;
187        private final File outputFile;
188        private final WeakReference<Activity> activityReference;
189
190        private Finisher(CountDownLatch latch, File outputFile, Activity activity) {
191            this.latch = latch;
192            this.outputFile = outputFile;
193            this.activityReference = new WeakReference<>(activity);
194        }
195
196        @Override
197        public void run() {
198            try {
199                if (!latch.await(8, TimeUnit.SECONDS)) {
200                    Log.d(Config.LOGTAG, "time out waiting for output file to be written");
201                }
202            } catch (final InterruptedException e) {
203                Log.d(Config.LOGTAG, "interrupted while waiting for output file to be written", e);
204            }
205            final Activity activity = activityReference.get();
206            if (activity == null) {
207                return;
208            }
209            activity.runOnUiThread(
210                    () -> {
211                        activity.setResult(
212                                Activity.RESULT_OK, new Intent().setData(Uri.fromFile(outputFile)));
213                        activity.finish();
214                    });
215        }
216    }
217
218    private File generateOutputFilename(final int outputFormat) {
219        final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMdd_HHmmssSSS", Locale.US);
220        final String extension;
221        if (outputFormat == MediaRecorder.OutputFormat.MPEG_4) {
222            extension = "m4a";
223        } else if (outputFormat == MediaRecorder.OutputFormat.OGG) {
224            extension = "oga";
225        } else if (outputFormat == MediaRecorder.OutputFormat.THREE_GPP) {
226            extension = "awb";
227        } else {
228            throw new IllegalStateException("Unrecognized output format");
229        }
230        final String filename =
231                String.format("RECORDING_%s.%s", dateFormat.format(new Date()), extension);
232        final File parentDirectory;
233        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
234            parentDirectory =
235                    Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_RECORDINGS);
236        } else {
237            parentDirectory =
238                    Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS);
239        }
240        final File conversationsDirectory = new File(parentDirectory, getString(R.string.app_name));
241        return new File(conversationsDirectory, filename);
242    }
243
244    private void setupOutputFile(final int outputFormat) {
245        mOutputFile = generateOutputFilename(outputFormat);
246        final File parentDirectory = mOutputFile.getParentFile();
247        if (Objects.requireNonNull(parentDirectory).mkdirs()) {
248            Log.d(Config.LOGTAG, "created " + parentDirectory.getAbsolutePath());
249        }
250        setupFileObserver(parentDirectory);
251    }
252
253    private void setupFileObserver(final File directory) {
254        mFileObserver =
255                new FileObserver(directory.getAbsolutePath()) {
256                    @Override
257                    public void onEvent(int event, String s) {
258                        if (s != null
259                                && s.equals(mOutputFile.getName())
260                                && event == FileObserver.CLOSE_WRITE) {
261                            outputFileWrittenLatch.countDown();
262                        }
263                    }
264                };
265        mFileObserver.startWatching();
266    }
267
268    private void tick() {
269        this.binding.timer.setText(TimeFrameUtils.formatTimePassed(mStartTime, true));
270    }
271
272    @Override
273    public void onClick(final View view) {
274        switch (view.getId()) {
275            case R.id.cancel_button:
276                mHandler.removeCallbacks(mTickExecutor);
277                stopRecording(false);
278                setResult(RESULT_CANCELED);
279                finish();
280                break;
281            case R.id.share_button:
282                this.binding.shareButton.setEnabled(false);
283                this.binding.shareButton.setText(R.string.please_wait);
284                mHandler.removeCallbacks(mTickExecutor);
285                mHandler.postDelayed(() -> stopRecording(true), 500);
286                break;
287        }
288    }
289}