feat: add custom materialFunc

feat: add custom materialFunc

README.md

@@ -124,6 +124,7 @@ Since FFAIVideo relies on FFmpeg for its functionality, it is essential that you
 | subtitleMaxWidth | number | - | Maximum subtitle width |
 | debug | boolean | false | Debug mode |
 | lastTime | number | 5 | Last time |
+| materialFunc | function | null | A custom material synthesis |
 | removeCache | boolean | true | Whether to remove cache |
 
 ## Reference Project

examples/simple.js

@@ -1,6 +1,7 @@
-const { generateVideo } = require('../dist');
+const { generateVideo, Logger } = require('../dist');
 const path = require('path');
 
+Logger.enabled = true;
 generateVideo(
   {
     provider: 'g4f',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffaivideo",
-  "version": "1.3.3",
+  "version": "1.3.7",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/config/config.ts

@@ -53,6 +53,12 @@ interface VideoConfig {
   lastTime?: number;
   removeCache?: boolean;
 
+  materialFunc?: (
+    searchTerm: string,
+    maxClipDuration: number,
+    index: number,
+    cacheDir?: string,
+  ) => Promise<any[]>;
   insertClips?: InsertClip[];
   [key: string]: any;
 }

src/generator.ts

@@ -81,7 +81,7 @@ const generateVideo = async (
     subtitleFile = '';
   }
   progress(40);
-
+  
   const downloadedVideos: string[] = await downloadVideos(
     videoTerms,
     videoDuration,

src/material.ts

@@ -2,13 +2,14 @@ import fs from 'fs-extra';
 import md5 from 'md5';
 import path from 'path';
 import axios from 'axios';
+import { isEmpty, forEach } from 'lodash';
 import { VideoAspect } from './config/constant';
 import { VideoConfig } from './config/config';
 import { toResolution } from './utils/video-aspect';
 import { getEnumKeyByValue } from './utils/utils';
 import { writeFileWithStream } from './utils/file';
 import { appequal } from './utils/utils';
-import { httpGet } from './utils/http';
+import { httpGet, buildApiUrl } from './utils/http';
 import { toJson } from './utils/json';
 import { Logger } from './utils/log';
 import { uuid } from './utils/utils';
@@ -27,13 +28,17 @@ const searchVideos = async (
   const { videoAspect = VideoAspect.Portrait } = config;
   const videoOrientation: string = getEnumKeyByValue(VideoAspect, videoAspect);
   const [videoWidth, videoHeight] = toResolution(videoAspect);
-
-  const params = new URLSearchParams();
-  params.append('query', searchTerm);
-  params.append('per_page', '20');
-  params.append('orientation', videoOrientation);
-  const queryUrl = `https://api.pexels.com/videos/search?${params.toString()}`;
-  const data = await httpGet(queryUrl, {}, config.pexels!);
+  const searchData = {
+    query: searchTerm,
+    per_page: '20',
+    orientation: videoOrientation,
+  };
+  const queryUrl = `https://api.pexels.com/videos/search`;
+  const data = await httpGet(
+    buildApiUrl(queryUrl, searchData),
+    {},
+    config.pexels!,
+  );
   if (!data) return [];
 
   const videoItems: MaterialInfo[] = [];
@@ -107,8 +112,21 @@ const downloadVideos = async (
   const validVideoUrls: string[] = [];
   let foundDuration = 0.0;
 
-  for (const searchTerm of searchTerms) {
-    const videoItems = await searchVideos(searchTerm, maxClipDuration, config);
+  for (const [index, searchTerm] of searchTerms.entries()) {
+    let videoItems = [];
+    if (config.materialFunc) {
+      videoItems = await config.materialFunc(
+        searchTerm,
+        index,
+        maxClipDuration,
+        cacheDir
+      );
+      if (isEmpty(videoItems)) {
+        videoItems = await searchVideos(searchTerm, maxClipDuration, config);
+      }
+    } else {
+      videoItems = await searchVideos(searchTerm, maxClipDuration, config);
+    }
 
     for (const item of videoItems) {
       if (!validVideoUrls.includes(item.url)) {

src/utils/http.ts

@@ -34,4 +34,18 @@ const httpGet = async (queryUrl: string, options = {}, site: MaterialSite) => {
   return null;
 };
 
-export { httpGet };
+const buildApiUrl = (baseUrl: string, data = {}) => {
+  const params = new URLSearchParams();
+
+  // 遍历 data 对象，将所有键值对添加到 URLSearchParams
+  for (const [key, value] of Object.entries(data)) {
+    if (value !== undefined && value !== null) {
+      params.append(key, value.toString());
+    }
+  }
+
+  // 如果 params 不为空，则添加 '?' 和参数字符串；否则返回原始 baseUrl
+  return params.toString() ? `${baseUrl}?${params.toString()}` : baseUrl;
+};
+
+export { httpGet, buildApiUrl };