vix - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #llm #android #machine-learning #rust #linux #nodejs #macos #java #cli #mcp #ios #openai

vix

(★ 249)

Elixir extension for libvips

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yaml
  - precompile.yaml
- from_binary.exs
- from_enum.exs
- mix.exs
- mix.lock
- op.exs
- stream.exs
- to_stream.exs
- precompiler.exs
- - g_boxed.c
  - g_boxed.h
  - g_object.c
  - g_object.h
  - g_param_spec.c
  - g_param_spec.h
  - g_type.c
  - g_type.h
  - g_value.c
  - g_value.h
- .clang-format
- Makefile
- pipe.c
- pipe.h
- utils.c
- utils.h
- vips_boxed.c
- vips_boxed.h
- vips_foreign.c
- vips_foreign.h
- vips_image.c
- vips_image.h
- vips_interpolate.c
- vips_interpolate.h
- vips_operation.c
- vips_operation.h
- vix.c
- - nif.ex
  - operator.ex
  - source_pipe.ex
  - target_pipe.ex
  - tensor.ex
  - type.ex
  - vips.ex
- auto_correct_rotation.livemd
- introduction.livemd
- picture-language.livemd
- rainbow.livemd
- build_libvips.sh
- download_toolchains.sh
- mirror_toolchains.sh
- - affine_puppies.jpg
  - alpha_band.png
  - black.jpg
  - black_on_white.jpg
  - black_on_white_hflip.jpg
  - boats.tif
  - conv_puppies.jpg
  - gradient.png
  - gravity_puppies.jpg
  - invert_puppies.jpg
  - puppies.jpg
  - puppies.raw
- - images.ex
- - foreign_test.exs
  - nif_test.exs
  - operator_test.exs
  - vips_test.exs
- test_helper.exs
.credo.exs
.formatter.exs
.gitignore
DEVELOPMENT.md
flake.lock
flake.nix
LICENSE
Makefile
mix.exs
mix.lock
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/akash-akya/vix

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd vix

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Make

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vix

