bare-ffmpeg 1.0.0-25 → 1.0.0-26

package/README.md

@@ -752,6 +752,18 @@ Gets the stream index this packet belongs to.
 
 **Returns**: `number`
 
+##### `Packet.isKeyFrame`
+
+Get or set the key frame flag.
+
+**Returns**: `boolean`
+
+##### `Packet.sideData`
+
+Gets or sets the side data associated with the packet.
+
+**Returns**: `Array<SideData>`
+
 #### Methods
 
 ##### `Packet.unref()`
@@ -766,6 +778,67 @@ Destroys the `Packet` and frees all associated resources. Automatically called w
 
 **Returns**: `void`
 
+### `SideData`
+
+The `SideData` API provides functionality to handle side data associated with packets. Side data contains additional metadata that may be useful for specific codecs or processing.
+
+```js
+const sideData = new ffmpeg.Packet.SideData(handle, options)
+```
+
+Parameters:
+
+- `handle` (`ArrayBuffer`): Internal side data handle
+- `options` (`object`, optional): Configuration options
+  - `type` (`number`): The side data type
+  - `data` (`Buffer`): The side data buffer
+
+**Returns**: A new `SideData` instance
+
+#### Static Methods
+
+##### `SideData.fromData(data, type)`
+
+Creates a new `SideData` instance from data and type.
+
+Parameters:
+
+- `data` (`Buffer`): The side data buffer
+- `type` (`number`): The side data type constant
+
+**Returns**: A new `SideData` instance
+
+#### Properties
+
+##### `SideData.type`
+
+Gets the side data type.
+
+**Returns**: `number`
+
+##### `SideData.name`
+
+Gets the human-readable name of the side data type.
+
+**Returns**: `string`
+
+##### `SideData.data`
+
+Gets the side data buffer.
+
+**Returns**: `Buffer`
+
+#### Example
+
+```js
+const packet = new ffmpeg.Packet()
+const sideData = ffmpeg.Packet.SideData.fromData(
+  Buffer.from('metadata'),
+  ffmpeg.constants.packetSideDataType.NEW_EXTRADATA
+)
+packet.sideData = [sideData]
+```
+
 ### `Image`
 
 The `Image` API provides functionality to create and manage image buffers.

package/binding.cc

@@ -103,6 +103,10 @@ typedef struct {
   AVAudioFifo *handle;
 } bare_ffmpeg_audio_fifo_t;
 
+typedef struct {
+  AVPacketSideData *handle;
+} bare_ffmpeg_side_data_t;
+
 static uv_once_t bare_ffmpeg__init_guard = UV_ONCE_INIT;
 
 static inline bool
@@ -817,6 +821,11 @@ bare_ffmpeg_get_codec_name_by_id(js_env_t *env, js_receiver_t, uint32_t id) {
   return std::string(name);
 }
 
