widgetInputs.js 17.7 KB
Newer Older
1
2
import { ComfyWidgets, addValueControlWidget } from "../../scripts/widgets.js";
import { app } from "../../scripts/app.js";
3
4

const CONVERTED_TYPE = "converted-widget";
5
const VALID_TYPES = ["STRING", "combo", "number", "BOOLEAN"];
6
const CONFIG = Symbol();
7

8
9
10
11
12
function getConfig(widgetName) {
	const { nodeData } = this.constructor;
	return nodeData?.input?.required[widgetName] ?? nodeData?.input?.optional?.[widgetName];
}

13
function isConvertableWidget(widget, config) {
14
	return (VALID_TYPES.includes(widget.type) || VALID_TYPES.includes(config[0])) && !widget.options?.forceInput;
15
16
17
18
19
20
21
22
23
24
}

function hideWidget(node, widget, suffix = "") {
	widget.origType = widget.type;
	widget.origComputeSize = widget.computeSize;
	widget.origSerializeValue = widget.serializeValue;
	widget.computeSize = () => [0, -4]; // -4 is due to the gap litegraph adds between widgets automatically
	widget.type = CONVERTED_TYPE + suffix;
	widget.serializeValue = () => {
		// Prevent serializing the widget if we have no input linked
25
26
27
		if (!node.inputs) {
			return undefined;
		}
28
29
30
		let node_input = node.inputs.find((i) => i.widget?.name === widget.name);

		if (!node_input || !node_input.link) {
31
32
			return undefined;
		}
33
		return widget.origSerializeValue ? widget.origSerializeValue() : widget.value;
34
35
	};

36
	// Hide any linked widgets, e.g. seed+seedControl
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
	if (widget.linkedWidgets) {
		for (const w of widget.linkedWidgets) {
			hideWidget(node, w, ":" + widget.name);
		}
	}
}

function showWidget(widget) {
	widget.type = widget.origType;
	widget.computeSize = widget.origComputeSize;
	widget.serializeValue = widget.origSerializeValue;

	delete widget.origType;
	delete widget.origComputeSize;
	delete widget.origSerializeValue;

53
	// Hide any linked widgets, e.g. seed+seedControl
54
55
56
57
58
59
60
61
62
63
	if (widget.linkedWidgets) {
		for (const w of widget.linkedWidgets) {
			showWidget(w);
		}
	}
}

function convertToInput(node, widget, config) {
	hideWidget(node, widget);

64
	const { linkType } = getWidgetType(config, `${node.comfyClass}|${widget.name}`);
65
66

	// Add input and store widget config for creating on primitive node
67
	const sz = node.size;
68
	node.addInput(widget.name, linkType, {
69
		widget: { name: widget.name, getConfig: () => config },
70
	});
71

72
73
74
75
	for (const widget of node.widgets) {
		widget.last_y += LiteGraph.NODE_SLOT_HEIGHT;
	}

76
77
	// Restore original size but grow if needed
	node.setSize([Math.max(sz[0], node.size[0]), Math.max(sz[1], node.size[1])]);
78
79
80
81
}

function convertToWidget(node, widget) {
	showWidget(widget);
82
	const sz = node.size;
83
	node.removeInput(node.inputs.findIndex((i) => i.widget?.name === widget.name));
84

85
86
87
88
	for (const widget of node.widgets) {
		widget.last_y -= LiteGraph.NODE_SLOT_HEIGHT;
	}

89
90
	// Restore original size but grow if needed
	node.setSize([Math.max(sz[0], node.size[0]), Math.max(sz[1], node.size[1])]);
91
92
}

93
function getWidgetType(config, comboType) {
94
95
96
97
98
	// Special handling for COMBO so we restrict links based on the entries
	let type = config[0];
	let linkType = type;
	if (type instanceof Array) {
		type = "COMBO";
99
		linkType = comboType;
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
	}
	return { type, linkType };
}

