Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Add SurfaceProducer#onSurfaceAvailable, deprecate onSurfaceCreated. #55418

Merged
merged 2 commits into from
Sep 25, 2024

Conversation

matanlurey
Copy link
Contributor

Closes flutter/flutter#155131.

Not only did I rename the method, but I also changed the contract slightly - now onSurfaceAvailable is only invoked after onSurfaceDestroyed has been called. The cost is a single boolean, and it honestly makes the API make a lot more sense than someone having to track this themselves.

/cc @johnmccutchan (OOO), and @flutter/android-reviewers.

Copy link
Member

@jonahwilliams jonahwilliams left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Jelly of default interface methods.

@@ -108,8 +108,9 @@ public FlutterRenderer(@NonNull FlutterJNI flutterJNI) {
public void onResume(@NonNull LifecycleOwner owner) {
Log.v(TAG, "onResume called; notifying SurfaceProducers");
for (ImageReaderSurfaceProducer producer : imageReaderProducers) {
if (producer.callback != null) {
producer.callback.onSurfaceCreated();
if (producer.callback != null && producer.notifiedDestroy) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this check ensures that we don't fire the callback multiple times if the surface wasn't prev destroyed. Makes sense!

* @deprecated Override and use {@link Callback#onSurfaceAvailable()} instead.
*/
@Deprecated(since = "Flutter 3.27", forRemoval = true)
default void onSurfaceCreated() {}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically let folks who haven't used SurfaceProducer.Callback not have to define both methods.

@matanlurey matanlurey added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 25, 2024
@auto-submit auto-submit bot merged commit 1c29585 into flutter:main Sep 25, 2024
30 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 25, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 26, 2024
@bdero
Copy link
Member

bdero commented Sep 26, 2024

Reason for revert: Engine->Framework roll breakage

@bdero bdero added the revert Label used to revert changes in a closed and merged pull request. label Sep 26, 2024
auto-submit bot pushed a commit that referenced this pull request Sep 26, 2024
@auto-submit auto-submit bot removed the revert Label used to revert changes in a closed and merged pull request. label Sep 26, 2024
auto-submit bot added a commit that referenced this pull request Sep 26, 2024
…ceCreated`. (#55418)" (#55450)

Reverts: #55418
Initiated by: bdero
Reason for reverting: [Engine->Framework roll breakage](flutter/flutter#155727 (comment))
Original PR Author: matanlurey

Reviewed By: {jonahwilliams}

This change reverts the following previous change:
Closes flutter/flutter#155131.

Not only did I rename the method, but I also changed the contract slightly - now `onSurfaceAvailable` is _only_ invoked _after_ `onSurfaceDestroyed` has been called. The cost is a single `boolean`, and it honestly makes the API make a lot more sense than someone having to track this themselves.

/cc @johnmccutchan (OOO), and @flutter/android-reviewers.
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 26, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 26, 2024
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 26, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Sep 26, 2024
…155733)

flutter/engine@d6d5fdb...d4850c1

2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (#55444)" (flutter/engine#55454)
2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (#55418)" (flutter/engine#55450)
2024-09-25 [email protected] Reland "[canvaskit] Further improve overlay optimization by splitting pictures" (flutter/engine#55402)
2024-09-25 [email protected] Move lint suppression from `baseline.xml` to `@SuppressLint`. (flutter/engine#55447)
2024-09-25 [email protected] [engine] set platform thread name to ui. (flutter/engine#55362)
2024-09-25 [email protected] Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter/engine#55444)
2024-09-25 [email protected] [Impeller] actually fix external texture for GLES. (flutter/engine#55414)
2024-09-25 [email protected] Roll Skia from e623a37de332 to 9f3b32b7b772 (2 revisions) (flutter/engine#55443)
2024-09-25 [email protected] Remove usages of WindowManager's getDefaultDisplay (flutter/engine#55002)
2024-09-25 [email protected] Fixes blend + color filter (flutter/engine#55411)
2024-09-25 [email protected] Add a boolean that exposes rotation/crop metadata capability. (flutter/engine#55434)
2024-09-25 [email protected] Roll Skia from 9af762100cf1 to e623a37de332 (1 revision) (flutter/engine#55439)
2024-09-25 [email protected] [scenario_app] delete get bitmap activity. (flutter/engine#55436)
2024-09-25 [email protected] [Flutter GPU] Use vm.Vector4 for clear color instead of ui.Color. (flutter/engine#55416)
2024-09-25 [email protected] Roll Dart SDK from dd73afd20be5 to c2728b947e46 (1 revision) (flutter/engine#55437)
2024-09-25 [email protected] adds more tasks to the engine workspace (flutter/engine#55435)
2024-09-25 [email protected] Roll Skia from 79e652aad7a9 to 9af762100cf1 (2 revisions) (flutter/engine#55433)
2024-09-25 [email protected] Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter/engine#55418)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
thejitenpatel pushed a commit to thejitenpatel/flutter that referenced this pull request Sep 26, 2024
…lutter#155733)

flutter/engine@d6d5fdb...d4850c1

2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter#55444)" (flutter/engine#55454)
2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter#55418)" (flutter/engine#55450)
2024-09-25 [email protected] Reland "[canvaskit] Further improve overlay optimization by splitting pictures" (flutter/engine#55402)
2024-09-25 [email protected] Move lint suppression from `baseline.xml` to `@SuppressLint`. (flutter/engine#55447)
2024-09-25 [email protected] [engine] set platform thread name to ui. (flutter/engine#55362)
2024-09-25 [email protected] Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter/engine#55444)
2024-09-25 [email protected] [Impeller] actually fix external texture for GLES. (flutter/engine#55414)
2024-09-25 [email protected] Roll Skia from e623a37de332 to 9f3b32b7b772 (2 revisions) (flutter/engine#55443)
2024-09-25 [email protected] Remove usages of WindowManager's getDefaultDisplay (flutter/engine#55002)
2024-09-25 [email protected] Fixes blend + color filter (flutter/engine#55411)
2024-09-25 [email protected] Add a boolean that exposes rotation/crop metadata capability. (flutter/engine#55434)
2024-09-25 [email protected] Roll Skia from 9af762100cf1 to e623a37de332 (1 revision) (flutter/engine#55439)
2024-09-25 [email protected] [scenario_app] delete get bitmap activity. (flutter/engine#55436)
2024-09-25 [email protected] [Flutter GPU] Use vm.Vector4 for clear color instead of ui.Color. (flutter/engine#55416)
2024-09-25 [email protected] Roll Dart SDK from dd73afd20be5 to c2728b947e46 (1 revision) (flutter/engine#55437)
2024-09-25 [email protected] adds more tasks to the engine workspace (flutter/engine#55435)
2024-09-25 [email protected] Roll Skia from 79e652aad7a9 to 9af762100cf1 (2 revisions) (flutter/engine#55433)
2024-09-25 [email protected] Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter/engine#55418)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
thejitenpatel pushed a commit to thejitenpatel/flutter that referenced this pull request Sep 26, 2024
…lutter#155733)

flutter/engine@d6d5fdb...d4850c1

2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter#55444)" (flutter/engine#55454)
2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter#55418)" (flutter/engine#55450)
2024-09-25 [email protected] Reland "[canvaskit] Further improve overlay optimization by splitting pictures" (flutter/engine#55402)
2024-09-25 [email protected] Move lint suppression from `baseline.xml` to `@SuppressLint`. (flutter/engine#55447)
2024-09-25 [email protected] [engine] set platform thread name to ui. (flutter/engine#55362)
2024-09-25 [email protected] Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter/engine#55444)
2024-09-25 [email protected] [Impeller] actually fix external texture for GLES. (flutter/engine#55414)
2024-09-25 [email protected] Roll Skia from e623a37de332 to 9f3b32b7b772 (2 revisions) (flutter/engine#55443)
2024-09-25 [email protected] Remove usages of WindowManager's getDefaultDisplay (flutter/engine#55002)
2024-09-25 [email protected] Fixes blend + color filter (flutter/engine#55411)
2024-09-25 [email protected] Add a boolean that exposes rotation/crop metadata capability. (flutter/engine#55434)
2024-09-25 [email protected] Roll Skia from 9af762100cf1 to e623a37de332 (1 revision) (flutter/engine#55439)
2024-09-25 [email protected] [scenario_app] delete get bitmap activity. (flutter/engine#55436)
2024-09-25 [email protected] [Flutter GPU] Use vm.Vector4 for clear color instead of ui.Color. (flutter/engine#55416)
2024-09-25 [email protected] Roll Dart SDK from dd73afd20be5 to c2728b947e46 (1 revision) (flutter/engine#55437)
2024-09-25 [email protected] adds more tasks to the engine workspace (flutter/engine#55435)
2024-09-25 [email protected] Roll Skia from 79e652aad7a9 to 9af762100cf1 (2 revisions) (flutter/engine#55433)
2024-09-25 [email protected] Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter/engine#55418)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
sfshaza2 pushed a commit to flutter/website that referenced this pull request Sep 26, 2024
Documents (for end-users) the changes made in:

- flutter/engine#55418
- flutter/engine#55434 (pending merge)
auto-submit bot pushed a commit that referenced this pull request Sep 26, 2024
auto-submit bot added a commit that referenced this pull request Sep 26, 2024
… `onSurfaceCreated`. (#55418)" (#55450)" (#55463)

Reverts: #55450
Initiated by: matanlurey
Reason for reverting: Fixed forward in flutter/packages#7712.
Original PR Author: auto-submit[bot]

Reviewed By: {fluttergithubbot}

This change reverts the following previous change:
Reverts: #55418
Initiated by: bdero
Reason for reverting: [Engine->Framework roll breakage](flutter/flutter#155727 (comment))
Original PR Author: matanlurey

Reviewed By: {jonahwilliams}

This change reverts the following previous change:
Closes flutter/flutter#155131.

Not only did I rename the method, but I also changed the contract slightly - now `onSurfaceAvailable` is _only_ invoked _after_ `onSurfaceDestroyed` has been called. The cost is a single `boolean`, and it honestly makes the API make a lot more sense than someone having to track this themselves.

/cc @johnmccutchan (OOO), and @flutter/android-reviewers.
thejitenpatel pushed a commit to thejitenpatel/flutter that referenced this pull request Sep 27, 2024
…lutter#155733)

flutter/engine@d6d5fdb...d4850c1

2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter#55444)" (flutter/engine#55454)
2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter#55418)" (flutter/engine#55450)
2024-09-25 [email protected] Reland "[canvaskit] Further improve overlay optimization by splitting pictures" (flutter/engine#55402)
2024-09-25 [email protected] Move lint suppression from `baseline.xml` to `@SuppressLint`. (flutter/engine#55447)
2024-09-25 [email protected] [engine] set platform thread name to ui. (flutter/engine#55362)
2024-09-25 [email protected] Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter/engine#55444)
2024-09-25 [email protected] [Impeller] actually fix external texture for GLES. (flutter/engine#55414)
2024-09-25 [email protected] Roll Skia from e623a37de332 to 9f3b32b7b772 (2 revisions) (flutter/engine#55443)
2024-09-25 [email protected] Remove usages of WindowManager's getDefaultDisplay (flutter/engine#55002)
2024-09-25 [email protected] Fixes blend + color filter (flutter/engine#55411)
2024-09-25 [email protected] Add a boolean that exposes rotation/crop metadata capability. (flutter/engine#55434)
2024-09-25 [email protected] Roll Skia from 9af762100cf1 to e623a37de332 (1 revision) (flutter/engine#55439)
2024-09-25 [email protected] [scenario_app] delete get bitmap activity. (flutter/engine#55436)
2024-09-25 [email protected] [Flutter GPU] Use vm.Vector4 for clear color instead of ui.Color. (flutter/engine#55416)
2024-09-25 [email protected] Roll Dart SDK from dd73afd20be5 to c2728b947e46 (1 revision) (flutter/engine#55437)
2024-09-25 [email protected] adds more tasks to the engine workspace (flutter/engine#55435)
2024-09-25 [email protected] Roll Skia from 79e652aad7a9 to 9af762100cf1 (2 revisions) (flutter/engine#55433)
2024-09-25 [email protected] Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter/engine#55418)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
thejitenpatel pushed a commit to thejitenpatel/flutter that referenced this pull request Sep 27, 2024
…lutter#155733)

flutter/engine@d6d5fdb...d4850c1

2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter#55444)" (flutter/engine#55454)
2024-09-26 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter#55418)" (flutter/engine#55450)
2024-09-25 [email protected] Reland "[canvaskit] Further improve overlay optimization by splitting pictures" (flutter/engine#55402)
2024-09-25 [email protected] Move lint suppression from `baseline.xml` to `@SuppressLint`. (flutter/engine#55447)
2024-09-25 [email protected] [engine] set platform thread name to ui. (flutter/engine#55362)
2024-09-25 [email protected] Roll Dart SDK from c2728b947e46 to 016368ee313d (1 revision) (flutter/engine#55444)
2024-09-25 [email protected] [Impeller] actually fix external texture for GLES. (flutter/engine#55414)
2024-09-25 [email protected] Roll Skia from e623a37de332 to 9f3b32b7b772 (2 revisions) (flutter/engine#55443)
2024-09-25 [email protected] Remove usages of WindowManager's getDefaultDisplay (flutter/engine#55002)
2024-09-25 [email protected] Fixes blend + color filter (flutter/engine#55411)
2024-09-25 [email protected] Add a boolean that exposes rotation/crop metadata capability. (flutter/engine#55434)
2024-09-25 [email protected] Roll Skia from 9af762100cf1 to e623a37de332 (1 revision) (flutter/engine#55439)
2024-09-25 [email protected] [scenario_app] delete get bitmap activity. (flutter/engine#55436)
2024-09-25 [email protected] [Flutter GPU] Use vm.Vector4 for clear color instead of ui.Color. (flutter/engine#55416)
2024-09-25 [email protected] Roll Dart SDK from dd73afd20be5 to c2728b947e46 (1 revision) (flutter/engine#55437)
2024-09-25 [email protected] adds more tasks to the engine workspace (flutter/engine#55435)
2024-09-25 [email protected] Roll Skia from 79e652aad7a9 to 9af762100cf1 (2 revisions) (flutter/engine#55433)
2024-09-25 [email protected] Add `SurfaceProducer#onSurfaceAvailable`, deprecate `onSurfaceCreated`. (flutter/engine#55418)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
autosubmit Merge PR when tree becomes green via auto submit App platform-android
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ReplaceSurfaceProducer.Callback.onSurfaceCreated with onSurfaceAvailable when published to stable
3 participants