+static std::string
+bare_ffmpeg_get_sample_format_name_by_id(js_env_t *env, js_receiver_t, uint32_t id) {
+  return av_get_sample_fmt_name(static_cast<enum AVSampleFormat>(id));
+}
+
 static js_arraybuffer_t
 bare_ffmpeg_codec_context_init(
   js_env_t *env,
@@ -884,6 +893,49 @@ bare_ffmpeg_codec_context_set_flags(
   context->handle->flags = value;
 }
 
+static js_arraybuffer_t
+bare_ffmpeg_codec_context_get_extra_data(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_codec_context_t, 1> context
+) {
+  js_arraybuffer_t buffer;
+  int err = js_create_arraybuffer(
+    env,
+    context->handle->extradata,
+    static_cast<size_t>(context->handle->extradata_size),
+    buffer
+  );
+  assert(err == 0);
+
+  return buffer;
+}
+
+void
+bare_ffmpeg_codec_context_set_extra_data(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_codec_context_t, 1> context,
+  js_arraybuffer_t buffer,
+  uint32_t offset,
+  uint32_t len
+) {
+  std::span<uint8_t> view;
+  int err = js_get_arraybuffer_info(env, buffer, view);
+  assert(err == 0);
+
+  if (context->handle->extradata_size) {
+    av_free(context->handle->extradata);
+  }
+
+  context->handle->extradata = reinterpret_cast<uint8_t *>(av_malloc(len + AV_INPUT_BUFFER_PADDING_SIZE));
+
+  memset(&context->handle->extradata[len], 0, AV_INPUT_BUFFER_PADDING_SIZE);
+  memcpy(context->handle->extradata, &view[offset], len);
+
+  context->handle->extradata_size = static_cast<int>(len);
+}
+
 static int
 bare_ffmpeg_frame_get_format(
   js_env_t *env,
@@ -1809,6 +1861,25 @@ bare_ffmpeg_codec_parameters_set_video_delay(
   parameters->handle->video_delay = delay;
 }
 
+static int
+bare_ffmpeg_codec_parameters_get_frame_size(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_codec_parameters_t, 1> parameters
+) {
+  return parameters->handle->frame_size;
+}
+
+static void
+bare_ffmpeg_codec_parameters_set_frame_size(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_codec_parameters_t, 1> parameters,
+  int frame_size
+) {
+  parameters->handle->frame_size = frame_size;
+}
+
 static js_arraybuffer_t
 bare_ffmpeg_frame_init(js_env_t *env, js_receiver_t) {
   int err;
@@ -2318,6 +2389,62 @@ bare_ffmpeg_packet_set_data(
   memcpy(packet->handle->data, &data[offset], len);
 }
 
+static std::vector<js_arraybuffer_t>
+bare_ffmpeg_packet_get_side_data(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_packet_t, 1> packet
+) {
+  std::vector<js_arraybuffer_t> res{};
+
+  int count = packet->handle->side_data_elems;
+  if (count == 0) return res;
+
+  for (int i = 0; i < count; i++) {
+    js_arraybuffer_t handle;
+    bare_ffmpeg_side_data_t *sd;
+    int err = js_create_arraybuffer(env, sd, handle);
+    assert(err == 0);
+
+    sd->handle = &packet->handle->side_data[i];
+
+    res.push_back(handle);
+  }
+
+  return res;
+}
+
+static void
+bare_ffmpeg_packet_set_side_data(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_packet_t, 1> packet,
+  std::vector<js_object_t> side_data_array
+) {
+  for (js_object_t side_data : side_data_array) {
+    int err;
+
+    int32_t type;
+    err = js_get_property(env, side_data, "type", type);
+    assert(err == 0);
+
+    js_arraybuffer_span_t buf;
+    err = js_get_property(env, side_data, "buffer", buf);
+    assert(err == 0);
+
+    int32_t offset;
+    err = js_get_property(env, side_data, "offset", offset);
+    assert(err == 0);
+
+    int32_t len;
+    err = js_get_property(env, side_data, "length", len);
+    assert(err == 0);
+
+    uint8_t *data = av_packet_new_side_data(packet->handle, static_cast<AVPacketSideDataType>(type), static_cast<size_t>(len));
+    memcpy(data, &buf[static_cast<size_t>(offset)], static_cast<size_t>(len));
+  }
+}
+
 static bool
 bare_ffmpeg_packet_is_keyframe(
   js_env_t *,
@@ -2327,6 +2454,20 @@ bare_ffmpeg_packet_is_keyframe(
   return packet->handle->flags & AV_PKT_FLAG_KEY;
 }
 
+static void
+bare_ffmpeg_packet_set_is_keyframe(
+  js_env_t *,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_packet_t, 1> packet,
+  bool has_key_frame
+) {
+  if (has_key_frame) {
+    packet->handle->flags |= AV_PKT_FLAG_KEY;
+  } else {
+    packet->handle->flags &= ~AV_PKT_FLAG_KEY;
+  }
+}
+
 static int64_t
 bare_ffmpeg_packet_get_dts(
   js_env_t *env,
@@ -2469,6 +2610,40 @@ bare_ffmpeg_packet_set_flags(
   packet->handle->flags = value;
 }
 
+static int
+bare_ffmpeg_side_data_get_type(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_side_data_t, 1> side_data
+) {
+  return side_data->handle->type;
+}
+
+static std::string
+bare_ffmpeg_side_data_get_name(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_side_data_t, 1> side_data
+) {
+  return av_packet_side_data_name(side_data->handle->type);
+}
+
+static js_arraybuffer_t
+bare_ffmpeg_side_data_get_data(
+  js_env_t *env,
+  js_receiver_t,
+  js_arraybuffer_span_of_t<bare_ffmpeg_side_data_t, 1> side_data
+) {
+  js_arraybuffer_t handle;
+  uint8_t *buf;
+  int err = js_create_arraybuffer(env, side_data->handle->size, buf, handle);
+  assert(err == 0);
+
+  memcpy(buf, side_data->handle->data, side_data->handle->size);
+
+  return handle;
+}
+
 static js_arraybuffer_t
 bare_ffmpeg_scaler_init(
   js_env_t *env,
@@ -3020,6 +3195,7 @@ bare_ffmpeg_exports(js_env_t *env, js_value_t *exports) {
   V("findDecoderByID", bare_ffmpeg_find_decoder_by_id)
   V("findEncoderByID", bare_ffmpeg_find_encoder_by_id)
   V("getCodecNameByID", bare_ffmpeg_get_codec_name_by_id)
+  V("getSampleFormatNameByID", bare_ffmpeg_get_sample_format_name_by_id)
 
   V("initCodecContext", bare_ffmpeg_codec_context_init)
   V("destroyCodecContext", bare_ffmpeg_codec_context_destroy)
@@ -3045,6 +3221,8 @@ bare_ffmpeg_exports(js_env_t *env, js_value_t *exports) {
   V("setCodecContextGOPSize", bare_ffmpeg_codec_context_set_gop_size)
   V("getCodecContextFramerate", bare_ffmpeg_codec_context_get_framerate)
   V("setCodecContextFramerate", bare_ffmpeg_codec_context_set_framerate)
+  V("getCodecContextExtraData", bare_ffmpeg_codec_context_get_extra_data)
+  V("setCodecContextExtraData", bare_ffmpeg_codec_context_set_extra_data)
 
   V("sendCodecContextPacket", bare_ffmpeg_codec_context_send_packet)
   V("receiveCodecContextPacket", bare_ffmpeg_codec_context_receive_packet)
@@ -3099,6 +3277,8 @@ bare_ffmpeg_exports(js_env_t *env, js_value_t *exports) {
   V("setCodecParametersSampleAspectRatio", bare_ffmpeg_codec_parameters_set_sample_aspect_ratio)
   V("getCodecParametersVideoDelay", bare_ffmpeg_codec_parameters_get_video_delay)
   V("setCodecParametersVideoDelay", bare_ffmpeg_codec_parameters_set_video_delay)
+  V("getCodecParametersFrameSize", bare_ffmpeg_codec_parameters_get_frame_size)
+  V("setCodecParametersFrameSize", bare_ffmpeg_codec_parameters_set_frame_size)
 
   V("initFrame", bare_ffmpeg_frame_init)
   V("destroyFrame", bare_ffmpeg_frame_destroy)
@@ -3138,7 +3318,10 @@ bare_ffmpeg_exports(js_env_t *env, js_value_t *exports) {
   V("setPacketStreamIndex", bare_ffmpeg_packet_set_stream_index)
   V("getPacketData", bare_ffmpeg_packet_get_data)
   V("setPacketData", bare_ffmpeg_packet_set_data)
+  V("getPacketSideData", bare_ffmpeg_packet_get_side_data)
+  V("setPacketSideData", bare_ffmpeg_packet_set_side_data)
   V("isPacketKeyframe", bare_ffmpeg_packet_is_keyframe)
+  V("setPacketIsKeyFrame", bare_ffmpeg_packet_set_is_keyframe)
   V("getPacketDTS", bare_ffmpeg_packet_get_dts)
   V("setPacketDTS", bare_ffmpeg_packet_set_dts)
   V("getPacketPTS", bare_ffmpeg_packet_get_pts)
@@ -3151,6 +3334,10 @@ bare_ffmpeg_exports(js_env_t *env, js_value_t *exports) {
   V("getPacketFlags", bare_ffmpeg_packet_get_flags)
   V("setPacketFlags", bare_ffmpeg_packet_set_flags)
 
+  V("getSideDataType", bare_ffmpeg_side_data_get_type)
+  V("getSideDataName", bare_ffmpeg_side_data_get_name)
+  V("getSideDataBuffer", bare_ffmpeg_side_data_get_data)
+
   V("initScaler", bare_ffmpeg_scaler_init)
   V("destroyScaler", bare_ffmpeg_scaler_destroy)
   V("scaleScaler", bare_ffmpeg_scaler_scale)
@@ -3417,6 +3604,49 @@ bare_ffmpeg_exports(js_env_t *env, js_value_t *exports) {
   V(SEEK_CUR)
   V(SEEK_SET)
   V(SEEK_END)
+
+  V(AV_PKT_DATA_PALETTE)
+  V(AV_PKT_DATA_NEW_EXTRADATA)
+  V(AV_PKT_DATA_PARAM_CHANGE)
+  V(AV_PKT_DATA_H263_MB_INFO)
+  V(AV_PKT_DATA_REPLAYGAIN)
+  V(AV_PKT_DATA_DISPLAYMATRIX)
+  V(AV_PKT_DATA_STEREO3D)
+  V(AV_PKT_DATA_AUDIO_SERVICE_TYPE)
+  V(AV_PKT_DATA_QUALITY_STATS)
+  V(AV_PKT_DATA_FALLBACK_TRACK)
+  V(AV_PKT_DATA_CPB_PROPERTIES)
+  V(AV_PKT_DATA_SKIP_SAMPLES)
+  V(AV_PKT_DATA_JP_DUALMONO)
+  V(AV_PKT_DATA_STRINGS_METADATA)
+  V(AV_PKT_DATA_SUBTITLE_POSITION)
+  V(AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL)
+  V(AV_PKT_DATA_WEBVTT_IDENTIFIER)
+  V(AV_PKT_DATA_WEBVTT_SETTINGS)
+  V(AV_PKT_DATA_METADATA_UPDATE)
+  V(AV_PKT_DATA_MPEGTS_STREAM_ID)
+  V(AV_PKT_DATA_MASTERING_DISPLAY_METADATA)
+  V(AV_PKT_DATA_SPHERICAL)
+  V(AV_PKT_DATA_CONTENT_LIGHT_LEVEL)
+  V(AV_PKT_DATA_A53_CC)
+  V(AV_PKT_DATA_ENCRYPTION_INIT_INFO)
+  V(AV_PKT_DATA_ENCRYPTION_INFO)
+  V(AV_PKT_DATA_AFD)
+  V(AV_PKT_DATA_PRFT)
+  V(AV_PKT_DATA_ICC_PROFILE)
+  V(AV_PKT_DATA_DOVI_CONF)
+  V(AV_PKT_DATA_S12M_TIMECODE)
+  V(AV_PKT_DATA_DYNAMIC_HDR10_PLUS)
+  V(AV_PKT_DATA_IAMF_MIX_GAIN_PARAM)
+  V(AV_PKT_DATA_IAMF_DEMIXING_INFO_PARAM)
+  V(AV_PKT_DATA_IAMF_RECON_GAIN_INFO_PARAM)
+  V(AV_PKT_DATA_AMBIENT_VIEWING_ENVIRONMENT)
+  V(AV_PKT_DATA_FRAME_CROPPING)
+  V(AV_PKT_DATA_LCEVC)
+  V(AV_PKT_DATA_3D_REFERENCE_DISPLAYS)
+  V(AV_PKT_DATA_RTCP_SR)
+  V(AV_PKT_DATA_NB)
+
 #undef V
 
   return exports;

package/lib/codec-context.js

@@ -107,6 +107,19 @@ module.exports = class FFmpegCodecContext {
     binding.setCodecContextFlags(this._handle, value)
   }
 
+  get extraData() {
+    return Buffer.from(binding.getCodecContextExtraData(this._handle))
+  }
+
+  set extraData(value) {
+    binding.setCodecContextExtraData(
+      this._handle,
+      value.buffer,
+      value.byteOffset,
+      value.byteLength
+    )
+  }
+
   open(options) {
     if (this._opened) return
     this._opened = true
@@ -155,7 +168,8 @@ module.exports = class FFmpegCodecContext {
       sampleRate: this.sampleRate,
       timeBase: this.timeBase,
       channelLayout: this.channelLayout,
-      gopSize: this.gopSize
+      gopSize: this.gopSize,
+      extraData: this.extraData
     }
   }
 }

package/lib/codec-parameters.js

@@ -72,6 +72,14 @@ module.exports = class FFmpegCodecParameters {
     )
   }
 
+  get frameSize() {
+    return binding.getCodecParametersFrameSize(this._handle)
+  }
+
+  set frameSize(size) {
+    binding.setCodecParametersFrameSize(this._handle, size)
+  }
+
   get videoDelay() {
     return binding.getCodecParametersVideoDelay(this._handle)
   }

package/lib/constants.js

@@ -140,6 +140,50 @@ module.exports = exports = {
     CUR: binding.SEEK_CUR,
     SET: binding.SEEK_SET,
     END: binding.SEEK_END
+  },
+  packetSideDataType: {
+    PALETTE: binding.AV_PKT_DATA_PALETTE,
+    NEW_EXTRADATA: binding.AV_PKT_DATA_NEW_EXTRADATA,
+    PARAM_CHANGE: binding.AV_PKT_DATA_PARAM_CHANGE,
+    H263_MB_INFO: binding.AV_PKT_DATA_H263_MB_INFO,
+    REPLAYGAIN: binding.AV_PKT_DATA_REPLAYGAIN,
+    DISPLAYMATRIX: binding.AV_PKT_DATA_DISPLAYMATRIX,
+    STEREO3D: binding.AV_PKT_DATA_STEREO3D,
+    AUDIO_SERVICE_TYPE: binding.AV_PKT_DATA_AUDIO_SERVICE_TYPE,
+    QUALITY_STATS: binding.AV_PKT_DATA_QUALITY_STATS,
+    FALLBACK_TRACK: binding.AV_PKT_DATA_FALLBACK_TRACK,
+    CPB_PROPERTIES: binding.AV_PKT_DATA_CPB_PROPERTIES,
+    SKIP_SAMPLES: binding.AV_PKT_DATA_SKIP_SAMPLES,
+    JP_DUALMONO: binding.AV_PKT_DATA_JP_DUALMONO,
+    STRINGS_METADATA: binding.AV_PKT_DATA_STRINGS_METADATA,
+    SUBTITLE_POSITION: binding.AV_PKT_DATA_SUBTITLE_POSITION,
+    MATROSKA_BLOCKADDITIONAL: binding.AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
+    WEBVTT_IDENTIFIER: binding.AV_PKT_DATA_WEBVTT_IDENTIFIER,
+    WEBVTT_SETTINGS: binding.AV_PKT_DATA_WEBVTT_SETTINGS,
+    METADATA_UPDATE: binding.AV_PKT_DATA_METADATA_UPDATE,
+    MPEGTS_STREAM_ID: binding.AV_PKT_DATA_MPEGTS_STREAM_ID,
+    MASTERING_DISPLAY_METADATA: binding.AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
+    SPHERICAL: binding.AV_PKT_DATA_SPHERICAL,
+    CONTENT_LIGHT_LEVEL: binding.AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
+    A53_CC: binding.AV_PKT_DATA_A53_CC,
+    ENCRYPTION_INIT_INFO: binding.AV_PKT_DATA_ENCRYPTION_INIT_INFO,
+    ENCRYPTION_INFO: binding.AV_PKT_DATA_ENCRYPTION_INFO,
+    AFD: binding.AV_PKT_DATA_AFD,
+    PRFT: binding.AV_PKT_DATA_PRFT,
+    ICC_PROFILE: binding.AV_PKT_DATA_ICC_PROFILE,
+    DOVI_CONF: binding.AV_PKT_DATA_DOVI_CONF,
+    S12M_TIMECODE: binding.AV_PKT_DATA_S12M_TIMECODE,
+    DYNAMIC_HDR10_PLUS: binding.AV_PKT_DATA_DYNAMIC_HDR10_PLUS,
+    IAMF_MIX_GAIN_PARAM: binding.AV_PKT_DATA_IAMF_MIX_GAIN_PARAM,
+    IAMF_DEMIXING_INFO_PARAM: binding.AV_PKT_DATA_IAMF_DEMIXING_INFO_PARAM,
+    IAMF_RECON_GAIN_INFO_PARAM: binding.AV_PKT_DATA_IAMF_RECON_GAIN_INFO_PARAM,
+    AMBIENT_VIEWING_ENVIRONMENT:
+      binding.AV_PKT_DATA_AMBIENT_VIEWING_ENVIRONMENT,
+    FRAME_CROPPING: binding.AV_PKT_DATA_FRAME_CROPPING,
+    LCEVC: binding.AV_PKT_DATA_LCEVC,
+    '3D_REFERENCE_DISPLAYS': binding.AV_PKT_DATA_3D_REFERENCE_DISPLAYS,
+    RTCP_SR: binding.AV_PKT_DATA_RTCP_SR,
+    NB: binding.AV_PKT_DATA_NB
   }
 }
 
@@ -190,3 +234,7 @@ exports.toChannelLayout = function toChannelLayout(layout) {
     `Channel layout must be a number or string. Received ${typeof layout} (${layout})`
   )
 }
+
+exports.getSampleFormatName = function (sampleFormat) {
+  return binding.getSampleFormatNameByID(sampleFormat)
+}

package/lib/packet.js

@@ -1,6 +1,42 @@
 const binding = require('../binding')
 const Rational = require('./rational')
 
+class SideData {
+  constructor(handle, opts = {}) {
+    this._handle = handle
+    this._type = opts.type || null
+    this._data = opts.data || null
+  }
+
+  static fromData(data, type) {
+    return new SideData(null, { data, type })
+  }
+
+  get type() {
+    if (this._type) return this._type
+    return binding.getSideDataType(this._handle)
+  }
+
+  get name() {
+    if (!this._handle) return null
+    return binding.getSideDataName(this._handle)
+  }
+
+  get data() {
+    if (this._data) return this._data
+    return Buffer.from(binding.getSideDataBuffer(this._handle))
+  }
+
+  [Symbol.for('bare.inspect')]() {
+    return {
+      __proto__: { constructor: SideData },
+      type: this.type,
+      name: this.name,
+      data: this.data
+    }
+  }
+}
+
 module.exports = class FFmpegPacket {
   constructor(buffer) {
     if (buffer) {
@@ -44,10 +80,31 @@ module.exports = class FFmpegPacket {
     )
   }
 
+  get sideData() {
+    const handles = binding.getPacketSideData(this._handle)
+    return handles.map((handle) => new SideData(handle))
+  }
+
+  set sideData(values) {
+    binding.setPacketSideData(
+      this._handle,
+      values.map((value) => ({
+        buffer: value.data.buffer,
+        offset: value.data.byteOffset,
+        length: value.data.byteLength,
+        type: value.type
+      }))
+    )
+  }
+
   get isKeyframe() {
     return binding.isPacketKeyframe(this._handle)
   }
 
+  set isKeyframe(value) {
+    binding.setPacketIsKeyFrame(this._handle, value)
+  }
+
   get dts() {
     return binding.getPacketDTS(this._handle)
   }
@@ -115,3 +172,5 @@ module.exports = class FFmpegPacket {
     this.destroy()
   }
 }
+
+module.exports.SideData = SideData

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-ffmpeg",
-  "version": "1.0.0-25",
+  "version": "1.0.0-26",
   "description": "Low-level FFmpeg bindings for Bare",
   "exports": {
     ".": "./index.js",