@fugood/bricks-project 2.22.0-beta.9 → 2.22.1

package/types/generators/TextToSpeechGgml.ts

@@ -0,0 +1,182 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Load the model */
+export type GeneratorGGMLTTSActionLoadModel = Action & {
+  __actionName: 'GENERATOR_GGML_TTS_LOAD_MODEL'
+}
+
+/* Generate audio */
+export type GeneratorGGMLTTSActionGenerate = ActionWithParams & {
+  __actionName: 'GENERATOR_GGML_TTS_GENERATE'
+  params?: Array<{
+    input: 'text'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Clean cache */
+export type GeneratorGGMLTTSActionCleanCache = Action & {
+  __actionName: 'GENERATOR_GGML_TTS_CLEAN_CACHE'
+}
+
+/* Release context */
+export type GeneratorGGMLTTSActionReleaseContext = Action & {
+  __actionName: 'GENERATOR_GGML_TTS_RELEASE_CONTEXT'
+}
+
+/* Cancel current generation and clear queue */
+export type GeneratorGGMLTTSActionCancel = Action & {
+  __actionName: 'GENERATOR_GGML_TTS_CANCEL'
+}
+
+interface GeneratorGGMLTTSDef {
+  /*
+Default property:
+{
+  "vocoderUrl": "https://huggingface.co/ggml-org/WavTokenizer/resolve/main/WavTokenizer-Large-75-F16.gguf",
+  "vocoderHashType": "sha256",
+  "vocoderHash": "2356baa8631cc2995ea3465196a017a2733600d849a91180c0f97fa7fb375bbe",
+  "vocoderBatchSize": 4096,
+  "outputType": "play",
+  "cacheGenerated": true,
+  "autoInferEnable": false,
+  "softBreakRegex": "^[^\\r\\n\\t\\f\\v]*([\\r\\n]+|[。！？!?.]\\B)",
+  "hardBreakTime": 500,
+  "completionTemperature": 0.1,
+  "completionRepetitionPenalty": 1.1,
+  "completionTopK": 40,
+  "completionTopP": 0.9,
+  "completionMinP": 0.05,
+  "useGuideToken": true,
+  "contextSize": 8192,
+  "batchSize": 8192,
+  "microBatchSize": 512,
+  "maxThreads": 2,
+  "accelVariant": "default",
+  "mainGpu": 0,
+  "gpuLayers": 0,
+  "useMlock": true,
+  "useMmap": true,
+  "useFlashAttn": "off"
+}
+  */
+  property?: {
+    /* Initialize the TTS context on generator initialization */
+    init?: boolean | DataLink
+    /* The URL or path of model  
+ We used GGUF format model, please refer to https://github.com/ggerganov/llama.cpp/tree/master#description */
+    modelUrl?: string | DataLink
+    /* Hash type of model */
+    modelHashType?: 'md5' | 'sha256' | 'sha1' | DataLink
+    /* Hash of model */
+    modelHash?: string | DataLink
+    /* The URL or path of vocoder model */
+    vocoderUrl?: string | DataLink
+    /* Hash type of vocoder model */
+    vocoderHashType?: 'md5' | 'sha256' | 'sha1' | DataLink
+    /* Hash of vocoder model */
+    vocoderHash?: string | DataLink
+    /* Batch size of vocoder model */
+    vocoderBatchSize?: number | DataLink
+    /* Output mode */
+    outputType?: 'play' | 'file' | DataLink
+    /* Enable cache for generated audio */
+    cacheGenerated?: boolean | DataLink
+    /* Text to generate */
+    prompt?: string | DataLink
+    /* Speaker JSON */
+    speaker?: {} | DataLink
+    /* Auto inference when prompt changes */
+    autoInferEnable?: boolean | DataLink
+    /* Segmentation rule for auto inference */
+    softBreakRegex?: string | DataLink
+    /* Time to force inference when softBreakRegex is not satisfied */
+    hardBreakTime?: number | DataLink
+    /* Temperature */
+    completionTemperature?: number | DataLink
+    /* Repetition Penalty */
+    completionRepetitionPenalty?: number | DataLink
+    /* Top K sampling */
+    completionTopK?: number | DataLink
+    /* Top P sampling */
+    completionTopP?: number | DataLink
+    /* Min P sampling */
+    completionMinP?: number | DataLink
+    /* Set the random number generator (RNG) seed (default: -1, -1 = random seed) */
+    completionSeed?: number | DataLink
+    /* Number of tokens to predict */
+    completionPredict?: number | DataLink
+    /* Enable guide token to help prevent hallucinations by forcing the TTS to use the correct words. */
+    useGuideToken?: boolean | DataLink
+    /* Context size, for OutTTS recommended 4096 ~ 8192 (Default to 4096) */
+    contextSize?: number | DataLink
+    /* Logical batch size for prompt processing */
+    batchSize?: number | DataLink
+    /* Physical batch size for prompt processing */
+    microBatchSize?: number | DataLink
+    /* Number of threads */
+    maxThreads?: number | DataLink
+    /* Accelerator variant (Only for desktop)  
+ `default` - CPU / Metal (macOS)  
+ `vulkan` - Use Vulkan  
+ `cuda` - Use CUDA */
+    accelVariant?: 'default' | 'vulkan' | 'cuda' | DataLink
+    /* Main GPU index */
+    mainGpu?: number | DataLink
+    /* Number of GPU layers (NOTE: Currently not supported for Android) */
+    gpuLayers?: number | DataLink
+    /* Use memory lock */
+    useMlock?: boolean | DataLink
+    /* Use mmap */
+    useMmap?: boolean | DataLink
+    /* Use Flash Attention for inference (Recommended with GPU enabled) */
+    useFlashAttn?: 'auto' | 'on' | 'off' | DataLink
+  }
+  events?: {
+    /* Event triggered when state change */
+    onContextStateChange?: Array<EventAction>
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Context state */
+    contextState?: () => Data
+    /* Generated audio file */
+    generatedAudio?: () => Data
+    /* Generated audio file is playing */
+    generatedAudioPlaying?: () => Data
+  }
+}
+
+/* Local Text-to-Speech (TTS) inference based on GGML and [llama.cpp](https://github.com/ggerganov/llama.cpp)  
+ You can use any converted model on HuggingFace. */
+export type GeneratorGGMLTTS = Generator &
+  GeneratorGGMLTTSDef & {
+    templateKey: 'GENERATOR_GGML_TTS'
+    switches: Array<
+      SwitchDef &
+        GeneratorGGMLTTSDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'contextState' | 'generatedAudio' | 'generatedAudioPlaying'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/TextToSpeechOnnx.ts

@@ -0,0 +1,169 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Load the model */
+export type GeneratorTTSActionLoadModel = Action & {
+  __actionName: 'GENERATOR_TTS_LOAD_MODEL'
+}
+
+/* Generate audio */
+export type GeneratorTTSActionGenerate = ActionWithParams & {
+  __actionName: 'GENERATOR_TTS_GENERATE'
+  params?: Array<{
+    input: 'text'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Clean cache */
+export type GeneratorTTSActionCleanCache = Action & {
+  __actionName: 'GENERATOR_TTS_CLEAN_CACHE'
+}
+
+/* Release context */
+export type GeneratorTTSActionReleaseContext = Action & {
+  __actionName: 'GENERATOR_TTS_RELEASE_CONTEXT'
+}
+
+/* Cancel current generation and clear queue */
+export type GeneratorTTSActionCancel = Action & {
+  __actionName: 'GENERATOR_TTS_CANCEL'
+}
+
+interface GeneratorTTSDef {
+  /*
+Default property:
+{
+  "model": "BricksDisplay/vits-eng",
+  "modelType": "auto",
+  "vocoderModel": "speecht5_hifigan",
+  "maxLength": 4096,
+  "temperature": 0.1,
+  "repetitionPenalty": 1.1,
+  "doSample": true,
+  "outputType": "play",
+  "cacheGenerated": true,
+  "speed": 1,
+  "autoInferEnable": false,
+  "softBreakRegex": "^[^\\r\\n\\t\\f\\v]*([\\r\\n]+|[。！？!?.]\\B)",
+  "hardBreakTime": 500,
+  "executionMode": "sequential"
+}
+  */
+  property?: {
+    /* Initialize the TTS context on generator initialization */
+    init?: boolean | DataLink
+    /* TTS model  
+ The mms-tts models are licensed under CC-BY-NC-4.0 */
+    model?: string | DataLink
+    /* Model type */
+    modelType?: string | DataLink
+    /* Quantize type */
+    quantizeType?:
+      | 'auto'
+      | 'none'
+      | 'fp16'
+      | 'q8'
+      | 'int8'
+      | 'uint8'
+      | 'q4'
+      | 'bnb4'
+      | 'q4f16'
+      | DataLink
+    /* Vocoder model for SpeechT5 */
+    vocoderModel?: 'Custom' | 'speecht5_hifigan' | DataLink
+    /* Custom vocoder model  
+ Choose model from https://huggingface.co/models?library=transformers.js&other=hifigan */
+    customVocoderModel?: string | DataLink
+    /* Speaker embedding, for SpeechT5 or StyleTTS (Kokoro) */
+    speakerEmbedUrl?: string | DataLink
+    /* Hash of `speakerEmbedUrl` */
+    speakerEmbedHash?: string | DataLink
+    /* Hash type of `speakerEmbedUrl` */
+    speakerEmbedHashType?: 'md5' | 'sha256' | 'sha1' | DataLink
+    /* Speaker config, for OuteTTS model */
+    speakerConfig?: {} | DataLink
+    /* Audio token generation max length */
+    maxLength?: number | DataLink
+    /* Audio token generation temperature */
+    temperature?: number | DataLink
+    /* Audio token generation repetition penalty */
+    repetitionPenalty?: number | DataLink
+    /* Use greedy sampling for audio token generation */
+    doSample?: boolean | DataLink
+    /* Output mode */
+    outputType?: 'play' | 'file' | DataLink
+    /* Enable cache for generated audio */
+    cacheGenerated?: boolean | DataLink
+    /* Speed of the generated audio, for StyleTTS (Kokoro) */
+    speed?: number | DataLink
+    /* Text to generate */
+    prompt?: string | DataLink
+    /* Auto inference when prompt changes */
+    autoInferEnable?: boolean | DataLink
+    /* Segmentation rule for auto inference */
+    softBreakRegex?: string | DataLink
+    /* Time to force inference when softBreakRegex is not satisfied */
+    hardBreakTime?: number | DataLink
+    /* Executor candidates, descending order of priority  
+  Default will be xnnpack, wasm, cpu */
+    executors?:
+      | Array<'qnn' | 'dml' | 'nnapi' | 'xnnpack' | 'coreml' | 'cpu' | 'wasm' | 'webgpu' | DataLink>
+      | DataLink
+    /* Execution mode  
+  Usually when the model has many branches, setting this option to `parallel` will give you better performance. */
+    executionMode?: 'sequential' | 'parallel' | DataLink
+    /* QNN backend */
+    qnnBackend?: 'HTP' | 'HTA' | 'DSP' | 'GPU' | 'CPU' | DataLink
+    /* Enable FP16 for QNN HTP */
+    qnnHtpEnableFp16?: boolean | DataLink
+    /* Enable QNN debug */
+    qnnEnableDebug?: boolean | DataLink
+  }
+  events?: {
+    /* Event triggered when state change */
+    onContextStateChange?: Array<EventAction>
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Context state */
+    contextState?: () => Data
+    /* Generated audio file */
+    generatedAudio?: () => Data
+    /* Generated audio file is playing */
+    generatedAudioPlaying?: () => Data
+  }
+}
+
+/* Local Text-to-Speech (TTS) inference based on ONNX Runtime and [transformers.js](https://huggingface.co/docs/transformers.js)  
+ You can use any converted model on HuggingFace. */
+export type GeneratorTTS = Generator &
+  GeneratorTTSDef & {
+    templateKey: 'GENERATOR_TTS'
+    switches: Array<
+      SwitchDef &
+        GeneratorTTSDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'contextState' | 'generatedAudio' | 'generatedAudioPlaying'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/TextToSpeechOpenAiLike.ts

@@ -0,0 +1,113 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Generate audio */
+export type GeneratorOpenAiTTSActionGenerate = ActionWithParams & {
+  __actionName: 'GENERATOR_OPENAI_TTS_GENERATE'
+  params?: Array<{
+    input: 'text'
+    value?: string | DataLink | EventProperty
+    mapping?: string
+  }>
+}
+
+/* Clean cache */
+export type GeneratorOpenAiTTSActionCleanCache = Action & {
+  __actionName: 'GENERATOR_OPENAI_TTS_CLEAN_CACHE'
+}
+
+/* Cancel current generation and clear queue */
+export type GeneratorOpenAiTTSActionCancel = Action & {
+  __actionName: 'GENERATOR_OPENAI_TTS_CANCEL'
+}
+
+interface GeneratorOpenAiTTSDef {
+  /*
+Default property:
+{
+  "apiEndpoint": "https://api.openai.com/v1",
+  "model": "tts-1",
+  "voice": "alloy",
+  "speed": 1,
+  "outputType": "play",
+  "playbackVolume": 100,
+  "cacheGenerated": true,
+  "autoInferEnable": false,
+  "softBreakRegex": "^[^\\r\\n\\t\\f\\v]*([\\r\\n]+|[。！？!?.]\\B)",
+  "hardBreakTime": 500
+}
+  */
+  property?: {
+    /* API endpoint URL */
+    apiEndpoint?: string | DataLink
+    /* OpenAI API Key */
+    apiKey?: string | DataLink
+    /* OpenAI TTS model */
+    model?: string | DataLink
+    /* Voice to use  
+ Select voice from https://openai.fm , default alloy */
+    voice?: string | DataLink
+    /* Additional instructions for the speech generation */
+    instructions?: string | DataLink
+    /* Speed of the generated audio */
+    speed?: number | DataLink
+    /* Output mode */
+    outputType?: 'play' | 'file' | DataLink
+    /* Playback volume (0 - 100) */
+    playbackVolume?: number | DataLink
+    /* Enable cache for generated audio */
+    cacheGenerated?: boolean | DataLink
+    /* Text to generate */
+    prompt?: string | DataLink
+    /* Auto inference when prompt changes */
+    autoInferEnable?: boolean | DataLink
+    /* Segmentation rule for auto inference */
+    softBreakRegex?: string | DataLink
+    /* Time to force inference when softBreakRegex is not satisfied */
+    hardBreakTime?: number | DataLink
+  }
+  events?: {
+    /* Event triggered when state change */
+    onContextStateChange?: Array<EventAction>
+    /* Event triggered when error occurs */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Context state */
+    contextState?: () => Data
+    /* Generated audio file */
+    generatedAudio?: () => Data
+    /* Generated audio file is playing */
+    generatedAudioPlaying?: () => Data
+  }
+}
+
+/* Generate speech from text using OpenAI's Text-to-Speech API */
+export type GeneratorOpenAiTTS = Generator &
+  GeneratorOpenAiTTSDef & {
+    templateKey: 'GENERATOR_OPENAI_TTS'
+    switches: Array<
+      SwitchDef &
+        GeneratorOpenAiTTSDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'contextState' | 'generatedAudio' | 'generatedAudioPlaying'
+                  value: any
+                }
+          }>
+        }
+    >
+  }

package/types/generators/ThermalPrinter.ts

@@ -0,0 +1,185 @@
+import type { SwitchCondInnerStateCurrentCanvas, SwitchCondData, SwitchDef } from '../switch'
+import type { Data, DataLink } from '../data'
+import type {
+  Generator,
+  EventAction,
+  ActionWithDataParams,
+  ActionWithParams,
+  Action,
+  EventProperty,
+} from '../common'
+
+/* Init thermal printer connection */
+export type GeneratorThermalPrinterActionInit = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_INIT'
+}
+
+/* Scan thermal printer */
+export type GeneratorThermalPrinterActionScan = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_SCAN'
+}
+
+/* Dispose thermal printer connection */
+export type GeneratorThermalPrinterActionDispose = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_DISPOSE'
+}
+
+/* Start print */
+export type GeneratorThermalPrinterActionPrint = ActionWithParams & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_PRINT'
+  params?: Array<
+    | {
+        input: 'options'
+        value?: {} | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'payload'
+        value?: Array<any> | DataLink | EventProperty
+        mapping?: string
+      }
+    | {
+        input: 'rawCommands'
+        value?: string | DataLink | EventProperty
+        mapping?: string
+      }
+  >
+}
+
+/* Check thermal printer status */
+export type GeneratorThermalPrinterActionCheckStatus = Action & {
+  __actionName: 'GENERATOR_THERMAL_PRINTER_CHECK_STATUS'
+}
+
+interface GeneratorThermalPrinterDef {
+  /*
+Default property:
+{
+  "init": false,
+  "lang": "ANK",
+  "scanTimeout": 5000,
+  "stateUpdateInterval": 5000,
+  "cutMode": "PARTIAL"
+}
+  */
+  property?: {
+    /* Connect printer on generator initialized */
+    init?: boolean | DataLink
+    /* Connection driver */
+    driver?: 'escpos' | 'star' | 'tsc' | DataLink
+    /* The address of the printer */
+    connectString?: string | DataLink
+    /* The language of the printer (only for EPSON) */
+    lang?: 'ANK' | 'CHINESE' | 'TAIWAN' | 'KOREAN' | 'THAI' | 'SOUTHASIA' | DataLink
+    /* The timeout of scanning */
+    scanTimeout?: number | DataLink
+    /* State update interval, 0 means no update automatically */
+    stateUpdateInterval?: number | DataLink
+    /* Enable page mode on printing */
+    pageMode?: boolean | DataLink
+    /* Printable page area width */
+    pageWidth?: number | DataLink
+    /* Printable page area height */
+    pageHeight?: number | DataLink
+    /* Cut mode at the end of printing */
+    cutMode?: 'NONE' | 'FULL' | 'PARTIAL' | DataLink
+    /* Print payload  
+ example:  
+ { type: 'text', content: 'Hello, World!' }  
+ { type: 'feed', feedLines: 1 }  
+ { type: 'reverse-feed', feedLines: 1 }  
+ { type: 'image', content: '/path/to/file' }  
+ { type: 'line-space', lineSpace: 1 }  
+ { type: 'barcode', content: '1234567890', barcodeType: 'CODE128' }  
+ { type: 'symbol', content: '1234567890', symbolType: 'QRCODE' }  
+ Notes:  
+ - `reverse-feed` only works on ESC/POS driver  
+ - `width` and `height` in Star driver is magnification factor  
+ - `y` position in ESC/POS is use feed lines to offset  
+ - `textFont` only works on TSC driver */
+    payload?:
+      | Array<
+          | DataLink
+          | {
+              type?:
+                | 'text'
+                | 'image'
+                | 'barcode'
+                | 'qrcode'
+                | 'line-space'
+                | 'feed'
+                | 'reverse-feed'
+                | DataLink
+              content?: string | DataLink
+              width?: number | DataLink
+              height?: number | DataLink
+              x?: number | DataLink
+              y?: number | DataLink
+              align?: 'LEFT' | 'CENTER' | 'RIGHT' | DataLink
+              textSmooth?: boolean | DataLink
+              textEmphasize?: boolean | DataLink
+              textUnderline?: boolean | DataLink
+              textLang?: 'EN' | 'JA' | 'ZH_CN' | 'ZH_TW' | 'KO' | 'TH' | 'VI' | 'MULTI' | DataLink
+              textFont?: string | DataLink
+              barcodeType?:
+                | 'CODE39'
+                | 'CODE93'
+                | 'CODE128'
+                | 'EAN13'
+                | 'JAN13'
+                | 'EAN8'
+                | 'JAN8'
+                | 'UPC_A'
+                | 'UPC_E'
+                | 'ITF'
+                | DataLink
+              barcodeHRI?: 'OFF' | 'ABOVE' | 'BELOW' | 'BOTH' | DataLink
+              qrcodeModel?: '1' | '2' | DataLink
+              qrcodeSize?: number | DataLink
+              qrcodeLevel?: 'L' | 'M' | 'Q' | 'H' | DataLink
+              qrcodeMask?: 'S0' | 'S1' | 'S2' | 'S3' | 'S4' | 'S5' | 'S6' | 'S7' | DataLink
+              feedLines?: number | DataLink
+              lineSpace?: number | DataLink
+            }
+        >
+      | DataLink
+    /* Raw ASCII commands to print */
+    rawCommands?: string | DataLink
+  }
+  events?: {
+    /* Event of connection error */
+    onError?: Array<EventAction>
+  }
+  outlets?: {
+    /* Is thermal printer initialized */
+    initialized?: () => Data
+    /* Thermal printer status */
+    status?: () => Data
+    /* Discovered devices */
+    discoveredDevices?: () => Data
+    /* Last error message */
+    lastError?: () => Data
+  }
+}
+
+/* Thermal Printer */
+export type GeneratorThermalPrinter = Generator &
+  GeneratorThermalPrinterDef & {
+    templateKey: 'GENERATOR_THERMAL_PRINTER'
+    switches: Array<
+      SwitchDef &
+        GeneratorThermalPrinterDef & {
+          conds?: Array<{
+            method: '==' | '!=' | '>' | '<' | '>=' | '<='
+            cond:
+              | SwitchCondInnerStateCurrentCanvas
+              | SwitchCondData
+              | {
+                  __typename: 'SwitchCondInnerStateOutlet'
+                  outlet: 'initialized' | 'status' | 'discoveredDevices' | 'lastError'
+                  value: any
+                }
+          }>
+        }
+    >
+  }