[NUT-devel] [nut]: r263 - trunk/libnut/libnut.h

[ods15]

Author: ods15
Date: Tue Nov 21 19:38:05 2006
New Revision: 263

Modified:
   trunk/libnut/libnut.h

Log:
better documentation of nut_info_packet_t


Modified: trunk/libnut/libnut.h
==============================================================================
--- trunk/libnut/libnut.h	(original)
+++ trunk/libnut/libnut.h	Tue Nov 21 19:38:05 2006
@@ -85,9 +85,9 @@
 
 /// Single info packet struct
 typedef struct {
-	int count;                 ///< -1 terminates the nut_info_packet_t array
+	int count;                 ///< Indicates how many info fields are provided in #fields
 	int stream_id_plus1;       ///< Zero indicates non-stream-specific info packet
-	int chapter_id;            ///< Zero indicates info packet applies to complete file. Positive values are real, non-overlapping chapters. Negative values may overlap
+	int chapter_id;            ///< Indicates which subsection of file this info packet applies to
 	nut_timebase_t chapter_tb; ///< Timebase of #chapter_start and #chapter_len
 	uint64_t chapter_start;    ///< Start of chapter or complete file
 	uint64_t chapter_len;      ///< Length of chapter or complete file
@@ -321,6 +321,29 @@
  * data.
  */
 
+/*! \var int nut_info_packet_t::count
+ * For arrays of #nut_info_packet_t, the packet with a #count of \a -1
+ * terminates the array.
+ */
+
+/*! \var nut_info_packet_t::chapter_id
+ * Value of 0 indicates info packet applies to complete file.
+ *
+ * Positive values are real chapters. Real chapters must not overlap. The
+ * #chapter_id of a real chapter must not be higher than the total amount
+ * of real chapters in the file.
+ *
+ * Negative values indicate a subsection of file and may overlap.
+ *
+ * If #chapter_id is 0, #chapter_start and #chapter_len provide length of
+ * entire file.
+ */
+
+/*! \var nut_info_packet_t::chapter_tb
+ * In muxing, values #chapter_tb \b must be identical to the timebase of
+ * one of the streams
+ */
+
 /*!
  * \var int nut_frame_table_input_t::flag
  *