kapy

Kapy is a simple utility designed to copy digital camera photos from an SD card to a disk with transformations. This tool streamlines the process of transferring photos from your camera to your computer, while also providing the ability to make any necessary image transformations during the copying process.

• Convert from JPEG to HEIC/AVIF to reduce image size
• Merge GPS information into EXIF from .gpx files on Google Drive
• Adjust image size and compression ratio based on EXIF rate information

Build

Build on macOS

If you use Homebrew (https://brew.sh/), you can easily install the required packages.
After installing Homebrew, you can install the required packages and build the application by running the following command:

$ brew install pkg-config imagemagick exiv2 libssh
$ CLIENT_ID={YOUR_CLIENT_ID} CLIENT_SECRET={YOUR_SECRET} cargo build

If you are not using Homebrew, please install the required packages below and set the corresponding environment variables accordingly:

• ImageMagick library (https://imagemagick.org/script/download.php)
  • IMAGE_MAGICK_DIR - installation directory of ImageMagick
  • IMAGE_MAGICK_LIB_DIRS - list of lib directories split by :
  • IMAGE_MAGICK_INCLUDE_DIRS - list of include directories split by :
  • IMAGE_MAGICK_LIBS - list of the libs to link to
• Exiv2 library (https://exiv2.org/download.html)
  • EXIV2_INCLUDE_DIRS - list of include directories split by :
  • EXIV2_LIB_DIRS - list of lib directories split by :
• libssh library (https://www.libssh.org/get-it/)
  • LIBSSH_INCLUDE_DIRS - list of include directories split by :
  • LIBSSH_LIB_DIRS - list of lib directories split by :

Build on Windows

Pre-requirements

• ImageMagick library (https://imagemagick.org/script/download.php)
  • Provides pre-built binary installers.
  • When installing, the checkbox for installing C/C++ header files should be selected.
  • You need to set the following Windows environment variable:
    • IMAGE_MAGICK_DIR={YOUR_MAGICK_INSTALLATION_DIR}
• Exiv2 library (https://exiv2.org/download.html)
  • Provides pre-built binaries as .zip compressed files.
  • You need to set the following Windows environment variables:
    • EXIV2_INCLUDE_DIRS={YOUR_EXIV2_INCLUDE_DIR}
    • EXIV2_LIB_DIRS={YOUR_EXIV_LIB_DIR}
• libssh library (https://www.libssh.org/get-it/)
  • Provided as a package in vcpkg the Microsoft's package manager.
  • vcpkg (https://vcpkg.io/en/getting-started.html) should be installed first.
  • After installation, install the library: vcpkg install --triplet=x64-windows libssh
  • You need to set the following Windows environment variables:
    • LIBSSH_INCLUDE_DIRS={YOUR_LIBSSH_INCLUDE_DIR}
    • LIBSSH_LIB_DIRS={YOUR_LIBSSH_LIB_DIR}
• clang library (https://releases.llvm.org/download.html)
  • Provides pre-built binary installers.
  • You need to set the following Windows environment variable:
    • LIBCLANG_PATH={YOUR_LLVM_BIN_DIR}
• NASM executable (https://www.nasm.us/)
  • Provides pre-built binary installer and only executables
  • You need to add the directory where executables were installed to your PATH.
• libheif library (https://github.com/strukturag/libheif)
  • Provided as a package in vcpkg the Microsoft's package manager.
  • vcpkg (https://vcpkg.io/en/getting-started.html) should be installed first.
  • After installation, install the library: vcpkg install --triplet=x64-windows-static-md
  • You need to set vcpkg related environment variables:
    • VCPKG_ROOT={YOUR_VCPKG_ROOT_DIR}
    • You need to append VCPKG_ROOT directory to your PATH environment.

Build

> set CLIENT_ID={YOUR_CLIENT_ID}
> set CLIENT_SECRET={YOUR_SECRET}
> set IMAGE_MAGICK_DIR={YOUR_MAGICK_INSTALLATION_DIR} 
> set EXIV2_INCLUDE_DIRS={YOUR_EXIV2_INCLUDE_DIR} 
> set EXIV2_LIB_DIRS={YOUR_EXIV_LIB_DIR}
> set LIBSSH_INCLUDE_DIRS={YOUR_LIBSSH_INCLUDE_DIR}
> set LIBSSH_LIB_DIRS={YOUR_LIBSSH_LIB_DIR}
> set LIBCLANG_PATH={YOUR_LLVM_BIN_DIR} 
> cargo build

Usage

$ kapy clone -c ~/.kapy.yaml --from /Volumes/Untitled/DCIM/108HASBL --to ~/images

Disclaimer

To access Google Drive API using your own Google OAuth 2.0 client_id and client_secret, you will need to set up a project on the Google Developers Console and create OAuth 2.0 credentials. Once you have obtained your credentials, you can set the CLIENT_ID and CLIENT_SECRET as environment variables or include them directly in your code.

$ CLIENT_ID={YOUR_CLIENT_ID} CLIENT_SECRET={YOUR_SECRET} kapy login
$ kapy clone

If you encounter login issues, you can log in again as follows.

$ kapy clean
$ CLIENT_ID={YOUR_CLIENT_ID} CLIENT_SECRET={YOUR_SECRET} kapy login

Or, you can assign CLIENT_ID and CLIENT_SECRET values at compile time.

$ CLIENT_ID={YOUR_CLIENT_ID} CLIENT_SECRET={YOUR_SECRET} cargo install kapy

OR

$ CLIENT_ID={YOUR_CLIENT_ID} CLIENT_SECRET={YOUR_SECRET} cargo build

The Google Drive API has a strict application approval process since it can access users' sensitive information. This application was originally created for my personal use, and it is difficult to comply with Google's strict approval process. You should refer to the following document to generate your own Google OAuth 2.0 credentials:

https://developers.google.com/identity/protocols/oauth2/native-app

The following API scopes must be specified:

• https://www.googleapis.com/auth/drive.metadata.readonly: See information about your Google Drive files.
• https://www.googleapis.com/auth/drive.readonly: See and download all your Google Drive files.

Configurations

• An example

default_path:
  from: /Volumes/Untitled/DCIM/108HASBL 
  to: ~/images
polices:
- rate: [5]
  commands:
   resize: 100%  # default value; ignore it
   format: preserve  # default value
- rate: [4]
  commands:
    quality: 95%
    format: heic
- rate: [1,2,3]
  commands:
    resize: 50% # resize image to 50%
    quality: 95%
    format: heic
- rate: [0]
  commands:
    resize: 36m # resize image to 36m pixels
    quality: 92%
    format: heic