From: Andre Noll <maan@systemlinux.org>
Date: Sat, 17 Oct 2009 15:08:38 +0000 (+0200)
Subject: Add docu of struct asf_header_info.
X-Git-Tag: v0.4.1~87
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=8fbaafaaaea2ec1e3873bdcf5cb2de3a643fc5e6

Add docu of struct asf_header_info.
---

diff --git a/wma.h b/wma.h
index 4b313427..850ffc97 100644
--- a/wma.h
+++ b/wma.h
@@ -3,15 +3,24 @@
  *
  * Both para_filter and para_afh need to read the header.
  */
+
+/** Information stored in the asf header. */
 struct asf_header_info {
 	/** The size of the audio file header. */
 	int header_len;
+	/** Offset of the audio stream info header. */
 	int audio_stream_info_start;
+	/** Number of channels. */
 	uint8_t channels;
+	/** One of the 5 possible sample rates. */
 	uint16_t sample_rate;
+	/** Size of one data block. */
 	uint16_t block_align;
+	/** Bits per second. */
 	uint32_t bit_rate;
+	/** Further decoding information (ignored). */
 	uint32_t flags1;
+	/** Whether to use exp_vlc, bit reservoir, variable block len. */
 	uint16_t flags2;
 };
 
@@ -20,7 +29,7 @@ int wma_log2(unsigned int v);
 const char *search_pattern(const char *pattern, int pattern_len,
 		const char *buf, int buf_size);
 int read_asf_header(char *buf, int loaded, struct asf_header_info *ahi);
-#define M_PI           3.14159265358979323846	/* pi */
+
 #define WMA_FRAME_SKIP 31
 #define DECLARE_ALIGNED(n,t,v)      t v __attribute__ ((aligned (n)))
 #define DECLARE_ALIGNED_16(t, v) DECLARE_ALIGNED(16, t, v)