module.json

{
	"name": "Spleeter",
	"type": "Empty",
	"path": "Custom",
	
	"version": "2.1.0",
	"description": "Music separation by Deezer / Spleeter.,,
	 ** Portable version for win, linux_x86_64, macOs x86_64 **,
	Need python / tensorflow / ffmpeg,
	Available models:
    Vocals (singing voice) / accompaniment separation (2 stems)
    Vocals / drums / bass / other separation (4 stems)
    Vocals / drums / bass / piano / other separation (5 stems)",
	"url":"https://github.com/zak-45/SpleeterGUI-Chataigne-Module",
	"downloadURL": "https://github.com/zak-45/SpleeterGUI-Chataigne-Module/archive/refs/heads/main.zip",
	"hasInput": true,
	"hasOutput": true, 
	"hideDefaultCommands": false,

	"parameters": {

		"Portable Python Installation": {
			"type": "Container",
			"description":"Spleeter Python Portable installation",
			"collapsed": false,
			"install": {
				"type": "Trigger",
				"description": "Install Spleeter Python portable version for your OS.Not necessary if you want to use your own, in this case you need to customize the cmd files.Click to initiate installation, this could take a while....",

			}
		},
		"Spleeter Params":{
			"type": "Container",
			"description":"Spleeter global parameters",
			"collapsed": false,
			"Spleeter Info": {
				"type": "Trigger",
				"description": "Click to see documentation"
			},
			"Spleeter command": { 
				"type": "File", 
				"description": "Command to execute",
				"default":"spleeter.cmd"
			},
			"Spleeter options": {
				"type": "String", 
				"description": "Command options ",
				"default":" separate -c mp3 "
			},			
			"Output Folder": { 
				"type": "File", 
				"directoryMode": true,
				"description": "Spleeter output folder name. 
	This one will store the separate audio file output.
	If left blank, will be set to audio_output under temp location."
			},
			"Force": { 
				"type": "Boolean", 
				"description": "To optimize the process, Spleeter will check if an already separation file exist and re-use it.
	This parameter will force spleeter to execute and overwrite existing files. ",
				"default":false
			},			
			"Verbose": { 
				"type": "Boolean", 
				"description": "Check to have verbose informations from Spleeter running process. ",
				"default":true
			},
			"Spleeter Command Line": {
				"type": "Trigger",
				"description": "Click to open spleeter command line terminal"
			}
		}
	},
	"values": {	
	},
	"scripts": [
		"Spleeter.js"
	],
	"commands": {
		
		"Separate":
		{
			"menu":"Spleeter",
			"callback":"Spleeter",
			"parameters":{
				"sequence":{
					"type":"Target",
					"root" : "root.sequences",					
					"description": "Select filePath from the Sequence / AudioClip  to separate.
Result will be shown on the existing sequence",
					"allowedTypes":["File"],
					"targetType" : "controllable",
					"showParameters": false,
					"showTriggers": false
				},
				"File name":{
					"type":"File",
					"description": "Select mp3 audio file to separate.
Result will create new sequence."					
				},				
				"Model to use": {
					"type": "Enum",
					"description": "
Vocals (singing voice) / accompaniment separation (2 stems)
Vocals / drums / bass / other separation (4 stems)
Vocals / drums / bass / piano / other separation (5 stems)

All the previous models (spleeter:2stems, spleeter:4stems and spleeter:5stems) performs separation up to 11kHz.
There also exists 16kHz versions of the same models (resp. (spleeter:2stems-16kHz, spleeter:4stems-16kHz and spleeter:5stems-16kHz)).
",
					"readOnly": false,
					"options": {
						"2 stems":"spleeter:2stems",
						"4 stems":"spleeter:4stems",
						"5 stems":"spleeter:5stems",
						"2 stems 16kHz":"spleeter:2stems-16kHz",
						"4 stems 16kHz":"spleeter:4stems-16kHz",
						"5 stems 16kHz":"spleeter:5stems-16kHz"
						
					}
				}
			}
		}
	}
}