Merge branch 'feature/add_media_lib_sal_component' into 'master'

feat(media_lib_sal): Add media_lib_sal component

See merge request adf/esp-adf-libs!297

Author: jason-mao

.github/workflows/upload_component.yml

@@ -25,5 +25,6 @@ jobs:
             esp_libsrtp;
             esp_image_effects;
             esp_media_protocols;
+            media_lib_sal;
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

media_lib_sal/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.9.0
+
+- Initial version of `media_lib_sal`

media_lib_sal/CMakeLists.txt

@@ -4,20 +4,7 @@ set(COMPONENT_ADD_INCLUDEDIRS include include/port)
 
 # Edit following two lines to set component requirements (see docs)
 
-set(COMPONENT_SRCS ./media_lib_common.c
-     ./media_lib_os.c ./port/media_lib_os_freertos.c
-    ./media_lib_adapter.c)
-
-if (CONFIG_MEDIA_PROTOCOL_LIB_ENABLE)
-    set(COMPONENT_REQUIRES mbedtls esp-tls)
-    list(APPEND COMPONENT_SRCS  ./media_lib_socket.c ./port/media_lib_socket_default.c
-                                ./media_lib_crypt.c  ./port/media_lib_crypt_default.c
-                                ./media_lib_tls.c  ./port/media_lib_tls_default.c
-                                ./media_lib_netif.c  ./port/media_lib_netif_default.c)
-if (idf_version VERSION_GREATER_EQUAL "5.0")
-    list(APPEND COMPONENT_REQUIRES esp-tls mbedtls)
-endif()
-endif()
+list (APPEND COMPONENT_SRCDIRS ./ ./port ./mem_trace)
 
 list(APPEND COMPONENT_REQUIRES esp-tls mbedtls esp_netif)
 

media_lib_sal/Kconfig

@@ -0,0 +1,69 @@
+menu "Media Library System Abstraction Layer Configuration"
+
+config MEDIA_LIB_CRYPT_ENABLE
+    bool "Enable media lib sal crypt library"
+    default "y"
+
+config MEDIA_LIB_SOCKET_ENABLE
+    bool "Enable media lib sal socket library"
+    default "y"
+
+config MEDIA_LIB_TLS_ENABLE
+    bool "Enable media lib sal tls library"
+    default "y"
+
+config MEDIA_LIB_NETIF_ENABLE
+    bool "Enable media lib sal netif library"
+    default "y"
+
+config MEDIA_LIB_MEM_AUTO_TRACE
+    bool "Support trace memory automatically after media_lib_sal init"
+    default "n"
+
+config MEDIA_LIB_MEM_TRACE_DEPTH
+    int
+    prompt "Memory trace stack depth" if MEDIA_LIB_MEM_AUTO_TRACE
+    depends on MEDIA_LIB_MEM_AUTO_TRACE
+    default 3
+    help
+        Set memory trace depth
+
+config MEDIA_LIB_MEM_TRACE_NUM
+    int
+    prompt "Memory trace number" if MEDIA_LIB_MEM_AUTO_TRACE
+    depends on MEDIA_LIB_MEM_AUTO_TRACE
+    default 1024
+    help
+        Set memory trace number
+
+config MEDIA_LIB_MEM_TRACE_MODULE
+    bool "Trace for module memory usage"
+    depends on MEDIA_LIB_MEM_AUTO_TRACE
+    default y
+
+config MEDIA_LIB_MEM_TRACE_LEAKAGE
+    depends on MEDIA_LIB_MEM_AUTO_TRACE
+    bool "Trace for memory leakage"
+    default y
+
+config MEDIA_LIB_MEM_TRACE_SAVE_HISTORY
+    bool "Trace to save memory history"
+    depends on MEDIA_LIB_MEM_AUTO_TRACE
+    default n
+
+config MEDIA_LIB_MEM_SAVE_CACHE_SIZE
+    int
+    prompt "Cache buffer size to store save history" if MEDIA_LIB_MEM_TRACE_SAVE_HISTORY
+    depends on MEDIA_LIB_MEM_TRACE_SAVE_HISTORY
+    default 32768
+    help
+        Set cache size for memory history
+
+config MEDIA_LIB_MEM_TRACE_SAVE_PATH
+    string "Memory trace save path" if MEDIA_LIB_MEM_TRACE_SAVE_HISTORY
+    depends on MEDIA_LIB_MEM_TRACE_SAVE_HISTORY
+    default "/sdcard/trace.log"
+    help
+        Set memory trace save path
+
+endmenu

media_lib_sal/LICENSE

@@ -0,0 +1,22 @@
+Espressif Modified MIT License
+
+Copyright (c) 2025 Espressif Systems (Shanghai) CO., LTD
+
+Permission is hereby granted for use EXCLUSIVELY with Espressif Systems products.
+This includes the right to use, copy, modify, merge, publish, distribute, and sublicense
+the Software, subject to the following conditions:
+
+1. This Software MUST BE USED IN CONJUNCTION WITH ESPRESSIF SYSTEMS PRODUCTS.
+2. The above copyright notice and this permission notice shall be included in all copies
+or substantial portions of the Software.
+3. Redistribution of the Software in source or binary form FOR USE WITH NON-ESPRESSIF PRODUCTS
+is strictly prohibited.
+
+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.
+
+SPDX-License-Identifier: LicenseRef-Espressif-Modified-MIT

