bare-ffmpeg 1.0.0-25 → 1.0.0-27

package/README.md

@@ -407,6 +407,20 @@ Gets or sets the frame height for video codecs.
 
 **Returns**: `number`
 
+##### `CodecContext.frameSize`
+
+Gets the number of samples per channel in an audio frame.
+
+**Returns**: `number`
+
+##### `CodecContext.frameNum`
+
+When encoding this gets the total number of frames passed to the encoder so far.
+
+When decoding this gets the total number of frames returned from the decoder so far.
+
+**Returns**: `number`
+
 #### Methods
 
 ##### `CodecContext.open([options])`
@@ -459,6 +473,52 @@ Parameters:
 
 **Returns**: `boolean` indicating if a packet was received
 
+##### `CodecContext.getSupportedConfig(config)`
+
+Gets the supported values for a codec configuration option.
+
+Parameters:
+
+- `config` (`number`): The configuration type from `ffmpeg.constants.codecConfig`
+
+**Returns**:
+
+- For `PIX_FORMAT`, `SAMPLE_FORMAT`, `COLOR_RANGE`, `COLOR_SPACE`: `Int32Array` of supported values (all valid values are included if the codec has no restrictions)
+- For `SAMPLE_RATE`: `Int32Array` of supported sample rates or `null` if the codec accepts any valid sample rate
+- For `FRAME_RATE`: Array of `Rational` instances or `null` if the codec accepts any valid frame rate
+- For `CHANNEL_LAYOUT`: Array of `ChannelLayout` instances or `null` if the codec accepts any valid channel layout
+
+**Throws**: Error if the config type is not applicable to this codec (e.g., asking for pixel formats from an audio codec)
+
+Examples:
+
+```js
+const codecCtx = new ffmpeg.CodecContext(ffmpeg.Codec.AV1.encoder)
+
+const pixelFormats = codecCtx.getSupportedConfig(
+  ffmpeg.constants.codecConfig.PIX_FORMAT
+)
+if (pixelFormats) {
+  console.log('Supported pixel formats:', pixelFormats)
+}
+
+const frameRates = codecCtx.getSupportedConfig(
+  ffmpeg.constants.codecConfig.FRAME_RATE
+)
+if (frameRates) {
+  frameRates.forEach((rate) => {
+    console.log(`${rate.toNumber()} fps`)
+  })
+}
+
+const layouts = codecCtx.getSupportedConfig(
+  ffmpeg.constants.codecConfig.CHANNEL_LAYOUT
+)
+if (layouts) {
+  console.log('Supported channel layouts:', layouts)
+}
+```
+
 ##### `CodecContext.destroy()`
 
 Destroys the `CodecContext` and frees all associated resources. Automatically called when the object is managed by a `using` declaration.
@@ -752,6 +812,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 +838,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.
@@ -1127,6 +1260,94 @@ Destroys the `Scaler` and frees all associated resources. Automatically called w
 
 **Returns**: `void`
 
