support publishing with WebRTC (#1659)

README.md

@@ -16,6 +16,7 @@ Live streams can be published to the server with:
 |RTMP servers and cameras|RTMP, RTMPS, Enhanced RTMP|H264|MPEG-4 Audio (AAC), MPEG-2 Audio (MP3)|
 |HLS servers and cameras|Low-Latency HLS, MP4-based HLS, legacy HLS|H265, H264|Opus, MPEG-4 Audio (AAC)|
 |UDP/MPEG-TS streams|Unicast, broadcast, multicast|H265, H264|Opus, MPEG-4 Audio (AAC)|
+|WebRTC||AV1, VP9, VP8, H264|Opus, G722, G711|
 |Raspberry Pi Cameras||H264||
 
 And can be read from the server with:
@@ -86,6 +87,7 @@ In the next months, the repository name and the Docker image name will be change
   * [From OBS Studio](#from-obs-studio)
   * [From OpenCV](#from-opencv)
   * [From a UDP stream](#from-a-udp-stream)
+  * [From the browser](#from-the-browser)
 * [Read from the server](#read-from-the-server)
   * [From VLC and Ubuntu](#from-vlc-and-ubuntu)
 * [RTSP protocol](#rtsp-protocol)
@@ -800,6 +802,14 @@ paths:
 
 After starting the server, the stream can be reached on `rtsp://localhost:8554/udp`.
 
+### From the browser
+
+Open the page into the browser:
+
+```
+http://localhost:8889/mystream/publish
+```
+
 ## Read from the server
 
 ### From VLC and Ubuntu

apidocs/openapi.yaml

@@ -303,15 +303,7 @@ components:
         conf:
           $ref: '#/components/schemas/PathConf'
         source:
-          oneOf:
-          - $ref: '#/components/schemas/PathSourceRTSPSession'
-          - $ref: '#/components/schemas/PathSourceRTSPSSession'
-          - $ref: '#/components/schemas/PathSourceRTMPConn'
-          - $ref: '#/components/schemas/PathSourceRTMPSConn'
-          - $ref: '#/components/schemas/PathSourceRTSPSource'
-          - $ref: '#/components/schemas/PathSourceRTMPSource'
-          - $ref: '#/components/schemas/PathSourceHLSSource'
-          - $ref: '#/components/schemas/PathSourceRPICameraSource'
+          $ref: '#/components/schemas/PathSourceOrReader'
         sourceReady:
           type: boolean
         tracks:
@@ -324,127 +316,26 @@ components:
         readers:
           type: array
           items:
-            oneOf:
-            - $ref: '#/components/schemas/PathReaderHLSMuxer'
-            - $ref: '#/components/schemas/PathReaderRTMPConn'
-            - $ref: '#/components/schemas/PathReaderRTMPSConn'
-            - $ref: '#/components/schemas/PathReaderRTSPSession'
-            - $ref: '#/components/schemas/PathReaderRTSPSSession'
-            - $ref: '#/components/schemas/PathReaderWebRTCConn'
-
-    PathSourceRTSPSession:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtspSession]
-        id:
-          type: string
-
-    PathSourceRTSPSSession:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtspsSession]
-        id:
-          type: string
-
-    PathSourceRTMPConn:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtmpConn]
-        id:
-          type: string
-
-    PathSourceRTMPSConn:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtmpsConn]
-        id:
-          type: string
-
-    PathSourceRTSPSource:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtspSource]
-
-    PathSourceRTMPSource:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtmpSource]
-
-    PathSourceHLSSource:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [hlsSource]
-
-    PathSourceRPICameraSource:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rpiCameraSource]
-
-    PathReaderHLSMuxer:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [hlsMuxer]
+            $ref: '#/components/schemas/PathSourceOrReader'
 
-    PathReaderRTMPConn:
+    PathSourceOrReader:
       type: object
       properties:
         type:
           type: string
-          enum: [rtmpConn]
-        id:
-          type: string
-
-    PathReaderRTMPSConn:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtmpsConn]
-        id:
-          type: string
-
-    PathReaderRTSPSession:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtspSession]
-        id:
-          type: string
-
-    PathReaderRTSPSSession:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [rtspsSession]
-        id:
-          type: string
-
-    PathReaderWebRTCConn:
-      type: object
-      properties:
-        type:
-          type: string
-          enum: [webRTCConn]
+          enum:
+          - hlsMuxer
+          - hlsSource
+          - rpiCameraSource
+          - rtmpSession
+          - rtmpSource
+          - rtmpsSession
+          - rtspSession
+          - rtspSource
+          - rtspsSession
+          - redirect
+          - udpSource
+          - webRTCConn
         id:
           type: string
 
@@ -560,6 +451,9 @@ components:
           type: string
         remoteCandidate:
           type: string
+        state:
+          type: string
+          enum: [read, publish]
         bytesReceived:
           type: integer
           format: int64

go.mod

