bare-media 1.3.0 → 1.5.0

package/README.md

@@ -49,13 +49,36 @@ const data = await createPreview({ path, maxWidth, maxHeight })
 
 ## API
 
-| Method          | Parameters                                              | Return Value        | Description                        |
-| --------------- | ------------------------------------------------------- | ------------------- | ---------------------------------- |
-| `createPreview` | `path, mimetype, maxWidth, maxHeight, format, encoding` | `metadata, preview` | Create a preview from a media file |
-| `decodeImage`   | `path`, `httpLink, mimetype`                            | `metadata, data`    | Decode an image to RGBA            |
-
 > See [schema.js](shared/spec/schema.js) for the complete reference of parameters
 
+### createPreview()
+
+Create a preview from a media file
+
+| 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 `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
 
 Apache-2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-media",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "main": "index.js",
   "type": "module",
   "scripts": {

package/shared/codecs.js

@@ -19,3 +19,7 @@ export async function importCodec(mimetype) {
   if (!codecImport) throw new Error(`No codec for ${mimetype}`)
   return await codecImport()
 }
+
+export function supportsQuality(mimetype) {
+  return { 'image/webp': true, 'image/jpeg': true }[mimetype] || false
+}

package/shared/spec/hrpc/index.js

@@ -1,5 +1,6 @@
 // This file is autogenerated by the hrpc compiler
 /* eslint-disable camelcase */
+/* eslint-disable space-before-function-paren */
 
 import { c, RPC, RPCStream, RPCRequestStream } from 'hrpc/runtime'
 import { getEncoding } from './messages.js'
@@ -140,8 +141,11 @@ class HRPC {
     return [].includes(command)
   }
 
+  // prettier-ignore-start
   _requestIsSend(command) {
-    return [].includes(command)
+    return [
+      // prettier-ignore
+    ].includes(command)
   }
 }
 

package/shared/spec/hrpc/messages.js

@@ -100,43 +100,71 @@ const encoding2 = {
 // @media/create-preview-request
 const encoding3 = {
   preencode(state, m) {
-    c.string.preencode(state, m.path)
-    state.end++ // max flag is 16 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)
+    if (m.maxFrames) c.uint.preencode(state, m.maxFrames)
+    if (m.maxBytes) c.uint.preencode(state, m.maxBytes)
     if (m.format) c.string.preencode(state, m.format)
     if (m.encoding) c.string.preencode(state, m.encoding)
   },
   encode(state, m) {
     const flags =
-      (m.mimetype ? 1 : 0) |
-      (m.maxWidth ? 2 : 0) |
-      (m.maxHeight ? 4 : 0) |
-      (m.format ? 8 : 0) |
-      (m.encoding ? 16 : 0)
+      (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.string.encode(state, m.path)
     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)
+    if (m.maxFrames) c.uint.encode(state, m.maxFrames)
+    if (m.maxBytes) c.uint.encode(state, m.maxBytes)
     if (m.format) c.string.encode(state, m.format)
     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,
-      format: (flags & 8) !== 0 ? c.string.decode(state) : null,
-      encoding: (flags & 16) !== 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
     }
   }
 }
@@ -170,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) {
@@ -191,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,43 +100,71 @@ const encoding2 = {
 // @media/create-preview-request
 const encoding3 = {
   preencode(state, m) {
-    c.string.preencode(state, m.path)
-    state.end++ // max flag is 16 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)
+    if (m.maxFrames) c.uint.preencode(state, m.maxFrames)
+    if (m.maxBytes) c.uint.preencode(state, m.maxBytes)
     if (m.format) c.string.preencode(state, m.format)
     if (m.encoding) c.string.preencode(state, m.encoding)
   },
   encode(state, m) {
     const flags =
-      (m.mimetype ? 1 : 0) |
-      (m.maxWidth ? 2 : 0) |
-      (m.maxHeight ? 4 : 0) |
-      (m.format ? 8 : 0) |
-      (m.encoding ? 16 : 0)
+      (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.string.encode(state, m.path)
     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)
+    if (m.maxFrames) c.uint.encode(state, m.maxFrames)
+    if (m.maxBytes) c.uint.encode(state, m.maxBytes)
     if (m.format) c.string.encode(state, m.format)
     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,
-      format: (flags & 8) !== 0 ? c.string.decode(state) : null,
-      encoding: (flags & 16) !== 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
     }
   }
 }
@@ -170,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) {
@@ -191,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",
@@ -94,6 +103,16 @@
           "type": "uint",
           "version": 1
         },
+        {
+          "name": "maxFrames",
+          "type": "uint",
+          "version": 1
+        },
+        {
+          "name": "maxBytes",
+          "type": "uint",
+          "version": 1
+        },
         {
           "name": "format",
           "type": "string",
@@ -142,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',
@@ -77,6 +84,14 @@ media.register({
       name: 'maxHeight',
       type: 'uint'
     },
+    {
+      name: 'maxFrames',
+      type: 'uint'
+    },
+    {
+      name: 'maxBytes',
+      type: 'uint'
+    },
     {
       name: 'format',
       type: 'string'
@@ -115,6 +130,10 @@ media.register({
       name: 'httpLink',
       type: 'string'
     },
+    {
+      name: 'buffer',
+      type: 'buffer'
+    },
     {
       name: 'mimetype',
       type: 'string'

package/worker/media.js

@@ -3,7 +3,7 @@ import fs from 'bare-fs'
 import fetch from 'bare-fetch'
 import getMimeType from 'get-mime-type'
 
-import { importCodec } from '../shared/codecs.js'
+import { importCodec, supportsQuality } from '../shared/codecs.js'
 import { calculateFitDimensions } from './util'
 
 const DEFAULT_PREVIEW_FORMAT = 'image/webp'
@@ -12,22 +12,92 @@ const animatableMimetypes = ['image/webp']
 
 export async function createPreview({
   path,
+  httpLink,
+  buffer,
   mimetype,
   maxWidth,
   maxHeight,
+  maxFrames,
+  maxBytes,
   format,
   encoding
 }) {
   mimetype = mimetype || getMimeType(path)
   format = format || DEFAULT_PREVIEW_FORMAT
 
-  const buffer = fs.readFileSync(path)
-  const rgba = await decodeImageToRGBA(buffer, mimetype)
+  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)
 
-  const encoded = await encodeImageFromRGBA(maybeResizedRGBA, format, encoding)
+  let preview = await encodeImageFromRGBA(maybeResizedRGBA, format)
+
+  // quality reduction
+
+  if (maxBytes && preview.byteLength > maxBytes && supportsQuality(format)) {
+    const MIN_QUALITY = 50
+    for (let quality = 80; quality >= MIN_QUALITY; quality -= 15) {
+      preview = await encodeImageFromRGBA(maybeResizedRGBA, format, { quality })
+      if (preview.byteLength <= maxBytes) {
+        break
+      }
+    }
+  }
+
+  // fps reduction
+
+  if (
+    maxBytes &&
+    preview.byteLength > maxBytes &&
+    maybeResizedRGBA.frames?.length > 1
+  ) {
+    const quality = 75
+
+    // drop every n frame
+
+    for (const dropEvery of [4, 3, 2]) {
+      const frames = maybeResizedRGBA.frames.filter(
+        (frame, index) => index % dropEvery !== 0
+      )
+      const filtered = { ...maybeResizedRGBA, frames }
+      preview = await encodeImageFromRGBA(filtered, format, { quality })
+      if (!maxBytes || preview.byteLength <= maxBytes) {
+        break
+      }
+    }
+
+    // cap to 25 frames
+
+    if (preview.byteLength > maxBytes) {
+      const frames = maybeResizedRGBA.frames
+        .slice(0, 50)
+        .filter((frame, index) => index % 2 === 0)
+      const capped = { ...maybeResizedRGBA, frames }
+      preview = await encodeImageFromRGBA(capped, format, { quality })
+    }
+
+    // take only one frame
+
+    if (preview.byteLength > maxBytes) {
+      const oneFrame = {
+        ...maybeResizedRGBA,
+        frames: maybeResizedRGBA.frames.slice(0, 1)
+      }
+      preview = await encodeImageFromRGBA(oneFrame, format)
+    }
+  }
+
+  if (maxBytes && preview.byteLength > maxBytes) {
+    throw new Error(
+      `Could not create preview under maxBytes, reached ${preview.byteLength} bytes`
+    )
+  }
+
+  const encoded =
+    encoding === 'base64'
+      ? { inlined: b4a.toString(preview, 'base64') }
+      : { buffer: preview }
 
   return {
     metadata: {
@@ -46,17 +116,10 @@ export async function createPreview({
   }
 }
 
-export async function decodeImage({ path, httpLink, mimetype }) {
-  let buffer
-
-  if (path) {
-    buffer = fs.readFileSync(path)
-  } else if (httpLink) {
-    const response = await fetch(httpLink)
-    buffer = await response.buffer()
-  }
+export async function decodeImage({ path, httpLink, buffer, mimetype }) {
+  const buff = await getBuffer({ path, httpLink, buffer })
 
-  const rgba = await decodeImageToRGBA(buffer, mimetype)
+  const rgba = await decodeImageToRGBA(buff, mimetype)
   const { width, height, data } = rgba
 
   return {
@@ -67,7 +130,24 @@ export async function decodeImage({ path, httpLink, mimetype }) {
   }
 }
 
-async function decodeImageToRGBA(buffer, 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
 
   const codec = await importCodec(mimetype)
@@ -76,6 +156,7 @@ async function decodeImageToRGBA(buffer, mimetype) {
     const { width, height, loops, frames } = codec.decodeAnimated(buffer)
     const data = []
     for (const frame of frames) {
+      if (maxFrames > 0 && data.length >= maxFrames) break
       data.push(frame)
     }
     rgba = { width, height, loops, frames: data }
@@ -86,19 +167,17 @@ async function decodeImageToRGBA(buffer, mimetype) {
   return rgba
 }
 
-async function encodeImageFromRGBA(rgba, format, encoding) {
+async function encodeImageFromRGBA(rgba, format, opts) {
   const codec = await importCodec(format)
 
   let encoded
   if (Array.isArray(rgba.frames)) {
-    encoded = codec.encodeAnimated(rgba)
+    encoded = codec.encodeAnimated(rgba, opts)
   } else {
-    encoded = codec.encode(rgba)
+    encoded = codec.encode(rgba, opts)
   }
 
-  return encoding === 'base64'
-    ? { inlined: b4a.toString(encoded, 'base64') }
-    : { buffer: encoded }
+  return encoded
 }
 
 async function resizeRGBA(rgba, maxWidth, maxHeight) {