@pexip/media-processor 20.3.4 → 20.3.5

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 (206) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/api-docs/README.mdx +411 -0
  3. package/api-docs/enumerations/AbortReason.mdx +5 -0
  4. package/api-docs/functions/avg.mdx +15 -0
  5. package/api-docs/functions/calculateDistance.mdx +18 -0
  6. package/api-docs/functions/closedCurve.mdx +27 -0
  7. package/api-docs/functions/copyByteBufferToFloatBuffer.mdx +16 -0
  8. package/api-docs/functions/createAnalyzerGraphNode.mdx +19 -0
  9. package/api-docs/functions/createAnalyzerSubscribableGraphNode.mdx +15 -0
  10. package/api-docs/functions/createAsyncCallbackLoop.mdx +35 -0
  11. package/api-docs/functions/createAudioContext.mdx +22 -0
  12. package/api-docs/functions/createAudioDestinationGraphNode.mdx +9 -0
  13. package/api-docs/functions/createAudioGraph.mdx +28 -0
  14. package/api-docs/functions/createAudioGraphProxy.mdx +14 -0
  15. package/api-docs/functions/createAudioSignalDetector.mdx +51 -0
  16. package/api-docs/functions/createAudioStats.mdx +19 -0
  17. package/api-docs/functions/createBenchmark.mdx +14 -0
  18. package/api-docs/functions/createCanvas.mdx +16 -0
  19. package/api-docs/functions/createCanvasTransform.mdx +14 -0
  20. package/api-docs/functions/createChannelMergerGraphNode.mdx +19 -0
  21. package/api-docs/functions/createChannelSplitterGraphNode.mdx +19 -0
  22. package/api-docs/functions/createDelayGraphNode.mdx +19 -0
  23. package/api-docs/functions/createDenoiseWorkletGraphNode.mdx +16 -0
  24. package/api-docs/functions/createFrameCallbackRequest.mdx +29 -0
  25. package/api-docs/functions/createGainGraphNode.mdx +15 -0
  26. package/api-docs/functions/createMediaElementSourceGraphNode.mdx +15 -0
  27. package/api-docs/functions/createSegmenter.mdx +14 -0
  28. package/api-docs/functions/createStreamDestinationGraphNode.mdx +15 -0
  29. package/api-docs/functions/createStreamSourceGraphNode.mdx +16 -0
  30. package/api-docs/functions/createVADetector.mdx +54 -0
  31. package/api-docs/functions/createVideoProcessor.mdx +14 -0
  32. package/api-docs/functions/createVideoTrackProcessor.mdx +9 -0
  33. package/api-docs/functions/createVideoTrackProcessorWithFallback.mdx +15 -0
  34. package/api-docs/functions/createVoiceDetectorFromProbability.mdx +15 -0
  35. package/api-docs/functions/createVoiceDetectorFromTimeData.mdx +19 -0
  36. package/api-docs/functions/curve.mdx +15 -0
  37. package/api-docs/functions/fromByteToFloat.mdx +27 -0
  38. package/api-docs/functions/fromFloatToByte.mdx +27 -0
  39. package/api-docs/functions/getAudioStats.mdx +19 -0
  40. package/api-docs/functions/getBezierCurveControlPoints.mdx +26 -0
  41. package/api-docs/functions/isAnalyzerNodeInit.mdx +13 -0
  42. package/api-docs/functions/isAudioNode.mdx +13 -0
  43. package/api-docs/functions/isAudioNodeInit.mdx +13 -0
  44. package/api-docs/functions/isAudioParam.mdx +13 -0
  45. package/api-docs/functions/isClipping.mdx +18 -0
  46. package/api-docs/functions/isEqualSize.mdx +22 -0
  47. package/api-docs/functions/isLowVolume.mdx +19 -0
  48. package/api-docs/functions/isMono.mdx +22 -0
  49. package/api-docs/functions/isRenderEffects.mdx +13 -0
  50. package/api-docs/functions/isSilent.mdx +22 -0
  51. package/api-docs/functions/isVoiceActivity.mdx +29 -0
  52. package/api-docs/functions/line.mdx +15 -0
  53. package/api-docs/functions/loadScript.mdx +14 -0
  54. package/api-docs/functions/loadWasms.mdx +13 -0
  55. package/api-docs/functions/pow.mdx +29 -0
  56. package/api-docs/functions/processAverageVolume.mdx +15 -0
  57. package/api-docs/functions/resumeAudioOnInterruption.mdx +23 -0
  58. package/api-docs/functions/resumeAudioOnUnmute.mdx +27 -0
  59. package/api-docs/functions/rms.mdx +15 -0
  60. package/api-docs/functions/round.mdx +23 -0
  61. package/api-docs/functions/subscribeTimeoutAnalyzerNode.mdx +22 -0
  62. package/api-docs/functions/subscribeWorkletNode.mdx +28 -0
  63. package/api-docs/functions/sum.mdx +15 -0
  64. package/api-docs/functions/toDecibel.mdx +18 -0
  65. package/api-docs/interfaces/Analyzer.mdx +368 -0
  66. package/api-docs/interfaces/AnalyzerSubscribableOptions.mdx +11 -0
  67. package/api-docs/interfaces/AsyncAssets.mdx +7 -0
  68. package/api-docs/interfaces/AudioGraph.mdx +92 -0
  69. package/api-docs/interfaces/AudioGraphOptions.mdx +6 -0
  70. package/api-docs/interfaces/AudioNodeInit.mdx +127 -0
  71. package/api-docs/interfaces/AudioNodeProps.mdx +15 -0
  72. package/api-docs/interfaces/AudioStats.mdx +16 -0
  73. package/api-docs/interfaces/BackgroundImage.mdx +6 -0
  74. package/api-docs/interfaces/Benchmark.mdx +35 -0
  75. package/api-docs/interfaces/Clock.mdx +11 -0
  76. package/api-docs/interfaces/Denoise.mdx +50 -0
  77. package/api-docs/interfaces/Detector.mdx +81 -0
  78. package/api-docs/interfaces/Frame.mdx +11 -0
  79. package/api-docs/interfaces/Gain.mdx +227 -0
  80. package/api-docs/interfaces/ImageRecord.mdx +6 -0
  81. package/api-docs/interfaces/ImageSegmenterOptions.mdx +8 -0
  82. package/api-docs/interfaces/MPMask.mdx +145 -0
  83. package/api-docs/interfaces/Point.mdx +10 -0
  84. package/api-docs/interfaces/Process.mdx +46 -0
  85. package/api-docs/interfaces/ProcessEventClose.mdx +7 -0
  86. package/api-docs/interfaces/ProcessEventDebug.mdx +14 -0
  87. package/api-docs/interfaces/ProcessEventDestroy.mdx +7 -0
  88. package/api-docs/interfaces/ProcessEventOpen.mdx +14 -0
  89. package/api-docs/interfaces/ProcessEventProcess.mdx +14 -0
  90. package/api-docs/interfaces/ProcessEventUpdate.mdx +14 -0
  91. package/api-docs/interfaces/ProcessWorkerDebugMessage.mdx +6 -0
  92. package/api-docs/interfaces/ProcessWorkerEvent.mdx +12 -0
  93. package/api-docs/interfaces/ProcessWorkerEventDebug.mdx +12 -0
  94. package/api-docs/interfaces/ProcessWorkerEventOpened.mdx +5 -0
  95. package/api-docs/interfaces/ProcessWorkerEventProcessed.mdx +12 -0
  96. package/api-docs/interfaces/ProcessWorkerEventUpdated.mdx +5 -0
  97. package/api-docs/interfaces/ProcessorEvent.mdx +7 -0
  98. package/api-docs/interfaces/ProcessorOptions.mdx +16 -0
  99. package/api-docs/interfaces/ProcessorProcessOptions.mdx +6 -0
  100. package/api-docs/interfaces/Rect.mdx +8 -0
  101. package/api-docs/interfaces/RenderEventHandlers.mdx +7 -0
  102. package/api-docs/interfaces/Renderer.mdx +64 -0
  103. package/api-docs/interfaces/RendererOptions.mdx +15 -0
  104. package/api-docs/interfaces/Runner.mdx +41 -0
  105. package/api-docs/interfaces/Segmentation.mdx +5 -0
  106. package/api-docs/interfaces/SegmentationModelAsset.mdx +8 -0
  107. package/api-docs/interfaces/SegmentationParams.mdx +18 -0
  108. package/api-docs/interfaces/SegmentationSmoothingConfig.mdx +5 -0
  109. package/api-docs/interfaces/Segmenter.mdx +121 -0
  110. package/api-docs/interfaces/SegmenterOptions.mdx +13 -0
  111. package/api-docs/interfaces/Size.mdx +10 -0
  112. package/api-docs/interfaces/StatsOptions.mdx +10 -0
  113. package/api-docs/interfaces/SubscribableOptions.mdx +9 -0
  114. package/api-docs/interfaces/ThrottleOptions.mdx +8 -0
  115. package/api-docs/interfaces/Transform.mdx +62 -0
  116. package/api-docs/interfaces/VideoFrameLike.mdx +8 -0
  117. package/api-docs/interfaces/VideoProcessor.mdx +38 -0
  118. package/api-docs/interfaces/WorkletMessagePortOptions.mdx +16 -0
  119. package/api-docs/interfaces/WorkletModule.mdx +6 -0
  120. package/api-docs/type-aliases/AnalyzerNodeInit.mdx +3 -0
  121. package/api-docs/type-aliases/AsyncCallback.mdx +7 -0
  122. package/api-docs/type-aliases/AudioBufferBytes.mdx +5 -0
  123. package/api-docs/type-aliases/AudioBufferFloats.mdx +6 -0
  124. package/api-docs/type-aliases/AudioDestinationNodeInit.mdx +3 -0
  125. package/api-docs/type-aliases/AudioNodeConnectParam.mdx +3 -0
  126. package/api-docs/type-aliases/AudioNodeInitConnectParam.mdx +3 -0
  127. package/api-docs/type-aliases/AudioNodeInitConnection.mdx +3 -0
  128. package/api-docs/type-aliases/AudioNodeInitConnections.mdx +3 -0
  129. package/api-docs/type-aliases/AudioNodeParam.mdx +3 -0
  130. package/api-docs/type-aliases/AudioSamples.mdx +17 -0
  131. package/api-docs/type-aliases/BaseAudioNode.mdx +3 -0
  132. package/api-docs/type-aliases/Callback.mdx +20 -0
  133. package/api-docs/type-aliases/Canvas.mdx +3 -0
  134. package/api-docs/type-aliases/CanvasContext.mdx +3 -0
  135. package/api-docs/type-aliases/ChannelSplitterNodeInit.mdx +3 -0
  136. package/api-docs/type-aliases/Color.mdx +12 -0
  137. package/api-docs/type-aliases/ConnectInitParamBaseType.mdx +3 -0
  138. package/api-docs/type-aliases/ConnectInitParamType.mdx +3 -0
  139. package/api-docs/type-aliases/ConnectParamBase.mdx +11 -0
  140. package/api-docs/type-aliases/ConnectParamBaseType.mdx +3 -0
  141. package/api-docs/type-aliases/ConnectParamType.mdx +3 -0
  142. package/api-docs/type-aliases/DelayNodeInit.mdx +3 -0
  143. package/api-docs/type-aliases/Delegate.mdx +3 -0
  144. package/api-docs/type-aliases/DenoiseWorkletNodeInit.mdx +3 -0
  145. package/api-docs/type-aliases/ExtractMessageEventType.mdx +9 -0
  146. package/api-docs/type-aliases/GainNodeInit.mdx +3 -0
  147. package/api-docs/type-aliases/ImageMapIterable.mdx +3 -0
  148. package/api-docs/type-aliases/ImageType.mdx +6 -0
  149. package/api-docs/type-aliases/IncludeMessageEventDataType.mdx +10 -0
  150. package/api-docs/type-aliases/InputFrame.mdx +3 -0
  151. package/api-docs/type-aliases/IsVoice.mdx +19 -0
  152. package/api-docs/type-aliases/MediaElementAudioSourceNodeInit.mdx +3 -0
  153. package/api-docs/type-aliases/MediaStreamAudioDestinationNodeInit.mdx +3 -0
  154. package/api-docs/type-aliases/MediaStreamAudioSourceNodeInit.mdx +3 -0
  155. package/api-docs/type-aliases/Node.mdx +3 -0
  156. package/api-docs/type-aliases/NodeConnectionAction.mdx +3 -0
  157. package/api-docs/type-aliases/Nodes.mdx +3 -0
  158. package/api-docs/type-aliases/ProcessEvents.mdx +17 -0
  159. package/api-docs/type-aliases/ProcessInputType.mdx +3 -0
  160. package/api-docs/type-aliases/ProcessStatus.mdx +3 -0
  161. package/api-docs/type-aliases/ProcessVideoTrack.mdx +15 -0
  162. package/api-docs/type-aliases/ProcessWorkerEvents.mdx +18 -0
  163. package/api-docs/type-aliases/ProcessorEvents.mdx +3 -0
  164. package/api-docs/type-aliases/ProcessorWorkerEvents.mdx +3 -0
  165. package/api-docs/type-aliases/RenderBackend.mdx +3 -0
  166. package/api-docs/type-aliases/RenderEffects.mdx +3 -0
  167. package/api-docs/type-aliases/RenderingEvents.mdx +3 -0
  168. package/api-docs/type-aliases/RunnerCreator.mdx +21 -0
  169. package/api-docs/type-aliases/SegmentationModel.mdx +3 -0
  170. package/api-docs/type-aliases/SegmentationTransform.mdx +3 -0
  171. package/api-docs/type-aliases/TupleOf.mdx +12 -0
  172. package/api-docs/type-aliases/UniversalAudioContextState.mdx +6 -0
  173. package/api-docs/type-aliases/Unsubscribe.mdx +9 -0
  174. package/api-docs/type-aliases/WasmPaths.mdx +3 -0
  175. package/api-docs/variables/BACKGROUND_BLUR_AMOUNT.mdx +3 -0
  176. package/api-docs/variables/CLIP_COUNT_THRESHOLD.mdx +6 -0
  177. package/api-docs/variables/CLIP_THRESHOLD.mdx +5 -0
  178. package/api-docs/variables/EDGE_BLUR_AMOUNT.mdx +3 -0
  179. package/api-docs/variables/FOREGROUND_THRESHOLD.mdx +3 -0
  180. package/api-docs/variables/FRAME_RATE.mdx +3 -0
  181. package/api-docs/variables/LOW_VOLUME_THRESHOLD.mdx +5 -0
  182. package/api-docs/variables/MASK_COMBINE_RATIO.mdx +3 -0
  183. package/api-docs/variables/MONO_THRESHOLD.mdx +6 -0
  184. package/api-docs/variables/PLAY_VIDEO_TIMEOUT.mdx +3 -0
  185. package/api-docs/variables/PROCESSING_HEIGHT.mdx +3 -0
  186. package/api-docs/variables/PROCESSING_WIDTH.mdx +3 -0
  187. package/api-docs/variables/PROCESS_STATUS.mdx +22 -0
  188. package/api-docs/variables/RENDERING_EVENTS.mdx +14 -0
  189. package/api-docs/variables/RENDER_BACKEND.mdx +10 -0
  190. package/api-docs/variables/RENDER_EFFECT.mdx +11 -0
  191. package/api-docs/variables/SEGMENTATION_MODELS.mdx +10 -0
  192. package/api-docs/variables/SILENT_THRESHOLD.mdx +6 -0
  193. package/api-docs/variables/VOICE_PROBABILITY_THRESHOLD.mdx +5 -0
  194. package/api-docs/variables/calculateMaxBlurPass.mdx +13 -0
  195. package/api-docs/variables/clamping.mdx +26 -0
  196. package/api-docs/variables/createLazyProps.mdx +19 -0
  197. package/api-docs/variables/createObjectUpdater.mdx +31 -0
  198. package/api-docs/variables/createRemoteImageBitmap.mdx +21 -0
  199. package/api-docs/variables/getErrorMessage.mdx +13 -0
  200. package/api-docs/variables/handleWebGLContextLoss.mdx +21 -0
  201. package/api-docs/variables/isRenderingEvents.mdx +13 -0
  202. package/api-docs/variables/isSegmentationModel.mdx +13 -0
  203. package/api-docs/variables/resize.mdx +30 -0
  204. package/api-docs/variables/toRenderingEvents.mdx +13 -0
  205. package/api-docs/variables/urls.mdx +10 -0
  206. package/package.json +14 -9
