From a8a4f11a5ed008277ae29d23c5e1543cfe0b71b2 Mon Sep 17 00:00:00 2001 From: luweike Date: Thu, 19 Dec 2024 18:01:22 +0800 Subject: [PATCH 1/2] docs: Remove unnecessary software design section --- docs/en/design-guide/index.rst | 1 - docs/en/design-guide/software-design.rst | 34 --------------------- docs/zh_CN/design-guide/software-design.rst | 1 - 3 files changed, 36 deletions(-) delete mode 100644 docs/en/design-guide/software-design.rst delete mode 100644 docs/zh_CN/design-guide/software-design.rst diff --git a/docs/en/design-guide/index.rst b/docs/en/design-guide/index.rst index 2c7a7fd08..43c0ea137 100644 --- a/docs/en/design-guide/index.rst +++ b/docs/en/design-guide/index.rst @@ -9,7 +9,6 @@ The ESP32 is a powerful chip well positioned as a MCU of the audio projects. Thi Project Design Design Considerations - Software Design Hardware Design (PDF) Development Boards Audio Samples diff --git a/docs/en/design-guide/software-design.rst b/docs/en/design-guide/software-design.rst deleted file mode 100644 index f307491d1..000000000 --- a/docs/en/design-guide/software-design.rst +++ /dev/null @@ -1,34 +0,0 @@ -Software Design -*************** - -Espressif audio framework project. - -Features -======== - -1. All of Streams and Codecs based on audio element. -2. All events based on queue. -3. Audio pipeline supports dynamic combination. -4. Audio pipeline supports multiple elements. -5. Pipeline Support functionality plug-in. -6. Audio common peripherals support work in the one task. -7. Support post-event mechanism in peripherals. -8. Support high level audio play API based on element and audio pipeline. -9. Audio high level interface supports dynamic adding of codec library. -10. Audio high level interface supports dynamic adding of input and output stream. -11. ESP audio supports multiple audio pipelines. - -Design Components -================= - -Five basic components are - Audio Element, Audio Event, Audio Pipeline, ESP peripherals, ESP audio - -.. toctree:: - :maxdepth: 1 - - Audio Element - Audio Event - Audio Pipeline - Audio Peripherals - Audio Player - diff --git a/docs/zh_CN/design-guide/software-design.rst b/docs/zh_CN/design-guide/software-design.rst deleted file mode 100644 index 3d35cf935..000000000 --- a/docs/zh_CN/design-guide/software-design.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/design-guide/software-design.rst \ No newline at end of file From 97a7cea179cb981e8c0d47c6a4fbd1e9cb2313f3 Mon Sep 17 00:00:00 2001 From: luweike Date: Fri, 20 Dec 2024 10:15:31 +0800 Subject: [PATCH 2/2] docs: remove unnecessary files --- docs/en/design-guide/audio-element.rst | 7 ------- docs/en/design-guide/audio-event.rst | 7 ------- docs/en/design-guide/audio-peripheral.rst | 19 ------------------- docs/en/design-guide/audio-pipeline.rst | 7 ------- docs/en/design-guide/esp-audio.rst | 7 ------- docs/zh_CN/design-guide/audio-element.rst | 1 - docs/zh_CN/design-guide/audio-event.rst | 1 - docs/zh_CN/design-guide/audio-peripheral.rst | 1 - docs/zh_CN/design-guide/audio-pipeline.rst | 1 - docs/zh_CN/design-guide/esp-audio.rst | 1 - 10 files changed, 52 deletions(-) delete mode 100644 docs/en/design-guide/audio-element.rst delete mode 100644 docs/en/design-guide/audio-event.rst delete mode 100644 docs/en/design-guide/audio-peripheral.rst delete mode 100644 docs/en/design-guide/audio-pipeline.rst delete mode 100644 docs/en/design-guide/esp-audio.rst delete mode 100644 docs/zh_CN/design-guide/audio-element.rst delete mode 100644 docs/zh_CN/design-guide/audio-event.rst delete mode 100644 docs/zh_CN/design-guide/audio-peripheral.rst delete mode 100644 docs/zh_CN/design-guide/audio-pipeline.rst delete mode 100644 docs/zh_CN/design-guide/esp-audio.rst diff --git a/docs/en/design-guide/audio-element.rst b/docs/en/design-guide/audio-element.rst deleted file mode 100644 index f6845bbd3..000000000 --- a/docs/en/design-guide/audio-element.rst +++ /dev/null @@ -1,7 +0,0 @@ -Audio Element -============= - -Example -------- - -Please refer to :component_file:`audio_stream/fatfs_stream.c` for an example of using an audio element. \ No newline at end of file diff --git a/docs/en/design-guide/audio-event.rst b/docs/en/design-guide/audio-event.rst deleted file mode 100644 index 88e0cf594..000000000 --- a/docs/en/design-guide/audio-event.rst +++ /dev/null @@ -1,7 +0,0 @@ -Audio Event -=========== - -Example -------- - -Please refer to :example_file:`player/pipeline_http_mp3/main/play_http_mp3_example.c` for an example of using an audio event. \ No newline at end of file diff --git a/docs/en/design-guide/audio-peripheral.rst b/docs/en/design-guide/audio-peripheral.rst deleted file mode 100644 index 153be9a06..000000000 --- a/docs/en/design-guide/audio-peripheral.rst +++ /dev/null @@ -1,19 +0,0 @@ -Audio Peripheral -================ - -Example -------- - -:: - - ESP_LOGI(TAG, "[ 3 ] Start and wait for Wi-Fi network"); - esp_periph_config_t periph_cfg = DEFAULT_ESP_PERIPH_SET_CONFIG(); - esp_periph_set_handle_t set = esp_periph_set_init(&periph_cfg); - periph_wifi_cfg_t wifi_cfg = { - .wifi_config.sta.ssid = CONFIG_WIFI_SSID, - .wifi_config.sta.password = CONFIG_WIFI_PASSWORD, - }; - esp_periph_handle_t wifi_handle = periph_wifi_init(&wifi_cfg); - esp_periph_start(set, wifi_handle); - periph_wifi_wait_for_connected(wifi_handle, portMAX_DELAY); - diff --git a/docs/en/design-guide/audio-pipeline.rst b/docs/en/design-guide/audio-pipeline.rst deleted file mode 100644 index e480c3db2..000000000 --- a/docs/en/design-guide/audio-pipeline.rst +++ /dev/null @@ -1,7 +0,0 @@ -Audio Pipeline -============== - -Example -------- - -Please refer to :example_file:`player/pipeline_play_sdcard_music/main/play_sdcard_music_example.c` for an example of linking elements into an audio pipeline. diff --git a/docs/en/design-guide/esp-audio.rst b/docs/en/design-guide/esp-audio.rst deleted file mode 100644 index 3eb17608a..000000000 --- a/docs/en/design-guide/esp-audio.rst +++ /dev/null @@ -1,7 +0,0 @@ -Audio Player -============ - -Example -------- - -Please refer to :example:`cli` for an example of initializing ``esp_audio`` as an audio player. diff --git a/docs/zh_CN/design-guide/audio-element.rst b/docs/zh_CN/design-guide/audio-element.rst deleted file mode 100644 index b7ed1b6c8..000000000 --- a/docs/zh_CN/design-guide/audio-element.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/design-guide/audio-element.rst \ No newline at end of file diff --git a/docs/zh_CN/design-guide/audio-event.rst b/docs/zh_CN/design-guide/audio-event.rst deleted file mode 100644 index 602e013c6..000000000 --- a/docs/zh_CN/design-guide/audio-event.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/design-guide/audio-event.rst \ No newline at end of file diff --git a/docs/zh_CN/design-guide/audio-peripheral.rst b/docs/zh_CN/design-guide/audio-peripheral.rst deleted file mode 100644 index c608ef6ab..000000000 --- a/docs/zh_CN/design-guide/audio-peripheral.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/design-guide/audio-peripheral.rst \ No newline at end of file diff --git a/docs/zh_CN/design-guide/audio-pipeline.rst b/docs/zh_CN/design-guide/audio-pipeline.rst deleted file mode 100644 index 2624ddddf..000000000 --- a/docs/zh_CN/design-guide/audio-pipeline.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/design-guide/audio-pipeline.rst \ No newline at end of file diff --git a/docs/zh_CN/design-guide/esp-audio.rst b/docs/zh_CN/design-guide/esp-audio.rst deleted file mode 100644 index 6a538bc9f..000000000 --- a/docs/zh_CN/design-guide/esp-audio.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../en/design-guide/esp-audio.rst \ No newline at end of file