# mp4-mjpeg

> Generate MP4 video file from JPEG images

Latest version **0.0.2** (published 2017-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install mp4-mjpeg
pnpm add mp4-mjpeg
yarn add mp4-mjpeg
bun add mp4-mjpeg
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-05-12 |
| First published | 2017-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Michel Gutierrez |
| Maintainers | mi-g |
| Keywords | video, mp4, mjpeg, javascript |

## Links

- npm: https://www.npmjs.com/package/mp4-mjpeg
- Repository: https://github.com/mi-g/mp4-mjpeg
- Issues: https://github.com/mi-g/mp4-mjpeg/issues
- npm.io page: https://npm.io/package/mp4-mjpeg

## Dependencies (1)

- [image-size](https://npm.io/package/image-size.md) ^0.5.3

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2017-05-12
- 0.0.1 — 2017-05-12

## README

A pure Javascript Node module to create video files from images

Install
-------

npm install --save mp4-mjpeg

Usage
-----

````javascript
const mjpeg = require('mp4-mjpeg');

// starting a video file
mjpeg({ fileName: "path/to/my/file.mp4" })
	.then( (recorder) => {

		// append a JPEG image as a data URL to the video
		recorder.appendImageDataUrl( imageAsDataURL )
			.then( () => {
				// image added
			})
			.catch( (error) => {
				// something bad happened
			})

		// or if we have the image as a buffer
		recorder.appendImageBuffer( imageBuffer )
		// ...

		// all the images added ?
		// let finalize the MP4 file to make it playable
		recorder.finalize()
			.then( () => {
				// MP4 video file is ready
			})
			.catch( (error) {
				// too bad
			})

	})
	.catch( (error) => {
		// could not create the file
	})
````

API
---

- `<module>(options)`: creates a video recorder. Options have properties:
  * `fileName`: the path to the output MP4 video file
  * `reuseLastFrame`: if an image is the same as the previous one, it does not take more data in the MP4 file (default `true`)
  * `ignoreIdenticalFrames`: if not `0` and the number of successive identical images has reached the parameter value, recording is put on hold until a different image is appended to the video (default '30`, 1 second)

The module function returns a [Promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise), not the actual recorder. To get the recorder:
````javascript
	(require('mp4-mpjpeg'))(options)
	    .then( (recorder) => {
			// the recorder can now be used to add images to the video
		});
````
- `<recorder>.appendImageDataUrl(dataUrl)`: add an image to the video. This image is encoded in *base64* prefixed with `data:image/png;base64, `, as what you get calling `canvas.toDataURL('image/jpeg')`<br/>The function returns a promise that is fulfilled when the image has been written

- `<recorder>.appendImageBuffer(buffer)`: add an image to the video. The image is a plain buffer that you can obtain by reading a JPEG file<br/>
The function returns a promise that is fulfilled when the image has been written

- `<recorder>.finalize()`: end the capturing process.<br/>
The function returns a promise that is fulfilled when the video file is ready to be played

Limitations
-----------
- only MJPEG encoding is supported
- generated video files have no audio
- framerate is fixed to 30 fps
- there is no cropping or scaling capbility in this library, the images should be processed before being appended, or the generated MP4 file can be worked afterwards
- there is no queue for appending images: the developer using this library is in charge of the flow control, which can be done easily using the promise returned by `appendXXX()`
- all appended images should have the same size, or weird things may happen

About
-----
This module has been written to cover a need on [JoclyBoard](https://github.com/mi-g/joclyboard): recording games being played in 3D. You can check JoclyBoard source code as an example of using this library

---
_Source: https://npm.io/package/mp4-mjpeg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._