adding metadata of swt-detection.v4.0

clamsproject · Feb 26, 2024 · 7b2ca99 · 7b2ca99
1 parent 396107b
commit 7b2ca99
Show file tree

Hide file tree

Showing 5 changed files with 194 additions and 23 deletions.
diff --git a/docs/_apps/swt-detection/v4.0/index.md b/docs/_apps/swt-detection/v4.0/index.md
@@ -0,0 +1,59 @@
+---
+layout: posts
+classes: wide
+title: "Scenes-with-text Detection (v4.0)"
+date: 2024-02-26T18:27:42+00:00
+---
+## About this version
+
+* Submitter: [marcverhagen](https://github.com/marcverhagen)
+* Submission Time: 2024-02-26T18:27:42+00:00
+* Prebuilt Container Image: [ghcr.io/clamsproject/app-swt-detection:v4.0](https://github.com/clamsproject/app-swt-detection/pkgs/container/app-swt-detection/v4.0)
+* Release Notes
+
+    > Version 4.0
+
+## About this app (See raw [metadata.json](metadata.json))
+
+**Detects scenes with text, like slates, chyrons and credits.**
+
+* App ID: [http://apps.clams.ai/swt-detection/v4.0](http://apps.clams.ai/swt-detection/v4.0)
+* App License: Apache 2.0
+* Source Repository: [https://github.com/clamsproject/app-swt-detection](https://github.com/clamsproject/app-swt-detection) ([source tree of the submitted version](https://github.com/clamsproject/app-swt-detection/tree/v4.0))
+
+
+#### Inputs
+* [http://mmif.clams.ai/vocabulary/VideoDocument/v1](http://mmif.clams.ai/vocabulary/VideoDocument/v1)  (required)
+(any properties)
+
+
+#### Configurable Parameters
+**(_Multivalued_ means the parameter can have one or more values.)**
+
+|Name|Description|Type|Multivalued|Default|Choices|
+|----|-----------|----|-----------|-------|-------|
+|startAt|Number of milliseconds into the video to start processing|integer|N|0||
+|stopAt|Number of milliseconds into the video to stop processing|integer|N|10000000||
+|sampleRate|Milliseconds between sampled frames|integer|N|1000||
+|minFrameScore|Minimum score for a still frame to be included in a TimeFrame|number|N|0.01||
+|minTimeframeScore|Minimum score for a TimeFrame|number|N|0.5||
+|minFrameCount|Minimum number of sampled frames required for a TimeFrame|integer|N|2||
+|pretty|The JSON body of the HTTP response will be re-formatted with 2-space indentation|boolean|N|false|**_`false`_**, `true`|
+
+
+#### Outputs
+**(Note that not all output annotations are always generated.)**
+* [http://mmif.clams.ai/vocabulary/TimeFrame/v2](http://mmif.clams.ai/vocabulary/TimeFrame/v2) 
+    * _timeUnit_ = "milliseconds"
+    * _frameType_ = "bars"
+* [http://mmif.clams.ai/vocabulary/TimeFrame/v2](http://mmif.clams.ai/vocabulary/TimeFrame/v2) 
+    * _timeUnit_ = "milliseconds"
+    * _frameType_ = "slate"
+* [http://mmif.clams.ai/vocabulary/TimeFrame/v2](http://mmif.clams.ai/vocabulary/TimeFrame/v2) 
+    * _timeUnit_ = "milliseconds"
+    * _frameType_ = "chyron"
+* [http://mmif.clams.ai/vocabulary/TimeFrame/v2](http://mmif.clams.ai/vocabulary/TimeFrame/v2) 
+    * _timeUnit_ = "milliseconds"
+    * _frameType_ = "credits"
+* [http://mmif.clams.ai/vocabulary/TimePoint/v1](http://mmif.clams.ai/vocabulary/TimePoint/v1) 
+    * _timeUnit_ = "milliseconds"
diff --git a/docs/_apps/swt-detection/v4.0/metadata.json b/docs/_apps/swt-detection/v4.0/metadata.json
@@ -0,0 +1,102 @@
+{
+  "name": "Scenes-with-text Detection",
+  "description": "Detects scenes with text, like slates, chyrons and credits.",
+  "app_version": "v4.0",
+  "mmif_version": "1.1.0",
+  "app_license": "Apache 2.0",
+  "identifier": "http://apps.clams.ai/swt-detection/v4.0",
+  "url": "https://github.com/clamsproject/app-swt-detection",
+  "input": [
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/VideoDocument/v1",
+      "required": true
+    }
+  ],
+  "output": [
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v2",
+      "properties": {
+        "timeUnit": "milliseconds",
+        "frameType": "bars"
+      }
+    },
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v2",
+      "properties": {
+        "timeUnit": "milliseconds",
+        "frameType": "slate"
+      }
+    },
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v2",
+      "properties": {
+        "timeUnit": "milliseconds",
+        "frameType": "chyron"
+      }
+    },
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/TimeFrame/v2",
+      "properties": {
+        "timeUnit": "milliseconds",
+        "frameType": "credits"
+      }
+    },
+    {
+      "@type": "http://mmif.clams.ai/vocabulary/TimePoint/v1",
+      "properties": {
+        "timeUnit": "milliseconds"
+      }
+    }
+  ],
+  "parameters": [
+    {
+      "name": "startAt",
+      "description": "Number of milliseconds into the video to start processing",
+      "type": "integer",
+      "default": 0,
+      "multivalued": false
+    },
+    {
+      "name": "stopAt",
+      "description": "Number of milliseconds into the video to stop processing",
+      "type": "integer",
+      "default": 10000000,
+      "multivalued": false
+    },
+    {
+      "name": "sampleRate",
+      "description": "Milliseconds between sampled frames",
+      "type": "integer",
+      "default": 1000,
+      "multivalued": false
+    },
+    {
+      "name": "minFrameScore",
+      "description": "Minimum score for a still frame to be included in a TimeFrame",
+      "type": "number",
+      "default": 0.01,
+      "multivalued": false
+    },
+    {
+      "name": "minTimeframeScore",
+      "description": "Minimum score for a TimeFrame",
+      "type": "number",
+      "default": 0.5,
+      "multivalued": false
+    },
+    {
+      "name": "minFrameCount",
+      "description": "Minimum number of sampled frames required for a TimeFrame",
+      "type": "integer",
+      "default": 2,
+      "multivalued": false
+    },
+    {
+      "name": "pretty",
+      "description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
+      "type": "boolean",
+      "default": 0,
+      "multivalued": false
+    }
+  ]
+}
diff --git a/docs/_apps/swt-detection/v4.0/submission.json b/docs/_apps/swt-detection/v4.0/submission.json
@@ -0,0 +1,6 @@
+{
+  "time": "2024-02-26T18:27:42+00:00",
+  "submitter": "marcverhagen",
+  "image": "ghcr.io/clamsproject/app-swt-detection:v4.0",
+  "releasenotes": "Version 4.0\n\n"
+}
diff --git a/docs/_data/app-index.json b/docs/_data/app-index.json
@@ -1,4 +1,30 @@
 {
+  "http://apps.clams.ai/swt-detection": {
+    "description": "Detects scenes with text, like slates, chyrons and credits.",
+    "latest_update": "2024-02-26T18:27:42+00:00",
+    "versions": [
+      [
+        "v4.0",
+        "marcverhagen"
+      ],
+      [
+        "v3.0",
+        "marcverhagen"
+      ],
+      [
+        "v2.1",
+        "marcverhagen"
+      ],
+      [
+        "v2.0",
+        "marcverhagen"
+      ],
+      [
+        "v1.0",
+        "marcverhagen"
+      ]
+    ]
+  },
   "http://apps.clams.ai/whisper-wrapper": {
     "description": "A CLAMS wrapper for Whisper-based ASR software originally developed by OpenAI.",
     "latest_update": "2024-02-12T19:47:39+00:00",
@@ -29,28 +55,6 @@
       ]
     ]
   },
-  "http://apps.clams.ai/swt-detection": {
-    "description": "Detects scenes with text, like slates, chyrons and credits.",
-    "latest_update": "2024-02-07T21:18:36+00:00",
-    "versions": [
-      [
-        "v3.0",
-        "marcverhagen"
-      ],
-      [
-        "v2.1",
-        "marcverhagen"
-      ],
-      [
-        "v2.0",
-        "marcverhagen"
-      ],
-      [
-        "v1.0",
-        "marcverhagen"
-      ]
-    ]
-  },
   "http://apps.clams.ai/easyocr-wrapper": {
     "description": "Using EasyOCR to extract text from timeframes",
     "latest_update": "2024-01-30T19:59:06+00:00",

diff --git a/docs/_data/apps.json b/docs/_data/apps.json