@kubohiroya/turbowarp-realtime-motion-capture 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/LICENSE +373 -0
  2. package/README.ja.md +89 -0
  3. package/README.md +113 -0
  4. package/THIRD_PARTY_NOTICES.md +31 -0
  5. package/config/feature-flags.ts +28 -0
  6. package/config/qr-config.ts +19 -0
  7. package/dist/extension-manifest.json +664 -0
  8. package/dist/turbowarp-realtime-motion-capture.js +82631 -0
  9. package/docs/architecture.ja.md +256 -0
  10. package/docs/architecture.md +294 -0
  11. package/docs/index.html +83 -0
  12. package/docs/turbowarp-extension-api.ja.md +157 -0
  13. package/docs/turbowarp-extension-api.md +1033 -0
  14. package/package.json +105 -0
  15. package/schemas/camera-calibration-v1.json +209 -0
  16. package/schemas/extension-manifest.schema.json +49 -0
  17. package/schemas/performance-dsl-v1.json +72 -0
  18. package/schemas/pose-frame-2d-v1.json +626 -0
  19. package/schemas/pose-frame-2d-v2.json +723 -0
  20. package/schemas/pose-frame-3d-v1.json +714 -0
  21. package/schemas/session-policy-v1.json +138 -0
  22. package/src/avatar/aframe-port.ts +39 -0
  23. package/src/avatar/controller.ts +541 -0
  24. package/src/avatar/kalidokit-adapter.ts +193 -0
  25. package/src/avatar/types.ts +119 -0
  26. package/src/block-definitions.json +810 -0
  27. package/src/calibration/controller.ts +564 -0
  28. package/src/calibration/opencv-backend.ts +347 -0
  29. package/src/calibration/types.ts +53 -0
  30. package/src/config.ts +13 -0
  31. package/src/extension-manifest.ts +182 -0
  32. package/src/extension.ts +913 -0
  33. package/src/frame-sync/controller.ts +416 -0
  34. package/src/frame-sync/detector.ts +278 -0
  35. package/src/frame-sync/pattern-display.ts +161 -0
  36. package/src/frame-sync/pattern.ts +88 -0
  37. package/src/frame-sync/time-source.ts +36 -0
  38. package/src/frame-sync/types.ts +39 -0
  39. package/src/frame-sync/video-frame-pump.ts +116 -0
  40. package/src/fusion/controller.ts +554 -0
  41. package/src/fusion/fuse.ts +385 -0
  42. package/src/fusion/geometry.ts +474 -0
  43. package/src/fusion/glow-stick.ts +173 -0
  44. package/src/fusion/identity.ts +112 -0
  45. package/src/fusion/jitter-buffer.ts +439 -0
  46. package/src/fusion/types.ts +103 -0
  47. package/src/globals.d.ts +57 -0
  48. package/src/index.ts +8 -0
  49. package/src/markers/canvas-sampler.ts +59 -0
  50. package/src/markers/color.ts +53 -0
  51. package/src/markers/sampler.ts +185 -0
  52. package/src/markers/types.ts +49 -0
  53. package/src/pose/controller.ts +388 -0
  54. package/src/pose/pose-frame.ts +128 -0
  55. package/src/pose/tfjs-movenet.ts +34 -0
  56. package/src/pose/types.ts +116 -0
  57. package/src/protocol/codec.ts +248 -0
  58. package/src/protocol/schemas.ts +283 -0
  59. package/src/qr-courier.ts +289 -0
  60. package/src/qr-svg.ts +39 -0
  61. package/src/sprite-skin.ts +112 -0
  62. package/src/webrtc-capability.ts +38 -0
