Sonic (16-bit path): `findPitchPeriodInRange` compares in 32-bit ints that overflow on loud audio, so a badly matching pitch period can win

Abierto Apto para principiantes
#3,565 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 4 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
android, java

Línea de trabajo

Lee libraries/common/src/main/java/androidx/media3/common/audio/Sonic.java, especialmente SonicShortImpl.findPitchPeriodInRange alrededor de las líneas 1114–1124. Compara sus dos comprobaciones de multiplicación de enteros con la aritmética de tipo long que se muestra en el issue y ejecuta o adapta la reproducción con PCM de 16 bits a volumen alto y velocidad 1.1. La tarea estará completada cuando las comparaciones eviten el desbordamiento y la selección del período de tono coincida con el resultado de la aritmética de tipo long.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug needs triage
Version

Media3 1.10.1

More version details

The same code is in Media3 1.11.1 and on main (e765dd45dbf58e67a578ae003ca64eaa449bcc28):

https://github.com/androidx/media/blob/e765dd45dbf58e67a578ae003ca64eaa449bcc28/libraries/common/src/main/java/androidx/media3/common/audio/Sonic.java#L1114-L1124

Devices that reproduce the issue

Every device: the issue is integer arithmetic in Sonic.java.

  • Measured on the JVM, with Media3 1.10.1's own Sonic class (from the media3-common AAR)
  • Recorded on an Android 12 emulator (API 31, x86_64), playing through ExoPlayer at speed 1.1
  • Heard on a Samsung Galaxy Note10+ running Android 12
Devices that do not reproduce the issue

No response

Reproducible in the demo app?

Not tested

Reproduction steps
  1. Take loud 16-bit PCM at 44.1 kHz, stereo: speech mastered to full scale, or full-scale white noise.

  2. Run it through Sonic at speed 1.1, pitch 1 (for example SonicAudioProcessor.setSpeed(1.1f), or an ExoPlayer at setPlaybackSpeed(1.1f)).

  3. Run the same input through a copy of Sonic whose two comparisons in SonicShortImpl.findPitchPeriodInRange are made in long:

    if ((long) diff * bestPeriod < (long) minDiff * period) {
    ...
    if ((long) diff * worstPeriod > (long) maxDiff * period) {
    
  4. Compare the two outputs: they differ. Scale the input down by 64, so that no product can reach 2^31, and they are identical, sample for sample.

The arithmetic alone, with values of the second pass: a poor candidate beats a good match.

int bestPeriod = 610, minDiff = 610 * 1_000; // the best so far: mean |s - p| of 1,000
int period = 600, diff = 600 * 8_000;        // a poor candidate: mean |s - p| of 8,000
diff * bestPeriod < minDiff * period                // true:  -1366967296 < 366000000
(long) diff * bestPeriod < (long) minDiff * period  // false: 2928000000 < 366000000
Expected result

The pitch search keeps the best-matching period at any level, as it does on quieter audio, in SonicFloatImpl (which holds diff, minDiff and maxDiff in doubles), and in the C library it was ported from (waywardgeek/sonic declares them unsigned long).

Suggested fix: the two casts of step 3.

Actual result

In SonicShortImpl.findPitchPeriodInRange the variables diff, minDiff, maxDiff, bestPeriod, worstPeriod and period are ints, so diff * bestPeriod < minDiff * period and diff * worstPeriod > maxDiff * period are evaluated in 32 bits. The comment above them says diff is a 24-bit number "since we skip samples". That holds for the first, down-sampled pass of findPitchPeriod. It does not hold for the second pass, which runs at the full rate (downSampleInput(positionFrames, 1) for more than one channel, the input buffer for mono) over periods of up to maxPeriod, 678 samples at 44.1 kHz. There diff sums up to 678 absolute differences of 16-bit samples, and its product with a period passes 2^31 once the mean absolute difference per sample is above about 2^31 / period² (about 13,400 at a period of 400, 4,700 at 678): any loud passage. A wrapped product decides the comparison, and a period that matches badly can be kept as the best one.

What it does to the sound: between 1x and 2x, Sonic blends the period it found into the next one. With a wrong period the two pieces are unalike, the blend partly cancels, and the level dips for a few milliseconds: a faint, rapid fluttering on a sustained voice.

Measured at speed 1.1 on a speech recording mastered to full scale (44.1 kHz stereo, −13 dBFS RMS, 120 s), 308 of 1,491 splices (21%) take another period once the comparisons are made in long, and the level dips at the splices fall:

Level dips over 3 dB, per second (0.3–2 kHz) as shipped compared in long
the loud recording (−13 dBFS RMS, 120 s) 1.78 0.97
a quieter recording (−20 dBFS RMS, 175 s) 1.49 1.15

A dip here is a run of 5 ms output frames whose level in the 0.3–2 kHz band is more than 3 dB below the best-matching place of the input; 306 of 310 dips over 1 dB lay within 12 ms of a splice.

Media

Any loud 16-bit PCM shows it (full-scale white noise is enough), so no file is attached. The measurements above used two speech recordings decoded to 44.1 kHz stereo 16-bit PCM.

No adb bugreport will follow: the issue is arithmetic and does not depend on the device.

Bug Report
  • You will email the zip file produced by adb bugreport to [email protected] after filing this issue.
Lenguaje dominante
Java
Estrellas
3.1k
Forks
1k
Merge medio
6 d 4 h
PR fusionados (30 d)
5

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de androidx/media

Todos los issues de androidx/media

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.