diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..56f653c --- /dev/null +++ b/LICENSE @@ -0,0 +1,237 @@ + 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 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, as 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 designated in writing by the copyright owner as "Not a + Contribution." + + "Contributor" shall mean Licensor and any 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, You must include a readable copy of the + attribution notices contained within such NOTICE file, 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 license statement for Your modifications and + may provide additional grant of rights to use, copy, modify, merge, + publish, distribute, sublicense, and/or sell copies of Your + modifications, and to permit persons to whom Your modifications are + furnished to do so. + + 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 exemplary 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 all other + commercial damages or losses), even if such Contributor has been + advised of the possibility of such damages. + + 9. Accepting Warranty or 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 rights consistent with this License. However, in + accepting such obligations, You may offer such obligations 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 + + --- + + SUPPLEMENTAL TERMS (additional conditions under Section 4) + + The following supplemental terms apply to all use, reproduction, and + distribution of this Work: + + a. Patent Prohibition. You may not use this software, its source code, + its compiled forms, its documentation, or any assets associated with + it to file or assist in filing any patent application of any kind in + any jurisdiction. + + b. Attribution Requirement. Any public or commercial deployment, + distribution, or product that incorporates this Work or a Derivative + Work must display the following notice in a prominent location visible + to end users (such as a splash screen, about page, or footer): + + Powered by K.G.One © 2026 Xiaohan Tian + + --- + + THIRD-PARTY COMPONENT NOTICES + + K.G.One integrates or proxies the following third-party projects. Their + respective licenses govern your use of those components. + + 1. K.G.Studio (https://github.com/KGAudioLab/K.G.Studio) + Apache License 2.0 with supplemental terms: + - You may not use the software to file or support any patent application. + - Public or commercial use requires displaying: + "Powered by K.G.Studio © 2025 Xiaohan Tian" + Full license: https://github.com/KGAudioLab/K.G.Studio/blob/main/LICENSE + + 2. ACE-Step 1.5 (https://github.com/ace-step/ACE-Step-1.5) + MIT License + Full license: https://github.com/ace-step/ACE-Step-1.5/blob/main/LICENSE + + 3. Foundation-1 / stable-audio-open-1.0 + (https://huggingface.co/stabilityai/stable-audio-open-1.0) + Stability AI Community License + - Free for research and non-commercial use. + - Commercial use requires a separate license from Stability AI. + See: https://stability.ai/license + Full license: https://huggingface.co/stabilityai/stable-audio-open-1.0 + + 4. python-audio-separator / UVR5 (https://github.com/nomadkaraoke/python-audio-separator) + MIT License + Full license: https://github.com/nomadkaraoke/python-audio-separator/blob/main/LICENSE + + If you use features powered by any of the above components, you are + responsible for complying with their respective licenses. + + --- + + Copyright 2026 Xiaohan Tian + + 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. diff --git a/README.md b/README.md index ee1d2ae..70db9f5 100644 --- a/README.md +++ b/README.md @@ -631,3 +631,27 @@ curl -X POST http://localhost:8000/v1/models/load \ } } ``` + +--- + +## License + +K.G.One is licensed under the [Apache License 2.0](./LICENSE) with two supplemental conditions: + +- **No patents** — this software may not be used to file or support any patent application in any jurisdiction. +- **Attribution** — public or commercial deployments must display `Powered by K.G.One © 2026 Xiaohan Tian` in a prominent location visible to end users. + +### Third-party component licenses + +K.G.One integrates or proxies the following projects. If you use the corresponding features, you are responsible for complying with their licenses. + +| Component | Used for | License | Notes | +|-----------|----------|---------|-------| +| [K.G.Studio](https://github.com/KGAudioLab/K.G.Studio) | Browser DAW UI | Apache 2.0 + custom terms | Public/commercial use requires displaying `Powered by K.G.Studio © 2025 Xiaohan Tian`; no patent filing permitted | +| [ACE-Step 1.5](https://github.com/ace-step/ACE-Step-1.5) | Full-song generation (`/v1/fullsong/*`) | MIT | Permissive — attribution required | +| [stable-audio-open-1.0](https://huggingface.co/stabilityai/stable-audio-open-1.0) | Clip generation (`/v1/clip/*`) via Foundation-1 | Stability AI Community License | **Non-commercial only.** Commercial use requires a separate license from Stability AI — see [stability.ai/license](https://stability.ai/license) | +| [python-audio-separator / UVR5](https://github.com/nomadkaraoke/python-audio-separator) | Stem separation (`/v1/separator/*`) | MIT | Permissive — attribution required | + +> **Note:** The `clip` generation feature is powered by a model released under the Stability AI Community License, which **does not permit commercial use**. If you intend to use K.G.One in a commercial product, you must obtain a commercial license from Stability AI before enabling or exposing the `/v1/clip/*` endpoints. + +See [LICENSE](./LICENSE) for the full terms including third-party notices. diff --git a/cleanup.bat b/cleanup.bat index f4eae46..1571f67 100644 --- a/cleanup.bat +++ b/cleanup.bat @@ -10,6 +10,8 @@ echo .venv\ (gateway Python environment) echo ace-step\ (submodule + venv + model checkpoints) echo foundation1\ (submodule + venv + model weights) echo separator\ (submodule + venv) +echo kgstudio\ (frontend repo + node_modules + dist) +echo soundfonts\ (soundfont-for-samplers MP3 samples, ~150 MB) echo outputs\ (all generated audio and MIDI files) echo uploads\ (all uploaded audio files) echo. @@ -55,6 +57,22 @@ if exist "separator" ( echo separator not found, skipping. ) +if exist "kgstudio" ( + echo Removing kgstudio ... + rmdir /s /q "kgstudio" + echo Done. +) else ( + echo kgstudio not found, skipping. +) + +if exist "soundfonts" ( + echo Removing soundfonts ... + rmdir /s /q "soundfonts" + echo Done. +) else ( + echo soundfonts not found, skipping. +) + if exist "outputs" ( echo Removing outputs ... rmdir /s /q "outputs" diff --git a/init.bat b/init.bat index 23bb0c2..c08dd4a 100644 --- a/init.bat +++ b/init.bat @@ -23,12 +23,19 @@ if errorlevel 1 ( exit /b 1 ) +where nvm >nul 2>&1 +if errorlevel 1 ( + echo ERROR: nvm not found. Install from https://github.com/coreybutler/nvm-windows/releases + exit /b 1 +) + echo git ... OK echo uv ... OK +echo nvm ... OK echo. :: --------------------------------------------------------- -echo [1/6] Reading submodules.json... +echo [1/9] Reading submodules.json... :: --------------------------------------------------------- powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.'ace-step'.url | Out-File -Encoding ASCII '%TEMP%\kg_acestep_url.txt' -NoNewline" @@ -41,6 +48,9 @@ powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.foundation1.commit | Out-File -Encoding ASCII '%TEMP%\kg_f1_commit.txt' -NoNewline" powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.'python-audio-separator'.url | Out-File -Encoding ASCII '%TEMP%\kg_sep_url.txt' -NoNewline" powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.'python-audio-separator'.commit | Out-File -Encoding ASCII '%TEMP%\kg_sep_commit.txt' -NoNewline" +powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.kgstudio.url | Out-File -Encoding ASCII '%TEMP%\kg_kgs_url.txt' -NoNewline" +powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.'soundfont-for-samplers'.url | Out-File -Encoding ASCII '%TEMP%\kg_sf_url.txt' -NoNewline" +powershell -NoProfile -Command "$j = Get-Content 'submodules.json' | ConvertFrom-Json; $j.'soundfont-for-samplers'.commit | Out-File -Encoding ASCII '%TEMP%\kg_sf_commit.txt' -NoNewline" set /p ACESTEP_URL=<"%TEMP%\kg_acestep_url.txt" set /p ACESTEP_COMMIT=<"%TEMP%\kg_acestep_commit.txt" @@ -48,7 +58,10 @@ set /p FOUNDATION1_URL=<"%TEMP%\kg_f1_url.txt" set /p FOUNDATION1_COMMIT=<"%TEMP%\kg_f1_commit.txt" set /p SEP_URL=<"%TEMP%\kg_sep_url.txt" set /p SEP_COMMIT=<"%TEMP%\kg_sep_commit.txt" -del "%TEMP%\kg_acestep_url.txt" "%TEMP%\kg_acestep_commit.txt" "%TEMP%\kg_f1_url.txt" "%TEMP%\kg_f1_commit.txt" "%TEMP%\kg_sep_url.txt" "%TEMP%\kg_sep_commit.txt" >nul 2>&1 +set /p KGSTUDIO_URL=<"%TEMP%\kg_kgs_url.txt" +set /p SOUNDFONTS_URL=<"%TEMP%\kg_sf_url.txt" +set /p SOUNDFONTS_COMMIT=<"%TEMP%\kg_sf_commit.txt" +del "%TEMP%\kg_acestep_url.txt" "%TEMP%\kg_acestep_commit.txt" "%TEMP%\kg_f1_url.txt" "%TEMP%\kg_f1_commit.txt" "%TEMP%\kg_sep_url.txt" "%TEMP%\kg_sep_commit.txt" "%TEMP%\kg_kgs_url.txt" "%TEMP%\kg_sf_url.txt" "%TEMP%\kg_sf_commit.txt" >nul 2>&1 if "%ACESTEP_URL%"=="" ( echo ERROR: Could not read from submodules.json @@ -61,10 +74,13 @@ echo Foundation-1 URL : %FOUNDATION1_URL% echo Foundation-1 commit: %FOUNDATION1_COMMIT% echo audio-separator URL : %SEP_URL% echo audio-separator commit: %SEP_COMMIT% +echo KGStudio URL : %KGSTUDIO_URL% +echo soundfont-for-samplers URL : %SOUNDFONTS_URL% +echo soundfont-for-samplers commit: %SOUNDFONTS_COMMIT% echo. :: --------------------------------------------------------- -echo [2/6] Setting up ACE-Step... +echo [2/9] Setting up ACE-Step... :: --------------------------------------------------------- if exist "ace-step\.git" goto :acestep_fetch @@ -91,7 +107,7 @@ echo ACE-Step OK. echo. :: --------------------------------------------------------- -echo [3/6] Setting up Foundation-1... +echo [3/9] Setting up Foundation-1... :: --------------------------------------------------------- if exist "foundation1\.git" goto :f1_fetch @@ -118,7 +134,7 @@ echo Foundation-1 OK. echo. :: --------------------------------------------------------- -echo Setting up python-audio-separator... +echo [4/9] Setting up python-audio-separator... :: --------------------------------------------------------- if exist "separator\.git" goto :sep_fetch @@ -145,7 +161,102 @@ echo python-audio-separator OK. echo. :: --------------------------------------------------------- -echo [4/6] Setting up Python environments... +echo [5/9] Setting up KGStudio... +:: --------------------------------------------------------- + +if exist "kgstudio\.git" goto :kgstudio_pull +echo Cloning KGStudio... +git clone "%KGSTUDIO_URL%" kgstudio +if errorlevel 1 ( + echo ERROR: Failed to clone KGStudio + exit /b 1 +) +goto :kgstudio_node + +:kgstudio_pull +echo Repository exists. Pulling latest... +git -C kgstudio pull --quiet origin + +:kgstudio_node +echo Installing Node.js 20.19 (latest patch)... +nvm install 20.19 +if errorlevel 1 ( + echo ERROR: Failed to install Node.js 20.19 + exit /b 1 +) +nvm use 20.19 +if errorlevel 1 ( + echo ERROR: Failed to activate Node.js 20.19 + exit /b 1 +) +:: nvm use updates the symlink but does not update PATH in the current batch session. +:: Resolve node's directory from nvm root + nvm current and inject it into PATH. +for /f "usebackq delims=" %%R in (`nvm root`) do set "_NVM_ROOT=%%R" +for /f "usebackq delims=" %%V in (`nvm current`) do set "_NVM_VER=%%V" +set "PATH=%_NVM_ROOT%\%_NVM_VER%;%PATH%" +echo Installing npm dependencies... +pushd kgstudio +echo kgstudio_npm_install_start > "%TEMP%\kginit_trace.txt" +call npm install --no-audit --no-fund +set "_EC=%ERRORLEVEL%" +echo kgstudio_npm_install_exit_%_EC% >> "%TEMP%\kginit_trace.txt" +echo [debug] npm install exit code: %_EC% +if %_EC% neq 0 ( + popd + type "%TEMP%\kginit_trace.txt" + echo ERROR: npm install failed ^(exit code %_EC%^) + exit /b 1 +) +echo Building KGStudio (tsc + vite build)... +echo kgstudio_npm_build_start >> "%TEMP%\kginit_trace.txt" +call npm run build +set "_EC=%ERRORLEVEL%" +echo kgstudio_npm_build_exit_%_EC% >> "%TEMP%\kginit_trace.txt" +echo [debug] npm run build exit code: %_EC% +if %_EC% neq 0 ( + popd + type "%TEMP%\kginit_trace.txt" + echo ERROR: npm run build failed ^(exit code %_EC%^) + exit /b 1 +) +popd +del "%TEMP%\kginit_trace.txt" >nul 2>&1 +if not exist "kgstudio\dist\index.html" ( + echo ERROR: Build succeeded but dist\index.html not found + exit /b 1 +) +echo KGStudio OK. +echo. + +:: --------------------------------------------------------- +echo [6/9] Setting up soundfonts... +:: --------------------------------------------------------- + +if exist "soundfonts\.git" goto :soundfonts_fetch +echo Cloning soundfont-for-samplers (may take several minutes, ~150 MB)... +git clone "%SOUNDFONTS_URL%" soundfonts +if errorlevel 1 ( + echo ERROR: Failed to clone soundfont-for-samplers + exit /b 1 +) +goto :soundfonts_checkout + +:soundfonts_fetch +echo Repository exists. Fetching refs... +git -C soundfonts fetch --quiet origin + +:soundfonts_checkout +echo Checking out pinned commit %SOUNDFONTS_COMMIT%... +git -C soundfonts checkout %SOUNDFONTS_COMMIT% --quiet +if errorlevel 1 ( + echo ERROR: Could not checkout soundfont-for-samplers commit %SOUNDFONTS_COMMIT% + exit /b 1 +) +echo soundfont-for-samplers OK. +echo. + +:: --------------------------------------------------------- +echo [7/9] Setting up Python environments... :: --------------------------------------------------------- :: Gateway venv @@ -273,7 +384,7 @@ echo Separator venv already exists, skipping. echo. :: --------------------------------------------------------- -echo [5/6] Creating output directories... +echo [8/9] Creating output directories... :: --------------------------------------------------------- if not exist "outputs\clip" mkdir "outputs\clip" if not exist "outputs\fullsong" mkdir "outputs\fullsong" @@ -285,7 +396,7 @@ echo Done. echo. :: --------------------------------------------------------- -echo [6/6] Downloading model weights... +echo [9/9] Downloading model weights... :: --------------------------------------------------------- :: ACE-Step weights - mirrors what the API server does on first initialize: @@ -324,16 +435,23 @@ echo Initialization complete! echo ========================================== echo. echo Start the gateway: -echo .venv\Scripts\python.exe main.py +echo uv run .\main.py +echo uv run .\main.py --host 0.0.0.0 (allow remote access) +echo uv run .\main.py --host 0.0.0.0 --port 8080 (custom port) +echo. +echo The default browser will open automatically once the server starts. echo. echo Then load a model: -echo POST http://localhost:8000/v1/models/load +echo POST http://127.0.0.1:8000/v1/models/load echo Body: {"model": "clip"} -- Foundation-1 (MIDI + WAV) echo Body: {"model": "fullsong"} -- ACE-Step 1.5 (full songs) echo. echo Or separate stems (no model load needed): -echo POST http://localhost:8000/v1/separator/separate +echo POST http://127.0.0.1:8000/v1/separator/separate echo Body: multipart/form-data file=