Bump version: 5.28 → 5.29

* Assign stream index on outgoing RTP packets (#5)

* Correctly assign mindex on outgoing rtp packets

Previously mindex was not set and defaulted to zero. This lead to most packets
getting dropped because of sequence number reuse when streaming both audio and
video. This reorders the SDP entries for video and audio so that video is first
in both a video-only and a audio+video configuration. This means that the mindex
for video packets should always be zero, and for audio (if present) should
always be one. This assumes there will never be an audio-only configuration.

* Adjust comments

Co-authored-by: Michael Lynch <git@mtlynch.io>

* Add preprocessor conditional to guard packet.mindex setting

The mindex field wasn't added to the janus_plugin_rtp_packet until Janus 1.0, so this change adds a precompiler check to ensure JANUS_PLUGIN_API_VERSION is >= 100 before assigning a value to the mindex field.

* Preserve audio-then-video ordering for Janus 0.x

Co-authored-by: Louis Goessling <louis@goessling.com>

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = True
 tag = True
-current_version = 5.17
+current_version = 5.29
 parse = (?P<major>\d+)\.(?P<minor>\d+)
 serialize = 
 	{major}.{minor}

.dockerignore

@@ -7,3 +7,4 @@
 !python/**
 !janus/**
 !man/**
+!pkg/docker/entry.sh

.github/FUNDING.yml

@@ -1,4 +1,4 @@
 # These are supported funding model platforms
 
 patreon: pikvm
-#custom: https://www.paypal.me/mdevaev
+custom: https://paypal.me/pikvm

.github/workflows/docker-alpine-image.yaml

@@ -0,0 +1,81 @@
+name: Build Alpine
+
+on:
+    push:
+        branches: [master, build_*]
+        tags: [v*]
+    pull_request:
+        branches: [master]
+
+jobs:
+  buildx:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Login to GitHub Container Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Login to DockerHub Container Registry
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/ustreamer,enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+            ghcr.io/${{ github.repository }},enable=${{ github.event_name != 'pull_request' }}
+          tags: |
+            type=ref,event=tag
+            type=sha,format=long
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver-opts: image=moby/buildkit:master
+      -
+        name: Build and export to Docker
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          load: true
+          tags: ustreamer
+          file: pkg/docker/Dockerfile.alpine
+      -
+        name: Test
+        run: |
+          echo version: $(docker run --rm -t ustreamer --version)
+          echo -e "features:\n$(docker run --rm -t ustreamer --features)"
+      -
+        name: Build multi arch
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/arm64,linux/amd64,linux/arm/v7
+          file: pkg/docker/Dockerfile.alpine
+      -
+        name: Push
+        if: steps.meta.outputs.tags != ''
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/arm64,linux/amd64,linux/arm/v7
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          file: pkg/docker/Dockerfile.alpine

README.md

@@ -5,7 +5,7 @@
 [[Русская версия]](README.ru.md)
 
 µStreamer is a lightweight and very quick server to stream [MJPEG](https://en.wikipedia.org/wiki/Motion_JPEG) video from any V4L2 device to the net. All new browsers have native support of this video format, as well as most video players such as mplayer, VLC etc.
-µStreamer is a part of the [Pi-KVM](https://github.com/pikvm/pikvm) project designed to stream [VGA](https://www.amazon.com/dp/B0126O0RDC) and [HDMI](https://auvidea.com/b101-hdmi-to-csi-2-bridge-15-pin-fpc/) screencast hardware data with the highest resolution and FPS possible.
+µStreamer is a part of the [PiKVM](https://github.com/pikvm/pikvm) project designed to stream [VGA](https://www.amazon.com/dp/B0126O0RDC) and [HDMI](https://auvidea.com/b101-hdmi-to-csi-2-bridge-15-pin-fpc/) screencast hardware data with the highest resolution and FPS possible.
 
 µStreamer is very similar to [mjpg-streamer](https://github.com/jacksonliam/mjpg-streamer) with ```input_uvc.so``` and ```output_http.so``` plugins, however, there are some major differences. The key ones are:
 
@@ -38,7 +38,7 @@ If you're going to live-stream from your backyard webcam and need to control it,
 You'll need  ```make```, ```gcc```, ```libevent``` with ```pthreads``` support, ```libjpeg9```/```libjpeg-turbo``` and ```libbsd``` (only for Linux).
 
 * Arch: `sudo pacman -S libevent libjpeg-turbo libutil-linux libbsd`.
-* Raspbian: `sudo apt install libevent-dev libjpeg8-dev libbsd-dev`. Add `libgpiod-dev` for `WITH_GPIO=1` and `libsystemd-dev` for `WITH_SYSTEMD=1`.
+* Raspbian: `sudo apt install libevent-dev libjpeg8-dev libbsd-dev`. Add `libgpiod-dev` for `WITH_GPIO=1` and `libsystemd-dev` for `WITH_SYSTEMD=1` and `libasound2-dev libspeex-dev libspeexdsp-dev libopus-dev` for `WITH_JANUS=1`.
 * Debian/Ubuntu: `sudo apt install build-essential libevent-dev libjpeg-dev libbsd-dev`.
 * Alpine: `sudo apk add libevent-dev libbsd-dev libjpeg-turbo-dev musl-dev`. Build with `WITH_PTHREAD_NP=0`.
 
@@ -81,8 +81,57 @@ $ ./ustreamer \
 
 You can always view the full list of options with ```ustreamer --help```.
 
+-----
+# Docker (Raspberry Pi 4 HDMI)
+
+## Preparations
+Add following lines to /boot/firmware/usercfg.txt:
+
+```
+gpu_mem=128
+dtoverlay=tc358743
+```
+
+Check size of CMA:
+
+```bash
+$ dmesg | grep cma-reserved
+[    0.000000] Memory: 7700524K/8244224K available (11772K kernel code, 1278K rwdata, 4320K rodata, 4096K init, 1077K bss, 281556K reserved, 262144K cma-reserved)
+```
+
+If it is smaller than 128M add following to /boot/firmware/cmdline.txt:
+
+```
+cma=128M
+```
+
+Save changes and reboot.
+
+## Launch
+Start container:
+
+```bash
+$ docker run --device /dev/video0:/dev/video0 -e EDID=1 -p 8080:8080 pikvm/ustreamer:latest
+```
+
+Then access the web interface at port 8080 (e.g. http://raspberrypi.local:8080).
+
+## Custom config
+```bash
+$ docker run --rm pikvm/ustreamer:latest \
+    --format=uyvy \
+    --workers=3 \
+    --persistent \
+    --dv-timings \
+    --drop-same-frames=30
+```
+
+## EDID
+Add `-e EDID=1` to set HDMI EDID before starging ustreamer. Use together with `-e EDID_HEX=xx` to specify custom EDID data.
+
 -----
 # Raspberry Pi Camera Example
+
 Example usage for the Raspberry Pi v1 camera:
 ```bash
 $ sudo modprobe bcm2835-v4l2

README.ru.md

@@ -5,7 +5,7 @@
 [[English version]](README.md)
 
 
-µStreamer - это маленький и очень быстрый сервер, который позволяет организовать трансляцию видео в формате [MJPEG](https://en.wikipedia.org/wiki/Motion_JPEG) с любого устройства V4L2 в сеть. Этот формат нативно поддерживается всеми современными браузерами и большинством приложений для просмотра видео (mplayer, VLC и так далее). µStreamer был разработан в рамках проекта [Pi-KVM](https://github.com/pikvm/pikvm) специально для стриминга с устройств видеозахвата [VGA](https://www.amazon.com/dp/B0126O0RDC) и [HDMI](https://auvidea.com/b101-hdmi-to-csi-2-bridge-15-pin-fpc/) с максимально возможным разрешением и FPS, которые только позволяет железо.
+µStreamer - это маленький и очень быстрый сервер, который позволяет организовать трансляцию видео в формате [MJPEG](https://en.wikipedia.org/wiki/Motion_JPEG) с любого устройства V4L2 в сеть. Этот формат нативно поддерживается всеми современными браузерами и большинством приложений для просмотра видео (mplayer, VLC и так далее). µStreamer был разработан в рамках проекта [PiKVM](https://github.com/pikvm/pikvm) специально для стриминга с устройств видеозахвата [VGA](https://www.amazon.com/dp/B0126O0RDC) и [HDMI](https://auvidea.com/b101-hdmi-to-csi-2-bridge-15-pin-fpc/) с максимально возможным разрешением и FPS, которые только позволяет железо.
 
 Функционально µStreamer очень похож на [mjpg-streamer](https://github.com/jacksonliam/mjpg-streamer) при использовании им плагинов ```input_uvc.so``` и ```output_http.so```, однако имеет ряд серьезных отличий. Основные приведены в этой таблице:
 

docs/h264.md

@@ -78,6 +78,17 @@ memsink: {
 EOF
 ```
 
+If you're using a TC358743-based video capture device that supports audio capture, run the following command to enable audio streaming:
+
+```sh
+cat << EOF >> /opt/janus/lib/janus/configs/janus.plugin.ustreamer.jcfg
+audio: {
+    device = "hw:1"
+    tc358743 = "/dev/video0"
+}
+EOF
+```
+
 ### Start µStreamer and the Janus WebRTC Server
 
 For µStreamer to share the video stream with the µStreamer Janus plugin, µStreamer must run with the following command-line flags:
@@ -111,13 +122,14 @@ The client-side JavaScript application uses the following control flow:
 1. The client instructs the Janus server to attach the µStreamer Janus plugin.
 1. On success, the client obtains a plugin handle through which it can send requests directly to the µStreamer Janus plugin. The client processes responses via the `attach` callbacks:
    - `onmessage` for general messages
-   - `onremotetrack` for the H.264 video stream
+   - `onremotetrack` for the H.264 video stream and (optionally) an Opus audio stream
 1. The client issues a `watch` request to the µStreamer Janus plugin, which initiates the H.264 stream in the plugin itself.
    - It takes a few seconds for uStreamer's video stream to become available to Janus. The first `watch` request may fail, so the client must retry the `watch` request.
 1. The client and server negotiate the underlying parameters of the WebRTC session. This procedure is called JavaScript Session Establishment Protocol (JSEP). The server makes a `jsepOffer` to the client, and the client responds with a `jsepAnswer`.
 1. The client issues a `start` request to the µStreamer Janus plugin to indicate that the client wants to begin consuming the video stream.
-1. The µStreamer Janus plugin delivers the H.264 video stream to the client via WebRTC.
-1. The Janus client library invokes the `onremotetrack` callback. The client attaches the video stream to the `<video>` element, rendering the video stream in the browser window.
+1. The µStreamer Janus plugin delivers the H.264 video stream and (optionally) an Opus audio stream to the client via WebRTC.
+1. The Janus client library invokes the `onremotetrack` callback with the video stream. The client attaches the video stream to the `<video>` element, rendering the video stream in the browser window.
+1. (if an audio track is available) The Janus client library invokes the `onremotetrack` callback with the Opus audio stream. The client adds the audio stream to the `<video>` element, rendering the audio in the browser window.
 
 ### Sample Code
 
@@ -176,7 +188,7 @@ The client-side JavaScript application uses the following control flow:
         // successfully.
         success: function (pluginHandle) {
           uStreamerPluginHandle = pluginHandle;
-          // Instruct the µStreamer Janus plugin to initiate the video stream.
+          // Instruct the µStreamer Janus plugin to initiate streaming.
           uStreamerPluginHandle.send({ message: { request: "watch" } });
         },
 
@@ -211,16 +223,17 @@ The client-side JavaScript application uses the following control flow:
           }
         },
 
-        // Callback function, for when the video stream arrives.
+        // Callback function, for when a media stream arrives.
         onremotetrack: function (mediaStreamTrack, mediaId, isAdded) {
           if (isAdded) {
             // Attach the received media track to the video element. Cloning the
             // mediaStreamTrack creates a new object with a distinct, globally
             // unique stream identifier.
             const videoElement = document.getElementById("webrtc-output");
-            const stream = new MediaStream();
-            stream.addTrack(mediaStreamTrack.clone());
-            videoElement.srcObject = stream;
+            if (videoElement.srcObject === null) {
+              videoElement.srcObject = new MediaStream();
+            }
+            videoElement.srcObject.addTrack(mediaStreamTrack.clone());
           }
         },
       });

janus/src/client.c

@@ -102,6 +102,11 @@ static void *_common_thread(void *v_client, bool video) {
 				packet.video = rtp->video;
 				packet.buffer = (char *)rtp->datagram;
 				packet.length = rtp->used;
+#				if JANUS_PLUGIN_API_VERSION >= 100
+				// The uStreamer Janus plugin places video in stream index 0 and audio
+				// (if available) in stream index 1.
+				packet.mindex = (rtp->video ? 0 : 1);
+#				endif
 				janus_plugin_rtp_extensions_reset(&packet.extensions);
 				// FIXME: Это очень эффективный способ уменьшить задержку, но WebRTC стек в хроме и фоксе
 				// слишком корявый, чтобы обработать это, из-за чего на кейфреймах начинаются заикания.

janus/src/logging.h

@@ -32,7 +32,7 @@
 #define US_JLOG_ERROR(x_prefix, x_msg, ...)	JANUS_LOG(LOG_ERR, "== %s/%-9s -- " x_msg "\n", US_PLUGIN_NAME, x_prefix, ##__VA_ARGS__)
 
 #define US_JLOG_PERROR(x_prefix, x_msg, ...) { \
-		char m_perror_buf[1024] = {0}; \
-		char *m_perror_ptr = us_errno_to_string(errno, m_perror_buf, 1023); \
-		JANUS_LOG(LOG_ERR, "[%s/%-9s] " x_msg ": %s\n", US_PLUGIN_NAME, x_prefix, ##__VA_ARGS__, m_perror_ptr); \
+		char *const m_perror_str = us_errno_to_string(errno); \
+		JANUS_LOG(LOG_ERR, "[%s/%-9s] " x_msg ": %s\n", US_PLUGIN_NAME, x_prefix, ##__VA_ARGS__, m_perror_str); \
+		free(m_perror_str); \
 	}

janus/src/memsinkfd.c

@@ -46,12 +46,15 @@ int us_memsink_fd_wait_frame(int fd, us_memsink_shared_s* mem, uint64_t last_id)
 	return -2;
 }
 
-us_frame_s *us_memsink_fd_get_frame(int fd, us_memsink_shared_s *mem, uint64_t *frame_id) {
+us_frame_s *us_memsink_fd_get_frame(int fd, us_memsink_shared_s *mem, uint64_t *frame_id, bool key_required) {
 	us_frame_s *frame = us_frame_init();
 	us_frame_set_data(frame, mem->data, mem->used);
 	US_FRAME_COPY_META(mem, frame);
 	*frame_id = mem->id;
 	mem->last_client_ts = us_get_now_monotonic();
+	if (key_required) {
+		mem->key_requested = true;
+	}
 
 	bool ok = true;
 	if (frame->format != V4L2_PIX_FMT_H264) {

janus/src/memsinkfd.h

@@ -22,6 +22,7 @@
 
 #pragma once
 
+#include <stdbool.h>
 #include <stdint.h>
 #include <unistd.h>
 
@@ -35,4 +36,4 @@
 
 
 int us_memsink_fd_wait_frame(int fd, us_memsink_shared_s* mem, uint64_t last_id);
-us_frame_s *us_memsink_fd_get_frame(int fd, us_memsink_shared_s *mem, uint64_t *frame_id);
+us_frame_s *us_memsink_fd_get_frame(int fd, us_memsink_shared_s *mem, uint64_t *frame_id, bool key_required);

janus/src/plugin.c

@@ -76,6 +76,7 @@ static pthread_mutex_t	_g_audio_lock = PTHREAD_MUTEX_INITIALIZER;
 static atomic_bool		_g_ready = false;
 static atomic_bool		_g_stop = false;
 static atomic_bool		_g_has_watchers = false;
+static atomic_bool		_g_key_required = false;
 
 
 #define _LOCK_VIDEO		US_MUTEX_LOCK(_g_video_lock)
@@ -149,10 +150,13 @@ static void *_video_sink_thread(UNUSED void *arg) {
 		while (!_STOP && _HAS_WATCHERS) {
 			const int result = us_memsink_fd_wait_frame(fd, mem, frame_id);
 			if (result == 0) {
-				us_frame_s *const frame = us_memsink_fd_get_frame(fd, mem, &frame_id);
+				us_frame_s *const frame = us_memsink_fd_get_frame(fd, mem, &frame_id, atomic_load(&_g_key_required));
 				if (frame == NULL) {
 					goto close_memsink;
 				}
+				if (frame->key) {
+					atomic_store(&_g_key_required, false);
+				}
 				if (us_queue_put(_g_video_queue, frame, 0) != 0) {
 					_IF_NOT_REPORTED({ US_JLOG_PERROR("video", "Video queue is full"); });
 					us_frame_destroy(frame);
@@ -250,7 +254,7 @@ static int _plugin_init(janus_callbacks *gw, const char *config_dir_path) {
 	// sysctl -w net.core.rmem_max=1000000 
 	// sysctl -w net.core.wmem_max=1000000
 
-	US_JLOG_INFO("main", "Initializing plugin ...");
+	US_JLOG_INFO("main", "Initializing PiKVM uStreamer plugin %s ...", US_VERSION);
 	if (gw == NULL || config_dir_path == NULL || ((_g_config = us_config_init(config_dir_path)) == NULL)) {
 		return -1;
 	}
@@ -424,10 +428,6 @@ static struct janus_plugin_result *_plugin_handle_message(
 		char *sdp;
 		{
 			char *const video_sdp = us_rtpv_make_sdp(_g_rtpv);
-			if (video_sdp == NULL) {
-				PUSH_ERROR(503, "Haven't received SPS/PPS from memsink yet");
-				goto ok_wait;
-			}
 			char *const audio_sdp = (_g_rtpa ? us_rtpa_make_sdp(_g_rtpa) : us_strdup(""));
 			US_ASPRINTF(sdp,
 				"v=0" RN
@@ -435,7 +435,16 @@ static struct janus_plugin_result *_plugin_handle_message(
 				"s=PiKVM uStreamer" RN
 				"t=0 0" RN
 				"%s%s",
-				us_get_now_id() >> 1, audio_sdp, video_sdp
+				us_get_now_id() >> 1,
+#				if JANUS_PLUGIN_API_VERSION >= 100
+				// Place video SDP before audio SDP so that the video and audio streams
+				// have predictable indices, even if audio is not available.
+				// See also client.c.
+				video_sdp, audio_sdp
+#				else
+				// For versions of Janus prior to 1.x, place the audio SDP first.
+				audio_sdp, video_sdp
+#				endif
 			);
 			free(audio_sdp);
 			free(video_sdp);
@@ -445,6 +454,10 @@ static struct janus_plugin_result *_plugin_handle_message(
 		PUSH_STATUS("started", offer_jsep);
 		json_decref(offer_jsep);
 
+	} else if (!strcmp(request_str, "key_required")) {
+		US_JLOG_INFO("main", "Got keyframe request from a client");
+		atomic_store(&_g_key_required, true);
+
 	} else {
 		PUSH_ERROR(405, "Not implemented");
 	}

janus/src/queue.c

@@ -40,6 +40,9 @@ us_queue_s *us_queue_init(unsigned capacity) {
 }
 
 void us_queue_destroy(us_queue_s *queue) {
+	US_COND_DESTROY(queue->empty_cond);
+	US_COND_DESTROY(queue->full_cond);
+	US_MUTEX_DESTROY(queue->mutex);
 	free(queue->items);
 	free(queue);
 }
@@ -73,7 +76,7 @@ int us_queue_put(us_queue_s *queue, void *item, long double timeout) {
 	++queue->in;
 	queue->in %= queue->capacity;
 	US_MUTEX_UNLOCK(queue->mutex);
-	assert(!pthread_cond_broadcast(&queue->empty_cond));
+	US_COND_BROADCAST(queue->empty_cond);
 	return 0;
 }
 
@@ -85,7 +88,7 @@ int us_queue_get(us_queue_s *queue, void **item, long double timeout) {
 	++queue->out;
 	queue->out %= queue->capacity;
 	US_MUTEX_UNLOCK(queue->mutex);
-	assert(!pthread_cond_broadcast(&queue->full_cond));
+	US_COND_BROADCAST(queue->full_cond);
 	return 0;
 }
 

janus/src/rtpv.c

@@ -36,35 +36,15 @@ us_rtpv_s *us_rtpv_init(us_rtp_callback_f callback, bool zero_playout_delay) {
 	US_CALLOC(rtpv, 1);
 	rtpv->rtp = us_rtp_init(96, true, zero_playout_delay);
 	rtpv->callback = callback;
-	rtpv->sps = us_frame_init();
-	rtpv->pps = us_frame_init();
-	US_MUTEX_INIT(rtpv->mutex);
 	return rtpv;
 }
 
 void us_rtpv_destroy(us_rtpv_s *rtpv) {
-	US_MUTEX_DESTROY(rtpv->mutex);
-	us_frame_destroy(rtpv->pps);
-	us_frame_destroy(rtpv->sps);
 	us_rtp_destroy(rtpv->rtp);
 	free(rtpv);
 }
 
 char *us_rtpv_make_sdp(us_rtpv_s *rtpv) {
-	US_MUTEX_LOCK(rtpv->mutex);
-
-	if (rtpv->sps->used == 0 || rtpv->pps->used == 0) {
-		US_MUTEX_UNLOCK(rtpv->mutex);
-		return NULL;
-	}
-
-	char *sps = NULL;
-	char *pps = NULL;
-	us_base64_encode(rtpv->sps->data, rtpv->sps->used, &sps, NULL);
-	us_base64_encode(rtpv->pps->data, rtpv->pps->used, &pps, NULL);
-
-	US_MUTEX_UNLOCK(rtpv->mutex);
-
 #	define PAYLOAD rtpv->rtp->payload
 	// https://tools.ietf.org/html/rfc6184
 	// https://github.com/meetecho/janus-gateway/issues/2443
@@ -75,8 +55,6 @@ char *us_rtpv_make_sdp(us_rtpv_s *rtpv) {
 		"a=rtpmap:%u H264/90000" RN
 		"a=fmtp:%u profile-level-id=42E01F" RN
 		"a=fmtp:%u packetization-mode=1" RN
-		"a=fmtp:%u sprop-sps=%s" RN
-		"a=fmtp:%u sprop-pps=%s" RN
 		"a=rtcp-fb:%u nack" RN
 		"a=rtcp-fb:%u nack pli" RN
 		"a=rtcp-fb:%u goog-remb" RN
@@ -84,17 +62,12 @@ char *us_rtpv_make_sdp(us_rtpv_s *rtpv) {
 		"%s" // playout-delay
 		"a=sendonly" RN,
 		PAYLOAD, PAYLOAD, PAYLOAD, PAYLOAD,
-		PAYLOAD, sps,
-		PAYLOAD, pps,
 		PAYLOAD, PAYLOAD, PAYLOAD,
 		rtpv->rtp->ssrc,
 		(rtpv->rtp->zero_playout_delay ? "a=extmap:1 http://www.webrtc.org/experiments/rtp-hdrext/playout-delay" RN : "")
 	);
-#	undef PAYLOAD
-
-	free(sps);
-	free(pps);
 	return sdp;
+#	undef PAYLOAD
 }
 
 #define _PRE 3 // Annex B prefix length
@@ -136,22 +109,11 @@ void us_rtpv_wrap(us_rtpv_s *rtpv, const us_frame_s *frame) {
 }
 
 void _rtpv_process_nalu(us_rtpv_s *rtpv, const uint8_t *data, size_t size, uint32_t pts, bool marked) {
+#	define DG rtpv->rtp->datagram
+
 	const unsigned ref_idc = (data[0] >> 5) & 3;
 	const unsigned type = data[0] & 0x1F;
 
-	us_frame_s *ps = NULL;
-	switch (type) {
-		case 7: ps = rtpv->sps; break;
-		case 8: ps = rtpv->pps; break;
-	}
-	if (ps != NULL) {
-		US_MUTEX_LOCK(rtpv->mutex);
-		us_frame_set_data(ps, data, size);
-		US_MUTEX_UNLOCK(rtpv->mutex);
-	}
-
-#	define DG rtpv->rtp->datagram
-
 	if (size + US_RTP_HEADER_SIZE <= US_RTP_DATAGRAM_SIZE) {
 		us_rtp_write_header(rtpv->rtp, pts, marked);
 		memcpy(DG + US_RTP_HEADER_SIZE, data, size);

janus/src/rtpv.h

@@ -31,12 +31,8 @@
 #include <sys/types.h>
 #include <linux/videodev2.h>
 
-#include <pthread.h>
-
 #include "uslibs/tools.h"
-#include "uslibs/threading.h"
 #include "uslibs/frame.h"
-#include "uslibs/base64.h"
 
 #include "rtp.h"
 
@@ -44,9 +40,6 @@
 typedef struct {
 	us_rtp_s			*rtp;
 	us_rtp_callback_f	callback;
-	us_frame_s			*sps; // Actually not a frame, just a bytes storage
-	us_frame_s			*pps;
-	pthread_mutex_t		mutex;
 } us_rtpv_s;
 
 

janus/src/uslibs/base64.c

@@ -1 +0,0 @@
-../../../src/libs/base64.c

janus/src/uslibs/base64.h

@@ -1 +0,0 @@
-../../../src/libs/base64.h

linters/Dockerfile

@@ -3,7 +3,7 @@ FROM archlinux/archlinux:base-devel
 RUN mkdir -p /etc/pacman.d/hooks \
 	&& ln -s /dev/null /etc/pacman.d/hooks/30-systemd-tmpfiles.hook
 
-RUN echo "Server = http://mirror.yandex.ru/archlinux/\$repo/os/\$arch" > /etc/pacman.d/mirrorlist
+RUN echo 'Server = https://mirror.rackspace.com/archlinux/$repo/os/$arch' > /etc/pacman.d/mirrorlist
 
 RUN pacman -Syu --noconfirm \
 	&& pacman -S --needed --noconfirm \

man/ustreamer-dump.1

@@ -1,6 +1,6 @@
 .\" Manpage for ustreamer-dump.
 .\" Open an issue or pull request to https://github.com/pikvm/ustreamer to correct errors or typos
-.TH USTREAMER-DUMP 1 "version 5.17" "January 2021"
+.TH USTREAMER-DUMP 1 "version 5.29" "January 2021"
 
 .SH NAME
 ustreamer-dump \- Dump uStreamer's memory sink to file
@@ -44,6 +44,9 @@ Limit the number of frames. Default: 0 (infinite).
 .TP
 .BR \-i ", "\-\-interval\ \fIsec
 Delay between reading frames (float). Default: 0.
+.TP
+.BR \-k ", " \-\-key\-required
+Request keyframe from the sink. Default: disabled.
 
 .SS "Logging options"
 .TP

man/ustreamer.1

@@ -1,6 +1,6 @@
 .\" Manpage for ustreamer.
 .\" Open an issue or pull request to https://github.com/pikvm/ustreamer to correct errors or typos
-.TH USTREAMER 1 "version 5.17" "November 2020"
+.TH USTREAMER 1 "version 5.29" "November 2020"
 
 .SH NAME
 ustreamer \- stream MJPEG video from any V4L2 device to the network
@@ -10,7 +10,7 @@ ustreamer \- stream MJPEG video from any V4L2 device to the network
 .RI [OPTIONS]
 
 .SH DESCRIPTION
-µStreamer (\fBustreamer\fP) is a lightweight and very quick server to stream MJPEG video from any V4L2 device to the network. All new browsers have native support of this video format, as well as most video players such as mplayer, VLC etc. µStreamer is a part of the Pi-KVM project designed to stream VGA and HDMI screencast hardware data with the highest resolution and FPS possible.
+µStreamer (\fBustreamer\fP) is a lightweight and very quick server to stream MJPEG video from any V4L2 device to the network. All new browsers have native support of this video format, as well as most video players such as mplayer, VLC etc. µStreamer is a part of the PiKVM project designed to stream VGA and HDMI screencast hardware data with the highest resolution and FPS possible.
 
 .SH USAGE
 Without arguments, \fBustreamer\fR will try to open \fB/dev/video0\fR with 640x480 resolution and start streaming on \fBhttp://127\.0\.0\.1:8080\fR\. You can override this behavior using parameters \fB\-\-device\fR, \fB\-\-host\fR and \fB\-\-port\fR\. For example, to stream to the world, run: \fBustreamer --device=/dev/video1 --host=0.0.0.0 --port=80\fR
@@ -203,6 +203,9 @@ Default: disabled.
 .BR \-\-allow\-origin\ \fIstr
 Set Access\-Control\-Allow\-Origin header. Default: disabled.
 .TP
+.BR \-\-instance\-id\ \fIstr
+A short string identifier to be displayed in the /state handle. It must satisfy regexp ^[a-zA-Z0-9\./+_-]*$. Default: an empty string.
+.TP
 .BR \-\-server\-timeout\ \fIsec
 Timeout for client connections. Default: 10.
 

pkg/arch/PKGBUILD

@@ -3,7 +3,7 @@
 
 
 pkgname=ustreamer
-pkgver=5.17
+pkgver=5.29
 pkgrel=1
 pkgdesc="Lightweight and fast MJPEG-HTTP streamer"
 url="https://github.com/pikvm/ustreamer"
@@ -22,8 +22,8 @@ if [ -e /usr/bin/python3 ]; then
 	makedepends+=(python-setuptools)
 fi
 if [ -e /usr/include/janus/plugins/plugin.h ];then
-	depends+=(janus-gateway-pikvm alsa-lib opus)
-	makedepends+=(janus-gateway-pikvm alsa-lib opus)
+	depends+=(janus-gateway alsa-lib opus)
+	makedepends+=(janus-gateway alsa-lib opus)
 	_options="$_options WITH_JANUS=1"
 fi
 

pkg/docker/Dockerfile.alpine

@@ -0,0 +1,34 @@
+FROM alpine:3.16 as build
+RUN apk add --no-cache \
+		alpine-sdk \
+		linux-headers \
+		libjpeg-turbo-dev \
+		libevent-dev \
+		libbsd-dev \
+		libgpiod-dev
+
+WORKDIR /build/ustreamer/
+COPY . .
+RUN make -j5 WITH_GPIO=1
+
+FROM alpine:3.16 as run
+
+RUN apk add --no-cache \
+		libevent \
+		libjpeg-turbo \
+		libevent \
+		libgpiod \
+		libbsd \
+		v4l-utils
+
+WORKDIR /ustreamer
+COPY --from=build /build/ustreamer/src/ustreamer.bin ustreamer
+
+RUN wget https://raw.githubusercontent.com/pikvm/kvmd/master/configs/kvmd/tc358743-edid.hex -O /edid.hex
+COPY pkg/docker/entry.sh /
+
+EXPOSE 8080
+ENTRYPOINT ["/entry.sh"]
+CMD ["--dv-timings", "--format", "UYVY"]
+
+# vim: syntax=dockerfile

pkg/docker/entry.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -e
+
+[ -n "$EDID" ] && {
+	[ -n "$EDID_HEX" ] && echo "$EDID_HEX" > /edid.hex
+	while true; do
+		v4l2-ctl --device=/dev/video0 --set-edid=file=/edid.hex --fix-edid-checksums --info-edid && break
+		echo 'Failed to set EDID. Reetrying...'
+		sleep 1
+	done
+}
+
+./ustreamer --host=0.0.0.0 $@

pkg/openwrt/Makefile

@@ -6,7 +6,7 @@
 include $(TOPDIR)/rules.mk
 
 PKG_NAME:=ustreamer
-PKG_VERSION:=5.17
+PKG_VERSION:=5.29
 PKG_RELEASE:=1
 PKG_MAINTAINER:=Maxim Devaev <mdevaev@gmail.com>
 

python/setup.py

@@ -1,14 +1,12 @@
 import os
 
-from typing import List
-
 from setuptools import Extension
 from setuptools import setup
 
 
 # =====
-def _find_sources(suffix: str) -> List[str]:
-    sources: List[str] = []
+def _find_sources(suffix: str) -> list[str]:
+    sources: list[str] = []
     for (root_path, _, names) in os.walk("src"):
         for name in names:
             if name.endswith(suffix):
@@ -19,7 +17,7 @@ def _find_sources(suffix: str) -> List[str]:
 if __name__ == "__main__":
     setup(
         name="ustreamer",
-        version="5.17",
+        version="5.29",
         description="uStreamer tools",
         author="Maxim Devaev",
         author_email="mdevaev@gmail.com",

python/src/ustreamer.c

@@ -181,12 +181,18 @@ static int _wait_frame(_MemsinkObject *self) {
 	return -2;
 }
 
-static PyObject *_MemsinkObject_wait_frame(_MemsinkObject *self, PyObject *Py_UNUSED(ignored)) {
+static PyObject *_MemsinkObject_wait_frame(_MemsinkObject *self, PyObject *args, PyObject *kwargs) {
 	if (self->mem == NULL || self->fd <= 0) {
 		PyErr_SetString(PyExc_RuntimeError, "Closed");
 		return NULL;
 	}
 
+	bool key_required = false;
+	static char *kws[] = {"key_required", NULL};
+	if (!PyArg_ParseTupleAndKeywords(args, kwargs, "|p", kws, &key_required)) {
+		return NULL;
+	}
+
 	switch (_wait_frame(self)) {
 		case 0: break;
 		case -2: Py_RETURN_NONE;
@@ -198,6 +204,9 @@ static PyObject *_MemsinkObject_wait_frame(_MemsinkObject *self, PyObject *Py_UN
 	self->frame_id = _MEM(id);
 	self->frame_ts = us_get_now_monotonic();
 	_MEM(last_client_ts) = self->frame_ts;
+	if (key_required) {
+		_MEM(key_requested) = true;
+	}
 
 	if (flock(self->fd, LOCK_UN) < 0) {
 		return PyErr_SetFromErrno(PyExc_OSError);
@@ -260,7 +269,7 @@ static PyMethodDef _MemsinkObject_methods[] = {
 	ADD_METHOD("close", close, METH_NOARGS),
 	ADD_METHOD("__enter__", enter, METH_NOARGS),
 	ADD_METHOD("__exit__", exit, METH_VARARGS),
-	ADD_METHOD("wait_frame", wait_frame, METH_NOARGS),
+	ADD_METHOD("wait_frame", wait_frame, METH_VARARGS | METH_KEYWORDS),
 	ADD_METHOD("is_opened", is_opened, METH_NOARGS),
 	{},
 #	undef ADD_METHOD

src/dump/file.c

@@ -52,11 +52,11 @@ void us_output_file_write(void *v_output, const us_frame_s *frame) {
 		us_base64_encode(frame->data, frame->used, &output->base64_data, &output->base64_allocated);
 		fprintf(output->fp,
 			"{\"size\": %zu, \"width\": %u, \"height\": %u,"
-			" \"format\": %u, \"stride\": %u, \"online\": %u,"
+			" \"format\": %u, \"stride\": %u, \"online\": %u, \"key\": %u,"
 			" \"grab_ts\": %.3Lf, \"encode_begin_ts\": %.3Lf, \"encode_end_ts\": %.3Lf,"
 			" \"data\": \"%s\"}\n",
 			frame->used, frame->width, frame->height,
-			frame->format, frame->stride, frame->online,
+			frame->format, frame->stride, frame->online, frame->key,
 			frame->grab_ts, frame->encode_begin_ts, frame->encode_end_ts,
 			output->base64_data);
 	} else {

src/dump/main.c

@@ -48,6 +48,7 @@ enum _OPT_VALUES {
 	_O_OUTPUT_JSON = 'j',
 	_O_COUNT = 'c',
 	_O_INTERVAL = 'i',
+	_O_KEY_REQUIRED = 'k',
 
 	_O_HELP = 'h',
 	_O_VERSION = 'v',
@@ -67,6 +68,7 @@ static const struct option _LONG_OPTS[] = {
 	{"output-json",			no_argument,		NULL,	_O_OUTPUT_JSON},
 	{"count",				required_argument,	NULL,	_O_COUNT},
 	{"interval",			required_argument,	NULL,	_O_INTERVAL},
+	{"key-required",		no_argument,		NULL,	_O_KEY_REQUIRED},
 
 	{"log-level",			required_argument,	NULL,	_O_LOG_LEVEL},
 	{"perf",				no_argument,		NULL,	_O_PERF},
@@ -98,6 +100,7 @@ static void _install_signal_handlers(void);
 static int _dump_sink(
 	const char *sink_name, unsigned sink_timeout,
 	long long count, long double interval,
+	bool key_required,
 	_output_context_s *ctx);
 
 static void _help(FILE *fp);
@@ -113,6 +116,7 @@ int main(int argc, char *argv[]) {
 	bool output_json = false;
 	long long count = 0;
 	long double interval = 0;
+	bool key_required = false;
 
 #	define OPT_SET(_dest, _value) { \
 			_dest = _value; \
@@ -150,13 +154,14 @@ int main(int argc, char *argv[]) {
 			case _O_OUTPUT_JSON:	OPT_SET(output_json, true);
 			case _O_COUNT:			OPT_NUMBER("--count", count, 0, LLONG_MAX, 0);
 			case _O_INTERVAL:		OPT_LDOUBLE("--interval", interval, 0, 60);
+			case _O_KEY_REQUIRED:	OPT_SET(key_required, true);
 
-			case _O_LOG_LEVEL:			OPT_NUMBER("--log-level", us_log_level, US_LOG_LEVEL_INFO, US_LOG_LEVEL_DEBUG, 0);
-			case _O_PERF:				OPT_SET(us_log_level, US_LOG_LEVEL_PERF);
-			case _O_VERBOSE:			OPT_SET(us_log_level, US_LOG_LEVEL_VERBOSE);
-			case _O_DEBUG:				OPT_SET(us_log_level, US_LOG_LEVEL_DEBUG);
-			case _O_FORCE_LOG_COLORS:	OPT_SET(us_log_colored, true);
-			case _O_NO_LOG_COLORS:		OPT_SET(us_log_colored, false);
+			case _O_LOG_LEVEL:			OPT_NUMBER("--log-level", us_g_log_level, US_LOG_LEVEL_INFO, US_LOG_LEVEL_DEBUG, 0);
+			case _O_PERF:				OPT_SET(us_g_log_level, US_LOG_LEVEL_PERF);
+			case _O_VERBOSE:			OPT_SET(us_g_log_level, US_LOG_LEVEL_VERBOSE);
+			case _O_DEBUG:				OPT_SET(us_g_log_level, US_LOG_LEVEL_DEBUG);
+			case _O_FORCE_LOG_COLORS:	OPT_SET(us_g_log_colored, true);
+			case _O_NO_LOG_COLORS:		OPT_SET(us_g_log_colored, false);
 
 			case _O_HELP:		_help(stdout); return 0;
 			case _O_VERSION:	puts(US_VERSION); return 0;
@@ -186,7 +191,7 @@ int main(int argc, char *argv[]) {
 	}
 
 	_install_signal_handlers();
-	const int retval = abs(_dump_sink(sink_name, sink_timeout, count, interval, &ctx));
+	const int retval = abs(_dump_sink(sink_name, sink_timeout, count, interval, key_required, &ctx));
 	if (ctx.v_output && ctx.destroy) {
 		ctx.destroy(ctx.v_output);
 	}
@@ -195,12 +200,9 @@ int main(int argc, char *argv[]) {
 
 
 static void _signal_handler(int signum) {
-	switch (signum) {
-		case SIGTERM:	US_LOG_INFO_NOLOCK("===== Stopping by SIGTERM ====="); break;
-		case SIGINT:	US_LOG_INFO_NOLOCK("===== Stopping by SIGINT ====="); break;
-		case SIGPIPE:	US_LOG_INFO_NOLOCK("===== Stopping by SIGPIPE ====="); break;
-		default:		US_LOG_INFO_NOLOCK("===== Stopping by %d =====", signum); break;
-	}
+	char *const name = us_signum_to_string(signum);
+	US_LOG_INFO_NOLOCK("===== Stopping by %s =====", name);
+	free(name);
 	_g_stop = true;
 }
 
@@ -226,6 +228,7 @@ static void _install_signal_handlers(void) {
 static int _dump_sink(
 	const char *sink_name, unsigned sink_timeout,
 	long long count, long double interval,
+	bool key_required,
 	_output_context_s *ctx) {
 
 	if (count == 0) {
@@ -248,17 +251,21 @@ static int _dump_sink(
 	long double last_ts = 0;
 
 	while (!_g_stop) {
-		int error = us_memsink_client_get(sink, frame);
+		bool key_requested;
+		const int error = us_memsink_client_get(sink, frame, &key_requested, key_required);
 		if (error == 0) {
+			key_required = false;
+
 			const long double now = us_get_now_monotonic();
 			const long long now_second = us_floor_ms(now);
 
 			char fourcc_str[8];
-			US_LOG_VERBOSE("Frame: size=%zu, res=%ux%u, fourcc=%s, stride=%u, online=%d, key=%d, latency=%.3Lf, diff=%.3Lf",
-				frame->used, frame->width, frame->height,
+			US_LOG_VERBOSE("Frame: res=%ux%u, fmt=%s, stride=%u, online=%d, key=%d, kr=%d, latency=%.3Lf, diff=%.3Lf, size=%zu",
+				frame->width, frame->height,
 				us_fourcc_to_string(frame->format, fourcc_str, 8),
-				frame->stride, frame->online, frame->key,
-				now - frame->grab_ts, (last_ts ? now - last_ts : 0));
+				frame->stride, frame->online, frame->key, key_requested,
+				now - frame->grab_ts, (last_ts ? now - last_ts : 0),
+				frame->used);
 			last_ts = now;
 
 			US_LOG_DEBUG("       grab_ts=%.3Lf, encode_begin_ts=%.3Lf, encode_end_ts=%.3Lf",
@@ -325,12 +332,13 @@ static void _help(FILE *fp) {
 	SAY("    -j|--output-json  ──────── Format output as JSON. Required option --output. Default: disabled.\n");
 	SAY("    -c|--count  <N>  ───────── Limit the number of frames. Default: 0 (infinite).\n");
 	SAY("    -i|--interval <sec>  ───── Delay between reading frames (float). Default: 0.\n");
+	SAY("    -k|--key-required  ─────── Request keyframe from the sink. Default: disabled.\n");
 	SAY("Logging options:");
 	SAY("════════════════");
 	SAY("    --log-level <N>  ──── Verbosity level of messages from 0 (info) to 3 (debug).");
 	SAY("                          Enabling debugging messages can slow down the program.");
 	SAY("                          Available levels: 0 (info), 1 (performance), 2 (verbose), 3 (debug).");
-	SAY("                          Default: %d.\n", us_log_level);
+	SAY("                          Default: %d.\n", us_g_log_level);
 	SAY("    --perf  ───────────── Enable performance messages (same as --log-level=1). Default: disabled.\n");
 	SAY("    --verbose  ────────── Enable verbose messages and lower (same as --log-level=2). Default: disabled.\n");
 	SAY("    --debug  ──────────── Enable debug messages and lower (same as --log-level=3). Default: disabled.\n");

src/libs/const.h

@@ -23,7 +23,7 @@
 #pragma once
 
 #define US_VERSION_MAJOR 5
-#define US_VERSION_MINOR 17
+#define US_VERSION_MINOR 29
 
 #define US_MAKE_VERSION2(_major, _minor) #_major "." #_minor
 #define US_MAKE_VERSION1(_major, _minor) US_MAKE_VERSION2(_major, _minor)

src/libs/logging.c

@@ -23,8 +23,8 @@
 #include "logging.h"
 
 
-enum us_log_level_t us_log_level;
+enum us_log_level_t us_g_log_level;
 
-bool us_log_colored;
+bool us_g_log_colored;
 
-pthread_mutex_t us_log_mutex;
+pthread_mutex_t us_g_log_mutex;

src/libs/logging.h

@@ -45,23 +45,23 @@ enum us_log_level_t {
 };
 
 
-extern enum us_log_level_t us_log_level;
+extern enum us_log_level_t us_g_log_level;
 
-extern bool us_log_colored;
+extern bool us_g_log_colored;
 
-extern pthread_mutex_t us_log_mutex;
+extern pthread_mutex_t us_g_log_mutex;
 
 
 #define US_LOGGING_INIT { \
-		us_log_level = US_LOG_LEVEL_INFO; \
-		us_log_colored = isatty(2); \
-		US_MUTEX_INIT(us_log_mutex); \
+		us_g_log_level = US_LOG_LEVEL_INFO; \
+		us_g_log_colored = isatty(2); \
+		US_MUTEX_INIT(us_g_log_mutex); \
 	}
 
-#define US_LOGGING_DESTROY	US_MUTEX_DESTROY(us_log_mutex)
+#define US_LOGGING_DESTROY	US_MUTEX_DESTROY(us_g_log_mutex)
 
-#define US_LOGGING_LOCK		US_MUTEX_LOCK(us_log_mutex)
-#define US_LOGGING_UNLOCK	US_MUTEX_UNLOCK(us_log_mutex)
+#define US_LOGGING_LOCK		US_MUTEX_LOCK(us_g_log_mutex)
+#define US_LOGGING_UNLOCK	US_MUTEX_UNLOCK(us_g_log_mutex)
 
 
 #define US_COLOR_GRAY		"\x1b[30;1m"
@@ -84,7 +84,7 @@ extern pthread_mutex_t us_log_mutex;
 	}
 
 #define US_SEP_DEBUG(x_ch) { \
-		if (us_log_level >= US_LOG_LEVEL_DEBUG) { \
+		if (us_g_log_level >= US_LOG_LEVEL_DEBUG) { \
 			US_SEP_INFO(x_ch); \
 		} \
 	}
@@ -93,7 +93,7 @@ extern pthread_mutex_t us_log_mutex;
 #define US_LOG_PRINTF_NOLOCK(x_label_color, x_label, x_msg_color, x_msg, ...) { \
 		char m_tname_buf[US_MAX_THREAD_NAME] = {0}; \
 		us_thread_get_name(m_tname_buf); \
-		if (us_log_colored) { \
+		if (us_g_log_colored) { \
 			fprintf(stderr, US_COLOR_GRAY "-- " x_label_color x_label US_COLOR_GRAY \
 				" [%.03Lf %9s]" " -- " US_COLOR_RESET x_msg_color x_msg US_COLOR_RESET, \
 				us_get_now_monotonic(), m_tname_buf, ##__VA_ARGS__); \
@@ -116,9 +116,9 @@ extern pthread_mutex_t us_log_mutex;
 	}
 
 #define US_LOG_PERROR(x_msg, ...) { \
-		char m_perror_buf[1024] = {0}; \
-		char *m_perror_ptr = us_errno_to_string(errno, m_perror_buf, 1024); \
-		US_LOG_ERROR(x_msg ": %s", ##__VA_ARGS__, m_perror_ptr); \
+		char *const m_perror_str = us_errno_to_string(errno); \
+		US_LOG_ERROR(x_msg ": %s", ##__VA_ARGS__, m_perror_str); \
+		free(m_perror_str); \
 	}
 
 #define US_LOG_INFO(x_msg, ...) { \
@@ -130,33 +130,33 @@ extern pthread_mutex_t us_log_mutex;
 	}
 
 #define US_LOG_PERF(x_msg, ...) { \
-		if (us_log_level >= US_LOG_LEVEL_PERF) { \
+		if (us_g_log_level >= US_LOG_LEVEL_PERF) { \
 			US_LOG_PRINTF(US_COLOR_CYAN, "PERF ", US_COLOR_CYAN, x_msg, ##__VA_ARGS__); \
 		} \
 	}
 
 #define US_LOG_PERF_FPS(x_msg, ...) { \
-		if (us_log_level >= US_LOG_LEVEL_PERF) { \
+		if (us_g_log_level >= US_LOG_LEVEL_PERF) { \
 			US_LOG_PRINTF(US_COLOR_YELLOW, "PERF ", US_COLOR_YELLOW, x_msg, ##__VA_ARGS__); \
 		} \
 	}
 
 #define US_LOG_VERBOSE(x_msg, ...) { \
-		if (us_log_level >= US_LOG_LEVEL_VERBOSE) { \
+		if (us_g_log_level >= US_LOG_LEVEL_VERBOSE) { \
 			US_LOG_PRINTF(US_COLOR_BLUE, "VERB ", US_COLOR_BLUE, x_msg, ##__VA_ARGS__); \
 		} \
 	}
 
 #define US_LOG_VERBOSE_PERROR(x_msg, ...) { \
-		if (us_log_level >= US_LOG_LEVEL_VERBOSE) { \
-			char m_perror_buf[1024] = {0}; \
-			char *m_perror_ptr = us_errno_to_string(errno, m_perror_buf, 1023); \
-			US_LOG_PRINTF(US_COLOR_BLUE, "VERB ", US_COLOR_BLUE, x_msg ": %s", ##__VA_ARGS__, m_perror_ptr); \
+		if (us_g_log_level >= US_LOG_LEVEL_VERBOSE) { \
+			char *m_perror_str = us_errno_to_string(errno); \
+			US_LOG_PRINTF(US_COLOR_BLUE, "VERB ", US_COLOR_BLUE, x_msg ": %s", ##__VA_ARGS__, m_perror_str); \
+			free(m_perror_str); \
 		} \
 	}
 
 #define US_LOG_DEBUG(x_msg, ...) { \
-		if (us_log_level >= US_LOG_LEVEL_DEBUG) { \
+		if (us_g_log_level >= US_LOG_LEVEL_DEBUG) { \
 			US_LOG_PRINTF(US_COLOR_GRAY, "DEBUG", US_COLOR_GRAY, x_msg, ##__VA_ARGS__); \
 		} \
 	}

src/libs/memsink.c

@@ -117,7 +117,7 @@ bool us_memsink_server_check(us_memsink_s *sink, const us_frame_s *frame) {
 	return (has_clients || !US_FRAME_COMPARE_META_USED_NOTS(sink->mem, frame));;
 }
 
-int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame) {
+int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame, bool *const key_requested) {
 	assert(sink->server);
 
 	const long double now = us_get_now_monotonic();
@@ -133,6 +133,10 @@ int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame) {
 
 		sink->last_id = us_get_now_id();
 		sink->mem->id = sink->last_id;
+		if (sink->mem->key_requested && frame->key) {
+			sink->mem->key_requested = false;
+		}
+		*key_requested = sink->mem->key_requested;
 
 		memcpy(sink->mem->data, frame->data, frame->used);
 		sink->mem->used = frame->used;
@@ -140,6 +144,7 @@ int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame) {
 
 		sink->mem->magic = US_MEMSINK_MAGIC;
 		sink->mem->version = US_MEMSINK_VERSION;
+
 		atomic_store(&sink->has_clients, (sink->mem->last_client_ts + sink->client_ttl > us_get_now_monotonic()));
 
 		if (flock(sink->fd, LOCK_UN) < 0) {
@@ -159,7 +164,7 @@ int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame) {
 	return 0;
 }
 
-int us_memsink_client_get(us_memsink_s *sink, us_frame_s *frame) { // cppcheck-suppress unusedFunction
+int us_memsink_client_get(us_memsink_s *sink, us_frame_s *frame, bool *const key_requested, bool key_required) { // cppcheck-suppress unusedFunction
 	assert(!sink->server); // Client only
 
 	if (us_flock_timedwait_monotonic(sink->fd, sink->timeout) < 0) {
@@ -182,9 +187,13 @@ int us_memsink_client_get(us_memsink_s *sink, us_frame_s *frame) { // cppcheck-s
 			sink->last_id = sink->mem->id;
 			us_frame_set_data(frame, sink->mem->data, sink->mem->used);
 			US_FRAME_COPY_META(sink->mem, frame);
+			*key_requested = sink->mem->key_requested;
 			retval = 0;
 		}
 		sink->mem->last_client_ts = us_get_now_monotonic();
+		if (key_required) {
+			sink->mem->key_requested = true;
+		}
 	}
 
 	done:

src/libs/memsink.h

@@ -63,6 +63,6 @@ us_memsink_s *us_memsink_init(
 void us_memsink_destroy(us_memsink_s *sink);
 
 bool us_memsink_server_check(us_memsink_s *sink, const us_frame_s *frame);
-int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame);
+int us_memsink_server_put(us_memsink_s *sink, const us_frame_s *frame, bool *const key_requested);
 
-int us_memsink_client_get(us_memsink_s *sink, us_frame_s *frame);
+int us_memsink_client_get(us_memsink_s *sink, us_frame_s *frame, bool *const key_requested, bool key_required);

src/libs/memsinksh.h

@@ -30,7 +30,7 @@
 
 
 #define US_MEMSINK_MAGIC	((uint64_t)0xCAFEBABECAFEBABE)
-#define US_MEMSINK_VERSION	((uint32_t)2)
+#define US_MEMSINK_VERSION	((uint32_t)3)
 
 #ifndef US_CFG_MEMSINK_MAX_DATA
 #	define US_CFG_MEMSINK_MAX_DATA 33554432
@@ -57,6 +57,7 @@ typedef struct {
 	long double	encode_end_ts;
 
 	long double	last_client_ts;
+	bool		key_requested;
 
 	uint8_t		data[US_MEMSINK_MAX_DATA];
 } us_memsink_shared_s;

src/libs/threading.h

@@ -67,7 +67,8 @@
 #define US_COND_INIT(x_cond)		assert(!pthread_cond_init(&(x_cond), NULL))
 #define US_COND_DESTROY(x_cond)		assert(!pthread_cond_destroy(&(x_cond)))
 #define US_COND_SIGNAL(x_cond)		assert(!pthread_cond_signal(&(x_cond)))
-#define US_COND_WAIT_TRUE(x_var, x_cond, x_mutex) { while(!(x_var)) assert(!pthread_cond_wait(&(x_cond), &(x_mutex))); }
+#define US_COND_BROADCAST(x_cond)	assert(!pthread_cond_broadcast(&(x_cond)))
+#define US_COND_WAIT_FOR(x_var, x_cond, x_mutex) { while(!(x_var)) assert(!pthread_cond_wait(&(x_cond), &(x_mutex))); }
 
 
 #ifdef WITH_PTHREAD_NP

src/libs/tools.h

@@ -38,6 +38,12 @@
 #include <sys/types.h>
 #include <sys/file.h>
 
+#if defined(__GLIBC__) && __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 32
+#	define HAS_SIGABBREV_NP
+#else
+#	include <signal.h>
+#endif
+
 
 #ifdef NDEBUG
 #	error WTF dude? Asserts are good things!
@@ -181,15 +187,34 @@ INLINE int us_flock_timedwait_monotonic(int fd, long double timeout) {
 	return retval;
 }
 
-INLINE char *us_errno_to_string(int error, char *buf, size_t size) {
-	assert(buf != NULL);
-	assert(size > 0);
+INLINE char *us_errno_to_string(int error) {
 	locale_t locale = newlocale(LC_MESSAGES_MASK, "C", NULL);
-	const char *str = "!!! newlocale() error !!!";
-	strncpy(buf, (locale ? strerror_l(error, locale) : str), size - 1);
-	buf[size - 1] = '\0';
+	char *buf;
 	if (locale) {
+		buf = us_strdup(strerror_l(error, locale));
 		freelocale(locale);
+	} else {
+		buf = us_strdup("!!! newlocale() error !!!");
+	}
+	return buf;
+}
+
+INLINE char *us_signum_to_string(int signum) {
+#	ifdef HAS_SIGABBREV_NP
+	const char *const name = sigabbrev_np(signum);
+#	else
+	const char *const name = (
+		signum == SIGTERM ? "TERM" :
+		signum == SIGINT ? "INT" :
+		signum == SIGPIPE ? "PIPE" :
+		NULL
+	);
+#	endif
+	char *buf;
+	if (name != NULL) {
+		US_ASPRINTF(buf, "SIG%s", name);
+	} else {
+		US_ASPRINTF(buf, "SIG[%d]", signum);
 	}
 	return buf;
 }

src/ustreamer/gpio/gpio.c

@@ -23,7 +23,7 @@
 #include "gpio.h"
 
 
-us_gpio_s us_gpio = {
+us_gpio_s us_g_gpio = {
 	.path = "/dev/gpiochip0",
 	.consumer_prefix = "ustreamer",
 
@@ -51,42 +51,42 @@ static void _gpio_output_destroy(us_gpio_output_s *output);
 
 
 void us_gpio_init(void) {
-	assert(us_gpio.chip == NULL);
+	assert(us_g_gpio.chip == NULL);
 	if (
-		us_gpio.prog_running.pin >= 0
-		|| us_gpio.stream_online.pin >= 0
-		|| us_gpio.has_http_clients.pin >= 0
+		us_g_gpio.prog_running.pin >= 0
+		|| us_g_gpio.stream_online.pin >= 0
+		|| us_g_gpio.has_http_clients.pin >= 0
 	) {
-		US_MUTEX_INIT(us_gpio.mutex);
-		US_LOG_INFO("GPIO: Using chip device: %s", us_gpio.path);
-		if ((us_gpio.chip = gpiod_chip_open(us_gpio.path)) != NULL) {
-			_gpio_output_init(&us_gpio.prog_running);
-			_gpio_output_init(&us_gpio.stream_online);
-			_gpio_output_init(&us_gpio.has_http_clients);
+		US_MUTEX_INIT(us_g_gpio.mutex);
+		US_LOG_INFO("GPIO: Using chip device: %s", us_g_gpio.path);
+		if ((us_g_gpio.chip = gpiod_chip_open(us_g_gpio.path)) != NULL) {
+			_gpio_output_init(&us_g_gpio.prog_running);
+			_gpio_output_init(&us_g_gpio.stream_online);
+			_gpio_output_init(&us_g_gpio.has_http_clients);
 		} else {
-			US_LOG_PERROR("GPIO: Can't initialize chip device %s", us_gpio.path);
+			US_LOG_PERROR("GPIO: Can't initialize chip device %s", us_g_gpio.path);
 		}
 	}
 }
 
 void us_gpio_destroy(void) {
-	_gpio_output_destroy(&us_gpio.prog_running);
-	_gpio_output_destroy(&us_gpio.stream_online);
-	_gpio_output_destroy(&us_gpio.has_http_clients);
-	if (us_gpio.chip != NULL) {
-		gpiod_chip_close(us_gpio.chip);
-		us_gpio.chip = NULL;
-		US_MUTEX_DESTROY(us_gpio.mutex);
+	_gpio_output_destroy(&us_g_gpio.prog_running);
+	_gpio_output_destroy(&us_g_gpio.stream_online);
+	_gpio_output_destroy(&us_g_gpio.has_http_clients);
+	if (us_g_gpio.chip != NULL) {
+		gpiod_chip_close(us_g_gpio.chip);
+		us_g_gpio.chip = NULL;
+		US_MUTEX_DESTROY(us_g_gpio.mutex);
 	}
 }
 
 int us_gpio_inner_set(us_gpio_output_s *output, bool state) {
 	int retval = 0;
 
-	assert(us_gpio.chip != NULL);
+	assert(us_g_gpio.chip != NULL);
 	assert(output->line != NULL);
 	assert(output->state != state); // Must be checked in macro for the performance
-	US_MUTEX_LOCK(us_gpio.mutex);
+	US_MUTEX_LOCK(us_g_gpio.mutex);
 
 	if (gpiod_line_set_value(output->line, (int)state) < 0) { \
 		US_LOG_PERROR("GPIO: Can't write value %d to line %s (will be disabled)", state, output->consumer); \
@@ -94,18 +94,18 @@ int us_gpio_inner_set(us_gpio_output_s *output, bool state) {
 		retval = -1;
 	}
 
-	US_MUTEX_UNLOCK(us_gpio.mutex);
+	US_MUTEX_UNLOCK(us_g_gpio.mutex);
 	return retval;
 }
 
 static void _gpio_output_init(us_gpio_output_s *output) {
-	assert(us_gpio.chip != NULL);
+	assert(us_g_gpio.chip != NULL);
 	assert(output->line == NULL);
 
-	US_ASPRINTF(output->consumer, "%s::%s", us_gpio.consumer_prefix, output->role);
+	US_ASPRINTF(output->consumer, "%s::%s", us_g_gpio.consumer_prefix, output->role);
 
 	if (output->pin >= 0) {
-		if ((output->line = gpiod_chip_get_line(us_gpio.chip, output->pin)) != NULL) {
+		if ((output->line = gpiod_chip_get_line(us_g_gpio.chip, output->pin)) != NULL) {
 			if (gpiod_line_request_output(output->line, output->consumer, 0) < 0) {
 				US_LOG_PERROR("GPIO: Can't request pin=%d as %s", output->pin, output->consumer);
 				_gpio_output_destroy(output);

src/ustreamer/gpio/gpio.h

@@ -56,7 +56,7 @@ typedef struct {
 } us_gpio_s;
 
 
-extern us_gpio_s us_gpio;
+extern us_gpio_s us_g_gpio;
 
 
 void us_gpio_init(void);
@@ -73,15 +73,15 @@ int us_gpio_inner_set(us_gpio_output_s *output, bool state);
 	}
 
 INLINE void us_gpio_set_prog_running(bool state) {
-	SET_STATE(us_gpio.prog_running, state);
+	SET_STATE(us_g_gpio.prog_running, state);
 }
 
 INLINE void us_gpio_set_stream_online(bool state) {
-	SET_STATE(us_gpio.stream_online, state);
+	SET_STATE(us_g_gpio.stream_online, state);
 }
 
 INLINE void us_gpio_set_has_http_clients(bool state) {
-	SET_STATE(us_gpio.has_http_clients, state);
+	SET_STATE(us_g_gpio.has_http_clients, state);
 }
 
 #undef SET_STATE

src/ustreamer/h264/stream.c

@@ -56,9 +56,15 @@ void us_h264_stream_process(us_h264_stream_s *h264, const us_frame_s *frame, boo
 		US_LOG_VERBOSE("H264: JPEG decoded; time=%.3Lf", us_get_now_monotonic() - now);
 	}
 
+	if (h264->key_requested) {
+		US_LOG_INFO("H264: Requested keyframe by a sink client");
+		h264->key_requested = false;
+		force_key = true;
+	}
+
 	bool online = false;
 	if (!us_m2m_encoder_compress(h264->enc, frame, h264->dest, force_key)) {
-		online = !us_memsink_server_put(h264->sink, h264->dest);
+		online = !us_memsink_server_put(h264->sink, h264->dest, &h264->key_requested);
 	}
 	atomic_store(&h264->online, online);
 }

src/ustreamer/h264/stream.h

@@ -36,6 +36,7 @@
 
 typedef struct {
 	us_memsink_s		*sink;
+	bool				key_requested;
 	us_frame_s			*tmp_src;
 	us_frame_s			*dest;
 	us_m2m_encoder_s	*enc;

src/ustreamer/http/bev.c

@@ -28,11 +28,11 @@ char *us_bufferevent_format_reason(short what) {
 	US_CALLOC(reason, 2048);
 
 	// evutil_socket_error_to_string() is not thread-safe
-	char perror_buf[1024] = {0};
-	const char *perror_ptr = us_errno_to_string(EVUTIL_SOCKET_ERROR(), perror_buf, 1024);
+	char *const perror_str = us_errno_to_string(EVUTIL_SOCKET_ERROR());
 	bool first = true;
 
-	strcat(reason, perror_ptr);
+	strcat(reason, perror_str);
+	free(perror_str);
 	strcat(reason, " (");
 
 #	define FILL_REASON(x_bev, x_name) { \

src/ustreamer/http/server.c

@@ -75,6 +75,7 @@ us_server_s *us_server_init(us_stream_s *stream) {
 	server->passwd = "";
 	server->static_path = "";
 	server->allow_origin = "";
+	server->instance_id = "";
 	server->timeout = 10;
 	server->run = run;
 
@@ -400,7 +401,9 @@ static void _http_callback_state(struct evhttp_request *request, void *v_server)
 
 	_A_EVBUFFER_ADD_PRINTF(buf,
 		"{\"ok\": true, \"result\": {"
+		" \"instance_id\": \"%s\","
 		" \"encoder\": {\"type\": \"%s\", \"quality\": %u},",
+		server->instance_id,
 		us_encoder_type_to_string(enc_type),
 		enc_quality
 	);

src/ustreamer/http/server.h

@@ -149,6 +149,7 @@ typedef struct us_server_sx {
 	char		*passwd;
 	char		*static_path;
 	char		*allow_origin;
+	char		*instance_id;
 
 	unsigned	drop_same_frames;
 	unsigned	fake_width;

src/ustreamer/m2m.c

@@ -220,7 +220,11 @@ static void _m2m_encoder_prepare(us_m2m_encoder_s *enc, const us_frame_s *frame)
 		fmt.fmt.pix_mp.colorspace = V4L2_COLORSPACE_DEFAULT;
 		fmt.fmt.pix_mp.num_planes = 1;
 		// fmt.fmt.pix_mp.plane_fmt[0].bytesperline = 0;
-		// fmt.fmt.pix_mp.plane_fmt[0].sizeimage = 512 << 10;
+		if (enc->output_format == V4L2_PIX_FMT_H264) {
+			// https://github.com/pikvm/ustreamer/issues/169
+			// https://github.com/raspberrypi/linux/pull/5232
+			fmt.fmt.pix_mp.plane_fmt[0].sizeimage = (1024 + 512) << 10; // 1.5Mb
+		}
 		_E_LOG_DEBUG("Configuring OUTPUT format ...");
 		_E_XIOCTL(VIDIOC_S_FMT, &fmt, "Can't set OUTPUT format");
 		if (fmt.fmt.pix_mp.pixelformat != enc->output_format) {

src/ustreamer/main.c

@@ -40,12 +40,9 @@
 #endif
 
 
-typedef struct {
-	us_stream_s *stream;
-	us_server_s *server;
-} _main_context_s;
+static us_stream_s	*_g_stream = NULL;
+static us_server_s	*_g_server = NULL;
 
-static _main_context_s *_ctx;
 
 static void _block_thread_signals(void) {
 	sigset_t mask;
@@ -58,25 +55,23 @@ static void _block_thread_signals(void) {
 static void *_stream_loop_thread(UNUSED void *arg) {
 	US_THREAD_RENAME("stream");
 	_block_thread_signals();
-	us_stream_loop(_ctx->stream);
+	us_stream_loop(_g_stream);
 	return NULL;
 }
 
 static void *_server_loop_thread(UNUSED void *arg) {
 	US_THREAD_RENAME("http");
 	_block_thread_signals();
-	us_server_loop(_ctx->server);
+	us_server_loop(_g_server);
 	return NULL;
 }
 
 static void _signal_handler(int signum) {
-	switch (signum) {
-		case SIGTERM:	US_LOG_INFO_NOLOCK("===== Stopping by SIGTERM ====="); break;
-		case SIGINT:	US_LOG_INFO_NOLOCK("===== Stopping by SIGINT ====="); break;
-		default:		US_LOG_INFO_NOLOCK("===== Stopping by %d =====", signum); break;
-	}
-	us_stream_loop_break(_ctx->stream);
-	us_server_loop_break(_ctx->server);
+	char *const name = us_signum_to_string(signum);
+	US_LOG_INFO_NOLOCK("===== Stopping by %s =====", name);
+	free(name);
+	us_stream_loop_break(_g_stream);
+	us_server_loop_break(_g_server);
 }
 
 static void _install_signal_handlers(void) {
@@ -107,22 +102,17 @@ int main(int argc, char *argv[]) {
 	us_options_s *options = us_options_init(argc, argv);
 	us_device_s *dev = us_device_init();
 	us_encoder_s *enc = us_encoder_init();
-	us_stream_s *stream = us_stream_init(dev, enc);
-	us_server_s *server = us_server_init(stream);
+	_g_stream = us_stream_init(dev, enc);
+	_g_server = us_server_init(_g_stream);
 
-	if ((exit_code = options_parse(options, dev, enc, stream, server)) == 0) {
+	if ((exit_code = options_parse(options, dev, enc, _g_stream, _g_server)) == 0) {
 #		ifdef WITH_GPIO
 		us_gpio_init();
 #		endif
 
 		_install_signal_handlers();
 
-		_main_context_s ctx;
-		ctx.stream = stream;
-		ctx.server = server;
-		_ctx = &ctx;
-
-		if ((exit_code = us_server_listen(server)) == 0) {
+		if ((exit_code = us_server_listen(_g_server)) == 0) {
 #			ifdef WITH_GPIO
 			us_gpio_set_prog_running(true);
 #			endif
@@ -141,8 +131,8 @@ int main(int argc, char *argv[]) {
 #		endif
 	}
 
-	us_server_destroy(server);
-	us_stream_destroy(stream);
+	us_server_destroy(_g_server);
+	us_stream_destroy(_g_stream);
 	us_encoder_destroy(enc);
 	us_device_destroy(dev);
 	us_options_destroy(options);

src/ustreamer/options.c

@@ -82,6 +82,7 @@ enum _US_OPT_VALUES {
 	_O_PASSWD,
 	_O_STATIC,
 	_O_ALLOW_ORIGIN,
+	_O_INSTANCE_ID,
 	_O_TCP_NODELAY,
 	_O_SERVER_TIMEOUT,
 
@@ -177,6 +178,7 @@ static const struct option _LONG_OPTS[] = {
 	{"static",					required_argument,	NULL,	_O_STATIC},
 	{"drop-same-frames",		required_argument,	NULL,	_O_DROP_SAME_FRAMES},
 	{"allow-origin",			required_argument,	NULL,	_O_ALLOW_ORIGIN},
+	{"instance-id",				required_argument,	NULL,	_O_INSTANCE_ID},
 	{"fake-resolution",			required_argument,	NULL,	_O_FAKE_RESOLUTION},
 	{"tcp-nodelay",				no_argument,		NULL,	_O_TCP_NODELAY},
 	{"server-timeout",			required_argument,	NULL,	_O_SERVER_TIMEOUT},
@@ -228,6 +230,7 @@ static const struct option _LONG_OPTS[] = {
 
 
 static int _parse_resolution(const char *str, unsigned *width, unsigned *height, bool limited);
+static int _check_instance_id(const char *str);
 
 static void _features(void);
 static void _help(FILE *fp, us_device_s *dev, us_encoder_s *enc, us_stream_s *stream, us_server_s *server);
@@ -419,6 +422,13 @@ int options_parse(us_options_s *options, us_device_s *dev, us_encoder_s *enc, us
 			case _O_DROP_SAME_FRAMES:	OPT_NUMBER("--drop-same-frames", server->drop_same_frames, 0, US_VIDEO_MAX_FPS, 0);
 			case _O_FAKE_RESOLUTION:	OPT_RESOLUTION("--fake-resolution", server->fake_width, server->fake_height, false);
 			case _O_ALLOW_ORIGIN:		OPT_SET(server->allow_origin, optarg);
+			case _O_INSTANCE_ID:
+				if (_check_instance_id(optarg) != 0) {
+					printf("Invalid instance ID, it should be like: ^[a-zA-Z0-9\\./+_-]*$\n");
+					return -1;
+				}
+				server->instance_id = optarg;
+				break;
 			case _O_TCP_NODELAY:		OPT_SET(server->tcp_nodelay, true);
 			case _O_SERVER_TIMEOUT:		OPT_NUMBER("--server-timeout", server->timeout, 1, 60, 0);
 
@@ -437,11 +447,11 @@ int options_parse(us_options_s *options, us_device_s *dev, us_encoder_s *enc, us
 #			undef ADD_SINK
 
 #			ifdef WITH_GPIO
-			case _O_GPIO_DEVICE:			OPT_SET(us_gpio.path, optarg);
-			case _O_GPIO_CONSUMER_PREFIX:	OPT_SET(us_gpio.consumer_prefix, optarg);
-			case _O_GPIO_PROG_RUNNING:		OPT_NUMBER("--gpio-prog-running", us_gpio.prog_running.pin, 0, 256, 0);
-			case _O_GPIO_STREAM_ONLINE:		OPT_NUMBER("--gpio-stream-online", us_gpio.stream_online.pin, 0, 256, 0);
-			case _O_GPIO_HAS_HTTP_CLIENTS:	OPT_NUMBER("--gpio-has-http-clients", us_gpio.has_http_clients.pin, 0, 256, 0);
+			case _O_GPIO_DEVICE:			OPT_SET(us_g_gpio.path, optarg);
+			case _O_GPIO_CONSUMER_PREFIX:	OPT_SET(us_g_gpio.consumer_prefix, optarg);
+			case _O_GPIO_PROG_RUNNING:		OPT_NUMBER("--gpio-prog-running", us_g_gpio.prog_running.pin, 0, 256, 0);
+			case _O_GPIO_STREAM_ONLINE:		OPT_NUMBER("--gpio-stream-online", us_g_gpio.stream_online.pin, 0, 256, 0);
+			case _O_GPIO_HAS_HTTP_CLIENTS:	OPT_NUMBER("--gpio-has-http-clients", us_g_gpio.has_http_clients.pin, 0, 256, 0);
 #			endif
 
 #			ifdef HAS_PDEATHSIG
@@ -457,12 +467,12 @@ int options_parse(us_options_s *options, us_device_s *dev, us_encoder_s *enc, us
 #			endif
 			case _O_NOTIFY_PARENT:			OPT_SET(server->notify_parent, true);
 
-			case _O_LOG_LEVEL:			OPT_NUMBER("--log-level", us_log_level, US_LOG_LEVEL_INFO, US_LOG_LEVEL_DEBUG, 0);
-			case _O_PERF:				OPT_SET(us_log_level, US_LOG_LEVEL_PERF);
-			case _O_VERBOSE:			OPT_SET(us_log_level, US_LOG_LEVEL_VERBOSE);
-			case _O_DEBUG:				OPT_SET(us_log_level, US_LOG_LEVEL_DEBUG);
-			case _O_FORCE_LOG_COLORS:	OPT_SET(us_log_colored, true);
-			case _O_NO_LOG_COLORS:		OPT_SET(us_log_colored, false);
+			case _O_LOG_LEVEL:			OPT_NUMBER("--log-level", us_g_log_level, US_LOG_LEVEL_INFO, US_LOG_LEVEL_DEBUG, 0);
+			case _O_PERF:				OPT_SET(us_g_log_level, US_LOG_LEVEL_PERF);
+			case _O_VERBOSE:			OPT_SET(us_g_log_level, US_LOG_LEVEL_VERBOSE);
+			case _O_DEBUG:				OPT_SET(us_g_log_level, US_LOG_LEVEL_DEBUG);
+			case _O_FORCE_LOG_COLORS:	OPT_SET(us_g_log_colored, true);
+			case _O_NO_LOG_COLORS:		OPT_SET(us_g_log_colored, false);
 
 			case _O_HELP:		_help(stdout, dev, enc, stream, server); return 1;
 			case _O_VERSION:	puts(US_VERSION); return 1;
@@ -473,6 +483,8 @@ int options_parse(us_options_s *options, us_device_s *dev, us_encoder_s *enc, us
 		}
 	}
 
+	US_LOG_INFO("Starting PiKVM uStreamer %s ...", US_VERSION);
+
 	options->blank = us_blank_frame_init(blank_path);
 	stream->blank = options->blank;
 
@@ -530,6 +542,18 @@ static int _parse_resolution(const char *str, unsigned *width, unsigned *height,
 	return 0;
 }
 
+static int _check_instance_id(const char *str) {
+	for (const char *ptr = str; *ptr; ++ptr) {
+		if (!(isascii(*ptr) && (
+			isalpha(*ptr) || isdigit(*ptr)
+			|| *ptr == '.' || *ptr == '/' || *ptr == '+' || *ptr == '_' || *ptr == '-'
+		))) {
+			return -1;
+		}
+	}
+	return 0;
+}
+
 static void _features(void) {
 #	ifdef WITH_GPIO
 	puts("+ WITH_GPIO");
@@ -657,6 +681,8 @@ static void _help(FILE *fp, us_device_s *dev, us_encoder_s *enc, us_stream_s *st
 	SAY("    --tcp-nodelay  ────────────── Set TCP_NODELAY flag to the client /stream socket. Only for TCP socket.");
 	SAY("                                  Default: disabled.\n");
 	SAY("    --allow-origin <str>  ─────── Set Access-Control-Allow-Origin header. Default: disabled.\n");
+	SAY("    --instance-id <str>  ──────── A short string identifier to be displayed in the /state handle.");
+	SAY("                                  It must satisfy regexp ^[a-zA-Z0-9\\./+_-]*$. Default: an empty string.\n");
 	SAY("    --server-timeout <sec>  ───── Timeout for client connections. Default: %u.\n", server->timeout);
 #	define ADD_SINK(x_name, x_opt) \
 		SAY(x_name " sink options:"); \
@@ -676,8 +702,8 @@ static void _help(FILE *fp, us_device_s *dev, us_encoder_s *enc, us_stream_s *st
 #	ifdef WITH_GPIO
 	SAY("GPIO options:");
 	SAY("═════════════");
-	SAY("    --gpio-device </dev/path>  ───── Path to GPIO character device. Default: %s.\n", us_gpio.path);
-	SAY("    --gpio-consumer-prefix <str>  ── Consumer prefix for GPIO outputs. Default: %s.\n", us_gpio.consumer_prefix);
+	SAY("    --gpio-device </dev/path>  ───── Path to GPIO character device. Default: %s.\n", us_g_gpio.path);
+	SAY("    --gpio-consumer-prefix <str>  ── Consumer prefix for GPIO outputs. Default: %s.\n", us_g_gpio.consumer_prefix);
 	SAY("    --gpio-prog-running <pin>  ───── Set 1 on GPIO pin while uStreamer is running. Default: disabled.\n");
 	SAY("    --gpio-stream-online <pin>  ──── Set 1 while streaming. Default: disabled.\n");
 	SAY("    --gpio-has-http-clients <pin>  ─ Set 1 while stream has at least one client. Default: disabled.\n");
@@ -702,7 +728,7 @@ static void _help(FILE *fp, us_device_s *dev, us_encoder_s *enc, us_stream_s *st
 	SAY("    --log-level <N>  ──── Verbosity level of messages from 0 (info) to 3 (debug).");
 	SAY("                          Enabling debugging messages can slow down the program.");
 	SAY("                          Available levels: 0 (info), 1 (performance), 2 (verbose), 3 (debug).");
-	SAY("                          Default: %d.\n", us_log_level);
+	SAY("                          Default: %d.\n", us_g_log_level);
 	SAY("    --perf  ───────────── Enable performance messages (same as --log-level=1). Default: disabled.\n");
 	SAY("    --verbose  ────────── Enable verbose messages and lower (same as --log-level=2). Default: disabled.\n");
 	SAY("    --debug  ──────────── Enable debug messages and lower (same as --log-level=3). Default: disabled.\n");

src/ustreamer/stream.c

@@ -32,7 +32,8 @@ static void _stream_expose_frame(us_stream_s *stream, us_frame_s *frame, unsigne
 
 #define _SINK_PUT(x_sink, x_frame) { \
 		if (stream->x_sink && us_memsink_server_check(stream->x_sink, x_frame)) {\
-			us_memsink_server_put(stream->x_sink, x_frame); \
+			bool m_key_requested; /* Unused */ \
+			us_memsink_server_put(stream->x_sink, x_frame, &m_key_requested); \
 		} \
 	}
 

