diff options
| author | Aaron Boxer <boxerab@gmail.com> | 2016-05-11 15:01:32 -0400 |
|---|---|---|
| committer | Sebastian Dröge <sebastian@centricular.com> | 2016-05-13 11:01:09 +0300 |
| commit | 82c2a5cbf830cf8706e2482875f9b7c2b8584fe3 (patch) | |
| tree | b7cac5a4635477f87f394521aff37c10edde69fd | |
| parent | fe4dc610e61c71acd8747e8bc1fea0630a4bfcf4 (diff) | |
rtpj2k: update documentation
https://bugzilla.gnome.org/show_bug.cgi?id=745187
| -rw-r--r-- | gst/rtp/gstrtpj2kdepay.c | 11 | ||||
| -rw-r--r-- | gst/rtp/gstrtpj2kpay.c | 17 |
2 files changed, 22 insertions, 6 deletions
diff --git a/gst/rtp/gstrtpj2kdepay.c b/gst/rtp/gstrtpj2kdepay.c index f6294195a..acf6f9289 100644 --- a/gst/rtp/gstrtpj2kdepay.c +++ b/gst/rtp/gstrtpj2kdepay.c @@ -17,6 +17,17 @@ * Boston, MA 02110-1301, USA. */ + + /** + * SECTION:element-rtpj2kdepay + * + * Depayload an RTP-payloaded JPEG 2000 image into RTP packets according to RFC 5371 + * and RFC 5372. + * For detailed information see: https://datatracker.ietf.org/doc/rfc5371/ + * and https://datatracker.ietf.org/doc/rfc5372/ + */ + + #ifdef HAVE_CONFIG_H # include "config.h" #endif diff --git a/gst/rtp/gstrtpj2kpay.c b/gst/rtp/gstrtpj2kpay.c index ee4da0308..fde51db02 100644 --- a/gst/rtp/gstrtpj2kpay.c +++ b/gst/rtp/gstrtpj2kpay.c @@ -17,15 +17,20 @@ * Boston, MA 02110-1301, USA. */ -/** + /** * SECTION:element-rtpj2kpay * - * Payload encode JPEG 2000 pictures into RTP packets according to RFC 5371. - * For detailed information see: http://www.rfc-editor.org/rfc/rfc5371.txt + * Payload encode JPEG 2000 images into RTP packets according to RFC 5371 + * and RFC 5372. + * For detailed information see: https://datatracker.ietf.org/doc/rfc5371/ + * and https://datatracker.ietf.org/doc/rfc5372/ + * + * The payloader takes a JPEG 2000 image, scans it for "packetization + * units" and constructs the RTP packet header followed by the JPEG 2000 + * codestream. A "packetization unit" is defined as either a JPEG 2000 main header, + * a JPEG 2000 tile-part header, or a JPEG 2000 packet. + * * - * The payloader takes a JPEG 2000 picture, scans the header for packetization - * units and constructs the RTP packet header followed by the actual JPEG 2000 - * codestream. */ #ifdef HAVE_CONFIG_H |