Don't use OffscreenCanvas on Safari

PiperOrigin-RevId: 522689566
This commit is contained in:
Sebastian Schmidt 2023-04-07 14:49:34 -07:00 committed by Copybara-Service
parent 8cedb82df1
commit 938b501d15
6 changed files with 130 additions and 8 deletions

View File

@ -40,6 +40,7 @@ mediapipe_ts_library(
"//mediapipe/tasks/web/core:task_runner", "//mediapipe/tasks/web/core:task_runner",
"//mediapipe/web/graph_runner:graph_runner_image_lib_ts", "//mediapipe/web/graph_runner:graph_runner_image_lib_ts",
"//mediapipe/web/graph_runner:graph_runner_ts", "//mediapipe/web/graph_runner:graph_runner_ts",
"//mediapipe/web/graph_runner:platform_utils",
"//mediapipe/web/graph_runner:register_model_resources_graph_service_ts", "//mediapipe/web/graph_runner:register_model_resources_graph_service_ts",
], ],
) )

View File

@ -20,6 +20,7 @@ import {WasmFileset} from '../../../../tasks/web/core/wasm_fileset';
import {ImageProcessingOptions} from '../../../../tasks/web/vision/core/image_processing_options'; import {ImageProcessingOptions} from '../../../../tasks/web/vision/core/image_processing_options';
import {GraphRunner, ImageSource, WasmMediaPipeConstructor} from '../../../../web/graph_runner/graph_runner'; import {GraphRunner, ImageSource, WasmMediaPipeConstructor} from '../../../../web/graph_runner/graph_runner';
import {SupportImage, WasmImage} from '../../../../web/graph_runner/graph_runner_image_lib'; import {SupportImage, WasmImage} from '../../../../web/graph_runner/graph_runner_image_lib';
import {isWebKit} from '../../../../web/graph_runner/platform_utils';
import {SupportModelResourcesGraphService} from '../../../../web/graph_runner/register_model_resources_graph_service'; import {SupportModelResourcesGraphService} from '../../../../web/graph_runner/register_model_resources_graph_service';
import {VisionTaskOptions} from './vision_task_options'; import {VisionTaskOptions} from './vision_task_options';
@ -39,11 +40,13 @@ export class VisionGraphRunner extends GraphRunnerVisionType {}
* GraphRunner should create its own canvas. * GraphRunner should create its own canvas.
*/ */
function createCanvas(): HTMLCanvasElement|OffscreenCanvas|undefined { function createCanvas(): HTMLCanvasElement|OffscreenCanvas|undefined {
// Returns an HTML canvas or `undefined` if OffscreenCanvas is available const supportsWebGL2ForOffscreenCanvas =
typeof OffscreenCanvas !== 'undefined' && !isWebKit();
// Returns an HTML canvas or `undefined` if OffscreenCanvas is fully supported
// (since the graph runner can initialize its own OffscreenCanvas). // (since the graph runner can initialize its own OffscreenCanvas).
return typeof OffscreenCanvas === 'undefined' ? return supportsWebGL2ForOffscreenCanvas ? undefined :
document.createElement('canvas') : document.createElement('canvas');
undefined;
} }
/** Base class for all MediaPipe Vision Tasks. */ /** Base class for all MediaPipe Vision Tasks. */

View File

