Contact iMeritAngo Hub WebsiteLog In to Ango Hub
Page cover

Video V2 Breaking Changes and Transition

On Wednesday, the 26th of February 2025, a new version of the video labeling editor will be deployed, which we call "V2". This video editor experience will be the default, and the only option, for projects created after the update is released.

Key points regarding the transition from Video V1 to Video V2:

  • Video V2 will be released on February 26, 2025, as part of the Ango Hub 4 update.

  • Video assets in projects created before the release of Video V2:

    • Will not see any change and will continue working as-is.

  • Video assets in projects created after the release of Video V2:

    • Will require a different JSON format for importing pre-annotations to them.

    • Will produce a different output in the export. While the overall format of the export will not change, the export content for video assets specifically will be different.

  • Plugins will need to be updated to support Video V2. Please contact the creator of the plugin you need to use to ensure they have updated the plugin to support V2.

This means that as a temporary workaround, you may upload new videos to projects that have been created before the update date, and your workflow will not change.

The Video V2 Pre-Annotation Import Format

Here is the new format required to import pre-annotations to videos after V2:

Sample V2 Pre-Annotation Import JSON
[
  {
    "externalId": "file.mp4",
    "objects": [
      {
        "schemaId": "6898f9b5d827f3583355586",
        "objectId": "1",
        "classifications": [
          {
            "objectId": "6",
            "schemaId": "cb64ec98cca7c5bdb8f8330",
            "keyFrames": {
              "60": {
                "answer": "a"
              },
              "70": {
                "answer": "c"
              }
            }
          },
          {
            "objectId": "7",
            "schemaId": "d5dbcccb3685739a909e442",
            "keyFrames": {
              "60": {
                "answer": "bb"
              },
              "65": {
                "answer": "cc"
              }
            }
          }
        ],
        "segments": [
          0,
          100
        ],
        "outOfViewSegments": [
          [
            10,
            20
          ]
        ],
        "keyFrames": {
          "0": {
            "bounding-box": {
              "x": 0.6799999999999997,
              "y": 512.1166666666667,
              "height": 40.0,
              "width": 20.0
            }
          },
          "50": {
            "bounding-box": {
              "x": 300,
              "y": 369.29288,
              "height": 354.27480999999995,
              "width": 76.08892
            }
          }
        }
      },
      {
        "schemaId": "8f735e404365e7243a56197",
        "objectId": "777",
        "classifications": [],
        "segments": [
          100,
          200
        ],
        "keyFrames": {
          "120": {
            "rotated-bounding-box": {
              "x": 299.2857142857143,
              "y": 193.95626242544733,
              "height": 561.1133200795229,
              "width": 14.285714285714286,
              "rotation": -45,
              "corners": [
                [
                  299.2857142857143,
                  193.95626242544733
                ],
                [
                  700.7142857142858,
                  584.7316103379721
                ],
                [
                  710.6689029115568,
                  574.4649123140548
                ],
                [
                  309.24033148298537,
                  183.6895644015299
                ]
              ]
            },
            "metadata": {
              "id": "unique-id"
            }
          },
          "150": {
            "rotated-bounding-box": {
              "x": 299.2857142857143,
              "y": 193.95626242544733,
              "height": 561.1133200795229,
              "width": 14.285714285714286,
              "rotation": 0,
              "corners": [
                [
                  299.2857142857143,
                  193.95626242544733
                ],
                [
                  700.7142857142858,
                  584.7316103379721
                ],
                [
                  710.6689029115568,
                  574.4649123140548
                ],
                [
                  309.24033148298537,
                  183.6895644015299
                ]
              ]
            },
            "metadata": {
              "id": "unique-id"
            }
          },
          "180": {
            "rotated-bounding-box": {
              "x": 299.2857142857143,
              "y": 193.95626242544733,
              "height": 561.1133200795229,
              "width": 14.285714285714286,
              "rotation": 45,
              "corners": [
                [
                  299.2857142857143,
                  193.95626242544733
                ],
                [
                  700.7142857142858,
                  584.7316103379721
                ],
                [
                  710.6689029115568,
                  574.4649123140548
                ],
                [
                  309.24033148298537,
                  183.6895644015299
                ]
              ]
            },
            "metadata": {
              "id": "unique-id"
            }
          }
        },
        "outOfViewSegments": [
          [
            125,
            145
          ]
        ]
      },
      {
        "schemaId": "6898f9b5d827f3583355586",
        "objectId": "2",
        "classifications": [],
        "segments": [
          150,
          175
        ],
        "keyFrames": {
          "155": {
            "bounding-box": {
              "x": 0.6799999999999997,
              "y": 512.1166666666667,
              "height": 40.0,
              "width": 20.0
            }
          },
          "165": {
            "bounding-box": {
              "x": 0.06453,
              "y": 369.29288,
              "height": 354.27480999999995,
              "width": 76.08892
            }
          }
        }
      },
      {
        "schemaId": "7e790a880628eb57fa13976",
        "objectId": "poly-id1",
        "segments": [
          250,
          450
        ],
        "keyFrames": {
          "260": {
            "polygon": [
              [
                429.2857142857143,
                357.1371769383698
              ],
              [
                689.2857142857143,
                211.13320079522865
              ],
              [
                712.1428571428571,
                481.66998011928433
              ]
            ]
          },
          "400": {
            "polygon": [
              [
                665,
                377.17693836978134
              ],
              [
                876.4285714285714,
                347.11729622266404
              ],
              [
                947.8571428571429,
                501.70974155069587
              ]
            ]
          }
        },
        "outOfViewSegments": [
          [
            251,
            255
          ],
          [
            445,
            450
          ]
        ]
      },
      {
        "schemaId": "055ec169efab9ec4a27d840",
        "objectId": "polyline-id",
        "segments": [
          300,
          340
        ],
        "keyFrames": {
          "300": {
            "polyline": [
              [
                819.2857142857143,
                435.8648111332008
              ],
              [
                1213.5714285714287,
                146.71968190854872
              ],
              [
                1117.857142857143,
                451.61033797216703
              ]
            ]
          },
          "335": {
            "polyline": [
              [
                205,
                427.2763419483102
              ],
              [
                599.2857142857143,
                138.13121272365805
              ],
              [
                503.57142857142856,
                443.0218687872764
              ]
            ]
          }
        }
      },
      {
        "schemaId": "5bab615bf6fe39117dfd678",
        "objectId": "point-id",
        "segments": [
          0,
          500
        ],
        "keyFrames": {
          "5": {
            "point": [
              1012.1428571428571,
              98.051689860835
            ]
          },
          "100": {
            "point": [
              120.71428571428572,
              667.7534791252484
            ]
          },
          "200": {
            "point": [
              1012.1428571428571,
              98.051689860835
            ]
          }
        },
        "outOfViewSegments": [
          [
            200,
            300
          ]
        ]
      },
      {
        "schemaId": "3f788aed27e64d2d4787663",
        "objectId": "spline-id",
        "segments": [
          500,
          600
        ],
        "keyFrames": {
          "520": {
            "spline": [
              [
                87.14285714285714,
                357.1371769383698,
                42.85714285714286,
                0
              ],
              [
                482.8571428571429,
                83.7375745526839,
                42.85714285714289,
                0
              ],
              [
                998.5714285714286,
                444.45328031809146,
                42.857142857143,
                0
              ]
            ]
          },
          "550": {
            "spline": [
              [
                87.14285714285714,
                357.1371769383698,
                42.85714285714286,
                0
              ],
              [
                482.8571428571429,
                528.9065606361829,
                42.85714285714289,
                0
              ],
              [
                1045.7142857142858,
                630.5367793240557,
                42.857142857143,
                0
              ]
            ]
          }
        }
      }
    ],
    "classifications": [
      {
        "objectId": "3",
        "schemaId": "a5f51ee4a6ff0f827fb0442",
        "keyFrames": {
          "50": {
            "answer": "r1"
          },
          "70": {
            "answer": "r2"
          },
          "90": {
            "answer": "r3"
          }
        },
        "segments": [
          50,
          250
        ],
        "classifications": [
          {
            "schemaId": "44b504df31195596ca46557",
            "objectId": "4",
            "keyFrames": {
              "60": {
                "answer": "rr1"
              },
              "65": {
                "answer": "rr2"
              },
              "68": {
                "answer": "rr3"
              }
            }
          }
        ]
      },
      {
        "schemaId": "355d4c2ff1d3c39e516c231",
        "objectId": "5",
        "answer": [
          "topms1",
          "topms2"
        ]
      },
      {
        "objectId": "6",
        "schemaId": "b2a29911c43a0ce39d54567",
        "keyFrames": {
          "30": {
            "answer": [
              "c1"
            ]
          },
          "60": {
            "answer": [
              "c2"
            ]
          }
        },
        "segments": [
          30,
          100
        ]
      },
      {
        "objectId": "7",
        "schemaId": "ee272d99a44bee1692d0664",
        "keyFrames": {
          "40": {
            "answer": "ss1"
          },
          "80": {
            "answer": "ss2"
          }
        },
        "segments": [
          40,
          120
        ]
      },
      {
        "objectId": "8",
        "schemaId": "3d72d3b1e2d4f17a713b602",
        "keyFrames": {
          "20": {
            "answer": [
              "ms1"
            ]
          },
          "70": {
            "answer": [
              "ms3"
            ]
          }
        },
        "segments": [
          20,
          90
        ]
      },
      {
        "schemaId": "8ae3d748a66f22f4e954374",
        "objectId": "topppradio",
        "answer": "topr1"
      },
      {
        "schemaId": "328e7973dbe087d4849b299",
        "objectId": "topppcheckbox",
        "answer": [
          "topc1",
          "topc3"
        ]
      },
      {
        "schemaId": "1efbae10408aad6736e1729",
        "objectId": "toppsssdropdown",
        "answer": "topss3"
      },
      {
        "schemaId": "accb292c48ac298f6c88832",
        "objectId": "topppleveltext",
        "answer": "video is good"
      }
    ]
  }
]

