添加了 readme, 稍微优化了下注释什么的

Author: SlimeNull

AudioVisualizer.sln

@@ -9,7 +9,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WpfAudioVisualizer", "WpfAu
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "LibAudioVisualizer", "LibAudioVisualizer\LibAudioVisualizer.csproj", "{15A2D4B9-BD52-411F-96E9-2BFACFEC4579}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AudioVisualizerDx", "AudioVisualizerDx\AudioVisualizerDx.csproj", "{20B17F7E-11C3-4E46-9E79-DE9A3B25B640}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AudioVisualizerDx", "AudioVisualizerDx\AudioVisualizerDx.csproj", "{20B17F7E-11C3-4E46-9E79-DE9A3B25B640}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{F54E0AE6-96AB-42EA-AFD1-37F1BCBAD304}"
+	ProjectSection(SolutionItems) = preProject
+		readme.md = readme.md
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

AudioVisualizer/MainWindow.cs

@@ -69,7 +69,7 @@ private Color[] GetAllHsvColors()
         }
 
         /// <summary>
-        /// 
+        /// 当捕获有数据的时候, 就怼到可视化器里面
         /// </summary>
         /// <param name="sender"></param>
         /// <param name="e"></param>
@@ -223,6 +223,19 @@ private void DrawCurve(Graphics g, Pen pen, double[] spectrumData, int pointCoun
             g.DrawCurve(pen, points);
         }
 
+        /// <summary>
+        /// 画简单的圆环线条
+        /// </summary>
+        /// <param name="g"></param>
+        /// <param name="brush"></param>
+        /// <param name="spectrumData"></param>
+        /// <param name="stripCount"></param>
+        /// <param name="xOffset"></param>
+        /// <param name="yOffset"></param>
+        /// <param name="radius"></param>
+        /// <param name="spacing"></param>
+        /// <param name="rotation"></param>
+        /// <param name="scale"></param>
         private void DrawCircleStrips(Graphics g, Brush brush, double[] spectrumData, int stripCount, double xOffset, double yOffset, double radius, double spacing, double rotation, double scale)
         {
             double rotationAngle = Math.PI / 180 * rotation;
@@ -258,7 +271,7 @@ private void DrawCircleStrips(Graphics g, Brush brush, double[] spectrumData, in
         }
 
         /// <summary>
-        /// 画圆环条
+        /// 画圆环渐变条
         /// </summary>
         /// <param name="g"></param>
         /// <param name="inner"></param>
@@ -312,20 +325,30 @@ private void DrawCircleGradientStrips(Graphics g, Color inner, Color outer, doub
                 PointF outerP = new PointF((p3.X + p4.X) / 2, (p3.Y + p4.Y) / 2);
 
                 Vector2 offset = new Vector2(outerP.X - innerP.X, outerP.Y - innerP.Y);
-                if (MathF.Sqrt(offset.X * offset.X + offset.Y * offset.Y) < 3)
+                if (MathF.Sqrt(offset.X * offset.X + offset.Y * offset.Y) < 1)                                // 渐变笔刷两点之间距离不能太小
                     continue;
 
                 try
                 {
-                    LinearGradientBrush brush = new LinearGradientBrush(innerP, outerP, inner, outer);
-                    g.FillPolygon(brush, polygon);
-
-                    brush.Dispose();
+                    using LinearGradientBrush brush = new LinearGradientBrush(innerP, outerP, inner, outer);        // 这里有玄学 bug, 这个 线性笔刷会 OutMemoryException
+                    g.FillPolygon(brush, polygon);                                                            // 但是实际上不应该有这个异常...
                 }
                 catch { }
             }
         }
 
+        /// <summary>
+        /// 画简单的线条
+        /// </summary>
+        /// <param name="g"></param>
+        /// <param name="brush"></param>
+        /// <param name="spectrumData"></param>
+        /// <param name="stripCount"></param>
+        /// <param name="drawingWidth"></param>
+        /// <param name="xOffset"></param>
+        /// <param name="yOffset"></param>
+        /// <param name="spacing"></param>
+        /// <param name="scale"></param>
         private void DrawStrips(Graphics g, Brush brush, double[] spectrumData, int stripCount, int drawingWidth, float xOffset, float yOffset, float spacing, double scale)
         {
             float stripWidth = (drawingWidth - spacing * stripCount) / stripCount;
@@ -354,6 +377,15 @@ private void DrawStrips(Graphics g, Brush brush, double[] spectrumData, int stri
             }
         }
 
