Bump version: 4.6 → 4.7

Document how to integrate uStreamer with nginx

.bumpversion.cfg

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

README.md

@@ -92,6 +92,21 @@ $ ./ustreamer --host :: -m jpeg --device-timeout=5 --buffers=3 -r 2592x1944
 $ modprobe bcm2835-v4l2 max_video_width=2592 max_video_height=1944
 ```
 
+-----
+# Integrations
+
+## Nginx
+When uStreamer is behind an Nginx proxy, it's buffering behavior introduces latency into the video stream. It's possible to disable Nginx's buffering to eliminate the additional latency:
+
+```nginx
+location /stream {
+    postpone_output 0;
+    proxy_buffering off;
+    proxy_ignore_headers X-Accel-Buffering;
+    proxy_pass http://ustreamer;
+}
+```
+
 -----
 # Tips & tricks for v4l2
 v4l2 utilities provide the tools to manage USB webcam setting and information. Scripts can be use to make adjustments and run manually or with cron. Running in cron for example to change the exposure settings at certain times of day. The package is available in all Linux distributions and is usually called `v4l-utils`.

README.ru.md

@@ -92,6 +92,21 @@ $ ./ustreamer --host :: -m jpeg --device-timeout=5 --buffers=3 -r 2592x1944
 $ modprobe bcm2835-v4l2 max_video_width=2592 max_video_height=1944
 ```
 
+-----
+# Интеграция
+
+## Nginx
+Если uStreamer находится на Nginx, то последний будет буферизировать поток и создавать дополнительную задержку в стриме. Чтобы задержки не было, буферизацию можно отключить:
+
+```nginx
+location /stream {
+    postpone_output 0;
+    proxy_buffering off;
+    proxy_ignore_headers X-Accel-Buffering;
+    proxy_pass http://ustreamer;
+}
+```
+
 -----
 # Утилиты V4L2
 V4L2 предоставляет ряд официальных утилит для управления USB-вебкамерами и получения информации об устройствах. С их помощью можно писать всякие настроечные скрипты и запускать их по крону, если, например, вам требуется изменять настройки экспозиции в зависимости от времени суток. Пакет с этими утилитами доступен на всех дистрибутивах Linux и обычно называется `v4l-utils`.

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 4.6" "January 2021"
+.TH USTREAMER-DUMP 1 "version 4.7" "January 2021"
 
 .SH NAME
 ustreamer-dump \- Dump uStreamer's memory sink to file

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 4.6" "November 2020"
+.TH USTREAMER 1 "version 4.7" "November 2020"
 
 .SH NAME
 ustreamer \- stream MJPG video from any V4L2 device to the network

pkg/arch/PKGBUILD

@@ -3,7 +3,7 @@
 
 
 pkgname=ustreamer
-pkgver=4.6
+pkgver=4.7
 pkgrel=1
 pkgdesc="Lightweight and fast MJPG-HTTP streamer"
 url="https://github.com/pikvm/ustreamer"

pkg/openwrt/Makefile

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

python/setup.py

@@ -8,7 +8,7 @@ from distutils.core import setup
 if __name__ == "__main__":
     setup(
         name="ustreamer",
-        version="4.6",
+        version="4.7",
         description="uStreamer tools",
         author="Maxim Devaev",
         author_email="mdevaev@gmail.com",

src/libs/config.h

@@ -23,7 +23,7 @@
 #pragma once
 
 #define VERSION_MAJOR 4
-#define VERSION_MINOR 6
+#define VERSION_MINOR 7
 
 #define MAKE_VERSION2(_major, _minor) #_major "." #_minor
 #define MAKE_VERSION1(_major, _minor) MAKE_VERSION2(_major, _minor)

src/ustreamer/http/server.c

@@ -25,6 +25,8 @@
 
 static int _http_preprocess_request(struct evhttp_request *request, server_s *server);
 
+static int _http_check_run_compat_action(struct evhttp_request *request, void *v_server);
+
 static void _http_callback_root(struct evhttp_request *request, void *v_server);
 static void _http_callback_static(struct evhttp_request *request, void *v_server);
 static void _http_callback_state(struct evhttp_request *request, void *v_server);
@@ -220,41 +222,63 @@ static int _http_preprocess_request(struct evhttp_request *request, server_s *se
 		} \
 	}
 
-static void _http_callback_root(struct evhttp_request *request, void *v_server) {
-	server_s *server = (server_s *)v_server;
+static int _http_check_run_compat_action(struct evhttp_request *request, void *v_server) {
+	// MJPG-Streamer compatibility layer
 
-	PREPROCESS_REQUEST;
+	struct evkeyvalq params;
+	int error = 0;
 
-	struct evkeyvalq params; // For mjpg-streamer compatibility
 	evhttp_parse_query(evhttp_request_get_uri(request), &params);
 	const char *action = evhttp_find_header(&params, "action");
 
 	if (action && !strcmp(action, "snapshot")) {
 		_http_callback_snapshot(request, v_server);
+		goto ok;
 	} else if (action && !strcmp(action, "stream")) {
 		_http_callback_stream(request, v_server);
-	} else {
-		struct evbuffer *buf;
-		assert((buf = evbuffer_new()));
-		assert(evbuffer_add_printf(buf, "%s", HTML_INDEX_PAGE));
-		ADD_HEADER("Content-Type", "text/html");
-		evhttp_send_reply(request, HTTP_OK, "OK", buf);
-		evbuffer_free(buf);
+		goto ok;
 	}
 
-	evhttp_clear_headers(&params);
+	error = -1;
+	ok:
+		evhttp_clear_headers(&params);
+		return error;
+}
+
+#define COMPAT_REQUEST { \
+		if (_http_check_run_compat_action(request, v_server) == 0) { \
+			return; \
+		} \
+	}
+
+static void _http_callback_root(struct evhttp_request *request, void *v_server) {
+	server_s *server = (server_s *)v_server;
+
+	PREPROCESS_REQUEST;
+	COMPAT_REQUEST;
+
+	struct evbuffer *buf;
+
+	assert((buf = evbuffer_new()));
+	assert(evbuffer_add_printf(buf, "%s", HTML_INDEX_PAGE));
+	ADD_HEADER("Content-Type", "text/html");
+	evhttp_send_reply(request, HTTP_OK, "OK", buf);
+
+	evbuffer_free(buf);
 }
 
 static void _http_callback_static(struct evhttp_request *request, void *v_server) {
 	server_s *server = (server_s *)v_server;
+
+	PREPROCESS_REQUEST;
+	COMPAT_REQUEST;
+
 	struct evbuffer *buf = NULL;
 	struct evhttp_uri *uri = NULL;
 	char *decoded_path = NULL;
 	char *static_path = NULL;
 	int fd = -1;
 
-	PREPROCESS_REQUEST;
-
 	{
 		char *uri_path;
 
@@ -324,6 +348,8 @@ static void _http_callback_static(struct evhttp_request *request, void *v_server
 		}
 }
 
+#undef COMPAT_REQUEST
+
 static void _http_callback_state(struct evhttp_request *request, void *v_server) {
 	server_s *server = (server_s *)v_server;