Merge pull request #3 from johnnychen94/jc/encode

initial implementation for `jpeg_encode` and `jpeg_decode`

Author: johnnychen94

.github/workflows/UnitTest.yml

@@ -45,4 +45,20 @@ jobs:
       - uses: codecov/codecov-action@v2
         with:
           files: lcov.info
-
+  multithreads:
+    name: Julia (threads) 1 - ubuntu-latest - x64 - ${{ github.event_name }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+          arch: 'x64'
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@v1
+      - name: run test
+        run: julia --project --code-coverage -t4 -e 'using Pkg; Pkg.test()'
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v2
+        with:
+          files: lcov.info

Project.toml

@@ -5,9 +5,11 @@ version = "0.1.0"
 
 [deps]
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"
+ImageCore = "a09fc81d-aa75-5fe9-8630-4744c3626534"
 JpegTurbo_jll = "aacddb02-875f-59d6-b918-886e6ef4fbf8"
 
 [compat]
 CEnum = "0.3, 0.4"
+ImageCore = "0.8, 0.9"
 JpegTurbo_jll = "~2.1"
 julia = "1.6"

README.md

@@ -4,3 +4,44 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://johnnychen94.github.io/JpegTurbo.jl/dev)
 [![Build Status](https://github.com/johnnychen94/JpegTurbo.jl/actions/workflows/UnitTest.yml/badge.svg?branch=master)](https://github.com/johnnychen94/JpegTurbo.jl/actions/workflows/UnitTest.yml?query=branch%3Amaster)
 [![Coverage](https://codecov.io/gh/johnnychen94/JpegTurbo.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/johnnychen94/JpegTurbo.jl)
+
+JpegTurbo.jl is a Julia wrapper of the C library [libjpeg-turbo] that provides IO support for
+the JPEG image format.
+
+The main functionality of this package consist of two functions: `jpeg_encode` and `jpeg_decode`.
+Check the [function references](https://johnnychen94.github.io/JpegTurbo.jl/dev/reference) for more
+details.
+
+## API
+
+`jpeg_encode` is used to compress 2D colorant matrix as JPEG image.
+
+```julia
+jpeg_encode(filename::AbstractString, img; kwargs...) -> Int
+jpeg_encode(io::IO, img; kwargs...) -> Int
+jpeg_encode(img; kwargs...) -> Vector{UInt8}
+```
+
+`jpeg_decode` is used to decompress JPEG image as 2D colorant matrix.
+
+```julia
+jpeg_decode([T,] filename::AbstractString; kwargs...) -> Matrix{T}
+```
+
+## Feature set
+
+| function             | filename | IOStream | in-memory buffer     | pre-allocated output | multi-threads |
+| -------------------- | -------- | -------- | -------------------- | -------------------  | ------------- |
+| `jpeg_encode`        | x        | x        | x                    |                      | x             |
+| `jpeg_decode`        | x        |          |                      |                      | x             |
+| `ImageMagick.save`   | x        | x        | x                    |                      | x             |
+| `ImageMagick.load`   | x        | x        | x                    |                      | x             |
+| `QuartzImageIO.save` | x        | x        | x (`FileIO.Stream`)  |                      | x             |
+| `QuartzImageIO.load` | x        | x        | x (`FileIO.Stream`)  |                      | x             |
+
+Notes:
+
+- `x`: supported
+- empty: missing/unsupported yet
+
+[libjpeg-turbo]: https://github.com/libjpeg-turbo/libjpeg-turbo