npm package: @shiguredo/light-adjustment
Description: Light Adjustment Library
Author: Shiguredo Inc.
Latest version: 2024.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# @shiguredo/light-adjustment

[![npm version](https://badge.fury.io/js/@shiguredo%2Flight-adjustment.svg)](https://badge.fury.io/js/@shiguredo%2Flight-adjustment)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

ブラウザで映像のライト調整機能を実現するためのライブラリです。

光量が不足している画像のコントラストを改善したり、逆光で暗くなっている人物を明るくすることができます。

なお、画像内の人物部分の切り出し部分には[@mediapipe/selfie_segmentation](https://www.npmjs.com/package/@mediapipe/selfie_segmentation)を利用しています。

## 使い方

### ブラウザから利用する場合

まずは script タグで JavaScript ファイルを読み込みます:
```html
<script src="https://cdn.jsdelivr.net/npm/@shiguredo/light-adjustment@latest/dist/light_adjustment.js"></script>
```

デフォルト設定でライト調整を行うコードは以下のようになります:
```html
<video id="outputVideo" autoplay></video>
<script>
    const processor = new Shiguredo.LightAdjustmentProcessor();

    navigator.mediaDevices.getUserMedia({video: true}).then((stream) => {
        const track = stream.getVideoTracks()[0];

        // 処理を開始
        processor.startProcessing(track).then((processed_track) => {
            const videoElement = document.getElementById("outputVideo"); // 映像の出力先を取得
            videoElement.srcObject = new MediaStream([processed_track]);
        });
    });
    ...

    // 処理を終了
    processor.stopProcessing();
</script>
```

`startProcessing()` の第二引数にはオプションを指定することができます:

```javascript
const assetsPath = "https://cdn.jsdelivr.net/npm/@shiguredo/light-adjustment@latest/dist";

const options = {
    // 画像内の人物部分にフォーカスしてライト調整を行うようにする
    "focusMask": new Shiguredo.SelfieSegmentationFocusMask(assetsPath)
};

processor.startProcessing(track, options).then((processed_track) => {
    ...
});
```

実際の動作は[デモページ](https://shiguredo.github.io/media-processors/light-adjustment/)（
[ソースコード](https://github.com/shiguredo/media-processors/blob/develop/examples/light-adjustment/main.mts)）で確認できます。


### JavaScript/TypeScript から利用する場合

以下のコマンドでパッケージがインストールできます:
```
$ npm install --save @shiguredo/light-adjustment
```

TypeScript での使用方法は次のようになります:
```typescript
import { LightAdjustmentProcessor } from "@shiguredo/light-adjustment";

const processor = new LightAdjustmentProcessor();
const processed_video_track = await processor.startProcessing(original_video_track);

...

processor.stopProcessing();
```

## サポートブラウザ

本ライブラリは Chrome や Edge 等の Chromium ベースのブラウザか Safari (15.4 以降）で動作します。
それぞれのブラウザでは、映像処理を効率的に行うために以下の機能を利用しています:
- **Chromium ベースブラウザ**: MediaStreamTrack Insertable Streams (aka Breakout Box)
- **Safari**: HTMLVideoElement.requestVideoFrameCallback メソッド

## ライセンス

[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)

```
Copyright 2023-2023, Takeru Ohta (Original Author)
Copyright 2023-2023, Shiguredo Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

npm パッケージに同梱されている以下のファイルのライセンスについては
[@mediapipe/selfie_segmentation](https://www.npmjs.com/package/@mediapipe/selfie_segmentation) を参照してください:
```
- selfie_segmentation.binarypb
- selfie_segmentation_landscape.tflite
- selfie_segmentation_solution_simd_wasm_bin.wasm
- selfie_segmentation_solution_wasm_bin.wasm
- selfie_segmentation.tflite
- selfie_segmentation_solution_simd_wasm_bin.js
- selfie_segmentation_solution_wasm_bin.js
```