Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 6.22 KB

README.md

File metadata and controls

80 lines (63 loc) · 6.22 KB
Raw

µStreamer

[Русская версия]

µStreamer is a lightweight and very quick server to broadcast MJPG 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 project designed to stream VGA and HDMI screencast hardware data with the highest resolution and FPS possible.

µStreamer is very similar to mjpg-streamer with input_uvc.so and output_http.so plugins, however, there are some major differences. The key ones are:

Feature µStreamer mjpg-streamer
Multithreaded JPEG encoding #00aa00 Yes #f03c15 No
OpenMAX IL hardware acceleration
on Raspberry Pi		 #00aa00 Yes #f03c15 No
Behavior when the device
is disconnected while streaming		 #00aa00 Shows a black screen
with NO SIGNAL on it
until reconnected		 #f03c15 Stops the broadcast 1
DV-timings support -
the ability to change resolution
on the fly by source signal		 #00aa00 Yes #ffaa00 Partially yes 1
Option to skip frames when streaming
static images by HTTP to save traffic		 #00aa00 Yes 2 #f03c15 No
Streaming via UNIX domain socket #00aa00 Yes #f03c15 No
Debug logs without recompiling,
performance statistics log,
access to HTTP broadcast parameters		 #00aa00 Yes #f03c15 No
Option to serve files
with a built-in HTTP server		 #00aa00 Yes #ffaa00 Regular files only
Access to webcam controls (focus, servos)
and settings such as brightness via HTTP		 #f03c15 No #00aa00 Yes

Footnotes:

  • 1 Long before µStreamer, I made a patch 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().

TL;DR

If you're going to live-stream from your backyard webcam and need to control it, use mjpg-streamer. If you need a high-quality image with high FPS - µStreamer for the win.

Building

You'll need make, gcc, libevent with pthreads support, libjpeg8/libjpeg-turbo and libuuid.

It should compile automatically with OpenMAX IL on Raspberry Pi, if the corresponding headers are present in /opt/vc/include.

$ git clone --depth=1 https://github.com/pi-kvm/ustreamer
$ cd ustreamer
$ make
$ ./ustreamer --help

AUR has a package for Arch Linux: https://aur.archlinux.org/packages/ustreamer

Usage

Without arguments, ustreamer will try to open /dev/video0 with 640x480 resolution and start broadcasting on http://127.0.0.1:8080. You can override this behavior using parameters --device, --host and --port. For example, to broadcast to the world, run:

# ./ustreamer --device=/dev/video1 --host=0.0.0.0 --port=80

The recommended way of running µStreamer with Auvidea B101 on Raspberry Pi:

$ ./ustreamer \
    --format=uyvy \ # Device input format
    --encoder=omx \ # Hardware encoding with OpenMAX
    --workers=3 \ # Maximum workers for OpenMAX
    --persistent \ # Don't re-initialize device on timeout (for example when HDMI cable was disconnected)
    --dv-timings \ # Use DV-timings
    --drop-same-frames=30 # Save that traffic

You can always view the full list of options with ustreamer --help.

License

Copyright (C) 2018 by 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/.