Skip to main content

A tool for automatic photo enhancement using curve corrections.

Project description

AutoLevels

AutoLevels is a program for batch-processing images to fix common issues in a semi- or fully-automated fashion.

Purpose

When you encounter images scanned from analog film or poorly processed by automatic corrections, such as "backlight" or simply underexposed, you will find black/white points that are too high/low. Even worse, they can differ by channel and produce a weird glow in dark areas or color cast on the entire image. Photo editing apps typically have features like "autolevel" or "enhance contrast" that could be used in batch-processing. They set black and white points to zero and 255, respectively. These might overshoot the problem, and the result may appear unnatural, particularly if the original image has low contrast. They are also not very suitable for fixing color problems.

AutoLevels helps you fix these issues by letting you choose sensible target black/white points for a batch of images. It detects low-contrast images and treats them differently. Along the way, you can remove a constant color cast, change gamma and saturation. If your color cast or bad camera settings require a more complex curve correction, AutoLevels has you covered: try the AI-based free curve correction, which finds the optimal RGB curves for each image.

Features

  • Adjust black point, white point, gamma, and saturation
  • Fully automated curve-based color correction feature
  • Smooth/Histogram/Perceptive black/white point sampling
  • Automatically detect low-contrast images and apply sensible corrections
  • Export darktable XMP files for a professional non-destructive workflow
  • Support for 16/48-bit images (TIFF, PNG)
  • Apply ICC color profiles after corrections
  • Flexible definition of input/output files (glob pattern, prefix/suffix, Python f-string)
  • Preserves compression quality and metadata (EXIF, IPTC, XMP, ICC-profile)
  • Free Open Source Software (GPLv3)

Installation

Python 3.9 or later is required (avoid 3.14 until onnxruntime supports it or install their nightly build). On most Linux distributions, this is already pre-installed. Otherwise, download it from Python.org or install it via your favourite app store. Make sure you mark the checkbox "Add Python executable to PATH". Then, to install AutoLevels, open a shell (cmd on Windows) and execute:

pip install autolevels

This will install the current stable release. To get the latest version from the github repository (requires git), use

pip install git+https://github.com/yellowdolphin/autolevels.git

This will also install the following requirements if not found:

  • numpy
  • pillow
  • pyexiftools
  • opencv-python
  • h5py
  • onnxruntime

To use the fully automated curve correction feature, download the ONNX curve inference model and specify the downloaded .onnx file using the --model option:

autolevels --model ~/Downloads/free_xcittiny_wa14.onnx -- example.jpg

To preserve metadata whenever possible, ExifTool must be installed. For Linux, the easiest way is via your package manager, for example (Ubuntu/Debian):

sudo apt-get install libimage-exiftool-perl

To install ExifTool on Windows or MacOS, download the zip or pkg file from https://exiftool.org/ and follow the installation instructions. Make sure, the executable is added to your PATH.

Windows 10

The latest versions of onnxruntime don't support Windows 10. To use autolevels with automatic color correction on Windows 10, install Python version 3.13 or earlier (but not before version 3.9), then install autolevels (see above) and onnxruntime version 1.20.1:

pip install onnxruntime==1.20.1

Graphical User Interface

If you prefer a graphical user interface, you can checkout RetroShine, which is easier to install and provides a user-friendly interface for AutoLevels.

Documentation

Basic Usage

autolevels --blackpoint 10 --whitepoint 255 --gamma 1.1 -- example.jpg

This will process the file example.jpg and write the output to example_al.jpg using the default suffix "_al". You can change that with --outsuffix <my suffix> or specify an output folder with --outdir. See Batch Processing for more ways to define input and output file names.

You can either use the fully automated correction with the --model option or manually specify target values for the black and white points of your images with the --blackpoint and --whitepoint options. In the latter case, you can further adjust the scope of the correction by setting bounds for images with low contrast.

Get a description of all options with:

autolevels -h

Safely try out settings before writing any output files with --simulate or --sandbox. You can check file names, black/white point correction, as images are read and processed, but not saved.

autolevels --simulate --blackpoint 10 5 0 --mode perceptive -- *.jpg

Batch Processing

The power of batch processing lets you apply the same corrections to a batch of images with a common capture source, camera settings, lighting conditions, or any common issue that can be fixed in a semi-automated fashion. If you don't have the time or expertise to find the optimal parameters, you can leverage AI power using the --model option. This will correct each image with individual RGB curves, fully automatic, correcting color casts, bad exposure, or white balance settings on the fly.

