bare-media 1.6.0 → 1.8.0

package/README.md

@@ -79,6 +79,22 @@ Decode an image to RGBA
 | `buffer`   | object | Bytes of the input file                                                   |
 | `mimetype` | string | Media type of the input file. If not provided it will be detected         |
 
+### cropImage()
+
+Crop an image
+
+| 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         |
+| `left`     | number | Offset from left edge                                                     |
+| `top`      | number | Offset from top edge                                                      |
+| `width`    | number | Width of the region to crop                                               |
+| `height`   | number | Height of the region to crop                                              |
+| `format`   | string | Media type for the cropped image. Default same as the input image         |
+
 ## License
 
 Apache-2.0

package/client.js

@@ -24,7 +24,7 @@ export class WorkerClient extends ReadyResource {
   }
 
   #attachMethods() {
-    const methods = ['createPreview', 'decodeImage']
+    const methods = ['createPreview', 'decodeImage', 'cropImage']
 
     for (const method of methods) {
       this[method] = async (...args) => {

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "bare-media",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "main": "index.js",
   "type": "module",
   "scripts": {
     "build:rpc": "cd shared/spec && bare ./build.js",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "lint": "lunte",
-    "test": "npm run lint && npm run format:check && brittle-bare test/index.js"
+    "lint": "npm run format:check && lunte",
+    "test": "brittle-bare test/index.js"
   },
   "keywords": [],
   "author": "Holepunch Inc",
@@ -26,6 +26,7 @@
     "bare-tiff": "^1.0.1",
     "bare-webp": "^1.0.3",
     "cross-worker": "^1.1.0",
+    "get-file-format": "^1.0.1",
     "get-mime-type": "^2.0.1",
     "hrpc": "^4.0.0",
     "hyperschema": "^1.12.3",

package/shared/spec/build.js

@@ -25,4 +25,10 @@ ns.register({
   response: { name: '@media/decode-image-response', stream: false }
 })
 
+ns.register({
+  name: 'crop-image',
+  request: { name: '@media/crop-image-request', stream: false },
+  response: { name: '@media/crop-image-response', stream: false }
+})
+
 HRPCBuilder.toDisk(builder)

package/shared/spec/hrpc/hrpc.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "schema": [
     {
       "id": 0,
@@ -26,6 +26,19 @@
         "stream": false
       },
       "version": 1
+    },
+    {
+      "id": 2,
+      "name": "@media/crop-image",
+      "request": {
+        "name": "@media/crop-image-request",
+        "stream": false
+      },
+      "response": {
+        "name": "@media/crop-image-response",
+        "stream": false
+      },
+      "version": 2
     }
   ]
 }

package/shared/spec/hrpc/index.js

