From: Thomas Vander Stichele Date: Tue, 13 Jun 2006 19:24:34 +0000 (+0000) Subject: docs/: add a gdp image X-Git-Tag: RELEASE-0_10_9~84 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0734eb921c83f1f844e54bb252064269d219a61f;hp=3c3956907eb0543ca62807d730471389ddae0089;p=platform%2Fupstream%2Fgstreamer.git docs/: add a gdp image Original commit message from CVS: * docs/README: * docs/images/gdp-header.svg: add a gdp image * docs/libs/Makefile.am: * docs/libs/gdp-header.png: * libs/gst/dataprotocol/dataprotocol.c: add it to the API docs * docs/manual/intro-motivation.xml: fix typo --- diff --git a/ChangeLog b/ChangeLog index 0bb4d212eb..b726eea268 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2006-06-13 Thomas Vander Stichele + + * docs/README: + * docs/images/gdp-header.svg: + add a gdp image + * docs/libs/Makefile.am: + * docs/libs/gdp-header.png: + * libs/gst/dataprotocol/dataprotocol.c: + add it to the API docs + * docs/manual/intro-motivation.xml: + fix typo + 2006-06-13 Tim-Philipp Müller * gst/gst.c: (scan_and_update_registry), (init_post): diff --git a/docs/README b/docs/README index 10a92ea537..7666957c5d 100644 --- a/docs/README +++ b/docs/README @@ -341,3 +341,9 @@ It's a really nice development app allowing you to look up API stuff from various gtk-doc'd libraries. GStreamer is one of these ;) gtk-doc generates both html API docs and the matching .devhelp files + +IMAGES +------ +It's important to keep the original source format for images, to be able +to change and regenerate later on. Original files go in +docs/images diff --git a/docs/images/gdp-header.svg b/docs/images/gdp-header.svg new file mode 100644 index 0000000000..9b88231fe8 --- /dev/null +++ b/docs/images/gdp-header.svg @@ -0,0 +1,906 @@ + + + + + + + + + image/svg+xml + + + + + + + + + Version + + + + + Flags + + + + + + + + + Payload type + + + + + Payload length + + + + + + + + + + Timestamp + + + + + Duration + + + + + + + + + Offset + + + + + Offset end + + + + + + + + + + + + + + + + + Buffer flags + + + + + ABI + + + + + ABI + + + + + ABI + + + + + CRC header + + + + + CRC payload + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GStreamerData Protocol + + diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index 0463e72ca3..6d611fce7f 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -72,7 +72,7 @@ IGNORE_HFILES = \ dp-private.h # Images to copy into HTML directory. -HTML_IMAGES = +HTML_IMAGES = gdp-header.png # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). content_files = diff --git a/docs/libs/gdp-header.png b/docs/libs/gdp-header.png new file mode 100644 index 0000000000..d7d08f6e6f Binary files /dev/null and b/docs/libs/gdp-header.png differ diff --git a/docs/manual/intro-motivation.xml b/docs/manual/intro-motivation.xml index e11e8e6a82..5ba2ed54c7 100644 --- a/docs/manual/intro-motivation.xml +++ b/docs/manual/intro-motivation.xml @@ -116,7 +116,7 @@ at the lowest level as it only adds overhead for the local case. That said, it shouldn't be hard to create a wrapper around the core components. There are tcp plugins now that implement a - &GStreamer; Data Protocol that allows pipelines to be slit over + &GStreamer; Data Protocol that allows pipelines to be split over TCP. These are located in the gst-plugins module directory gst/tcp. diff --git a/libs/gst/dataprotocol/dataprotocol.c b/libs/gst/dataprotocol/dataprotocol.c index fa07d0cab9..887b2eeb72 100644 --- a/libs/gst/dataprotocol/dataprotocol.c +++ b/libs/gst/dataprotocol/dataprotocol.c @@ -60,6 +60,10 @@ * #GstDPPacketizer object and invoking its packetizer functions. * For backwards-compatibility reasons, the old 0.2 methods are still * available but deprecated. + * + * For reference, this image shows the byte layout of the GDP header: + * + * */ #ifdef HAVE_CONFIG_H