mediabunny 1.0.2 → 1.0.4

package/dist/modules/conversion.d.ts

@@ -0,0 +1,158 @@
+/*!
+ * Copyright (c) 2025-present, Vanilagy and contributors
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+import { AudioCodec, VideoCodec } from './codec';
+import { Input } from './input';
+import { InputTrack } from './input-track';
+import { AudioEncodingConfig, VideoEncodingConfig } from './media-source';
+import { Rotation } from './misc';
+import { Output } from './output';
+import { AudioSample } from './sample';
+/**
+ * The options for media file conversion.
+ * @public
+ */
+export type ConversionOptions = {
+    /** The input file. */
+    input: Input;
+    /** The output file. */
+    output: Output;
+    /** Video-specific options. */
+    video?: {
+        /** If true, all video tracks will be discarded and will not be present in the output. */
+        discard?: boolean;
+        /**
+         * The desired width of the output video in pixels, defaulting to the video's natural display width. If height
+         * is not set, it will be deduced automatically based on aspect ratio.
+         */
+        width?: number;
+        /**
+         * The desired height of the output video in pixels, defaulting to the video's natural display height. If width
+         * is not set, it will be deduced automatically based on aspect ratio.
+         */
+        height?: number;
+        /**
+         * The fitting algorithm in case both width and height are set.
+         *
+         * - 'fill' will stretch the image to fill the entire box, potentially altering aspect ratio.
+         * - 'contain' will contain the entire image within the box while preserving aspect ratio. This may lead to
+         * letterboxing.
+         * - 'cover' will scale the image until the entire box is filled, while preserving aspect ratio.
+         */
+        fit?: 'fill' | 'contain' | 'cover';
+        /**
+         * The angle in degrees to rotate the input video by, clockwise. Rotation is applied before resizing. This
+         * rotation is _in addition to_ the natural rotation of the input video as specified in input file's metadata.
+         */
+        rotate?: Rotation;
+        /** The desired output video codec. */
+        codec?: VideoCodec;
+        /** The desired bitrate of the output video. */
+        bitrate?: VideoEncodingConfig['bitrate'];
+        /** When true, video will always be re-encoded instead of directly copying over the encoded samples. */
+        forceTranscode?: boolean;
+    };
+    /** Audio-specific options. */
+    audio?: {
+        /** If true, all audio tracks will be discarded and will not be present in the output. */
+        discard?: boolean;
+        /** The desired channel count of the output audio. */
+        numberOfChannels?: number;
+        /** The desired sample rate of the output audio, in hertz. */
+        sampleRate?: number;
+        /** The desired output audio codec. */
+        codec?: AudioCodec;
+        /** The desired bitrate of the output audio. */
+        bitrate?: AudioEncodingConfig['bitrate'];
+        /** When true, audio will always be re-encoded instead of directly copying over the encoded samples. */
+        forceTranscode?: boolean;
+    };
+    /** Options to trim the input file. */
+    trim?: {
+        /** The time in the input file in seconds at which the output file should start. Must be less than `end`.  */
+        start: number;
+        /** The time in the input file in seconds at which the output file should end. Must be greater than `start`. */
+        end: number;
+    };
+};
+/**
+ * Represents a media file conversion process, used to convert one media file into another. In addition to conversion,
+ * this class can be used to resize and rotate video, resample audio, drop tracks, or trim to a specific time range.
+ * @public
+ */
+export declare class Conversion {
+    /** The input file. */
+    readonly input: Input;
+    /** The output file. */
+    readonly output: Output;
+    /**
+     * A callback that is fired whenever the conversion progresses. Returns a number between 0 and 1, indicating the
+     * completion of the conversion. Note that a progress of 1 doesn't necessarily mean the conversion is complete;
+     * the conversion is complete once `execute` resolves.
+     *
+     * In order for progress to be computed, this property must be set before `execute` is called.
+     */
+    onProgress?: (progress: number) => unknown;
+    /** The list of tracks that are included in the output file. */
+    readonly utilizedTracks: InputTrack[];
+    /** The list of tracks from the input file that have been discarded, alongside the discard reason. */
+    readonly discardedTracks: {
+        /** The track that was discarded. */
+        track: InputTrack;
+        /** The reason for discarding the track. */
+        reason: 'discarded_by_user' | 'max_track_count_reached' | 'max_track_count_of_type_reached' | 'unknown_source_codec' | 'undecodable_source_codec' | 'no_encodable_target_codec';
+    }[];
+    /** Initializes a new conversion process without starting the conversion. */
+    static init(options: ConversionOptions): Promise<Conversion>;
+    private constructor();
+    /** Executes the conversion process. Resolves once conversion is complete. */
+    execute(): Promise<void>;
+    /** Cancels the conversion process. Does nothing if the conversion is already complete. */
+    cancel(): Promise<void>;
+}
+/**
+ * Utility class to handle audio resampling, handling both sample rate resampling as well as channel up/downmixing.
+ * The advantage over doing this manually rather than using OfflineAudioContext to do it for us is the artifact-free
+ * handling of putting multiple resampled audio samples back to back, which produces flaky results using
+ * OfflineAudioContext.
+ */
+export declare class AudioResampler {
+    sourceSampleRate: number;
+    targetSampleRate: number;
+    sourceNumberOfChannels: number;
+    targetNumberOfChannels: number;
+    startTime: number;
+    endTime: number;
+    onSample: (sample: AudioSample) => Promise<void>;
+    bufferSizeInFrames: number;
+    bufferSizeInSamples: number;
+    outputBuffer: Float32Array;
+    /** Start frame of current buffer */
+    bufferStartFrame: number;
+    /** The highest index written to in the current buffer */
+    maxWrittenFrame: number;
+    channelMixer: (sourceData: Float32Array, sourceFrameIndex: number, targetChannelIndex: number) => number;
+    tempSourceBuffer: Float32Array;
+    constructor(options: {
+        sourceSampleRate: number;
+        targetSampleRate: number;
+        sourceNumberOfChannels: number;
+        targetNumberOfChannels: number;
+        startTime: number;
+        endTime: number;
+        onSample: (sample: AudioSample) => Promise<void>;
+    });
+    /**
+     * Sets up the channel mixer to handle up/downmixing in the case where input and output channel counts don't match.
+     */
+    setupChannelMixer(): void;
+    ensureTempBufferSize(requiredSamples: number): void;
+    add(audioSample: AudioSample): Promise<void>;
+    finalizeCurrentBuffer(): Promise<void>;
+    finalize(): Promise<void>;
+}
+//# sourceMappingURL=conversion.d.ts.map

