Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.25 KB

readme.md

File metadata and controls

71 lines (47 loc) · 2.25 KB
Raw

Video and Image Annotation Tool

This project provides an annotation tool for HTML video and image elements. The tool allows users to draw and annotate over video and images using various drawing tools, including curves, rectangles, ellipses, and texts. Users can also customize the color and stroke size of their annotations.

Demo: lifeart.github.io/sm-annotate

Features

  • ✍️ Drawing and annotating over video and image elements.
  • 🛠️ Multiple drawing tools (curve, rectangle, ellipse, and text).
  • 🎨 Customizable color and stroke size for the annotations.
  • ↩️ Undo functionality.
  • 🔗 Serialization and deserialization of drawn shapes.
  • 📏 Scaling shapes to the current canvas size.
  • ⌨️ Keyboard shortcuts for undo (Ctrl/Cmd + Z).
  • 🖱️ Event handling for pointer events (mouse and touch).
  • 🎞️ Playback of annotated frames as video.
  • 💾 Saving the current frame or all frames with annotations.
  • 🎞️ Video Overlay comparsion

Additional Benefits

  • 🚀 Zero dependencies.
  • 📱 Support for mobile devices.
  • 🔌 Powerful plugin system.
  • 📘 Written in TypeScript.

Getting Started

Add the package to your project using yarn:

yarn add https://github.com/lifeart/sm-annotate.git

Usage

import { SmAnnotate } from '@lifeart/sm-annotate';
const video = document.getElementById('video');
const annotationTool = new AnnotationTool(video);

Users can draw and annotate using the available tools (curve, rectangle, ellipse, and text) and customize the color and stroke size of the annotations. The tool also supports undo functionality and event handling for pointer events (mouse and touch).

To save the current frame or all frames with annotations, use the saveCurrentFrame or saveAllFrames methods, respectively.

Hotkeys

Curve tool

KeyCode Result
Shift Magnifier x2
r Red color
g Green color
b Blue color
y Yellow color
1 - 9 Tool size

Contributing

We welcome contributions to improve the project. Please feel free to submit issues or pull requests for consideration.

License

This code is allowed for non-commercial use. For commercial use, users must contact the author.