@ -1,6 +1,7 @@
# The TypeScript graph runner used by all MediaPipe Web tasks. # The TypeScript graph runner used by all MediaPipe Web tasks.
load("//mediapipe/framework/port:build_config.bzl", "mediapipe_ts_library") load("//mediapipe/framework/port:build_config.bzl", "mediapipe_ts_library")
load("@npm//@bazel/jasmine:index.bzl", "jasmine_node_test")
package(default_visibility = [ package(default_visibility = [
"//mediapipe/tasks:internal", "//mediapipe/tasks:internal",
@ -12,6 +13,7 @@ mediapipe_ts_library(
":graph_runner.ts", ":graph_runner.ts",
], ],
allow_unoptimized_namespaces = True, allow_unoptimized_namespaces = True,
deps = [":platform_utils"],
) )
mediapipe_ts_library( mediapipe_ts_library(
@ -31,3 +33,26 @@ mediapipe_ts_library(
allow_unoptimized_namespaces = True, allow_unoptimized_namespaces = True,
deps = [":graph_runner_ts"], deps = [":graph_runner_ts"],
) )
mediapipe_ts_library(
name = "platform_utils",
srcs = [
"platform_utils.ts",
],
)
mediapipe_ts_library(
name = "platform_utils_test_lib",
testonly = True,
srcs = [
"platform_utils.test.ts",
],
deps = [":platform_utils"],
)
jasmine_node_test(
name = "platform_utils_test",
deps = [
":platform_utils_test_lib",
],
)

View File

@ -1,5 +1,6 @@
// Placeholder for internal dependency on assertTruthy // Placeholder for internal dependency on assertTruthy
// Placeholder for internal dependency on jsloader // Placeholder for internal dependency on jsloader
import {isWebKit} from '../../web/graph_runner/platform_utils';
// Placeholder for internal dependency on trusted resource url // Placeholder for internal dependency on trusted resource url
// This file can serve as a common interface for most simple TypeScript // This file can serve as a common interface for most simple TypeScript
@ -216,13 +217,15 @@ export class GraphRunner {
if (glCanvas !== undefined) { if (glCanvas !== undefined) {
this.wasmModule.canvas = glCanvas; this.wasmModule.canvas = glCanvas;
} else if (typeof OffscreenCanvas !== 'undefined') { } else if (typeof OffscreenCanvas !== 'undefined' && !isWebKit()) {
// If no canvas is provided, assume Chrome/Firefox and just make an // If no canvas is provided, assume Chrome/Firefox and just make an
// OffscreenCanvas for GPU processing. // OffscreenCanvas for GPU processing. Note that we exclude Safari
// since it does not (yet) support WebGL for OffscreenCanvas.
this.wasmModule.canvas = new OffscreenCanvas(1, 1); this.wasmModule.canvas = new OffscreenCanvas(1, 1);
} else { } else {
console.warn('OffscreenCanvas not detected and GraphRunner constructor ' console.warn(
+ 'glCanvas parameter is undefined. Creating backup canvas.'); 'OffscreenCanvas not supported and GraphRunner constructor ' +
'glCanvas parameter is undefined. Creating backup canvas.');
this.wasmModule.canvas = document.createElement('canvas'); this.wasmModule.canvas = document.createElement('canvas');
} }
} }

View File

@ -0,0 +1,67 @@
/**
* Copyright 2022 The MediaPipe Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import 'jasmine';
import {isWebKit} from '../../web/graph_runner/platform_utils';
const DESKTOP_FIREFOX =
'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:65.0) Gecko/20100101 Firefox/65.0';
const DESKTOP_SAFARI =
'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Safari/604.1.38,gzip(gfe)';
const IOS_SAFARI =
'Mozilla/5.0 (iPhone; CPU iPhone OS 5_0 like Mac OS X) AppleWebKit/534.46 (KHTML, like Gecko) Version/5.1 Mobile/9A334 Safari/7534.48.3';
const IPAD_SAFARI =
'Mozilla/5.0 (iPad; U; CPU OS 3_2 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Version/4.0.4 Mobile/7B334b Safari/531.21.10';
const DESKTOP_CHROME =
'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/535.8 (KHTML, like Gecko) Chrome/40.0.1000.10 Safari/535.8';
const IOS_CHROME =
'Mozilla/5.0 (iPhone; CPU iPhone OS 5_1_1 like Mac OS X; en-us) AppleWebKit/534.46.0 (KHTML, like Gecko) CriOS/22.0.1194.0 Mobile/11E53 Safari/7534.48.3';
describe('isWebKit()', () => {
const navigator = {userAgent: ''};
it('returns false for Firefox on desktop', () => {
navigator.userAgent = DESKTOP_FIREFOX;
expect(isWebKit(navigator as Navigator)).toBeFalse();
});
it('returns true for Safari on desktop', () => {
navigator.userAgent = DESKTOP_SAFARI;
expect(isWebKit(navigator as Navigator)).toBeTrue();
});
it('returns true for Safari on iOS', () => {
navigator.userAgent = IOS_SAFARI;
expect(isWebKit(navigator as Navigator)).toBeTrue();
});
it('returns true for Safari on iPad', () => {
navigator.userAgent = IPAD_SAFARI;
expect(isWebKit(navigator as Navigator)).toBeTrue();
});
it('returns false for Chrome on desktop', () => {
navigator.userAgent = DESKTOP_CHROME;
expect(isWebKit(navigator as Navigator)).toBeFalse();
});
it('returns true for Chrome on iOS', () => {
navigator.userAgent = IOS_CHROME;
expect(isWebKit(navigator as Navigator)).toBeTrue();
});
});

View File

@ -0,0 +1,23 @@
/**
* Copyright 2023 The MediaPipe Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** Returns whether the underlying rendering engine is WebKit. */
export function isWebKit(browser = navigator) {
const userAgent = browser.userAgent;
// Note that this returns true for Chrome on iOS (which is running WebKit) as
// it uses "CriOS".
return userAgent.includes('Safari') && !userAgent.includes('Chrome');
}