package/LICENSE ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
package/README.ja.md ADDED
@@ -0,0 +1,89 @@
1
+ # TurboWarp Realtime Motion Capture
2
+
3
+ [English](README.md)
4
+
5
+ **ドキュメント:** [TurboWarp機能拡張API](docs/turbowarp-extension-api.ja.md) ·
6
+ [アーキテクチャ](docs/architecture.ja.md) ·
7
+ [機械可読manifest](dist/extension-manifest.json)
8
+
9
+ multiview pose estimationを使うcamera/fusion application向けの複合TurboWarp機能拡張です。
10
+
11
+ ## できること
12
+
13
+ - WebRTC offer pairing codeを複数のQR spriteとして表示します。
14
+ - WebGPU MoveNet MultiPoseで最大6人を追跡し、PoseFrame2D v1/v2 JSONを返します。
15
+ - このpackageが所有するmultiview-pose JSON contractを検証します。
16
+ - chessboardとOpenCV.jsで共有cameraをcalibrationします。
17
+ - 外部PoseFrame3D v1を宣言的なA-Frame avatar rigへretargetします。
18
+ - camera timingを計測し、同期した2D poseを3Dへ統合して、サイリウムで演者を識別します。
19
+
20
+ ## 要件と安全性
21
+
22
+ - 信頼できるunsandboxed custom extensionを利用できるTurboWarp
23
+ - QR/時刻用WebRTC 0.3.0、video用Camera Source 0.5.0、avatar用A-Frame 0.3.0
24
+ - 姿勢推定用TensorFlow.js WebGPUとcalibration用WebAssembly
25
+
26
+ 全機能は起動時固定・既定OFFです。MoveNetにCPU/WASM/WebGL fallbackはなく、初回model loadは
27
+ network接続を必要とする場合があります。QRにはICE credentialやlocal addressが含まれ得るため、
28
+ 信頼できる環境だけで表示・保管してください。正確な依存関係とcleanupは
29
+ [APIリファレンス](docs/turbowarp-extension-api.ja.md)を参照してください。
30
+
31
+ ## 使い方
32
+
33
+ provider拡張を先に読み込み、その後に`dist/turbowarp-realtime-motion-capture.js`をサンドボックスなしの
34
+ custom extensionとして読み込みます。通常の順序はCamera Source、WebRTC、A-Frame、Realtime Motion Capture
35
+ です。使わないproviderは省略できます。
36
+
37
+ version固定CDN URL:
38
+
39
+ ```text
40
+ https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-realtime-motion-capture@0.2.0/dist/turbowarp-realtime-motion-capture.js
41
+ ```
42
+
43
+ npm packageが公開するのはbrowser向けstandalone bundle、schema、文書です。Composition APIは
44
+ 公開していません。TurboWarp blockとversion管理されたruntime capabilityを通じて連携します。
45
+
46
+ 拡張を読み込む前に、必要な機能を1回だけ設定します。
47
+
48
+ ```js
49
+ globalThis.__TWMP_FEATURE_FLAGS__ = {
50
+ qrCourierPairing: true,
51
+ webgpuMoveNetMultiPose: true,
52
+ frameSyncPatternV1: true,
53
+ poseFusion3D: true,
54
+ glowStickMarkers: true,
55
+ };
56
+ ```
57
+
58
+ 省略した機能は無効です。変更後はeditorと拡張を再読み込みしてください。
59
+
60
+ ```text
61
+ prepare offer QR for peer [camera-1]
62
+ show offer QR part [1] on this sprite
63
+ show next offer QR part on this sprite
64
+ end offer QR display
65
+ ```
66
+
67
+ block上のpart番号は1始まりです。姿勢推定、protocol、calibration、avatarのworkflowは
68
+ [APIリファレンス](docs/turbowarp-extension-api.ja.md)へまとめています。
69
+
70
+ ## 開発
71
+
72
+ ```bash
73
+ corepack enable
74
+ pnpm install --frozen-lockfile
75
+ pnpm run check
76
+ ```
77
+
78
+ 実装・releaseの詳細は[アーキテクチャ](docs/architecture.ja.md)に記載しています。
79
+
80
+ ## ロールバック
81
+
82
+ 対象feature flagを`false`にし、projectを停止して一時resourceを解放してからeditorを再読み込み
83
+ します。8つの機能は独立しています。QRはWebRTCのmanual offer/answer blockへ切り戻せます。
84
+ 詳細は[APIリファレンス](docs/turbowarp-extension-api.ja.md)を参照してください。
85
+
86
+ ## ライセンス
87
+
88
+ [Mozilla Public License 2.0](LICENSE)(SPDX: `MPL-2.0`)。third-party softwareは
89
+ [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)に記載します。
package/README.md ADDED
@@ -0,0 +1,113 @@
1
+ # TurboWarp Realtime Motion Capture
2
+
3
+ [日本語](README.ja.md)
4
+
5
+ **Documentation:** [TurboWarp extension API](docs/turbowarp-extension-api.md) ·
6
+ [Architecture](docs/architecture.md) ·
7
+ [Machine-readable manifest](dist/extension-manifest.json)
8
+
9
+ Composite TurboWarp blocks for camera and fusion applications using multiview pose estimation.
10
+
11
+ ## What it does
12
+
13
+ - Displays WebRTC offer pairing codes as multipart QR sprites.
14
+ - Runs WebGPU MoveNet MultiPose for up to six people and reports PoseFrame2D v1/v2 JSON.
15
+ - Validates the owned multiview-pose JSON contracts.
16
+ - Calibrates shared cameras with a chessboard and OpenCV.js.
17
+ - Retargets external PoseFrame3D v1 data to declarative A-Frame avatar rigs.
18
+ - Measures camera timing, fuses synchronized 2D poses into 3D, and identifies performers by glow sticks.
19
+
20
+ ## Requirements and safety
21
+
22
+ - TurboWarp with trusted unsandboxed custom extensions enabled.
23
+ - WebRTC 0.3.0 for QR/time, Camera Source 0.5.0 for video, and A-Frame 0.3.0 for avatars.
24
+ - TensorFlow.js WebGPU support for pose and WebAssembly support for calibration.
25
+
26
+ All features are startup-fixed and OFF by default. MoveNet has no CPU, WASM, or WebGL fallback and
27
+ its first model load can require network access. Pairing QR codes can expose ICE credentials and
28
+ local addresses; display and retain them only in a trusted environment. See the
29
+ [API reference](docs/turbowarp-extension-api.md) for exact dependencies and cleanup behavior.
30
+
31
+ ## Installation
32
+
33
+ Load provider extensions first, then load `dist/turbowarp-realtime-motion-capture.js` as an unsandboxed custom
34
+ extension. The usual order is Camera Source, WebRTC, A-Frame, then Realtime Motion Capture; providers that are
35
+ not used may be omitted. A version-pinned package URL is:
36
+
37
+ ```text
38
+ https://cdn.jsdelivr.net/npm/@kubohiroya/turbowarp-realtime-motion-capture@0.2.0/dist/turbowarp-realtime-motion-capture.js
39
+ ```
40
+
41
+ The npm package distributes a standalone browser bundle, schemas, and documentation. It does not
42
+ publish a JavaScript or TypeScript Composition API. Integrate through the TurboWarp blocks and the
43
+ versioned runtime capabilities described in the [API reference](docs/turbowarp-extension-api.md).
44
+
45
+ Set the required features once before loading the extension:
46
+
47
+ ```js
48
+ globalThis.__TWMP_FEATURE_FLAGS__ = {
49
+ qrCourierPairing: true,
50
+ webgpuMoveNetMultiPose: true,
51
+ frameSyncPatternV1: true,
52
+ poseFusion3D: true,
53
+ glowStickMarkers: true,
54
+ };
55
+ ```
56
+
57
+ Omitted features remain disabled. Reload the editor and extension after changing the object.
58
+
59
+ ## Quick start
60
+
61
+ ```text
62
+ prepare offer QR for peer [camera-1]
63
+ show offer QR part [1] on this sprite
64
+ repeat until courier photography is complete:
65
+ show next offer QR part on this sprite
66
+ end offer QR display
67
+ ```
68
+
69
+ Part indices exposed to blocks are one-based. Continue with the feature-specific workflows in the
70
+ [API reference](docs/turbowarp-extension-api.md).
71
+
72
+ ## Block reference
73
+
74
+ This section is generated from `src/block-definitions.json`. For lifecycle values, errors, JSON
75
+ contracts, and avatar rig format, see the [complete API reference](docs/turbowarp-extension-api.md).
76
+
77
+ <!-- BEGIN GENERATED BLOCKS -->
78
+
79
+ See the [TurboWarp extension API](docs/turbowarp-extension-api.md) for every block.
80
+
81
+ <!-- END GENERATED BLOCKS -->
82
+
83
+ ## Compatibility
84
+
85
+ | Identifier | Value |
86
+ | ------------------ | ------------------------------------------------ |
87
+ | npm package | `@kubohiroya/turbowarp-realtime-motion-capture` |
88
+ | Extension ID | `kubohiroyarealtimemotioncapture` |
89
+ | WebRTC capability | `kubohiroyaWebRtcCapability`, version 2 |
90
+ | Extension manifest | `dist/extension-manifest.json`, format version 1 |
91
+
92
+ ## Development
93
+
94
+ Use Node.js 22.18 or later and the pnpm version declared in `package.json`.
95
+
96
+ ```bash
97
+ corepack enable
98
+ pnpm install --frozen-lockfile
99
+ pnpm run check
100
+ ```
101
+
102
+ Implementation and release details are documented in [Architecture](docs/architecture.md).
103
+
104
+ ## Rollback
105
+
106
+ Set the affected startup flag to `false`, stop the project to release temporary resources, and reload
107
+ the editor. The eight feature groups are independent; QR pairing can fall back to WebRTC's manual
108
+ offer/answer blocks. Detailed rollback behavior is in the [API reference](docs/turbowarp-extension-api.md).
109
+
110
+ ## License
111
+
112
+ [Mozilla Public License 2.0](LICENSE) (SPDX: `MPL-2.0`). Bundled third-party software is listed in
113
+ [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
@@ -0,0 +1,31 @@
1
+ # Third-party notices
2
+
3
+ The standalone bundle includes `qrcode` 1.5.4 and its runtime dependencies. They are distributed
4
+ under the MIT License. See the corresponding package source and license files for copyright terms:
5
+
6
+ - <https://github.com/soldair/node-qrcode>
7
+ - <https://github.com/almartin82/node-dijkstra>
8
+
9
+ `jsqr` is used only by the integration tests and is distributed under the Apache License 2.0:
10
+
11
+ - <https://github.com/cozmo/jsQR>
12
+
13
+ TensorFlow.js, its WebGPU backend, and TensorFlow Models pose-detection are bundled for MoveNet
14
+ MultiPose inference. They are distributed under the Apache License 2.0:
15
+
16
+ - <https://github.com/tensorflow/tfjs>
17
+ - <https://github.com/tensorflow/tfjs-models/tree/master/pose-detection>
18
+
19
+ TypeBox is bundled for JSON Schema-compatible protocol validation and is distributed under the MIT
20
+ License:
21
+
22
+ - <https://github.com/sinclairzx81/typebox>
23
+
24
+ The calibration bundle includes OpenCV.js 4.12 through `@techstark/opencv-js`. OpenCV is
25
+ distributed under the Apache License 2.0:
26
+
27
+ - <https://github.com/TechStark/opencv-js>
28
+
29
+ Kalidokit 1.1.5 is bundled as the avatar pose solver and is distributed under the MIT License:
30
+
31
+ - <https://github.com/yeemachine/kalidokit>
@@ -0,0 +1,28 @@
1
+ export interface MultiviewPoseFeatureFlags {
2
+ readonly qrCourierPairing: boolean;
3
+ readonly webgpuMoveNetMultiPose: boolean;
4
+ readonly protocolV1Codec: boolean;
5
+ readonly cameraCalibrationV1: boolean;
6
+ readonly avatarRetargetV1: boolean;
7
+ readonly frameSyncPatternV1: boolean;
8
+ readonly poseFusion3D: boolean;
9
+ readonly glowStickMarkers: boolean;
10
+ }
11
+
12
+ interface FeatureFlagGlobal {
13
+ readonly __TWMP_FEATURE_FLAGS__?: Partial<MultiviewPoseFeatureFlags>;
14
+ }
15
+
16
+ const overrides = (globalThis as FeatureFlagGlobal).__TWMP_FEATURE_FLAGS__;
17
+
18
+ /** Startup-fixed flags. Experimental QR and pose paths stay independently opt-in. */
19
+ export const featureFlags: MultiviewPoseFeatureFlags = Object.freeze({
20
+ qrCourierPairing: overrides?.qrCourierPairing === true,
21
+ webgpuMoveNetMultiPose: overrides?.webgpuMoveNetMultiPose === true,
22
+ protocolV1Codec: overrides?.protocolV1Codec === true,
23
+ cameraCalibrationV1: overrides?.cameraCalibrationV1 === true,
24
+ avatarRetargetV1: overrides?.avatarRetargetV1 === true,
25
+ frameSyncPatternV1: overrides?.frameSyncPatternV1 === true,
26
+ poseFusion3D: overrides?.poseFusion3D === true,
27
+ glowStickMarkers: overrides?.glowStickMarkers === true,
28
+ });
@@ -0,0 +1,19 @@
1
+ import type { QrErrorCorrectionLevel } from "../src/qr-courier.js";
2
+
3
+ interface QrConfigGlobal {
4
+ readonly __TWMP_QR_CONFIG__?: {
5
+ readonly errorCorrectionLevel?: QrErrorCorrectionLevel;
6
+ };
7
+ }
8
+
9
+ const configuredLevel = (globalThis as QrConfigGlobal).__TWMP_QR_CONFIG__
10
+ ?.errorCorrectionLevel;
11
+
12
+ /** Startup-fixed QR settings. M is the initial software-validated default. */
13
+ export const qrConfig = Object.freeze({
14
+ errorCorrectionLevel: isLevel(configuredLevel) ? configuredLevel : "M",
15
+ });
16
+
17
+ function isLevel(value: unknown): value is QrErrorCorrectionLevel {
18
+ return value === "L" || value === "M" || value === "Q" || value === "H";
19
+ }