app.registerExtension({
	name: "Comfy.WidgetInputs",
	async beforeRegisterNodeDef(nodeType, nodeData, app) {
		// Add menu options to conver to/from widgets
		const origGetExtraMenuOptions = nodeType.prototype.getExtraMenuOptions;
		nodeType.prototype.getExtraMenuOptions = function (_, options) {
			const r = origGetExtraMenuOptions ? origGetExtraMenuOptions.apply(this, arguments) : undefined;

			if (this.widgets) {
				let toInput = [];
				let toWidget = [];
				for (const w of this.widgets) {
116
117
118
					if (w.options?.forceInput) {
						continue;
					}
119
120
121
122
123
124
					if (w.type === CONVERTED_TYPE) {
						toWidget.push({
							content: `Convert ${w.name} to widget`,
							callback: () => convertToWidget(this, w),
						});
					} else {
125
						const config = getConfig.call(this, w.name) ?? [w.type, w.options || {}];
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
						if (isConvertableWidget(w, config)) {
							toInput.push({
								content: `Convert ${w.name} to input`,
								callback: () => convertToInput(this, w, config),
							});
						}
					}
				}
				if (toInput.length) {
					options.push(...toInput, null);
				}

				if (toWidget.length) {
					options.push(...toWidget, null);
				}
			}

			return r;
		};

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
		nodeType.prototype.onGraphConfigured = function () {
			if (!this.inputs) return;

			for (const input of this.inputs) {
				if (input.widget) {
					// Cleanup old widget config
					delete input.widget.config;

					if (!input.widget.getConfig) {
						input.widget.getConfig = getConfig.bind(this, input.widget.name);
					}

					const w = this.widgets.find((w) => w.name === input.widget.name);
					if (w) {
						hideWidget(this, w);
					} else {
						convertToWidget(this, input);
					}
				}
			}
		};

		const origOnNodeCreated = nodeType.prototype.onNodeCreated;
169
170
		nodeType.prototype.onNodeCreated = function () {
			const r = origOnNodeCreated ? origOnNodeCreated.apply(this) : undefined;
171
172
173

			// When node is created, convert any force/default inputs
			if (!app.configuringGraph && this.widgets) {
174
				for (const w of this.widgets) {
Chris's avatar
Chris committed
175
					if (w?.options?.forceInput || w?.options?.defaultInput) {
176
						const config = getConfig.call(this, w.name) ?? [w.type, w.options || {}];
177
178
179
180
						convertToInput(this, w, config);
					}
				}
			}
181

182
			return r;
183
		};
184

185
186
187
		const origOnConfigure = nodeType.prototype.onConfigure;
		nodeType.prototype.onConfigure = function () {
			const r = origOnConfigure ? origOnConfigure.apply(this, arguments) : undefined;
188
189
			if (!app.configuringGraph && this.inputs) {
				// On copy + paste of nodes, ensure that widget configs are set up
190
				for (const input of this.inputs) {
191
192
					if (input.widget && !input.widget.getConfig) {
						input.widget.getConfig = getConfig.bind(this, input.widget.name);
193
194
195
196
197
198
199
					}
				}
			}

			return r;
		};

200
201
202
203
204
205
206
207
208
		function isNodeAtPos(pos) {
			for (const n of app.graph._nodes) {
				if (n.pos[0] === pos[0] && n.pos[1] === pos[1]) {
					return true;
				}
			}
			return false;
		}

209
210
		// Double click a widget input to automatically attach a primitive
		const origOnInputDblClick = nodeType.prototype.onInputDblClick;
211
		const ignoreDblClick = Symbol();
212
213
214
		nodeType.prototype.onInputDblClick = function (slot) {
			const r = origOnInputDblClick ? origOnInputDblClick.apply(this, arguments) : undefined;

215
			const input = this.inputs[slot];
216
217
			if (!input.widget || !input[ignoreDblClick]) {
				// Not a widget input or already handled input
218
				if (!(input.type in ComfyWidgets) && !(input.widget.getConfig?.()?.[0] instanceof Array)) {
219
220
					return r; //also Not a ComfyWidgets input or combo (do nothing)
				}
221
			}
222

223
224
225
			// Create a primitive node
			const node = LiteGraph.createNode("PrimitiveNode");
			app.graph.add(node);
226

227
228
229
230
			// Calculate a position that wont directly overlap another node
			const pos = [this.pos[0] - node.size[0] - 30, this.pos[1]];
			while (isNodeAtPos(pos)) {
				pos[1] += LiteGraph.NODE_TITLE_HEIGHT;
231
232
			}

233
234
235
236
237
238
239
240
241
242
			node.pos = pos;
			node.connect(0, this, slot);
			node.title = input.name;

			// Prevent adding duplicates due to triple clicking
			input[ignoreDblClick] = true;
			setTimeout(() => {
				delete input[ignoreDblClick];
			}, 300);

243
244
245
246
247
248
249
250
251
252
253
254
255
256
			return r;
		};
	},
	registerCustomNodes() {
		class PrimitiveNode {
			constructor() {
				this.addOutput("connect to widget input", "*");
				this.serialize_widgets = true;
				this.isVirtualNode = true;
			}

			applyToGraph() {
				if (!this.outputs[0].links?.length) return;

257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
				function get_links(node) {
					let links = [];
					for (const l of node.outputs[0].links) {
						const linkInfo = app.graph.links[l];
						const n = node.graph.getNodeById(linkInfo.target_id);
						if (n.type == "Reroute") {
							links = links.concat(get_links(n));
						} else {
							links.push(l);
						}
					}
					return links;
				}

				let links = get_links(this);
272
				// For each output link copy our value over the original widget value
273
				for (const l of links) {
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
					const linkInfo = app.graph.links[l];
					const node = this.graph.getNodeById(linkInfo.target_id);
					const input = node.inputs[linkInfo.target_slot];
					const widgetName = input.widget.name;
					if (widgetName) {
						const widget = node.widgets.find((w) => w.name === widgetName);
						if (widget) {
							widget.value = this.widgets[0].value;
							if (widget.callback) {
								widget.callback(widget.value, app.canvas, node, app.canvas.graph_mouse, {});
							}
						}
					}
				}
			}

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
			refreshComboInNode() {
				const widget = this.widgets?.[0];
				if (widget?.type === "combo") {
					widget.options.values = this.outputs[0].widget.getConfig()[0];

					if (!widget.options.values.includes(widget.value)) {
						widget.value = widget.options.values[0];
						widget.callback(widget.value);
					}
				}
			}

			onAfterGraphConfigured() {
				if (this.outputs[0].links?.length && !this.widgets?.length) {
					this.#onFirstConnection();

					// Populate widget values from config data
307
308
309
310
311
312
313
					if (this.widgets) {
						for (let i = 0; i < this.widgets_values.length; i++) {
							const w = this.widgets[i];
							if (w) {
								w.value = this.widgets_values[i];
							}
						}
314
					}
315
316
317

					// Merge values if required
					this.#mergeWidgetConfig();
318
319
320
				}
			}

321
			onConnectionsChange(_, index, connected) {
322
323
324
325
326
				if (app.configuringGraph) {
					// Dont run while the graph is still setting up
					return;
				}

327
				const links = this.outputs[0].links;
328
				if (connected) {
329
					if (links?.length && !this.widgets?.length) {
330
						this.#onFirstConnection();
331
					}
332
333
334
335
336
337
338
				} else {
					// We may have removed a link that caused the constraints to change
					this.#mergeWidgetConfig();

					if (!links?.length) {
						this.#onLastDisconnect();
					}
339
340
341
342
343
344
345
				}
			}

			onConnectOutput(slot, type, input, target_node, target_slot) {
				// Fires before the link is made allowing us to reject it if it isn't valid

				// No widget, we cant connect
346
347
348
				if (!input.widget) {
					if (!(input.type in ComfyWidgets)) return false;
				}
349
350
351
352
353
354

				if (this.outputs[slot].links?.length) {
					return this.#isValidConnection(input);
				}
			}

355
			#onFirstConnection(recreating) {
356
357
358
359
360
361
362
363
364
365
366
				// First connection can fire before the graph is ready on initial load so random things can be missing
				const linkId = this.outputs[0].links[0];
				const link = this.graph.links[linkId];
				if (!link) return;

				const theirNode = this.graph.getNodeById(link.target_id);
				if (!theirNode || !theirNode.inputs) return;

				const input = theirNode.inputs[link.target_slot];
				if (!input) return;

367
				let widget;
368
369
				if (!input.widget) {
					if (!(input.type in ComfyWidgets)) return;
370
					widget = { name: input.name, getConfig: () => [input.type, {}] }; //fake widget
371
				} else {
372
					widget = input.widget;
373
374
				}

375
				const { type, linkType } = getWidgetType(widget.getConfig(), `${theirNode.comfyClass}|${widget.name}`);
376
377
378
379
380
				// Update our output to restrict to the widget type
				this.outputs[0].type = linkType;
				this.outputs[0].name = type;
				this.outputs[0].widget = widget;

381
				this.#createWidget(widget[CONFIG] ?? widget.getConfig(), theirNode, widget.name, recreating);
382
383
			}

384
			#createWidget(inputData, node, widgetName, recreating) {
385
386
387
388
389
390
391
392
393
394
				let type = inputData[0];

				if (type instanceof Array) {
					type = "COMBO";
				}

				let widget;
				if (type in ComfyWidgets) {
					widget = (ComfyWidgets[type](this, "value", inputData, app) || {}).widget;
				} else {
395
					widget = this.addWidget(type, "value", null, () => {}, {});
396
397
398
399
400
401
402
403
404
				}

				if (node?.widgets && widget) {
					const theirWidget = node.widgets.find((w) => w.name === widgetName);
					if (theirWidget) {
						widget.value = theirWidget.value;
					}
				}

405
				if (widget.type === "number" || widget.type === "combo") {
406
					addValueControlWidget(this, widget, "fixed");
407
408
				}

pythongosssss's avatar
pythongosssss committed
409
410
411
412
413
414
415
416
417
418
				// When our value changes, update other widgets to reflect our changes
				// e.g. so LoadImage shows correct image
				const callback = widget.callback;
				const self = this;
				widget.callback = function () {
					const r = callback ? callback.apply(this, arguments) : undefined;
					self.applyToGraph();
					return r;
				};

419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
				if (!recreating) {
					// Grow our node if required
					const sz = this.computeSize();
					if (this.size[0] < sz[0]) {
						this.size[0] = sz[0];
					}
					if (this.size[1] < sz[1]) {
						this.size[1] = sz[1];
					}

					requestAnimationFrame(() => {
						if (this.onResize) {
							this.onResize(this.size);
						}
					});
434
				}
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
			}

			#recreateWidget() {
				const values = this.widgets.map((w) => w.value);
				this.#removeWidgets();
				this.#onFirstConnection(true);
				for (let i = 0; i < this.widgets?.length; i++) this.widgets[i].value = values[i];
			}

			#mergeWidgetConfig() {
				// Merge widget configs if the node has multiple outputs
				const output = this.outputs[0];
				const links = output.links;

				const hasConfig = !!output.widget[CONFIG];
				if (hasConfig) {
					delete output.widget[CONFIG];
452
453
				}

454
455
456
457
				if (links?.length < 2 && hasConfig) {
					// Copy the widget options from the source
					if (links.length) {
						this.#recreateWidget();
458
					}
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476

					return;
				}

				const config1 = output.widget.getConfig();
				const isNumber = config1[0] === "INT" || config1[0] === "FLOAT";
				if (!isNumber) return;

				for (const linkId of links) {
					const link = app.graph.links[linkId];
					if (!link) continue; // Can be null when removing a node

					const theirNode = app.graph.getNodeById(link.target_id);
					const theirInput = theirNode.inputs[link.target_slot];

					// Call is valid connection so it can merge the configs when validating
					this.#isValidConnection(theirInput, hasConfig);
				}
477
478
			}