@@ -0,0 +1,13 @@
1
+ ```ts
2
+ const isRenderingEvents: (t) => t is RenderingEvents;
3
+ ```
4
+
5
+ ## Parameters
6
+
7
+ | Parameter | Type |
8
+ | ------ | ------ |
9
+ | `t` | `unknown` |
10
+
11
+ ## Returns
12
+
13
+ `t is RenderingEvents`
@@ -0,0 +1,13 @@
1
+ ```ts
2
+ const isSegmentationModel: (t) => t is SegmentationModel;
3
+ ```
4
+
5
+ ## Parameters
6
+
7
+ | Parameter | Type |
8
+ | ------ | ------ |
9
+ | `t` | `unknown` |
10
+
11
+ ## Returns
12
+
13
+ `t is SegmentationModel`
@@ -0,0 +1,30 @@
1
+ ```ts
2
+ const resize: (fromWidth, fromHeight, toWidth, toHeight) => object;
3
+ ```
4
+
5
+ Calculate the coordinates and size of the source and destination to fit the
6
+ target aspect ratio.
7
+
8
+ ## Parameters
9
+
10
+ | Parameter | Type | Description |
11
+ | ------ | ------ | ------ |
12
+ | `fromWidth` | `number` | The width of the source |
13
+ | `fromHeight` | `number` | The height of the source |
14
+ | `toWidth` | `number` | The width of the destination |
15
+ | `toHeight` | `number` | The height of the destination |
16
+
17
+ ## Returns
18
+
19
+ `object`
20
+
21
+ | Name | Type |
22
+ | ------ | ------ |
23
+ | `sx` | `number` |
24
+ | `sy` | `number` |
25
+ | `sw` | `number` |
26
+ | `sh` | `number` |
27
+ | `dx` | `number` |
28
+ | `dy` | `number` |
29
+ | `dw` | `number` |
30
+ | `dh` | `number` |
@@ -0,0 +1,13 @@
1
+ ```ts
2
+ const toRenderingEvents: (t) => RenderingEvents;
3
+ ```
4
+
5
+ ## Parameters
6
+
7
+ | Parameter | Type |
8
+ | ------ | ------ |
9
+ | `t` | `unknown` |
10
+
11
+ ## Returns
12
+
13
+ [`RenderingEvents`](../type-aliases/RenderingEvents.mdx)
@@ -0,0 +1,10 @@
1
+ ```ts
2
+ const urls: object;
3
+ ```
4
+
5
+ ## Type Declaration
6
+
7
+ | Name | Type |
8
+ | ------ | ------ |
9
+ | <a id="denoise"></a> `denoise()` | () => `URL` |
10
+ | <a id="mediaworker"></a> `mediaWorker()` | () => `URL` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pexip/media-processor",
3
- "version": "20.3.4",
3
+ "version": "20.3.5",
4
4
  "description": "Media processor for video and audio",
