Mirador Annotation Editor with Video support (MAEV) - GPL edition

Presentation

Generalities

mirador-annotation-editor-video(also known as "MAEV") is a Mirador 4 plugin that adds annotation video support to MAE. It wraps the original MAE plugin to add video annotation support.

Copyrights

Licence

mirador-annotation-editor-video is distributed under the GPL v3.

Please acknowledge that any modification you make must be distributed under a compatible licence and cannot be closed source.

If you need to integrate this code base in closed source pieces of software, please contact us, so we can discuss dual licencing.

Property

The base of this software (up to V1) is the property of SATT Ouest Valorisation that funded its development under the French public contract AO-MA2023-0004-DV5189.

Authors

The authors of this software are :

• Clarisse Bardiot (concept and use cases)
• Jacob Hart (specifications)
• Tétras Libre SARL (development):
  • David Rouquet
  • Anthony Geourjon
  • Antoine Roy

Contributors (updated february 2024)

• AZOPSOFT SAS
  • Samuel Jugnet (especially code for the Konvas part)
• Loïs Poujade (especially the original modifications to annotate videos)

General functionalities

• Add video annotation support to mirador-annotation-editor
• Wrap mirador-annotation-editor

Technical aspects

• Support Material UI 5 and React 18 to follow the latest Mirador upgrades
• Need a custom

Use in npm project

You can override Mirador and existing annotation plugin with your own versions by using npm. We support React 18 and MUI 5. You need to use our custom Mirador 4 version. https://github.com/SCENE-CE/mirador-video

"mirador": "npm:mirador-video@^1.0.6",
"mirador-annotations": "npm:mirador-annotation-editor-video@^0.0.7",

You can find an example of integration in our Mirador-integration repository : https://gitlab.tetras-libre.fr/iiif/mirador/mirador-integration

Install (local)

This method requires nvm, npm.

git clone [email protected]:SCENE-CE/mirador-annotation-editor-video.git
cd mirador-annotation-editor
nvm use
npm install

If you encounter dependency issues, you can try to install with legacy peer dependencies :

npm install --legacy-peer-deps

Run a demo with Mirador and the MAEV plugin :

npm start

Full working Mirador environnement

We develop a Mirador Multi User (MMU) environnement : https://github.com/SCENE-CE/mirador-multi-user. MMU come out of the box with our custom Mirador Video (Mirador 4 with custom code) and the MAEV plugin.

Persisting Annotations

Persisting annotations requires implementing a IIIF annotation server. Several examples of annotation servers are available on iiif-awesome.

mirador-annotation-editor-editor currently supports adapters for annotot and local storage. We welcome contributions of adapters for other annotation servers.

Contribute

Our plugin follow the Mirador guidelines. Development, design, and maintenance is driven by community needs and ongoing feedback and discussion. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.