Commit 12c768d5 authored by Jerome Wu's avatar Jerome Wu

Update README.md

parent a4417eb3
FFmpeg README
=============
FFmpeg.wasm Core
================
![FFmpeg.wasm Core](https://github.com/ffmpegwasm/ffmpeg.wasm-core/workflows/FFmpeg.wasm/badge.svg?branch=n4.3.1-wasm)
FFmpeg is a collection of libraries and tools to process multimedia content
such as audio, video, subtitles and related metadata.
This is the core part of FFmpeg.wasm where we transpile C/C++ code of FFmpeg to JavaScript/WebAssembly code. It is still very experimental (and slow), but shows the possibilities of using FFmpeg right purely in your browser.
## Libraries
## Build
* `libavcodec` provides implementation of a wider range of codecs.
* `libavformat` implements streaming protocols, container formats and basic I/O access.
* `libavutil` includes hashers, decompressors and miscellaneous utility functions.
* `libavfilter` provides a mean to alter decoded Audio and Video through chain of filters.
* `libavdevice` provides an abstraction to access capture and playback devices.
* `libswresample` implements audio mixing and resampling routines.
* `libswscale` implements color conversion and scaling routines.
1. Use docker (easy way)
## Tools
Install latest docker and run `build-with-docker.sh`.
* [ffmpeg](https://ffmpeg.org/ffmpeg.html) is a command line toolbox to
manipulate, convert and stream multimedia content.
* [ffplay](https://ffmpeg.org/ffplay.html) is a minimalistic multimedia player.
* [ffprobe](https://ffmpeg.org/ffprobe.html) is a simple analysis tool to inspect
multimedia content.
* Additional small tools such as `aviocat`, `ismindex` and `qt-faststart`.
```
$ bash build-with-docker.sh
```
## Documentation
2. Install emsdk (unstable way)
The offline documentation is available in the **doc/** directory.
Setup the emsdk from [HERE](https://emscripten.org/docs/getting_started/downloads.html) and run `build.sh`.
The online documentation is available in the main [website](https://ffmpeg.org)
and in the [wiki](https://trac.ffmpeg.org).
```
$ bash build.sh
```
### Examples
If nothing goes wrong, you can find JavaScript files in `wasm/dist`.
Coding examples are available in the **doc/examples** directory.
## Configuration
## License
FFmpeg codebase is mainly LGPL-licensed with optional components licensed under
GPL. Please refer to the LICENSE file for detailed information.
## Contributing
Patches should be submitted to the ffmpeg-devel mailing list using
`git format-patch` or `git send-email`. Github pull requests should be
avoided because they are not part of our review process and will be ignored.
- Emscripten: 2.0.8
- FFmpeg: 4.3.1
- x264: 0.160.x
- libvpx: 1.9.0
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment