loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify SSIM request method name

Browse Source 
`requestCalculateSsim` more clearly represents the intention of the caller.

Also rephrase the javadoc to simplify it and make it more precise.

PiperOrigin-RevId: 465575578
This commit is contained in:
andrewlewis 2022-08-05 16:02:07 +00:00 committed by tonihei
parent c95bfe325d
commit 2eb59fa1af
5 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
libraries/transformer/src/androidTest/java/androidx/media3/transformer/TransformerAndroidTestRunner.java
View File

@ -52,7 +52,7 @@ public class TransformerAndroidTestRunner {
public static class Builder {
private final Context context;
private final Transformer transformer;
private boolean maybeCalculateSsim;
private boolean requestCalculateSsim;
private int timeoutSeconds;
private boolean suppressAnalysisExceptions;
@Nullable private Map<String, Object> inputValues;
@ -85,22 +85,21 @@ public class TransformerAndroidTestRunner {
}
/**
* Sets whether to try to calculate the SSIM of the transformation output.
* Sets whether to calculate the SSIM of the transformation output compared to the input, if
* supported. Calculating SSIM is not supported if the input and output video dimensions don't
* match, or if the input video is trimmed.
*
* <p>SSIM requires the input and output video dimensions to match. Therefore, if encoder
* resolution fallback occurs, this calculation is skipped.
*
* <p>The calculation involves decoding and comparing both the input and the output video.
* Consequently this calculation is not cost-free.
* <p>Calculating SSIM involves decoding and comparing frames of the expected and actual videos,
* which will increase the runtime of the test.
*
* <p>The default value is {@code false}.
*
* @param maybeCalculateSsim Whether to try to calculate SSIM.
* @param requestCalculateSsim Whether to calculate SSIM, if supported.
* @return This {@link Builder}.
*/
@CanIgnoreReturnValue
public Builder setMaybeCalculateSsim(boolean maybeCalculateSsim) {
this.maybeCalculateSsim = maybeCalculateSsim;
public Builder setRequestCalculateSsim(boolean requestCalculateSsim) {
this.requestCalculateSsim = requestCalculateSsim;
return this;
}
@ -146,7 +145,7 @@ public class TransformerAndroidTestRunner {
context,
transformer,
timeoutSeconds,
maybeCalculateSsim,
requestCalculateSsim,
suppressAnalysisExceptions,
inputValues);
}
@ -156,7 +155,7 @@ public class TransformerAndroidTestRunner {
private final CodecNameForwardingCodecFactory transformerCodecFactory;
private final Transformer transformer;
private final int timeoutSeconds;
private final boolean maybeCalculateSsim;
private final boolean requestCalculateSsim;
private final boolean suppressAnalysisExceptions;
@Nullable private final Map<String, Object> inputValues;
@ -164,7 +163,7 @@ public class TransformerAndroidTestRunner {
Context context,
Transformer transformer,
int timeoutSeconds,
boolean maybeCalculateSsim,
boolean requestCalculateSsim,
boolean suppressAnalysisExceptions,
@Nullable Map<String, Object> inputValues) {
this.context = context;
@ -177,7 +176,7 @@ public class TransformerAndroidTestRunner {
.setEncoderFactory(transformerCodecFactory)
.build();
this.timeoutSeconds = timeoutSeconds;
this.maybeCalculateSsim = maybeCalculateSsim;
this.requestCalculateSsim = requestCalculateSsim;
this.suppressAnalysisExceptions = suppressAnalysisExceptions;
this.inputValues = inputValues;
}
@ -229,7 +228,7 @@ public class TransformerAndroidTestRunner {
private TransformationTestResult runInternal(String testId, MediaItem mediaItem)
throws InterruptedException, IOException, TimeoutException, TransformationException {
if (!mediaItem.clippingConfiguration.equals(MediaItem.ClippingConfiguration.UNSET)
&& maybeCalculateSsim) {
&& requestCalculateSsim) {
throw new UnsupportedOperationException(
"SSIM calculation is not supported for clipped inputs.");
}
@ -323,7 +322,7 @@ public class TransformerAndroidTestRunner {
.setFilePath(outputVideoFile.getPath())
.setElapsedTimeMs(elapsedTimeMs);
if (!maybeCalculateSsim) {
if (!requestCalculateSsim) {
return resultBuilder.build();
}
if (fallbackResolutionApplied.get()) {

6
libraries/transformer/src/androidTest/java/androidx/media3/transformer/mh/TranscodeQualityTest.java
View File

@ -67,7 +67,7 @@ public final class TranscodeQualityTest {
TransformationTestResult result =
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(
testId,
@ -104,7 +104,7 @@ public final class TranscodeQualityTest {
TransformationTestResult result =
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(
testId,
@ -134,7 +134,7 @@ public final class TranscodeQualityTest {
TransformationTestResult result =
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(
testId,

10
libraries/transformer/src/androidTest/java/androidx/media3/transformer/mh/TransformationTest.java
View File

@ -55,7 +55,7 @@ public class TransformationTest {
.setEncoderFactory(new ForceEncodeEncoderFactory(context))
.build();
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(MP4_ASSET_WITH_INCREASING_TIMESTAMPS_URI_STRING)));
}
@ -86,7 +86,7 @@ public class TransformationTest {
.build()))
.build();
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(MP4_ASSET_WITH_INCREASING_TIMESTAMPS_URI_STRING)));
}
@ -109,7 +109,7 @@ public class TransformationTest {
.setEncoderFactory(new ForceEncodeEncoderFactory(context))
.build();
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.setTimeoutSeconds(180)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(MP4_REMOTE_4K60_PORTRAIT_URI_STRING)));
@ -132,7 +132,7 @@ public class TransformationTest {
.setEncoderFactory(new ForceEncodeEncoderFactory(context))
.build();
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.setTimeoutSeconds(180)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(MP4_REMOTE_8K24_URI_STRING)));
@ -148,7 +148,7 @@ public class TransformationTest {
.setRemoveAudio(true)
.build();
new TransformerAndroidTestRunner.Builder(context, transformer)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(MP4_ASSET_WITH_INCREASING_TIMESTAMPS_URI_STRING)));
}

2
libraries/transformer/src/androidTest/java/androidx/media3/transformer/mh/analysis/BitrateAnalysisTest.java
View File

@ -157,7 +157,7 @@ public class BitrateAnalysisTest {
new TransformerAndroidTestRunner.Builder(context, transformer)
.setInputValues(inputValues)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(fileUri)));
}

2
libraries/transformer/src/androidTest/java/androidx/media3/transformer/mh/analysis/SsimMapperTest.java
View File

@ -306,7 +306,7 @@ public class SsimMapperTest {
double ssim =
new TransformerAndroidTestRunner.Builder(context, transformer)
.setInputValues(inputValues)
.setMaybeCalculateSsim(true)
.setRequestCalculateSsim(true)
.build()
.run(testId, MediaItem.fromUri(Uri.parse(videoUri)))
.ssim;