5
5
  "homepage": "https://gitlab.com/pexip/zoo",
6
6
  "bugs": "https://gitlab.com/pexip/zoo/issues",
@@ -45,23 +45,25 @@
45
45
  },
46
46
  "directories": {
47
47
  "lib": "dist",
48
- "test": "__tests__"
48
+ "test": "__tests__",
49
+ "doc": "api-docs"
49
50
  },
50
51
  "files": [
51
- "dist"
52
+ "dist",
53
+ "api-docs"
52
54
  ],
53
55
  "scripts": {
54
56
  "build": "yarn build:main && yarn build:worklets && yarn build:workers",
55
57
  "build:denoise": "cd denoise && wasm-pack build -t web && printf '%s\n%s\n' \"import {TextDecoder, TextEncoder} from './EncoderDecoder';\" \"$(cat ./pkg/denoise.js)\" >./pkg/denoise.js && prettier --write pkg && cp pkg/denoise* ../../denoise/",
56
- "build:main": "yarn pexip-bundler build --bundler=tsc -c ./src/main",
58
+ "build:main": "yarn pexip-bundler build --bundler=tsc -c ./src/main && yarn docs",
57
59
  "build:workers": "pexip-bundler build --bundler=esbuild -o dist/workers -b src/workers/*.ts",
58
60
  "build:worklets": "pexip-bundler build --bundler=esbuild -o dist/worklets -b src/worklets/*.ts",
59
61
  "build:sourcemap": "yarn build:main:sourcemap && yarn build:worklets:sourcemap && yarn build:workers:sourcemap",
60
- "build:main:sourcemap": "yarn pexip-bundler build --sourcemap --bundler=tsc -c ./src/main",
62
+ "build:main:sourcemap": "yarn pexip-bundler build --sourcemap --bundler=tsc -c ./src/main && yarn docs",
61
63
  "build:workers:sourcemap": "pexip-bundler build --sourcemap --bundler=esbuild -o dist/workers -b src/workers/*.ts",
62
64
  "build:worklets:sourcemap": "pexip-bundler build --sourcemap --bundler=esbuild -o dist/worklets -b src/worklets/*.ts",
63
65
  "check-format": "prettier --ignore-path=../../.prettierignore --check .",
64
- "clean": "rm -fr dist",
66
+ "clean": "rm -fr dist api-docs",
65
67
  "format": "prettier --ignore-path=../../.prettierignore --write .",
66
68
  "lint": "yarn run -T biome lint",
67
69
  "prepack": "yarn clean && yarn build:main && yarn build:worklets && yarn build:workers",
@@ -75,16 +77,17 @@
75
77
  "update-selfie-landscape-model": "curl -OL --output-dir ../media-assets/@mediapipe/models/ --create-dirs https://storage.googleapis.com/mediapipe-models/image_segmenter/selfie_segmenter_landscape/float16/latest/selfie_segmenter_landscape.tflite",
76
78
  "update-selfie-models": "yarn update-selfie-square-model && yarn update-selfie-landscape-model",
77
79
  "update-selfie-square-model": "curl -OL --output-dir ../media-assets/@mediapipe/models/ --create-dirs https://storage.googleapis.com/mediapipe-models/image_segmenter/selfie_segmenter/float16/latest/selfie_segmenter.tflite",
78
- "update-tasks-vision-assets": "unzip -jo ../../.yarn/cache/@mediapipe-tasks-vision-npm-* \"*/wasm/*\" \"*.json\" -d ../media-assets/@mediapipe/tasks-vision/wasm/"
80
+ "update-tasks-vision-assets": "unzip -jo ../../.yarn/cache/@mediapipe-tasks-vision-npm-* \"*/wasm/*\" \"*.json\" -d ../media-assets/@mediapipe/tasks-vision/wasm/",
81
+ "docs": "typedoc"
79
82
  },
80
83
  "dependencies": {
81
84
  "@mediapipe/tasks-vision": "^0.10.20",
82
85
  "@pexip/denoise": "16.4.0",
83
- "@pexip/utils": "17.1.2"
86
+ "@pexip/utils": "17.1.3"
84
87
  },
85
88
  "devDependencies": {
86
89
  "@jest/globals": "^30.2.0",
87
- "@pexip/bundler": "18.1.2",
90
+ "@pexip/bundler": "18.2.0",
88
91
  "@swc/core": "^1.10.12",
89
92
  "@swc/jest": "^0.2.39",
90
93
  "@types/audioworklet": "^0.0.41",
@@ -94,6 +97,8 @@
94
97
  "jest": "^29.5.12",
95
98
  "jest-junit": "^16.0.0",
96
99
  "prettier": "^3.2.5",
100
+ "typedoc": "^0.28.15",
101
+ "typedoc-plugin-markdown": "^4.9.0",
97
102
  "typescript": "~5.7.3"
98
103
  },
99
104
  "publishConfig": {