@@ -9,7 +9,9 @@ const methods = new Map([
   ['@media/create-preview', 0],
   [0, '@media/create-preview'],
   ['@media/decode-image', 1],
-  [1, '@media/decode-image']
+  [1, '@media/decode-image'],
+  ['@media/crop-image', 2],
+  [2, '@media/crop-image']
 ])
 
 class HRPC {
@@ -18,11 +20,13 @@ class HRPC {
     this._handlers = []
     this._requestEncodings = new Map([
       ['@media/create-preview', getEncoding('@media/create-preview-request')],
-      ['@media/decode-image', getEncoding('@media/decode-image-request')]
+      ['@media/decode-image', getEncoding('@media/decode-image-request')],
+      ['@media/crop-image', getEncoding('@media/crop-image-request')]
     ])
     this._responseEncodings = new Map([
       ['@media/create-preview', getEncoding('@media/create-preview-response')],
-      ['@media/decode-image', getEncoding('@media/decode-image-response')]
+      ['@media/decode-image', getEncoding('@media/decode-image-response')],
+      ['@media/crop-image', getEncoding('@media/crop-image-response')]
     ])
     this._rpc = new RPC(stream, async (req) => {
       const command = methods.get(req.command)
@@ -125,6 +129,10 @@ class HRPC {
     return this._call('@media/decode-image', args)
   }
 
+  async cropImage(args) {
+    return this._call('@media/crop-image', args)
+  }
+
   onCreatePreview(responseFn) {
     this._handlers['@media/create-preview'] = responseFn
   }
@@ -133,6 +141,10 @@ class HRPC {
     this._handlers['@media/decode-image'] = responseFn
   }
 
+  onCropImage(responseFn) {
+    this._handlers['@media/crop-image'] = responseFn
+  }
+
   _requestIsStream(command) {
     return [].includes(command)
   }

package/shared/spec/hrpc/messages.js

@@ -1,11 +1,12 @@
 // This file is autogenerated by the hyperschema compiler
-// Schema Version: 1
+// Schema Version: 2
 /* eslint-disable camelcase */
 /* eslint-disable quotes */
+/* eslint-disable space-before-function-paren */
 
 import { c } from 'hyperschema/runtime'
 
-const VERSION = 1
+const VERSION = 2
 
 // eslint-disable-next-line no-unused-vars
 let version = VERSION
@@ -260,6 +261,107 @@ const encoding6 = {
   }
 }
 
+// @media/crop-image-request
+const encoding7 = {
+  preencode(state, m) {
+    const flags =
+      (version >= 2 && m.path ? 1 : 0) |
+      (version >= 2 && m.httpLink ? 2 : 0) |
+      (version >= 2 && m.buffer ? 4 : 0) |
+      (version >= 2 && m.mimetype ? 8 : 0) |
+      (version >= 2 && m.left ? 16 : 0) |
+      (version >= 2 && m.top ? 32 : 0) |
+      (version >= 2 && m.width ? 64 : 0) |
+      (version >= 2 && m.height ? 128 : 0) |
+      (version >= 2 && m.format ? 256 : 0)
+
+    c.uint.preencode(state, flags)
+
+    if (version >= 2 && m.path) c.string.preencode(state, m.path)
+    if (version >= 2 && m.httpLink) c.string.preencode(state, m.httpLink)
+    if (version >= 2 && m.buffer) c.buffer.preencode(state, m.buffer)
+    if (version >= 2 && m.mimetype) c.string.preencode(state, m.mimetype)
+    if (version >= 2 && m.left) c.uint.preencode(state, m.left)
+    if (version >= 2 && m.top) c.uint.preencode(state, m.top)
+    if (version >= 2 && m.width) c.uint.preencode(state, m.width)
+    if (version >= 2 && m.height) c.uint.preencode(state, m.height)
+    if (version >= 2 && m.format) c.string.preencode(state, m.format)
+  },
+  encode(state, m) {
+    const flags =
+      (version >= 2 && m.path ? 1 : 0) |
+      (version >= 2 && m.httpLink ? 2 : 0) |
+      (version >= 2 && m.buffer ? 4 : 0) |
+      (version >= 2 && m.mimetype ? 8 : 0) |
+      (version >= 2 && m.left ? 16 : 0) |
+      (version >= 2 && m.top ? 32 : 0) |
+      (version >= 2 && m.width ? 64 : 0) |
+      (version >= 2 && m.height ? 128 : 0) |
+      (version >= 2 && m.format ? 256 : 0)
+
+    c.uint.encode(state, flags)
+
+    if (version >= 2 && m.path) c.string.encode(state, m.path)
+    if (version >= 2 && m.httpLink) c.string.encode(state, m.httpLink)
+    if (version >= 2 && m.buffer) c.buffer.encode(state, m.buffer)
+    if (version >= 2 && m.mimetype) c.string.encode(state, m.mimetype)
+    if (version >= 2 && m.left) c.uint.encode(state, m.left)
+    if (version >= 2 && m.top) c.uint.encode(state, m.top)
+    if (version >= 2 && m.width) c.uint.encode(state, m.width)
+    if (version >= 2 && m.height) c.uint.encode(state, m.height)
+    if (version >= 2 && m.format) c.string.encode(state, m.format)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      path: version >= 2 && (flags & 1) !== 0 ? c.string.decode(state) : null,
+      httpLink:
+        version >= 2 && (flags & 2) !== 0 ? c.string.decode(state) : null,
+      buffer: version >= 2 && (flags & 4) !== 0 ? c.buffer.decode(state) : null,
+      mimetype:
+        version >= 2 && (flags & 8) !== 0 ? c.string.decode(state) : null,
+      left: version >= 2 && (flags & 16) !== 0 ? c.uint.decode(state) : 0,
+      top: version >= 2 && (flags & 32) !== 0 ? c.uint.decode(state) : 0,
+      width: version >= 2 && (flags & 64) !== 0 ? c.uint.decode(state) : 0,
+      height: version >= 2 && (flags & 128) !== 0 ? c.uint.decode(state) : 0,
+      format:
+        version >= 2 && (flags & 256) !== 0 ? c.string.decode(state) : null
+    }
+  }
+}
+
+// @media/crop-image-response.metadata
+const encoding8_0 = encoding2_0
+
+// @media/crop-image-response
+const encoding8 = {
+  preencode(state, m) {
+    state.end++ // max flag is 2 so always one byte
+
+    if (version >= 2 && m.metadata) encoding8_0.preencode(state, m.metadata)
+    if (version >= 2 && m.data) c.buffer.preencode(state, m.data)
+  },
+  encode(state, m) {
+    const flags =
+      (version >= 2 && m.metadata ? 1 : 0) | (version >= 2 && m.data ? 2 : 0)
+
+    c.uint.encode(state, flags)
+
+    if (version >= 2 && m.metadata) encoding8_0.encode(state, m.metadata)
+    if (version >= 2 && m.data) c.buffer.encode(state, m.data)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      metadata:
+        version >= 2 && (flags & 1) !== 0 ? encoding8_0.decode(state) : null,
+      data: version >= 2 && (flags & 2) !== 0 ? c.buffer.decode(state) : null
+    }
+  }
+}
+
 function setVersion(v) {
   version = v
 }
@@ -297,6 +399,10 @@ function getEncoding(name) {
       return encoding5
     case '@media/decode-image-response':
       return encoding6
+    case '@media/crop-image-request':
+      return encoding7
+    case '@media/crop-image-response':
+      return encoding8
     default:
       throw new Error('Encoder not found ' + name)
   }

package/shared/spec/schema/index.js

@@ -1,11 +1,12 @@
 // This file is autogenerated by the hyperschema compiler
-// Schema Version: 1
+// Schema Version: 2
 /* eslint-disable camelcase */
 /* eslint-disable quotes */
+/* eslint-disable space-before-function-paren */
 
 import { c } from 'hyperschema/runtime'
 
-const VERSION = 1
+const VERSION = 2
 
 // eslint-disable-next-line no-unused-vars
 let version = VERSION
@@ -260,6 +261,107 @@ const encoding6 = {
   }
 }
 
