From e33207905014c96d19d304c28dd438a25a896ce6 Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Thu, 2 Oct 2014 23:36:04 +0200 Subject: better distinction between sydra and sydra-rtp --- LICENSE | 1 - README | 18 ++++++++++++++++-- doc/Makefile | 1 - doc/sydra-rtp.8 | 4 +++- doc/sydra-rtp.8.txt | 1 + src/Makefile | 1 - src/configure | 1 - src/daemon.h | 1 - src/datatypes.h | 1 - src/log.c | 1 - src/log.h | 1 - src/log_targets.h | 1 - src/options.c | 1 - src/options.h | 1 - src/pipelines.c | 1 - src/pipelines.h | 1 - src/sydra-rtp.c | 1 - src/udp.c | 1 - src/udp.h | 1 - src/utils.c | 1 - src/utils.h | 1 - 21 files changed, 20 insertions(+), 21 deletions(-) diff --git a/LICENSE b/LICENSE index fe83a41..1cff93a 100644 --- a/LICENSE +++ b/LICENSE @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/README b/README index b8a6ccd..90b16e0 100644 --- a/README +++ b/README @@ -6,11 +6,25 @@ Video/Audio streams from external locations. sydra has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival. -Sydra is based on GStreamer and is written in C. Sydra consists of several components: - tba... +sydra-rtp: + This is the basic utility for the task which is based on GStreamer and is + written in C. + The utility creates a gstreamer pipeline to send or receive RTP-based + Audio/Video streams. For a bidirectional connection 2 instances of sydra-rtp + are required on both sides of the communication. sydra-rtp has automatic + client detection capabilities in the form of keep alive messages. + These message are sent out by receivers to request RTP packets from a sender. + The sender will send RTP packets to one or more receivers which request + the stream. It also uses the keep alive messages to remove stale client + 'connections'. A receiver can also request to be removed from the list of + receivers. This ensures a fast and clean shutdown. + The keepalive messages are also a simple way to work around NAT and + firewalls (UDP hole punching). + +tba... Dependencies ============ diff --git a/doc/Makefile b/doc/Makefile index 09e6b49..185a01b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,7 +6,6 @@ ## sydra has been written to be used for the Elevate Festival in Graz ## Austria in order to involve external locations to present themselves ## at the festival. -## Sydra is based on GStreamer and is written in C. ## ## ## Copyright (C) 2014 Christian Pointner diff --git a/doc/sydra-rtp.8 b/doc/sydra-rtp.8 index 48a739f..a768495 100644 --- a/doc/sydra-rtp.8 +++ b/doc/sydra-rtp.8 @@ -70,7 +70,9 @@ sydra\-rtp .fi .SH "DESCRIPTION" .sp -\fBsydra\fR is a toolbox which allows you to set up multiple bidirectional Video/Audio streams from external locations\&. \fBsydra\fR has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival\&. This manpage describes \fBsydra\-rtp\fR the basic utility for the task which is based on GStreamer and is written in C\&. The \fBsydra\-rtp\fR utility creates a gstreamer pipeline to send or receive RTP\-based Audio/Video streams\&. For a bidirectional connection 2 instances of \fBsydra\-rtp\fR are required on both sides of the communication\&. \fBsydra\-rtp\fR has automatic client detection capabilities in the form of keep alive messages\&. These message are sent out by receivers to request RTP packets from a sender\&. The sender will send RTP packets to one or more receivers which request the stream\&. It also uses the keep alive messages to remove stale client \fIconnections\fR\&. A receiver can also request to be removed from the list of receivers\&. This ensures a fast and clean shutdown\&. The keepalive messages are also a simple way to work around NAT and firewalls (UDP hole punching)\&. +\fBsydra\fR is a toolbox which allows you to set up multiple bidirectional Video/Audio streams from external locations\&. \fBsydra\fR has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival\&. +.sp +This manpage describes \fBsydra\-rtp\fR the basic utility for the task which is based on GStreamer and is written in C\&. The \fBsydra\-rtp\fR utility creates a gstreamer pipeline to send or receive RTP\-based Audio/Video streams\&. For a bidirectional connection 2 instances of \fBsydra\-rtp\fR are required on both sides of the communication\&. \fBsydra\-rtp\fR has automatic client detection capabilities in the form of keep alive messages\&. These message are sent out by receivers to request RTP packets from a sender\&. The sender will send RTP packets to one or more receivers which request the stream\&. It also uses the keep alive messages to remove stale client \fIconnections\fR\&. A receiver can also request to be removed from the list of receivers\&. This ensures a fast and clean shutdown\&. The keepalive messages are also a simple way to work around NAT and firewalls (UDP hole punching)\&. .SH "OPTIONS" .sp The following options can be passed to the \fBsydra\-rtp\fR daemon: diff --git a/doc/sydra-rtp.8.txt b/doc/sydra-rtp.8.txt index 4fd87b0..31c1585 100644 --- a/doc/sydra-rtp.8.txt +++ b/doc/sydra-rtp.8.txt @@ -57,6 +57,7 @@ Video/Audio streams from external locations. *sydra* has been written to be used for the Elevate Festival in Graz Austria in order to involve external locations to present themselves at the festival. + This manpage describes *sydra-rtp* the basic utility for the task which is based on GStreamer and is written in C. The *sydra-rtp* utility creates a gstreamer pipeline to send or receive diff --git a/src/Makefile b/src/Makefile index ac211d8..9db9ead 100644 --- a/src/Makefile +++ b/src/Makefile @@ -6,7 +6,6 @@ ## sydra has been written to be used for the Elevate Festival in Graz ## Austria in order to involve external locations to present themselves ## at the festival. -## Sydra is based on GStreamer and is written in C. ## ## ## Copyright (C) 2014 Christian Pointner diff --git a/src/configure b/src/configure index 515399f..077ffe4 100755 --- a/src/configure +++ b/src/configure @@ -7,7 +7,6 @@ # sydra has been written to be used for the Elevate Festival in Graz # Austria in order to involve external locations to present themselves # at the festival. -# Sydra is based on GStreamer and is written in C. # # # Copyright (C) 2014 Christian Pointner diff --git a/src/daemon.h b/src/daemon.h index e945964..90ebc6f 100644 --- a/src/daemon.h +++ b/src/daemon.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/datatypes.h b/src/datatypes.h index 97fc03b..a306515 100644 --- a/src/datatypes.h +++ b/src/datatypes.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/log.c b/src/log.c index 639ba5b..9c9e2ae 100644 --- a/src/log.c +++ b/src/log.c @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/log.h b/src/log.h index 075fb39..3939097 100644 --- a/src/log.h +++ b/src/log.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/log_targets.h b/src/log_targets.h index 71e56b9..90414ff 100644 --- a/src/log_targets.h +++ b/src/log_targets.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/options.c b/src/options.c index 0126362..e6101aa 100644 --- a/src/options.c +++ b/src/options.c @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/options.h b/src/options.h index afc5ae6..1f93360 100644 --- a/src/options.h +++ b/src/options.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/pipelines.c b/src/pipelines.c index fa33562..cc0c44c 100644 --- a/src/pipelines.c +++ b/src/pipelines.c @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/pipelines.h b/src/pipelines.h index 0d09e3a..7f04813 100644 --- a/src/pipelines.h +++ b/src/pipelines.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/sydra-rtp.c b/src/sydra-rtp.c index c8c15da..de65e25 100644 --- a/src/sydra-rtp.c +++ b/src/sydra-rtp.c @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/udp.c b/src/udp.c index 719bb2f..205b464 100644 --- a/src/udp.c +++ b/src/udp.c @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/udp.h b/src/udp.h index fca7ca3..7370133 100644 --- a/src/udp.h +++ b/src/udp.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/utils.c b/src/utils.c index abeb595..443ab62 100644 --- a/src/utils.c +++ b/src/utils.c @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner diff --git a/src/utils.h b/src/utils.h index 97c497f..215efed 100644 --- a/src/utils.h +++ b/src/utils.h @@ -6,7 +6,6 @@ * sydra has been written to be used for the Elevate Festival in Graz * Austria in order to involve external locations to present themselves * at the festival. - * Sydra is based on GStreamer and is written in C. * * * Copyright (C) 2014 Christian Pointner -- cgit v1.2.3