Skip to content

bean-mhm/flim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

59 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎞️ flim - Filmic Color Transform

Introduction

flim is an experimental film emulation transform that can be used for:

  1. Displaying Digital Open-Domain (HDR) Images
  2. Color Grading
  3. Post-Processing in Video Games and Shaders ("tone-mapping")

flim comes with 2 presets, but you can add your own presets with their custom parameters!

  • default: The default preset provides a generic look that works well on most images.
  • silver: Gives a slightly different look.

grace

grace is a generic OpenColorIO config I've made which contains the latest version of flim and its presets, along with other useful elements. I suggest you use grace instead of the test config that comes with flim's releases.

Eye Candy

  • See comparisons between native sRGB, AgX, and flim's presets in the releases section.

  • You can find links to collections of OpenEXR image files for testing in Useful Links.

  • Below are some example images gone through flim's different presets (v1.1.0).

13 - SRIC_arri_alexa35 01025 - 2 flim (default)

14 - SRIC_arri_alexa35 01033 - 2 flim (default)

46 - blue_bar_709 - 2 flim (default)

26 - SRIC_hdm-vmlab-hdr 01032 - 3 flim (silver)

32 - SRIC_red 01004 - 2 flim (default)

35 - SRIC_red 01006 - 3 flim (silver)

43 - pretville_street_4k - 3 flim (silver)

55 - lakeside_2k - 2 flim (default)

Releases

Here's what each new release contains:

  • 3D LUTs for flim

  • An OpenColorIO config containing AgX and flim's presets as view transforms

  • Comparisons between flim and other view transforms

See the latest release here.

Using the Config

As mentioned above, each new release comes with a config containing flim and AgX. If your DCC software supports OpenColorIO for color management, you should be able to use flim's config. In Blender, for example, you can swap the contents of the colormanagement folder with the contents of the config you want to use, after making a backup of Blender's default config (the Filmic config, made by the author of AgX, Troy Sobotka).

[Blender Installation Path]/X.X/datafiles/colormanagement

I recommend you take a look at the Filmic and the AgX configs. Troy is a very respectful and experienced person in this area, and I've learned a lot from him, even while making flim. Feel free to also check out their IMDb page, and their blog, The Hitchhiker's Guide to Digital Colour.

Scripts

The code is structured in the following way:

Script Role Uses
main.py Compiles 3D LUTs for flim flim.py
flim.py Transforms a given linear 3D LUT table utils.py
utils.py Contains helper functions -

You can add new presets in main.py, or play with the film emulation chain in flim.py.

Here are the external libraries required to run the scripts:

Using the LUTs

First, a few notes:

  • flim's 3D LUTs are designed to be used in an OpenColorIO (OCIO) environment, but depending on your software and environment, you might be able to manually replicate the transforms in your custom pipeline (See Non-OCIO Guide below).

  • flim only supports the sRGB display format as of now.

If you don't want to:

  1. Use the test OCIO configs that come with flim's releases,
  2. Use OCIO at all, You can use the information below to manually use flim's 3D LUTs.

If main.py runs successfully, you should see files named like flim_X.spi3d in the same directory. Alternatively, you can look up the latest LUTs in the releases section.

The LUT comments contain most of the information you need. The following is an example of the LUT comments (note that this might not match the latest version).

# -------------------------------------------------
# 
# flim v1.1.0 - Filmic Color Transform
# 
# Preset: default
# URL: None
# 
# LUT input is expected to be in Linear BT.709 I-D65 and gone through an AllocationTransform like the following:
# !<AllocationTransform> {allocation: lg2, vars: [-10, 10, 0.0009765625]}
# 
# Output will be in sRGB 2.2.
# 
# Here's how you can add this to an OpenColorIO config:
colorspaces:
  - !<ColorSpace>
    name: flim (default)
    family: Image Formation
    equalitygroup: ""
    bitdepth: unknown
    description: flim v1.1.0 - https://github.com/bean-mhm/flim
    isdata: false
    allocation: uniform
    from_scene_reference: !<GroupTransform>
      children:
        - !<ColorSpaceTransform> {src: reference, dst: Linear BT.709 I-D65}
        - !<RangeTransform> {min_in_value: 0., min_out_value: 0.}
        - !<AllocationTransform> {allocation: lg2, vars: [-10, 10, 0.0009765625]}
        - !<FileTransform> {src: flim_default.spi3d, interpolation: linear}
# Explanation:
#   1. ColorSpaceTransform converts the input from the scene reference to Linear BT.709 I-D65. If this is named
#      differently in your config (for example Linear Rec.709), change the name manually.
#   2. RangeTransform clips negative values. You might want to use a gamut compression algorithm before this step.
#   3. AllocationTransform is for LUT compression, it takes the log2 of the RGB values and maps them from a
#      specified range (the first two values after 'vars') to [0, 1]. The third value is the offset applied to the
#      values before log2. This is done to keep the blacks.
#   4. Lastly, the FileTransform references the 3D LUT and defines a trilinear interpolation method.
# 
# Adding this as a view transform is pretty straightforward:
displays:
  sRGB:
    - !<View> {name: flim (default), colorspace: flim (default)}
    ... (other view transforms here)
# 
# Repo:
# https://github.com/bean-mhm/flim
# 
# Read more:
# https://opencolorio.readthedocs.io/en/latest/guides/authoring/authoring.html#how-to-configure-colorspace-allocation
# 
# -------------------------------------------------

Non-OCIO Guide

After reading the explanations above, you should be able to replicate the transforms fairly easily in order to use flim's 3D LUTs in your own pipeline without OCIO. The following pseudo-code demonstrates the general process to transform a single RGB triplet (note that this might not match the latest version).

# Input RGB values (color space: Linear BT.709 I-D65)
col = np.array([4.2, 0.23, 0.05])

# RangeTransform
# Clip negative values, or use a gamut compression algorithm.
col = np.maximum(col, 0.0)

# AllocationTransform
col += 0.0009765625  # offset by 2 to the power of -10 (lower bound of log2 compression)
col = np.log2(col)
col = map_range(col, from=[-10, 10], to=[0, 1], clamp=True)

# Sample from the 3D LUT (output color space: sRGB 2.2)
out = lut.sample(TRILINEAR, col)

3D LUT Visualization

LUT Compression

As you saw above, flim uses logarithmic compression to fit an extremely large range of linear values without losing too much precision. The method is very simple. You take the log2 of your RGB values and map them from a large range (for example [-10, +10]) to the [0, 1] range. You can also add a tiny offset to the RGB values before taking the log2, in order to preserve tiny values all the way down to 0.

Shadertoy

I made a GLSL port of flim on Shadertoy, check it out here!

image

Useful Links