baseaudioencoder: additional documentation on granule semantics and

configuration

diff --git a/gst-libs/gst/audio/gstbaseaudioencoder.c b/gst-libs/gst/audio/gstbaseaudioencoder.c
index 27211a7..3c2349f 100644 (file)
--- a/gst-libs/gst/audio/gstbaseaudioencoder.c
+++ b/gst-libs/gst/audio/gstbaseaudioencoder.c
@@ -116,6 +116,13 @@
  * or draining all currently remaining input data, depending on the direction
  * of the discontuinity.
  *
+ * If perfect timestamps are arranged, it is also possible to request baseclass
+ * (usually set by subclass) to provide additional buffer metadata (in OFFSET
+ * and OFFSET_END) fields according to granule defined semantics currently
+ * needed by oggmux.  Specifically, OFFSET is set to granulepos (= sample count
+ * including buffer) and OFFSET_END to corresponding timestamp (as determined
+ * by same sample count and sample rate).
+ *
  * Things that subclass need to take care of:
  * <itemizedlist>
  *   <listitem><para>Provide pad templates</para></listitem>