gilles/go2rtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revert changes in readme file

Browse Source
This commit is contained in:
Alex X
2024-04-29 12:26:53 +03:00
parent 152719441e
commit 64ac27d93d
1 changed files with 145 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+88 -100
View File
@@ -37,60 +37,60 @@ Ultimate camera streaming application with support RTSP, WebRTC, HomeKit, FFmpeg
---
- [Fast start](#fast-start)
- [go2rtc: Binary](#go2rtc-binary)
- [go2rtc: Docker](#go2rtc-docker)
- [go2rtc: Home Assistant Add-on](#go2rtc-home-assistant-add-on)
- [go2rtc: Home Assistant Integration](#go2rtc-home-assistant-integration)
- [go2rtc: Dev version](#go2rtc-dev-version)
- [Configuration](#configuration)
- [Module: Streams](#module-streams)
- [Two way audio](#two-way-audio)
- [Source: RTSP](#source-rtsp)
- [Source: RTMP](#source-rtmp)
- [Source: HTTP](#source-http)
- [Source: ONVIF](#source-onvif)
- [Source: FFmpeg](#source-ffmpeg)
- [Source: FFmpeg Device](#source-ffmpeg-device)
- [Source: Exec](#source-exec)
- [Source: Echo](#source-echo)
- [Source: Expr](#source-expr)
- [Source: HomeKit](#source-homekit)
- [Source: Bubble](#source-bubble)
- [Source: DVRIP](#source-dvrip)
- [Source: Tapo](#source-tapo)
- [Source: Kasa](#source-kasa)
- [Source: GoPro](#source-gopro)
- [Source: Ivideon](#source-ivideon)
- [Source: Hass](#source-hass)
- [Source: ISAPI](#source-isapi)
- [Source: Nest](#source-nest)
- [Source: Roborock](#source-roborock)
- [Source: WebRTC](#source-webrtc)
- [Source: WebTorrent](#source-webtorrent)
- [Incoming sources](#incoming-sources)
- [Stream to camera](#stream-to-camera)
- [Publish stream](#publish-stream)
- [Module: API](#module-api)
- [Module: RTSP](#module-rtsp)
- [Module: RTMP](#module-rtmp)
- [Module: WebRTC](#module-webrtc)
- [Module: HomeKit](#module-homekit)
- [Module: WebTorrent](#module-webtorrent)
- [Module: ngrok](#module-ngrok)
- [Module: Hass](#module-hass)
- [Module: MP4](#module-mp4)
- [Module: HLS](#module-hls)
- [Module: MJPEG](#module-mjpeg)
- [Module: Log](#module-log)
- [Security](#security)
- [Codecs filters](#codecs-filters)
- [Codecs madness](#codecs-madness)
- [Codecs negotiation](#codecs-negotiation)
- [Projects using go2rtc](#projects-using-go2rtc)
- [Camera experience](#cameras-experience)
- [TIPS](#tips)
- [FAQ](#faq)
* [Fast start](#fast-start)
* [go2rtc: Binary](#go2rtc-binary)
* [go2rtc: Docker](#go2rtc-docker)
* [go2rtc: Home Assistant Add-on](#go2rtc-home-assistant-add-on)
* [go2rtc: Home Assistant Integration](#go2rtc-home-assistant-integration)
* [go2rtc: Dev version](#go2rtc-dev-version)
* [Configuration](#configuration)
* [Module: Streams](#module-streams)
* [Two way audio](#two-way-audio)
* [Source: RTSP](#source-rtsp)
* [Source: RTMP](#source-rtmp)
* [Source: HTTP](#source-http)
* [Source: ONVIF](#source-onvif)
* [Source: FFmpeg](#source-ffmpeg)
* [Source: FFmpeg Device](#source-ffmpeg-device)
* [Source: Exec](#source-exec)
* [Source: Echo](#source-echo)
* [Source: Expr](#source-expr)
* [Source: HomeKit](#source-homekit)
* [Source: Bubble](#source-bubble)
* [Source: DVRIP](#source-dvrip)
* [Source: Tapo](#source-tapo)
* [Source: Kasa](#source-kasa)
* [Source: GoPro](#source-gopro)
* [Source: Ivideon](#source-ivideon)
* [Source: Hass](#source-hass)
* [Source: ISAPI](#source-isapi)
* [Source: Nest](#source-nest)
* [Source: Roborock](#source-roborock)
* [Source: WebRTC](#source-webrtc)
* [Source: WebTorrent](#source-webtorrent)
* [Incoming sources](#incoming-sources)
* [Stream to camera](#stream-to-camera)
* [Publish stream](#publish-stream)
* [Module: API](#module-api)
* [Module: RTSP](#module-rtsp)
* [Module: RTMP](#module-rtmp)
* [Module: WebRTC](#module-webrtc)
* [Module: HomeKit](#module-homekit)
* [Module: WebTorrent](#module-webtorrent)
* [Module: ngrok](#module-ngrok)
* [Module: Hass](#module-hass)
* [Module: MP4](#module-mp4)
* [Module: HLS](#module-hls)
* [Module: MJPEG](#module-mjpeg)
* [Module: Log](#module-log)
* [Security](#security)
* [Codecs filters](#codecs-filters)
* [Codecs madness](#codecs-madness)
* [Codecs negotiation](#codecs-negotiation)
* [Projects using go2rtc](#projects-using-go2rtc)
* [Camera experience](#cameras-experience)
* [TIPS](#tips)
* [FAQ](#faq)
## Fast start
@@ -152,7 +152,7 @@ Latest, but maybe unstable version:
## Configuration
- by default go2rtc will search `go2rtc.yaml` in the current work directory
- by default go2rtc will search `go2rtc.yaml` in the current work dirrectory
- `api` server will start on default **1984 port** (TCP)
- `rtsp` server will start on default **8554 port** (TCP)
- `webrtc` will use port **8555** (TCP/UDP) for connections
@@ -305,7 +305,7 @@ streams:
#### Source: ONVIF
_[New in v1.5.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.5.0)_
*[New in v1.5.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.5.0)*
The source is not very useful if you already know RTSP and snapshot links for your camera. But it can be useful if you don't.
@@ -399,23 +399,12 @@ streams:
#### Source: Exec
Exec source can run any external application and expect data from it. Two transports are supported - **pipe** (_from [v1.5.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.5.0)_) and **RTSP**.
Exec source can run any external application and expect data from it. Two transports are supported - **pipe** (*from [v1.5.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.5.0)*) and **RTSP**.
If you want to use **RTSP** transport - the command must contain the `{output}` argument in any place. On launch, it will be replaced by the local address of the RTSP server.
**pipe** reads data from app stdout in different formats: **MJPEG**, **H.264/H.265 bitstream**, **MPEG-TS**.
Pipe commands support two parameters:
- **killsignal**: Signal which will be send to stop the process (default: sigkill)
- **killtimeout**: Time in seconds after the process will killed with sigkill (default: 5)
The **killtimeout** parameter is only relevant if **killsignal** is not sigkill.
Setting **killtimeout** to a negative number (or zero) will result in an immediate SIGKILL.
See `man 7 signal` to get a full list of all the signals.
Format: `exec:{command}#{param1}#{param2}`
The source can be used with:
- [FFmpeg](https://ffmpeg.org/) - go2rtc ffmpeg source just a shortcut to exec source
@@ -428,7 +417,6 @@ streams:
stream: exec:ffmpeg -re -i /media/BigBuckBunny.mp4 -c copy -rtsp_transport tcp -f rtsp {output}
picam_h264: exec:libcamera-vid -t 0 --inline -o -
picam_mjpeg: exec:libcamera-vid -t 0 --codec mjpeg -o -
canon: exec:gphoto2 --capture-movie --stdout#killsignal=sigint
```
#### Source: Echo
@@ -446,7 +434,7 @@ streams:
#### Source: Expr
_[New in v1.8.2](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.2)_
*[New in v1.8.2](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.2)*
Like `echo` source, but uses the built-in [expr](https://github.com/antonmedv/expr) expression language ([read more](https://github.com/AlexxIT/go2rtc/blob/master/internal/expr/README.md)).
@@ -485,7 +473,7 @@ RTSP link with "normal" audio for any player: `rtsp://192.168.1.123:8554/aqara_g
#### Source: Bubble
_[New in v1.6.1](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.1)_
*[New in v1.6.1](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.1)*
Other names: [ESeeCloud](http://www.eseecloud.com/), [dvr163](http://help.dvr163.com/).
@@ -499,7 +487,7 @@ streams:
#### Source: DVRIP
_[New in v1.2.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.2.0)_
*[New in v1.2.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.2.0)*
Other names: DVR-IP, NetSurveillance, Sofia protocol (NETsurveillance ActiveX plugin XMeye SDK).
@@ -519,7 +507,7 @@ streams:
#### Source: Tapo
_[New in v1.2.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.2.0)_
*[New in v1.2.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.2.0)*
[TP-Link Tapo](https://www.tapo.com/) proprietary camera protocol with **two way audio** support.
@@ -545,7 +533,7 @@ echo -n "cloud password" | shasum -a 256 | awk '{print toupper($0)}'
#### Source: Kasa
_[New in v1.7.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.7.0)_
*[New in v1.7.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.7.0)*
[TP-Link Kasa](https://www.kasasmart.com/) non-standard protocol [more info](https://medium.com/@hu3vjeen/reverse-engineering-tp-link-kc100-bac4641bf1cd).
@@ -556,7 +544,7 @@ streams:
#### Source: GoPro
_[New in v1.8.3](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.3)_
*[New in v1.8.3](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.3)*
Support streaming from [GoPro](https://gopro.com/) cameras, connected via USB or Wi-Fi to Linux, Mac, Windows. [Read more](https://github.com/AlexxIT/go2rtc/tree/master/internal/gopro).
@@ -587,7 +575,7 @@ streams:
aqara_g3: hass:Camera-Hub-G3-AB12
```
**WebRTC Cameras** (_from [v1.6.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.0)_)
**WebRTC Cameras** (*from [v1.6.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.0)*)
Any cameras in WebRTC format are supported. But at the moment Home Assistant only supports some [Nest](https://www.home-assistant.io/integrations/nest/) cameras in this fomat.
@@ -607,7 +595,7 @@ By default, the Home Assistant API does not allow you to get dynamic RTSP link t
#### Source: ISAPI
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
This source type support only backchannel audio for Hikvision ISAPI protocol. So it should be used as second source in addition to the RTSP protocol.
@@ -620,7 +608,7 @@ streams:
#### Source: Nest
_[New in v1.6.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.0)_
*[New in v1.6.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.0)*
Currently only WebRTC cameras are supported. Stream reconnects every 5 minutes.
@@ -633,7 +621,7 @@ streams:
#### Source: Roborock
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
This source type support Roborock vacuums with cameras. Known working models:
@@ -646,7 +634,7 @@ If you have graphic pin for your vacuum - add it as numeric pin (lines: 123, 456
#### Source: WebRTC
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
This source type support four connection formats.
@@ -658,15 +646,15 @@ This source type support four connection formats.
This format is only supported in go2rtc. Unlike WHEP it supports asynchronous WebRTC connection and two way audio.
**openipc** (_from [v1.7.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.7.0)_)
**openipc** (*from [v1.7.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.7.0)*)
Support connection to [OpenIPC](https://openipc.org/) cameras.
**wyze** (_from [v1.6.1](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.1)_)
**wyze** (*from [v1.6.1](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.1)*)
Supports connection to [Wyze](https://www.wyze.com/) cameras, using WebRTC protocol. You can use [docker-wyze-bridge](https://github.com/mrlt8/docker-wyze-bridge) project to get connection credentials.
**kinesis** (_from [v1.6.1](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.1)_)
**kinesis** (*from [v1.6.1](https://github.com/AlexxIT/go2rtc/releases/tag/v1.6.1)*)
Supports [Amazon Kinesis Video Streams](https://aws.amazon.com/kinesis/video-streams/), using WebRTC protocol. You need to specify signalling WebSocket URL with all credentials in query params, `client_id` and `ice_servers` list in [JSON format](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer).
@@ -683,7 +671,7 @@ streams:
#### Source: WebTorrent
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
This source can get a stream from another go2rtc via [WebTorrent](#module-webtorrent) protocol.
@@ -723,7 +711,7 @@ By default, go2rtc establishes a connection to the source when any client reques
#### Incoming: Browser
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
You can turn the browser of any PC or mobile into an IP-camera with support video and two way audio. Or even broadcast your PC screen:
@@ -735,7 +723,7 @@ You can turn the browser of any PC or mobile into an IP-camera with support vide
#### Incoming: WebRTC/WHIP
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
You can use **OBS Studio** or any other broadcast software with [WHIP](https://www.ietf.org/archive/id/draft-ietf-wish-whip-01.html) protocol support. This standard has not yet been approved. But you can download OBS Studio [dev version](https://github.com/obsproject/obs-studio/actions/runs/3969201209):
@@ -743,7 +731,7 @@ You can use **OBS Studio** or any other broadcast software with [WHIP](https://w
#### Stream to camera
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
go2rtc support play audio files (ex. music or [TTS](https://www.home-assistant.io/integrations/#text-to-speech)) and live streams (ex. radio) on cameras with [two way audio](#two-way-audio) support (RTSP/ONVIF cameras, TP-Link Tapo, Hikvision ISAPI, Roborock vacuums, any Browser).
@@ -765,7 +753,7 @@ POST http://localhost:1984/api/streams?dst=camera1&src=ffmpeg:http://example.com
### Publish stream
_[New in v1.8.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.0)_
*[New in v1.8.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.0)*
You can publish any stream to streaming services (YouTube, Telegram, etc.) via RTMP/RTMPS. Important:
@@ -864,7 +852,7 @@ Read more about [codecs filters](#codecs-filters).
### Module: RTMP
_[New in v1.8.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.0)_
*[New in v1.8.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.8.0)*
You can get any stream as RTMP-stream: `rtmp://192.168.1.123/{stream_name}`. Only H264/AAC codecs supported right now.
@@ -944,7 +932,7 @@ webrtc:
### Module: HomeKit
_[New in v1.7.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.7.0)_
*[New in v1.7.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.7.0)*
HomeKit module can work in two modes:
@@ -998,7 +986,7 @@ homekit:
### Module: WebTorrent
_[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)_
*[New in v1.3.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.3.0)*
This module support:
@@ -1130,7 +1118,7 @@ API examples:
- MP4 snapshot: `http://192.168.1.123:1984/api/frame.mp4?src=camera1` (H264, H265)
- MP4 stream: `http://192.168.1.123:1984/api/stream.mp4?src=camera1` (H264, H265, AAC)
- MP4 file: `http://192.168.1.123:1984/api/stream.mp4?src=camera1` (H264, H265\*, AAC, OPUS, MP3, PCMA, PCMU, PCM)
- MP4 file: `http://192.168.1.123:1984/api/stream.mp4?src=camera1` (H264, H265*, AAC, OPUS, MP3, PCMA, PCMU, PCM)
- You can use `mp4`, `mp4=flac` and `mp4=all` param for codec filters
- You can use `duration` param in seconds (ex. `duration=15`)
- You can use `filename` param (ex. `filename=record.mp4`)
@@ -1143,7 +1131,7 @@ Read more about [codecs filters](#codecs-filters).
### Module: HLS
_[New in v1.1.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.1.0)_
*[New in v1.1.0](https://github.com/AlexxIT/go2rtc/releases/tag/v1.1.0)*
[HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming) is the worst technology for real-time streaming. It can only be useful on devices that do not support more modern technology, like [WebRTC](#module-webrtc), [MSE/MP4](#module-mp4).
@@ -1252,14 +1240,14 @@ Some examples:
`AVC/H.264` video can be played almost anywhere. But `HEVC/H.265` has a lot of limitations in supporting with different devices and browsers. It's all about patents and money, you can't do anything about it.
| Device | WebRTC | MSE | HTTP\* | HLS |
| ------------------------------------------------------------------------ | ---------------------------------------- | --------------------------------------- | -------------------------------------------- | ---------------------------- |
| _latency_ | best | medium | bad | bad |
| Device | WebRTC | MSE | HTTP* | HLS |
|--------------------------------------------------------------------------|-----------------------------------------|-----------------------------------------|----------------------------------------------|-----------------------------|
| *latency* | best | medium | bad | bad |
| - Desktop Chrome 107+ <br/> - Desktop Edge <br/> - Android Chrome 107+ | H264 <br/> PCMU, PCMA <br/> OPUS | H264, H265* <br/> AAC, FLAC* <br/> OPUS | H264, H265* <br/> AAC, FLAC* <br/> OPUS, MP3 | no |
| Desktop Firefox | H264 <br/> PCMU, PCMA <br/> OPUS | H264 <br/> AAC, FLAC\* <br/> OPUS | H264 <br/> AAC, FLAC\* <br/> OPUS | no |
| - Desktop Safari 14+ <br/> - iPad Safari 14+ <br/> - iPhone Safari 17.1+ | H264, H265\* <br/> PCMU, PCMA <br/> OPUS | H264, H265 <br/> AAC, FLAC\* | **no!** | H264, H265 <br/> AAC, FLAC\* |
| iPhone Safari 14+ | H264, H265\* <br/> PCMU, PCMA <br/> OPUS | **no!** | **no!** | H264, H265 <br/> AAC, FLAC\* |
| macOS [Hass App][1] | no | no | no | H264, H265 <br/> AAC, FLAC\* |
| Desktop Firefox | H264 <br/> PCMU, PCMA <br/> OPUS | H264 <br/> AAC, FLAC* <br/> OPUS | H264 <br/> AAC, FLAC* <br/> OPUS | no |
| - Desktop Safari 14+ <br/> - iPad Safari 14+ <br/> - iPhone Safari 17.1+ | H264, H265* <br/> PCMU, PCMA <br/> OPUS | H264, H265 <br/> AAC, FLAC* | **no!** | H264, H265 <br/> AAC, FLAC* |
| iPhone Safari 14+ | H264, H265* <br/> PCMU, PCMA <br/> OPUS | **no!** | **no!** | H264, H265 <br/> AAC, FLAC* |
| macOS [Hass App][1] | no | no | no | H264, H265 <br/> AAC, FLAC* |
[1]: https://apps.apple.com/app/home-assistant/id1099568401