src/ustreamer/workers.c

@@ -104,7 +104,7 @@ us_worker_s *us_workers_pool_wait(us_workers_pool_s *pool) {
 	us_worker_s *ready_wr = NULL;
 
 	US_MUTEX_LOCK(pool->free_workers_mutex);
-	US_COND_WAIT_TRUE(pool->free_workers, pool->free_workers_cond, pool->free_workers_mutex);
+	US_COND_WAIT_FOR(pool->free_workers, pool->free_workers_cond, pool->free_workers_mutex);
 	US_MUTEX_UNLOCK(pool->free_workers_mutex);
 
 	if (pool->oldest_wr && !atomic_load(&pool->oldest_wr->has_job)) {
@@ -185,7 +185,7 @@ static void *_worker_thread(void *v_worker) {
 		US_LOG_DEBUG("Worker %s waiting for a new job ...", wr->name);
 
 		US_MUTEX_LOCK(wr->has_job_mutex);
-		US_COND_WAIT_TRUE(atomic_load(&wr->has_job), wr->has_job_cond, wr->has_job_mutex);
+		US_COND_WAIT_FOR(atomic_load(&wr->has_job), wr->has_job_cond, wr->has_job_mutex);
 		US_MUTEX_UNLOCK(wr->has_job_mutex);
 
 		if (!atomic_load(&wr->pool->stop)) {

tools/make-jpeg-h.py

@@ -26,13 +26,11 @@ import os
 import io
 import struct
 
-from typing import Tuple
-
 import common
 
 
 # =====
-def _get_jpeg_size(data: bytes) -> Tuple[int, int]:
+def _get_jpeg_size(data: bytes) -> tuple[int, int]:
     # https://sheep.horse/2013/9/finding_the_dimensions_of_a_jpeg_file_in_python.html
 
     stream = io.BytesIO(data)