feat: ImgClip supports the tickInterceptor method

Author: hughfenghen

.changeset/good-seals-mix.md

@@ -0,0 +1,5 @@
+---
+'@webav/av-cliper': minor
+---
+
+feat: ImgClip supports the tickInterceptor method

packages/av-cliper/src/clips/__tests__/img-clip.test.ts

@@ -1,4 +1,4 @@
-import { expect, test } from 'vitest';
+import { expect, test, vi } from 'vitest';
 import { ImgClip } from '..';
 
 const animated_gif = `//${location.host}/img/animated.gif`;
@@ -32,3 +32,17 @@ test('clone ImgClip', async () => {
   const { state } = await cloneClip.tick(10e6);
   expect(state).toBe('success');
 });
+
+test('ImgClip tickInterceptor', async () => {
+  const clip = new ImgClip((await fetch(static_jpg)).body!);
+  clip.tickInterceptor = vi.fn();
+  await clip.ready;
+  await clip.tick(10e6);
+  expect(clip.tickInterceptor).toBeCalledWith(
+    10e6,
+    expect.objectContaining({
+      state: 'success',
+      video: expect.any(ImageBitmap),
+    }),
+  );
+});

packages/av-cliper/src/clips/img-clip.ts

@@ -119,25 +119,30 @@ export class ImgClip implements IClip {
     Log.info('ImgClip ready:', this.#meta);
   }
 
+  tickInterceptor: <T extends Awaited<ReturnType<ImgClip['tick']>>>(
+    time: number,
+    tickRet: T,
+  ) => Promise<T> = async (_, tickRet) => tickRet;
+
   async tick(time: number): Promise<{
     video: ImageBitmap | VideoFrame;
     state: 'success';
   }> {
     if (this.#img != null) {
-      return {
+      return await this.tickInterceptor(time, {
         video: await createImageBitmap(this.#img),
         state: 'success',
-      };
+      });
     }
     const tt = time % this.#meta.duration;
-    return {
+    return await this.tickInterceptor(time, {
       video: (
         this.#frames.find(
           (f) => tt >= f.timestamp && tt <= f.timestamp + (f.duration ?? 0),
         ) ?? this.#frames[0]
       ).clone(),
       state: 'success',
-    };
+    });
   }
 
   async split(time: number) {