Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve conference call handling #285

Merged
merged 1 commit into from
Apr 12, 2023
Merged

Improve conference call handling #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/src/main/java/com/chiller3/bcr/Permissions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ object Permissions {
Manifest.permission.READ_PHONE_STATE,
)

private fun isGranted(context: Context, permission: String) =
fun isGranted(context: Context, permission: String) =
ContextCompat.checkSelfPermission(context, permission) == PackageManager.PERMISSION_GRANTED

/**
Expand Down
15 changes: 13 additions & 2 deletions app/src/main/java/com/chiller3/bcr/RecorderInCallService.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,16 @@ class RecorderInCallService : InCallService(), RecorderThread.OnRecordingComplet

Log.d(TAG, "handleStateChange: $call, $state, $callState")

if (callState == Call.STATE_ACTIVE) {
if (call.parent != null) {
Log.v(TAG, "Ignoring state change of conference call child")
} else if (callState == Call.STATE_ACTIVE) {
startRecording(call)
} else if (callState == Call.STATE_DISCONNECTING || callState == Call.STATE_DISCONNECTED) {
// This is necessary because onCallRemoved() might not be called due to firmware bugs
requestStopRecording(call)
}

recorders[call]?.isHolding = callState == Call.STATE_HOLDING
}

/**
Expand Down Expand Up @@ -243,7 +247,14 @@ class RecorderInCallService : InCallService(), RecorderThread.OnRecordingComplet
* The recording thread uses call details for generating filenames.
*/
private fun handleDetailsChange(call: Call, details: Call.Details) {
recorders[call]?.onCallDetailsChanged(details)
val parentCall = call.parent
val recorder = if (parentCall != null) {
recorders[parentCall]
} else {
recorders[call]
}

recorder?.onCallDetailsChanged(call, details)
}

