Initial release: ComfyUI custom nodes for SoulX-Singer zero-shot singing voice synthesis

- Add 4 ComfyUI nodes for preprocessing and SVS inference
- Add .gitignore, LICENSE (Apache-2.0), README with installation guide
- Remove __pycache__ and internal config from tracking

Co-authored-by: Cursor <cursoragent@cursor.com>

.gitignore

@@ -0,0 +1,50 @@
+# Sensitive files
+config.json
+rh_config.json
+.env
+*.pem
+*.key
+sync.sh
+deploy.sh
+cptorh*.sh
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+dist/
+build/
+venv/
+.venv/
+
+# Node.js
+node_modules/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Large files / Models
+*.pth
+*.ckpt
+*.safetensors
+*.bin
+*.pt
+models/
+weights/
+save_audio/
+
+# Logs
+*.log
+*.tmp
+
+# Audio output
+output/

LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 RunningHub
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,175 @@
+# ComfyUI_RH_SoulX-Singer
+
+![License](https://img.shields.io/badge/License-Apache%202.0-green)
+
+A ComfyUI custom node for **[SoulX-Singer](https://github.com/Soul-AILab/SoulX-Singer)** — a high-fidelity, zero-shot singing voice synthesis (SVS) model. This node enables users to generate realistic singing voices for unseen singers directly within ComfyUI, supporting both melody-conditioned (F0 contour) and score-conditioned (MIDI notes) control.
+
+<p align="center">
+  <a href="https://github.com/Soul-AILab/SoulX-Singer">Original Project</a> |
+  <a href="https://huggingface.co/spaces/Soul-AILab/SoulX-Singer">HF Demo</a> |
+  <a href="https://arxiv.org/abs/2602.07803">Paper</a>
+</p>
+
+## ✨ Features
+
+- **Zero-Shot Singing Voice Synthesis** — Generate high-fidelity singing voices for unseen singers without fine-tuning
+- **Flexible Control Modes** — Melody (F0 contour) and Score (MIDI notes) conditioning
+- **Multi-Language Support** — Mandarin, English, and Cantonese
+- **Full Pipeline** — Includes audio preprocessing (vocal separation, F0 extraction, lyric/note transcription) and SVS inference
+- **Timbre Cloning** — Preserve singer identity across languages and styles
+
+## 🛠️ Installation
+
+### Method 1: ComfyUI Manager (Recommended)
+
+Search for `ComfyUI_RH_SoulX-Singer` in ComfyUI Manager and install.
+
+### Method 2: Manual Installation
+
+```bash
+cd ComfyUI/custom_nodes
+git clone https://github.com/HM-RunningHub/ComfyUI_RH_SoulX-Singer.git
+cd ComfyUI_RH_SoulX-Singer
+pip install -r preprocess/requirements.txt
+```
+
+## 📦 Model Download & Installation
+
+All models must be placed in `ComfyUI/models/Soul-AILab/` with the following structure:
+
+```
+ComfyUI/
+└── models/
+    └── Soul-AILab/
+        ├── SoulX-Singer/                        # SVS model
+        │   └── model.pt
+        └── SoulX-Singer-Preprocess/             # Preprocessing models
+            ├── mel-band-roformer-karaoke/        # Vocal separation
+            ├── dereverb_mel_band_roformer/       # Dereverberation
+            ├── rmvpe/                            # F0 extraction
+            ├── speech_seaco_paraformer_large_asr_nat-zh-cn-16k-common-vocab8404-pytorch/  # Chinese ASR
+            ├── parakeet-tdt-0.6b-v2/             # English ASR
+            └── rosvot/                           # Note transcription
+                ├── rosvot/model.pt
+                └── rwbd/model.pt
+```
+
+### Download Methods
+
+#### Method 1: Download from HuggingFace (Recommended)
+
+```bash
+pip install -U huggingface_hub
+
+# Download the SoulX-Singer SVS model
+huggingface-cli download Soul-AILab/SoulX-Singer --local-dir ComfyUI/models/Soul-AILab/SoulX-Singer
+
+# Download preprocessing models
+huggingface-cli download Soul-AILab/SoulX-Singer-Preprocess --local-dir ComfyUI/models/Soul-AILab/SoulX-Singer-Preprocess
+```
+
+#### Method 2: Download from ModelScope (For China users)
+
+```bash
+pip install modelscope
+
+# Download the SoulX-Singer SVS model
+modelscope download --model Soul-AILab/SoulX-Singer --local_dir ComfyUI/models/Soul-AILab/SoulX-Singer
+
+# Download preprocessing models
+modelscope download --model Soul-AILab/SoulX-Singer-Preprocess --local_dir ComfyUI/models/Soul-AILab/SoulX-Singer-Preprocess
+```
+
+## 🚀 Usage
+
+### Workflow
+
+The typical workflow consists of 4 nodes:
+
+1. **Load Preprocess Pipeline** → Loads the audio preprocessing models
+2. **Preprocess Audio** → Extracts vocal, F0, lyrics, and notes from audio
+3. **Load SVS Model** → Loads the SoulX-Singer synthesis model
+4. **Generate Singing Voice** → Synthesizes singing voice with timbre cloning
+
+### Basic Steps
+
+1. Connect a **prompt audio** (reference singer voice for timbre) and a **target audio** (the song to be synthesized)
+2. Preprocess both audios to extract metadata
+3. Load the SVS model
+4. Generate the singing voice with melody or score control
+
+## 📝 Node Reference
+
+### RunningHub SoulX-Singer Preprocess Pipeline
+
+Loads all preprocessing models (vocal separation, F0 extraction, ASR, note transcription).
+
+| Output | Type | Description |
+|--------|------|-------------|
+| pipeline | SoulXSinger_Preprocess_Pipeline | Loaded preprocessing pipeline |
+
+### RunningHub SoulX-Singer Preprocessor
+
+Processes audio to extract singing metadata.
+
+| Input | Type | Description |
+|-------|------|-------------|
+| pipeline | SoulXSinger_Preprocess_Pipeline | Preprocessing pipeline |
+| audio | AUDIO | Input audio |
+| max_merge_duration | INT | Max segment duration in ms (10000–60000, default: 30000) |
+| language | STRING | Language: Mandarin / English / Cantonese |
+
+| Output | Type | Description |
+|--------|------|-------------|
+| audio metadata | SoulXSinger_Audio_Metadata | Extracted singing metadata (JSON) |
+
+### RunningHub SoulX-Singer SVS Loader
+
+Loads the SoulX-Singer SVS model and data processor.
+
+| Output | Type | Description |
+|--------|------|-------------|
+| pipeline | SoulXSinger_SVS_Pipeline | Loaded SVS model and processor |
+
+### RunningHub SoulX-Singer SVS Processor
+
+Generates singing voice from metadata.
+
+| Input | Type | Description |
+|-------|------|-------------|
+| pipeline | SoulXSinger_SVS_Pipeline | Loaded SVS pipeline |
+| control | STRING | Control mode: melody / score |
+| prompt_wav | AUDIO | Reference singer audio (timbre source) |
+| prompt_metadata | SoulXSinger_Audio_Metadata | Prompt audio metadata |
+| target_metadata | SoulXSinger_Audio_Metadata | Target audio metadata |
+| seed | INT | Random seed (default: 12306) |
+
+| Output | Type | Description |
+|--------|------|-------------|
+| audio | AUDIO | Generated singing voice audio |
+
+## 📄 License
+
+This project is licensed under the [Apache License 2.0](LICENSE).
+
+## 🔗 Links
+
+- **Original Project**: [Soul-AILab/SoulX-Singer](https://github.com/Soul-AILab/SoulX-Singer)
+- **Online Demo**: [HuggingFace Space](https://huggingface.co/spaces/Soul-AILab/SoulX-Singer)
+- **Paper**: [arXiv:2602.07803](https://arxiv.org/abs/2602.07803)
+- **SVS Model**: [HuggingFace](https://huggingface.co/Soul-AILab/SoulX-Singer)
+- **Preprocess Models**: [HuggingFace](https://huggingface.co/Soul-AILab/SoulX-Singer-Preprocess)
+
+## 🙏 Acknowledgements
+
+This project is based on [SoulX-Singer](https://github.com/Soul-AILab/SoulX-Singer), developed by [Soul-AILab](https://github.com/Soul-AILab).
+
+We also thank the following open-source projects:
+
+- [F5-TTS](https://github.com/SWivid/F5-TTS) — Text-to-Speech framework
+- [Amphion](https://github.com/open-mmlab/Amphion) — Audio/Music/Speech toolkit
+- [Music Source Separation Training](https://github.com/ZFTurbo/Music-Source-Separation-Training) — Vocal separation
+- [RMVPE](https://github.com/Dream-High/RMVPE) — F0 extraction
+- [ROSVOT](https://github.com/RickyL-2000/ROSVOT) — Note transcription
+- [Paraformer](https://modelscope.cn/models/iic/speech_seaco_paraformer_large_asr_nat-zh-cn-16k-common-vocab8404-pytorch) — Chinese ASR
+- [Parakeet-tdt-0.6b-v2](https://huggingface.co/nvidia/parakeet-tdt-0.6b-v2) — English ASR

rh_config.json

@@ -1 +0,0 @@
-{"enable": true, "untracked_paths": []}