+### `Filter`
+
+The `Filter` API provides access to FFmpeg filters by name.
+
+```js
+const filter = new ffmpeg.Filter(name)
+```
+
+Parameters:
+
+- `name` (`string`): The filter name (e.g., `'scale'`, `'buffer'`, `'overlay'`)
+
+**Returns**: A new `Filter` instance
+
+#### Example
+
+```js
+const filter = new ffmpeg.Filter('buffer')
+```
+
+### `FilterGraph`
+
+The `FilterGraph` API provides functionality to create and manage complex filter chains for audio and video processing.
+
+```js
+const graph = new ffmpeg.FilterGraph()
+```
+
+**Returns**: A new `FilterGraph` instance
+
+#### Methods
+
+##### `FilterGraph.createFilter(context, filter, name, args)`
+
+Creates a filter within the filter graph with the specified parameters.
+
+Parameters:
+
+- `context` (`FilterContext`): The filter context to associate with this filter
+- `filter` (`Filter`): The filter to create (e.g., `new ffmpeg.Filter('buffer')`)
+- `name` (`string`): A unique name for this filter instance
+- `args` (`object` | `undefined`): Filter-specific arguments
+  - `width` (`number`): Video width in pixels
+  - `height` (`number`): Video height in pixels
+  - `pixelFormat` (`number`): Pixel format constant
+  - `timeBase` (`Rational`): Time base for the filter
+  - `aspectRatio` (`Rational`): Pixel aspect ratio
+
+**Returns**: `void`
+
+```js
+using graph = new ffmpeg.FilterGraph()
+const context = new ffmpeg.FilterContext()
+const filter = new ffmpeg.Filter('buffer')
+
+graph.createFilter(context, filter, 'in', {
+  width: 1920,
+  height: 1080,
+  pixelFormat: ffmpeg.constants.pixelFormats.RGB24,
+  timeBase: new ffmpeg.Rational(1, 30),
+  aspectRatio: new ffmpeg.Rational(1, 1)
+})
+```
+
+##### `FilterGraph.parse(filterDescription, inputs, outputs)`
+
+Parses a filter description string and applies it to the filter graph.
+
+Parameters:
+
+- `filterDescription` (`string`): The filter description (e.g., `'negate'`, `'scale=640:480'`)
+- `inputs` (`FilterInOut`): Input filter endpoints
+- `outputs` (`FilterInOut`): Output filter endpoints
+
+**Returns**: `void`
+
+##### `FilterGraph.configure()`
+
+Configures the filter graph and validates all connections.
+
+**Returns**: `void`
+
+##### `FilterGraph.destroy()`
+
+Destroys the `FilterGraph` and frees all associated resources including any created filters. Automatically called when the object is managed by a `using` declaration.
+
+**Returns**: `void`
+
 ### `AudioFIFO`
 
 The `AudioFIFO` API provides a first in first out buffer for audio samples. This is useful for buffering audio data between different processing stages.
@@ -1219,6 +1440,84 @@ Destroys the `AudioFIFO` and frees all associated resources. Automatically calle
 
 **Returns**: `void`
 
+### `FilterInOut`
+
+The `FilterInOut` API provides functionality to represent input and output pads for FFmpeg filter graphs.
+
+```js
+const filterInOut = new ffmpeg.FilterInOut()
+```
+
+**Returns**: A new `FilterInOut` instance
+
+> **Note**: FilterInOut objects form a linked list structure in FFmpeg. When destroying a FilterInOut that has a `next` reference, the entire chain is automatically freed. Only destroy the head of the chain to avoid double-free errors.
+
+#### Properties
+
+##### `FilterInOut.name`
+
+Gets or sets the name identifier for this input/output pad.
+
+**Returns**: `string` or `undefined` if not set
+
+```js
+const filterInOut = new ffmpeg.FilterInOut()
+filterInOut.name = 'input'
+console.log(filterInOut.name) // 'input'
+```
+
+##### `FilterInOut.padIdx`
+
+Gets or sets the pad index within the filter context.
+
+**Returns**: `number`
+
+```js
+filterInOut.padIdx = 0
+console.log(filterInOut.padIdx) // 0
+```
+
+##### `FilterInOut.filterContext`
+
+Gets or sets the filter context associated with this input/output pad.
+
+**Returns**: `FilterContext` instance or `null` if not set
+
+> **Note**: FilterContext must be created through FilterGraph operations before it can be used effectively.
+
+##### `FilterInOut.next`
+
+Gets or sets the next FilterInOut in the linked list chain.
+
+**Returns**: `FilterInOut` instance or `null` if this is the last in the chain
+
+```js
+const input = new ffmpeg.FilterInOut()
+const output = new ffmpeg.FilterInOut()
+output.name = 'output'
+
+input.next = output
+console.log(input.next.name) // 'output'
+```
+
+#### Methods
+
+##### `FilterInOut.destroy()`
+
+Destroys the `FilterInOut` and frees all associated resources. **Important**: This automatically frees the entire linked list chain via FFmpeg's `avfilter_inout_free()`.
+
+**Returns**: `void`
+
+```js
+const head = new ffmpeg.FilterInOut()
+const next = new ffmpeg.FilterInOut()
+head.next = next
+
+// Only destroy the head - 'next' is automatically freed
+head.destroy()
+// DO NOT call next.destroy() - causes double-free error
+```
+
 ## License
 
 Apache-2.0