@lumen5/framefusion 0.0.3

package/dist/src/BaseExtractor.js

@@ -0,0 +1,45 @@
+export class BaseExtractor {
+    static async create(args) {
+        throw new Error('Not implemented');
+    }
+    async init({ inputFileOrUrl, outputFile, threadCount = 8, endTime, interpolateFps, interpolateMode, }) {
+        throw new Error('Not implemented');
+    }
+    get duration() {
+        throw new Error('Not implemented');
+    }
+    get width() {
+        throw new Error('Not implemented');
+    }
+    get height() {
+        throw new Error('Not implemented');
+    }
+    async seekToPTS(targetPts) {
+        throw new Error('Not implemented');
+    }
+    async getFrameAtTime(targetTime) {
+        throw new Error('Not implemented');
+    }
+    async getFrameAtPts(targetPts) {
+        throw new Error('Not implemented');
+    }
+    async seekToTime(targetTime) {
+        throw new Error('Not implemented');
+    }
+    /**
+     * Convert a PTS (based on timebase) to PTS (in seconds)
+     */
+    ptsToTime(pts) {
+        throw new Error('Not implemented');
+    }
+    async readFrames({ onFrameAvailable, flush = true, } = {
+        flush: true,
+        onFrameAvailable: () => true,
+    }) {
+        throw new Error('Not implemented');
+    }
+    async dispose() {
+        throw new Error('Not implemented');
+    }
+}
+//# sourceMappingURL=BaseExtractor.js.map

package/dist/src/BaseExtractor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseExtractor.js","sourceRoot":"","sources":["../../src/BaseExtractor.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,aAAa;IACtB,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAmB;QACnC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EACP,cAAc,EACd,UAAU,EACV,WAAW,GAAG,CAAC,EACf,OAAO,EACP,cAAc,EACd,eAAe,GACH;QACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,QAAQ;QACR,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,KAAK;QACL,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,MAAM;QACN,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,SAAiB;QAC7B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,UAAkB;QACnC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,SAAiB;QACjC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,UAAkB;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,GAAW;QACjB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EACb,gBAAgB,EAChB,KAAK,GAAG,IAAI,MAOZ;QACA,KAAK,EAAE,IAAI;QACX,gBAAgB,EAAE,GAAG,EAAE,CAAC,IAAI;KAC/B;QACG,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,OAAO;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC;CACJ"}

package/dist/src/DownloadVideoURL.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Downloads a video file from a given URL as a temporary file. When the object is cleared, the temporary file is
+ * deleted.
+ */
+export declare class DownloadVideoURL {
+    #private;
+    constructor(url: any);
+    /**
+     * returns the filepath of the downloaded file. If the file has not been downloaded yet, it will be undefined
+     */
+    get filepath(): string;
+    /**
+     * Downloads the file from the given URL. The file will be downloaded to a temporary file.
+     */
+    download(): Promise<void>;
+    clear(): void;
+}

package/dist/src/DownloadVideoURL.js

