vdoencodeclient: Add support for AVIF

Co-authored-by: Jimmy Rubin <jimmyrn@axis.com>
Co-authored-by: Isak Jakobsson <isakj@axis.com>

Author: 3 people

.github/workflows/vdostream.yml

@@ -15,6 +15,11 @@ jobs:
         axis-os: ["12.7.53"]
         arch: ["armv7hf", "aarch64"]
         vdo-format: ["h264", "h265", "y800", "jpeg", "nv12"]
+        include:
+          - axis-os: "12.7.53"
+            arch: "aarch64"
+            vdo-format: "avif"
+            chip: "artpec9"
     env:
       EXREPO: acap-native-examples
       EXNAME: vdostream

vdostream/README.md

@@ -2,12 +2,19 @@
 
 # A vdo stream based ACAP application on an edge device
 
-This README file explains how to build an ACAP application that uses the vdostream API.
+This README file explains how to build an ACAP application that uses:
+
+- the [Video capture API (VDO)](https://developer.axis.com/acap/api/native-sdk-api/#video-capture-api-vdo) to fetch frames from e.g. a camera.
 
 Together with this README file, you should be able to find a directory called app. That directory contains the "vdoencodeclient" application source code which can easily
 be compiled and run with the help of the tools and step by step below.
 
-This example illustrates how to continuously capture frames from the vdo service, access the received buffer contents as well as the frame metadata. Captured frames are logged in the Application log.
+This example illustrates two different ways of retrieving video frames from VDO.
+
+- Snapshot, if only one video frame is wanted the vdo_stream_snapshot API is convenient. Typically used for JPEG or AVIF.
+- Continously capturing video frame from the VDO service.
+
+When a video buffer is retrieved, access the received buffer contents as well as the frame metadata. Captured frames are logged in the Application log.
 
 ## Getting started
 
@@ -18,11 +25,14 @@ vdostream
 ├── app
 │   ├── LICENSE
 │   ├── Makefile
+│   ├── manifest.json.avif
 │   ├── manifest.json.h264
 │   ├── manifest.json.h265
 │   ├── manifest.json.jpeg
 │   ├── manifest.json.nv12
 │   ├── manifest.json.y800
+│   └── panic.c
+│   └── panic.h
 │   └── vdoencodeclient.c
 ├── Dockerfile
 └── README.md
@@ -31,6 +41,7 @@ vdostream
 - **app/LICENSE** - Text file which lists all open source licensed source code distributed with the application.
 - **app/Makefile** - Build and link instructions for the application.
 - **app/manifest.json** - Defines the application and its configuration.
+- **app/panic.c/h** - Utility for exiting the program on error
 - **app/vdoencodeclient.c** - Application to capture the frames using vdo service in C.
 - **Dockerfile** - Assembles an image containing the ACAP Native SDK and builds the application using it.
 - **README.md** - Step by step instructions on how to run the example.
@@ -59,7 +70,7 @@ docker build --platform=linux/amd64 --tag <APP_IMAGE> --build-arg VDO_FORMAT=<VD
 ```
 
 <!-- textlint-disable terminology -->
-<VDO_FORMAT> is the video compression format. Supported values are *h264*, *h265*, *jpeg*, *nv12* and *y800*
+<VDO_FORMAT> is the video compression format. Supported values are *avif*, *h264*, *h265*, *jpeg*, *nv12* and *y800*
 <!-- textlint-enable -->
 
 <APP_IMAGE> is the name to tag the image with, e.g., vdoencodeclient:1.0
@@ -85,16 +96,20 @@ vdostream
 ├── app
 │   ├── LICENSE
 │   ├── Makefile
+│   ├── manifest.json.avif
 │   ├── manifest.json.h264
 │   ├── manifest.json.h265
 │   ├── manifest.json.jpeg
 │   ├── manifest.json.nv12
 │   ├── manifest.json.y800
+│   └── panic.c
+│   └── panic.h
 │   └── vdoencodeclient.c
 ├── build
 │   ├── LICENSE
 │   ├── Makefile
 │   ├── manifest.json
+│   ├── manifest.json.avif
 │   ├── manifest.json.h264
 │   ├── manifest.json.h265
 │   ├── manifest.json.jpeg
@@ -150,6 +165,15 @@ Application log can be found directly at:
 http://<AXIS_DEVICE_IP>/axis-cgi/admin/systemlog.cgi?appname=vdoencodeclient
 ```
 
+#### Output - format avif
+
+```sh
+----- Contents of SYSTEM_LOG for 'vdoencodeclient' -----
+
+vdoencodeclient[49013]: Starting stream: avif, 640x360
+vdoencodeclient[49013]: frame =    0, type = avif, size = 2700
+```
+
 #### Output - format h264
 
 ```sh

vdostream/app/Makefile

@@ -1,5 +1,5 @@
 PROG1	= $(shell jq -r '.acapPackageConf.setup.appName' manifest.json)
-OBJS1	= $(PROG1).c
+OBJS1	= $(PROG1).c panic.c
 PROGS	= $(PROG1)
 DEBUG_DIR = debug
 

vdostream/app/manifest.json.avif

@@ -0,0 +1,14 @@
+{
+    "schemaVersion": "1.8.0",
+    "acapPackageConf": {
+        "setup": {
+            "friendlyName": "vdoencodeclient_avif",
+            "appName": "vdoencodeclient",
+            "vendor": "Axis Communications",
+            "embeddedSdkVersion": "3.0",
+            "runOptions": "--format avif --frames 1",
+            "runMode": "never",
+            "version": "1.0.0"
+        }
+    }
+}

vdostream/app/panic.c

@@ -0,0 +1,32 @@
+/**
+ * Copyright (C) 2025, Axis Communications AB, Lund, Sweden
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "panic.h"
+
+#include <stdarg.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <syslog.h>
+
+// Function definition for panic
+__attribute__((noreturn)) __attribute__((format(printf, 1, 2))) void panic(const char* format,
+                                                                           ...) {
+    va_list arg;
+    va_start(arg, format);
+    vsyslog(LOG_ERR, format, arg);
+    va_end(arg);
+    exit(1);
+}

vdostream/app/panic.h

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2025, Axis Communications AB, Lund, Sweden
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <stdarg.h>
+
+// Function declaration for panic
+__attribute__((noreturn)) __attribute__((format(printf, 1, 2))) void panic(const char* format, ...);