+// @media/crop-image-request
+const encoding7 = {
+  preencode(state, m) {
+    const flags =
+      (version >= 2 && m.path ? 1 : 0) |
+      (version >= 2 && m.httpLink ? 2 : 0) |
+      (version >= 2 && m.buffer ? 4 : 0) |
+      (version >= 2 && m.mimetype ? 8 : 0) |
+      (version >= 2 && m.left ? 16 : 0) |
+      (version >= 2 && m.top ? 32 : 0) |
+      (version >= 2 && m.width ? 64 : 0) |
+      (version >= 2 && m.height ? 128 : 0) |
+      (version >= 2 && m.format ? 256 : 0)
+
+    c.uint.preencode(state, flags)
+
+    if (version >= 2 && m.path) c.string.preencode(state, m.path)
+    if (version >= 2 && m.httpLink) c.string.preencode(state, m.httpLink)
+    if (version >= 2 && m.buffer) c.buffer.preencode(state, m.buffer)
+    if (version >= 2 && m.mimetype) c.string.preencode(state, m.mimetype)
+    if (version >= 2 && m.left) c.uint.preencode(state, m.left)
+    if (version >= 2 && m.top) c.uint.preencode(state, m.top)
+    if (version >= 2 && m.width) c.uint.preencode(state, m.width)
+    if (version >= 2 && m.height) c.uint.preencode(state, m.height)
+    if (version >= 2 && m.format) c.string.preencode(state, m.format)
+  },
+  encode(state, m) {
+    const flags =
+      (version >= 2 && m.path ? 1 : 0) |
+      (version >= 2 && m.httpLink ? 2 : 0) |
+      (version >= 2 && m.buffer ? 4 : 0) |
+      (version >= 2 && m.mimetype ? 8 : 0) |
+      (version >= 2 && m.left ? 16 : 0) |
+      (version >= 2 && m.top ? 32 : 0) |
+      (version >= 2 && m.width ? 64 : 0) |
+      (version >= 2 && m.height ? 128 : 0) |
+      (version >= 2 && m.format ? 256 : 0)
+
+    c.uint.encode(state, flags)
+
+    if (version >= 2 && m.path) c.string.encode(state, m.path)
+    if (version >= 2 && m.httpLink) c.string.encode(state, m.httpLink)
+    if (version >= 2 && m.buffer) c.buffer.encode(state, m.buffer)
+    if (version >= 2 && m.mimetype) c.string.encode(state, m.mimetype)
+    if (version >= 2 && m.left) c.uint.encode(state, m.left)
+    if (version >= 2 && m.top) c.uint.encode(state, m.top)
+    if (version >= 2 && m.width) c.uint.encode(state, m.width)
+    if (version >= 2 && m.height) c.uint.encode(state, m.height)
+    if (version >= 2 && m.format) c.string.encode(state, m.format)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      path: version >= 2 && (flags & 1) !== 0 ? c.string.decode(state) : null,
+      httpLink:
+        version >= 2 && (flags & 2) !== 0 ? c.string.decode(state) : null,
+      buffer: version >= 2 && (flags & 4) !== 0 ? c.buffer.decode(state) : null,
+      mimetype:
+        version >= 2 && (flags & 8) !== 0 ? c.string.decode(state) : null,
+      left: version >= 2 && (flags & 16) !== 0 ? c.uint.decode(state) : 0,
+      top: version >= 2 && (flags & 32) !== 0 ? c.uint.decode(state) : 0,
+      width: version >= 2 && (flags & 64) !== 0 ? c.uint.decode(state) : 0,
+      height: version >= 2 && (flags & 128) !== 0 ? c.uint.decode(state) : 0,
+      format:
+        version >= 2 && (flags & 256) !== 0 ? c.string.decode(state) : null
+    }
+  }
+}
+
+// @media/crop-image-response.metadata
+const encoding8_0 = encoding2_0
+
+// @media/crop-image-response
+const encoding8 = {
+  preencode(state, m) {
+    state.end++ // max flag is 2 so always one byte
+
+    if (version >= 2 && m.metadata) encoding8_0.preencode(state, m.metadata)
+    if (version >= 2 && m.data) c.buffer.preencode(state, m.data)
+  },
+  encode(state, m) {
+    const flags =
+      (version >= 2 && m.metadata ? 1 : 0) | (version >= 2 && m.data ? 2 : 0)
+
+    c.uint.encode(state, flags)
+
+    if (version >= 2 && m.metadata) encoding8_0.encode(state, m.metadata)
+    if (version >= 2 && m.data) c.buffer.encode(state, m.data)
+  },
+  decode(state) {
+    const flags = c.uint.decode(state)
+
+    return {
+      metadata:
+        version >= 2 && (flags & 1) !== 0 ? encoding8_0.decode(state) : null,
+      data: version >= 2 && (flags & 2) !== 0 ? c.buffer.decode(state) : null
+    }
+  }
+}
+
 function setVersion(v) {
   version = v
 }