package/dist/modules/conversion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversion.d.ts","sourceRoot":"","sources":["../../src/conversion.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAEN,UAAU,EAOV,UAAU,EACV,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAmB,UAAU,EAAmB,MAAM,eAAe,CAAC;AAO7E,OAAO,EACN,mBAAmB,EAInB,mBAAmB,EAInB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAA0D,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAa,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAe,MAAM,UAAU,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC/B,sBAAsB;IACtB,KAAK,EAAE,KAAK,CAAC;IACb,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IAEf,8BAA8B;IAC9B,KAAK,CAAC,EAAE;QACP,yFAAyF;QACzF,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;;;;;WAOG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;QACnC;;;WAGG;QACH,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,sCAAsC;QACtC,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,+CAA+C;QAC/C,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACzC,uGAAuG;QACvG,cAAc,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;IAEF,8BAA8B;IAC9B,KAAK,CAAC,EAAE;QACP,yFAAyF;QACzF,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,qDAAqD;QACrD,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,6DAA6D;QAC7D,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,sCAAsC;QACtC,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,+CAA+C;QAC/C,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACzC,uGAAuG;QACvG,cAAc,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;IAEF,sCAAsC;IACtC,IAAI,CAAC,EAAE;QACN,6GAA6G;QAC7G,KAAK,EAAE,MAAM,CAAC;QACd,+GAA+G;QAC/G,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;CACF,CAAC;AAKF;;;;GAIG;AACH,qBAAa,UAAU;IACtB,sBAAsB;IACtB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,uBAAuB;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAwCxB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAa;IAMvD,+DAA+D;IAC/D,QAAQ,CAAC,cAAc,EAAE,UAAU,EAAE,CAAM;IAC3C,qGAAqG;IACrG,QAAQ,CAAC,eAAe,EAAE;QACzB,oCAAoC;QACpC,KAAK,EAAE,UAAU,CAAC;QAClB,2CAA2C;QAC3C,MAAM,EACH,mBAAmB,GACnB,yBAAyB,GACzB,iCAAiC,GACjC,sBAAsB,GACtB,0BAA0B,GAC1B,2BAA2B,CAAC;KAC/B,EAAE,CAAM;IAET,4EAA4E;WAC/D,IAAI,CAAC,OAAO,EAAE,iBAAiB;IAO5C,OAAO;IA+KP,6EAA6E;IACvE,OAAO;IAyCb,0FAA0F;IACpF,MAAM;CA6bZ;AA6DD;;;;;GAKG;AACH,qBAAa,cAAc;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,YAAY,EAAE,YAAY,CAAC;IAC3B,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAG,CAAC,UAAU,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,KAAK,MAAM,CAAC;IAC1G,gBAAgB,EAAE,YAAY,CAAC;gBAEnB,OAAO,EAAE;QACpB,gBAAgB,EAAE,MAAM,CAAC;QACzB,gBAAgB,EAAE,MAAM,CAAC;QACzB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,sBAAsB,EAAE,MAAM,CAAC;QAC/B,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;KACjD;IAsBD;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAuGzB,oBAAoB,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI;IAc7C,GAAG,CAAC,WAAW,EAAE,WAAW;IAsE5B,qBAAqB;IAyB3B,QAAQ;CAGR"}