+        /// <summary>
+        /// 画渐变的边框
+        /// </summary>
+        /// <param name="g"></param>
+        /// <param name="inner"></param>
+        /// <param name="outer"></param>
+        /// <param name="area"></param>
+        /// <param name="scale"></param>
+        /// <param name="width"></param>
         private void DrawGradientBorder(Graphics g, Color inner, Color outer, Rectangle area, double scale, float width)
         {
             int thickness = (int)(width * scale);
@@ -394,25 +426,24 @@ private void DrawingTimer_Tick(object? sender, EventArgs e)
             Color color1 = allColors[colorIndex % allColors.Length];
             Color color2 = allColors[(colorIndex + 200) % allColors.Length];
 
-            double[] bassArea = Visualizer.TakeSpectrumOfFrequency(spectrumData, capture.WaveFormat.SampleRate, 250);
-            double bassScale = bassArea.Average() * 100;
-            double extraScale = Math.Min(drawingPanel.Width, drawingPanel.Height) / 6;
+            double[] bassArea = Visualizer.TakeSpectrumOfFrequency(spectrumData, capture.WaveFormat.SampleRate, 250);       // 低频区域
+            double bassScale = bassArea.Average() * 100;                                                                    // 低音导致的缩放 (比例数)
+            double extraScale = Math.Min(drawingPanel.Width, drawingPanel.Height) / 6;                                      // 低音导致的缩放 (乘上窗口大小)
 
             Rectangle border = new Rectangle(Point.Empty, drawingPanel.Size);
 
             BufferedGraphics buffer = BufferedGraphicsManager.Current.Allocate(drawingPanel.CreateGraphics(), drawingPanel.ClientRectangle);
             Graphics g = buffer.Graphics;
 
-            if (oldBuffer != null)
-            {
-                oldBuffer.Render(buffer.Graphics);
-                oldBuffer.Dispose();
-            }
+            //if (oldBuffer != null)                        // 如果你想要实现 "留影" 效果, 就取消注释这段代码, 并且将 g.Clear 改为 g.FillRectange(xxx, 半透明的黑色)
+            //{
+            //    oldBuffer.Render(buffer.Graphics);
+            //    oldBuffer.Dispose();
+            //}
 
-            using Pen pen = new Pen(Color.Pink);
-            using Brush brush = new SolidBrush(Color.Purple);
+            using Pen pen = new Pen(Color.Pink);                  // 画音频采样波形用的笔
 
-            g.SmoothingMode = SmoothingMode.HighQuality;
+            g.SmoothingMode = SmoothingMode.HighQuality;          // 嗨嗨害, 那必须得是高质量绘图
             g.Clear(drawingPanel.BackColor);
 
             DrawGradientBorder(g, Color.FromArgb(0, color1), color2, border, bassScale, drawingPanel.Width / 10);
@@ -423,7 +454,7 @@ private void DrawingTimer_Tick(object? sender, EventArgs e)
 
             buffer.Render();
 
-            oldBuffer = buffer;
+            oldBuffer = buffer;                                   // 保存一下 buffer (之所以不全局只使用一个 Buffer 是因为,,, 用户可能调整窗口大小, 所以每一帧都必须适应)
         }
 
         private void MainWindow_Load(object sender, EventArgs e)

readme.md

@@ -0,0 +1,37 @@
+# 音频可视化器 / AudioVisualizer
+
+分别在 GDI+ 和 Direct2D(SharpDX) 上实现了音频可视化 \
+Audio visualization on GDI+ and Direct2D (SharpDX) respectively
+
+你可以学到: 如何实现音频可视化, 如何使用 SharpDX 进行 2D 绘图 \
+You can learn: how to implement audio visualization, how to use SharpDX for 2D drawing
+
+![preview](res/preview1.png)
+
+## 主要逻辑 / Main logic
+
+### 音频可视化 / Audio visualization
+
+- 每一帧对旧数据和新数据进行 "渐变", 值不会立即更新为新值, 而是更新为两值的中间值, 也就是说, 每一次刷新, 数据只会 "移动" 一定比例 \
+  Each frame do lerp operation between the old data and the new data, the value is not updated to the new value immediately, but is updated to the intermediate value of the two values, that is, each refresh, the data will only "move" a certain percentage
+- 加个窗函数, 遮盖住低频与高频, 主要展示中间频率 \
+  Add a window function to cover the low frequency and high frequency, mainly showing the middle frequency
+- 将低频区域的值取出来, 单独用来做 "低音" 的视觉效果 \
+  Take out the value of the low-frequency area and use it separately for the visual effect of "bass"
+
+### WinForm
+
+- 使用 WinForm 的 Timer 实现在单线程的定时频谱数据获取以及界面刷新 \
+  Using WinForm's Timer to achieve timed spectrum data acquisition and interface refresh in a single thread
+
+### GDI+
+
+- 使用 BufferedGraphics 使绘制时不会闪屏 \
+  Use BufferedGraphics to draw without flickering
+
+## Enjoy
+
+代码注释很完善, 所以, 学起来呀~ \
+The code comments are very perfect, so let's just learn it~
+
+![code](res/code.png)