@@ -297,6 +399,10 @@ function getEncoding(name) {
       return encoding5
     case '@media/decode-image-response':
       return encoding6
+    case '@media/crop-image-request':
+      return encoding7
+    case '@media/crop-image-response':
+      return encoding8
     default:
       throw new Error('Encoder not found ' + name)
   }

package/shared/spec/schema/schema.json

@@ -1,5 +1,5 @@
 {
-  "version": 1,
+  "version": 2,
   "schema": [
     {
       "name": "dimensions",
@@ -190,6 +190,77 @@
           "version": 1
         }
       ]
+    },
+    {
+      "name": "crop-image-request",
+      "namespace": "media",
+      "compact": false,
+      "flagsPosition": 0,
+      "fields": [
+        {
+          "name": "path",
+          "type": "string",
+          "version": 2
+        },
+        {
+          "name": "httpLink",
+          "type": "string",
+          "version": 2
+        },
+        {
+          "name": "buffer",
+          "type": "buffer",
+          "version": 2
+        },
+        {
+          "name": "mimetype",
+          "type": "string",
+          "version": 2
+        },
+        {
+          "name": "left",
+          "type": "uint",
+          "version": 2
+        },
+        {
+          "name": "top",
+          "type": "uint",
+          "version": 2
+        },
+        {
+          "name": "width",
+          "type": "uint",
+          "version": 2
+        },
+        {
+          "name": "height",
+          "type": "uint",
+          "version": 2
+        },
+        {
+          "name": "format",
+          "type": "string",
+          "version": 2
+        }
+      ]
+    },
+    {
+      "name": "crop-image-response",
+      "namespace": "media",
+      "compact": false,
+      "flagsPosition": 0,
+      "fields": [
+        {
+          "name": "metadata",
+          "type": "@media/metadata",
+          "version": 2
+        },
+        {
+          "name": "data",
+          "type": "buffer",
+          "version": 2
+        }
+      ]
     }
   ]
 }

