Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lorddashme/nodejs-image-squeezer
A simple npm package for image compression powered by FFMPEG.
https://github.com/lorddashme/nodejs-image-squeezer
ffmpeg image-processing javascript linux nodejs optimization typescript
Last synced: about 2 months ago
JSON representation
A simple npm package for image compression powered by FFMPEG.
- Host: GitHub
- URL: https://github.com/lorddashme/nodejs-image-squeezer
- Owner: LordDashMe
- License: mit
- Created: 2019-05-22T04:37:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-01T16:03:36.000Z (almost 2 years ago)
- Last Synced: 2024-09-20T12:07:44.544Z (4 months ago)
- Topics: ffmpeg, image-processing, javascript, linux, nodejs, optimization, typescript
- Language: TypeScript
- Homepage:
- Size: 73.9 MB
- Stars: 15
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NodeJS Image Squeezer
A simple npm package for image compression powered by FFMPEG.
[](https://coveralls.io/github/LordDashMe/nodejs-image-squeezer?branch=master) [](https://www.npmjs.com/package/nodejs-image-squeezer)
## Requirement(s)
- Node.js **8.x.x** up to **latest**.
- Operating System: Windows or Linux.
- FFMPEG Binaries or Executable File:
- To get the latest static build for **Linux**: [Linux FFMPEG Static Build](https://johnvansickle.com/ffmpeg/)
- For **Windows** you can download it via this link: [Windows FFMPEG Build](https://ffmpeg.zeranoe.com/builds/)
- As of the moment **MacOS** is not supported.
- To check the FFMPEG latest build or release please refer to this link: [FFMPEG Main Download Link](https://ffmpeg.org/download.html)
- Other Feature(s):
- ImageMagick:
- To use the "ProressiveJPEG" class this require the ImageMagick package.
- To get the latest version [ImageMagick Download Link](https://imagemagick.org/script/download.php)
## Install
### NPM
- Use command ```npm install nodejs-image-squeezer --save```.
### Github Package
- Use command ```npm install @lorddashme/nodejs-image-squeezer```.
- Currently Github only support scoped npm packages, see: [Publishing a package](https://help.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages#publishing-a-package)
## Usage
### FFMPEG
- Basic implementation using Vanilla/Common JavaScript:
```js
// Require the main class of the NodeJS Image Squeezer.
const ImageSqueezer = require('nodejs-image-squeezer');
// Initialize the main class.
const imgSqueezer = new ImageSqueezer.FFMPEGComppresion();
// Load the necessary requirements and validate
// if the package fit for the current environment.
imgSqueezer.load();
// Set the default binaries file.
imgSqueezer.setBin('/path/to/ffmpeg');
// Provide the source file path of the desire image
// that will be compress later on.
imgSqueezer.setSourceFilePath('/path/source-filename');
// Provide the output file path of the compressed image.
imgSqueezer.setOutputFilePath('/path/output-filename');
// (Optional) This will allow output file path as empty
// and will use the source file path as the output file path.
imgSqueezer.allowEmptyOutputFilePath();
// (Optional) To adjust the compression level.
// COMPRESSION_LEVEL_LOW = 30%
// COMPRESSION_LEVEL_NORMAL = 70%
// (Default) COMPRESSION_LEVEL_HIGH = 100%
imgSqueezer.setCompressionLevel(ImageSqueezer.FFMPEGComppresion.COMPRESSION_LEVEL_NORMAL);
// Prepare all necessary commands before executing
// the compression process.
imgSqueezer.build();
// Execute the image compression.
// Please take note this is an async method.
// return a Promise.
imgSqueezer.compress();
```
- Below are the simple implementation using **TypeScript**:
```ts
import ImageSqueezer from 'nodejs-image-squeezer';
const imgSqueezer = new ImageSqueezer.FFMPEGComppresion();
imgSqueezer.load();
imgSqueezer.setBin('/path/to/ffmpeg');
imgSqueezer.setSourceFilePath('/path/source-filename');
imgSqueezer.setOutputFilePath('/path/output-filename');
imgSqueezer.allowEmptyOutputFilePath();
imgSqueezer.setCompressionLevel(ImageSqueezer.FFMPEGComppresion.COMPRESSION_LEVEL_NORMAL);
imgSqueezer.build();
imgSqueezer.compress();
```
### JPEG Progressive
- **Note:** This function will only work for JPEG format.
- Basic implementation without using superset libraries for Vanilla/Common JavaScript:
```js
const ImageSqueezer = require('nodejs-image-squeezer');
const imgSqueezer = new ImageSqueezer.ProgressiveJPEG();
imgSqueezer.load();
imgSqueezer.setBin('/path/to/convert');
imgSqueezer.setSourceFilePath('/path/source-filename');
imgSqueezer.setOutputFilePath('/path/output-filename');
// (Optional) This will allow output file path as empty
// and will use the source file path as the output file path.
imgSqueezer.allowEmptyOutputFilePath();
imgSqueezer.build();
// Execute the jpeg progressive optimization.
// Please take note this is an async method.
// return a Promise.
imgSqueezer.compress();
```
- Below are the simple implementation using **TypeScript**:
```ts
import ImageSqueezer from 'nodejs-image-squeezer';
const imgSqueezer = new ImageSqueezer.ProgressiveJPEG();
imgSqueezer.load();
imgSqueezer.setBin('/path/to/convert');
imgSqueezer.setSourceFilePath('/path/source-filename');
imgSqueezer.setOutputFilePath('/path/output-filename');
imgSqueezer.allowEmptyOutputFilePath();
imgSqueezer.build();
imgSqueezer.compress();
```
## License
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).