When importing pre-annotations to a Video V2 asset, you must specify the file extension.

This means that if you are attempting to import the pre-annotations using only the externald field, then the asset's externalID must contain the file's correct extension. For example:

If you are using the "data" field, alone or together with the externalId field, then at least the data field must contain the full filename, including the file extension:

The main changes are:

  • Keyframes, segments, and out of view intervals are introduced (see below)

  • The concept and property of "page" has been removed

Here is a look from the UI, for reference:

In the above screenshot, a bounding box belonging to the class "bb" first appears on frame 3 and has a keyframe. Then, it is edited on frame 10, and therefore has another keyframe there. The bounding box disappears from view from frame 12 to 14 included. It then reappears on frame 15 and keeps appearing until frame 20, with the same properties it had since they were last set on the keyframe on frame 10.

If we were to import this bounding box as a pre-annotation, it would look like this:

Sample Bounding Box Object JSON

Some things to note:

  • In the UI, the frame count starts at 1, but in the JSON, it starts at 0. Adjust frame numbers accordingly.

  • For "Out of view" sections, the first number is included, and the second excluded. (see example above)

  • The "segments" property is only used for top-level objects and classifications. Nested classifications use their parent's "segments."

  • Any "keyframe" can have a "metadata" field where any kind of arbitrary metadata can be included. While this metadata will not be shown on the user interface, it will be made available in the final export if the keyframe has not been deleted by that point.

V1 to V2 Conversion Script

We are providing here a Python script to automatically convert Video V1 pre-annotation import JSONs to Video V2 ones.

This script is provided as-is and we do not provide support for it. You are responsible for ensuring the result is correct.

While the script has been tested as working for most use cases, it might not return correct results for exceptionally complex pre-annotation JSONs, especially if they include the following:

The script:

7KB
v1_import_to_v2_import.py
Open

Video V2 Export Format

The following is a sample of the new video asset export.

As highlighted above, there will be no changes to the export outside of the sections about video assets, and only in those video assets in projects created after the release of Video V2.

Sample Export

The changes in the export reflect the changes that have been made in the import format.

Last updated