package/shared/spec/schema.js

@@ -154,3 +154,59 @@ media.register({
     }
   ]
 })
+
+media.register({
+  name: 'crop-image-request',
+  fields: [
+    {
+      name: 'path',
+      type: 'string'
+    },
+    {
+      name: 'httpLink',
+      type: 'string'
+    },
+    {
+      name: 'buffer',
+      type: 'buffer'
+    },
+    {
+      name: 'mimetype',
+      type: 'string'
+    },
+    {
+      name: 'left',
+      type: 'uint'
+    },
+    {
+      name: 'top',
+      type: 'uint'
+    },
+    {
+      name: 'width',
+      type: 'uint'
+    },
+    {
+      name: 'height',
+      type: 'uint'
+    },
+    {
+      name: 'format',
+      type: 'string'
+    }
+  ]
+})
+
+media.register({
+  name: 'crop-image-response',
+  fields: [
+    {
+      name: 'metadata',
+      type: '@media/metadata'
+    },
+    {
+      name: 'data',
+      type: 'buffer'
+    }
+  ]
+})

package/worker/index.js

@@ -18,6 +18,7 @@ const rpc = new HRPC(stream)
 
 rpc.onCreatePreview(media.createPreview)
 rpc.onDecodeImage(media.decodeImage)
+rpc.onCropImage(media.cropImage)
 
 uncaughts.on((err) => {
   log('Uncaught error:', err)

package/worker/media.js

@@ -1,10 +1,11 @@
 import b4a from 'b4a'
-import fs from 'bare-fs'
-import fetch from 'bare-fetch'
-import getMimeType from 'get-mime-type'
 
-import { importCodec, supportsQuality } from '../shared/codecs.js'
-import { calculateFitDimensions } from './util'
+import {
+  importCodec,
+  isCodecSupported,
+  supportsQuality
+} from '../shared/codecs.js'
+import { getBuffer, detectMimeType, calculateFitDimensions } from './util'
 
 const DEFAULT_PREVIEW_FORMAT = 'image/webp'
 
@@ -22,10 +23,15 @@ export async function createPreview({
   format,
   encoding
 }) {
-  mimetype = mimetype || getMimeType(path)
   format = format || DEFAULT_PREVIEW_FORMAT
 
   const buff = await getBuffer({ path, httpLink, buffer })
+  mimetype = mimetype || detectMimeType(buff, path)
+
+  if (!isCodecSupported(mimetype)) {
+    throw new Error(`Unsupported file type: No codec available for ${mimetype}`)
+  }
+
   const rgba = await decodeImageToRGBA(buff, mimetype, maxFrames)
   const { width, height } = rgba
 
@@ -118,6 +124,11 @@ export async function createPreview({
 
 export async function decodeImage({ path, httpLink, buffer, mimetype }) {
   const buff = await getBuffer({ path, httpLink, buffer })
+  mimetype = mimetype || detectMimeType(buff, path)
+
+  if (!isCodecSupported(mimetype)) {
+    throw new Error(`Unsupported file type: No codec available for ${mimetype}`)
+  }
 
   const rgba = await decodeImageToRGBA(buff, mimetype)
   const { width, height, data } = rgba
@@ -130,21 +141,39 @@ export async function decodeImage({ path, httpLink, buffer, mimetype }) {
   }
 }
 
-async function getBuffer({ path, httpLink, buffer }) {
-  if (buffer) return buffer
+export async function cropImage({
+  path,
+  httpLink,
+  buffer,
+  mimetype,
+  left,
+  top,
+  width,
+  height,
+  format
+}) {
+  const buff = await getBuffer({ path, httpLink, buffer })
+  mimetype = mimetype || detectMimeType(buff, path)
 
-  if (path) {
-    return fs.readFileSync(path)
+  if (!isCodecSupported(mimetype)) {
+    throw new Error(`Unsupported file type: No codec available for ${mimetype}`)
   }
 
-  if (httpLink) {
-    const response = await fetch(httpLink)
-    return await response.buffer()
-  }
+  const rgba = await decodeImageToRGBA(buff, mimetype)
+
+  const cropped = await cropRGBA(rgba, left, top, width, height)
 
-  throw new Error(
-    'At least one of "path", "httpLink" or "buffer" must be provided'
-  )
+  const data = await encodeImageFromRGBA(cropped, format || mimetype)
+
+  return {
+    metadata: {
+      dimensions: {
+        width: rgba.width,
+        height: rgba.height
+      }
+    },
+    data
+  }
 }
 
 async function decodeImageToRGBA(buffer, mimetype, maxFrames) {
@@ -214,3 +243,32 @@ async function resizeRGBA(rgba, maxWidth, maxHeight) {
 
   return maybeResizedRGBA
 }
+
+async function cropRGBA(rgba, left, top, width, height) {
+  if (
+    left < 0 ||
+    top < 0 ||
+    width <= 0 ||
+    height <= 0 ||
+    left + width > rgba.width ||
+    top + height > rgba.height
+  ) {
+    throw new Error('Crop rectangle out of bounds')
+  }
+
+  const data = Buffer.alloc(width * height * 4)
+
+  for (let y = 0; y < height; y++) {
+    for (let x = 0; x < width; x++) {
+      const srcIndex = ((y + top) * rgba.width + (x + left)) * 4
+      const dstIndex = (y * width + x) * 4
+
+      data[dstIndex] = rgba.data[srcIndex]
+      data[dstIndex + 1] = rgba.data[srcIndex + 1]
+      data[dstIndex + 2] = rgba.data[srcIndex + 2]
+      data[dstIndex + 3] = rgba.data[srcIndex + 3]
+    }
+  }
+
+  return { width, height, data }
+}

package/worker/util.js

@@ -1,5 +1,31 @@
+import fs from 'bare-fs'
+import fetch from 'bare-fetch'
+import getMimeType from 'get-mime-type'
+import getFileFormat from 'get-file-format'
+
 export const log = (...args) => console.log('[bare-media]', ...args)
 
+export 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'
+  )
+}
+
+export function detectMimeType(buffer, path) {
+  return getMimeType(getFileFormat(buffer)) || getMimeType(path)
+}
+
 export function calculateFitDimensions(width, height, maxWidth, maxHeight) {
   if (width <= maxWidth && height <= maxHeight) {
     return { width, height }