This leaves you with defining input and output files and paths. AutoLevels gives you three ways to do that.

  1. Folders and glob patterns

    autolevels --outdir processed -- scans/*.png IMG_00[0-3]?.jpg
    

    Your shell will interpret these glob patterns and expand the file names to scans/12.png scans/23.png IMG_0015.jpg ... matching any existing files in the current directory. All output files are written to the specified folder processed.

    If you are afraid the expanded list of file paths exceeds the shell limit for the length of a command, you can specify a folder for the input files and enter the glob pattern in quotes to escape shell expansion:

    autolevels --folder ~/Pictures/scans -- "*.tif"
    
  2. Prefixes and Suffixes Often, your input file names will have a common folder, prefix, suffix, and some variable part in between. You may want to keep the variable part and change any of the fixed components, for example:

    autolevels --folder orig --prefix scn --suffix .jpg --outfolder processed --outprefix img_ --outsuffix .jpg -- 1 2 3 4
    

    This will search for input files orig/scn1.jpg ... and write output files processed/img_1.jpg ...

  3. Python f-strings An alternative way to define file names in AutoLevels is to use Python f-strings. Don't worry, no Python skills required, just look at this example:

    variable = 42
    f"orig/scn_{variable:04d}.jpg"
    

    This is proper Python code and evaluates to "orig/scn_0042.jpg". The part in curly brackets contains a variable name and (after the :) an optional format instruction for integer numbers d, which shall have leading 0s to make 4 digits.

    If you provide an f-string to the --fstring or --outfstring options (you can skip the "f" before the quotes), AutoLevels substitutes variable by any values given instead of file names:

    autolevels --fstring "orig/scn{i}.jpg" --outfstring "processed/img_{i:04d}.jpg" -- 1 2 3
    

    This will read files orig/scn1.jpg ... and write processed/img_0001.jpg ... to disk.

Exporting darktable XMP files

You can use AutoLevels as an automatic preprocessing step in a professional, non-destructive workflow using darktable. The idea is to establish a baseline color correction with the --model option and export the curves to darktable, where you can fine-tune them or proceed with your normal darktable workflow.

The recommended way to use AutoLevels curves in darktable is to install the darktable-autolevels-module Lua script, which you can activate via the scripts module in the lighttable view. An AutoLevels module will appear in the same panel. Click the little file browser button to search for the downloaded .onnx file. Then select images and press the "add AutoLevels curve" button. Changing to the darkroom, you will find a new history item that adds an rgb curve instance in mode "RGB, independent channels". Feel free to make adjustments to the curves, the original curves will remain in the history, until you compress it.

You might notice that the rgb curve instance created by AutoLevels is applied right before the input color profile module. This is where the channel-wise color correction works most effectively for JPEGs and most HDR images (RAW formats are not yet supported by the script). If you create a new rgb curve instance, this will appear at the usual place in the pipeline.

Under the hood, the Lua script calls autolevels with the --export darktable <version> argument:

autolevels --model ~/Downloads/free_xcittiny_wa14.onnx --export darktable 5.3.0 --outsuffix .jpg.xmp -- myimage.jpg

AutoLevels reads the XMP sidecar file associated with each selected image (or duplicate). It is passed via the --outsuffix option. If the XMP file does not exist, AutoLevels will create a minimal one with the default auto-apply presets. The --outsuffix option is optional and prevents AutoLevels from creating an output image if its value ends with ".xmp".

If you want to call AutoLevels with the --export darktable option outside of darktable, note that darktable only reads XMP files on import if you have activated the look for updated XMP files on startup option in preferences/storage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autolevels-1.3.6.tar.gz (237.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autolevels-1.3.6-py3-none-any.whl (52.6 kB view details)

Uploaded Python 3

File details

Details for the file autolevels-1.3.6.tar.gz.

File metadata

  • Download URL: autolevels-1.3.6.tar.gz
  • Upload date:
  • Size: 237.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.33.1

File hashes

Hashes for autolevels-1.3.6.tar.gz
Algorithm Hash digest
SHA256 da85d235fb6a04cdb28c9ee584601bd826cdcdfc5064964acd6b4b076d8cd010
MD5 f54a11e94d3554c54ca1c16bc2a41ed6
BLAKE2b-256 b4186cc17773a96f921b9e1548c35022f584e5ee18ebf43428306c31c3487ae6

See more details on using hashes here.

File details

Details for the file autolevels-1.3.6-py3-none-any.whl.

File metadata

  • Download URL: autolevels-1.3.6-py3-none-any.whl
  • Upload date:
  • Size: 52.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.33.1

File hashes

Hashes for autolevels-1.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ce7932819ba3192378c2d5280315b7da8e3cb749692f4d5f4fcbf9d259ab894b
MD5 3e09b07b4b09bc0aa278ceefa00f1eee
BLAKE2b-256 1b6b0870ead25b667d35017083d1e43a0d9ae7b82d4e24917d5858f88ef06bb7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page