@@ -0,0 +1,77 @@
+import path from 'path';
+import https from 'node:https';
+import http from 'http';
+import tmp from 'tmp';
+import fs from 'fs-extra';
+class CancelRequestError extends Error {
+}
+/**
+ * Downloads a video file from a given URL as a temporary file. When the object is cleared, the temporary file is
+ * deleted.
+ */
+export class DownloadVideoURL {
+    #url;
+    #httpRequest = undefined;
+    #filepath = undefined;
+    #tmpObj = undefined;
+    constructor(url) {
+        this.#url = url;
+    }
+    /**
+     * returns the filepath of the downloaded file. If the file has not been downloaded yet, it will be undefined
+     */
+    get filepath() {
+        return this.#filepath;
+    }
+    /**
+     * Downloads the file from the given URL. The file will be downloaded to a temporary file.
+     */
+    async download() {
+        await new Promise((resolve, reject) => {
+            const source = this.#url;
+            const extension = path.extname(source);
+            this.#tmpObj = tmp.fileSync({ postfix: extension });
+            try {
+                const connectionHandler = source.startsWith('https://') ? https : http;
+                this.#httpRequest = connectionHandler.get(source, (res) => {
+                    const contentType = res.headers['content-type'];
+                    if (!contentType.includes('video')) {
+                        const err = new Error(`Source ${source}, returned unsupported content type ${contentType}`);
+                        reject(err);
+                        return;
+                    }
+                    const writeStream = fs.createWriteStream(this.#tmpObj.name);
+                    res.pipe(writeStream);
+                    writeStream.on('finish', () => {
+                        writeStream.close();
+                        this.#filepath = this.#tmpObj.name;
+                        resolve();
+                    });
+                    writeStream.on('error', (e) => {
+                        reject(e);
+                    });
+                });
+                this.#httpRequest.on('error', (e) => {
+                    if (e instanceof CancelRequestError) {
+                        return;
+                    }
+                    reject(e);
+                });
+            }
+            catch (e) {
+                reject(e);
+            }
+        });
+    }
+    clear() {
+        if (this.#tmpObj)
+            this.#tmpObj.removeCallback();
+        if (this.#url)
+            this.#url = undefined;
+        if (this.#httpRequest)
+            this.#httpRequest = null;
+        if (this.#filepath)
+            this.#filepath = undefined;
+    }
+}
+//# sourceMappingURL=DownloadVideoURL.js.map

package/dist/src/DownloadVideoURL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DownloadVideoURL.js","sourceRoot":"","sources":["../../src/DownloadVideoURL.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,MAAM,YAAY,CAAC;AAE/B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,MAAM,UAAU,CAAC;AAE1B,MAAM,kBAAmB,SAAQ,KAAK;CAAI;AAE1C;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IACzB,IAAI,CAAqB;IACzB,YAAY,GAA8B,SAAS,CAAC;IACpD,SAAS,GAAuB,SAAS,CAAC;IAC1C,OAAO,GAAuC,SAAS,CAAC;IAExD,YAAY,GAAG;QACX,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACV,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;YACzB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;YACpD,IAAI;gBACA,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;gBACvE,IAAI,CAAC,YAAY,GAAG,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE;oBACtD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;oBAChD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;wBAChC,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,UAAU,MAAM,uCAAuC,WAAW,EAAE,CAAC,CAAC;wBAC5F,MAAM,CAAC,GAAG,CAAC,CAAC;wBACZ,OAAO;qBACV;oBACD,MAAM,WAAW,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAC5D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACtB,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;wBAC1B,WAAW,CAAC,KAAK,EAAE,CAAC;wBACpB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;wBACnC,OAAO,EAAE,CAAC;oBACd,CAAC,CAAC,CAAC;oBACH,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;wBAC1B,MAAM,CAAC,CAAC,CAAC,CAAC;oBACd,CAAC,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;oBAChC,IAAI,CAAC,YAAY,kBAAkB,EAAE;wBACjC,OAAO;qBACV;oBACD,MAAM,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC,CAAC,CAAC;aACN;YACD,OAAO,CAAC,EAAE;gBACN,MAAM,CAAC,CAAC,CAAC,CAAC;aACb;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,KAAK;QACD,IAAI,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAChD,IAAI,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YAAE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAChD,IAAI,IAAI,CAAC,SAAS;YAAE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IACnD,CAAC;CACJ"}

package/dist/src/backends/beamcoder.d.ts

@@ -0,0 +1,184 @@
+/// <reference types="node" />
+import type { ReadStream } from 'fs';
+import type { Frame } from 'beamcoder';
+import beamcoder from 'beamcoder';
+import type { Extractor, ExtractorArgs } from '../../framefusion.js';
+import { BaseExtractor } from '../BaseExtractor.js';
+/**
+ * Assumptions made by this library:
+ *
+ *  - The input is always a mp4
+ *    It would be nice to support other formats. One thing to change is the iformat, hardcoded for mp4.
+ *
+ *  - Stream 0 is the video stream we want to extract.
+ *    It would be good to detect cases where stream 0 is an audio stream an switch to the next stream.
+ *
+ */
+export declare const probeCodecPar: (codecpar: any) => {
+    type: any;
+    codec_type: any;
+    codec_id: any;
+    name: any;
+    codec_tag: any;
+    extradata: any;
+    format: any;
+    bit_rate: any;
+    bits_per_coded_sample: any;
+    bits_per_raw_sample: any;
+    profile: any;
+    level: any;
+    width: any;
+    height: any;
+    sample_aspect_ratio: any;
+    field_order: any;
+    color_range: any;
+    color_primaries: any;
+    color_trc: any;
+    color_space: any;
+    chroma_location: any;
+    video_delay: any;
+    channel_layout: any;
+    channels: any;
+    sample_rate: any;
+    block_align: any;
+    frame_size: any;
+    initial_padding: any;
+    trailing_padding: any;
+    seek_preroll: any;
+};
+export declare const probeStream: (stream: any) => {
+    type: any;
+    index: any;
+    id: any;
+    time_base: any;
+    start_time: any;
+    duration: any;
+    nb_frames: any;
+    disposition: any;
+    discard: any;
+    sample_aspect_ratio: any;
+    metadata: any;
+    avg_frame_rate: any;
+    attached_pic: any;
+    side_data: any;
+    event_flags: any;
+    r_frame_rate: any;
+    codecpar: {
+        type: any;
+        codec_type: any;
+        codec_id: any;
+        name: any;
+        codec_tag: any;
+        extradata: any;
+        format: any;
+        bit_rate: any;
+        bits_per_coded_sample: any;
+        bits_per_raw_sample: any;
+        profile: any;
+        level: any;
+        width: any;
+        height: any;
+        sample_aspect_ratio: any;
+        field_order: any;
+        color_range: any;
+        color_primaries: any;
+        color_trc: any;
+        color_space: any;
+        chroma_location: any;
+        video_delay: any;
+        channel_layout: any;
+        channels: any;
+        sample_rate: any;
+        block_align: any;
+        frame_size: any;
+        initial_padding: any;
+        trailing_padding: any;
+        seek_preroll: any;
+    };
+};
+/**
+ * Class to keep track of the muxer/demuxer/encoder/muxer used while extracting a video to frames.
+ */
+export declare class BeamcoderExtractor extends BaseExtractor implements Extractor {
+    #private;
+    decoder: beamcoder.Decoder;
+    demuxer: beamcoder.Demuxer;
+    encoder: beamcoder.Encoder;
+    muxer: beamcoder.Muxer;
+    filterer: beamcoder.Filterer;
+    packet: beamcoder.Packet;
+    endTime: number;
+    demuxerStream: beamcoder.WritableDemuxerStream;
+    readStream: ReadStream;
+    lastFrame: beamcoder.Frame;
+    filteredFrames: beamcoder.Frame[];
+    /**
+     * Encoder/Decoder constuction is async, so it can't be put in a regular constructor.
+     *
+     * Use and await this method to generate an extactor.
+     */
+    static create(args: ExtractorArgs): Promise<Extractor>;
+    init({ inputFileOrUrl, outputFile, threadCount, endTime, interpolateFps, interpolateMode, outputPixelFormat, }: ExtractorArgs): Promise<void>;
+    get duration(): number;
+    get width(): number;
+    get height(): number;
+    /**
+     * Seek to a given PTS in the stream
+     *
+     * PTS stands for presentation time stamp. It's expressed in time_base units.
+     * If timebase is 1/10000,
+     * and a frame PTS is 10000,
+     * Then the frame must be displayed at exactly 1 second.
+     */
+    seekToPTS(targetPts: number): Promise<void>;
+    /**
+     * Dump one frame at a specific time
+     *
+     * This method can seek as required, but generally, it is designed to be
+     * performant in the cases where we progressively read a video frame by frame.
+     *
+     * So the implementation in here should not seek all the time, but rather
+     * read packets as they come, when possible,
+     *
+     * @see getFrameAtPts()
+     */
+    getFrameAtTime(targetTime: number): Promise<beamcoder.Frame>;
+    /**
+     * Dump one frame at a specific pts
+     *
+     * This method can seek as required, but generally, it is designed to be
+     * performant in the cases where we progressively read a video frame by frame.
+     *
+     * So the implementation in here should not seek all the time, but rather
+     * read packets as they come, when possible,
+     */
+    getFrameAtPts(targetPts: number): Promise<beamcoder.Frame>;
+    /**
+     * Seek to a given time in the stream
+     */
+    seekToTime(targetTime: number): Promise<void>;
+    /**
+     * Convert a time (in seconds) to PTS (based on timebase)
+     */
+    timeToPts(time: number): number;
+    /**
+     * Convert a PTS (based on timebase) to PTS (in seconds)
+     */
+    ptsToTime(pts: number): number;
+    /**
+     * Detect multiple access to beamcoder which could put our system in an unexpected state.
+     */
+    withLock(callback: any): Promise<void>;
+    /**
+     * Dump all frames from the current point.
+     * Stops processing packets after target is reached.
+     */
+    readFrames({ onFrameAvailable, flush, }?: {
+        /**
+         * Return true if we need to read more frames.
+         */
+        onFrameAvailable?: (frame: Frame) => Promise<boolean> | boolean;
+        flush?: boolean;
+    }): Promise<void>;
+    dispose(): Promise<void>;
+}