image folder, include effect gif

Author: GitHubZJY

README.md

@@ -0,0 +1,76 @@
+# AudioVisualizeView
+    许多音乐App上常见的音频可视化效果，读取音频数据并利用傅里叶转换成可视化的字节数据，再通过自定义View渲染而成.
+    组件源码目录：https://github.com/GitHubZJY/AudioVisualizeView/tree/master/audiovisualize
+    demo目录：https://github.com/GitHubZJY/AudioVisualizeView/tree/master/app
+
+## 特性
+1. 支持自定义可视化颜色 <br/>
+2. 支持本地路径、url、raw的音频路径读取，或自定义外部MediaPlayer传入音频数据渲染 <br/>
+3. 支持自定义频谱展示数目 <br/>
+4. 支持多种可视化展示形式，包括圆形、水平、波浪、网状等 <br/>
+5. 支持AndroidX <br/>
+
+## 效果预览
+![](https://github.com/GitHubZJY/AudioVisualizeView/blob/master/image/SingleVisualize.gif)
+![](https://github.com/GitHubZJY/AudioVisualizeView/blob/master/image/ReflectVisualize.gif)
+![](https://github.com/GitHubZJY/AudioVisualizeView/blob/master/image/CircleVisualize.gif)
+![](https://github.com/GitHubZJY/AudioVisualizeView/blob/master/image/WaveVisualize.gif)
+![](https://github.com/GitHubZJY/AudioVisualizeView/blob/master/image/NetVisualize.gif)
+
+## 如何使用
+在项目根目录的build.gradle添加：
+```
+allprojects {
+    repositories {
+        ...
+        maven { url 'https://jitpack.io' }
+    }
+}
+```
+
+在项目的build.gradle添加如下依赖：
+```
+implementation 'com.github.GitHubZJY:AudioVisualizeView:v1.0.0'
+```
+
+### 1.在xml中引用
+
+```xml
+<com.zjy.audiovisualize.view.SingleVisualizeView
+        android:id="@+id/audio_visualize_view"
+        app:visualize_ratio="2"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content" />
+```
+
+### 2.在代码中初始化
+```java
+public class SingleVisualizeActivity extends AppCompatActivity {
+
+    private AudioVisualizeView vAudioVisualize;
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.activity_single_visualize);
+
+        vAudioVisualize = findViewById(R.id.audio_visualize_view);
+        vAudioVisualize.doPlay(R.raw.sound);
+    }
+
+
+    @Override
+    protected void onDestroy() {
+        super.onDestroy();
+        if (vAudioVisualize != null) {
+           vAudioVisualize.release();
+        }
+    }
+}
+```
+在需要播放的位置，调用 `doPlay` 方法，并传入对应的音频资源id或者音频文件路径，即可开始播放。
+在页面销毁时记得调用release释放对应的音频资源，避免内存泄漏。
+
+## About Me
+    一个在奋斗路上的Android小生
+    欢迎关注简书: https://www.jianshu.com/u/4cb2688ddf31

app/src/main/res/layout/activity_single_visualize.xml

@@ -11,7 +11,7 @@
     <com.zjy.audiovisualize.view.SingleVisualizeView
         android:id="@+id/audio_visualize_view"
         android:text="Hello World!"
-        app:visualize_ratio="2"
+        app:visualize_ratio="4"
         android:layout_width="match_parent"
         android:layout_height="match_parent"
         app:layout_constraintBottom_toBottomOf="parent"

app/src/main/res/layout/activity_wave_visualize.xml

@@ -11,7 +11,7 @@
     <com.zjy.audiovisualize.view.WaveVisualizeView
         android:id="@+id/audio_visualize_view"
         android:text="Hello World!"
-        app:visualize_ratio="2"
+        app:visualize_ratio="4"
         android:layout_width="match_parent"
         android:layout_height="match_parent"
         app:layout_constraintBottom_toBottomOf="parent"

app/src/main/res/values/colors.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
-    <color name="colorPrimary">#6200EE</color>
-    <color name="colorPrimaryDark">#3700B3</color>
-    <color name="colorAccent">#03DAC5</color>
+    <color name="colorPrimary">#00c1de</color>
+    <color name="colorPrimaryDark">#00c1de</color>
+    <color name="colorAccent">#00c1de</color>
 </resources>

audiovisualize/src/main/java/com/zjy/audiovisualize/view/CircleVisualizeView.java

@@ -11,7 +11,7 @@
 /**
  * Date: 2020/11/30
  * Author: Yang
- * Describe:
+ * Describe: In CIRCLE mode, show spectrum base on a circle, with jumping around it
  */
 public class CircleVisualizeView extends AudioVisualizeView{
 

audiovisualize/src/main/java/com/zjy/audiovisualize/view/NetVisualizeView.java

@@ -11,7 +11,7 @@
 /**
  * Date: 2020/11/30
  * Author: Yang
- * Describe:
+ * Describe: In NET mode, show spectrum base on a circle, with jumping around it and link all points of spectrum so like a net.
  */
 public class NetVisualizeView extends AudioVisualizeView{
 

audiovisualize/src/main/java/com/zjy/audiovisualize/view/ReflectVisualizeView.java

@@ -11,7 +11,7 @@
 /**
  * Date: 2020/11/30
  * Author: Yang
- * Describe:
+ * Describe: In REFLECT mode, show spectrum base on a horizontal line, different with HORIZONTAL_LINE mode, it will show both sides of line.
  */
 public class ReflectVisualizeView extends AudioVisualizeView{
 

audiovisualize/src/main/java/com/zjy/audiovisualize/view/SingleVisualizeView.java

@@ -16,7 +16,7 @@
 /**
  * Date: 2020/11/30
  * Author: Yang
- * Describe:
+ * Describe: In SINGLE mode, show spectrum base on a horizontal line, with jumping above of the center line , it's also default visualize mode.
  */
 public class SingleVisualizeView extends AudioVisualizeView{
 

audiovisualize/src/main/java/com/zjy/audiovisualize/view/WaveVisualizeView.java

@@ -11,7 +11,7 @@
 /**
  * Date: 2020/11/30
  * Author: Yang
- * Describe:
+ * Describe: In WAVE mode, show spectrum base on a horizontal line, it will link all points of spectrum so like a wave.
  */
 public class WaveVisualizeView extends AudioVisualizeView{