cassdlcm/mediapipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add running mode to all vision tasks

Browse Source 
PiperOrigin-RevId: 488816785
This commit is contained in:
Sebastian Schmidt 2022-11-15 18:59:06 -08:00 committed by Copybara-Service
parent febfc2029b
commit f7aef677fc
18 changed files with 281 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
mediapipe/tasks/web/vision/core/BUILD
View File

@ -1,11 +1,26 @@
# This package contains options shared by all MediaPipe Tasks for Web.
load("//mediapipe/framework/port:build_config.bzl", "mediapipe_ts_library")
load("//mediapipe/framework/port:build_config.bzl", "mediapipe_ts_declaration", "mediapipe_ts_library")
package(default_visibility = ["//mediapipe/tasks:internal"])
mediapipe_ts_library(
name = "running_mode",
srcs = ["running_mode.ts"],
deps = ["//mediapipe/tasks/cc/core/proto:base_options_jspb_proto"],
mediapipe_ts_declaration(
name = "vision_task_options",
srcs = ["vision_task_options.d.ts"],
deps = [
"//mediapipe/tasks/web/core",
],
)
mediapipe_ts_library(
name = "vision_task_runner",
srcs = ["vision_task_runner.ts"],
deps = [
":vision_task_options",
"//mediapipe/tasks/cc/core/proto:base_options_jspb_proto",
"//mediapipe/tasks/web/components/processors:base_options",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:task_runner",
"//mediapipe/web/graph_runner:wasm_mediapipe_lib_ts",
],
)

27
mediapipe/tasks/web/vision/core/running_mode.ts → mediapipe/tasks/web/vision/core/vision_task_options.d.ts vendored
View File

@ -14,23 +14,26 @@
* limitations under the License.
*/
import {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {BaseOptions} from '../../../../tasks/web/core/base_options';
/**
* The running mode of a task.
* The two running modes of a video task.
* 1) The image mode for processing single image inputs.
* 2) The video mode for processing decoded frames of a video.
*/
export type RunningMode = 'image'|'video';
/** Configues the `useStreamMode` option . */
export function configureRunningMode(
options: {runningMode?: RunningMode},
proto?: BaseOptionsProto): BaseOptionsProto {
proto = proto ?? new BaseOptionsProto();
if ('runningMode' in options) {
const useStreamMode = options.runningMode === 'video';
proto.setUseStreamMode(useStreamMode);
}
return proto;
/** The options for configuring a MediaPipe vision task. */
export declare interface VisionTaskOptions {
/** Options to configure the loading of the model assets. */
baseOptions?: BaseOptions;
/**
* The running mode of the task. Default to the image mode.
* Vision tasks have two running modes:
* 1) The image mode for processing single image inputs.
* 2) The video mode for processing decoded frames of a video.
*/
runningMode?: RunningMode;
}

66
mediapipe/tasks/web/vision/core/vision_task_runner.ts Normal file
View File

@ -0,0 +1,66 @@
/**
* 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 {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {convertBaseOptionsToProto} from '../../../../tasks/web/components/processors/base_options';
import {TaskRunner} from '../../../../tasks/web/core/task_runner';
import {ImageSource} from '../../../../web/graph_runner/wasm_mediapipe_lib';
import {VisionTaskOptions} from './vision_task_options';
/** Base class for all MediaPipe Vision Tasks. */
export abstract class VisionTaskRunner<T> extends TaskRunner {
protected abstract baseOptions?: BaseOptionsProto|undefined;
/** Configures the shared options of a vision task. */
async setOptions(options: VisionTaskOptions): Promise<void> {
this.baseOptions = this.baseOptions ?? new BaseOptionsProto();
if (options.baseOptions) {
this.baseOptions = await convertBaseOptionsToProto(
options.baseOptions, this.baseOptions);
}
if ('runningMode' in options) {
const useStreamMode =
!!options.runningMode && options.runningMode !== 'image';
this.baseOptions.setUseStreamMode(useStreamMode);
}
}
/** Sends an image packet to the graph and awaits results. */
protected abstract process(input: ImageSource, timestamp: number): T;
/** Sends a single image to the graph and awaits results. */
protected processImageData(image: ImageSource): T {
if (!!this.baseOptions?.getUseStreamMode()) {
throw new Error(
'Task is not initialized with image mode. ' +
'\'runningMode\' must be set to \'image\'.');
}
return this.process(image, performance.now());
}
/** Sends a single video frame to the graph and awaits results. */
protected processVideoData(imageFrame: ImageSource, timestamp: number): T {
if (!this.baseOptions?.getUseStreamMode()) {
throw new Error(
'Task is not initialized with video mode. ' +
'\'runningMode\' must be set to \'video\'.');
}
return this.process(imageFrame, timestamp);
}
}

5
mediapipe/tasks/web/vision/gesture_recognizer/BUILD
View File

@ -19,6 +19,7 @@ mediapipe_ts_library(
"//mediapipe/framework/formats:classification_jspb_proto",
"//mediapipe/framework/formats:landmark_jspb_proto",
"//mediapipe/framework/formats:rect_jspb_proto",
"//mediapipe/tasks/cc/core/proto:base_options_jspb_proto",
"//mediapipe/tasks/cc/vision/gesture_recognizer/proto:gesture_classifier_graph_options_jspb_proto",
"//mediapipe/tasks/cc/vision/gesture_recognizer/proto:gesture_recognizer_graph_options_jspb_proto",
"//mediapipe/tasks/cc/vision/gesture_recognizer/proto:hand_gesture_recognizer_graph_options_jspb_proto",
@ -27,11 +28,10 @@ mediapipe_ts_library(
"//mediapipe/tasks/cc/vision/hand_landmarker/proto:hand_landmarks_detector_graph_options_jspb_proto",
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/components/containers:landmark",
"//mediapipe/tasks/web/components/processors:base_options",
"//mediapipe/tasks/web/components/processors:classifier_options",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:classifier_options",
"//mediapipe/tasks/web/core:task_runner",
"//mediapipe/tasks/web/vision/core:vision_task_runner",
"//mediapipe/web/graph_runner:wasm_mediapipe_lib_ts",
],
)
@ -47,5 +47,6 @@ mediapipe_ts_declaration(
"//mediapipe/tasks/web/components/containers:landmark",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:classifier_options",
"//mediapipe/tasks/web/vision/core:vision_task_options",
],
)

48
mediapipe/tasks/web/vision/gesture_recognizer/gesture_recognizer.ts
View File

@ -19,6 +19,7 @@ import {CalculatorOptions} from '../../../../framework/calculator_options_pb';
import {ClassificationList} from '../../../../framework/formats/classification_pb';
import {LandmarkList, NormalizedLandmarkList} from '../../../../framework/formats/landmark_pb';
import {NormalizedRect} from '../../../../framework/formats/rect_pb';
import {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {GestureClassifierGraphOptions} from '../../../../tasks/cc/vision/gesture_recognizer/proto/gesture_classifier_graph_options_pb';
import {GestureRecognizerGraphOptions} from '../../../../tasks/cc/vision/gesture_recognizer/proto/gesture_recognizer_graph_options_pb';
import {HandGestureRecognizerGraphOptions} from '../../../../tasks/cc/vision/gesture_recognizer/proto/hand_gesture_recognizer_graph_options_pb';
@ -27,10 +28,9 @@ import {HandLandmarkerGraphOptions} from '../../../../tasks/cc/vision/hand_landm
import {HandLandmarksDetectorGraphOptions} from '../../../../tasks/cc/vision/hand_landmarker/proto/hand_landmarks_detector_graph_options_pb';
import {Category} from '../../../../tasks/web/components/containers/category';
import {Landmark} from '../../../../tasks/web/components/containers/landmark';
import {convertBaseOptionsToProto} from '../../../../tasks/web/components/processors/base_options';
import {convertClassifierOptionsToProto} from '../../../../tasks/web/components/processors/classifier_options';
import {TaskRunner} from '../../../../tasks/web/core/task_runner';
import {WasmLoaderOptions} from '../../../../tasks/web/core/wasm_loader_options';
import {VisionTaskRunner} from '../../../../tasks/web/vision/core/vision_task_runner';
import {createMediaPipeLib, FileLocator, ImageSource, WasmModule} from '../../../../web/graph_runner/wasm_mediapipe_lib';
// Placeholder for internal dependency on trusted resource url
@ -64,7 +64,8 @@ FULL_IMAGE_RECT.setWidth(1);
FULL_IMAGE_RECT.setHeight(1);
/** Performs hand gesture recognition on images. */
export class GestureRecognizer extends TaskRunner {
export class GestureRecognizer extends
VisionTaskRunner<GestureRecognizerResult> {
private gestures: Category[][] = [];
private landmarks: Landmark[][] = [];
private worldLandmarks: Landmark[][] = [];
@ -156,10 +157,14 @@ export class GestureRecognizer extends TaskRunner {
this.handGestureRecognizerGraphOptions);
this.initDefaults();
}
// Disables the automatic render-to-screen code, which allows for pure
// CPU processing.
this.setAutoRenderToScreen(false);
protected override get baseOptions(): BaseOptionsProto|undefined {
return this.options.getBaseOptions();
}
protected override set baseOptions(proto: BaseOptionsProto|undefined) {
this.options.setBaseOptions(proto);
}
/**
@ -171,12 +176,8 @@ export class GestureRecognizer extends TaskRunner {
*
* @param options The options for the gesture recognizer.
*/
async setOptions(options: GestureRecognizerOptions): Promise<void> {
if (options.baseOptions) {
const baseOptionsProto = await convertBaseOptionsToProto(
options.baseOptions, this.options.getBaseOptions());
this.options.setBaseOptions(baseOptionsProto);
}
override async setOptions(options: GestureRecognizerOptions): Promise<void> {
await super.setOptions(options);
if ('numHands' in options) {
this.handDetectorGraphOptions.setNumHands(
@ -233,12 +234,27 @@ export class GestureRecognizer extends TaskRunner {
/**
* Performs gesture recognition on the provided single image and waits
* synchronously for the response.
* @param imageSource An image source to process.
* @param timestamp The timestamp of the current frame, in ms. If not
* provided, defaults to `performance.now()`.
* @param image A single image to process.
* @return The detected gestures.
*/
recognize(imageSource: ImageSource, timestamp: number = performance.now()):
recognize(image: ImageSource): GestureRecognizerResult {
return this.processImageData(image);
}
/**
* Performs gesture recognition on the provided video frame and waits
* synchronously for the response.
* @param videoFrame A video frame to process.
* @param timestamp The timestamp of the current frame, in ms.
* @return The detected gestures.
*/
recognizeForVideo(videoFrame: ImageSource, timestamp: number):
GestureRecognizerResult {
return this.processVideoData(videoFrame, timestamp);
}
/** Runs the gesture recognition and blocks on the response. */
protected override process(imageSource: ImageSource, timestamp: number):
GestureRecognizerResult {
this.gestures = [];
this.landmarks = [];

7
mediapipe/tasks/web/vision/gesture_recognizer/gesture_recognizer_options.d.ts vendored
View File

@ -14,14 +14,11 @@
* limitations under the License.
*/
import {BaseOptions} from '../../../../tasks/web/core/base_options';
import {ClassifierOptions} from '../../../../tasks/web/core/classifier_options';
import {VisionTaskOptions} from '../../../../tasks/web/vision/core/vision_task_options';
/** Options to configure the MediaPipe Gesture Recognizer Task */
export declare interface GestureRecognizerOptions {
/** Options to configure the loading of the model assets. */
baseOptions?: BaseOptions;
export declare interface GestureRecognizerOptions extends VisionTaskOptions {
/**
* The maximum number of hands can be detected by the GestureRecognizer.
* Defaults to 1.

5
mediapipe/tasks/web/vision/hand_landmarker/BUILD
View File

@ -19,14 +19,14 @@ mediapipe_ts_library(
"//mediapipe/framework/formats:classification_jspb_proto",
"//mediapipe/framework/formats:landmark_jspb_proto",
"//mediapipe/framework/formats:rect_jspb_proto",
"//mediapipe/tasks/cc/core/proto:base_options_jspb_proto",
"//mediapipe/tasks/cc/vision/hand_detector/proto:hand_detector_graph_options_jspb_proto",
"//mediapipe/tasks/cc/vision/hand_landmarker/proto:hand_landmarker_graph_options_jspb_proto",
"//mediapipe/tasks/cc/vision/hand_landmarker/proto:hand_landmarks_detector_graph_options_jspb_proto",
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/components/containers:landmark",
"//mediapipe/tasks/web/components/processors:base_options",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:task_runner",
"//mediapipe/tasks/web/vision/core:vision_task_runner",
"//mediapipe/web/graph_runner:wasm_mediapipe_lib_ts",
],
)
@ -41,5 +41,6 @@ mediapipe_ts_declaration(
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/components/containers:landmark",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/vision/core:vision_task_options",
],
)

47
mediapipe/tasks/web/vision/hand_landmarker/hand_landmarker.ts
View File

@ -19,14 +19,14 @@ import {CalculatorOptions} from '../../../../framework/calculator_options_pb';
import {ClassificationList} from '../../../../framework/formats/classification_pb';
import {LandmarkList, NormalizedLandmarkList} from '../../../../framework/formats/landmark_pb';
import {NormalizedRect} from '../../../../framework/formats/rect_pb';
import {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {HandDetectorGraphOptions} from '../../../../tasks/cc/vision/hand_detector/proto/hand_detector_graph_options_pb';
import {HandLandmarkerGraphOptions} from '../../../../tasks/cc/vision/hand_landmarker/proto/hand_landmarker_graph_options_pb';
import {HandLandmarksDetectorGraphOptions} from '../../../../tasks/cc/vision/hand_landmarker/proto/hand_landmarks_detector_graph_options_pb';
import {Category} from '../../../../tasks/web/components/containers/category';
import {Landmark} from '../../../../tasks/web/components/containers/landmark';
import {convertBaseOptionsToProto} from '../../../../tasks/web/components/processors/base_options';
import {TaskRunner} from '../../../../tasks/web/core/task_runner';
import {WasmLoaderOptions} from '../../../../tasks/web/core/wasm_loader_options';
import {VisionTaskRunner} from '../../../../tasks/web/vision/core/vision_task_runner';
import {createMediaPipeLib, FileLocator, ImageSource, WasmModule} from '../../../../web/graph_runner/wasm_mediapipe_lib';
// Placeholder for internal dependency on trusted resource url
@ -58,7 +58,7 @@ FULL_IMAGE_RECT.setWidth(1);
FULL_IMAGE_RECT.setHeight(1);
/** Performs hand landmarks detection on images. */
export class HandLandmarker extends TaskRunner {
export class HandLandmarker extends VisionTaskRunner<HandLandmarkerResult> {
private landmarks: Landmark[][] = [];
private worldLandmarks: Landmark[][] = [];
private handednesses: Category[][] = [];
@ -138,10 +138,14 @@ export class HandLandmarker extends TaskRunner {
this.options.setHandDetectorGraphOptions(this.handDetectorGraphOptions);
this.initDefaults();
}
// Disables the automatic render-to-screen code, which allows for pure
// CPU processing.
this.setAutoRenderToScreen(false);
protected override get baseOptions(): BaseOptionsProto|undefined {
return this.options.getBaseOptions();
}
protected override set baseOptions(proto: BaseOptionsProto|undefined) {
this.options.setBaseOptions(proto);
}
/**
@ -153,12 +157,8 @@ export class HandLandmarker extends TaskRunner {
*
* @param options The options for the hand landmarker.
*/
async setOptions(options: HandLandmarkerOptions): Promise<void> {
if (options.baseOptions) {
const baseOptionsProto = await convertBaseOptionsToProto(
options.baseOptions, this.options.getBaseOptions());
this.options.setBaseOptions(baseOptionsProto);
}
override async setOptions(options: HandLandmarkerOptions): Promise<void> {
await super.setOptions(options);
// Configure hand detector options.
if ('numHands' in options) {
@ -186,12 +186,27 @@ export class HandLandmarker extends TaskRunner {
/**
* Performs hand landmarks detection on the provided single image and waits
* synchronously for the response.
* @param imageSource An image source to process.
* @param timestamp The timestamp of the current frame, in ms. If not
* provided, defaults to `performance.now()`.
* @param image An image to process.
* @return The detected hand landmarks.
*/
detect(imageSource: ImageSource, timestamp: number = performance.now()):
detect(image: ImageSource): HandLandmarkerResult {
return this.processImageData(image);
}
/**
* Performs hand landmarks detection on the provided video frame and waits
* synchronously for the response.
* @param videoFrame A video frame to process.
* @param timestamp The timestamp of the current frame, in ms.
* @return The detected hand landmarks.
*/
detectForVideo(videoFrame: ImageSource, timestamp: number):
HandLandmarkerResult {
return this.processVideoData(videoFrame, timestamp);
}
/** Runs the hand landmarker graph and blocks on the response. */
protected override process(imageSource: ImageSource, timestamp: number):
HandLandmarkerResult {
this.landmarks = [];
this.worldLandmarks = [];

7
mediapipe/tasks/web/vision/hand_landmarker/hand_landmarker_options.d.ts vendored
View File

@ -14,13 +14,10 @@
* limitations under the License.
*/
import {BaseOptions} from '../../../../tasks/web/core/base_options';
import {VisionTaskOptions} from '../../../../tasks/web/vision/core/vision_task_options';
/** Options to configure the MediaPipe HandLandmarker Task */
export declare interface HandLandmarkerOptions {
/** Options to configure the loading of the model assets. */
baseOptions?: BaseOptions;
export declare interface HandLandmarkerOptions extends VisionTaskOptions {
/**
* The maximum number of hands can be detected by the HandLandmarker.
* Defaults to 1.

5
mediapipe/tasks/web/vision/image_classifier/BUILD
View File

@ -16,15 +16,15 @@ mediapipe_ts_library(
"//mediapipe/framework:calculator_jspb_proto",
"//mediapipe/framework:calculator_options_jspb_proto",
"//mediapipe/tasks/cc/components/containers/proto:classifications_jspb_proto",
"//mediapipe/tasks/cc/core/proto:base_options_jspb_proto",
"//mediapipe/tasks/cc/vision/image_classifier/proto:image_classifier_graph_options_jspb_proto",
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/components/containers:classification_result",
"//mediapipe/tasks/web/components/processors:base_options",
"//mediapipe/tasks/web/components/processors:classifier_options",
"//mediapipe/tasks/web/components/processors:classifier_result",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:classifier_options",
"//mediapipe/tasks/web/core:task_runner",
"//mediapipe/tasks/web/vision/core:vision_task_runner",
"//mediapipe/web/graph_runner:wasm_mediapipe_lib_ts",
],
)
@ -39,5 +39,6 @@ mediapipe_ts_declaration(
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/components/containers:classification_result",
"//mediapipe/tasks/web/core:classifier_options",
"//mediapipe/tasks/web/vision/core:vision_task_options",
],
)

51
mediapipe/tasks/web/vision/image_classifier/image_classifier.ts
View File

@ -17,12 +17,12 @@
import {CalculatorGraphConfig} from '../../../../framework/calculator_pb';
import {CalculatorOptions} from '../../../../framework/calculator_options_pb';
import {ClassificationResult} from '../../../../tasks/cc/components/containers/proto/classifications_pb';
import {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {ImageClassifierGraphOptions} from '../../../../tasks/cc/vision/image_classifier/proto/image_classifier_graph_options_pb';
import {convertBaseOptionsToProto} from '../../../../tasks/web/components/processors/base_options';
import {convertClassifierOptionsToProto} from '../../../../tasks/web/components/processors/classifier_options';
import {convertFromClassificationResultProto} from '../../../../tasks/web/components/processors/classifier_result';
import {TaskRunner} from '../../../../tasks/web/core/task_runner';
import {WasmLoaderOptions} from '../../../../tasks/web/core/wasm_loader_options';
import {VisionTaskRunner} from '../../../../tasks/web/vision/core/vision_task_runner';
import {createMediaPipeLib, FileLocator, ImageSource} from '../../../../web/graph_runner/wasm_mediapipe_lib';
// Placeholder for internal dependency on trusted resource url
@ -42,7 +42,7 @@ export {ImageSource}; // Used in the public API
// tslint:disable:jspb-use-builder-pattern
/** Performs classification on images. */
export class ImageClassifier extends TaskRunner {
export class ImageClassifier extends VisionTaskRunner<ImageClassifierResult> {
private classificationResult: ImageClassifierResult = {classifications: []};
private readonly options = new ImageClassifierGraphOptions();
@ -105,6 +105,14 @@ export class ImageClassifier extends TaskRunner {
wasmLoaderOptions, new Uint8Array(graphData));
}
protected override get baseOptions(): BaseOptionsProto|undefined {
return this.options.getBaseOptions();
}
protected override set baseOptions(proto: BaseOptionsProto|undefined) {
this.options.setBaseOptions(proto);
}
/**
* Sets new options for the image classifier.
*
@ -114,28 +122,39 @@ export class ImageClassifier extends TaskRunner {
*
* @param options The options for the image classifier.
*/
async setOptions(options: ImageClassifierOptions): Promise<void> {
if (options.baseOptions) {
const baseOptionsProto = await convertBaseOptionsToProto(
options.baseOptions, this.options.getBaseOptions());
this.options.setBaseOptions(baseOptionsProto);
}
override async setOptions(options: ImageClassifierOptions): Promise<void> {
await super.setOptions(options);
this.options.setClassifierOptions(convertClassifierOptionsToProto(
options, this.options.getClassifierOptions()));
this.refreshGraph();
}
/**
* Performs image classification on the provided image and waits synchronously
* for the response.
* Performs image classification on the provided single image and waits
* synchronously for the response.
*
* @param imageSource An image source to process.
* @param timestamp The timestamp of the current frame, in ms. If not
* provided, defaults to `performance.now()`.
* @param image An image to process.
* @return The classification result of the image
*/
classify(imageSource: ImageSource, timestamp?: number):
classify(image: ImageSource): ImageClassifierResult {
return this.processImageData(image);
}
/**
* Performs image classification on the provided video frame and waits
* synchronously for the response.
*
* @param videoFrame A video frame to process.
* @param timestamp The timestamp of the current frame, in ms.
* @return The classification result of the image
*/
classifyForVideo(videoFrame: ImageSource, timestamp: number):
ImageClassifierResult {
return this.processVideoData(videoFrame, timestamp);
}
/** Runs the image classification graph and blocks on the response. */
protected override process(imageSource: ImageSource, timestamp: number):
ImageClassifierResult {
// Get classification result by running our MediaPipe graph.
this.classificationResult = {classifications: []};

7
mediapipe/tasks/web/vision/image_classifier/image_classifier_options.d.ts vendored
View File

@ -14,4 +14,9 @@
* limitations under the License.
*/
export {ClassifierOptions as ImageClassifierOptions} from '../../../../tasks/web/core/classifier_options';
import {ClassifierOptions} from '../../../../tasks/web/core/classifier_options';
import {VisionTaskOptions} from '../../../../tasks/web/vision/core/vision_task_options';
/** Ooptions to configure the image classifier task. */
export declare interface ImageClassifierOptions extends ClassifierOptions,
VisionTaskOptions {}

8
mediapipe/tasks/web/vision/image_embedder/BUILD
View File

@ -16,15 +16,15 @@ mediapipe_ts_library(
"//mediapipe/framework:calculator_jspb_proto",
"//mediapipe/framework:calculator_options_jspb_proto",
"//mediapipe/tasks/cc/components/containers/proto:embeddings_jspb_proto",
"//mediapipe/tasks/cc/core/proto:base_options_jspb_proto",
"//mediapipe/tasks/cc/vision/image_embedder/proto:image_embedder_graph_options_jspb_proto",
"//mediapipe/tasks/web/components/containers:embedding_result",
"//mediapipe/tasks/web/components/processors:base_options",
"//mediapipe/tasks/web/components/processors:embedder_options",
"//mediapipe/tasks/web/components/processors:embedder_result",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:embedder_options",
"//mediapipe/tasks/web/core:task_runner",
"//mediapipe/tasks/web/vision/core:running_mode",
"//mediapipe/tasks/web/vision/core:vision_task_options",
"//mediapipe/tasks/web/vision/core:vision_task_runner",
"//mediapipe/web/graph_runner:wasm_mediapipe_lib_ts",
],
)
@ -39,6 +39,6 @@ mediapipe_ts_declaration(
"//mediapipe/tasks/web/components/containers:embedding_result",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:embedder_options",
"//mediapipe/tasks/web/vision/core:running_mode",
"//mediapipe/tasks/web/vision/core:vision_task_options",
],
)

49
mediapipe/tasks/web/vision/image_embedder/image_embedder.ts
View File

@ -17,13 +17,12 @@
import {CalculatorGraphConfig} from '../../../../framework/calculator_pb';
import {CalculatorOptions} from '../../../../framework/calculator_options_pb';
import {EmbeddingResult} from '../../../../tasks/cc/components/containers/proto/embeddings_pb';
import {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {ImageEmbedderGraphOptions} from '../../../../tasks/cc/vision/image_embedder/proto/image_embedder_graph_options_pb';
import {convertBaseOptionsToProto} from '../../../../tasks/web/components/processors/base_options';
import {convertEmbedderOptionsToProto} from '../../../../tasks/web/components/processors/embedder_options';
import {convertFromEmbeddingResultProto} from '../../../../tasks/web/components/processors/embedder_result';
import {TaskRunner} from '../../../../tasks/web/core/task_runner';
import {WasmLoaderOptions} from '../../../../tasks/web/core/wasm_loader_options';
import {configureRunningMode} from '../../../../tasks/web/vision/core/running_mode';
import {VisionTaskRunner} from '../../../../tasks/web/vision/core/vision_task_runner';
import {createMediaPipeLib, FileLocator, ImageSource} from '../../../../web/graph_runner/wasm_mediapipe_lib';
// Placeholder for internal dependency on trusted resource url
@ -43,7 +42,7 @@ export * from './image_embedder_result';
export {ImageSource}; // Used in the public API
/** Performs embedding extraction on images. */
export class ImageEmbedder extends TaskRunner {
export class ImageEmbedder extends VisionTaskRunner<ImageEmbedderResult> {
private readonly options = new ImageEmbedderGraphOptions();
private embeddings: ImageEmbedderResult = {embeddings: []};
@ -105,6 +104,14 @@ export class ImageEmbedder extends TaskRunner {
wasmLoaderOptions, new Uint8Array(graphData));
}
protected override get baseOptions(): BaseOptionsProto|undefined {
return this.options.getBaseOptions();
}
protected override set baseOptions(proto: BaseOptionsProto|undefined) {
this.options.setBaseOptions(proto);
}
/**
* Sets new options for the image embedder.
*
@ -114,24 +121,16 @@ export class ImageEmbedder extends TaskRunner {
*
* @param options The options for the image embedder.
*/
async setOptions(options: ImageEmbedderOptions): Promise<void> {
let baseOptionsProto = this.options.getBaseOptions();
if (options.baseOptions) {
baseOptionsProto = await convertBaseOptionsToProto(
options.baseOptions, baseOptionsProto);
}
baseOptionsProto = configureRunningMode(options, baseOptionsProto);
this.options.setBaseOptions(baseOptionsProto);
override async setOptions(options: ImageEmbedderOptions): Promise<void> {
await super.setOptions(options);
this.options.setEmbedderOptions(convertEmbedderOptionsToProto(
options, this.options.getEmbedderOptions()));
this.refreshGraph();
}
/**
* Performs embedding extraction on the provided image and waits synchronously
* for the response.
* Performs embedding extraction on the provided single image and waits
* synchronously for the response.
*
* Only use this method when the `useStreamMode` option is not set or
* expliclity set to `false`.
@ -140,12 +139,7 @@ export class ImageEmbedder extends TaskRunner {
* @return The classification result of the image
*/
embed(image: ImageSource): ImageEmbedderResult {
if (!!this.options.getBaseOptions()?.getUseStreamMode()) {
throw new Error(
'Task is not initialized with image mode. ' +
'\'runningMode\' must be set to \'image\'.');
}
return this.performEmbeddingExtraction(image, performance.now());
return this.processImageData(image);
}
/**
@ -160,16 +154,11 @@ export class ImageEmbedder extends TaskRunner {
*/
embedForVideo(imageFrame: ImageSource, timestamp: number):
ImageEmbedderResult {
if (!this.options.getBaseOptions()?.getUseStreamMode()) {
throw new Error(
'Task is not initialized with video mode. ' +
'\'runningMode\' must be set to \'video\' or \'live_stream\'.');
}
return this.performEmbeddingExtraction(imageFrame, timestamp);
return this.processVideoData(imageFrame, timestamp);
}
/** Runs the embedding extractio and blocks on the response. */
private performEmbeddingExtraction(image: ImageSource, timestamp: number):
/** Runs the embedding extraction and blocks on the response. */
protected process(image: ImageSource, timestamp: number):
ImageEmbedderResult {
// Get embeddings by running our MediaPipe graph.
this.addGpuBufferAsImageToStream(

15
mediapipe/tasks/web/vision/image_embedder/image_embedder_options.d.ts vendored
View File

@ -15,17 +15,8 @@
*/
import {EmbedderOptions} from '../../../../tasks/web/core/embedder_options';
import {RunningMode} from '../../../../tasks/web/vision/core/running_mode';
import {VisionTaskOptions} from '../../../../tasks/web/vision/core/vision_task_options';
/** The options for configuring a MediaPipe image embedder task. */
export declare interface ImageEmbedderOptions extends EmbedderOptions {
/**
* The running mode of the task. Default to the image mode.
* Image embedder has three running modes:
* 1) The image mode for embedding image on single image inputs.
* 2) The video mode for embedding image on the decoded frames of a video.
* 3) The live stream mode for embedding image on the live stream of input
* data, such as from camera.
*/
runningMode?: RunningMode;
}
export declare interface ImageEmbedderOptions extends EmbedderOptions,
VisionTaskOptions {}

5
mediapipe/tasks/web/vision/object_detector/BUILD
View File

@ -17,11 +17,11 @@ mediapipe_ts_library(
"//mediapipe/framework:calculator_jspb_proto",
"//mediapipe/framework:calculator_options_jspb_proto",
"//mediapipe/framework/formats:detection_jspb_proto",
"//mediapipe/tasks/cc/core/proto:base_options_jspb_proto",
"//mediapipe/tasks/cc/vision/object_detector/proto:object_detector_options_jspb_proto",
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/components/processors:base_options",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/core:task_runner",
"//mediapipe/tasks/web/vision/core:vision_task_runner",
"//mediapipe/web/graph_runner:wasm_mediapipe_lib_ts",
],
)
@ -35,5 +35,6 @@ mediapipe_ts_declaration(
deps = [
"//mediapipe/tasks/web/components/containers:category",
"//mediapipe/tasks/web/core",
"//mediapipe/tasks/web/vision/core:vision_task_options",
],
)

45
mediapipe/tasks/web/vision/object_detector/object_detector.ts
View File

@ -17,10 +17,10 @@
import {CalculatorGraphConfig} from '../../../../framework/calculator_pb';
import {CalculatorOptions} from '../../../../framework/calculator_options_pb';
import {Detection as DetectionProto} from '../../../../framework/formats/detection_pb';
import {BaseOptions as BaseOptionsProto} from '../../../../tasks/cc/core/proto/base_options_pb';
import {ObjectDetectorOptions as ObjectDetectorOptionsProto} from '../../../../tasks/cc/vision/object_detector/proto/object_detector_options_pb';
import {convertBaseOptionsToProto} from '../../../../tasks/web/components/processors/base_options';
import {TaskRunner} from '../../../../tasks/web/core/task_runner';
import {WasmLoaderOptions} from '../../../../tasks/web/core/wasm_loader_options';
import {VisionTaskRunner} from '../../../../tasks/web/vision/core/vision_task_runner';
import {createMediaPipeLib, FileLocator, ImageSource} from '../../../../web/graph_runner/wasm_mediapipe_lib';
// Placeholder for internal dependency on trusted resource url
@ -41,7 +41,7 @@ export {ImageSource}; // Used in the public API
// tslint:disable:jspb-use-builder-pattern
/** Performs object detection on images. */
export class ObjectDetector extends TaskRunner {
export class ObjectDetector extends VisionTaskRunner<Detection[]> {
private detections: Detection[] = [];
private readonly options = new ObjectDetectorOptionsProto();
@ -103,6 +103,14 @@ export class ObjectDetector extends TaskRunner {
wasmLoaderOptions, new Uint8Array(graphData));
}
protected override get baseOptions(): BaseOptionsProto|undefined {
return this.options.getBaseOptions();
}
protected override set baseOptions(proto: BaseOptionsProto|undefined) {
this.options.setBaseOptions(proto);
}
/**
* Sets new options for the object detector.
*
@ -112,12 +120,8 @@ export class ObjectDetector extends TaskRunner {
*
* @param options The options for the object detector.
*/
async setOptions(options: ObjectDetectorOptions): Promise<void> {
if (options.baseOptions) {
const baseOptionsProto = await convertBaseOptionsToProto(
options.baseOptions, this.options.getBaseOptions());
this.options.setBaseOptions(baseOptionsProto);
}
override async setOptions(options: ObjectDetectorOptions): Promise<void> {
await super.setOptions(options);
// Note that we have to support both JSPB and ProtobufJS, hence we
// have to expliclity clear the values instead of setting them to
@ -158,12 +162,27 @@ export class ObjectDetector extends TaskRunner {
/**
* Performs object detection on the provided single image and waits
* synchronously for the response.
* @param imageSource An image source to process.
* @param timestamp The timestamp of the current frame, in ms. If not
* provided, defaults to `performance.now()`.
* @param image An image to process.
* @return The list of detected objects
*/
detect(imageSource: ImageSource, timestamp?: number): Detection[] {
detect(image: ImageSource): Detection[] {
return this.processImageData(image);
}
/**
* Performs object detection on the provided vidoe frame and waits
* synchronously for the response.
* @param videoFrame A video frame to process.
* @param timestamp The timestamp of the current frame, in ms.
* @return The list of detected objects
*/
detectForVideo(videoFrame: ImageSource, timestamp: number): Detection[] {
return this.processVideoData(videoFrame, timestamp);
}
/** Runs the object detector graph and blocks on the response. */
protected override process(imageSource: ImageSource, timestamp: number):
Detection[] {
// Get detections by running our MediaPipe graph.
this.detections = [];
this.addGpuBufferAsImageToStream(

7
mediapipe/tasks/web/vision/object_detector/object_detector_options.d.ts vendored
View File

@ -14,13 +14,10 @@
* limitations under the License.
*/
import {BaseOptions} from '../../../../tasks/web/core/base_options';
import {VisionTaskOptions} from '../../../../tasks/web/vision/core/vision_task_options';
/** Options to configure the MediaPipe Object Detector Task */
export interface ObjectDetectorOptions {
/** Options to configure the loading of the model assets. */
baseOptions?: BaseOptions;
export interface ObjectDetectorOptions extends VisionTaskOptions {
/**
* The locale to use for display names specified through the TFLite Model
* Metadata, if any. Defaults to English.