# HG changeset patch
# User melanson
# Date 1082835049 0
# Node ID 2b0fc6b25ab878f1879909f8ff06fb9aa219b30a
# Parent  e1fc7c59855876731988ac83d66909414c021b45
add the minimal documentation to make this decoder useful

diff -r e1fc7c598558 -r 2b0fc6b25ab8 wmadec.c
--- a/wmadec.c	Sat Apr 24 15:23:50 2004 +0000
+++ b/wmadec.c	Sat Apr 24 19:30:49 2004 +0000
@@ -20,6 +20,15 @@
 /**
  * @file wmadec.c
  * WMA compatible decoder.
+ * This decoder handles Microsoft Windows Media Audio data, versions 1 & 2.
+ * WMA v1 is identified by audio format 0x160 in Microsoft media files 
+ * (ASF/AVI/WAV). WMA v2 is identified by audio format 0x161.
+ *
+ * To use this decoder, a calling application must supply the extra data
+ * bytes provided with the WMA data. These are the extra, codec-specific
+ * bytes at the end of a WAVEFORMATEX data structure. Transmit these bytes 
+ * to the decoder using the extradata[_size] fields in AVCodecContext. There 
+ * should be 4 extra bytes for v1 data and 6 extra bytes for v2 data.
  */
 
 #include "avcodec.h"