AD7999によるボリューム読み取りのAPIを実装した

[uzume/uzume_bfin.git] / uzume_prototype / uzume.h

diff --git a/uzume_prototype/uzume.h b/uzume_prototype/uzume.h
index 3c56556..b072e39 100644 (file)
--- a/uzume_prototype/uzume.h
+++ b/uzume_prototype/uzume.h
@@ -4,15 +4,35 @@
  */
 #ifndef UZUME_H_
 #define UZUME_H_
+
+/**
+ * @brief 汎用固定小数点型。
+ * @datails
+ * Blackfinでは32bitで使用する。整数部のビット長は0である。
+ */
+typedef int FX32;
+
 /**
  * @brief 割り込み1回あたりのサンプル数。ユーザーが変えてもよい。
  */
+#define UZUME_INT_BITS 0
+/**
+ * @brief スケーリング・ファクター
+ * @details
+ * AUDIOSAMPLE型の整数部のビット数を指定する。0の場合フォーマットは1.32、
+ * 3ならば4.28、7ならば8.24となる。
+ */
 #define UZUME_BLOCKSIZE 64
 /**
  * @brief サンプルあたりのスロット数。I2Sなら2。
  */
 #define SLOT_PER_SAMPLE 2
 
+/**
+ * @brief オーディオコーデック用データ型。
+ * @datails
+ * Blackfinでは32bitで使用する。整数部のビット長は、 UZUME_INT_BITS で宣言する。
+ */
 typedef int AUDIOSAMPLE;
 
 // CODECのスロット番号