Merge branch 'feature/add_webrtc_solution_code' into 'main'

esp-webrtc_solution: Add webrtc solutions code

See merge request adf/esp-webrtc-solution!1

Author: TempoTian

.gitignore

@@ -0,0 +1,38 @@
+.config
+*.o
+*.pyc
+
+# gtags
+GTAGS
+GRTAGS
+GPATH
+
+# emacs
+.dir-locals.el
+
+# emacs temp file suffixes
+*~
+.#*
+\#*#
+# MacOS directory files
+.DS_Store
+
+# eclipse setting
+.settings
+
+# Example project files
+
+**/sdkconfig
+**/sdkconfig.old
+**/build
+**/managed_components
+**/dependencies.lock
+**/dist
+
+# gcov coverage reports
+*.gcda
+*.gcno
+coverage.info
+coverage_report/
+
+.vscode

README.md

@@ -1,93 +1,24 @@
-# esp-webrtc-solution
+# esp_webrtc_solution
 
+## Introduction
 
+This repository provides everything needed to build a WebRTC application.  
+It includes the `esp_webrtc` core code along with its dependent components, such as:  
+- **`esp_capture`**: For capturing media data  
+- **`av_render`**: For playing media data  
 
-## Getting started
+Additionally, the repository contains three simple demo applications that demonstrate how to use `esp_webrtc`.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Solutions
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+### 1. OpenAI Realtime Communication Solution
+This demo establishes a WebRTC connection to an OpenAI server for real-time communication.  
+It showcases how to use a customized signaling mechanism to build specialized WebRTC applications.
 
-## Add your files
+### 2. Doorbell Solution
+This demo implements a doorbell application that can:  
+- Be controlled in real-time by a browser or phone  
+- Send real-time video data to a controller while supporting two-way audio communication
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://gitlab.espressif.cn:6688/adf/esp-webrtc-solution.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.espressif.cn:6688/adf/esp-webrtc-solution/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+### 3. Peer Demo
+This demo mainly show how to use `esp_peer` API to buildup a WebRTC application from scratch.

components/av_render/CMakeLists.txt

@@ -0,0 +1,8 @@
+
+list (APPEND COMPONENT_SRCDIRS ./src)
+
+set(COMPONENT_ADD_INCLUDEDIRS ./include)
+
+set(COMPONENT_PRIV_REQUIRES media_lib_sal esp_timer esp_audio_codec esp_video_codec)
+
+register_component()

components/av_render/README.md

@@ -0,0 +1,36 @@
+# AV_Render
+
+`AV_Render` is a simple player designed for video and audio playback. It primarily supports "push" playback model, where the user first provides stream information and then pushes the stream data to `av_render`. The player checks the input stream's codec and uses appropriate audio and video decoders for processing. The decoded output frame data is sent to the corresponding renderer for final output (e.g., audio playback via codec, video playback on LCD).
+
+## Abstraction
+
+### Render Implementations
+
+Users can select the appropriate renderer based on their specific use case. We also provide default implementations for common scenarios, such as:
+
+- **Audio Rendering:** `av_render_alloc_i2s_render` — outputs audio through I2S.
+- **Video Rendering:** `av_render_alloc_lcd_render` — renders video through `esp_lcd`.
+
+## Simple Usage
+
+The overall flow for audio and video playback is as follows:
+
+1. `av_render_open`
+2. `av_render_add_audio_stream`
+3. `av_render_add_video_stream`
+4. `av_render_add_audio_data`
+5. `av_render_add_video_data`
+6. `av_render_close`
+
+### Resetting the Playback
+
+If you want to clear the current stream and start a new one, call `av_render_reset`.
+
+### Resource usage
+
+Users can configure resource usage more precisely to meet their specific needs. This includes options such as whether an additional thread is required for decoding, as well as how much data can be buffered by the decoder and renderer.
+
+To customize these settings, you can use the `av_render_cfg_t` configuration structure or the following API functions:
+
+- `av_render_config_audio_fifo` — Configure the audio buffer size for the decoder and renderer.
+- `av_render_config_video_fifo` — Configure the video buffer size for the decoder and renderer.

components/av_render/idf_component.yml

@@ -0,0 +1,5 @@
+## IDF Component Manager Manifest File
+dependencies:
+  espressif/esp_audio_codec: "*"
+  espressif/esp_video_codec: "*"
+  espressif/esp_audio_effects: "*"

components/av_render/include/audio_decoder.h

@@ -0,0 +1,106 @@
+/**
+ * ESPRESSIF MIT License
+ *
+ * Copyright (c) 2025 <ESPRESSIF SYSTEMS (SHANGHAI) CO., LTD>
+ *
+ * Permission is hereby granted for use on all ESPRESSIF SYSTEMS products, in which case,
+ * it is free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
+ * to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+#pragma once
+
+#include "av_render_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief  Audio decoder frame callback
+ *
+ * @param[in]  frame  Decoded audio frame
+ * @param[in]  ctx    Decoder context set by user
+ *
+ * @return
+ *       - 0       On success
+ *       - Others  Fail to decode
+ */
+typedef int (*adec_frame_cb)(av_render_audio_frame_t *frame, void *ctx);
+
+/**
+ * @brief  Audio decoder configuration
+ */
+typedef struct {
+    av_render_audio_info_t audio_info; /*!< Audio information */
+    adec_frame_cb          frame_cb;   /*!< Decoded frame callback */
+    void                  *ctx;        /*!< Decoder context */
+} adec_cfg_t;
+
+/**
+ * @brief  Audio decoder handle
+ */
+typedef void *adec_handle_t;
+
+/**
+ * @brief  Open audio decoder
+ *
+ * @param[in]  cfg  Audio decoder configuration
+ *
+ * @return
+ *       - NULL    No memory for decoder instance
+ *       - Others  On success
+ */
+adec_handle_t adec_open(adec_cfg_t *cfg);
+
+/**
+ * @brief  Decode audio
+ *
+ * @param[in]  h     Audio decoder handle
+ * @param[in]  data  Audio data to be decoded
+ *
+ * @return
+ *       - 0       On success
+ *       - Others  Fail to decode
+ */
+int adec_decode(adec_handle_t h, av_render_audio_data_t *data);
+
+/**
+ * @brief  Get decoded audio frame information
+ *
+ * @param[in]   h           Audio decoder handle
+ * @param[out]  frame_info  Audio frame information
+ *
+ * @return
+ *       - 0       On success
+ *       - Others  Fail to decode
+ */
+int adec_get_frame_info(adec_handle_t h, av_render_audio_frame_info_t *frame_info);
+
+/**
+ * @brief  Close audio decoder
+ *
+ * @param[in]  h  Audio decoder handle
+ *
+ * @return
+ *       - 0       On success
+ *       - Others  Fail to decode
+ */
+int adec_close(adec_handle_t h);
+
+#ifdef __cplusplus
+}
+#endif