media_lib_sal/README.md

@@ -0,0 +1,113 @@
+# MEDIA_LIB_SAL (Media Library System Abstraction Layer)
+
+## Overview
+
+The `media_lib_sal` provides a cross-platform abstraction for media libraries and applications.
+It enables developers to build media applications in a platform-independent way and even debug on a PC without changing application logic.
+
+The `media_lib_sal` offers a unified interface to interact with:
+- Operating system primitives (threads, memory, sync objects)
+- Cryptographic operations (MD5, SHA256, AES)
+- Networking (sockets, netif)
+- TLS/SSL for secure communication
+
+Through its registration mechanism, platform-specific implementations can be plugged in, while applications always use the same wrapper APIs.
+
+## Architecture
+
+The `media_lib_sal` follows a two-layer architecture:
+
+1. **Wrapper Layer** – Public APIs that applications call
+2. **Registration Layer** – Interfaces to bind platform-specific implementations
+
+Applications only see the wrapper layer, while hardware or OS vendors provide implementations via the registration layer.
+
+### Architecture Diagram
+
+```mermaid
+flowchart TB
+    subgraph Application_Layer["Application Layer"]
+        APP["Media Applications"]
+    end
+    subgraph SAL["System Abstraction Layer"]
+        W["Wrapper Layer<br/>(media_lib_xxx.h)"]
+        R["Registration Layer<br/>(media_lib_adapter.h)"]
+    end
+    subgraph Platform["Platform Implementations"]
+        OS["OS Functions"]
+        CRYPT["Crypto Functions"]
+        SOCK["Socket Functions"]
+        TLS["TLS Functions"]
+        NETIF["Netif Functions"]
+    end
+    APP --> W
+    W --> R
+    R --> OS & CRYPT & SOCK & TLS & NETIF
+```
+
+## Core Components
+
+### 1. Operating System Abstraction (`media_lib_os.h`)
+
+Cross-platform access to OS services:
+- Memory management (`malloc`, `calloc`, `realloc`, `free`)
+- Thread management (`create`, `destroy`, `sleep`)
+- Synchronization primitives (mutex, semaphore, event groups)
+
+### 2. Cryptography (`media_lib_crypt.h`)
+
+Standard crypto wrappers:
+- **MD5** – init, update, finish
+- **SHA256** – init, update, finish
+- **AES** – key setup, CBC encrypt/decrypt
+
+### 3. Socket API (`media_lib_socket.h`)
+
+Unified networking interface:
+- **Connection management** – open, bind, connect, listen, accept
+- **Data transfer** – send/recv, sendto/recvfrom
+- **Socket control** – select, setsockopt, getsockopt
+
+### 4. TLS/SSL (`media_lib_tls.h`)
+
+Abstraction for secure communication:
+- Create client/server TLS sessions
+- Read/Write encrypted data
+- Session management (delete/cleanup)
+
+### 5. Network Interface (`media_lib_netif.h`)
+
+Query and utility functions:
+- Get IPv4 information
+- Address conversion (`ntoa`)
+
+## Utilities
+
+### Memory Tracing (`media_lib_mem_trace.h`)
+
+Advanced debugging utilities:
+- Track memory usage by module
+- Detect leaks with stack traces
+- Allocation history logging
+
+## Registration Interface (Port Layer)
+
+Platform-specific functions are registered via adapters:
+
+- `media_lib_add_default_adapter()` – Register all defaults
+- `media_lib_os_register(...)` – Register custom OS functions
+- `media_lib_crypt_register(...)` – Register custom crypto functions
+- `media_lib_socket_register(...)` – Register custom socket functions
+- `media_lib_tls_register(...)` – Register custom TLS functions
+- `media_lib_netif_register(...)` – Register custom netif functions
+
+Users can manually register each component or register all and select the used one by menuconfig, this allows flexible default or custom implementation selection.
+
+## Platform Support
+
+- **ESP32 family (primary target)**
+- Easily portable to other platforms by providing new registration functions.
+
+## License
+
+This component is licensed under the Modified MIT License - see the [LICENSE](./LICENSE) file for details.

media_lib_sal/component.mk

@@ -0,0 +1,15 @@
+version: 0.9.0
+description: Media Library System Abstract layer
+url: https://github.com/espressif/esp-adf-libs/tree/master/media_lib_sal
+repository: https://github.com/espressif/esp-adf-libs.git
+issues: https://github.com/espressif/esp-adf/issues
+
+dependencies:
+  idf:
+    version: '>=5.1'
+
+tags:
+- Multimedia
+- OSLibrary
+- System
+- Network