[![CI](https://github.com/akash-akya/vix/actions/workflows/ci.yaml/badge.svg)](https://github.com/akash-akya/vix/actions/workflows/ci.yaml)
[![Hex.pm](https://img.shields.io/hexpm/v/vix.svg)](https://hex.pm/packages/vix)
[![docs](https://img.shields.io/badge/docs-hexpm-blue.svg)](https://hexdocs.pm/vix/)

Blazing fast image processing for Elixir powered by [libvips](https://libvips.github.io/libvips/), the same engine that powers [sharp.js](https://github.com/lovell/sharp).

## Perfect For

- Building image processing APIs and services
- Generating thumbnails at scale
- Image manipulation in web applications
- Computer vision preprocessing
- Processing large scientific/satellite images

## Features

- **High Performance**: Uses libvips' demand-driven, horizontally threaded architecture
- **Memory Efficient**: Processes images in chunks, perfect for large files
- **Streaming Support**: Read/write images without loading them fully into memory
- **Rich Ecosystem**: Zero-copy integration with [Nx](https://hex.pm/packages/nx) and [eVision](https://hex.pm/packages/evision)
- **Zero Setup**: Pre-built binaries for MacOS and Linux platforms included.
- **Auto-updating API**: New libvips features automatically available
- **Comprehensive Documentation**: [Type specifications and documentation](https://hexdocs.pm/vix/Vix.Vips.Operation.html) for 300+ operations

## Quick Start

```elixir
Mix.install([
  {:vix, "~> 0.23"}
])

alias Vix.Vips.{Image, Operation}

# Create a thumbnail and optimize for web
{:ok, thumb} = Operation.thumbnail("profile.jpg", 300)
:ok = Image.write_to_file(thumb, "thumbnail.jpg", Q: 90, strip: true, interlace: true)
```

[👉 Try in Livebook](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Fakash-akya%2Fvix%2Fblob%2Fmaster%2Flivebooks%2Fintroduction.livemd)

## Common Operations

### Basic Processing
```elixir
# Reading an image
{:ok, img} = Image.new_from_file("profile.jpg")

# Resize preserving aspect ratio
{:ok, resized} = Operation.resize(img, 0.5)  # 50% of original size

# Crop a section
{:ok, cropped} = Operation.extract_area(img, 100, 100, 500, 500)

# Rotate with white background
{:ok, rotated} = Operation.rotate(img, 90, background: [255, 255, 255])

# Smart thumbnail (preserves important features)
{:ok, thumb} = Operation.thumbnail("large.jpg", 300, size: :VIPS_SIZE_DOWN, crop: :VIPS_INTERESTING_ATTENTION)
```

### Web Optimization
```elixir
# Convert to WebP with quality optimization
:ok = Image.write_to_file(img, "output.webp", Q: 80, effort: 4)

# Create progressive JPEG with metadata stripped
:ok = Image.write_to_file(img, "output.jpg", interlace: true, strip: true, Q: 85)

# Generate multiple formats
:ok = Image.write_to_file(img, "photo.avif", Q: 60)
:ok = Image.write_to_file(img, "photo.webp", Q: 80)
:ok = Image.write_to_file(img, "photo.jpg", Q: 85)
```

### Filters & Effects
```elixir
# Blur
{:ok, blurred} = Operation.gaussblur(img, 3.0)

# Sharpen
{:ok, sharp} = Operation.sharpen(img, sigma: 1.0)

# Grayscale
{:ok, bw} = Operation.colourspace(img, :VIPS_INTERPRETATION_B_W)
```

### Advanced Usage
```elixir
# Smart thumbnail preserving important features
{:ok, thumb} = Operation.thumbnail(
  "large.jpg",
  300,
  size: :VIPS_SIZE_DOWN, # only downsize, it will just copy if asked to upsize
  crop: :VIPS_INTERESTING_ATTENTION
)

# Process image stream on the fly
{:ok, image} =
  File.stream!("large_photo.jpg", [], 65_536)
  |> Image.new_from_enum()
# use `image` for further operations...

# Stream image to S3
:ok =
  Image.write_to_stream(image, ".png")
  |> Stream.each(&upload_chunk_to_s3/1)
  |> Stream.run()
```

## Performance

Libvips very fast and uses very little memory. See the detailed [benchmark](https://github.com/libvips/libvips/wiki/Speed-and-memory-use). Resizing an image is typically 4x-5x faster than using the quickest ImageMagick settings. It can also work with very large images without completely loading them to the memory.

## Installation

Add Vix to your dependencies:

```elixir
def deps do
  [
    {:vix, "~> x.x.x"}
  ]
end
```

That's it! Vix includes pre-built binaries for MacOS & Linux.

## Advanced Setup

Want to use your system's libvips? Set before compilation:

```bash
export VIX_COMPILATION_MODE=PLATFORM_PROVIDED_LIBVIPS
```

Want to use a custom libvips install prefix instead of the system default? Set:

```bash
export VIX_COMPILATION_MODE=PLATFORM_PROVIDED_LIBVIPS
export VIX_LIBVIPS_PREFIX=/path/to/libvips/prefix
```

`VIX_LIBVIPS_PREFIX` is the libvips install prefix Vix should use, for example the path passed to Meson with `--prefix`.

From a Git checkout, developers can use `scripts/build_libvips.sh` as a starting point to build libvips.

See [libvips installation guide](https://www.libvips.org/install.html) and [DEVELOPMENT.md](DEVELOPMENT.md) for more details.

## Documentation & Resources

- [Complete API Documentation](https://hexdocs.pm/vix/)
- [Interactive Introduction (Livebook)](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Fakash-akya%2Fvix%2Fblob%2Fmaster%2Flivebooks%2Fintroduction.livemd)
- [Creating Rainbow Effects (Livebook)](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Fakash-akya%2Fvix%2Fblob%2Fmaster%2Flivebooks%2Frainbow.livemd)
- [Auto Document Rotation (Livebook)](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Fakash-akya%2Fvix%2Fblob%2Fmaster%2Flivebooks%2Fauto_correct_rotation.livemd)
- [Picture Language from SICP (Livebook)](https://livebook.dev/run?url=https%3A%2F%2Fgithub.com%2Fakash-akya%2Fvix%2Fblob%2Fmaster%2Flivebooks%2Fpicture-language.livemd)

## FAQ

### Should I use Vix or Image?

[Image](https://github.com/kipcole9/image) is a library which builds on top of Vix.

- Use [Image](https://github.com/kipcole9/image) when you need:
  - A more Elixir-friendly API for common operations
  - Higher-level operations like Blurhash
  - Simple, chainable functions for common operations

- Use Vix directly when you need:
  - Advanced VIPS features and fine-grained control
  - Complex image processing pipelines
  - Direct libvips performance and capabilities
  - Lesser dependencies

### What image formats are supported?
Out of the box: JPEG, PNG, WEBP, TIFF, SVG, HEIF, GIF, and more. Need others? Just install libvips with the required libraries!

## License

MIT License - see [LICENSE](LICENSE) for details.