Bump version: 0.51 → 0.52

.bumpversion.cfg

@@ -1,7 +1,7 @@
 [bumpversion]
 commit = True
 tag = True
-current_version = 0.51
+current_version = 0.52
 parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?)?
 serialize = 
 	{major}.{minor}

Makefile

@@ -8,7 +8,7 @@ LDFLAGS ?=
 CC = gcc
 LIBS = -lm -ljpeg -pthread -levent -levent_pthreads -luuid
 override CFLAGS += -c -std=c99 -Wall -Wextra -D_GNU_SOURCE
-SOURCES = $(shell ls src/*.c src/jpeg/*.c)
+SOURCES = $(shell ls src/*.c src/jpeg/*.c src/hw/*.c)
 OBJECTS = $(SOURCES:.c=.o)
 PROG = ustreamer
 

PKGBUILD

@@ -3,7 +3,7 @@
 
 
 pkgname=ustreamer
-pkgver=0.51
+pkgver=0.52
 pkgrel=1
 pkgdesc="Lightweight and fast MJPG-HTTP streamer"
 url="https://github.com/pi-kvm/ustreamer"

README.md

@@ -15,18 +15,15 @@
 | Option to skip frames when streaming<br>static images by HTTP to save traffic | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Yes <sup>2</sup> | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) No |
 | Streaming via UNIX domain socket | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Yes | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) No |
 | Debug logs without recompiling,<br>performance statistics log,<br>access to HTTP broadcast parameters | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Yes | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) No |
-| Supported input formats | ![#ffaa00](https://placehold.it/15/ffaa00/000000?text=+) YUYV, UYVY,<br>RGB565, ~~MJPG~~ <sup>3</sup> | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) YUYV, UYVY,<br>RGB565, MJPG |
 | Access to webcam controls (focus, servos)<br>and settings such as brightness via HTTP | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) No | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Yes |
-| Option to serve files<br>with a built-in HTTP server, auth settings | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) No <sup>4</sup> | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Yes |
+| Option to serve files<br>with a built-in HTTP server, auth settings | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) No <sup>3</sup> | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Yes |
 
 Footnotes:
   * ```1``` Long before µStreamer, I made a [patch](https://github.com/jacksonliam/mjpg-streamer/pull/164) to add DV-timings support to mjpg-streamer and to keep it from hanging up no device disconnection. Alas, the patch is far from perfect and I can't guarantee it will work every time - mjpg-streamer's source code is very complicated and its structure is hard to understand. With this in mind, along with needing multithreading and JPEG hardware acceleration in the future, I decided to make my own stream server from scratch instead of supporting legacy code.
   
   * ```2``` This feature allows to cut down outgoing traffic several-fold when broadcasting HDMI, but it increases CPU usage a little bit. The idea is that HDMI is a fully digital interface and each captured frame can be identical to the previous one byte-wise. There's no need to broadcast the same image over the net several times a second. With the `--drop-same-frames=20` option enabled, µStreamer will drop all the matching frames (with a limit of 20 in a row). Each new frame is matched with the previous one first by length, then using ```memcmp()```.
 
-  * ```3``` As µStreamer was made mainly to be used with screencast hardware it supports video formats they usually need. MJPG input means that the screencast device can compress images to JPEG and feed it to the software, which allows to cut down CPU usage and avoid software image encoding. This video format is supported by most webcams, but I've never seen it supported by screencast hardware: neither [Auvidea B101](https://auvidea.com/b101-hdmi-to-csi-2-bridge-15-pin-fpc/), nor [EasyCap UTV 007](https://www.amazon.com/dp/B0126O0RDC) offer such support. It's not hard to add hardware MJPG sources support, it's just not done yet.
-
-  * ```4``` ...and there'll never be. µStreamer is designed UNIX-way, so if you need a small website with your broadcast, install NGINX.
+  * ```3``` ...and there'll never be. µStreamer is designed UNIX-way, so if you need a small website with your broadcast, install NGINX.
 
 -----
 # TL;DR

README.ru.md

@@ -15,18 +15,15 @@
 | Возможность пропуска фреймов при передаче<br>статического изображения по HTTP<br>для экономии трафика | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Есть <sup>2</sup> | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) Нет |
 | Стрим через UNIX domain socket | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Есть | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) Нет |
 | Дебаг-логи без перекомпиляции,<br>логгирование статистики производительности,<br>возможность получения параметров<br>трансляции по HTTP | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Есть | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) Нет |
-| Поддерживаемые входные форматы устройств | ![#ffaa00](https://placehold.it/15/ffaa00/000000?text=+) YUYV, UYVY,<br>RGB565, ~~MJPG~~ <sup>3</sup> | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) YUYV, UYVY,<br>RGB565, MJPG |
 | Поддержка контролов веб-камер (фокус,<br> движение сервами) и всяких настроек,<br> типа яркости, через HTTP | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) Нет | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Есть |
-| Возможность сервить файлы встроенным<br>HTTP-сервером, настройки авторизации | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) Нет <sup>4</sup> | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Есть |
+| Возможность сервить файлы встроенным<br>HTTP-сервером, настройки авторизации | ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) Нет <sup>3</sup> | ![#00aa00](https://placehold.it/15/00aa00/000000?text=+) Есть |
 
 Сносочки:
   * ```1``` Еще до написания µStreamer, я запилил [патч](https://github.com/jacksonliam/mjpg-streamer/pull/164), добавляющий в mjpg-streamer поддержку DV-таймингов и предотвращающий его зависание при отключении устройства. Однако патч, увы, далек от совершенства и я не гарантирую его стопроцентную работоспособность, поскольку код mjpg-streamer чрезвычайно запутан и очень плохо структурирован. Учитывая это, а также то, что в дальнейшем мне потребовались многопоточность и аппаратное кодирование JPEG, было принято решение написать свой стрим-сервер с нуля, чтобы не тратить силы на поддержку лишнего легаси.
   
   * ```2``` Это фича позволяет в несколько раз снизить объем исходящего трафика при трансляции HDMI, однако немного увеличивает загрузку процессора. Суть в том, что HDMI - полностью цифровой интерфейс, и новый захваченный фрейм может быть идентичен предыдущему в точности до байта. В этом случае нет нужды передавать одну и ту же картинку по сети несколько раз в секунду. При использовании опции `--drop-same-frames=20`, µStreamer будет дропать все одинаковые фреймы, но не более 20 подряд. Новый фрейм сравнивается с предыдущим сначала по длине, а затем помощью ```memcmp()```.
 
-  * ```3``` Поскольку µStreamer писался в первую очередь для устройств видеозахвата, в нем реализованы только те форматы, которые для них были нужны. MJPG в контексте входных данных означает, что устройство умеет самостоятельно сжимать картинку в JPEG и отдавать ее программе, что позволяет значительно снизить загрузку процессора и избавить его от необходимости кодировать картинку софтом. Этот формат поддерживается большинством веб-камер, но не поддерживается ни одним из встреченных мной устройств видеозахвата; его не умеет ни [Auvidea B101](https://auvidea.com/b101-hdmi-to-csi-2-bridge-15-pin-fpc/), ни [EasyCap UTV 007](https://www.amazon.com/dp/B0126O0RDC). Нет никаких технических сложностей добавить поддержку аппаратного MJPG источника, но у меня просто пока не дошли до этого руки.
-
-  * ```4``` ... и не будет. µStreamer придерживается концепции UNIX-way, так что если вам нужно нарисовать маленький сайтик со встроенной трансляцией - просто поставьте NGINX.
+  * ```3``` ... и не будет. µStreamer придерживается концепции UNIX-way, так что если вам нужно нарисовать маленький сайтик со встроенной трансляцией - просто поставьте NGINX.
 
 -----
 # TL;DR

src/config.h

@@ -22,4 +22,4 @@
 
 #pragma once
 
-#define VERSION "0.51"
+#define VERSION "0.52"

src/device.c

@@ -55,6 +55,8 @@ static const struct {
 	{"YUYV",	V4L2_PIX_FMT_YUYV},
 	{"UYVY",	V4L2_PIX_FMT_UYVY},
 	{"RGB565",	V4L2_PIX_FMT_RGB565},
+	{"JPEG",	V4L2_PIX_FMT_MJPEG},
+	{"JPEG",	V4L2_PIX_FMT_JPEG},
 };
 
 

src/device.h

@@ -39,7 +39,7 @@
 #define STANDARDS_STR		"UNKNOWN, PAL, NTSC, SECAM"
 
 #define FORMAT_UNKNOWN	-1
-#define FORMATS_STR		"YUYV, UYVY, RGB565"
+#define FORMATS_STR		"YUYV, UYVY, RGB565, JPEG"
 
 
 struct hw_buffer_t {
@@ -62,7 +62,7 @@ struct device_runtime_t {
 	unsigned			height;
 	unsigned			format;
 	unsigned			n_buffers;
-	unsigned			n_workers;
+//	unsigned			n_workers; // FIXME
 	struct hw_buffer_t	*hw_buffers;
 	struct picture_t	*pictures;
 	unsigned long		max_picture_size;

src/encoder.c

@@ -23,12 +23,15 @@
 #include <strings.h>
 #include <assert.h>
 
+#include <linux/videodev2.h>
+
 #include "tools.h"
 #include "logging.h"
 #include "device.h"
 #include "encoder.h"
 
 #include "jpeg/encoder.h"
+#include "hw/encoder.h"
 
 #ifdef OMX_ENCODER
 #	include "omx/encoder.h"
@@ -40,6 +43,7 @@ static const struct {
 	const enum encoder_type_t type;
 } _ENCODER_TYPES[] = {
 	{"CPU",	ENCODER_TYPE_CPU},
+	{"HW",	ENCODER_TYPE_HW},
 #	ifdef OMX_ENCODER
 	{"OMX",	ENCODER_TYPE_OMX},
 #	endif
@@ -52,10 +56,12 @@ struct encoder_t *encoder_init() {
 
 	A_CALLOC(run, 1);
 	run->type = ENCODER_TYPE_CPU;
+	run->quality = 80;
+	A_PTHREAD_M_INIT(&run->mutex);
 
 	A_CALLOC(encoder, 1);
 	encoder->type = run->type;
-	encoder->quality = 80;
+	encoder->quality = run->quality;
 	encoder->run = run;
 	return encoder;
 }
@@ -66,16 +72,16 @@ void encoder_prepare(struct encoder_t *encoder, struct device_t *dev) {
 #pragma GCC diagnostic pop
 
 	assert(encoder->type != ENCODER_TYPE_UNKNOWN);
+	// XXX: Тут нет гонки, потому что encoder_prepare() запускается еще до существования других потоков
 	encoder->run->type = encoder->type;
-
-	if (encoder->run->type != ENCODER_TYPE_CPU) {
-		LOG_DEBUG("Initializing encoder ...");
-	}
+	encoder->run->quality = encoder->quality;
 
 	LOG_INFO("Using JPEG quality: %u%%", encoder->quality);
 
 #	ifdef OMX_ENCODER
 	if (encoder->run->type == ENCODER_TYPE_OMX) {
+		LOG_DEBUG("Preparing OMX encoder ...");
+
 		if (dev->n_workers > OMX_MAX_ENCODERS) {
 			LOG_INFO(
 				"OMX-based encoder can only work with %u worker threads; forced --workers=%u",
@@ -101,6 +107,7 @@ void encoder_prepare(struct encoder_t *encoder, struct device_t *dev) {
 	use_fallback:
 		LOG_ERROR("Can't initialize selected encoder, using CPU instead it");
 		encoder->run->type = ENCODER_TYPE_CPU;
+		encoder->run->quality = encoder->quality;
 #	pragma GCC diagnostic pop
 }
 
@@ -115,6 +122,7 @@ void encoder_destroy(struct encoder_t *encoder) {
 		free(encoder->run->omxs);
 	}
 #	endif
+	A_PTHREAD_M_DESTROY(&encoder->run->mutex);
 	free(encoder->run);
 	free(encoder);
 }
@@ -133,11 +141,33 @@ enum encoder_type_t encoder_parse_type(const char *str) {
 void encoder_prepare_live(struct encoder_t *encoder, struct device_t *dev) {
 	assert(encoder->run->type != ENCODER_TYPE_UNKNOWN);
 
+	if (
+		(dev->run->format == V4L2_PIX_FMT_MJPEG || dev->run->format == V4L2_PIX_FMT_JPEG)
+		&& encoder->run->type != ENCODER_TYPE_HW
+	) {
+		LOG_INFO("Switching to HW encoder because the input format is (M)JPEG");
+		A_PTHREAD_M_LOCK(&encoder->run->mutex);
+		encoder->run->type = ENCODER_TYPE_HW;
+		A_PTHREAD_M_UNLOCK(&encoder->run->mutex);
+	}
+
+	if (encoder->run->type == ENCODER_TYPE_HW) {
+		if (dev->run->format != V4L2_PIX_FMT_MJPEG && dev->run->format != V4L2_PIX_FMT_JPEG) {
+			LOG_INFO("Switching to CPU encoder because the input format is not (M)JPEG");
+			goto use_fallback;
+		}
+		if (hw_encoder_prepare_live(dev, encoder->quality) < 0) {
+			A_PTHREAD_M_LOCK(&encoder->run->mutex);
+			encoder->run->quality = 0;
+			A_PTHREAD_M_UNLOCK(&encoder->run->mutex);
+		}
+	}
 #pragma GCC diagnostic pop
 #	ifdef OMX_ENCODER
-	if (encoder->run->type == ENCODER_TYPE_OMX) {
+	else if (encoder->run->type == ENCODER_TYPE_OMX) {
 		for (unsigned index = 0; index < encoder->run->n_omxs; ++index) {
 			if (omx_encoder_prepare_live(encoder->run->omxs[index], dev, encoder->quality) < 0) {
+				LOG_ERROR("Can't prepare OMX encoder, falling back to CPU");
 				goto use_fallback;
 			}
 		}
@@ -149,8 +179,10 @@ void encoder_prepare_live(struct encoder_t *encoder, struct device_t *dev) {
 #	pragma GCC diagnostic ignored "-Wunused-label"
 #	pragma GCC diagnostic push
 	use_fallback:
-		LOG_ERROR("Can't prepare selected encoder, falling back to CPU");
+		A_PTHREAD_M_LOCK(&encoder->run->mutex);
 		encoder->run->type = ENCODER_TYPE_CPU;
+		encoder->run->quality = encoder->quality;
+		A_PTHREAD_M_UNLOCK(&encoder->run->mutex);
 #	pragma GCC diagnostic pop
 }
 
@@ -163,11 +195,13 @@ int encoder_compress_buffer(struct encoder_t *encoder, struct device_t *dev, uns
 
 	if (encoder->run->type == ENCODER_TYPE_CPU) {
 		jpeg_encoder_compress_buffer(dev, buf_index, encoder->quality);
+	} else if (encoder->run->type == ENCODER_TYPE_HW) {
+		hw_encoder_compress_buffer(dev, buf_index);
 	}
 #	ifdef OMX_ENCODER
 	else if (encoder->run->type == ENCODER_TYPE_OMX) {
 		if (omx_encoder_compress_buffer(encoder->run->omxs[worker_number], dev, buf_index) < 0) {
-			goto error;
+			goto use_fallback;
 		}
 	}
 #	endif
@@ -176,9 +210,12 @@ int encoder_compress_buffer(struct encoder_t *encoder, struct device_t *dev, uns
 
 #	pragma GCC diagnostic ignored "-Wunused-label"
 #	pragma GCC diagnostic push
-	error:
-		LOG_INFO("HW compressing error, falling back to CPU");
+	use_fallback:
+		LOG_INFO("Error while compressing, falling back to CPU");
+		A_PTHREAD_M_LOCK(&encoder->run->mutex);
 		encoder->run->type = ENCODER_TYPE_CPU;
+		encoder->run->quality = encoder->quality;
+		A_PTHREAD_M_UNLOCK(&encoder->run->mutex);
 		return -1;
 #	pragma GCC diagnostic pop
 }

src/encoder.h

@@ -22,6 +22,8 @@
 
 #pragma once
 
+#include "pthread.h"
+
 #include "tools.h"
 #include "device.h"
 
@@ -34,19 +36,23 @@
 
 
 #define ENCODER_TYPES_STR \
-	"CPU" \
+	"CPU, HW" \
 	ENCODER_TYPES_OMX_HINT
 
 enum encoder_type_t {
 	ENCODER_TYPE_UNKNOWN, // Only for encoder_parse_type() and main()
 	ENCODER_TYPE_CPU,
+	ENCODER_TYPE_HW,
 #ifdef OMX_ENCODER
 	ENCODER_TYPE_OMX,
 #endif
 };
 
 struct encoder_runtime_t {
-	enum encoder_type_t type;
+	enum encoder_type_t	type;
+	unsigned			quality;
+	pthread_mutex_t		mutex;
+
 #ifdef OMX_ENCODER
 	unsigned				n_omxs;
 	struct omx_encoder_t	**omxs;

src/http.c

@@ -47,6 +47,7 @@
 
 #include "tools.h"
 #include "logging.h"
+#include "encoder.h"
 #include "stream.h"
 #include "http.h"
 
@@ -259,6 +260,11 @@ static void _http_callback_state(struct evhttp_request *request, void *v_server)
 
 	PROCESS_HEAD_REQUEST;
 
+	A_PTHREAD_M_LOCK(&server->run->stream->encoder->run->mutex);
+	enum encoder_type_t encoder_run_type = server->run->stream->encoder->run->type;
+	unsigned encoder_run_quality = server->run->stream->encoder->run->quality;
+	A_PTHREAD_M_UNLOCK(&server->run->stream->encoder->run->mutex);
+
 	assert((buf = evbuffer_new()));
 	assert(evbuffer_add_printf(buf,
 		"{\"ok\": true, \"result\": {"
@@ -266,8 +272,8 @@ static void _http_callback_state(struct evhttp_request *request, void *v_server)
 		" \"source\": {\"resolution\": {\"width\": %u, \"height\": %u},"
 		" \"online\": %s, \"desired_fps\": %u, \"captured_fps\": %u},"
 		" \"stream\": {\"queued_fps\": %u, \"clients\": %u, \"clients_stat\": {",
-		bool_to_string(server->run->stream->encoder->type != server->run->stream->encoder->run->type),
-		server->run->stream->encoder->quality,
+		bool_to_string(server->run->stream->encoder->type != encoder_run_type),
+		encoder_run_quality,
 		(server->fake_width ? server->fake_width : server->run->exposed->width),
 		(server->fake_height ? server->fake_height : server->run->exposed->height),
 		bool_to_string(server->run->exposed->online),

src/hw/encoder.c

@@ -0,0 +1,58 @@
+/*****************************************************************************
+#                                                                            #
+#    uStreamer - Lightweight and fast MJPG-HTTP streamer.                    #
+#                                                                            #
+#    Copyright (C) 2018  Maxim Devaev <mdevaev@gmail.com>                    #
+#                                                                            #
+#    This program is free software: you can redistribute it and/or modify    #
+#    it under the terms of the GNU General Public License as published by    #
+#    the Free Software Foundation, either version 3 of the License, or       #
+#    (at your option) any later version.                                     #
+#                                                                            #
+#    This program is distributed in the hope that it will be useful,         #
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of          #
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           #
+#    GNU General Public License for more details.                            #
+#                                                                            #
+#    You should have received a copy of the GNU General Public License       #
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.  #
+#                                                                            #
+*****************************************************************************/
+
+
+#include <string.h>
+#include <assert.h>
+
+#include <linux/videodev2.h>
+
+#include "../tools.h"
+#include "../logging.h"
+#include "../xioctl.h"
+#include "../device.h"
+
+
+int hw_encoder_prepare_live(struct device_t *dev, unsigned quality) {
+	struct v4l2_jpegcompression comp;
+
+	MEMSET_ZERO(comp);
+
+	if (xioctl(dev->run->fd, VIDIOC_G_JPEGCOMP, &comp) < 0) {
+		LOG_ERROR("Can't query HW JPEG compressor params and set quality (unsupported)");
+		return -1;
+	}
+	comp.quality = quality;
+	if (xioctl(dev->run->fd, VIDIOC_S_JPEGCOMP, &comp) < 0) {
+		LOG_ERROR("Can't set HW JPEG compressor quality (unsopported)");
+		return -1;
+	}
+	return 0;
+}
+
+void hw_encoder_compress_buffer(struct device_t *dev, unsigned index) {
+	if (dev->run->format != V4L2_PIX_FMT_MJPEG && dev->run->format != V4L2_PIX_FMT_JPEG) {
+		assert(0 && "Unsupported input format for HW JPEG compressor");
+	}
+	assert(dev->run->pictures[index].allocated >= dev->run->hw_buffers[index].length);
+	memcpy(dev->run->pictures[index].data, dev->run->hw_buffers[index].start, dev->run->hw_buffers[index].length);
+	dev->run->pictures[index].size = dev->run->hw_buffers[index].length;
+}

src/hw/encoder.h

@@ -0,0 +1,29 @@
+/*****************************************************************************
+#                                                                            #
+#    uStreamer - Lightweight and fast MJPG-HTTP streamer.                    #
+#                                                                            #
+#    Copyright (C) 2018  Maxim Devaev <mdevaev@gmail.com>                    #
+#                                                                            #
+#    This program is free software: you can redistribute it and/or modify    #
+#    it under the terms of the GNU General Public License as published by    #
+#    the Free Software Foundation, either version 3 of the License, or       #
+#    (at your option) any later version.                                     #
+#                                                                            #
+#    This program is distributed in the hope that it will be useful,         #
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of          #
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           #
+#    GNU General Public License for more details.                            #
+#                                                                            #
+#    You should have received a copy of the GNU General Public License       #
+#    along with this program.  If not, see <https://www.gnu.org/licenses/>.  #
+#                                                                            #
+*****************************************************************************/
+
+
+#pragma once
+
+#include "../device.h"
+
+
+int hw_encoder_prepare_live(struct device_t *dev, unsigned quality);
+void hw_encoder_compress_buffer(struct device_t *dev, unsigned index);