X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=vss.c;h=b8c7463b68345ccea84a15dfd9d4625adf7d3ac4;hb=c708253b998a6253ddc5f18b9403fe27aad5e99b;hp=eef3a6320e2a7ed9e4ee8757bb0edde6ab1e8918;hpb=c19a0921ea3a8cd9d0e35cb2b09748c3f9f607ef;p=paraslash.git

diff --git a/vss.c b/vss.c
index eef3a632..b8c7463b 100644
--- a/vss.c
+++ b/vss.c
@@ -89,35 +89,79 @@ struct vss_task {
 	size_t header_len;
 };
 
+/**
+ * The list of currently connected fec clients.
+ *
+ * Senders may use \ref vss_add_fec_client() to add entries to the list.
+ */
 static struct list_head fec_client_list;
 
+/**
+ * Describes one slice of a FEC group.
+ *
+ * FEC slices directly correspond to the data packages sent by the paraslash
+ * senders that use FEC. Each slice is identified by its group number and its
+ * number within the group. All slices have the same size, but the last slice
+ * of the group may not be filled entirely.
+ */
 struct fec_slice {
+	/** The slice number within the FEC group. */
 	uint8_t num;
+	/** The number of used bytes in this slice. */
 	uint16_t bytes;
 };
 
+/**
+ * Data associated with one FEC group.
+ *
+ * A FEC group consists of a fixed number of slices and this number is given by
+ * the \a slices_per_group parameter of struct \ref fec_client_parms. Each FEC
+ * group contains a number of chunks of the current audio file.
+ */
 struct fec_group {
+	/** The number of the FEC group. */
 	uint32_t num;
+	/** Number of bytes in this group. */
 	uint32_t bytes;
+	/** The first chunk of the current audio file belonging to the group. */
 	uint32_t first_chunk;
+	/** The number of chunks contained in this group. */
 	uint32_t num_chunks;
+	/** The time needed to play all chunks of the group. */
 	struct timeval duration;
+	/** When the first chunk was sent. */
 	struct timeval start;
+	/** \a The group duration divided by \a slices_per_group. */
 	struct timeval slice_duration;
 };
 
+/**
+ * Describes one connected FEC client.
+ */
 struct fec_client {
+	/** Parameters requested by the client. */
 	struct fec_client_parms *fcp;
+	/** Used by the core FEC code. */
 	struct fec_parms *parms;
+	/** The position of this client in the fec client list. */
 	struct list_head node;
+	/** When the first slice for this client was sent. */
 	struct timeval stream_start;
+	/** The first chunk sent to this FEC client. */
 	int first_stream_chunk;
+	/** Describes the current group. */
 	struct fec_group group;
+	/** Describes the current slice. */
 	struct fec_slice slice;
+	/** The data to be FEC-encoded (point to a region within the mapped audio file). */
 	const unsigned char **src_data;
+	/** Used for the last source pointer of the last group. */
 	unsigned char *extra_src_buf;
+	/** The size of the buffer for the extra source pointer. */
 	size_t extra_src_buf_size;
+	/** Contains FEC-encoded data. */
 	unsigned char *enc_buf;
+	/** Size of \a enc_buf. */
 	size_t enc_buf_size;
 };
 
@@ -222,6 +266,7 @@ static void write_fec_header(struct fec_client *fc)
 /**
  * Return a buffer that marks the end of the stream.
  *
+ * \param buf Result pointer.
  * \return The length of the eof buffer.
  *
  * This is used for (multicast) udp streaming where closing the socket on the