Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

ffaivideo

Package Overview
Dependencies
Maintainers
0
Versions
53
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ffaivideo

  • 1.5.5
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
121
decreased by-72.5%
Maintainers
0
Weekly downloads
 
Created
Source

Logo

A node.js project that generates short videos using popular AI LLM.

FFAIVideo

A lightweight node.js project that utilizes the currently popular AI LLM in the industry to intelligently generate short videos. Without the need for complex configurations, simply input a short piece of text, and it can automatically synthesize an exciting video content.

Features

  • Fully developed on Node.js, enabling quick mastery by front-end developers.
  • Minimal dependencies, easy installation, cross-platform, and low machine requirements.
  • Simple usage, just input text to intelligently create compelling videos.
  • Supports Chinese and English scripts, with multiple voice options.
  • Includes subtitle generation, adjustable for font, position, color, and size.
  • Supports background music with adjustable volume.

Installation

npm install ffaivideo

Note: To run the preceding commands, Node.js and npm must be installed.

Example usage

const { generateVideo } = require('ffaivideo');

generateVideo(
  {
    provider: 'g4f',
    // Use the free g4f, or OpenAI, or Moonshot account
    // provider: 'openai',
    // openai: {
    //   apiKey: 'xxx',
    //   modelName: 'xxx',
    //   baseUrl: 'xxx',
    // },
    termsNum: 8,
    subtitleMaxWidth: 9,
    videoClipDuration: 12,
    voiceName: 'zh-CN-YunjianNeural',
    bgMusic: path.join(__dirname, './assets/songs/m1.mp3'),
    output: path.join(__dirname, './output'),
    pexels: {
      apiKey: 'xxx',
    },
    videoScript: `
    ...Enter your text here
  `,
  },
  progress => {
    console.log(progress);
  },
).then(videoPath => {
  console.log(videoPath);
});

Installation preparation

About the config of LLM

The current project already supports multiple AI LLM models such as OpenAI, Moonshot, Azure, g4f, Google Gemini, etc. to meet your different needs. If you want to introduce other AI LLM models, please fork this project and submit a Pull Request (PR) for us to evaluate and merge.

Before using this project, please make sure that you have applied for an API Key from the corresponding service provider. For example, if you plan to use GPT-4.0 or GPT-3.5, you need to make sure that you already have an API Key from OpenAI. In addition, you can also choose to use g4f, which is an open source library that provides free GPT usage services. Please note that although g4f is free, its service stability may fluctuate, and the usage experience may be good and bad from time to time. You can find its repository link on GitHub: https://github.com/xtekky/gpt4free.

In addition, as another option, you can apply for API services by visiting the Moonshot ai platform. After registration, you will immediately receive 15 of experience money, which is enough to support about 1,500 conversations. After successfully applying, you need to set the provider to moonshot and configure the corresponding apiKey to complete the project setup.

You need to configure apiKey, modelName and baseUrl. For azure ai, you also need to configure apiVersion.

openai: {
  apiKey: 'xxxx',
  modelName: 'gpt-4-turbo-preview',
  baseUrl: 'https://api.openai.com/v1',
},
About video material site

The video resources of this project use the Pexels website. Please visit https://www.pexels.com/api/new/ and follow the instructions to apply for a new API key so that you can use the rich materials provided by Pexels in your project.

About voice tts

FFAIVideo integrates Microsoft Edge's online text-to-speech service, powered by Microsoft Azure. Furthermore, it enables users to customize and set up their own app tokens for more flexible configuration and utilization of this service. As for the various voice options available for setup, you can find a detailed list in the following file within the GitHub repository: https://github.com/drawcall/FFAIVideo/blob/main/src/config/voice-config.ts. This way, you can select the most suitable voice according to your specific needs.

About installing ffmpeg

Since FFAIVideo relies on FFmpeg for its functionality, it is essential that you install a standard, well-maintained version of FFmpeg. This will ensure that FFAIVideo operates smoothly and without any compatibility issues.

API Configuration

Parameter nameTypeDefault valueDescription
providerstringg4fLLM Provider
moonshotLLMConfig-Moonshot configuration
openaiLLMConfig-OpenAI configuration
azureLLMConfig-Azure configuration
geminiLLMConfig-Gemini configuration
g4fLLMConfig-G4F configuration
customoAILLMConfig-custom ai configuration
pexelsMaterialSite-Pexels material site
videoScriptstring-Script for generating videos
videoTermsstring | string[]-Keywords for generating videos
videoAspectVideoAspectundefinedVideo aspect ratio, can be undefined by default
videoClipDurationnumber5Video clip duration, default is 5 seconds
termsNumnumber5Number of keywords
outputstring-Output path
cacheDirstring-Cache directory
voiceNamestring-Voice name
voiceVolumenumber1.0Voice volume, default is 1.0
bgMusicstring-Background music
bgMusicVolumenumber0.5Background music volume, default is 0.2
fontsDirstring-Font directory
fontSizenumber24Font size
fontNamestring-Font name
textColorstring"#FFFFFF"Text color, default is "#FFFFFF"
strokeColorstring"#000000"Stroke color, default is "#000000"
strokeWidthnumber-Stroke width
textBottomnumber20Text bottom position
subtitleMaxWidthnumber-Maximum subtitle width
debugbooleanfalseDebug mode
lastTimenumber5Last time
materialFuncfunctionnullA custom material synthesis
removeCachebooleantrueWhether to remove cache

Reference Project

This project is inspired by and builds upon the open-source contributions from several notable repositories, including MoneyPrinterTurbo, MoneyPrinter, and MsEdgeTTS. We express our sincere gratitude to the original authors for their dedication to the open-source community and their innovative spirit.

License

MIT LICENSE

FAQs

Package last updated on 29 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc