/** * @node sdcpp-upscale * @name SD.cpp Upscale * @category sdcpp * @version 1.0.0 * @description Enlarge an image with the loaded upscaler * @icon maximize-2 */ // The credential this node wants, named so it can be found. It is stored as a // plain basic credential - that is what decides how it is encrypted - and this // only says which basic credential is the SD.cpp one. Anything that accepts a // basic credential still accepts this, and this node still accepts a plain // basic credential, because the shape is identical. const credentialTypes = [ { id: 'sdcpp', label: 'SD.cpp Server', baseType: 'basic', description: 'The username and password you sign in to sdcpp-restapi with. The node exchanges them for a token before every call', usernameLabel: 'Username', passwordLabel: 'Password' } ]; const configSchema = { type: 'object', properties: { serverUrl: { type: 'string', title: 'Server URL', description: 'Base address of the sdcpp-restapi server', default: 'http://localhost:8077' }, credentialId: { type: 'string', title: 'Credential', description: 'A basic credential holding the sdcpp-restapi username and password', dynamicOptions: { source: 'credentials', filter: { type: ['sdcpp', 'basic'] } } }, imageBase64: { type: 'string', title: 'Image (base64)', description: 'The image to enlarge, base64 without a data: prefix' }, upscaleFactor: { type: 'number', title: 'Factor', description: 'How much to enlarge by' }, repeats: { type: 'number', title: 'Repeats', description: 'Run the upscaler more than once' }, tileSize: { type: 'number', title: 'Tile Size', description: 'Tile the work to fit in memory' }, title: { type: 'string', title: 'Job Title', description: 'Optional label stored with the job, useful for finding it again in the queue' }, extraOptions: { type: 'object', title: 'Extra Options', description: 'Any other generation field passed straight through, such as slg_scale, cache_mode or vae_tiling. See /options/generation on the server for the full list' }, timeout: { type: 'number', title: 'Timeout (ms)', description: 'Applies to queueing the job, not to the render. The call returns as soon as the job is accepted', default: 30000 } }, required: ['credentialId'] }; const inputSchema = { type: 'object', properties: { data: { type: 'any' } } }; const outputSchema = { type: 'object', properties: { jobId: { type: 'string', description: 'Id of the queued job, to pass to SD.cpp Wait For Job' }, status: { type: 'string', description: 'Queue status when the job was accepted, normally pending' }, position: { type: 'number', description: 'Place in the queue' }, request: { type: 'object', description: 'The body actually sent, useful for seeing which defaults were left to the server' } } }; function normalizeServer(url) { const value = String(url || '').trim(); if (!value) { throw new Error('SD.cpp: a server URL is required, such as http://localhost:8077'); } return value.replace(/\/+$/, ''); } function readCredential(credentialId) { const auth = smartbotic.credentials.get(credentialId); if (!auth || auth.success !== true) { throw new Error('SD.cpp: could not read the credential: ' + ((auth && auth.error) || 'unknown error')); } const value = auth.headerValue || ''; if (value.indexOf('Basic ') !== 0) { throw new Error('SD.cpp: the credential must be a basic one, holding the sdcpp-restapi ' + 'username and password'); } const decoded = smartbotic.utils.base64Decode(value.substring(6)); const separator = decoded.indexOf(':'); if (separator < 1) { throw new Error('SD.cpp: the credential is malformed, expected a username and a password'); } return { username: decoded.substring(0, separator), password: decoded.substring(separator + 1) }; } function call(options) { const response = smartbotic.http.request(options); let body = response.data; if (typeof body === 'string' && body.length > 0) { try { body = JSON.parse(body); } catch (e) { const snippet = body.substring(0, 200).replace(/\s+/g, ' '); throw new Error('SD.cpp: ' + options.what + ' returned HTTP ' + response.status + ' with a body that is not JSON: ' + snippet); } } if (response.status < 200 || response.status >= 300) { const detail = (body && (body.message || body.error)) || ('HTTP ' + response.status); throw new Error('SD.cpp: ' + options.what + ' failed: ' + detail); } return body || {}; } function login(server, credential, timeout) { const session = call({ method: 'POST', url: server + '/auth/login', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ username: credential.username, password: credential.password }), timeout: timeout, what: 'signing in' }); if (!session.token) { throw new Error('SD.cpp: the server accepted the login but returned no token'); } return session.token; } // /health is unauthenticated, and it is the only way to find out what is // already loaded without asking for a token first. function readHealth(server, timeout) { return call({ method: 'GET', url: server + '/health', timeout: timeout, what: 'reading server health' }); } function putIfSet(target, key, value) { if (value === undefined || value === null || value === '') { return; } target[key] = value; } // Width, steps, cfg_scale and the rest are architecture defaults: the server // fills them from the loaded model's preset when the field is absent. Sending an // empty box as 0 would override that preset with nonsense, so a field the user // did not fill is left out of the body entirely - and the test is emptiness, // never truthiness, because seed 0 and clip_skip 0 are legitimate values. async function execute(config, input, context) { const server = normalizeServer(config.serverUrl); const timeout = config.timeout || 30000; const credential = readCredential(config.credentialId); const token = login(server, credential, timeout); const body = {}; putIfSet(body, 'image_base64', config.imageBase64); putIfSet(body, 'upscale_factor', config.upscaleFactor); putIfSet(body, 'repeats', config.repeats); putIfSet(body, 'tile_size', config.tileSize); if (!body.image_base64) { throw new Error('SD.cpp: upscale needs an image'); } putIfSet(body, 'title', config.title); // Anything else the API accepts, passed through, so a new server field does // not need a node change to be reachable. const extra = config.extraOptions; if (extra && typeof extra === 'object') { const keys = Object.keys(extra); for (let i = 0; i < keys.length; i++) { putIfSet(body, keys[i], extra[keys[i]]); } } const queued = call({ method: 'POST', url: server + '/upscale', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer ' + token }, body: JSON.stringify(body), timeout: timeout, what: 'queueing the upscale job' }); if (!queued.job_id) { throw new Error('SD.cpp: the job was accepted but no job id came back'); } smartbotic.log.info('SD.cpp: queued upscale job ' + queued.job_id); return { jobId: queued.job_id, status: queued.status || 'pending', position: queued.position !== undefined ? queued.position : -1, request: body }; } module.exports = { configSchema, inputSchema, outputSchema, execute };