- 
+
+> ⚠️ **Project Status:** The maintainer is on hiatus from Jan 2026 to Feb 2027. Support and updates will be limited.
+>
+> [**Read the full announcement for details.**](https://github.com/LSXPrime/SoundFlow/discussions/102)
+
+[](https://github.com/LSXPrime/SoundFlow)
# SoundFlow
-**A Powerful and Extensible .NET Audio Engine for Enterprise Applications**
+**The Complete .NET Audio Framework: From High-Fidelity Synthesis to Secure Distribution**
-[](https://github.com/LSXPrime/SoundFlow/actions/workflows/build.yml) [](https://opensource.org/licenses/MIT) [](https://www.nuget.org/packages/SoundFlow) [](https://dotnet.microsoft.com/download/dotnet/8.0)
+[](https://github.com/LSXPrime/SoundFlow/actions/workflows/release.yml) [](https://opensource.org/licenses/MIT) [](https://www.nuget.org/packages/SoundFlow) [](https://dotnet.microsoft.com/download/dotnet/8.0)
[](https://thebsd.github.io/StandWithPalestine)
+
+> ⚠️ **Project Status:** The maintainer is on hiatus from Jan 2026 to Feb 2027. Support and updates will be limited.
+>
+> [**Read the full announcement for details.**](https://github.com/LSXPrime/SoundFlow/discussions/102)
+
+[](https://github.com/LSXPrime/SoundFlow)
# SoundFlow
-**A Powerful and Extensible .NET Audio Engine for Enterprise Applications**
+**The Complete .NET Audio Framework: From High-Fidelity Synthesis to Secure Distribution**
-[](https://github.com/LSXPrime/SoundFlow/actions/workflows/build.yml) [](https://opensource.org/licenses/MIT) [](https://www.nuget.org/packages/SoundFlow) [](https://dotnet.microsoft.com/download/dotnet/8.0)
+[](https://github.com/LSXPrime/SoundFlow/actions/workflows/release.yml) [](https://opensource.org/licenses/MIT) [](https://www.nuget.org/packages/SoundFlow) [](https://dotnet.microsoft.com/download/dotnet/8.0)
This project stands in solidarity with the people of Palestine and condemns the ongoing violence and ethnic cleansing by Israel. We believe developers have a responsibility to be aware of such injustices. Read our full statement on the catastrophic situation in Palestine and the surrounding region.
- Read Our Full Ethical Stance + Read Our Full Ethical Stance@@ -20,40 +25,57 @@ SoundFlow is a robust and versatile .NET audio engine designed for seamless cross-platform audio processing. It provides a comprehensive set of features for audio playback, recording, processing, analysis, and visualization, all within a well-structured and extensible framework. SoundFlow empowers developers to build sophisticated audio applications, from real-time communication systems to advanced non-linear audio editors. -**Key Features:** +## Key Features +SoundFlow provides a comprehensive suite of tools organized into a powerful, extensible architecture. + +### Core Architecture & Design * **Cross-Platform Compatibility:** Runs seamlessly on Windows, macOS, Linux, Android, iOS, and FreeBSD, ensuring broad deployment options. +* **High Performance:** Optimized for real-time audio processing with SIMD support and efficient memory management. +* **Modular Component Architecture:** Build custom audio pipelines by connecting sources, modifiers, mixers, and analyzers. +* **Extensibility:** Easily add custom audio components, effects, and visualizers to tailor the engine to your specific needs. +* **Plug & Play Integrations:** Extend SoundFlow's capabilities with official integration packages, such as the WebRTC Audio Processing Module. +* **Backend Agnostic:** Supports the `MiniAudio` backend out of the box, with the ability to add others. + +### Advanced Audio I/O & Device Management * **Multi-Device Management:** Initialize and manage multiple independent audio playback and capture devices simultaneously, each with its own audio graph. * **Advanced Device Control:** Fine-tune latency, sharing modes, and platform-specific settings (WASAPI, CoreAudio, ALSA, etc.) for professional-grade control. * **On-the-fly Device Switching:** Seamlessly switch between audio devices during runtime without interrupting the audio graph. -* **Modular Component Architecture:** Build custom audio pipelines by connecting sources, modifiers, mixers, and analyzers. -* **Plug & Play Integrations:** Extend SoundFlow's capabilities with official integration packages, such as the WebRTC Audio Processing Module for advanced noise suppression, echo cancellation, and automatic gain control. -* **Extensibility:** Easily add custom audio components, effects, and visualizers to tailor the engine to your specific needs. -* **Pluggable Codec System:** Extend format support dynamically via `ICodecFactory`. Includes built-in support for WAV, MP3, and FLAC (via MiniAudio), with extensive format support available via extensions. -* **Robust Metadata Handling:** Read and write metadata tags (ID3v1, ID3v2, Vorbis Comments, MP4 Atoms) and embedded Cue Sheets for a wide range of formats (MP3, FLAC, OGG, M4A, WAV, AIFF). -* **High Performance:** Optimized for real-time audio processing with SIMD support and efficient memory management. + +### Core Audio Processing & Playback * **Playback:** Play audio from various sources, including files, streams, and in-memory assets. * **Recording:** Capture audio input and save it to different encoding formats. * **Mixing:** Combine multiple audio streams with precise control over volume and panning. * **Effects:** Apply a wide range of audio effects, including reverb, chorus, delay, equalization, and more. + +### Analysis, Formats & Streaming +* **Pluggable Codec System:** Extend format support dynamically via `ICodecFactory`. Includes built-in support for WAV, MP3, and FLAC (via MiniAudio), with extensive format support available via extensions. +* **Robust Metadata Handling:** Read and write metadata tags (ID3v1, ID3v2, Vorbis Comments, MP4 Atoms) and embedded Cue Sheets for a wide range of formats (MP3, FLAC, OGG, M4A, WAV, AIFF). * **Visualization & Analysis:** Create engaging visual representations with FFT-based spectrum analysis, voice activity detection, and level metering. * **Surround Sound:** Supports advanced surround sound configurations with customizable speaker positions, delays, and panning methods. * **HLS Streaming Support:** Integrate internet radio and online audio via HTTP Live Streaming. -* **Backend Agnostic:** Supports the `MiniAudio` backend out of the box, with the ability to add others. -* **Synthesis Engine:** - * **Polyphonic Synthesizer:** A robust synthesis engine supporting unison, filtering, and modulation envelopes. - * **SoundFont Support:** Native loading and playback of SoundFont 2 (.sf2) banks. - * **MPE Support:** Full support for MIDI Polyphonic Expression for per-note control of pitch, timbre, and pressure. -* **MIDI Ecosystem:** - * **Cross-Platform I/O:** Send and receive MIDI messages from hardware devices via the PortMidi backend. - * **Routing & Effects:** Graph-based MIDI routing with a suite of modifiers including Arpeggiators, Harmonizers, Randomizers, and Velocity curves. - * **Parameter Mapping:** Real-time MIDI mapping system allows controlling any engine parameter (Volume, Filter Cutoff, etc.) via external hardware controllers. -* **Non-Destructive Audio & MIDI Editing:** - * **Compositions & Tracks:** Organize projects into multi-track compositions supporting both Audio and MIDI tracks. - * **Hybrid Timeline:** Mix audio clips and MIDI segments on the same timeline. - * **Sequencing:** Sample-accurate MIDI sequencing with quantization, swing, and tempo map support. - * **Project Persistence:** Save/Load full projects including audio assets, MIDI sequences, tempo maps, and routing configurations. +### Synthesis Engine +* **Polyphonic Synthesizer:** A robust synthesis engine supporting unison, filtering, and modulation envelopes. +* **SoundFont Support:** Native loading and playback of SoundFont 2 (.sf2) banks. +* **MPE Support:** Full support for MIDI Polyphonic Expression for per-note control of pitch, timbre, and pressure. + +### MIDI Ecosystem +* **Cross-Platform I/O:** Send and receive MIDI messages from hardware devices via the PortMidi backend. +* **Routing & Effects:** Graph-based MIDI routing with a suite of modifiers including Arpeggiators, Harmonizers, Randomizers, and Velocity curves. +* **Parameter Mapping:** Real-time MIDI mapping system allows controlling any engine parameter (Volume, Filter Cutoff, etc.) via external hardware controllers. + +### Non-Destructive Audio & MIDI Editing +* **Compositions & Tracks:** Organize projects into multi-track compositions supporting both Audio and MIDI tracks. +* **Hybrid Timeline:** Mix audio clips and MIDI segments on the same timeline. +* **Sequencing:** Sample-accurate MIDI sequencing with quantization, swing, and tempo map support. +* **Project Persistence:** Save/Load full projects including audio assets, MIDI sequences, tempo maps, and routing configurations, with optional digital signing for integrity. + +### Comprehensive Security Suite +* **Audio Encryption:** High-performance, seekable stream encryption using AES-256-CTR, packaged in a secure container format. +* **Digital Signatures:** Ensure file integrity and authenticity for projects and audio containers using ECDSA digital signatures. +* **Audio Watermarking:** Embed robust, inaudible ownership data (DSSS) or fragile integrity verification markers (LSB) directly into audio signals. +* **Acoustic Fingerprinting:** Identify audio content by generating and matching robust acoustic fingerprints against a database. ## Getting Started To begin using SoundFlow, the easiest way is to install the NuGet package: @@ -71,26 +93,32 @@ You can also find a wide variety of practical applications, complex audio graphs SoundFlow's architecture supports adding specialized audio processing capabilities via dedicated NuGet packages. These extensions integrate external libraries, making their features available within the SoundFlow ecosystem. ### SoundFlow.Codecs.FFMpeg - This package integrates the massive **FFmpeg** library into SoundFlow. While the core engine handles common formats, this extension unlocks decoding and encoding for virtually any audio format in existence. -* **Decoders/Encoders:** Adds support for MP3, AAC, OGG Vorbis, Opus, ALAC, AC3, PCM variations, and many more. +* **Decoders/Encoders:** Adds support for MP3 (encoder by LAME), AAC, OGG Vorbis, Opus, ALAC, AC3, PCM variations, and many more. * **Container Support:** Handles complex containers like M4A, MKA, and others. * **Automatic Registration:** simply registering the factory enables the engine to auto-detect and play these formats transparently. -### SoundFlow.Midi.PortMidi +To install this extension: +```bash +dotnet add package SoundFlow.Codecs.FFMpeg +``` +### SoundFlow.Midi.PortMidi This package provides the backend implementation for MIDI hardware I/O using **PortMidi**. * **Hardware Access:** Enumerates and connects to physical MIDI keyboards, synthesizers, and controllers on Windows, macOS, and Linux. * **Synchronization:** Provides high-precision clock synchronization, allowing SoundFlow to act as a MIDI Clock Master or Slave. -### SoundFlow.Extensions.WebRtc.Apm +To install this extension: +```bash +dotnet add package SoundFlow.Midi.PortMidi +``` +### SoundFlow.Extensions.WebRtc.Apm This package provides an integration with a native library based on the **WebRTC Audio Processing Module (APM)**. The WebRTC APM is a high-quality suite of algorithms commonly used in voice communication applications to improve audio quality. Features included in this extension: - * **Acoustic Echo Cancellation (AEC):** Reduces echoes caused by playback audio being picked up by the microphone. * **Noise Suppression (NS):** Reduces steady-state background noise. * **Automatic Gain Control (AGC):** Automatically adjusts the audio signal level to a desired target. @@ -99,6 +127,11 @@ Features included in this extension: **Note:** The WebRTC APM native library has specific requirements, notably supporting only certain sample rates (8000, 16000, 32000, or 48000 Hz). Ensure your audio devices are initialized with one of these rates when using this extension. +To install this extension: +```bash +dotnet add package SoundFlow.Extensions.WebRtc.Apm +``` + ## API Reference Comprehensive API documentation will be available on the **[SoundFlow Documentation](https://lsxprime.github.io/soundflow-docs/)**. @@ -114,6 +147,7 @@ The **[Documentation](https://lsxprime.github.io/soundflow-docs/)** provides a w * **Analysis:** Getting RMS level, analyzing frequency spectrum. * **Visualization:** Creating level meters, waveform displays, and spectrum analyzers. * **Composition:** Managing audio projects, including creating, editing, and saving multi-track compositions. +* **Security:** Encrypting audio, signing files, and embedding robust ownership watermarks. **(Note:** You can also find extensive example code in the `Samples` folder of the repository.) @@ -129,83 +163,47 @@ We sincerely appreciate the foundational work provided by the following projects * **[miniaudio](https://github.com/mackron/miniaudio)** - Provides a lightweight and efficient audio I/O backend. * **[FFmpeg](https://ffmpeg.org/)** - The leading multimedia framework, powering our codec extension. +* **[LAME Project](https://lame.sourceforge.io/)** - For the high-quality MP3 encoder used in the FFMpeg extension. * **[PortMidi](https://github.com/PortMidi/portmidi)** - Enables cross-platform MIDI I/O. * **[WebRTC Audio Processing Module (APM)](https://gitlab.freedesktop.org/pulseaudio/webrtc-audio-processing)** - Offers advanced audio processing (AEC, AGC, Noise Suppression). ## Support This Project -SoundFlow is an open-source project driven by passion and community needs. Maintaining and developing a project of this scale, especially with thorough audio testing, requires significant time and resources. - -Currently, development and testing are primarily done using built-in computer speakers. **Your support will directly help improve the quality of SoundFlow by enabling the purchase of dedicated headphones and audio equipment for more accurate and comprehensive testing across different audio setups.** - -Beyond equipment, your contributions, no matter the size, help to: - -* **Dedicate more time to development:** Allowing for faster feature implementation, bug fixes, and improvements. -* **Enhance project quality:** Enabling better testing, documentation, and overall project stability (including better audio testing with proper equipment!). -* **Sustain long-term maintenance:** Ensuring SoundFlow remains actively maintained and relevant for the community. - -You can directly support SoundFlow and help me get essential headphones through: +SoundFlow is an open-source project driven by passion and community needs. Maintaining and developing a project of this scale requires significant time and resources. -* **AirTM:** For simple one-time donations with various payment options like Direct Bank Transfer (ACH), Debit / Credit Card via Moonpay, Stablecoins, and more than 500 banks and e-wallets. +Your support is crucial for the continued development and maintenance of SoundFlow. Contributions help dedicate more time to the project, improve documentation, and acquire necessary hardware for robust testing. For instance, funds will directly help purchase dedicated audio equipment for more accurate testing, moving beyond basic built-in speakers to ensure high-quality output for everyone. - [Donate using AirTM](https://airtm.me/lsxprime) +If you find this project useful, please consider one of the following ways to support it: -* **USDT (Tron/TRC20):** Supporting directly by sending to the following USDT wallet address. +* **[❤️ Sponsor on Ko-fi](https://ko-fi.com/lsxprime)** - For simple one-time or recurring donations. +* **[💸 Donate via PayPal](https://paypal.me/LSXPrime)** - For quick and easy one-time contributions. +* **[🌐 Donate using AirTM](https://airtm.me/lsxprime)** - Offers various payment options like Bank Transfer, Debit/Credit Card, and more. +* **[💎 USDT (Tron/TRC20)](https://github.com/LSXPrime/SoundFlow#)** - Send to the following wallet address: `TKZzeB71XacY3Av5rnnQVrz2kQqgzrkjFn` + * **Important:** Please ensure you are sending USDT via the **TRC20 (Tron)** network. Sending funds on any other network may result in their permanent loss. - `TKZzeB71XacY3Av5rnnQVrz2kQqgzrkjFn` - - **Important:** Please ensure you are sending USDT via the **TRC20 (Tron)** network. Sending funds on any other network may result in their permanent loss. - -**By becoming a sponsor or making a donation, you directly contribute to the future of SoundFlow and help ensure it sounds great for everyone. Thank you for your generosity!** +**Thank you for your generosity and for helping ensure SoundFlow sounds great for everyone!** ## License SoundFlow is released under the [MIT License](LICENSE.md). -## An Ethical Stance - -**While building powerful tools to help make human life better is commendable, we must also acknowledge the horrific injustices taking place in Palestine and across the region.** Israel’s actions since October 7th, 2023 have escalated into a brutal campaign of ethnic cleansing disguised as “defense.” The consequences are devastating, particularly in Gaza, but extend to Lebanon, Syria, and Iran. - -This is not a conflict between equal sides; it's a systematic assault by an occupying power on a stateless population struggling for basic human rights. - -**The situation in Gaza is catastrophic:** - -* **Massacres of Civilians:** Over 61,200 Palestinians are dead, including tens of thousands of women and children. Israel indiscriminately bombs densely populated areas, targeting civilian shelters as well as hospitals like the Al-Shifa Hospital, which provided crucial healthcare to over a million people in Gaza, obliterating their lifeline and leaving them with no access to essential medical care. -* **Starvation as Warfare:** Israel's relentless siege blocks vital supplies of food, water, medicine, fuel, and even building materials for repairs, pushing the population towards starvation. Children are dying before aid can reach them. The UN has condemned this as a collective punishment that violates international humanitarian law. -* **Forced Displacement & Land Confiscation:** Nearly 90% of Gaza’s 2.1 million inhabitants have been displaced multiple times, trapped in overcrowded camps with no end in sight to the siege and relentless bombings. This systematic displacement aims to erase Palestinian identity from the land they rightfully call home, forcing them onto crowded, contaminated, and dangerous territory while Israel continues to confiscate land for its own settlements. -* **Destruction of Infrastructure:** Israel systematically targets essential infrastructure - hospitals, schools, power stations, water treatment plants – crippling Gaza's ability to function and leaving people without necessities like clean water and electricity. - -**Syria:** +## Citing SoundFlow -* **Israel's Brutal Attacks:** Israel has intensified its brutal attacks on Syrian territory, striking government buildings in Damascus with impunity, escalating tensions with the already fractured nation and claiming territory under a false pretense of defense for the Druze minority facing internal conflict. The world remains silent as they violate Syria's sovereignty. -* **Tensions between Druze and Bedouin:** Druze factions in Southern Syria have engaged in intense violence against Bedouin tribes, involving killings, forced displacement, and humiliation. Israel explicitly supported these Druze interests by conducting airstrikes in Damascus on July 16, 2025. These strikes were claimed as a "warning" in defense of the Druze amidst their clashes, showcasing Israel's direct military backing in the conflict. +If you use SoundFlow in your research or project, you can cite it using the following format: -**Lebanon:** Israel’s violation of Lebanon’s airspace and frequent incursions have heightened fears of another devastating war. Targeted killings and bombings are displacing Lebanese civilians, further destabilizing a nation struggling to recover from past conflicts. - -**Iran:** - -* **Bombing of Civilians:** Israeli strikes on Iran that began on June 13, 2025, have resulted in significant civilian casualties. According to a US-based human rights group, at least 950 people have been killed, including 380 identified civilians, with over 3,450 others wounded. Iran's Health Ministry has reported that over 90% of the injuries occurred among civilians, including women and children. -* **A "Crybaby" Reaction to Retaliation:** While inflicting heavy civilian casualties in Iran, Israel has shown a different face when faced with retaliation. After Iran launched missiles and drones in response, killing 29 people and wounding over 3,000 in Israel, Israeli Prime Minister Benjamin Netanyahu called the Iranian regime "weak" and appealed for international support. This reaction highlights a pattern of aggression without accepting the consequences when an opponent can strike back with force. -* **Begging for US Intervention and Failure to Achieve Goals:** Israel's military campaign, dubbed "Operation Rising Lion," aimed to destroy Iran's nuclear program. However, some of Iran's nuclear facilities are buried deep underground, reportedly beyond the reach of Israeli weapons. This led to Israel seeking and receiving direct military intervention from the United States, which used "bunker buster" bombs on Iranian nuclear sites. Despite the joint effort, assessments indicate that while Iran's nuclear program was set back, it was not eliminated. Reports suggest that some sites are repairable and that Iran retains the materials and knowledge to rebuild, potentially being more motivated to develop nuclear weapons to deter future attacks. - -**The situation in Egypt is also not that good** - -* **Tensions between Egypt and Israel:** Tensions between Egypt and Israel have reached their highest level since the war began, primarily due to Israel's policies aimed at forcibly displacing Palestinians toward Egypt's borders. Egypt views this as a direct threat to its national security and rejects any plan for mass displacement into Sinai. Egypt has expressed strong objections to Israel's continued military control over the Philadelphi Corridor and its refusal to reopen border crossings. -* **Pressure on Borders:** Israel pressures Egypt to accept the flow of Palestinian refugees fleeing the carnage in Gaza, threatening regional stability and exacerbating existing tensions within Sinai. This pressure plays on long-standing historical grievances between Palestinians and Egyptian authorities who see this influx as a destabilizing force under Israeli manipulation. -* **Threatening Peace Treaties:** By flagrantly violating Egypt's territorial sovereignty through incursions and air strikes, Israel threatens the fragile peace agreement signed in 1979. - -**This is not simply a regional conflict; it’s a systematic pattern of violence driven by illegal occupation, apartheid policies, and blatant disregard for international law.** - -The international community remains largely complicit, failing to hold Israel accountable for its crimes against humanity and enabling the expansionism that fuels this ongoing catastrophe. - -**We urge you as developers to consider:** - -* **Boycotting all products and services that directly benefit the Israeli military machine.** Your money funds their brutal weapons and technology used in Gaza, Syria, Lebanon, and Iran – investing in businesses that profit from human suffering is ethically untenable. -* **Using your platform and influence to raise awareness about this injustice.** Silence empowers aggressors. Speak out against Israeli policies and war crimes. Demand accountability for every Palestinian life lost under their relentless assault. -* **Supporting Palestinian-led organizations working on the ground in Palestine, Syria, Lebanon, and Egypt:** They provide vital aid, resist oppression, document human rights abuses, and fight for justice. - -**Your skills are powerful tools.** Use them responsibly and ethically. The reality is brutal: a child's body shattered by bombs in Gaza, families torn apart in Lebanon while their homes are reduced to rubble, land stolen while its rightful owners cower under the threat of death. - -**Don’t be complicit.** History is not written by the victors alone – stand up for justice against this violent expansionism before it engulfs the entire region. +### APA +``` +Abdallah, A. (2026). SoundFlow: A high-performance, secure audio and MIDI engine for .NET (Version 1.4.0) [Computer software]. https://github.com/LSXPrime/SoundFlow +``` -Learn more about the reality on the ground from reliable sources, not colonizer-backed websites. \ No newline at end of file +### BibTeX +``` +@software{abdallah_soundflow_2026, + author = {Abdallah, Ahmed}, + title = {{SoundFlow: A high-performance, secure audio and MIDI engine for .NET}}, + url = {https://github.com/LSXPrime/SoundFlow}, + version = {1.4.0}, + year = {2026}, + note = {Cross-platform audio processing, synthesis, and content protection framework} +} +``` \ No newline at end of file diff --git a/SOUNDFLOW-THIRD-PARTY-NOTICES.txt b/SOUNDFLOW-THIRD-PARTY-NOTICES.txt new file mode 100644 index 0000000..8614f82 --- /dev/null +++ b/SOUNDFLOW-THIRD-PARTY-NOTICES.txt @@ -0,0 +1,124 @@ +SoundFlow Third-Party Notices +============================= + +This file contains the license notices for the SoundFlow library and the +third-party native libraries it wraps or utilizes. + +-------------------------------------------------------------------------------- +1. SoundFlow (and sub-libraries) +License: MIT +Copyright (c) 2026 Ahmed Abdallah (LSXPrime) + +Permission is hereby granted, 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. + +-------------------------------------------------------------------------------- +2. MiniAudio +License: MIT or Unlicense (Dual Licensed) +Author: David Reid + +(Notice used under MIT terms) +Copyright (c) David Reid + +Permission is hereby granted, 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. + +-------------------------------------------------------------------------------- +3. PortMidi +License: MIT-style +Copyright (c) 1999-2000 Ross Bencina and Phil Burk +Copyright (c) 2001-2009 Roger B. Dannenberg + +Permission is hereby granted, 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. + +Non-binding requests from the PortMusic community: +- Any person wishing to distribute modifications to the Software is requested to + send the modifications to the original developer so that they can be + incorporated into the canonical version. +- It is also requested that these non-binding requests be included along with + the license above. + +-------------------------------------------------------------------------------- +4. WebRTC Audio Processing Module (APM) +License: BSD-3-Clause +Copyright (c) 2011, The WebRTC project authors. All rights reserved. + +The SoundFlow WebRTC extension utilizes a standalone version of the WebRTC APM, +maintained by the PulseAudio project. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + * Neither the name of Google nor the names of its contributors may + be used to endorse or promote products derived from this software + without specific prior written permission. + +-------------------------------------------------------------------------------- +5. FFmpeg +License: LGPL v2.1 or later +Copyright (c) the FFmpeg developers + +SoundFlow.Codecs.FFMpeg utilizes FFmpeg libraries for audio decoding and encoding. +The FFmpeg binaries used are licensed under the GNU Lesser General Public +License (LGPL) version 2.1 or later. + +FFmpeg is a trademark of Fabrice Bellard, originator of the FFmpeg project. + +Compliance Disclosure: +- The native wrapper (soundflow-ffmpeg) is built using static linking to + FFmpeg libraries with the following configuration: + --disable-gpl --disable-nonfree --enable-pic --disable-shared --enable-static +- This configuration ensures the binary is LGPL-compliant and does not contain + GPL or non-free code. +- As per LGPL requirements for static linking, the source code for the + SoundFlow FFmpeg wrapper (soundflow-ffmpeg.c/.h) is provided in this + distribution/repository under the MIT license. +- This allows users to modify and re-link the native wrapper against different + versions of the FFmpeg libraries. +- The source code for FFmpeg can be found at: https://ffmpeg.org/download.html +-------------------------------------------------------------------------------- \ No newline at end of file diff --git a/STATEMENT.md b/STATEMENT.md new file mode 100644 index 0000000..c12a85b --- /dev/null +++ b/STATEMENT.md @@ -0,0 +1,47 @@ +# Our Ethical Stance + +**While building powerful tools to help make human life better is commendable, we must also acknowledge the horrific injustices taking place in Palestine and across the region.** Israel’s actions since October 7th, 2023 have escalated into a brutal campaign of ethnic cleansing disguised as “defense.” The consequences are devastating, particularly in Gaza, but extend to Lebanon, Syria, and Iran. + +This is not a conflict between equal sides; it's a systematic assault by an occupying power on a stateless population struggling for basic human rights. + +**The situation in Gaza is catastrophic:** + +* **Massacres of Civilians:** Over 61,200 Palestinians are dead, including tens of thousands of women and children. Israel indiscriminately bombs densely populated areas, targeting civilian shelters as well as hospitals like the Al-Shifa Hospital, which provided crucial healthcare to over a million people in Gaza, obliterating their lifeline and leaving them with no access to essential medical care. +* **Starvation as Warfare:** Israel's relentless siege blocks vital supplies of food, water, medicine, fuel, and even building materials for repairs, pushing the population towards starvation. Children are dying before aid can reach them. The UN has condemned this as a collective punishment that violates international humanitarian law. +* **Forced Displacement & Land Confiscation:** Nearly 90% of Gaza’s 2.1 million inhabitants have been displaced multiple times, trapped in overcrowded camps with no end in sight to the siege and relentless bombings. This systematic displacement aims to erase Palestinian identity from the land they rightfully call home, forcing them onto crowded, contaminated, and dangerous territory while Israel continues to confiscate land for its own settlements. +* **Destruction of Infrastructure:** Israel systematically targets essential infrastructure - hospitals, schools, power stations, water treatment plants – crippling Gaza's ability to function and leaving people without necessities like clean water and electricity. + +**Syria:** + +* **Israel's Brutal Attacks:** Israel has intensified its brutal attacks on Syrian territory, striking government buildings in Damascus with impunity, escalating tensions with the already fractured nation and claiming territory under a false pretense of defense for the Druze minority facing internal conflict. The world remains silent as they violate Syria's sovereignty. +* **Tensions between Druze and Bedouin:** Druze factions in Southern Syria have engaged in intense violence against Bedouin tribes, involving killings, forced displacement, and humiliation. Israel explicitly supported these Druze interests by conducting airstrikes in Damascus on July 16, 2025. These strikes were claimed as a "warning" in defense of the Druze amidst their clashes, showcasing Israel's direct military backing in the conflict. + +**Lebanon:** Israel’s violation of Lebanon’s airspace and frequent incursions have heightened fears of another devastating war. Targeted killings and bombings are displacing Lebanese civilians, further destabilizing a nation struggling to recover from past conflicts. + +**Iran:** + +* **Bombing of Civilians:** Israeli strikes on Iran that began on June 13, 2025, have resulted in significant civilian casualties. According to a US-based human rights group, at least 950 people have been killed, including 380 identified civilians, with over 3,450 others wounded. Iran's Health Ministry has reported that over 90% of the injuries occurred among civilians, including women and children. +* **A "Crybaby" Reaction to Retaliation:** While inflicting heavy civilian casualties in Iran, Israel has shown a different face when faced with retaliation. After Iran launched missiles and drones in response, killing 29 people and wounding over 3,000 in Israel, Israeli Prime Minister Benjamin Netanyahu called the Iranian regime "weak" and appealed for international support. This reaction highlights a pattern of aggression without accepting the consequences when an opponent can strike back with force. +* **Begging for US Intervention and Failure to Achieve Goals:** Israel's military campaign, dubbed "Operation Rising Lion," aimed to destroy Iran's nuclear program. However, some of Iran's nuclear facilities are buried deep underground, reportedly beyond the reach of Israeli weapons. This led to Israel seeking and receiving direct military intervention from the United States, which used "bunker buster" bombs on Iranian nuclear sites. Despite the joint effort, assessments indicate that while Iran's nuclear program was set back, it was not eliminated. Reports suggest that some sites are repairable and that Iran retains the materials and knowledge to rebuild, potentially being more motivated to develop nuclear weapons to deter future attacks. + +**The situation in Egypt is also not that good** + +* **Tensions between Egypt and Israel:** Tensions between Egypt and Israel have reached their highest level since the war began, primarily due to Israel's policies aimed at forcibly displacing Palestinians toward Egypt's borders. Egypt views this as a direct threat to its national security and rejects any plan for mass displacement into Sinai. Egypt has expressed strong objections to Israel's continued military control over the Philadelphi Corridor and its refusal to reopen border crossings. +* **Pressure on Borders:** Israel pressures Egypt to accept the flow of Palestinian refugees fleeing the carnage in Gaza, threatening regional stability and exacerbating existing tensions within Sinai. This pressure plays on long-standing historical grievances between Palestinians and Egyptian authorities who see this influx as a destabilizing force under Israeli manipulation. +* **Threatening Peace Treaties:** By flagrantly violating Egypt's territorial sovereignty through incursions and air strikes, Israel threatens the fragile peace agreement signed in 1979. + +**This is not simply a regional conflict; it’s a systematic pattern of violence driven by illegal occupation, apartheid policies, and blatant disregard for international law.** + +The international community remains largely complicit, failing to hold Israel accountable for its crimes against humanity and enabling the expansionism that fuels this ongoing catastrophe. + +**We urge you as developers to consider:** + +* **Boycotting all products and services that directly benefit the Israeli military machine.** Your money funds their brutal weapons and technology used in Gaza, Syria, Lebanon, and Iran – investing in businesses that profit from human suffering is ethically untenable. +* **Using your platform and influence to raise awareness about this injustice.** Silence empowers aggressors. Speak out against Israeli policies and war crimes. Demand accountability for every Palestinian life lost under their relentless assault. +* **Supporting Palestinian-led organizations working on the ground in Palestine, Syria, Lebanon, and Egypt:** They provide vital aid, resist oppression, document human rights abuses, and fight for justice. + +**Your skills are powerful tools.** Use them responsibly and ethically. The reality is brutal: a child's body shattered by bombs in Gaza, families torn apart in Lebanon while their homes are reduced to rubble, land stolen while its rightful owners cower under the threat of death. + +**Don’t be complicit.** History is not written by the victors alone – stand up for justice against this violent expansionism before it engulfs the entire region. + +Learn more about the reality on the ground from reliable sources, not colonizer-backed websites. diff --git a/Samples/SoundFlow.Samples.EditingMixer/PersistenceExamples.cs b/Samples/SoundFlow.Samples.EditingMixer/PersistenceExamples.cs index 5ade0f7..bff7348 100644 --- a/Samples/SoundFlow.Samples.EditingMixer/PersistenceExamples.cs +++ b/Samples/SoundFlow.Samples.EditingMixer/PersistenceExamples.cs @@ -7,6 +7,8 @@ using SoundFlow.Editing.Persistence; using SoundFlow.Enums; using SoundFlow.Providers; +using SoundFlow.Security.Configuration; +using SoundFlow.Security.Utils; using SoundFlow.Structs; namespace SoundFlow.Samples.EditingMixer; @@ -24,7 +26,7 @@ public static class PersistenceExamples public static void Run() { - Console.WriteLine("\nSoundFlow Editing - Persistence Examples"); + Console.WriteLine("\nSoundFlow Editing — Persistence Examples"); Console.WriteLine("========================================"); Directory.CreateDirectory(ProjectSaveDirectory); @@ -39,6 +41,8 @@ public static void Run() Console.WriteLine(" 2. Create, Save, and Load a Project (Embed Small Media, No Consolidate)"); Console.WriteLine(" 3. Load Project with Missing Media and Relink"); Console.WriteLine(" 4. Demonstrate Dirty Flag"); + Console.WriteLine(" 5. Create, Sign, and Verify a Secure Project"); + Console.WriteLine(" 6. Attempt to Verify a Tampered Project"); Console.WriteLine(" 0. Back to Main Menu / Exit"); Console.Write("Enter your choice: "); @@ -50,6 +54,8 @@ public static void Run() case 2: RunPersistenceExample(SaveAndLoadSimpleProject_Embed, "Save/Load Simple (Embed)"); break; case 3: RunPersistenceExample(LoadWithMissingMediaAndRelink, "Load Missing & Relink"); break; case 4: RunPersistenceExample(DemonstrateDirtyFlag, "Demonstrate Dirty Flag"); break; + case 5: RunPersistenceExample(CreateSignAndVerifySecureProject, "Sign & Verify Secure Project"); break; + case 6: RunPersistenceExample(VerifyTamperedProject, "Verify Tampered Project"); break; case 0: running = false; break; default: Console.WriteLine("Invalid choice. Please try again."); break; } @@ -134,7 +140,7 @@ private static void PlayComposition(Composition composition, string message = "P private static async Task SaveAndLoadSimpleProject_Consolidate() { - var projectName = "SimpleProject_Consolidated"; + const string projectName = "SimpleProject_Consolidated"; var projectFilePath = Path.Combine(ProjectSaveDirectory, $"{projectName}.sfproj"); Console.WriteLine($"Creating composition: {projectName}"); @@ -393,4 +399,89 @@ private static Task DemonstrateDirtyFlag() composition.Dispose(); return Task.CompletedTask; } + + private static async Task CreateSignAndVerifySecureProject() + { + var projectName = "SecureProject_Signed"; + var projectFilePath = Path.Combine(ProjectSaveDirectory, $"{projectName}.sfproj"); + + Console.WriteLine("Generating ECDSA key pair for project signing..."); + var keys = SignatureKeyGenerator.Generate(); + + Console.WriteLine($"Creating composition: {projectName}"); + var composition = new Composition(AudioEngine, Format, projectName); + var track = new Track("Secure Track"); + composition.Editor.AddTrack(track); + + // Add dummy segment + var beepDuration = TimeSpan.FromSeconds(1.0); + var beepProvider = DemoAudio.GenerateShortBeep(beepDuration); + track.AddSegment(new AudioSegment(Format, beepProvider, TimeSpan.Zero, beepDuration, TimeSpan.Zero, "Beep", ownsDataProvider: true)); + + // Save with signing + Console.WriteLine($"Saving and signing project to: {projectFilePath}"); + await CompositionProjectManager.SaveProjectAsync(AudioEngine, composition, projectFilePath, new ProjectSaveOptions + { + SigningConfiguration = new SignatureConfiguration { PrivateKeyPem = keys.PrivateKeyPem } + }); + Console.WriteLine("Project saved and signed (.sig file created)."); + composition.Dispose(); + + // Verify before loading + Console.WriteLine("Verifying project integrity..."); + var verifyResult = await CompositionProjectManager.VerifyProjectAsync(projectFilePath, null, new SignatureConfiguration { PublicKeyPem = keys.PublicKeyPem }); + + if (verifyResult is { IsSuccess: true, Value: true }) + { + Console.WriteLine("SUCCESS: Project verification passed. The file is authentic."); + + // Proceed to load + var (loadedComposition, _) = await CompositionProjectManager.LoadProjectAsync(AudioEngine, Format, projectFilePath); + Console.WriteLine("Project loaded successfully."); + loadedComposition.Dispose(); + } + else + { + Console.WriteLine($"FAILURE: Project verification failed! {verifyResult.Error?.Message}"); + } + } + + private static async Task VerifyTamperedProject() + { + var projectName = "TamperedProject"; + var projectFilePath = Path.Combine(ProjectSaveDirectory, $"{projectName}.sfproj"); + + Console.WriteLine($"Generating ECDSA key pair..."); + var keys = SignatureKeyGenerator.Generate(); + + Console.WriteLine($"Creating and saving valid project: {projectName}"); + var composition = new Composition(AudioEngine, Format, projectName); + await CompositionProjectManager.SaveProjectAsync(AudioEngine, composition, projectFilePath, new ProjectSaveOptions + { + SigningConfiguration = new SignatureConfiguration { PrivateKeyPem = keys.PrivateKeyPem } + }); + composition.Dispose(); + + // Simulating tampering + Console.WriteLine("Simulating tampering: Modifying project file content..."); + var originalContent = await File.ReadAllTextAsync(projectFilePath); + // Replace something benign but structurally valid to ensure it's not just a JSON parse error, but a signature mismatch. + var tamperedContent = originalContent.Replace(projectName, "HackedProjectName"); + await File.WriteAllTextAsync(projectFilePath, tamperedContent); + + // Verify + Console.WriteLine("Attempting to verify tampered project..."); + var verifyResult = await CompositionProjectManager.VerifyProjectAsync(projectFilePath, null, new SignatureConfiguration { PublicKeyPem = keys.PublicKeyPem }); + + if (verifyResult is { IsSuccess: true, Value: true }) + { + Console.WriteLine("FAILURE: Tampered project was accepted as valid! (This is bad)"); + } + else + { + Console.WriteLine("SUCCESS: Tampered project was correctly rejected."); + if (!verifyResult.Value) Console.WriteLine("Reason: Signature mismatch (bool check)."); + if (verifyResult.IsFailure) Console.WriteLine($"Reason: {verifyResult.Error?.Message}"); + } + } } \ No newline at end of file diff --git a/Samples/SoundFlow.Samples.Recording/DeviceService.cs b/Samples/SoundFlow.Samples.Recording/DeviceService.cs new file mode 100644 index 0000000..f5144a1 --- /dev/null +++ b/Samples/SoundFlow.Samples.Recording/DeviceService.cs @@ -0,0 +1,54 @@ +using SoundFlow.Abstracts; +using SoundFlow.Structs; + +namespace SoundFlow.Samples.Recording; + +///