Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bilibili/webav
WebAV is an SDK built on WebCodecs, designed for creating and editing video files on the web platform. WebAV 是基于 WebCodecs 构建的 SDK，用于在 Web 平台上创建/编辑视频文件。
https://github.com/bilibili/webav
audio browser canvas media mp4 recorder video web webcodecs
Last synced: 2 days ago
JSON representation
WebAV is an SDK built on WebCodecs, designed for creating and editing video files on the web platform. WebAV 是基于 WebCodecs 构建的 SDK，用于在 Web 平台上创建/编辑视频文件。
- Host: GitHub
- URL: https://github.com/bilibili/webav
- Owner: bilibili
- License: mit
- Created: 2023-03-27T13:53:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-23T09:23:07.000Z (3 months ago)
- Last Synced: 2024-08-24T16:06:06.439Z (3 months ago)
- Topics: audio, browser, canvas, media, mp4, recorder, video, web, webcodecs
- Language: TypeScript
- Homepage: https://bilibili.github.io/WebAV/
- Size: 195 MB
- Stars: 878
- Watchers: 11
- Forks: 102
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WebAV
[](https://github.com/bilibili/WebAV/actions/workflows/release.yml)
English | [中文](./README_CN.md)
WebAV is an SDK for **creating/editing** video files on the web platform, built on WebCodecs.
### Features
- Cross-platform: Supports running on Edge and Chrome browsers, as well as in Electron.
- Zero Cost: Fully utilizes client-side computation, eliminating server costs.
- Privacy and Security: No user data is uploaded.
- High Performance: 10 to 20 times faster than ffmpeg.wasm.
- Easy to Extend: Developer-friendly for web developers, easily integrates with Canvas and WebAudio for custom functionality.
- Small Size: Approximately 50KB (MINIFIED + GZIPPED, without tree-shaking).
_Compatible with Chrome 102+_
### Use Cases
- Batch audio and video file processing, such as adding watermarks, dubbing, and embedding subtitles
- Building audio and video related products, such as video editing, live streaming, and video animation production
## DEMO
The WebAV project offers a variety of quick DEMO experiences. Visit the [DEMO Homepage](https://bilibili.github.io/WebAV/demo) to check the compatibility of your current device.
_Note: The test video resources are hosted on GitHub pages, so starting a DEMO may require some network loading time._
Here are some feature demos you might be interested in:
- [Video Concatenation](https://bilibili.github.io/WebAV/demo/2_1-concat-video)
- [Video Editing](https://bilibili.github.io/WebAV/demo/6_4-video-editor)
- [Live Recording](https://bilibili.github.io/WebAV/demo/4_2-recorder-avcanvas)
- WebAV + Canvas + WebAudio [Decode and Play Video](https://bilibili.github.io/WebAV/demo/1_1-decode-video)
## Packages Introduction
### [av-cliper](https://bilibili.github.io/WebAV/_api/av-cliper/)
`av-cliper` is the foundational SDK for audio and video data processing. It provides basic classes and functions to help developers quickly achieve their target functionalities.
Here is a brief introduction to the core API of `av-cliper`:
- `IClip` abstracts audio and video materials, parses audio and video, image, and subtitle resources, and provides data to other modules.
- `Sprite` attaches spatial and temporal attributes to materials, allowing control over the spatial position and time offset of the video in the material, achieving multi-material collaboration, animation, and other functions.
- `Combinator` can add multiple Sprites, and based on their positions, layers, and time offsets, synthesize and output as a video file.
Code Demo: Add a Moving Semi-transparent Watermark to a Video
```js
import {
ImgClip,
MP4Clip,
OffscreenSprite,
renderTxt2ImgBitmap,
Combinator,
} from '@webav/av-cliper';
const spr1 = new OffscreenSprite(
new MP4Clip((await fetch('./video/bunny.mp4')).body),
);
const spr2 = new OffscreenSprite(
new ImgClip(
await renderTxt2ImgBitmap(
'Watermark',
`font-size:40px; color: white; text-shadow: 2px 2px 6px red;`,
),
),
);
spr2.time = { offset: 0, duration: 5e6 };
spr2.setAnimation(
{
'0%': { x: 0, y: 0 },
'25%': { x: 1200, y: 680 },
'50%': { x: 1200, y: 0 },
'75%': { x: 0, y: 680 },
'100%': { x: 0, y: 0 },
},
{ duration: 4e6, iterCount: 1 },
);
spr2.zIndex = 10;
spr2.opacity = 0.5;
const com = new Combinator({
width: 1280,
height: 720,
});
await com.addSprite(spr1);
await com.addSprite(spr2);
com.output(); // => ReadableStream
```
### [av-canvas](https://bilibili.github.io/WebAV/_api/av-canvas/)
`av-canvas` relies on the basic capabilities of `av-cliper` and provides a canvas that responds to user operations on Sprites (dragging, scaling, rotating), enabling quick implementation of products like video editing and live streaming workstations.
Code Demo: Add Video and Text to the Canvas
```js
import {
ImgClip,
MP4Clip,
VisibleSprite,
renderTxt2ImgBitmap,
} from '@webav/av-cliper';
import { AVCanvas } from '@webav/av-canvas';
const avCvs = new AVCanvas(document.querySelector('#app'), {
width: 1280,
height: 720,
});
const spr1 = new VisibleSprite(
new MP4Clip((await fetch('./video/bunny.mp4')).body),
);
const spr2 = new VisibleSprite(
new ImgClip(
await renderTxt2ImgBitmap(
'Watermark',
`font-size:40px; color: white; text-shadow: 2px 2px 6px red;`,
),
),
);
await avCvs.add(spr1);
await avCvs.add(spr2);
// Export user-edited materials into a video
// (await avCvs.createCombinator()).output()
// Capture stream from the canvas (MediaStream) for live streaming or video recording
// avCvs.captureStream()
```
### [av-recorder](https://bilibili.github.io/WebAV/_api/av-canvas/)
`av-recorder` records `MediaStream` and outputs the video file stream in MP4 format.
Code Demo: Record Camera and Microphone, Output MP4 File Stream
```js
import { AVRecorder } from '@webav/av-recorder';
const mediaStream = await navigator.mediaDevices.getUserMedia({
video: true,
audio: true,
});
const recorder = new AVRecorder(mediaStream);
recorder.start(); // => ReadableStream
```
## Contributing
### Running the Project
1. Clone the current project locally
2. Execute `pnpm install && pnpm build` in the root directory
3. Change directory to the specific package (e.g., av-cliper) and run `pnpm dev`
4. The path is the filename in the DEMO directory, such as `concat-media.html`
5. Open the DEMO URL in the browser, such as `http://localhost:6066/concat-media.html`
6. Run unit tests for the package with `pnpm test`
### Running the WebAV Site
1. Clone the current project locally
2. Execute `pnpm install && pnpm build` in the root directory
3. Change directory to `doc-site` and run `pnpm dev`
4. Follow the terminal prompts to visit the specified URL
If you are a beginner in the field of web audio and video, you can start by learning the basics:
[Articles by the Author](https://bilibili.github.io/WebAV/article)
[Web Audio and Video Knowledge Graph](https://github.com/bilibili/WebAV-KnowledgeGraph)
## Sponsor Author
If this project has been helpful to you, please sponsor the author to a milk tea ：）
[Paypal.me](https://paypal.me/hughfenghen)