@@ -19,7 +19,9 @@ require (
 	github.com/notedit/rtmp v0.0.2
 	github.com/pion/ice/v2 v2.3.2
 	github.com/pion/interceptor v0.1.16
+	github.com/pion/rtcp v1.2.10
 	github.com/pion/rtp v1.7.13
+	github.com/pion/sdp/v3 v3.0.6
 	github.com/pion/webrtc/v3 v3.2.1
 	github.com/stretchr/testify v1.8.2
 	golang.org/x/crypto v0.9.0
@@ -50,9 +52,7 @@ require (
 	github.com/pion/logging v0.2.2 // indirect
 	github.com/pion/mdns v0.0.7 // indirect
 	github.com/pion/randutil v0.1.0 // indirect
-	github.com/pion/rtcp v1.2.10 // indirect
 	github.com/pion/sctp v1.8.7 // indirect
-	github.com/pion/sdp/v3 v3.0.6 // indirect
 	github.com/pion/srtp/v2 v2.0.12 // indirect
 	github.com/pion/stun v0.4.0 // indirect
 	github.com/pion/transport/v2 v2.2.0 // indirect

internal/core/hls_muxer.go

@@ -275,9 +275,7 @@ func (m *hlsMuxer) runInner(innerCtx context.Context, innerReady chan struct{})
 
 	m.path = res.path
 
-	defer func() {
-		m.path.readerRemove(pathReaderRemoveReq{author: m})
-	}()
+	defer m.path.readerRemove(pathReaderRemoveReq{author: m})
 
 	m.ringBuffer, _ = ringbuffer.New(uint64(m.readBufferCount))
 
@@ -614,8 +612,9 @@ func (m *hlsMuxer) apiMuxersList(req hlsServerAPIMuxersListSubReq) {
 }
 
 // apiReaderDescribe implements reader.
-func (m *hlsMuxer) apiReaderDescribe() interface{} {
-	return struct {
-		Type string `json:"type"`
-	}{"hlsMuxer"}
+func (m *hlsMuxer) apiReaderDescribe() pathAPISourceOrReader {
+	return pathAPISourceOrReader{
+		Type: "hlsMuxer",
+		ID:   "",
+	}
 }

internal/core/hls_source.go

@@ -206,8 +206,9 @@ func (s *hlsSource) run(ctx context.Context, cnf *conf.PathConf, reloadConf chan
 }
 
 // apiSourceDescribe implements sourceStaticImpl.
-func (*hlsSource) apiSourceDescribe() interface{} {
-	return struct {
-		Type string `json:"type"`
-	}{"hlsSource"}
+func (*hlsSource) apiSourceDescribe() pathAPISourceOrReader {
+	return pathAPISourceOrReader{
+		Type: "hlsSource",
+		ID:   "",
+	}
 }

internal/core/path.go

@@ -90,6 +90,7 @@ type pathGetPathConfRes struct {
 
 type pathGetPathConfReq struct {
 	name        string
+	publish     bool
 	credentials authCredentials
 	res         chan pathGetPathConfRes
 }
@@ -130,6 +131,7 @@ type pathPublisherAnnounceRes struct {
 type pathPublisherAddReq struct {
 	author      publisher
 	pathName    string
+	skipAuth    bool
 	credentials authCredentials
 	res         chan pathPublisherAnnounceRes
 }
@@ -151,6 +153,11 @@ type pathPublisherStopReq struct {
 	res    chan struct{}
 }
 
+type pathAPISourceOrReader struct {
+	Type string `json:"type"`
+	ID   string `json:"id"`
+}
+
 type pathAPIPathsListItem struct {
 	ConfName      string         `json:"confName"`
 	Conf          *conf.PathConf `json:"conf"`

internal/core/path_manager.go

@@ -209,7 +209,8 @@ outer:
 				continue
 			}
 
-			err = authenticate(pm.externalAuthenticationURL, pm.authMethods, req.name, pathConf, false, req.credentials)
+			err = authenticate(pm.externalAuthenticationURL, pm.authMethods,
+				req.name, pathConf, req.publish, req.credentials)
 			if err != nil {
 				req.res <- pathGetPathConfRes{err: pathErrAuth{wrapped: err}}
 				continue
@@ -266,10 +267,12 @@ outer:
 				continue
 			}
 
-			err = authenticate(pm.externalAuthenticationURL, pm.authMethods, req.pathName, pathConf, true, req.credentials)
-			if err != nil {
-				req.res <- pathPublisherAnnounceRes{err: pathErrAuth{wrapped: err}}
-				continue
+			if !req.skipAuth {
+				err = authenticate(pm.externalAuthenticationURL, pm.authMethods, req.pathName, pathConf, true, req.credentials)
+				if err != nil {
+					req.res <- pathPublisherAnnounceRes{err: pathErrAuth{wrapped: err}}
+					continue
+				}
 			}
 
 			// create path if it doesn't exist

internal/core/reader.go

@@ -3,5 +3,5 @@ package core
 // reader is an entity that can read a stream.
 type reader interface {
 	close()
-	apiReaderDescribe() interface{}
+	apiReaderDescribe() pathAPISourceOrReader
 }

internal/core/rpicamera_source.go

@@ -128,8 +128,9 @@ func (s *rpiCameraSource) run(ctx context.Context, cnf *conf.PathConf, reloadCon
 }
 
 // apiSourceDescribe implements sourceStaticImpl.
-func (*rpiCameraSource) apiSourceDescribe() interface{} {
-	return struct {
-		Type string `json:"type"`
-	}{"rpiCameraSource"}
+func (*rpiCameraSource) apiSourceDescribe() pathAPISourceOrReader {
+	return pathAPISourceOrReader{
+		Type: "rpiCameraSource",
+		ID:   "",
+	}
 }