bare-media 1.4.0 → 1.6.0

package/README.md

@@ -55,26 +55,29 @@ const data = await createPreview({ path, maxWidth, maxHeight })
 
 Create a preview from a media file
 
-| Property    | Type   | Description                                                       |
-| ----------- | ------ | ----------------------------------------------------------------- |
-| `path`      | string | Path to the input file                                            |
-| `mimetype`  | string | Media type of the input file. If not provided it will be detected |
-| `maxWidth`  | number | Max width for the generated preview                               |
-| `maxHeight` | number | Max height for the generated preview                              |
-| `maxFrames` | number | Max frames for the generated preview in case the file is animated |
-| `maxBytes`  | number | Max bytes for the generated preview                               |
-| `format`    | string | Media type for the generated preview. Default `image/webp`        |
-| `encoding`  | string | `base64` or nothing for buffer                                    |
+| Property    | Type   | Description                                                               |
+| ----------- | ------ | ------------------------------------------------------------------------- |
+| `path`      | string | Path to the input file. Either `path`, `httpLink` or `buffer` is required |
+| `httpLink`  | string | Http link to the input file                                               |
+| `buffer`    | object | Bytes of the input file                                                   |
+| `mimetype`  | string | Media type of the input file. If not provided it will be detected         |
+| `maxWidth`  | number | Max width for the generated preview                                       |
+| `maxHeight` | number | Max height for the generated preview                                      |
+| `maxFrames` | number | Max frames for the generated preview in case the file is animated         |
+| `maxBytes`  | number | Max bytes for the generated preview                                       |
+| `format`    | string | Media type for the generated preview. Default `image/webp`                |
+| `encoding`  | string | `base64` or nothing for buffer                                            |
 
 ### decodeImage()
 
 Decode an image to RGBA
 
-| Property   | Type   | Description                                                       |
-| ---------- | ------ | ----------------------------------------------------------------- |
-| `path`     | string | Path to the input file. Either this or `httpLink` is required     |
-| `httpLink` | string | Http link to the input file                                       |
-| `mimetype` | string | Media type of the input file. If not provided it will be detected |
+| Property   | Type   | Description                                                               |
+| ---------- | ------ | ------------------------------------------------------------------------- |
+| `path`     | string | Path to the input file. Either `path`, `httpLink` or `buffer` is required |
+| `httpLink` | string | Http link to the input file                                               |
+| `buffer`   | object | Bytes of the input file                                                   |
+| `mimetype` | string | Media type of the input file. If not provided it will be detected         |
 
 ## License
 

package/client.js

@@ -42,6 +42,17 @@ export class WorkerClient extends ReadyResource {
     this.worker?.IPC.end()
   }
 
+  #reset() {
+    this.opening = null
+    this.closing = null
+
+    this.opened = false
+    this.closed = false
+
+    this.worker = null
+    this.rpc = null
+  }
+
   async #run() {
     const { filename, requireSource, args } = this.opts
     const source = requireSource?.()
@@ -50,7 +61,13 @@ export class WorkerClient extends ReadyResource {
     const ipc = this.worker.IPC
 
     ipc.on('end', () => ipc.end())
-    ipc.on('close', () => this.onClose?.())
+    ipc.on('close', () => {
+      this.#reset()
+      this.onClose?.()
+      console.error(
+        '[bare-media] Worker has exited. IPC channel closed unexpectedly.'
+      )
+    })
 
     this.rpc = new HRPC(ipc)
   }

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "bare-media",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "build:rpc": "cd shared/spec && bare ./build.js",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "test": "npm run format:check && brittle-bare test/index.js"
+    "lint": "lunte",
+    "test": "npm run lint && npm run format:check && brittle-bare test/index.js"
   },
   "keywords": [],
   "author": "Holepunch Inc",
@@ -17,6 +18,7 @@
     "b4a": "^1.6.7",
     "bare-fetch": "^2.4.1",
     "bare-fs": "^4.1.5",
+    "bare-gif": "^1.1.2",
     "bare-heif": "^1.0.5",
     "bare-image-resample": "^1.0.1",
     "bare-jpeg": "^1.0.1",
