Added a note to cTsToPes::GetPes() about having to call it repeatedly, once it has returned a non-NULL value

2 files changed, 8 insertions, 1 deletions

diff --git a/HISTORY b/HISTORY
index fd502e07..edb75444 100644
--- a/HISTORY
+++ b/HISTORY
@@ -6091,3 +6091,5 @@ Video Disk Recorder Revision History
 - Removed limitation to PAL resolution from SPU handling.
 - Checking fd_video in cDvbDevice::GetVideoSize() to avoid error messages on
   systems with no real primary replay device (reported by Martin Neuditschko).
+- Added a note to cTsToPes::GetPes() about having to call it repeatedly, once
+  it has returned a non-NULL value.
diff --git a/remux.h b/remux.h
index 063acaa6..3ee9c9e9 100644
--- a/remux.h
+++ b/remux.h
@@ -4,7 +4,7 @@
  * See the main source file 'vdr.c' for copyright information and
  * how to reach the author.
  *
- * $Id: remux.h 2.10 2009/04/19 10:57:09 kls Exp $
+ * $Id: remux.h 2.11 2009/05/10 13:43:52 kls Exp $
  */
 
 #ifndef __REMUX_H
@@ -254,6 +254,11 @@ public:
        ///< is not complete yet. If the packet is complete, Length will contain
        ///< the total packet length. The returned pointer is only valid until
        ///< the next call to PutTs() or Reset(), or until this object is destroyed.
+       ///< Once GetPes() has returned a non-NULL value, it must be called
+       ///< repeatedly, and the data processed, until it returns NULL. This
+       ///< is because video packets may be larger than the data a single
+       ///< PES packet with an actual length field can hold, and are therefore
+       ///< split into several PES packates with smaller sizes.
   void Reset(void);
        ///< Resets the converter. This needs to be called after a PES packet has
        ///< been fetched by a call to GetPes(), and before the next call to