@mediapipe/tasks-vision 0.1.0-alpha-9 → 0.1.0-alpha-10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediapipe/tasks-vision",
-  "version": "0.1.0-alpha-9",
+  "version": "0.1.0-alpha-10",
   "description": "MediaPipe Vision Tasks",
   "main": "vision_bundle.js",
   "author": "mediapipe@google.com",

package/vision.d.ts

@@ -56,6 +56,12 @@ export declare interface BoundingBox {
     height: number;
 }
 
+/**
+ * A user-defined callback to take input data and map it to a custom output
+ * value.
+ */
+export declare type Callback<I, O> = (input: I) => O;
+
 /**
  * Copyright 2022 The MediaPipe Authors. All Rights Reserved.
  *
@@ -153,23 +159,8 @@ declare interface ClassifierOptions {
     categoryDenylist?: string[] | undefined;
 }
 
-/**
- * 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.
- */
-/** A face landmark connection. */
-export declare interface Connection {
+/** A connection between two landmarks. */
+declare interface Connection {
     start: number;
     end: number;
 }
@@ -198,6 +189,77 @@ declare interface DetectionResult {
 export { DetectionResult as FaceDetectorResult }
 export { DetectionResult as ObjectDetectorResult }
 
+/**
+ * Options for customizing the drawing routines
+ */
+export declare interface DrawingOptions {
+    /** The color that is used to draw the shape. Defaults to white. */
+    color?: string | CanvasGradient | CanvasPattern | Callback<LandmarkData, string | CanvasGradient | CanvasPattern>;
+    /**
+     * The color that is used to fill the shape. Defaults to `.color` (or black
+     * if color is not set).
+     */
+    fillColor?: string | CanvasGradient | CanvasPattern | Callback<LandmarkData, string | CanvasGradient | CanvasPattern>;
+    /** The width of the line boundary of the shape. Defaults to 4. */
+    lineWidth?: number | Callback<LandmarkData, number>;
+    /** The radius of location marker. Defaults to 6. */
+    radius?: number | Callback<LandmarkData, number>;
+}
+
+/** Helper class to visualize the result of a MediaPipe Vision task. */
+export declare class DrawingUtils {
+    /**
+     * Creates a new DrawingUtils class.
+     *
+     * @param ctx The canvas to render onto.
+     */
+    constructor(ctx: CanvasRenderingContext2D);
+    /**
+     * Restricts a number between two endpoints (order doesn't matter).
+     *
+     * @param x The number to clamp.
+     * @param x0 The first boundary.
+     * @param x1 The second boundary.
+     * @return The clamped value.
+     */
+    static clamp(x: number, x0: number, x1: number): number;
+    /**
+     * Linearly interpolates a value between two points, clamping that value to
+     * the endpoints.
+     *
+     * @param x The number to interpolate.
+     * @param x0 The x coordinate of the start value.
+     * @param x1 The x coordinate of the end value.
+     * @param y0 The y coordinate of the start value.
+     * @param y1 The y coordinate of the end value.
+     * @return The interpolated value.
+     */
+    static lerp(x: number, x0: number, x1: number, y0: number, y1: number): number;
+    /**
+     * Draws circles onto the provided landmarks.
+     *
+     * @param landmarks The landmarks to draw.
+     * @param style The style to visualize the landmarks.
+     */
+    drawLandmarks(landmarks?: NormalizedLandmark[], style?: DrawingOptions): void;
+    /**
+     * Draws lines between landmarks (given a connection graph).
+     *
+     * @param landmarks The landmarks to draw.
+     * @param connections The connections array that contains the start and the
+     *     end indices for the connections to draw.
+     * @param style The style to visualize the landmarks.
+     */
+    drawConnectors(landmarks?: NormalizedLandmark[], connections?: Connection[], style?: DrawingOptions): void;
+    /**
+     * Draws a bounding box.
+     *
+     * @param boundingBox The bounding box to draw.
+     * @param style The style to visualize the boundin box.
+     */
+    drawBoundingBox(boundingBox: BoundingBox, style?: DrawingOptions): void;
+}
+
 /**
  * Copyright 2022 The MediaPipe Authors. All Rights Reserved.
  *
@@ -475,46 +537,16 @@ export declare interface FaceLandmarkerResult {
  * connections.
  */
 export declare class FaceLandmarksConnections {
-    static FACE_LANDMARKS_LIPS: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_LEFT_EYE: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_LEFT_EYEBROW: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_LEFT_IRIS: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_RIGHT_EYE: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_RIGHT_EYEBROW: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_RIGHT_IRIS: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_FACE_OVAL: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_CONTOURS: {
-        start: number;
-        end: number;
-    }[];
-    static FACE_LANDMARKS_TESSELATION: {
-        start: number;
-        end: number;
-    }[];
+    static FACE_LANDMARKS_LIPS: Connection[];
+    static FACE_LANDMARKS_LEFT_EYE: Connection[];
+    static FACE_LANDMARKS_LEFT_EYEBROW: Connection[];
+    static FACE_LANDMARKS_LEFT_IRIS: Connection[];
+    static FACE_LANDMARKS_RIGHT_EYE: Connection[];
+    static FACE_LANDMARKS_RIGHT_EYEBROW: Connection[];
+    static FACE_LANDMARKS_RIGHT_IRIS: Connection[];
+    static FACE_LANDMARKS_FACE_OVAL: Connection[];
+    static FACE_LANDMARKS_CONTOURS: Connection[];
+    static FACE_LANDMARKS_TESSELATION: Connection[];
 }
 
 /** Performs face stylization on images. */
@@ -1416,6 +1448,13 @@ export declare interface Landmark {
     z: number;
 }
 
+/** Data that a user can use to specialize drawing options. */
+export declare interface LandmarkData {
+    index?: number;
+    from?: NormalizedLandmark;
+    to?: NormalizedLandmark;
+}
+
 /**
  * Copyright 2023 The MediaPipe Authors. All Rights Reserved.
  *