@@ -35,6 +37,7 @@
     "corestore": "^7.4.5",
     "hyperblobs": "^2.8.0",
     "hypercore-blob-server": "^1.11.0",
+    "lunte": "^1.3.0",
     "prettier": "^3.6.2",
     "prettier-config-holepunch": "^1.0.0",
     "test-tmp": "^1.4.0"

package/shared/codecs.js

@@ -7,7 +7,8 @@ export const codecs = {
   'image/webp': () => import('bare-webp'),
   'image/png': () => import('bare-png'),
   'image/tif': () => import('bare-tiff'),
-  'image/tiff': () => import('bare-tiff')
+  'image/tiff': () => import('bare-tiff'),
+  'image/gif': () => import('bare-gif')
 }
 
 export function isCodecSupported(mimetype) {

package/shared/spec/hrpc/messages.js

@@ -100,9 +100,23 @@ const encoding2 = {
 // @media/create-preview-request
 const encoding3 = {
   preencode(state, m) {
-    c.string.preencode(state, m.path)
-    state.end++ // max flag is 64 so always one byte
+    const flags =
+      (m.path ? 1 : 0) |
+      (m.httpLink ? 2 : 0) |
+      (m.buffer ? 4 : 0) |
+      (m.mimetype ? 8 : 0) |
+      (m.maxWidth ? 16 : 0) |
+      (m.maxHeight ? 32 : 0) |
+      (m.maxFrames ? 64 : 0) |
+      (m.maxBytes ? 128 : 0) |
+      (m.format ? 256 : 0) |
+      (m.encoding ? 512 : 0)
+
+    c.uint.preencode(state, flags)
 
+    if (m.path) c.string.preencode(state, m.path)
+    if (m.httpLink) c.string.preencode(state, m.httpLink)
+    if (m.buffer) c.buffer.preencode(state, m.buffer)
     if (m.mimetype) c.string.preencode(state, m.mimetype)
     if (m.maxWidth) c.uint.preencode(state, m.maxWidth)
     if (m.maxHeight) c.uint.preencode(state, m.maxHeight)
@@ -113,17 +127,22 @@ const encoding3 = {
   },
   encode(state, m) {
     const flags =
-      (m.mimetype ? 1 : 0) |
-      (m.maxWidth ? 2 : 0) |
-      (m.maxHeight ? 4 : 0) |
-      (m.maxFrames ? 8 : 0) |
-      (m.maxBytes ? 16 : 0) |
-      (m.format ? 32 : 0) |
-      (m.encoding ? 64 : 0)
-
-    c.string.encode(state, m.path)
+      (m.path ? 1 : 0) |
+      (m.httpLink ? 2 : 0) |
+      (m.buffer ? 4 : 0) |
+      (m.mimetype ? 8 : 0) |
+      (m.maxWidth ? 16 : 0) |
+      (m.maxHeight ? 32 : 0) |
+      (m.maxFrames ? 64 : 0) |
+      (m.maxBytes ? 128 : 0) |
+      (m.format ? 256 : 0) |
+      (m.encoding ? 512 : 0)
+
     c.uint.encode(state, flags)
 
+    if (m.path) c.string.encode(state, m.path)
+    if (m.httpLink) c.string.encode(state, m.httpLink)
+    if (m.buffer) c.buffer.encode(state, m.buffer)
     if (m.mimetype) c.string.encode(state, m.mimetype)
     if (m.maxWidth) c.uint.encode(state, m.maxWidth)
     if (m.maxHeight) c.uint.encode(state, m.maxHeight)
@@ -133,18 +152,19 @@ const encoding3 = {
     if (m.encoding) c.string.encode(state, m.encoding)
   },
   decode(state) {
-    const r0 = c.string.decode(state)
     const flags = c.uint.decode(state)
 
     return {
-      path: r0,
-      mimetype: (flags & 1) !== 0 ? c.string.decode(state) : null,
-      maxWidth: (flags & 2) !== 0 ? c.uint.decode(state) : 0,
-      maxHeight: (flags & 4) !== 0 ? c.uint.decode(state) : 0,
-      maxFrames: (flags & 8) !== 0 ? c.uint.decode(state) : 0,
-      maxBytes: (flags & 16) !== 0 ? c.uint.decode(state) : 0,
-      format: (flags & 32) !== 0 ? c.string.decode(state) : null,
-      encoding: (flags & 64) !== 0 ? c.string.decode(state) : null
+      path: (flags & 1) !== 0 ? c.string.decode(state) : null,
+      httpLink: (flags & 2) !== 0 ? c.string.decode(state) : null,
+      buffer: (flags & 4) !== 0 ? c.buffer.decode(state) : null,
+      mimetype: (flags & 8) !== 0 ? c.string.decode(state) : null,
+      maxWidth: (flags & 16) !== 0 ? c.uint.decode(state) : 0,
+      maxHeight: (flags & 32) !== 0 ? c.uint.decode(state) : 0,
+      maxFrames: (flags & 64) !== 0 ? c.uint.decode(state) : 0,
+      maxBytes: (flags & 128) !== 0 ? c.uint.decode(state) : 0,
+      format: (flags & 256) !== 0 ? c.string.decode(state) : null,
+      encoding: (flags & 512) !== 0 ? c.string.decode(state) : null
     }
   }
 }
@@ -178,19 +198,25 @@ const encoding4 = {
 // @media/decode-image-request
 const encoding5 = {
   preencode(state, m) {
-    state.end++ // max flag is 4 so always one byte
+    state.end++ // max flag is 8 so always one byte
 
     if (m.path) c.string.preencode(state, m.path)
     if (m.httpLink) c.string.preencode(state, m.httpLink)
+    if (m.buffer) c.buffer.preencode(state, m.buffer)
     if (m.mimetype) c.string.preencode(state, m.mimetype)
   },
   encode(state, m) {
-    const flags = (m.path ? 1 : 0) | (m.httpLink ? 2 : 0) | (m.mimetype ? 4 : 0)
+    const flags =
+      (m.path ? 1 : 0) |
+      (m.httpLink ? 2 : 0) |
+      (m.buffer ? 4 : 0) |
+      (m.mimetype ? 8 : 0)
 
     c.uint.encode(state, flags)
 
     if (m.path) c.string.encode(state, m.path)
     if (m.httpLink) c.string.encode(state, m.httpLink)
+    if (m.buffer) c.buffer.encode(state, m.buffer)
     if (m.mimetype) c.string.encode(state, m.mimetype)
   },
   decode(state) {
@@ -199,7 +225,8 @@ const encoding5 = {
     return {
       path: (flags & 1) !== 0 ? c.string.decode(state) : null,
       httpLink: (flags & 2) !== 0 ? c.string.decode(state) : null,
-      mimetype: (flags & 4) !== 0 ? c.string.decode(state) : null
+      buffer: (flags & 4) !== 0 ? c.buffer.decode(state) : null,
+      mimetype: (flags & 8) !== 0 ? c.string.decode(state) : null
     }
   }
 }

package/shared/spec/schema/index.js

@@ -100,9 +100,23 @@ const encoding2 = {
 // @media/create-preview-request
 const encoding3 = {
   preencode(state, m) {
-    c.string.preencode(state, m.path)
-    state.end++ // max flag is 64 so always one byte
+    const flags =
+      (m.path ? 1 : 0) |
+      (m.httpLink ? 2 : 0) |
+      (m.buffer ? 4 : 0) |
+      (m.mimetype ? 8 : 0) |
+      (m.maxWidth ? 16 : 0) |
+      (m.maxHeight ? 32 : 0) |
+      (m.maxFrames ? 64 : 0) |
+      (m.maxBytes ? 128 : 0) |
+      (m.format ? 256 : 0) |
+      (m.encoding ? 512 : 0)
+
+    c.uint.preencode(state, flags)
 
+    if (m.path) c.string.preencode(state, m.path)
+    if (m.httpLink) c.string.preencode(state, m.httpLink)
+    if (m.buffer) c.buffer.preencode(state, m.buffer)
     if (m.mimetype) c.string.preencode(state, m.mimetype)
     if (m.maxWidth) c.uint.preencode(state, m.maxWidth)
     if (m.maxHeight) c.uint.preencode(state, m.maxHeight)
@@ -113,17 +127,22 @@ const encoding3 = {
   },
   encode(state, m) {
     const flags =
-      (m.mimetype ? 1 : 0) |
-      (m.maxWidth ? 2 : 0) |
-      (m.maxHeight ? 4 : 0) |
-      (m.maxFrames ? 8 : 0) |
-      (m.maxBytes ? 16 : 0) |
-      (m.format ? 32 : 0) |
-      (m.encoding ? 64 : 0)
-
-    c.string.encode(state, m.path)
+      (m.path ? 1 : 0) |
+      (m.httpLink ? 2 : 0) |
+      (m.buffer ? 4 : 0) |
+      (m.mimetype ? 8 : 0) |
+      (m.maxWidth ? 16 : 0) |
+      (m.maxHeight ? 32 : 0) |
+      (m.maxFrames ? 64 : 0) |
+      (m.maxBytes ? 128 : 0) |
+      (m.format ? 256 : 0) |
+      (m.encoding ? 512 : 0)
+
     c.uint.encode(state, flags)
 
+    if (m.path) c.string.encode(state, m.path)
+    if (m.httpLink) c.string.encode(state, m.httpLink)
+    if (m.buffer) c.buffer.encode(state, m.buffer)
     if (m.mimetype) c.string.encode(state, m.mimetype)
     if (m.maxWidth) c.uint.encode(state, m.maxWidth)
     if (m.maxHeight) c.uint.encode(state, m.maxHeight)
@@ -133,18 +152,19 @@ const encoding3 = {
     if (m.encoding) c.string.encode(state, m.encoding)
   },
   decode(state) {
-    const r0 = c.string.decode(state)
     const flags = c.uint.decode(state)
 
     return {
-      path: r0,
-      mimetype: (flags & 1) !== 0 ? c.string.decode(state) : null,
-      maxWidth: (flags & 2) !== 0 ? c.uint.decode(state) : 0,
-      maxHeight: (flags & 4) !== 0 ? c.uint.decode(state) : 0,
-      maxFrames: (flags & 8) !== 0 ? c.uint.decode(state) : 0,
-      maxBytes: (flags & 16) !== 0 ? c.uint.decode(state) : 0,
-      format: (flags & 32) !== 0 ? c.string.decode(state) : null,
-      encoding: (flags & 64) !== 0 ? c.string.decode(state) : null
+      path: (flags & 1) !== 0 ? c.string.decode(state) : null,
+      httpLink: (flags & 2) !== 0 ? c.string.decode(state) : null,
+      buffer: (flags & 4) !== 0 ? c.buffer.decode(state) : null,
+      mimetype: (flags & 8) !== 0 ? c.string.decode(state) : null,
+      maxWidth: (flags & 16) !== 0 ? c.uint.decode(state) : 0,
+      maxHeight: (flags & 32) !== 0 ? c.uint.decode(state) : 0,
+      maxFrames: (flags & 64) !== 0 ? c.uint.decode(state) : 0,
+      maxBytes: (flags & 128) !== 0 ? c.uint.decode(state) : 0,
+      format: (flags & 256) !== 0 ? c.string.decode(state) : null,
+      encoding: (flags & 512) !== 0 ? c.string.decode(state) : null
     }
   }
 }
@@ -178,19 +198,25 @@ const encoding4 = {
 // @media/decode-image-request
 const encoding5 = {
   preencode(state, m) {
-    state.end++ // max flag is 4 so always one byte
+    state.end++ // max flag is 8 so always one byte
 
     if (m.path) c.string.preencode(state, m.path)
     if (m.httpLink) c.string.preencode(state, m.httpLink)
+    if (m.buffer) c.buffer.preencode(state, m.buffer)
     if (m.mimetype) c.string.preencode(state, m.mimetype)
   },
   encode(state, m) {
-    const flags = (m.path ? 1 : 0) | (m.httpLink ? 2 : 0) | (m.mimetype ? 4 : 0)
+    const flags =
+      (m.path ? 1 : 0) |
+      (m.httpLink ? 2 : 0) |
+      (m.buffer ? 4 : 0) |
+      (m.mimetype ? 8 : 0)
 
     c.uint.encode(state, flags)
 
     if (m.path) c.string.encode(state, m.path)
     if (m.httpLink) c.string.encode(state, m.httpLink)
+    if (m.buffer) c.buffer.encode(state, m.buffer)
     if (m.mimetype) c.string.encode(state, m.mimetype)
   },
   decode(state) {
@@ -199,7 +225,8 @@ const encoding5 = {
     return {
       path: (flags & 1) !== 0 ? c.string.decode(state) : null,
       httpLink: (flags & 2) !== 0 ? c.string.decode(state) : null,
-      mimetype: (flags & 4) !== 0 ? c.string.decode(state) : null
+      buffer: (flags & 4) !== 0 ? c.buffer.decode(state) : null,
+      mimetype: (flags & 8) !== 0 ? c.string.decode(state) : null
     }
   }
 }

package/shared/spec/schema/schema.json

@@ -71,14 +71,23 @@
       "name": "create-preview-request",
       "namespace": "media",
       "compact": false,
-      "flagsPosition": 1,
+      "flagsPosition": 0,
       "fields": [
         {
           "name": "path",
-          "required": true,
           "type": "string",
           "version": 1
         },
+        {
+          "name": "httpLink",
+          "type": "string",
+          "version": 1
+        },
+        {
+          "name": "buffer",
+          "type": "buffer",
+          "version": 1
+        },
         {
           "name": "mimetype",
           "type": "string",
@@ -152,6 +161,11 @@
           "type": "string",
           "version": 1
         },
+        {
+          "name": "buffer",
+          "type": "buffer",
+          "version": 1
+        },
         {
           "name": "mimetype",
           "type": "string",

package/shared/spec/schema.js

@@ -62,8 +62,15 @@ media.register({
   fields: [
     {
       name: 'path',
-      type: 'string',
-      required: true
+      type: 'string'
+    },
+    {
+      name: 'httpLink',
+      type: 'string'
+    },
+    {
+      name: 'buffer',
+      type: 'buffer'
     },
     {
       name: 'mimetype',
@@ -123,6 +130,10 @@ media.register({
       name: 'httpLink',
       type: 'string'
     },
+    {
+      name: 'buffer',
+      type: 'buffer'
+    },
     {
       name: 'mimetype',
       type: 'string'

package/worker/media.js

@@ -12,6 +12,8 @@ const animatableMimetypes = ['image/webp']
 
 export async function createPreview({
   path,
+  httpLink,
+  buffer,
   mimetype,
   maxWidth,
   maxHeight,
@@ -23,8 +25,8 @@ export async function createPreview({
   mimetype = mimetype || getMimeType(path)
   format = format || DEFAULT_PREVIEW_FORMAT
 
-  const buffer = fs.readFileSync(path)
-  const rgba = await decodeImageToRGBA(buffer, mimetype, maxFrames)
+  const buff = await getBuffer({ path, httpLink, buffer })
+  const rgba = await decodeImageToRGBA(buff, mimetype, maxFrames)
   const { width, height } = rgba
 
   const maybeResizedRGBA = await resizeRGBA(rgba, maxWidth, maxHeight)
@@ -114,17 +116,10 @@ export async function createPreview({
   }
 }
 
-export async function decodeImage({ path, httpLink, mimetype }) {
-  let buffer
+export async function decodeImage({ path, httpLink, buffer, mimetype }) {
+  const buff = await getBuffer({ path, httpLink, buffer })
 
-  if (path) {
-    buffer = fs.readFileSync(path)
-  } else if (httpLink) {
-    const response = await fetch(httpLink)
-    buffer = await response.buffer()
-  }
-
-  const rgba = await decodeImageToRGBA(buffer, mimetype)
+  const rgba = await decodeImageToRGBA(buff, mimetype)
   const { width, height, data } = rgba
 
   return {
@@ -135,6 +130,23 @@ export async function decodeImage({ path, httpLink, mimetype }) {
   }
 }
 
+async function getBuffer({ path, httpLink, buffer }) {
+  if (buffer) return buffer
+
+  if (path) {
+    return fs.readFileSync(path)
+  }
+
+  if (httpLink) {
+    const response = await fetch(httpLink)
+    return await response.buffer()
+  }
+
+  throw new Error(
+    'At least one of "path", "httpLink" or "buffer" must be provided'
+  )
+}
+
 async function decodeImageToRGBA(buffer, mimetype, maxFrames) {
   let rgba