├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenAnnotationIO 2 | ## Abstract 3 | Traditional annotations are marginalia, errata, and highlights in printed books, schemas, picture, and other physical media. Open Annotations are an attempt to recreate and extend that functionality as a new layer of interactivity and linking on top of the fabric of reality. 4 | 5 | It will allow anyone to annotate anything anywhere, be it a pdf, an timeline, a video, an image, a 3d model, an audio stream, or data in raw or visualized form. Open Annotations can be linked, shared between services, tracked back to their origins, searched and discovered, and stored wherever the author wishes; the vision is for a decentralized and open annotation infrastructure. 6 | 7 | ## Introduction 8 | Annotating, the act of creating associations between distinct pieces of information, is a driving activity of any creative and technical process, but currently lacks a uniform approach. 9 | 10 | The interactive and collaborative world we live in, where citizens are part of a global community, has produced an environment that both socially motivate and give rise to technical challenges for annotating. 11 | 12 | Currently, comments are made using tools built in to various systems. In addition to commenting on resources in a wide variety of social media and creative platforms, there are a plethora of closed and proprietary web-based "sticky note" systems and stand-alone multimedia annotation systems. 13 | 14 | The primary downfall about these types of systems is that the user-created annotations cannot be shared or reused due to a deliberate "lock-in" strategy within the environments where they were created. The basic requirement is a common approach to model and express annotations. 15 | 16 | This is the primary aim of OpenAnnotationIO. 17 | 18 | OpenAnnotationIO aim to provide a simple extendable way to share and model complex annotation networks while remaining simple enough to be used in the most common use cases, like attaching a piece of text to a single media. 19 | 20 | The intended use of OpenAnnotatioIO interoperability is either for sharing public annotations with others or for the migration of private annotations between systems or devices. The annotations must be able to be integrated into existing media collections, APIs, metadata storages and reused without loss of significant information, retaining the contextuality. 21 | 22 | ## Terminology 23 | **IRI** https://datatracker.ietf.org/doc/html/rfc3987 24 | 25 | **Resource** An item of interest that MAY be identified by an IRI. 26 | 27 | ## Guiding Principles and Values 28 | The primary aim is to create a standard description framework for sharing annotations between systems. 29 | 30 | ## Basics 31 | ### Annotation 32 | An Annotation is a Resource. An Annotation usually has a single Body, which is a comment, a scribble, a video an image a sound, and a Target that the Body is somehow "about". The Annotation could contain also additional descriptive properties. 33 | 34 | **Example Use Case**: Gaelle has written a note that makes a comment about a particular movie shot. Her client application creates an Annotation with the note as the body resource, and the movie shot as the target resource. 35 | 36 | ### Motivations 37 | The “aboutness” that is described in the Annotation is conveyed using an instance of the oaio:Motivation class. 38 | 39 | ### External Resource 40 | 41 | ### Basic Resource Types 42 | #### Dataset 43 | #### Text 44 | #### Sound 45 | #### Video 46 | #### Image 47 | #### Model 48 | 49 | ### Agents 50 | More information about the agents behind the creation of an Annotation is normally required with an identification IRI. For instance they could be includes whether individuals, a group or a software and with is additional properties such as real name, company name, position, and email address. 51 | 52 | **Example Use Case:** Gaelle wants to submit an Annotation to a system that does not know about her identity, for instance if the IRI of the user is from a Database that ins't shared, she would like her name to be displayed and a way for other system to either add her comment in the Database or either send her a notification when new notes are added in a federated system sceneraio. Her software client adds this information to the Annotation to send to external services. 53 | 54 | ### Audience 55 | 56 | ### Rights 57 | 58 | ### Selectors 59 | Annotations refer to part of a media, rather than all of it, as the Target. We call that part of the media a Segment. A Selector is used to describe how to determine the Segment from within the Source media. Multiple Selectors can be given to describe the same Segment in different ways. 60 | 61 | **Example Use Case:** Gaelle wants to associate a selection of an image in frame version, with another image on the same frame of another version. She selects both using her client application, and creates the Annotation with a SpecificResource that has a Selector for each of the Body and the Target. 62 | 63 | #### Fragment Selector 64 | As the most well understood mechanism for selecting a Segment is to use the fragment part of an IRI defined by the representation's media type, To be clear about which fragment type is being used, the Selector may refer to the specification that defines it. The specification should be accessible by anyone accessing the annotation. 65 | 66 | **Example Use Case:** Gaelle wants to associate part of a video as the comment for an animation was created by an artist. She selects the time range within the video and clicks that it is describing the target. Her client appllication then creates the Annotation using a SpecificResource with a FragmentSelector and the describing Motivation. 67 | 68 | #### OTIO Selector 69 | Another common method of selecting elements and content within a resource that supports OTIO, is to use an OTIO selection. OTIO allows a great deal of flexibility when describing the editorial structure to the selected content. Results are not defined for when an OTIO Selector is applied to a representation that does not conform to the edit. 70 | 71 | **Example Use Case:** Gaelle selects a clip and writes a note about the whole clip. To refer explicitly to this item, her client application use the OTIO structure to identify it as the target of the Annotation. 72 | 73 | #### USD Selector 74 | 75 | #### OIIO Selector 76 | 77 | #### Data Position Selector 78 | 79 | #### SVG Selector 80 | 81 | #### Range Selector 82 | 83 | ### States 84 | 85 | ### Styles 86 | 87 | ### Multiplicity 88 | #### Choice 89 | A Choice is a set of resources. The client application can decide what resource to choose either trough an automated algorithm that should make use of the information present in the Annotation to do so, or present a list and require the user to make the decision. The Choice should have a default option. 90 | 91 | **Example Use Case:** Galle annotates a frame that is published in multiple Metadata Storages, however the representations are identical. One copy is in her studio based Metadata Storage, the other in her institutional Metadata Storage. She wishes to explicitly link both of the Targets to ensure her annotation can be presented along with at least one copy of the frame from the most convenient location to the Annotation Consumer. 92 | 93 | #### Composite 94 | #### List 95 | 96 | ## Use Cases 97 | While there are too many use cases to discuss them all in detail, it is useful to hightlight some key scenarios that serve as input to the design process. 98 | 99 | The most common use case for annotations is simply attaching a textual comment to an existing media. This could take the form of a commenting system, an overlaid digital sticky-note. 100 | 101 | An extension to this scenario is when the body or the target being annotated is not just textual. It could be a video or audio file, for example, which is about an image or data set. Commenters can easily leave video or audio comments and associate it with a specific media with the ability to easily upload from mobile devices or computers with webcams. 102 | 103 | The ability to annotate arbitrary media is particularly important in many production use cases, where different media formats, large scale datasets, frames, 3d Models and many others are the topic of discussions. 104 | 105 | Tagging resources, either with a simple string or a semantic URI, is also a very common case. For instance tagging a media with a specific Vendor ID, Database ID to then pass it along to other vendorts that would tag the resource with their own IDs. 106 | 107 | Machines also create annotations to be consumed by other machines. Image/Video Mining applications can quickly annotate every image or audio, and then build upon those annotations to create relationships between them. 108 | 109 | ### Annotate a single Image 110 | 111 | ### Annotate a range in a video 112 | 113 | ### Annotate a 3D Model 114 | 115 | ### Annotate two media in compare mode 116 | 117 | ### Annotate a media layer 118 | 119 | ### Annotate a clip 120 | 121 | ### Annotate a track 122 | 123 | ### Annotate a selection of clips 124 | 125 | ### Requirements 126 | The following requirements are summarized from the use cases presented above. 127 | 128 | ## Data Model 129 | 130 | ## Data Model Modules 131 | 132 | ## Interoperability 133 | 134 | ### OTIO 135 | 136 | ### USD 137 | 138 | ### EXR Metadata 139 | 140 | ### QuickTime Metadata 141 | 142 | 143 | --------------------------------------------------------------------------------