/**
Expand Down
208 changes: 174 additions & 34 deletions app/src/main/java/com/chiller3/bcr/RecorderThread.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ import android.media.MediaRecorder
import android.net.Uri
import android.os.Build
import android.os.ParcelFileDescriptor
import android.provider.ContactsContract.PhoneLookup
import android.system.Os
import android.telecom.Call
import android.telecom.PhoneAccount
import android.telephony.SubscriptionManager
import android.telephony.TelephonyManager
import android.util.Log
import androidx.core.database.getStringOrNull
import androidx.core.net.toFile
import androidx.documentfile.provider.DocumentFile
import com.chiller3.bcr.format.Encoder
Expand Down Expand Up @@ -43,12 +45,13 @@ import android.os.Process as AndroidProcess
* kept in the object.
* @param listener Used for sending completion notifications. The listener is called from this
* thread, not the main thread.
* @param call Used only for determining the output filename and is not saved.
* @param parentCall Used for determining the output filename. References to it and its children are
* kept in the object.
*/
class RecorderThread(
private val context: Context,
private val listener: OnRecordingCompletedListener,
call: Call,
private val parentCall: Call,
) : Thread(RecorderThread::class.java.simpleName) {
private val tag = "${RecorderThread::class.java.simpleName}/${id}"
private val prefs = Preferences(context)
Expand All @@ -70,23 +73,27 @@ class RecorderThread(
}
private var wasEverResumed = !isPaused

// Call state
@Volatile var isHolding = false
private val isConference = parentCall.details.hasProperty(Call.Details.PROPERTY_CONFERENCE)

// Timestamp
private lateinit var callTimestamp: ZonedDateTime
private var formatter = FORMATTER

// Filename
private val filenameLock = Object()
private var pendingCallDetails: Call.Details? = null
private lateinit var lastCallDetails: Call.Details
private var callDetails = mutableMapOf<Call, Call.Details>()
private lateinit var filenameTemplate: FilenameTemplate
private lateinit var filename: String
private val redactions = HashMap<String, String>()
private var redactionsSorted = emptyList<Pair<String, String>>()
private val redactor = object : OutputDirUtils.Redactor {
override fun redact(msg: String): String {
synchronized(filenameLock) {
var result = msg

for ((source, target) in redactions) {
for ((source, target) in redactionsSorted) {
result = result.replace(source, target)
}

Expand All @@ -109,10 +116,15 @@ class RecorderThread(
private lateinit var logcatProcess: Process

init {
Log.i(tag, "Created thread for call: $call")
Log.i(tag, "Created thread for call: $parentCall")
Log.i(tag, "Initially paused: $isPaused")

onCallDetailsChanged(call.details)
callDetails[parentCall] = parentCall.details
if (isConference) {
for (childCall in parentCall.children) {
callDetails[childCall] = childCall.details
}
}

val savedFormat = Format.fromPreferences(prefs)
format = savedFormat.first
Expand All @@ -123,21 +135,123 @@ class RecorderThread(
* Update [filename] with information from [details].
*
* This function holds a lock on [filenameLock] until it returns.
*
* @param call Either the parent call or a child of the parent (for conference calls)
* @param details The updated call details belonging to [call]
*/
fun onCallDetailsChanged(details: Call.Details) {
fun onCallDetailsChanged(call: Call, details: Call.Details) {
if (call !== parentCall && call.parent !== parentCall) {
throw IllegalStateException("Not the parent call nor one of its children: $call")
}

synchronized(filenameLock) {
callDetails[call] = details

updateFilename(false)
}
}

private fun addRedaction(source: String, target: String) {
synchronized(filenameLock) {
redactions[source] = target

// Keyword-based redaction with arbitrary filenames can never be 100% foolproof, but we
// can improve the odds by replacing the longest strings first
redactionsSorted = redactions.entries
.map { it.key to it.value }
.sortedByDescending { it.first.length }
}
}

private fun getPhoneNumber(details: Call.Details): String? {
val uri = details.handle

return if (uri?.scheme == PhoneAccount.SCHEME_TEL) {
uri.schemeSpecificPart
} else {
null
}
}

private fun getContactDisplayName(details: Call.Details, allowManualLookup: Boolean): String? {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
val name = details.contactDisplayName
if (name != null) {
return name
}
}

// In conference calls, the telephony framework sometimes doesn't return the contact display
// name for every party in the call, so do the lookup ourselves. This is similar to what
// InCallUI does, except it doesn't even try to look at contactDisplayName.
if (isConference) {
Log.w(tag, "Contact display name missing in conference child call")
}

// This is disabled until the very last filename update because it's synchronous.
if (!allowManualLookup) {
Log.d(tag, "Manual lookup is disabled for this invocation")
return null
}

if (!Permissions.isGranted(context, Manifest.permission.READ_CONTACTS)) {
Log.w(tag, "Permissions not granted for looking up contacts")
return null
}

Log.d(tag, "Performing manual contact lookup")

val number = getPhoneNumber(details)
if (number == null) {
Log.w(tag, "Cannot determine phone number from call")
return null
}

// Same heuristic as InCallUI's PhoneNumberHelper.isUriNumber()
val numberIsSip = number.contains("@") || number.contains("%40")

val uri = PhoneLookup.ENTERPRISE_CONTENT_FILTER_URI.buildUpon()
.appendPath(number)
.appendQueryParameter(PhoneLookup.QUERY_PARAMETER_SIP_ADDRESS,
numberIsSip.toString())
.build()

context.contentResolver.query(
uri, arrayOf(PhoneLookup.DISPLAY_NAME), null, null, null)?.use { cursor ->
if (cursor.moveToFirst()) {
val index = cursor.getColumnIndex(PhoneLookup.DISPLAY_NAME)
if (index != -1) {
Log.d(tag, "Found contact display name via manual lookup")
return cursor.getStringOrNull(index)
}
}
}

Log.d(tag, "Contact not found via manual lookup")
return null
}

private fun updateFilename(allowManualContactLookup: Boolean) {
synchronized(filenameLock) {
if (!this::filenameTemplate.isInitialized) {
// Thread hasn't started yet, so we haven't loaded the filename template
pendingCallDetails = details
return
}

lastCallDetails = details
val parentDetails = callDetails[parentCall]!!
val displayDetails = if (isConference) {
callDetails.entries.asSequence()
.filter { it.key != parentCall }
.map { it.value }
.toList()
} else {
listOf(parentDetails)
}

filename = filenameTemplate.evaluate {
when {
it == "date" || it.startsWith("date:") -> {
val instant = Instant.ofEpochMilli(details.creationTimeMillis)
val instant = Instant.ofEpochMilli(parentDetails.creationTimeMillis)
callTimestamp = ZonedDateTime.ofInstant(instant, ZoneId.systemDefault())

val colon = it.indexOf(":")
Expand All @@ -157,8 +271,15 @@ class RecorderThread(
return@evaluate formatter.format(callTimestamp)
}
it == "direction" -> {
// AOSP's telephony framework has internal documentation that specifies that
// the call direction is meaningless for conference calls until enough
// participants hang up that it becomes an emulated one-on-one call.
if (isConference) {
return@evaluate "conference"
}

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
when (details.callDirection) {
when (parentDetails.callDirection) {
Call.Details.DIRECTION_INCOMING -> return@evaluate "in"
Call.Details.DIRECTION_OUTGOING -> return@evaluate "out"
Call.Details.DIRECTION_UNKNOWN -> {}
Expand All @@ -176,36 +297,56 @@ class RecorderThread(
// Only append SIM slot ID if the device has multiple active SIMs
if (subscriptionManager.activeSubscriptionInfoCount > 1) {
val telephonyManager = context.getSystemService(TelephonyManager::class.java)
val subscriptionId = telephonyManager.getSubscriptionId(details.accountHandle)
val subscriptionId = telephonyManager.getSubscriptionId(parentDetails.accountHandle)
val subscriptionInfo = subscriptionManager.getActiveSubscriptionInfo(subscriptionId)

return@evaluate "${subscriptionInfo.simSlotIndex + 1}"
}
}
}
it == "phone_number" -> {
if (details.handle?.scheme == PhoneAccount.SCHEME_TEL) {
redactions[details.handle.schemeSpecificPart] = "<phone number>"

return@evaluate details.handle.schemeSpecificPart
val joined = displayDetails.asSequence()
.map { d -> getPhoneNumber(d) }
.filterNotNull()
.joinToString(",")
if (joined.isNotEmpty()) {
addRedaction(joined, if (isConference) {
"<conference phone numbers>"
} else {
"<phone number>"
})

return@evaluate joined
}
}
it == "caller_name" -> {
val callerName = details.callerDisplayName?.trim()
if (!callerName.isNullOrBlank()) {
redactions[callerName] = "<caller name>"

return@evaluate callerName
val joined = displayDetails.asSequence()
.map { d -> d.callerDisplayName?.trim() }
.filter { n -> !n.isNullOrEmpty() }
.joinToString(",")
if (joined.isNotEmpty()) {
addRedaction(joined, if (isConference) {
"<conference caller names>"
} else {
"<caller name>"
})

return@evaluate joined
}
}
it == "contact_name" -> {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
val contactName = details.contactDisplayName?.trim()
if (!contactName.isNullOrBlank()) {
redactions[contactName] = "<contact name>"

return@evaluate contactName
}
val joined = displayDetails.asSequence()
.map { d -> getContactDisplayName(d, allowManualContactLookup)?.trim() }
.filter { n -> !n.isNullOrEmpty() }
.joinToString(",")
if (joined.isNotEmpty()) {
addRedaction(joined, if (isConference) {
"<conference contact names>"
} else {
"<contact name>"
})

return@evaluate joined
}
}
else -> {
Expand Down Expand Up @@ -235,8 +376,7 @@ class RecorderThread(
// checking for the existence of the template may take >500ms.
filenameTemplate = FilenameTemplate.load(context, false)

onCallDetailsChanged(pendingCallDetails!!)
pendingCallDetails = null
updateFilename(false)
}

startLogcat()
Expand All @@ -260,7 +400,7 @@ class RecorderThread(
val finalFilename = synchronized(filenameLock) {
filenameTemplate = FilenameTemplate.load(context, true)

onCallDetailsChanged(lastCallDetails)
updateFilename(true)
filename
}
if (finalFilename != initialFilename) {
Expand Down Expand Up @@ -579,8 +719,8 @@ class RecorderThread(

val encodeBegin = System.nanoTime()

// If paused, keep recording, but throw away the data
if (!isPaused) {
// If paused by the user or holding, keep recording, but throw away the data
if (!isPaused && !isHolding) {
encoder.encode(buffer, false)
numFramesEncoded += n / frameSize
}
Expand Down
6 changes: 3 additions & 3 deletions app/src/main/res/raw/filename_template.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
# timestamps in the filenames to have the expected pattern.
filename.0.text = ${date}

# Call direction, which is either `in` or `out`. Only defined on Android 10+.
# Call direction, which can be `in`, `out`, or `conference`. Only defined on
# Android 10+.
filename.1.text = ${direction}
filename.1.prefix = _

Expand All @@ -60,8 +61,7 @@ filename.3.prefix = _
filename.4.text = ${caller_name}
filename.4.prefix = _

# Contact name. Only defined on Android 11+ if the user has granted the contacts
# permission.
# Contact name. Only defined if the user has granted the contacts permission.
filename.5.text = ${contact_name}
filename.5.prefix = _

Expand Down