479
			#isValidConnection(input, forceUpdate) {
480
				// Only allow connections where the configs match
481
482
				const output = this.outputs[0];
				const config1 = output.widget[CONFIG] ?? output.widget.getConfig();
483
				const config2 = input.widget.getConfig();
484

485
486
487
488
489
				if (config1[0] instanceof Array) {
					// These checks shouldnt actually be necessary as the types should match
					// but double checking doesn't hurt

					// New input isnt a combo
490
491
492
493
					if (!(config2[0] instanceof Array)) {
						console.log(`connection rejected: tried to connect combo to ${config2[0]}`);
						return false;
					}
494
					// New imput combo has a different size
495
496
497
498
					if (config1[0].length !== config2[0].length) {
						console.log(`connection rejected: combo lists dont match`);
						return false;
					}
499
					// New input combo has different elements
500
501
502
503
					if (config1[0].find((v, i) => config2[0][i] !== v)) {
						console.log(`connection rejected: combo lists dont match`);
						return false;
					}
504
				} else if (config1[0] !== config2[0]) {
505
506
					// Types dont match
					console.log(`connection rejected: types dont match`, config1[0], config2[0]);
507
508
					return false;
				}
509

510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
				const keys = new Set([...Object.keys(config1[1] ?? {}), ...Object.keys(config2[1] ?? {})]);

				let customConfig;
				const getCustomConfig = () => {
					if (!customConfig) {
						if (typeof structuredClone === "undefined") {
							customConfig = JSON.parse(JSON.stringify(config1[1] ?? {}));
						} else {
							customConfig = structuredClone(config1[1] ?? {});
						}
					}
					return customConfig;
				};

				const isNumber = config1[0] === "INT" || config1[0] === "FLOAT";
				for (const k of keys.values()) {
					if (k !== "default" && k !== "forceInput" && k !== "defaultInput") {
						let v1 = config1[1][k];
						let v2 = config2[1][k];

						if (v1 === v2 || (!v1 && !v2)) continue;

						if (isNumber) {
							if (k === "min") {
								const theirMax = config2[1]["max"];
								if (theirMax != null && v1 > theirMax) {
									console.log("Invalid connection, min > max");
									return false;
								}
								getCustomConfig()[k] = v1 == null ? v2 : v2 == null ? v1 : Math.max(v1, v2);
								continue;
							} else if (k === "max") {
								const theirMin = config2[1]["min"];
								if (theirMin != null && v1 < theirMin) {
									console.log("Invalid connection, max < min");
									return false;
								}
								getCustomConfig()[k] = v1 == null ? v2 : v2 == null ? v1 : Math.min(v1, v2);
								continue;
							} else if (k === "step") {
								let step;
								if (v1 == null) {
									step = v2;
								} else if (v2 == null) {
									step = v1;
								} else {
									if (v1 < v2) {
										const a = v2;
										v2 = v1;
										v1 = a;
									}
									if (v1 % v2) {
										console.log("Steps not divisible", "current:", v1, "new:", v2);
										return false;
									}

									step = v1;
								}

								getCustomConfig()[k] = step;
								continue;
							}
572
						}
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593

						console.log(`connection rejected: config ${k} values dont match`, v1, v2);
						return false;
					}
				}

				if (customConfig || forceUpdate) {
					if (customConfig) {
						output.widget[CONFIG] = [config1[0], customConfig];
					}

					this.#recreateWidget();

					const widget = this.widgets[0];
					// When deleting a node this can be null
					if (widget) {
						const min = widget.options.min;
						const max = widget.options.max;
						if (min != null && widget.value < min) widget.value = min;
						if (max != null && widget.value > max) widget.value = max;
						widget.callback(widget.value);
594
595
596
597
598
599
					}
				}

				return true;
			}

600
			#removeWidgets() {
601
602
603
604
605
606
607
608
609
610
				if (this.widgets) {
					// Allow widgets to cleanup
					for (const w of this.widgets) {
						if (w.onRemove) {
							w.onRemove();
						}
					}
					this.widgets.length = 0;
				}
			}
611
612
613
614
615
616
617
618
619
620

			#onLastDisconnect() {
				// We cant remove + re-add the output here as if you drag a link over the same link
				// it removes, then re-adds, causing it to break
				this.outputs[0].type = "*";
				this.outputs[0].name = "connect to widget input";
				delete this.outputs[0].widget;

				this.#removeWidgets();
			}
621
622
623
624
625
626
627
628
629
630
631
		}

		LiteGraph.registerNodeType(
			"PrimitiveNode",
			Object.assign(PrimitiveNode, {
				title: "Primitive",
			})
		);
		PrimitiveNode.category = "utils";
	},
});