mirror of
https://github.com/arcodange-org/mediabunny.git
synced 2026-09-27 10:53:50 +02:00
45 lines
2.3 KiB
Markdown
45 lines
2.3 KiB
Markdown
# @mediabunny/prores
|
|
|
|
[](https://www.npmjs.com/package/@mediabunny/prores)
|
|
[](https://bundlephobia.com/package/@mediabunny/prores)
|
|
[](https://www.npmjs.com/package/@mediabunny/prores)
|
|
[](https://discord.gg/hmpkyYuS4U)
|
|
|
|
<div align="center">
|
|
<img src="../../docs/public/mediabunny-logo.svg" width="180" height="180">
|
|
</div>
|
|
|
|
Browsers have no support for Apple ProRes in their WebCodecs implementations. This extension package provides a decoder for use with [Mediabunny](https://github.com/Vanilagy/mediabunny), allowing you to decode ProRes directly in the browser at unprecedented speed. It is implemented using Mediabunny's [custom coder API](https://mediabunny.dev/guide/supported-formats-and-codecs#custom-coders) and uses [TurboRes](https://github.com/Vanilagy/turbores), an extremely fast WASM-based ProRes decoder, under the hood.
|
|
|
|
> This package, like the rest of Mediabunny, is enabled by its [sponsors](https://mediabunny.dev/#sponsors) and their donations. If you've derived value from this package, please consider [leaving a donation](https://github.com/sponsors/Vanilagy)! 💘
|
|
|
|
## Installation
|
|
|
|
This library peer-depends on Mediabunny. Install both using npm:
|
|
```bash
|
|
npm install mediabunny @mediabunny/prores
|
|
```
|
|
|
|
Alternatively, directly include them using a script tag:
|
|
```html
|
|
<script src="mediabunny.js"></script>
|
|
<script src="mediabunny-prores.js"></script>
|
|
```
|
|
|
|
This will expose the global objects `Mediabunny` and `MediabunnyProres`. Use `mediabunny-prores.d.ts` to provide types for these globals. You can download the built distribution files from the [releases page](https://github.com/Vanilagy/mediabunny/releases).
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { registerProresDecoder } from '@mediabunny/prores';
|
|
|
|
registerProresDecoder();
|
|
```
|
|
That's it - Mediabunny now uses the registered ProRes decoder automatically.
|
|
|
|
For all the ways of using Mediabunny, refer to its [guide](https://mediabunny.dev/guide/introduction).
|
|
|
|
## Building and development
|
|
|
|
The complete JavaScript package can be built alongside the rest of Mediabunny by running `npm run build` in Mediabunny's root.
|