Skip to content

Commit 10ca0ca

Browse files
CharcoalChenCharcoalChen
committed
Fix ResolutionSelector API review comments
1. Added @ImageOutputConfig.RotationDegreesValue annotation to the int parameter of ResolutionFileter#filter API 2. Removed "flag" wording from the high resolution related API - Renamed setHighResolutionEnabledFlag function name to setAllowedResolutionMode - Renamed HIGH_RESOLUTION_FLAG_OFF/ON to ALLOWED_RESOLUTIONS_NORMAL and ALLOWED_RESOLUTIONS_SLOW - Updated the related javadoc description Relnote: "Renamed ResolutionSelector#HIGH_RESOLUTION_FLAG_OFF/ON constants to ALLOWED_RESOLUTIONS_NORMAL/SLOW and renamed the builder setHighResolutionEnabledFlag function name to setAllowedResolutionMode." Bug: 277218966 Test: ./gradlew bOS Change-Id: Iae8175364782aecb55e04936bbba4e27a3834124
1 parent a613980 commit 10ca0ca

File tree

13 files changed

+84
-71
lines changed

13 files changed

+84
-71
lines changed

‎camera/camera-camera2/src/androidTest/java/androidx/camera/camera2/internal/Camera2CameraImplTest.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import static androidx.camera.core.CameraSelector.DEFAULT_BACK_CAMERA;
2323
import static androidx.camera.core.concurrent.CameraCoordinator.CAMERA_OPERATING_MODE_CONCURRENT;
2424
import static androidx.camera.core.concurrent.CameraCoordinator.CAMERA_OPERATING_MODE_SINGLE;
25+
import static androidx.camera.core.resolutionselector.ResolutionSelector.ALLOWED_RESOLUTIONS_SLOW;
2526

2627
import static com.google.common.base.Preconditions.checkNotNull;
2728
import static com.google.common.base.Preconditions.checkState;
@@ -1075,8 +1076,8 @@ public void zslDisabled_whenHighResolutionIsEnabled() throws InterruptedExceptio
10751076

10761077
// Creates a test use case with high resolution enabled.
10771078
ResolutionSelector highResolutionSelector =
1078-
new ResolutionSelector.Builder().setHighResolutionEnabledFlag(
1079-
ResolutionSelector.HIGH_RESOLUTION_FLAG_ON).build();
1079+
new ResolutionSelector.Builder().setAllowedResolutionMode(
1080+
ALLOWED_RESOLUTIONS_SLOW).build();
10801081
FakeUseCaseConfig.Builder configBuilder =
10811082
new FakeUseCaseConfig.Builder().setSessionOptionUnpacker(
10821083
new Camera2SessionOptionUnpacker()).setTargetName(

‎camera/camera-core/api/current.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -534,19 +534,19 @@ package androidx.camera.core.resolutionselector {
534534
}
535535

536536
@RequiresApi(21) public final class ResolutionSelector {
537+
method public int getAllowedResolutionMode();
537538
method public androidx.camera.core.resolutionselector.AspectRatioStrategy getAspectRatioStrategy();
538-
method public int getHighResolutionEnabledFlag();
539539
method public androidx.camera.core.resolutionselector.ResolutionFilter? getResolutionFilter();
540540
method public androidx.camera.core.resolutionselector.ResolutionStrategy? getResolutionStrategy();
541-
field public static final int HIGH_RESOLUTION_FLAG_OFF = 0; // 0x0
542-
field public static final int HIGH_RESOLUTION_FLAG_ON = 1; // 0x1
541+
field public static final int ALLOWED_RESOLUTIONS_NORMAL = 0; // 0x0
542+
field public static final int ALLOWED_RESOLUTIONS_SLOW = 1; // 0x1
543543
}
544544

545545
public static final class ResolutionSelector.Builder {
546546
ctor public ResolutionSelector.Builder();
547547
method public androidx.camera.core.resolutionselector.ResolutionSelector build();
548+
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setAllowedResolutionMode(int);
548549
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setAspectRatioStrategy(androidx.camera.core.resolutionselector.AspectRatioStrategy);
549-
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setHighResolutionEnabledFlag(int);
550550
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setResolutionFilter(androidx.camera.core.resolutionselector.ResolutionFilter);
551551
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setResolutionStrategy(androidx.camera.core.resolutionselector.ResolutionStrategy);
552552
}

‎camera/camera-core/api/public_plus_experimental_current.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -551,19 +551,19 @@ package androidx.camera.core.resolutionselector {
551551
}
552552

553553
@RequiresApi(21) public final class ResolutionSelector {
554+
method public int getAllowedResolutionMode();
554555
method public androidx.camera.core.resolutionselector.AspectRatioStrategy getAspectRatioStrategy();
555-
method public int getHighResolutionEnabledFlag();
556556
method public androidx.camera.core.resolutionselector.ResolutionFilter? getResolutionFilter();
557557
method public androidx.camera.core.resolutionselector.ResolutionStrategy? getResolutionStrategy();
558-
field public static final int HIGH_RESOLUTION_FLAG_OFF = 0; // 0x0
559-
field public static final int HIGH_RESOLUTION_FLAG_ON = 1; // 0x1
558+
field public static final int ALLOWED_RESOLUTIONS_NORMAL = 0; // 0x0
559+
field public static final int ALLOWED_RESOLUTIONS_SLOW = 1; // 0x1
560560
}
561561

562562
public static final class ResolutionSelector.Builder {
563563
ctor public ResolutionSelector.Builder();
564564
method public androidx.camera.core.resolutionselector.ResolutionSelector build();
565+
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setAllowedResolutionMode(int);
565566
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setAspectRatioStrategy(androidx.camera.core.resolutionselector.AspectRatioStrategy);
566-
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setHighResolutionEnabledFlag(int);
567567
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setResolutionFilter(androidx.camera.core.resolutionselector.ResolutionFilter);
568568
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setResolutionStrategy(androidx.camera.core.resolutionselector.ResolutionStrategy);
569569
}

‎camera/camera-core/api/restricted_current.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -534,19 +534,19 @@ package androidx.camera.core.resolutionselector {
534534
}
535535

536536
@RequiresApi(21) public final class ResolutionSelector {
537+
method public int getAllowedResolutionMode();
537538
method public androidx.camera.core.resolutionselector.AspectRatioStrategy getAspectRatioStrategy();
538-
method public int getHighResolutionEnabledFlag();
539539
method public androidx.camera.core.resolutionselector.ResolutionFilter? getResolutionFilter();
540540
method public androidx.camera.core.resolutionselector.ResolutionStrategy? getResolutionStrategy();
541-
field public static final int HIGH_RESOLUTION_FLAG_OFF = 0; // 0x0
542-
field public static final int HIGH_RESOLUTION_FLAG_ON = 1; // 0x1
541+
field public static final int ALLOWED_RESOLUTIONS_NORMAL = 0; // 0x0
542+
field public static final int ALLOWED_RESOLUTIONS_SLOW = 1; // 0x1
543543
}
544544

545545
public static final class ResolutionSelector.Builder {
546546
ctor public ResolutionSelector.Builder();
547547
method public androidx.camera.core.resolutionselector.ResolutionSelector build();
548+
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setAllowedResolutionMode(int);
548549
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setAspectRatioStrategy(androidx.camera.core.resolutionselector.AspectRatioStrategy);
549-
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setHighResolutionEnabledFlag(int);
550550
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setResolutionFilter(androidx.camera.core.resolutionselector.ResolutionFilter);
551551
method public androidx.camera.core.resolutionselector.ResolutionSelector.Builder setResolutionStrategy(androidx.camera.core.resolutionselector.ResolutionStrategy);
552552
}

‎camera/camera-core/src/main/java/androidx/camera/core/UseCase.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,8 @@ public UseCaseConfig<?> mergeConfigs(
263263
// Forces disable ZSL when high resolution is enabled.
264264
if (mergedConfig.containsOption(ImageOutputConfig.OPTION_RESOLUTION_SELECTOR)
265265
&& mergedConfig.retrieveOption(
266-
ImageOutputConfig.OPTION_RESOLUTION_SELECTOR).getHighResolutionEnabledFlag()
267-
!= ResolutionSelector.HIGH_RESOLUTION_FLAG_OFF) {
266+
ImageOutputConfig.OPTION_RESOLUTION_SELECTOR).getAllowedResolutionMode()
267+
!= ResolutionSelector.ALLOWED_RESOLUTIONS_NORMAL) {
268268
mergedConfig.insertOption(UseCaseConfig.OPTION_ZSL_DISABLED, true);
269269
}
270270

‎camera/camera-core/src/main/java/androidx/camera/core/impl/utils/ResolutionSelectorUtil.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,10 @@ public static ResolutionSelector overrideResolutionSelectors(
6363
builder.setResolutionFilter(resolutionSelectorToOverride.getResolutionFilter());
6464
}
6565

66-
if (resolutionSelectorToOverride.getHighResolutionEnabledFlag()
67-
!= ResolutionSelector.HIGH_RESOLUTION_FLAG_OFF) {
68-
builder.setHighResolutionEnabledFlag(
69-
resolutionSelectorToOverride.getHighResolutionEnabledFlag());
66+
if (resolutionSelectorToOverride.getAllowedResolutionMode()
67+
!= ResolutionSelector.ALLOWED_RESOLUTIONS_NORMAL) {
68+
builder.setAllowedResolutionMode(
69+
resolutionSelectorToOverride.getAllowedResolutionMode());
7070
}
7171

7272
return builder.build();

‎camera/camera-core/src/main/java/androidx/camera/core/internal/SupportedOutputSizesSorter.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,8 @@ private List<Size> getResolutionCandidateList(@NonNull UseCaseConfig<?> useCaseC
289289
private List<Size> applyHighResolutionSettings(@NonNull List<Size> resolutionCandidateList,
290290
@NonNull ResolutionSelector resolutionSelector, int imageFormat) {
291291
// Appends high resolution output sizes if high resolution is enabled by ResolutionSelector
292-
if (resolutionSelector.getHighResolutionEnabledFlag()
293-
== ResolutionSelector.HIGH_RESOLUTION_FLAG_ON) {
292+
if (resolutionSelector.getAllowedResolutionMode()
293+
== ResolutionSelector.ALLOWED_RESOLUTIONS_SLOW) {
294294
List<Size> allSizesList = new ArrayList<>();
295295
allSizesList.addAll(resolutionCandidateList);
296296
allSizesList.addAll(mCameraInfoInternal.getSupportedHighResolutions(imageFormat));

‎camera/camera-core/src/main/java/androidx/camera/core/resolutionselector/ResolutionFilter.java

+8-5
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import androidx.camera.core.AspectRatio;
2525
import androidx.camera.core.Preview;
2626
import androidx.camera.core.UseCase;
27+
import androidx.camera.core.impl.ImageOutputConfig;
2728

2829
import java.util.List;
2930

@@ -51,16 +52,18 @@ public interface ResolutionFilter {
5152
* according to the other resolution selector settings.
5253
* @param rotationDegrees the rotation degrees to rotate the image to the desired
5354
* orientation, matching the {@link UseCase}’s target rotation setting
54-
* . For example, the target rotation set via
55-
* {@link Preview.Builder#setTargetRotation(int)} or
55+
* {@link View} size at the front of the returned list. The value is
56+
* one of the following: 0, 90, 180, or 270. For example, the target
57+
* rotation set via {@link Preview.Builder#setTargetRotation(int)} or
5658
* {@link Preview#setTargetRotation(int)}. After rotating the sizes by
5759
* the rotation degrees, applications can obtain the source image size
5860
* in the specified target orientation. Then, applications can put the
59-
* size that best fits to the {@link Preview}'s Android
60-
* {@link View} size at the front of the returned list.
61+
* size that best fits to the {@link Preview}'s Android {@link View}
62+
* size at the front of the returned list.
6163
* @return the desired ordered sizes list for resolution selection. The returned list should
6264
* only include sizes in the provided input supported sizes list.
6365
*/
6466
@NonNull
65-
List<Size> filter(@NonNull List<Size> supportedSizes, int rotationDegrees);
67+
List<Size> filter(@NonNull List<Size> supportedSizes,
68+
@ImageOutputConfig.RotationDegreesValue int rotationDegrees);
6669
}

‎camera/camera-core/src/main/java/androidx/camera/core/resolutionselector/ResolutionSelector.java

+40-35
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
* <p>ResolutionSelector provides the following function for applications to adjust the candidate
4747
* resolution settings.
4848
* <ul>
49-
* <li> {@link Builder#setHighResolutionEnabledFlag(int)}
49+
* <li> {@link Builder#setAllowedResolutionMode(int)}
5050
* </ul>
5151
*
5252
* <p>For the second step, ResolutionSelector provides the following three functions for
@@ -82,60 +82,67 @@
8282
* <p>When creating a ResolutionSelector instance, the
8383
* {@link AspectRatioStrategy#RATIO_4_3_FALLBACK_AUTO_STRATEGY} will be the default
8484
* {@link AspectRatioStrategy} if it is not set.
85-
* {@link ResolutionSelector#HIGH_RESOLUTION_FLAG_OFF} is the default value of high resolution
86-
* enabled flag. However, if neither the {@link ResolutionStrategy} nor the
87-
* {@link ResolutionFilter} are set, there will be no default value specified.
85+
* {@link ResolutionSelector#ALLOWED_RESOLUTIONS_NORMAL} is the default allowed resolution
86+
* mode. However, if neither the {@link ResolutionStrategy} nor the {@link ResolutionFilter} are
87+
* set, there will be no default value specified.
8888
*/
8989
@RequiresApi(21) // TODO(b/200306659): Remove and replace with annotation on package-info.java
9090
public final class ResolutionSelector {
9191
/**
92-
* This flag disables high resolution support.
92+
* This mode allows CameraX to select the normal output sizes on the camera device.
93+
*
94+
* <p>The available resolutions for this mode are obtained from the
95+
* {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes(int)} method
96+
* from the stream configuration map obtained with the
97+
* {@link android.hardware.camera2.CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP}
98+
* camera characteristics.
9399
*/
94-
public static final int HIGH_RESOLUTION_FLAG_OFF = 0;
100+
public static final int ALLOWED_RESOLUTIONS_NORMAL = 0;
95101
/**
96-
* This flag enables high resolution in the default sensor pixel mode.
102+
* This mode allows CameraX to select the output sizes which might result in slower capture
103+
* times.
97104
*
98-
* <p>This flag allows CameraX to select the highest resolution output sizes available on the
99-
* camera device. The high resolution is retrieved via the
105+
* <p>The available resolutions for this mode are obtained from the
106+
* {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes(int)} and
100107
* {@link android.hardware.camera2.params.StreamConfigurationMap#getHighResolutionOutputSizes(int)}
101-
* from the stream configuration map obtained with the
108+
* methods from the stream configuration map obtained with the
102109
* {@link android.hardware.camera2.CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP}
103-
* camera characteristics. However, please note that using a high resolution may result in
104-
* slower capture times. Please see the javadoc of
110+
* camera characteristics. However, please note that using a resolution obtained from the
111+
* {@link android.hardware.camera2.params.StreamConfigurationMap#getHighResolutionOutputSizes(int)}
112+
* may result in slower capture times. Please see the javadoc of
105113
* {@link android.hardware.camera2.params.StreamConfigurationMap#getHighResolutionOutputSizes(int)}
106114
* for more details.
107115
*
108116
* <p>Since Android 12, some devices might support a maximum resolution sensor pixel mode,
109117
* which allows them to capture additional ultra high resolutions retrieved from
110118
* {@link android.hardware.camera2.CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP_MAXIMUM_RESOLUTION}
111-
* . Enabling high resolution with this flag does not allow applications to select those
112-
* ultra high resolutions.
119+
* . This mode does not allow applications to select those ultra high resolutions.
113120
*/
114-
public static final int HIGH_RESOLUTION_FLAG_ON = 1;
121+
public static final int ALLOWED_RESOLUTIONS_SLOW = 1;
115122

116-
@IntDef({HIGH_RESOLUTION_FLAG_OFF, HIGH_RESOLUTION_FLAG_ON})
123+
@IntDef({ALLOWED_RESOLUTIONS_NORMAL, ALLOWED_RESOLUTIONS_SLOW})
117124
@Retention(RetentionPolicy.SOURCE)
118125
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
119-
public @interface HighResolutionFlag {
126+
public @interface AllowedResolutionMode {
120127
}
121128
@NonNull
122129
private final AspectRatioStrategy mAspectRatioStrategy;
123130
@Nullable
124131
private final ResolutionStrategy mResolutionStrategy;
125132
@Nullable
126133
private final ResolutionFilter mResolutionFilter;
127-
@HighResolutionFlag
128-
private final int mHighResolutionEnabledFlag;
134+
@AllowedResolutionMode
135+
private final int mAllowedResolutionMode;
129136

130137
ResolutionSelector(
131138
@NonNull AspectRatioStrategy aspectRatioStrategy,
132139
@Nullable ResolutionStrategy resolutionStrategy,
133140
@Nullable ResolutionFilter resolutionFilter,
134-
@HighResolutionFlag int highResolutionEnabledFlag) {
141+
@AllowedResolutionMode int allowedResolutionMode) {
135142
mAspectRatioStrategy = aspectRatioStrategy;
136143
mResolutionStrategy = resolutionStrategy;
137144
mResolutionFilter = resolutionFilter;
138-
mHighResolutionEnabledFlag = highResolutionEnabledFlag;
145+
mAllowedResolutionMode = allowedResolutionMode;
139146
}
140147

141148
/**
@@ -165,11 +172,11 @@ public ResolutionFilter getResolutionFilter() {
165172
}
166173

167174
/**
168-
* Returns the specified high resolution enabled flag.
175+
* Returns the specified allowed resolution mode.
169176
*/
170-
@HighResolutionFlag
171-
public int getHighResolutionEnabledFlag() {
172-
return mHighResolutionEnabledFlag;
177+
@AllowedResolutionMode
178+
public int getAllowedResolutionMode() {
179+
return mAllowedResolutionMode;
173180
}
174181

175182
/**
@@ -182,8 +189,8 @@ public static final class Builder {
182189
private ResolutionStrategy mResolutionStrategy = null;
183190
@Nullable
184191
private ResolutionFilter mResolutionFilter = null;
185-
@HighResolutionFlag
186-
private int mHighResolutionEnabledFlag = HIGH_RESOLUTION_FLAG_OFF;
192+
@AllowedResolutionMode
193+
private int mAllowedResolutionMode = ALLOWED_RESOLUTIONS_NORMAL;
187194

188195
/**
189196
* Creates a Builder instance.
@@ -195,7 +202,7 @@ private Builder(@NonNull ResolutionSelector resolutionSelector) {
195202
mAspectRatioStrategy = resolutionSelector.getAspectRatioStrategy();
196203
mResolutionStrategy = resolutionSelector.getResolutionStrategy();
197204
mResolutionFilter = resolutionSelector.getResolutionFilter();
198-
mHighResolutionEnabledFlag = resolutionSelector.getHighResolutionEnabledFlag();
205+
mAllowedResolutionMode = resolutionSelector.getAllowedResolutionMode();
199206
}
200207

201208
/**
@@ -245,16 +252,14 @@ public Builder setResolutionFilter(@NonNull ResolutionFilter resolutionFilter) {
245252
}
246253

247254
/**
248-
* Sets high resolutions enabled flag to allow the application to select high
249-
* resolutions for the {@link UseCase}s. This will enable the application to choose high
250-
* resolutions for the captured image, which may result in better quality images.
255+
* Sets the allowed resolution mode.
251256
*
252257
* <p>If not specified, the default setting is
253-
* {@link ResolutionSelector#HIGH_RESOLUTION_FLAG_OFF}.
258+
* {@link ResolutionSelector#ALLOWED_RESOLUTIONS_NORMAL}.
254259
*/
255260
@NonNull
256-
public Builder setHighResolutionEnabledFlag(@HighResolutionFlag int flag) {
257-
mHighResolutionEnabledFlag = flag;
261+
public Builder setAllowedResolutionMode(@AllowedResolutionMode int mode) {
262+
mAllowedResolutionMode = mode;
258263
return this;
259264
}
260265

@@ -265,7 +270,7 @@ public Builder setHighResolutionEnabledFlag(@HighResolutionFlag int flag) {
265270
@NonNull
266271
public ResolutionSelector build() {
267272
return new ResolutionSelector(mAspectRatioStrategy, mResolutionStrategy,
268-
mResolutionFilter, mHighResolutionEnabledFlag);
273+
mResolutionFilter, mAllowedResolutionMode);
269274
}
270275
}
271276
}

0 commit comments

Comments
 (0)