RawPedia - User contributions [en]

Demosaicing

2018-11-29T19:04:00Z

Ingo: /* Method */

{{1:1}}

[[File:Chipincamera.jpg|thumb|Cutaway illustration of a camera showing the light sensor with a Bayer filter.]]
[[File:Bayer pattern on sensor.svg|thumb|Bayer pattern on sensor.]]
[[File:Bayer pattern on sensor profile.svg|thumb|Profile/cross-section of sensor.]]
Most digital cameras today use a [https://en.wikipedia.org/wiki/Color_filter_array color filter array] over their sensors. To display such raw files their data needs to be [http://www.cambridgeincolour.com/tutorials/camera-sensors.htm demosaiced]. Cameras with a [https://en.wikipedia.org/wiki/Foveon_X3_sensor Foveon X3 sensor] (Sigma) do not have color filter arrays and so do not need demosaicing. Demosaicing is why opening a raw file always takes a bit longer than opening a [https://en.wikipedia.org/wiki/JPEG JPEG] or [https://en.wikipedia.org/wiki/TIFF TIFF] file, where the data is already 'display-ready'. RawTherapee offers several demosaicing algorithms, each with its own characteristics. The differences between them are often very subtle - one might need to zoom in to 200-400% to discern them - but since the program works on a pixel-by-pixel basis and demosaicing is the basis upon which all other tools work, the choice of demosaicing algorithm can have a visually significant effect when combined with other tools, such as the sharpening ones. The choice of a certain algorithm influences, among other things, the quality of very fine details in the image, whether false maze patterns will appear, and decides how well colored edges are rendered.

RawTherapee supports demosaicing images from sensors with [https://en.wikipedia.org/wiki/Bayer_filter Bayer filters] and [https://en.wikipedia.org/wiki/Bayer_filter#Fujifilm_.22X-Trans.22_filter Fujifilm X-Trans filters]. If you take a look inside the "Raw" tab, you will notice there are two tools: "Sensor with Bayer Matrix" and "Sensor with X-Trans Matrix". The settings in one of these two tools have no influence over the settings in the other - if you open a raw image from a Bayer-type sensor, only the settings from the "Sensor with Bayer Matrix" tool will be used, the settings from the "Sensor with X-Trans Matrix" tool will be ignored, and vice versa if you open a raw image from an X-Trans type sensor. For simplicity, we will describe both here.

== Method ==
The following demosaicing algorithms are available for raw files from Bayer sensors:
* AMaZE
* AMaZE+VNG4
* RCD
* RCD+VNG4
* DCB
* DCB+VNG4
* LMMSE
* IGV
* AHD
* EAHD
* HPHD
* VNG4
* Fast
* Mono
* Pixel Shift
* None

The following demosaicing algorithms are available for raw files from X-Trans sensors:
* 3-pass+fast
* 3-pass (Markesteijn)
* 1-Pass+fast
* 1-Pass (Markesteijn)
* Fast
* Mono
* None

<div align="center">
<gallery caption="Comparison of RawTherapee's demosaicing algorithms" perrow="10">
Image:Demosaicing city1 amaze.png|AMaZE
Image:Demosaicing city1 igv.png|IGV
Image:Demosaicing city1 lmmse.png|LMMSE
Image:Demosaicing city1 eahd.png|EAHD
Image:Demosaicing city1 hphd.png|HPHD
Image:Demosaicing city1 vng4.png|VNG4
Image:Demosaicing city1 dcb.png|DCB
Image:Demosaicing city1 ahd.png|AHD
Image:Demosaicing city1 fast.png|Fast
Image:Demosaicing city1 none.png|None
</gallery>
</div>

Which demosaicing method should you use?<br>
This page aims to tell you as much about the various algorithms as is relevant to a photographer, but there is no much to say as the explanations would quickly become technical and of a programmatical and mathematical nature. After reading though this article you should know that LMMSE and IGV are to be used on high ISO photos and that for the majority of other cases you should stick with the default AMaZE method, but of course you are free to explore for yourself and to test each method out on your own raw files. It is of no use reading an article somewhere on the internet which claims that some specific method is best because in their test that method was the sharpest, as the performance of each method depends specifically on the sensor in your camera and even on ISO, so keeping our suggestions in mind, run your own test and make up your own mind!

RawTherapee versions 4.2.91 and newer always use the demosaicing method you choose regardless of zoom level.
RawTherapee versions older than 4.2.91 use the Fast algorithm to initially open the image for editing. After this, the selected demosaicing method is applied when the image is zoomed to 100% magnification or when the detail window is opened. The selected method is also used for batch processing. It is not recommended to select the Fast method for the final conversion, as it is a low-quality algorithm for display purposes.

'''AMaZE''' (Aliasing Minimization and Zipper Elimination) is the default demosaicing method, as it yields the best results in most cases. In RawTherapee versions 2.4 and older VNG4 used to be the preferred algorithm for Olympus cameras, as AMaZE didn't exist yet and VNG4 eliminated certain maze pattern artifacts that might have been created by the other methods, but with the introduction of the AMaZE method in RawTherapee version 3.0 Olympus users might prefer that instead.

'''RCD''' does an excellent job for round edges, for example stars in astrophotography, while preserving almost the same level of detail as AMaZE.

'''DCB''' produces similar results to AMaZE. AMaZE can often be slightly superior in recovering details, while DCB can be better at avoiding false colors especially in images from cameras without anti-aliasing filters.

When working with very noisy, high ISO images in conjunction with the [[Noise Reduction]] tool, it is recommended to use the '''LMMSE''' or '''IGV''' demosaicing methods. They will prevent false maze patterns from appearing, and prevent the image from looking washed-out due to heavy noise reduction.

If you use a medium format technical camera with near-symmetrical wide angle lenses such as the Schneider Digitar 28mm or 35mm it's likely that your file will contain some crosstalk, especially if the lens is shifted (due to the low angle of incoming light from these lenses some light leaks over to the next pixel on the sensor), and in this case you can get mazing artifacts with AMaZE and DCB because of green channel separation caused by the crosstalk. If you, via adapters, combine a mirrorless camera with a wide angle lens designed for film, you may also get crosstalk. It can then be better to use the more robust '''VNG4''' algorithm (Variable Number of Gradients) which handles this situation well, at the cost of some fine detail. An alternative is to enable [[Preprocessing#Green Equilibration|green equilibration]] to even-out the green channel differences.

'''AHD''' (Adaptive Homogeneity-Directed), '''EAHD''' (Horvath's AHD) and '''HPHD''' (Heterogeneity-Projection Hard-Decision) are old methods which are generally slow and inferior to the other methods.

'''None''' means no demosaicing is performed. This can be useful for diagnostics, but you would not use it for photography.

'''Mono''' is only useful for users of either monochrome cameras, or cameras with the color filter array removed.

'''Fast''' is a very fast but simple and low quality demosaicing method, not recommended.

'''3-Pass''' is a demosaicing method for cameras with X-Trans sensors (Fuji). It runs three passes over the image which leads to sharper results though you can only see this on low ISO photos. It is slower than 1-Pass.

'''1-Pass''' is a demosaicing method for cameras with X-Trans sensors (Fuji). It is faster than the 3-Pass method though a bit inferior in quality, though this difference is only visible in low ISO shots, so if speed is an issue you can use this method on high ISO shots with no visual difference in quality.

=== False Color Suppression Steps ===
Sets the number of median filter passes applied to suppress demosaicing artifacts when applying the demosaicing algorithm. False colors (speckles) could be introduced during the demosaicing phase where very fine detail is resolved. False color suppression is similar to color smoothing. The luminance channel is not affected by this suppression.

False colors are generally more apparent in images from cameras without anti-aliasing filters. Note that it is foremost the chosen demosaicing algorithm which is the deciding factor in how prominent will be the false color problem with which you will have to deal. In some situations it may be better to change the demosaicing algorithm than to enable false color suppression, as the latter reduces color resolution.

=== How to Find the Best Demosaicing Method ===
[[image:demosaicing_city1_example_bad.jpg|thumb|A good image to test the demosaicing algorithms on. Zoomed in to 800%, you can clearly see that VNG4 is not a good choice for this Pentax K10D raw file, as there are dots where there should be none, and the detail of the wall’s brickwork (the orange part on the right) is all washed out.]]
Zoom in to at least 100% (1:1) and try all the demosaicing algorithms, see which works best for you. Try them on sharp photos with fine detail and tiny patterns, such as the wavy and repetitive fabric of a sweater (watch for maze pattern artifacts), a distant brick wall, a distant round road sign (watch for aliasing along the round edges), and test with both low and high ISO shots. Use photos from your own camera; what's best for Nikon raw images may not be what's best for Olympus ones.

=== Monochrome Cameras ===
A monochrome camera has the same light filter in front of all pixels, that is you get a black-and-white image and no demosaicing is required. Some of these cameras have no infrared filter and are thus sensitive to infrared light, which can be used for creative black and white photography.

RawTherapee supports monochrome cameras, but the user interface is not adapted for it so when you load a monochrome file all color tools will still be enabled (they won't do anything meaningful of course). You will have to live with that, monochrome cameras are rare so we won't put any major effort into making the user interface morph into reduced monochrome-only version.

There are a few additional factors to consider when working with monochrome files: some monochrome cameras report that they have only a single monochrome channel and a neutral color matrix, like Leica M Monochrom, while others report RGB channels in a bayer configuration (like Phase One IQ260 Achromatic, or IR-modified cameras). If the camera reports only one channel, RawTherapee recognizes this and won't perform any demosaicing (the demosaicer selection is still enabled but does not do anything), and everything works normally. However, if the camera reports as an RGB bayer camera, demosaicing will be performed and a color matrix will be applied. To disable this, you should select the "Mono" demosaicing option, and select "No profile" as [[Color_Management#Input_Profile|input profile]] in the Color Management panel.

Demosaicing

2018-11-29T18:44:47Z

Ingo: /* Method */

{{1:1}}

[[File:Chipincamera.jpg|thumb|Cutaway illustration of a camera showing the light sensor with a Bayer filter.]]
[[File:Bayer pattern on sensor.svg|thumb|Bayer pattern on sensor.]]
[[File:Bayer pattern on sensor profile.svg|thumb|Profile/cross-section of sensor.]]
Most digital cameras today use a [https://en.wikipedia.org/wiki/Color_filter_array color filter array] over their sensors. To display such raw files their data needs to be [http://www.cambridgeincolour.com/tutorials/camera-sensors.htm demosaiced]. Cameras with a [https://en.wikipedia.org/wiki/Foveon_X3_sensor Foveon X3 sensor] (Sigma) do not have color filter arrays and so do not need demosaicing. Demosaicing is why opening a raw file always takes a bit longer than opening a [https://en.wikipedia.org/wiki/JPEG JPEG] or [https://en.wikipedia.org/wiki/TIFF TIFF] file, where the data is already 'display-ready'. RawTherapee offers several demosaicing algorithms, each with its own characteristics. The differences between them are often very subtle - one might need to zoom in to 200-400% to discern them - but since the program works on a pixel-by-pixel basis and demosaicing is the basis upon which all other tools work, the choice of demosaicing algorithm can have a visually significant effect when combined with other tools, such as the sharpening ones. The choice of a certain algorithm influences, among other things, the quality of very fine details in the image, whether false maze patterns will appear, and decides how well colored edges are rendered.

RawTherapee supports demosaicing images from sensors with [https://en.wikipedia.org/wiki/Bayer_filter Bayer filters] and [https://en.wikipedia.org/wiki/Bayer_filter#Fujifilm_.22X-Trans.22_filter Fujifilm X-Trans filters]. If you take a look inside the "Raw" tab, you will notice there are two tools: "Sensor with Bayer Matrix" and "Sensor with X-Trans Matrix". The settings in one of these two tools have no influence over the settings in the other - if you open a raw image from a Bayer-type sensor, only the settings from the "Sensor with Bayer Matrix" tool will be used, the settings from the "Sensor with X-Trans Matrix" tool will be ignored, and vice versa if you open a raw image from an X-Trans type sensor. For simplicity, we will describe both here.

== Method ==
The following demosaicing algorithms are available for raw files from Bayer sensors:
* AMaZE
* AMaZE+VNG4
* RCD
* RCD+VNG4
* DCB
* DCB+VNG4
* LMMSE
* IGV
* AHD
* EAHD
* HPHD
* VNG4
* Fast
* Mono
* Pixel Shift
* None

The following demosaicing algorithms are available for raw files from X-Trans sensors:
* 3-pass+fast
* 3-pass (Markesteijn)
* 1-Pass+fast
* 1-Pass (Markesteijn)
* Fast
* Mono
* None

<div align="center">
<gallery caption="Comparison of RawTherapee's demosaicing algorithms" perrow="10">
Image:Demosaicing city1 amaze.png|AMaZE
Image:Demosaicing city1 igv.png|IGV
Image:Demosaicing city1 lmmse.png|LMMSE
Image:Demosaicing city1 eahd.png|EAHD
Image:Demosaicing city1 hphd.png|HPHD
Image:Demosaicing city1 vng4.png|VNG4
Image:Demosaicing city1 dcb.png|DCB
Image:Demosaicing city1 ahd.png|AHD
Image:Demosaicing city1 fast.png|Fast
Image:Demosaicing city1 none.png|None
</gallery>
</div>

Which demosaicing method should you use?<br>
This page aims to tell you as much about the various algorithms as is relevant to a photographer, but there is no much to say as the explanations would quickly become technical and of a programmatical and mathematical nature. After reading though this article you should know that LMMSE and IGV are to be used on high ISO photos and that for the majority of other cases you should stick with the default AMaZE method, but of course you are free to explore for yourself and to test each method out on your own raw files. It is of no use reading an article somewhere on the internet which claims that some specific method is best because in their test that method was the sharpest, as the performance of each method depends specifically on the sensor in your camera and even on ISO, so keeping our suggestions in mind, run your own test and make up your own mind!

RawTherapee versions 4.2.91 and newer always use the demosaicing method you choose regardless of zoom level.
RawTherapee versions older than 4.2.91 use the Fast algorithm to initially open the image for editing. After this, the selected demosaicing method is applied when the image is zoomed to 100% magnification or when the detail window is opened. The selected method is also used for batch processing. It is not recommended to select the Fast method for the final conversion, as it is a low-quality algorithm for display purposes.

'''AMaZE''' (Aliasing Minimization and Zipper Elimination) is the default demosaicing method, as it yields the best results in most cases. In RawTherapee versions 2.4 and older VNG4 used to be the preferred algorithm for Olympus cameras, as AMaZE didn't exist yet and VNG4 eliminated certain maze pattern artifacts that might have been created by the other methods, but with the introduction of the AMaZE method in RawTherapee version 3.0 Olympus users might prefer that instead.

'''DCB''' produces similar results to AMaZE. AMaZE can often be slightly superior in recovering details, while DCB can be better at avoiding false colors especially in images from cameras without anti-aliasing filters.

When working with very noisy, high ISO images in conjunction with the [[Noise Reduction]] tool, it is recommended to use the '''LMMSE''' or '''IGV''' demosaicing methods. They will prevent false maze patterns from appearing, and prevent the image from looking washed-out due to heavy noise reduction.

If you use a medium format technical camera with near-symmetrical wide angle lenses such as the Schneider Digitar 28mm or 35mm it's likely that your file will contain some crosstalk, especially if the lens is shifted (due to the low angle of incoming light from these lenses some light leaks over to the next pixel on the sensor), and in this case you can get mazing artifacts with AMaZE and DCB because of green channel separation caused by the crosstalk. If you, via adapters, combine a mirrorless camera with a wide angle lens designed for film, you may also get crosstalk. It can then be better to use the more robust '''VNG4''' algorithm (Variable Number of Gradients) which handles this situation well, at the cost of some fine detail. An alternative is to enable [[Preprocessing#Green Equilibration|green equilibration]] to even-out the green channel differences.

'''AHD''' (Adaptive Homogeneity-Directed), '''EAHD''' (Horvath's AHD) and '''HPHD''' (Heterogeneity-Projection Hard-Decision) are old methods which are generally slow and inferior to the other methods.

'''None''' means no demosaicing is performed. This can be useful for diagnostics, but you would not use it for photography.

'''Mono''' is only useful for users of either monochrome cameras, or cameras with the color filter array removed.

'''Fast''' is a very fast but simple and low quality demosaicing method, not recommended.

'''3-Pass''' is a demosaicing method for cameras with X-Trans sensors (Fuji). It runs three passes over the image which leads to sharper results though you can only see this on low ISO photos. It is slower than 1-Pass.

'''1-Pass''' is a demosaicing method for cameras with X-Trans sensors (Fuji). It is faster than the 3-Pass method though a bit inferior in quality, though this difference is only visible in low ISO shots, so if speed is an issue you can use this method on high ISO shots with no visual difference in quality.

=== False Color Suppression Steps ===
Sets the number of median filter passes applied to suppress demosaicing artifacts when applying the demosaicing algorithm. False colors (speckles) could be introduced during the demosaicing phase where very fine detail is resolved. False color suppression is similar to color smoothing. The luminance channel is not affected by this suppression.

False colors are generally more apparent in images from cameras without anti-aliasing filters. Note that it is foremost the chosen demosaicing algorithm which is the deciding factor in how prominent will be the false color problem with which you will have to deal. In some situations it may be better to change the demosaicing algorithm than to enable false color suppression, as the latter reduces color resolution.

=== How to Find the Best Demosaicing Method ===
[[image:demosaicing_city1_example_bad.jpg|thumb|A good image to test the demosaicing algorithms on. Zoomed in to 800%, you can clearly see that VNG4 is not a good choice for this Pentax K10D raw file, as there are dots where there should be none, and the detail of the wall’s brickwork (the orange part on the right) is all washed out.]]
Zoom in to at least 100% (1:1) and try all the demosaicing algorithms, see which works best for you. Try them on sharp photos with fine detail and tiny patterns, such as the wavy and repetitive fabric of a sweater (watch for maze pattern artifacts), a distant brick wall, a distant round road sign (watch for aliasing along the round edges), and test with both low and high ISO shots. Use photos from your own camera; what's best for Nikon raw images may not be what's best for Olympus ones.

=== Monochrome Cameras ===
A monochrome camera has the same light filter in front of all pixels, that is you get a black-and-white image and no demosaicing is required. Some of these cameras have no infrared filter and are thus sensitive to infrared light, which can be used for creative black and white photography.

RawTherapee supports monochrome cameras, but the user interface is not adapted for it so when you load a monochrome file all color tools will still be enabled (they won't do anything meaningful of course). You will have to live with that, monochrome cameras are rare so we won't put any major effort into making the user interface morph into reduced monochrome-only version.

There are a few additional factors to consider when working with monochrome files: some monochrome cameras report that they have only a single monochrome channel and a neutral color matrix, like Leica M Monochrom, while others report RGB channels in a bayer configuration (like Phase One IQ260 Achromatic, or IR-modified cameras). If the camera reports only one channel, RawTherapee recognizes this and won't perform any demosaicing (the demosaicer selection is still enabled but does not do anything), and everything works normally. However, if the camera reports as an RGB bayer camera, demosaicing will be performed and a color matrix will be applied. To disable this, you should select the "Mono" demosaicing option, and select "No profile" as [[Color_Management#Input_Profile|input profile]] in the Color Management panel.

Sharpening

2018-11-29T18:34:06Z

Ingo: /* Unsharp Mask */

{{1:1}}

{{Sharpening_gallery}}

This article describes the tool called "Sharpening", however RawTherapee contains other tools which can be used to perform various types of sharpening - see [[Edges and Microcontrast]] and the [[Wavelets]] tools.

The Sharpening tool is applied to the full image, '''before''' the [[Resize]] tool. If you would like to apply sharpening '''after''' resizing, use the [[Resize#Post-Resize Sharpening|Post-Resize Sharpening]] tool which you will find inside the Resize tool.

== Unsharp Mask ==
[https://en.wikipedia.org/wiki/Unsharp_mask Unsharp masking] (USM) is a technique used to increase the apparent [https://en.wikipedia.org/wiki/Acutance acutance] (edge contrast) of an image, making it appear clearer, even though it technically does not really sharpen the image. It makes use of several phenomena of the human visual system in order to accomplish this effect, such as the [https://en.wikipedia.org/wiki/Cornsweet_illusion Cornsweet illusion] and [https://en.wikipedia.org/wiki/Mach_bands Mach bands]. Though unsharp masking in other software is easily prone to causing [https://en.wikipedia.org/wiki/Haloing halos], RawTherapee has a unique threshold slider which allows you to achieve a superb sharpening effect without a minimal risk of halos.
=== Radius ===
The Radius determines the size of the details being amplified and, consequently, relates to the width of the sharpening halo. In general the quality of sharpening is best if the sharpening radius is smaller. For low ISO images that are in focus and without motion blur a value of 0.5-0.7 is satisfactory.

=== Amount ===
The ''Amount'' parameter controls the strength of the sharpening.

=== Threshold ===
[[image:Usm_threshold.png]] The ''Threshold'' tool helps to suppress noise amplification and haloing and to confine sharpening to a desired tonal range. The Threshold tool allows one to create a curve via which the sharpening is applied. The vertical axis corresponds to opacity: 0% at the bottom (transparent, sharpening not visible), 100% at the top (opaque, sharpening visible). The horizontal axis corresponds to luminosity: select the tonal range that will get sharpened - the darkest tones are on the left, progressing to white tones on the right. As mentioned in the tooltip, to move each of the points in the threshold tool individually, hold the Shift key before clicking on a point with your mouse. Holding the Ctrl key while moving a point with the mouse allows for very fine movements.

When moving the right pair of sliders to the left side, sharpening is reduced in the highlights. When moving the left pair of sliders to the right side, sharpening is reduced in the shadows and minimizes amplification of dark noise.

The default threshold values will protect from over-sharpening and haloing in most cases and limit the sharpening effect to mid-tones. In the example screenshot, the blackest tones have no USM applied, then USM is applied to a broad range of tones from dark to light, and the strength of USM gradually drops off from maximal at the mid-tones to none at the whitest tones, so as to prevent noise amplification and haloing.

=== Sharpen Only Edges ===
If you activate "''Sharpen only edges''" then uniform areas will not be sharpened. This is useful when sharpening noisy photos.

Two new sliders appear as well:
==== Radius ====
The ''Radius'' is used for noise detection. If the noise is low, a lower radius can be used, and vice-versa.
A higher radius slows down the image processing.

==== Edge Tolerance ====
''Edge Tolerance'' determines how much a pixel has to differ from its neighbor to be considered as an edge and not as noise. It is very similar to the USM ''Threshold'' parameter and has a high impact on the visual quality. For low ISO (low noise) images use 1000 or less, for high ISO images use 2500-3000 or even more.

=== Halo Control ===
''Halo Control'' is used to avoid halo effects around light objects when sharpening too aggressively. When activated, a new slider appears:

==== Amount ====
At 100 it works at maximum, reducing the visual impact of the USM filter.

== RL Deconvolution ==
[https://en.wikipedia.org/wiki/Richardson%E2%80%93Lucy_deconvolution RL deconvolution] is named after the makers of this algorithm, Richardson and Lucy. It uses the [https://en.wikipedia.org/wiki/Point_spread_function point spread function] (PSF) to deconvolve (reverse) the effects of Gaussian-like blur. In reality, the blur produced by the lens and by motion may differ from Gaussian blur significantly, therefore some artifacts, such as halos, may appear when the radius diverges too far from the type of blur in the actual image, and when then effect is too strong.

=== Radius ===
The radius defines the [https://en.wikipedia.org/wiki/Standard_deviation standard deviation] (sigma) of the [https://en.wikipedia.org/wiki/Gaussian_blur Gaussian blur] in the image. Find the right value through trial and error.

=== Amount ===
Controls the blend factor between the unsharpened image and the sharpened one.

=== Damping ===
Damping reduces the effect of the deconvolution at each iteration. It has the effect of preventing sharpening of the finest details. Use it if the sharpened image has too much "bite" at the finest level.

=== Iterations ===
RL Deconvolution is an iterative algorithm; it requires being repeated in order to achieve the intended results. Each repetition of the process is called an "iteration", and the result of one iteration is used as the starting point of the next iteration. While each iteration removes blur, it also increases processing time and the likelihood that halo artifacts will appear, so you need to find the perfect balance through trial and error - the default value should be fine for most cases.

Chromatic Aberration

2018-09-23T23:52:45Z

Ingo:

[[Image:chromatic_aberration_auto1.jpg|900px|thumb|400% zoom showing correction of CA.]]
[[Image:chromatic_aberration_auto2.jpg|900px|thumb|CA easily visible even at 100% corrected.]]
This "Chromatic Aberration" tool works on the image '''before''' demosaicing, that's why it's located in the ''Raw'' tab. The [[Lens/Geometry#Chromatic_Aberration_Correction | Chromatic Aberration Correction]] tool in the ''Transform'' tab works on the image '''after''' demosaicing.

Chromatic aberration correction on the raw level is currently only supported for raw files from cameras with a [https://en.wikipedia.org/wiki/Bayer_filter Bayer filter]. If you need to remove chromatic aberration from raw photos from X-Trans sensor cameras (Fuji), then use the [[Lens/Geometry#Chromatic_Aberration_Correction | Chromatic Aberration Correction]] tool in the ''Transform'' tab.

Chromatic aberration can be corrected by using the "Red" and "Blue" sliders. Normally you won't see any chromatic aberration in the fit-to-screen preview, therefore it is highly recommended to open a detail window [[image:New-detail-window.png]] or to zoom the main preview in to 100% [[image:Gtk-zoom-100.png]] or more when you attempt this kind of correction.

This tools corrects bluish-green and magenta fringes due to lens lateral chromatic aberration that show mainly in the borders of the image. This correction is performed before demosaicing and can sometimes improve the quality of demosaicing.

== Auto-Correction ==
If "Auto-correction" is checked, the "Red"/"Blue" sliders are disabled and an automated detection and correction of chromatic aberration is performed. Where manual correction applies a constant value across the image, auto-correction divides the image into many blocks and tailors the values required to eliminate chromatic aberration to each block. For this reason auto-correction usually performs better than manual correction, and the auto-correction values cannot be displayed in the sliders.

== Iterations ==
This setting is available if "Auto-Correct" is checked. Auto-Correction is conservative, means it often does not correct all Chromatic Abberation. To correct the remaining Chromatic Aberration, from RT 5.5 on you can use up to 5 iterations of automatic Chromatic Aberration correction. Each iteration will reduce the remaing Chromatic Aberration from the last iteration at the cost of additional processing time.

== Red/Blue ==
If the "Red"/"Blue" sliders are non-zero the given values are used to correct chromatic aberration. They cannot be used at the same time as "Auto-correction".

Chromatic Aberration

2018-09-23T23:38:57Z

Ingo:

[[Image:chromatic_aberration_auto1.jpg|900px|thumb|400% zoom showing correction of CA.]]
[[Image:chromatic_aberration_auto2.jpg|900px|thumb|CA easily visible even at 100% corrected.]]
This "Chromatic Aberration" tool works on the image '''before''' demosaicing, that's why it's located in the ''Raw'' tab. The [[Lens/Geometry#Chromatic_Aberration_Correction | Chromatic Aberration Correction]] tool in the ''Transform'' tab works on the image '''after''' demosaicing.

Chromatic aberration correction on the raw level is currently only supported for raw files from cameras with a [https://en.wikipedia.org/wiki/Bayer_filter Bayer filter]. If you need to remove chromatic aberration from raw photos from X-Trans sensor cameras (Fuji), then use the [[Lens/Geometry#Chromatic_Aberration_Correction | Chromatic Aberration Correction]] tool in the ''Transform'' tab.

Chromatic aberration can be corrected by using the "Red" and "Blue" sliders. Normally you won't see any chromatic aberration in the fit-to-screen preview, therefore it is highly recommended to open a detail window [[image:New-detail-window.png]] or to zoom the main preview in to 100% [[image:Gtk-zoom-100.png]] or more when you attempt this kind of correction.

This tools corrects bluish-green and magenta fringes due to lens lateral chromatic aberration that show mainly in the borders of the image. This correction is performed before demosaicing and can sometimes improve the quality of demosaicing.

== Auto-Correction ==
If "Auto-correction" is checked, the "Red"/"Blue" sliders are disabled and an automated detection and correction of chromatic aberration is performed. Where manual correction applies a constant value across the image, auto-correction divides the image into many blocks and tailors the values required to eliminate chromatic aberration to each block. For this reason auto-correction usually performs better than manual correction, and the auto-correction values cannot be displayed in the sliders.

== Iterations ==
This setting is available if "Auto-Correct" is checked. Auto-Correction is conservative, means it often does not correct all CA. To correct the remaining CA, from RT 5.5 on you can use up to 5 iterations of CA-correction. Each iteration will reduce the remaing CA from the last iteration at the cost of additional processing time.

== Red/Blue ==
If the "Red"/"Blue" sliders are non-zero the given values are used to correct chromatic aberration. They cannot be used at the same time as "Auto-correction".

MacOS

2017-09-16T18:55:40Z

Ingo: /* MacPorts */

This page details instructions for compiling RawTherapee on '''macOS''' systems. There are also separate pages with instructions for compiling on [[Linux]] and [[Windows]]. This guide details the '''what''' and '''how''' parts of compilation. For the '''why''' and explanations of these commands, for a list of dependencies, CMake options and other information, please refer to the detailed [[Linux]] article.

When in doubt, [[IRC | join us on IRC]] and ask a human!

For instructions on cloning the source, choosing branches, configuring CMake and doing the actual compilation, see these sections in the [[Linux]] guide. The information below is in addition to that.

== Dependencies ==
See the list of dependencies in the [[Linux#Dependencies|Compiling in Linux]] article.

=== MacPorts ===
Tested on OS X 10.9 and newer.
* '''Prerequisites:'''
** Apple's Xcode Developer Tools
** Apple's Command Line Tools
** MacPorts
*** Detailed instructions on setting up MacPorts and the developer tools are available on the MacPorts website.
*** The native system compiler provided by Apple is badly outdated and does not support OpenMP. Don't use it. Use the latest stable compiler from MacPorts - RawTherapee will run faster.
* '''Configure MacPorts:'''
: Add the following line to /opt/local/etc/macports/variants.conf
:: <code>+quartz -x11 -gnome</code>

* '''Dependencies:'''
: To install the dependencies, run from the terminal:
:: <code>sudo port install git clang-3.9 gtk3 gtkmm3 gtk-osx-application-gtk3 adwaita-icon-theme libsigcxx2 lcms2 libiptcdata fftw-3-single lensfun</code>

=== libiconv patch ===
libiconv.2.dylib must be patched, otherwise RawTherapee will crash on startup. The patch is available in [https://github.com/Beep6581/RawTherapee/blob/dev/tools/osx/libiconv_1.15_rt.patch `tools/osx/libiconv_1.15_rt.patch`]

libiconv patching and compilation instructions:
<pre style="white-space: pre-wrap">
wget http://ftp.gnu.org/pub/gnu/libiconv/libiconv-1.15.tar.gz
tar xf libiconv-1.15.tar.gz
cd libiconv-1.15
wget https://raw.githubusercontent.com/Beep6581/RawTherapee/dev/tools/osx/libiconv_1.15_rt.patch
patch -p1 < libiconv_1.15_rt.patch
mkdir build
cd build
buildDir="$(pwd)"
../configure --prefix=/opt/local --disable-static 'CFLAGS=-arch x86_64 -mmacosx-version-min=10.9' 'LDFLAGS=-arch x86_64 -mmacosx-version-min=10.9' CXXFLAGS="-arch x86_64 -mmacosx-version-min=10.9"
make
make DESTDIR="$buildDir" install
cd /opt/local/lib
sudo cp ./libiconv.2.dylib ./libiconv.2.dylib.backup # backup MacPorts dylib
sudo cp "${buildDir}/opt/local/lib/libiconv.2.dylib" /opt/local/lib/libiconv.2.dylib
</pre>

== Compiling ==
See the [[Linux#Compiling:_The_Manual_Way|Compiling in Linux]] article for instructions on how to '''clone''' the source code, choose a '''branch''' and how to configure '''CMake'''. Ignore the "Now you are ready to compile" code on that page and follow the code on this page.

If you want to upload a build or otherwise share it with others, you must use
: <code>-DPROC_TARGET_NUMBER="1"</code>
and set the processor label manually by setting
: <code>-DPROC_LABEL="generic processor"</code>

If you want to compile for yourself only, then use
: <code>-DPROC_TARGET_NUMBER="2"</code>
and then the processor label would be irrelevant, you could skip it.

=== Compile RawTherapee ===
Now you are ready to compile:
<pre style="white-space: pre-wrap">cd ~/repo-rt
rm -rf build
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE="release" \
-DPROC_TARGET_NUMBER="1" \
-DPROC_LABEL="generic processor" \
-DCACHE_NAME_SUFFIX="5-dev" \
-DCMAKE_C_COMPILER="clang-mp-3.9" \
-DCMAKE_CXX_COMPILER="clang++-mp-3.9" \
-DWITH_LTO="OFF" \
..
make -j4 install
make macosx_bundle
</pre>

=== Run and Share RawTherapee ===
You will find a disk image in the build directory; this is the distribution release and can be run on any machine which meets the architecture requirements you specified in variants.conf earlier.

To provide the RawTherapee project with your build, please zip the .dmg and AboutThisBuild.txt files together. Name the zip file according to this template:
: RawTherapee_OSX_'''<minimum supported macOS version>'''_64_'''<RawTherapee version>'''.zip
for example if your build is made for macOS 10.12 and the version of RawTherapee is 5.2-dev-g1a2b3c4d, name it:
: RawTherapee_OSX_10.12_64_5.2-dev-g1a2b3c4d.zip
Upload the zip archive to http://filebin.net/ and [https://github.com/Beep6581/RawTherapee/issues/new open a new issue on our GitHub page] with the link so that we can upload it to the website.

Linux

2017-09-14T23:26:22Z

Ingo: /* Ubuntu 16.10 */

This page details instructions for compiling RawTherapee on '''GNU/Linux''' systems. There are also instructions for compiling on [[Windows]] and [[OS X]].

When in doubt, [[IRC | join us on IRC]] and ask a human!

== Dependencies ==
To compile RawTherapee your system will need a set of tools. They are called dependencies, and here is a list of dependencies for both GTK2 and GTK3 versions of RawTherapee:

{| class="wikitable sortable"
|+ Build-time dependencies for RawTherapee 4 and 5.0.
! GTK+ !! Package !! Version !! Gentoo !! Debian/Ubuntu !! URL
|-
| GTK2, GTK3 || BZIP2 || bzip2>-1.0.4 || app-arch/bzip2 || libbz2-dev || http://www.bzip.org/
|-
| GTK2, GTK3 || EXIV2 || exiv2>=0.19 || media-gfx/exiv2 || libexiv2-dev || http://www.exiv2.org/
|-
| GTK2, GTK3 || EXPAT || expat>=2.1.0 || dev-libs/expat || libexpat-dev || http://expat.sourceforge.net/
|-
| GTK2, GTK3 || FFTW3 || fftw>=3.2.2 || sci-libs/fftw || fftw-dev || http://fftw.org/
|-
| GTK2, GTK3 || GCC || gcc>=4.9 || sys-devel/gcc || build-essential || http://gcc.gnu.org/
|-
| GTK2, GTK3 || GLIB2 || glib-2.0>=2.24 || dev-libs/glib || libglib2.0-dev || http://www.gtk.org/
|-
| GTK2, GTK3 || GLIBMM || glibmm-2.4>=2.24 || dev-cpp/glibmm || libglibmm-2.4-dev || http://www.gtkmm.org
|-
| GTK2 || GTK+ || gtk+-2.0>=2.24.18 || x11-libs/gtk+ || libgtk2.0-dev || http://www.gtk.org/
|-
| GTK3 || GTK+ || gtk+-3.16 || x11-libs/gtk+ || libgtk-3-dev || http://www.gtk.org/
|-
| GTK2 || GTK2-Engines || gtk-engines-2.20.2 || x11-themes/gtk-engines || gtk2-engines || http://www.gtk.org/
|-
| GTK2 || GTKMM || gtkmm-2.4>=2.22 || dev-cpp/gtkmm || libgtkmm-2.4-dev || http://www.gtkmm.org
|-
| GTK3 || GTKMM || gtkmm-3.16 || dev-cpp/gtkmm || libgtkmm-3.0-dev || http://www.gtkmm.org
|-
| GTK2, GTK3 || JPEG || libjpeg>=6b || media-libs/jpeg || libjpeg-dev || http://libjpeg-turbo.virtualgl.org/ http://jpegclub.org/ http://www.ijg.org/
|-
| GTK2, GTK3 || LCMS2 || lcms>=2.6 || media-libs/lcms || liblcms2-dev || http://www.littlecms.com/
|-
| GTK3 || LENSFUN || lensfun>=0.2 || ?? || liblensfun-dev || http://lensfun.sourceforge.net/
|-
| GTK2, GTK3 || LIBCANBERRA || libcanberra>=0.29 || media-libs/libcanberra || libcanberra-gtk3-dev || http://0pointer.de/lennart/projects/libcanberra/ (Linux only)
|-
| GTK2, GTK3 || LIBIPTCDATA || libiptcdata>=1.0.2 || media-libs/libiptcdata || libiptcdata-dev || http://libiptcdata.sourceforge.net
|-
| GTK2, GTK3 || PNG || libpng>=1.2.44 || media-libs/libpng || libpng-dev || http://www.libpng.org/
|-
| GTK2, GTK3 || SIGC || sigc++-2.0 || dev-libs/libsigc++ || libsigc++-2.0-dev || http://libsigc.sourceforge.net/
|-
| GTK2, GTK3 || TIFF || libtiff>=3.9.4 || media-libs/tiff || libtiff-dev || http://www.remotesensing.org/libtiff/
|-
| GTK2, GTK3 || ZLIB || zlib>=1.2.3 || sys-libs/zlib || zlib1g-dev || http://www.zlib.net/
|}

To compile the outdated RawTherapee 3 you will need these:

{| class="wikitable"
|+ Build-time dependencies for RawTherapee 3
! Package !! Version !! Gentoo !! Debian/Ubuntu !! URL
|-
| LCMS1 || lcms<=1.99 || media-libs/lcms || liblcms1-dev || http://www.littlecms.com/
|}

In order to install all these dependencies, you will need to open a console and paste the code from the appropriate section into the console. Note that these code snippets include the GTK3 dependencies if available, so if you want to compile the legacy "gtk2" branch which uses GTK2 then replace the GTK3 dependencies with GTK2 ones as described in the list above.

=== Arch ===
The latest Arch supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo pacman -S bzip2 exiv2 expat fftw glib2 glibmm gtk3 gtkmm3 lcms2 lensfun libcanberra libiptcdata libjpeg-turbo libpng libsigc++ libtiff zlib</pre>

=== CentOS 7.1 ===
CentOS 7.1 does not support a recent enough version of GTK3, so you can only compile the <code>gtk2</code> branch.
As CentOS 7.1 does not seem to have the Clearlooks GTK2 theme engine, you will either need to install some other GTK2 theme engine, or after installing RawTherapee go to "Preferences > General > Default Theme" and enable "Use system theme".
<pre style="white-space: pre-wrap">sudo yum install bzip2-devel cmake curl exiv2-devel expat-devel fftw-devel gcc-c++ git glibmm24-devel gtk2-devel gtkmm24-devel lcms2-devel libjpeg-turbo-devel libcanberra-devel libiptcdata-devel libpng-devel libtiff-devel sigc++20-devel zlib-devel</pre>

=== Fedora ===
Fedora supports GTK3 from version 22, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
If you are using Fedora version 21 or older, use the legacy <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo dnf install bzip2-devel cmake exiv2-devel expat-devel fftw-devel gcc-c++ glib2-devel glibmm24-devel gtk3-devel gtkmm30-devel lcms2-devel lensfun-devel libcanberra-devel libiptcdata-devel libjpeg-turbo-devel libpng-devel libsigc++20-devel libtiff-devel zlib-devel</pre>

=== Gentoo ===
Gentoo supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo emerge -uva app-arch/bzip2 dev-cpp/gtkmm:3.0 dev-libs/expat media-gfx/exiv2 media-libs/lcms media-libs/libcanberra media-libs/libiptcdata media-libs/libjpeg-turbo media-libs/libpng media-libs/tiff net-misc/curl sci-libs/fftw sys-libs/zlib x11-libs/gtk+:3</pre>

=== openSUSE ===
openSUSE 42.2 and Tumbleweed support GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
Note: openSUSE 42.1 supports GTK+ 3.16.7 but compilation fails as the sigc++-2.0>=2.4 requirement is not met.
If you are using openSUSE version 42.1 or older, use the legacy <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo zypper in cmake fftw3-devel gcc-c++ glib2-devel glibmm2-devel gtk3-devel gtkmm3-devel libbz2-devel libcanberra-devel libexpat-devel libiptcdata-devel libjpeg-devel liblcms2-devel libpng-devel libsigc++2-devel libtiff-devel zlib-devel</pre>

=== Sabayon ===
Sabayon supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo equo install app-arch/bzip2 dev-cpp/gtkmm:3.0 dev-libs/expat dev-util/cmake media-gfx/exiv2 media-libs/lcms media-libs/libcanberra media-libs/libiptcdata media-libs/libjpeg-turbo media-libs/libpng media-libs/tiff net-misc/curl sci-libs/fftw sys-libs/zlib x11-libs/gtk+:3</pre>

=== Ubuntu ===
Ubuntu as of version 15.10 (Wily Werewolf) supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
Older versions of Ubuntu either do not support GTK3 at all, or the version of GTK3 they ship is not recent enough (RawTherapee GTK3 support requires GTK3 version 3.16 or newer), meaning you must use the legacy <code>gtk2</code> branch which uses GTK2.

==== Ubuntu 17.04 and 16.10 ====
Use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo apt update
sudo apt install build-essential cmake curl git libcanberra-gtk3-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk-3-dev libgtkmm-3.0-dev libiptcdata0-dev libjpeg-dev liblcms2-dev liblensfun-dev libpng-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 16.04 LTS and 15.10 ====
Use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk3-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk-3-dev libgtkmm-3.0-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev liblensfun-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 15.04, 14.10, 14.04 LTS ====
Use the legacy <code>gtk2</code> branch. The dependencies below are only for the <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

RawTherapee requires GCC version 4.9 or higher. Ubuntu 14.04 LTS ships with GCC version 4.8.2 which is too old - to get 4.9, follow these steps: http://askubuntu.com/questions/466651/how-do-i-use-the-latest-gcc-on-ubuntu-14-04

==== Ubuntu 13.10, 13.04, 12.10, 12.04 LTS, 11.10 ====
These versions of Ubuntu are badly outdated. The code below used to work but it may stop working at any moment. Upgrade your operating system.

As these versions of Ubuntu only support GCC-4.8.1 and older, the latest commit you will be able to compile is [https://github.com/Beep6581/RawTherapee/commit/b343b9a7 commit b343b9a7] from 2015-12-29 - newer versions will not compile.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 10.10 and 11.04 ====
These versions of Ubuntu are badly outdated. The code below used to work but it may stop working at any moment. Upgrade your operating system.

<pre style="white-space: pre-wrap">sudo apt-add-repository ppa:dasprid/rawtherapee
sudo apt-get update
sudo apt-get install cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg62 liblcms2-dev libnm-glib2 libpng12-dev libsigc++-2.0-dev libtiff4-dev zlib1g-dev</pre>


== Compiling: The Manual Way ==
This section describes compiling RawTherapee manually.

=== Clone the source ===
First, you need to clone RawTherapee's source code repository. Bring up your console and run this:

<pre style="white-space: pre-wrap">git clone https://github.com/Beep6581/RawTherapee ~/repo-rt
cd ~/repo-rt</pre>

=== Choose a branch ===
* Features are developed on their own feature branches.
* Development happens on the <code>dev</code> branch. Feature branches are merged into the <code>dev</code> branch when they're ready. The <code>dev</code> branch is unstable.
* Releases are tagged on the <code>releases</code> branch.

Checkout the latest tag if you want the most stable code. To see all available tags, type:
<pre style="white-space: pre-wrap">git tag</pre>

Checkout the <code>dev</code> branch or some other feature branch if you want to test the latest bleeding-edge code. To see all available branches, type:
<pre style="white-space: pre-wrap">git branch -a</pre>

Checking out is done via the "git checkout" command. To checkout a tag or a branch, type:
<pre style="white-space: pre-wrap">git checkout <tag or branch></pre>

RawTherapee uses GTK+ for the user interface and requires GTK+ version 3.16 or newer. If your system does not support version 3.16 or newer then you must checkout the <code>5.0-r1-gtk2</code> tag. Our GTK2 support has officially ended on 2 February 2017 - update your system.

Note: Compiling old versions of RawTherapee will fail on a modern system, as you will be missing the old dependencies.

=== Compile RawTherapee ===
Now you will make an out-of-source compilation of RawTherapee, it will be built into the ~/repo-rt/build/release folder, and then you will move this folder to your home directory and rename it to "rt", so make sure there is no ~/rt folder already!

There are a few compilation settings you need to be aware of, you will pass these to CMake using the -D option as described below:

; BUILD_TYPE
: You must specify the <code>BUILD_TYPE</code> when building RawTherapee. You can set the <code>BUILD_TYPE</code> value to "<code>debug</code>", "<code>relwithdebinfo</code>" or "<code>release</code>". The "debug" and "relwithdebinfo" builds will let you [[How_to_write_useful_bug_reports | get a useful stack-backtrace]] if RawTherapee crashes while running through GDB which you can then submit to us so we can find the problem and fix it. The "debug" build is the slowest but generates the most detailed information. The "relwithdebinfo" build is almost as fast as a "release" build and generates often sufficient information, though not as detiled as a "debug" build. The "release" build will not provide any useful information when it crashes, but does contain many speed optimizations resulting in a program that works many times faster than the "debug" version would. For normal use, make a "release" or "relwithdebinfo" build. If you find a reproducible bug, then make a "debug" build and send us a stack-backtrace (or fix it yourself and send us the patch!). Alternatively use a "relwithdebinfo" build, and hope that it's detailed enough.
:: To make a "release" type build, write: <code>-DCMAKE_BUILD_TYPE="release"</code>
:: Replace "release" by "debug" or "relwithdebinfo" as needed.

; USE_OLD_CXX_ABI
: When compiling a program, one must use the same conventions as those used by the libraries which that program relies upon, otherwise compilation (linking) will fail. Generally one does not need to concern oneself with this, but we are now at a time when GCC4 is being phased out by GCC5, each by default uses a convention incompatible with the other, and so this issue is relevant. If the libraries on your system have been compiled using GCC5, they probably use a standard called C++11. This means that your RawTherapee build must use the same standard, which is the case by default. However if despite using GCC5 your libraries were built using the older C++03 standard, then RawTherapee must be set to use the same, and this is when you would set "USE_OLD_CXX_ABI" to "ON":
:: To enable USE_OLD_CXX_ABI, write: <code>-DUSE_OLD_CXX_ABI="ON"</code>

; CACHE_NAME_SUFFIX
: The CACHE_NAME_SUFFIX options dictates the suffix of the cache and config folder names the compiled RawTherapee build will use.
: See the [[File Paths]] article for a full explanation, or just use "5-dev".

; PROC_TARGET_NUMBER
: The PROC_TARGET_NUMBER option sets which CPU type to optimize for. "2" is a safe choice because it means "native", so the optimizations will be automatically detected for your CPU.
: For more info, see the file "ProcessorTargets.cmake" in the cloned repository.
:: To make a build using "native" optimizations, write: <code>-DPROC_TARGET_NUMBER="2"</code>

; LENSFUNDBDIR
: The LENSFUNDBDIR option permits to locate the lensfun data base in the specified directory i.e. <code>.\share\lensfun</code>`

Finally, you need to find out how many threads your CPU supports. This will make compilation faster but it will have no effect on the speed of running RawTherapee.
; Threads
: To find out how many threads your CPU supports, run:
: <code>grep -c processor /proc/cpuinfo</code>
: Then replace the number in "-j8" below with this number.

Now you are ready to compile:
<pre style="white-space: pre-wrap">cd ~/repo-rt
rm -rf build
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE="release" \
-DPROC_TARGET_NUMBER="2" \
-DBUILD_BUNDLE="ON" \
-DCACHE_NAME_SUFFIX="5-dev" \
-DWITH_LTO="OFF" \
..
make -j4 install
mv release ~/rt</pre>

=== Run RawTherapee ===
To run RawTherapee:
<pre style="white-space: pre-wrap">~/rt/rawtherapee</pre>

The source code repository is in <code>~/repo-rt</code> and the compiled program is in <code>~/rt</code>

You can safely delete <code>~/repo-rt</code> if you so wish. The compiled program will still work, but then you will have to redo all the above steps if you want to update. Rather, leave the repository intact so that you can do the next step in a week or a month's time.

=== Update RawTherapee ===
Every time you want to update your RawTherapee to the latest code available, just do the following:
<pre style="white-space: pre-wrap">cd ~/repo-rt
git pull</pre>

Then repeat the [[Linux#Compile RawTherapee | Compile RawTherapee]] step above.

Linux

2017-09-14T14:37:12Z

Ingo: /* Compile RawTherapee */

This page details instructions for compiling RawTherapee on '''GNU/Linux''' systems. There are also instructions for compiling on [[Windows]] and [[OS X]].

When in doubt, [[IRC | join us on IRC]] and ask a human!

== Dependencies ==
To compile RawTherapee your system will need a set of tools. They are called dependencies, and here is a list of dependencies for both GTK2 and GTK3 versions of RawTherapee:

{| class="wikitable sortable"
|+ Build-time dependencies for RawTherapee 4 and 5.0.
! GTK+ !! Package !! Version !! Gentoo !! Debian/Ubuntu !! URL
|-
| GTK2, GTK3 || BZIP2 || bzip2>-1.0.4 || app-arch/bzip2 || libbz2-dev || http://www.bzip.org/
|-
| GTK2, GTK3 || EXIV2 || exiv2>=0.19 || media-gfx/exiv2 || libexiv2-dev || http://www.exiv2.org/
|-
| GTK2, GTK3 || EXPAT || expat>=2.1.0 || dev-libs/expat || libexpat-dev || http://expat.sourceforge.net/
|-
| GTK2, GTK3 || FFTW3 || fftw>=3.2.2 || sci-libs/fftw || fftw-dev || http://fftw.org/
|-
| GTK2, GTK3 || GCC || gcc>=4.9 || sys-devel/gcc || build-essential || http://gcc.gnu.org/
|-
| GTK2, GTK3 || GLIB2 || glib-2.0>=2.24 || dev-libs/glib || libglib2.0-dev || http://www.gtk.org/
|-
| GTK2, GTK3 || GLIBMM || glibmm-2.4>=2.24 || dev-cpp/glibmm || libglibmm-2.4-dev || http://www.gtkmm.org
|-
| GTK2 || GTK+ || gtk+-2.0>=2.24.18 || x11-libs/gtk+ || libgtk2.0-dev || http://www.gtk.org/
|-
| GTK3 || GTK+ || gtk+-3.16 || x11-libs/gtk+ || libgtk-3-dev || http://www.gtk.org/
|-
| GTK2 || GTK2-Engines || gtk-engines-2.20.2 || x11-themes/gtk-engines || gtk2-engines || http://www.gtk.org/
|-
| GTK2 || GTKMM || gtkmm-2.4>=2.22 || dev-cpp/gtkmm || libgtkmm-2.4-dev || http://www.gtkmm.org
|-
| GTK3 || GTKMM || gtkmm-3.16 || dev-cpp/gtkmm || libgtkmm-3.0-dev || http://www.gtkmm.org
|-
| GTK2, GTK3 || JPEG || libjpeg>=6b || media-libs/jpeg || libjpeg-dev || http://libjpeg-turbo.virtualgl.org/ http://jpegclub.org/ http://www.ijg.org/
|-
| GTK2, GTK3 || LCMS2 || lcms>=2.6 || media-libs/lcms || liblcms2-dev || http://www.littlecms.com/
|-
| GTK3 || LENSFUN || lensfun>=0.2 || ?? || liblensfun-dev || http://lensfun.sourceforge.net/
|-
| GTK2, GTK3 || LIBCANBERRA || libcanberra>=0.29 || media-libs/libcanberra || libcanberra-gtk3-dev || http://0pointer.de/lennart/projects/libcanberra/ (Linux only)
|-
| GTK2, GTK3 || LIBIPTCDATA || libiptcdata>=1.0.2 || media-libs/libiptcdata || libiptcdata-dev || http://libiptcdata.sourceforge.net
|-
| GTK2, GTK3 || PNG || libpng>=1.2.44 || media-libs/libpng || libpng-dev || http://www.libpng.org/
|-
| GTK2, GTK3 || SIGC || sigc++-2.0 || dev-libs/libsigc++ || libsigc++-2.0-dev || http://libsigc.sourceforge.net/
|-
| GTK2, GTK3 || TIFF || libtiff>=3.9.4 || media-libs/tiff || libtiff-dev || http://www.remotesensing.org/libtiff/
|-
| GTK2, GTK3 || ZLIB || zlib>=1.2.3 || sys-libs/zlib || zlib1g-dev || http://www.zlib.net/
|}

To compile the outdated RawTherapee 3 you will need these:

{| class="wikitable"
|+ Build-time dependencies for RawTherapee 3
! Package !! Version !! Gentoo !! Debian/Ubuntu !! URL
|-
| LCMS1 || lcms<=1.99 || media-libs/lcms || liblcms1-dev || http://www.littlecms.com/
|}

In order to install all these dependencies, you will need to open a console and paste the code from the appropriate section into the console. Note that these code snippets include the GTK3 dependencies if available, so if you want to compile the legacy "gtk2" branch which uses GTK2 then replace the GTK3 dependencies with GTK2 ones as described in the list above.

=== Arch ===
The latest Arch supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo pacman -S bzip2 exiv2 expat fftw glib2 glibmm gtk3 gtkmm3 lcms2 lensfun libcanberra libiptcdata libjpeg-turbo libpng libsigc++ libtiff zlib</pre>

=== CentOS 7.1 ===
CentOS 7.1 does not support a recent enough version of GTK3, so you can only compile the <code>gtk2</code> branch.
As CentOS 7.1 does not seem to have the Clearlooks GTK2 theme engine, you will either need to install some other GTK2 theme engine, or after installing RawTherapee go to "Preferences > General > Default Theme" and enable "Use system theme".
<pre style="white-space: pre-wrap">sudo yum install bzip2-devel cmake curl exiv2-devel expat-devel fftw-devel gcc-c++ git glibmm24-devel gtk2-devel gtkmm24-devel lcms2-devel libjpeg-turbo-devel libcanberra-devel libiptcdata-devel libpng-devel libtiff-devel sigc++20-devel zlib-devel</pre>

=== Fedora ===
Fedora supports GTK3 from version 22, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
If you are using Fedora version 21 or older, use the legacy <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo dnf install bzip2-devel cmake exiv2-devel expat-devel fftw-devel gcc-c++ glib2-devel glibmm24-devel gtk3-devel gtkmm30-devel lcms2-devel lensfun-devel libcanberra-devel libiptcdata-devel libjpeg-turbo-devel libpng-devel libsigc++20-devel libtiff-devel zlib-devel</pre>

=== Gentoo ===
Gentoo supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo emerge -uva app-arch/bzip2 dev-cpp/gtkmm:3.0 dev-libs/expat media-gfx/exiv2 media-libs/lcms media-libs/libcanberra media-libs/libiptcdata media-libs/libjpeg-turbo media-libs/libpng media-libs/tiff net-misc/curl sci-libs/fftw sys-libs/zlib x11-libs/gtk+:3</pre>

=== openSUSE ===
openSUSE 42.2 and Tumbleweed support GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
Note: openSUSE 42.1 supports GTK+ 3.16.7 but compilation fails as the sigc++-2.0>=2.4 requirement is not met.
If you are using openSUSE version 42.1 or older, use the legacy <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo zypper in cmake fftw3-devel gcc-c++ glib2-devel glibmm2-devel gtk3-devel gtkmm3-devel libbz2-devel libcanberra-devel libexpat-devel libiptcdata-devel libjpeg-devel liblcms2-devel libpng-devel libsigc++2-devel libtiff-devel zlib-devel</pre>

=== Sabayon ===
Sabayon supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo equo install app-arch/bzip2 dev-cpp/gtkmm:3.0 dev-libs/expat dev-util/cmake media-gfx/exiv2 media-libs/lcms media-libs/libcanberra media-libs/libiptcdata media-libs/libjpeg-turbo media-libs/libpng media-libs/tiff net-misc/curl sci-libs/fftw sys-libs/zlib x11-libs/gtk+:3</pre>

=== Ubuntu ===
Ubuntu as of version 15.10 (Wily Werewolf) supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
Older versions of Ubuntu either do not support GTK3 at all, or the version of GTK3 they ship is not recent enough (RawTherapee GTK3 support requires GTK3 version 3.16 or newer), meaning you must use the legacy <code>gtk2</code> branch which uses GTK2.

==== Ubuntu 16.10 ====
Use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo apt update
sudo apt install build-essential cmake curl git libcanberra-gtk3-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk-3-dev libgtkmm-3.0-dev libiptcdata0-dev libjpeg-dev liblcms2-dev liblensfun-dev libpng-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 16.04 LTS and 15.10 ====
Use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk3-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk-3-dev libgtkmm-3.0-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev liblensfun-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 15.04, 14.10, 14.04 LTS ====
Use the legacy <code>gtk2</code> branch. The dependencies below are only for the <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

RawTherapee requires GCC version 4.9 or higher. Ubuntu 14.04 LTS ships with GCC version 4.8.2 which is too old - to get 4.9, follow these steps: http://askubuntu.com/questions/466651/how-do-i-use-the-latest-gcc-on-ubuntu-14-04

==== Ubuntu 13.10, 13.04, 12.10, 12.04 LTS, 11.10 ====
These versions of Ubuntu are badly outdated. The code below used to work but it may stop working at any moment. Upgrade your operating system.

As these versions of Ubuntu only support GCC-4.8.1 and older, the latest commit you will be able to compile is [https://github.com/Beep6581/RawTherapee/commit/b343b9a7 commit b343b9a7] from 2015-12-29 - newer versions will not compile.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 10.10 and 11.04 ====
These versions of Ubuntu are badly outdated. The code below used to work but it may stop working at any moment. Upgrade your operating system.

<pre style="white-space: pre-wrap">sudo apt-add-repository ppa:dasprid/rawtherapee
sudo apt-get update
sudo apt-get install cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg62 liblcms2-dev libnm-glib2 libpng12-dev libsigc++-2.0-dev libtiff4-dev zlib1g-dev</pre>


== Compiling: The Manual Way ==
This section describes compiling RawTherapee manually.

=== Clone the source ===
First, you need to clone RawTherapee's source code repository. Bring up your console and run this:

<pre style="white-space: pre-wrap">git clone https://github.com/Beep6581/RawTherapee ~/repo-rt
cd ~/repo-rt</pre>

=== Choose a branch ===
* Features are developed on their own feature branches.
* Development happens on the <code>dev</code> branch. Feature branches are merged into the <code>dev</code> branch when they're ready. The <code>dev</code> branch is unstable.
* Releases are tagged on the <code>releases</code> branch.

Checkout the latest tag if you want the most stable code. To see all available tags, type:
<pre style="white-space: pre-wrap">git tag</pre>

Checkout the <code>dev</code> branch or some other feature branch if you want to test the latest bleeding-edge code. To see all available branches, type:
<pre style="white-space: pre-wrap">git branch -a</pre>

Checking out is done via the "git checkout" command. To checkout a tag or a branch, type:
<pre style="white-space: pre-wrap">git checkout <tag or branch></pre>

RawTherapee uses GTK+ for the user interface and requires GTK+ version 3.16 or newer. If your system does not support version 3.16 or newer then you must checkout the <code>5.0-r1-gtk2</code> tag. Our GTK2 support has officially ended on 2 February 2017 - update your system.

Note: Compiling old versions of RawTherapee will fail on a modern system, as you will be missing the old dependencies.

=== Compile RawTherapee ===
Now you will make an out-of-source compilation of RawTherapee, it will be built into the ~/repo-rt/build/release folder, and then you will move this folder to your home directory and rename it to "rt", so make sure there is no ~/rt folder already!

There are a few compilation settings you need to be aware of, you will pass these to CMake using the -D option as described below:

; BUILD_TYPE
: You must specify the <code>BUILD_TYPE</code> when building RawTherapee. You can set the <code>BUILD_TYPE</code> value to "<code>debug</code>", "<code>relwithdebinfo</code>" or "<code>release</code>". The "debug" and "relwithdebinfo" builds will let you [[How_to_write_useful_bug_reports | get a useful stack-backtrace]] if RawTherapee crashes while running through GDB which you can then submit to us so we can find the problem and fix it. The "debug" build is the slowest but generates the most detailed information. The "relwithdebinfo" build is almost as fast as a "release" build and generates often sufficient information, though not as detiled as a "debug" build. The "release" build will not provide any useful information when it crashes, but does contain many speed optimizations resulting in a program that works many times faster than the "debug" version would. For normal use, make a "release" or "relwithdebinfo" build. If you find a reproducible bug, then make a "debug" build and send us a stack-backtrace (or fix it yourself and send us the patch!). Alternatively use a "relwithdebinfo" build, and hope that it's detailed enough.
:: To make a "release" type build, write: <code>-DCMAKE_BUILD_TYPE="release"</code>
:: Replace "release" by "debug" or "relwithdebinfo" as needed.

; USE_OLD_CXX_ABI
: When compiling a program, one must use the same conventions as those used by the libraries which that program relies upon, otherwise compilation (linking) will fail. Generally one does not need to concern oneself with this, but we are now at a time when GCC4 is being phased out by GCC5, each by default uses a convention incompatible with the other, and so this issue is relevant. If the libraries on your system have been compiled using GCC5, they probably use a standard called C++11. This means that your RawTherapee build must use the same standard, which is the case by default. However if despite using GCC5 your libraries were built using the older C++03 standard, then RawTherapee must be set to use the same, and this is when you would set "USE_OLD_CXX_ABI" to "ON":
:: To enable USE_OLD_CXX_ABI, write: <code>-DUSE_OLD_CXX_ABI="ON"</code>

; CACHE_NAME_SUFFIX
: The CACHE_NAME_SUFFIX options dictates the suffix of the cache and config folder names the compiled RawTherapee build will use.
: See the [[File Paths]] article for a full explanation, or just use "5-dev".

; PROC_TARGET_NUMBER
: The PROC_TARGET_NUMBER option sets which CPU type to optimize for. "2" is a safe choice because it means "native", so the optimizations will be automatically detected for your CPU.
: For more info, see the file "ProcessorTargets.cmake" in the cloned repository.
:: To make a build using "native" optimizations, write: <code>-DPROC_TARGET_NUMBER="2"</code>

; LENSFUNDBDIR
: The LENSFUNDBDIR option permits to locate the lensfun data base in the specified directory i.e. <code>.\share\lensfun</code>`

Finally, you need to find out how many threads your CPU supports. This will make compilation faster but it will have no effect on the speed of running RawTherapee.
; Threads
: To find out how many threads your CPU supports, run:
: <code>grep -c processor /proc/cpuinfo</code>
: Then replace the number in "-j8" below with this number.

Now you are ready to compile:
<pre style="white-space: pre-wrap">cd ~/repo-rt
rm -rf build
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE="release" \
-DPROC_TARGET_NUMBER="2" \
-DBUILD_BUNDLE="ON" \
-DCACHE_NAME_SUFFIX="5-dev" \
-DWITH_LTO="OFF" \
..
make -j4 install
mv release ~/rt</pre>

=== Run RawTherapee ===
To run RawTherapee:
<pre style="white-space: pre-wrap">~/rt/rawtherapee</pre>

The source code repository is in <code>~/repo-rt</code> and the compiled program is in <code>~/rt</code>

You can safely delete <code>~/repo-rt</code> if you so wish. The compiled program will still work, but then you will have to redo all the above steps if you want to update. Rather, leave the repository intact so that you can do the next step in a week or a month's time.

=== Update RawTherapee ===
Every time you want to update your RawTherapee to the latest code available, just do the following:
<pre style="white-space: pre-wrap">cd ~/repo-rt
git pull</pre>

Then repeat the [[Linux#Compile RawTherapee | Compile RawTherapee]] step above.

Windows

2017-09-14T14:31:52Z

Ingo: /* Clone and build RawTherapee */

This guide documents how to build RawTherapee for 32-bit or 64-bit versions of Windows using the MinGW-w64 runtime. Begin by installing and updating MSYS2 using the instructions from the [https://msys2.github.io/ MSYS2 website]. Then run the following commands using either "''MinGW-w64 Win32 Shell''" if you want to build a 32-bit version, or "''MinGW-w64 Win64 Shell''" if you want to build a 64-bit version.

RawTherapee can be built using GTK+ versions 2 or 3. To build using GTK2 use the <code>gtk2</code> branch; to build using GTK3 use the <code>dev</code> branch. The last version of RawTherapee to support GTK2 is 5.0-r1-gtk2 released on 2017-02-02. Use the <code>dev</code> branch for the latest code - it requires GTK+ >=3.16.

== Install tools and libraries ==

First, install a few miscellaneous tools:
<pre style="white-space: pre-wrap">
$ pacman -S tar gzip nano make diffutils intltool git
</pre>

Then install the necessary development tools:
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gcc mingw-w64-i686-gdb mingw-w64-i686-make mingw-w64-i686-pkg-config mingw-w64-i686-cmake
# win64
$ pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-make mingw-w64-x86_64-pkg-config mingw-w64-x86_64-cmake
</pre>
and the required libraries:
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gtkmm mingw-w64-i686-gtkmm3 mingw-w64-i686-lcms2 mingw-w64-i686-fftw
# win64
$ pacman -S mingw-w64-x86_64-gtkmm mingw-w64-x86_64-gtkmm3 mingw-w64-x86_64-lcms2 mingw-w64-x86_64-fftw mingw-w64-x86_64-lensfun
</pre>

== Download and build libiptcdata ==

The libiptcdata library is not yet provided by MSYS2, therefore it should be downloaded and configured using:
<pre style="white-space: pre-wrap">
$ curl -LO http://downloads.sourceforge.net/project/libiptcdata/libiptcdata/1.0.4/libiptcdata-1.0.4.tar.gz
$ tar xzf libiptcdata-1.0.4.tar.gz
$ cd libiptcdata-1.0.4

# win32
$ ./configure --prefix=/mingw32
# win64
$ ./configure --prefix=/mingw64
</pre>

Afterwards the <code>Makefile</code> needs to be opened using a text editor to remove <code>iptc</code> and <code>docs</code> from the lists named <code>SUBDIRS</code> and <code>DIST_SUBDIRS</code>, as building or installing will fail otherwise:
<pre style="white-space: pre-wrap">
$ nano Makefile

# Replace
DIST_SUBDIRS = m4 libiptcdata po iptc docs win python
# with
DIST_SUBDIRS = m4 libiptcdata po win python

# And replace
SUBDIRS = m4 libiptcdata po iptc docs win $(MAYBE_PYTHONLIB)
# with
SUBDIRS = m4 libiptcdata po win $(MAYBE_PYTHONLIB)
</pre>

Finally build and install the library:
<pre style="white-space: pre-wrap">
$ make
$ make install
$ cd
</pre>

== Download and build Clearlooks ==

If you are building RawTherapee using GTK2 then you need the Clearlooks theme engine. You do not need it if you are building using GTK3.

Download and build it:
<pre style="white-space: pre-wrap">
$ curl -LO http://sources.archlinux.org/other/gtk-engines/gtk-engines-2.21.0.tar.gz
$ tar xzf gtk-engines-2.21.0.tar.gz
$ cd gtk-engines-2.21.0

# win32
$ ./configure --prefix=/mingw32 --disable-all --enable-clearlooks
# win64
$ ./configure --prefix=/mingw64 --disable-all --enable-clearlooks

$ make
$ make install
$ cd
</pre>

== Clone and build RawTherapee ==

Clone RawTherapee's Git repository. The build process will fail if there is a space character anywhere in your <code>build</code> folder path. For example if your Windows username is "Zank Frappa" then your home path will be <code>C:\Users\Zank Frappa\</code> and if you clone RawTherapee inside there then the build will fail during compilation. Simply clone to a folder where neither it nor its parent folders have a space in their name, for example <code>C:\code\repo-rt</code>
<pre style="white-space: pre-wrap">
$ git clone http://github.com/Beep6581/RawTherapee.git /c/code/repo-rt
$ cd /c/code/repo-rt
</pre>

RawTherapee can be built using GTK+ versions 2 or 3. To build using GTK2 use the <code>gtk2</code> branch; to build using GTK3 use the <code>dev</code> branch. The last version of RawTherapee to support GTK2 is 5.0-r1-gtk2 released on 2017-02-02. Use the <code>dev</code> branch for the latest code - it requires GTK+ >=3.16. When you clone the repository you will automatically find yourself in the <code>dev</code> branch. To switch to the <code>dev</code> branch manually, do the following:
<pre style="white-space: pre-wrap">
$ git checkout dev
</pre>

Create a separate directory for the build:
<pre style="white-space: pre-wrap">
$ mkdir build
$ cd build
</pre>

Note that if you switch branches then you must delete and recreate the <code>build</code> folder so that compilation starts from scratch in an empty folder, otherwise compilation is likely to fail. However if you are just updating without changing branches then you do not have to start with an empty build folder - you can just go into the existing one, and compilation will be faster because not everything will need to be recompiled.

Run CMake and Make:
<pre style="white-space: pre-wrap">
$ cmake -G "MSYS Makefiles" -DLENSFUNDBDIR=share/lensfun -DCMAKE_BUILD_TYPE="release" -DPROC_TARGET_NUMBER="2" -DCACHE_NAME_SUFFIX="5-dev" ..
$ make install
</pre>

Please refer to the [[Linux]] article for an explanation of the various options passed to CMake and Make, including which "BUILD_TYPE" to use.

If you are building for 32-bit Windows XP and are using the <code>release</code> or <code>relwithdebinfo</code> "BUILD_TYPE", you will need to add the <code>-mstackrealign</code> compiler flag before the last two dots <code>..</code> of the CMake command above:
<pre style="white-space: pre-wrap">
-DCMAKE_C_FLAGS="-mstackrealign" -DCMAKE_CXX_FLAGS="-mstackrealign"
</pre>

== Copy RawTherapee and required DLLs ==

RawTherapee can now be started from the MSYS2 command line:
<pre style="white-space: pre-wrap">
# for debug builds
$ cd debug
# for release builds
$ cd release
# for relwithdebinfo builds
$ cd relwithdebinfo
$ ./rawtherapee.exe
</pre>

The file manager can be used to copy the contents of <code>c:\code\repo-rt\build\<debug|release|relwithdebinfo></code> together with the necessary DLLs from <code><MSYS2>\<mingw32|mingw64>\bin</code> into a RawTherapee installation folder, where <code><MSYS2></code> is the MSYS2 installation folder.

A (possibly incomplete) list of required DLLs is:
<pre style="white-space: pre-wrap">
libatk-1.0-0.dll
libatkmm-1.6-1.dll
libsz-1.dll
libcairo-2.dll
libcairo-gobject-2.dll
libcairomm-1.0-1.dll
libcroco-0.6-3.dll
libepoxy-0.dll
libexpat-1.dll
libfﬁ-6.dll
libfftw3f-3.dll
libfontconﬁg-1.dll
libfreetype-6.dll
libgcc_s_seh-1.dll
libgdk_pixbuf-2.0-0.dll
libgdk-3-0.dll
libgdkmm-3.0-1.dll
libgio-2.0-0.dll
libgiomm-2.4-1.dll
libglib-2.0-0.dll
libglibmm-2.4-1.dll
libgmodule-2.0-0.dll
libgobject-2.0-0.dll
libgomp-1.dll
libgraphite2.dll
libgtk-3-0.dll
libgtkmm-3.0-1.dll
libharfbuzz-0.dll
libiconv-2.dll
libintl-8.dll
libjpeg-8.dll
liblcms2-2.dll
liblensfun.dll
liblzma-5.dll
libpango-1.0-0.dll
libpangocairo-1.0-0.dll
libpangoft2-1.0-0.dll
libpangomm-1.4-1.dll
libpangowin32-1.0-0.dll
libpcre-1.dll
libpixman-1-0.dll
libpng16-16.dll
librsvg-2-2.dll
libsigc-2.0-0.dll
libstdc++-6.dll
libsystre-0.dll
libtiff-5.dll
libtre-5.dll
libwinpthread-1.dll
libxml2-2.dll
zlib1.dll
</pre>

The following files also need to be copied:
<pre style="white-space: pre-wrap">
<prefix>\bin\gspawn-<win32|win64>-helper.exe -> .
<prefix>\bin\gspawn-<win32|win64>-helper-console.exe -> .

<prefix>\lib\gtk-2.0\include -> .
<prefix>\lib\gtk-2.0\modules -> .
<prefix>\lib\gtk-2.0\2.10.0\engines -> .

<prefix>\lib\gdk-pixbuf-2.0 -> .\lib\gdk-pixbuf-2.0

<prefix>\share\glib-2.0\schemas\gschemas.compiled -> .\share\glib-2.0\schemas
<prefix>\share\lensfun\version_1\* -> .\share\lensfun
</pre>
where <code><prefix></code> is <code><MSYS2>\<mingw32|mingw64></code> from above and <code>.</code> is the installation folder.

== Creating a distributable package ==

If you plan to distribute RawTherapee packages for the Windows platform, as a first step you need to make sure that RawTherapee will be built for the "generic" processor target. To do so, use <code>-DPROC_TARGET_NUMBER="1"</code> in the CMake command.

During compilation, a script named <code>WindowsInnoSetup.iss</code> is created in the RawTherapee installation folder. This script is used by Inno Setup [http://www.jrsoftware.org/isinfo.php], a program which is used to generate installers for Windows programs. It is advised to download the Unicode version [http://www.jrsoftware.org/download.php/is-unicode.exe] to avoid problems with some languages.

The current <code>WindowsInnoSetup.iss</code> script is designed for the <code>gtk2</code> branch. If you want to create a package for a GTK3 build (<code>dev</code> or <code>releases</code> branches) you will need to edit the script and replace the line:

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\lib\*"; DestDir: "{app}\lib\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

with

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\share\*"; DestDir: "{app}\share\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

so that icons and schemas will be copied into the package.

To help users [[How_to_write_useful_bug_reports|write useful bug reports]], package maintainers are encouraged to produce builds which include both a "release" and a "debug" executable, and to bundle them together with the GDB debugger executable. In other words, put the <code>rawtherapee.exe</code> (release) file together with the <code>rawtherapee-debug.exe</code> (debug) file and the <code>gdb.exe</code> file together into the same installer or the same archive. An alternative is to produce "relwithdebinfo" builds - these are much faster than "debug" but not as optimized as "release" builds, yet they provide just about as much useful information as "debug" builds. When making "relwithdebinfo" or "debug" builds you must provide the GDB debugger executable. Windows binaries of the debugger <code>gdb.exe</code> can be downloaded from [http://www.equation.com/servlet/equation.cmd?fa=gdb here] in 32- and 64-bit versions.

The <code>gdb.exe</code> binary, available from http://www.gnu.org/software/gdb/, should be copied into the RawTherapee installation folder and, if using Inno Setup to generate the package, the <code>WindowsInnoSetup.iss</code> script should be edited by uncommenting (removing the semicolon from the front of) the following around line 114 of the script:

<pre style="white-space: pre-wrap">
;Source: "{#MyBuildBasePath}\gdb.exe"; DestDir: "{app}"; Flags: ignoreversion
</pre>

Now that everything is set up, to create the package right-click on the <code>WindowsInnoSetup.iss</code> script and choose ''Compile'' from the context menu. It will automatically generate the installer and place it in the parent folder.

To make your new package compatible with the RawTherapee website's upload panel, create a zip archive in which you will place both the newly created installer and the corresponding ''AboutThisBuild.txt'' file which can be found at the same place. Name the resulting zip archive following this template:
<code>RawTherapee_<WinXP|WinVista>_<32|64>_<version>_<buildtype>.zip</code>

* "WinXP" means that the build is only for Windows XP. "WinVista" means it can run on any version of Windows from Vista upwards, including 10.
* The "version" will either look like <code>5.2</code> if you checkout the <code>5.2</code> tag, or <code>5.2-dev-g1a2b3c4d</code> if you checkout the <code>dev</code> branch after 5.2 was tagged.
* If you are shipping more than one build type in an installer, include the names of all build types, e.g. <code>release_debug</code>.

For example:
* <code>RawTherapee_WinVista_64_5.2_release.zip</code>
* <code>RawTherapee_WinVista_64_5.2_release_debug.zip</code>
* <code>RawTherapee_WinVista_64_5.2-dev-g1a2b3c4d_release_debug.zip</code>

Windows

2017-09-13T15:08:49Z

Ingo: /* Copy RawTherapee and required DLLs */

This guide documents how to build RawTherapee for 32-bit or 64-bit versions of Windows using the MinGW-w64 runtime. Begin by installing and updating MSYS2 using the instructions from the [https://msys2.github.io/ MSYS2 website]. Then run the following commands using either "''MinGW-w64 Win32 Shell''" if you want to build a 32-bit version, or "''MinGW-w64 Win64 Shell''" if you want to build a 64-bit version.

RawTherapee can be built using GTK+ versions 2 or 3. To build using GTK2 use the <code>gtk2</code> branch; to build using GTK3 use the <code>dev</code> branch. The last version of RawTherapee to support GTK2 is 5.0-r1-gtk2 released on 2017-02-02. Use the <code>dev</code> branch for the latest code - it requires GTK+ >=3.16.

== Install tools and libraries ==

First, install a few miscellaneous tools:
<pre style="white-space: pre-wrap">
$ pacman -S tar gzip nano make diffutils intltool git
</pre>

Then install the necessary development tools:
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gcc mingw-w64-i686-gdb mingw-w64-i686-make mingw-w64-i686-pkg-config mingw-w64-i686-cmake
# win64
$ pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-make mingw-w64-x86_64-pkg-config mingw-w64-x86_64-cmake
</pre>
and the required libraries:
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gtkmm mingw-w64-i686-gtkmm3 mingw-w64-i686-lcms2 mingw-w64-i686-fftw
# win64
$ pacman -S mingw-w64-x86_64-gtkmm mingw-w64-x86_64-gtkmm3 mingw-w64-x86_64-lcms2 mingw-w64-x86_64-fftw mingw-w64-x86_64-lensfun
</pre>

== Download and build libiptcdata ==

The libiptcdata library is not yet provided by MSYS2, therefore it should be downloaded and configured using:
<pre style="white-space: pre-wrap">
$ curl -LO http://downloads.sourceforge.net/project/libiptcdata/libiptcdata/1.0.4/libiptcdata-1.0.4.tar.gz
$ tar xzf libiptcdata-1.0.4.tar.gz
$ cd libiptcdata-1.0.4

# win32
$ ./configure --prefix=/mingw32
# win64
$ ./configure --prefix=/mingw64
</pre>

Afterwards the <code>Makefile</code> needs to be opened using a text editor to remove <code>iptc</code> and <code>docs</code> from the lists named <code>SUBDIRS</code> and <code>DIST_SUBDIRS</code>, as building or installing will fail otherwise:
<pre style="white-space: pre-wrap">
$ nano Makefile

# Replace
DIST_SUBDIRS = m4 libiptcdata po iptc docs win python
# with
DIST_SUBDIRS = m4 libiptcdata po win python

# And replace
SUBDIRS = m4 libiptcdata po iptc docs win $(MAYBE_PYTHONLIB)
# with
SUBDIRS = m4 libiptcdata po win $(MAYBE_PYTHONLIB)
</pre>

Finally build and install the library:
<pre style="white-space: pre-wrap">
$ make
$ make install
$ cd
</pre>

== Download and build Clearlooks ==

If you are building RawTherapee using GTK2 then you need the Clearlooks theme engine. You do not need it if you are building using GTK3.

Download and build it:
<pre style="white-space: pre-wrap">
$ curl -LO http://sources.archlinux.org/other/gtk-engines/gtk-engines-2.21.0.tar.gz
$ tar xzf gtk-engines-2.21.0.tar.gz
$ cd gtk-engines-2.21.0

# win32
$ ./configure --prefix=/mingw32 --disable-all --enable-clearlooks
# win64
$ ./configure --prefix=/mingw64 --disable-all --enable-clearlooks

$ make
$ make install
$ cd
</pre>

== Clone and build RawTherapee ==

Clone RawTherapee's Git repository. The build process will fail if there is a space character anywhere in your <code>build</code> folder path. For example if your Windows username is "Zank Frappa" then your home path will be <code>C:\Users\Zank Frappa\</code> and if you clone RawTherapee inside there then the build will fail during compilation. Simply clone to a folder where neither it nor its parent folders have a space in their name, for example <code>C:\code\repo-rt</code>
<pre style="white-space: pre-wrap">
$ git clone http://github.com/Beep6581/RawTherapee.git /c/code/repo-rt
$ cd /c/code/repo-rt
</pre>

RawTherapee can be built using GTK+ versions 2 or 3. To build using GTK2 use the <code>gtk2</code> branch; to build using GTK3 use the <code>dev</code> branch. The last version of RawTherapee to support GTK2 is 5.0-r1-gtk2 released on 2017-02-02. Use the <code>dev</code> branch for the latest code - it requires GTK+ >=3.16. When you clone the repository you will automatically find yourself in the <code>dev</code> branch. To switch to the <code>dev</code> branch manually, do the following:
<pre style="white-space: pre-wrap">
$ git checkout dev
</pre>

Create a separate directory for the build:
<pre style="white-space: pre-wrap">
$ mkdir build
$ cd build
</pre>

Note that if you switch branches then you must delete and recreate the <code>build</code> folder so that compilation starts from scratch in an empty folder, otherwise compilation is likely to fail. However if you are just updating without changing branches then you do not have to start with an empty build folder - you can just go into the existing one, and compilation will be faster because not everything will need to be recompiled.

Run CMake and Make:
<pre style="white-space: pre-wrap">
$ cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE="release" -DPROC_TARGET_NUMBER="2" -DCACHE_NAME_SUFFIX="5-dev" ..
$ make install
</pre>

Please refer to the [[Linux]] article for an explanation of the various options passed to CMake and Make, including which "BUILD_TYPE" to use.

If you are building for 32-bit Windows XP and are using the <code>release</code> or <code>relwithdebinfo</code> "BUILD_TYPE", you will need to add the <code>-mstackrealign</code> compiler flag before the last two dots <code>..</code> of the CMake command above:
<pre style="white-space: pre-wrap">
-DCMAKE_C_FLAGS="-mstackrealign" -DCMAKE_CXX_FLAGS="-mstackrealign"
</pre>

== Copy RawTherapee and required DLLs ==

RawTherapee can now be started from the MSYS2 command line:
<pre style="white-space: pre-wrap">
# for debug builds
$ cd debug
# for release builds
$ cd release
# for relwithdebinfo builds
$ cd relwithdebinfo
$ ./rawtherapee.exe
</pre>

The file manager can be used to copy the contents of <code>c:\code\repo-rt\build\<debug|release|relwithdebinfo></code> together with the necessary DLLs from <code><MSYS2>\<mingw32|mingw64>\bin</code> into a RawTherapee installation folder, where <code><MSYS2></code> is the MSYS2 installation folder.

A (possibly incomplete) list of required DLLs is:
<pre style="white-space: pre-wrap">
libatk-1.0-0.dll
libatkmm-1.6-1.dll
libsz-1.dll
libcairo-2.dll
libcairo-gobject-2.dll
libcairomm-1.0-1.dll
libcroco-0.6-3.dll
libepoxy-0.dll
libexpat-1.dll
libfﬁ-6.dll
libfftw3f-3.dll
libfontconﬁg-1.dll
libfreetype-6.dll
libgcc_s_seh-1.dll
libgdk_pixbuf-2.0-0.dll
libgdk-3-0.dll
libgdkmm-3.0-1.dll
libgio-2.0-0.dll
libgiomm-2.4-1.dll
libglib-2.0-0.dll
libglibmm-2.4-1.dll
libgmodule-2.0-0.dll
libgobject-2.0-0.dll
libgomp-1.dll
libgraphite2.dll
libgtk-3-0.dll
libgtkmm-3.0-1.dll
libharfbuzz-0.dll
libiconv-2.dll
libintl-8.dll
libjpeg-8.dll
liblcms2-2.dll
liblensfun.dll
liblzma-5.dll
libpango-1.0-0.dll
libpangocairo-1.0-0.dll
libpangoft2-1.0-0.dll
libpangomm-1.4-1.dll
libpangowin32-1.0-0.dll
libpcre-1.dll
libpixman-1-0.dll
libpng16-16.dll
librsvg-2-2.dll
libsigc-2.0-0.dll
libstdc++-6.dll
libsystre-0.dll
libtiff-5.dll
libtre-5.dll
libwinpthread-1.dll
libxml2-2.dll
zlib1.dll
</pre>

The following files also need to be copied:
<pre style="white-space: pre-wrap">
<prefix>\bin\gspawn-<win32|win64>-helper.exe -> .
<prefix>\bin\gspawn-<win32|win64>-helper-console.exe -> .

<prefix>\lib\gtk-2.0\include -> .
<prefix>\lib\gtk-2.0\modules -> .
<prefix>\lib\gtk-2.0\2.10.0\engines -> .

<prefix>\lib\gdk-pixbuf-2.0 -> .\lib\gdk-pixbuf-2.0

<prefix>\share\glib-2.0\schemas\gschemas.compiled -> .\share\glib-2.0\schemas
<prefix>\share\lensfun\version_1\* -> .\share\lensfun
</pre>
where <code><prefix></code> is <code><MSYS2>\<mingw32|mingw64></code> from above and <code>.</code> is the installation folder.

== Creating a distributable package ==

If you plan to distribute RawTherapee packages for the Windows platform, as a first step you need to make sure that RawTherapee will be built for the "generic" processor target. To do so, use <code>-DPROC_TARGET_NUMBER="1"</code> in the CMake command.

During compilation, a script named <code>WindowsInnoSetup.iss</code> is created in the RawTherapee installation folder. This script is used by Inno Setup [http://www.jrsoftware.org/isinfo.php], a program which is used to generate installers for Windows programs. It is advised to download the Unicode version [http://www.jrsoftware.org/download.php/is-unicode.exe] to avoid problems with some languages.

The current <code>WindowsInnoSetup.iss</code> script is designed for the <code>gtk2</code> branch. If you want to create a package for a GTK3 build (<code>dev</code> or <code>releases</code> branches) you will need to edit the script and replace the line:

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\lib\*"; DestDir: "{app}\lib\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

with

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\share\*"; DestDir: "{app}\share\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

so that icons and schemas will be copied into the package.

To help users [[How_to_write_useful_bug_reports|write useful bug reports]], package maintainers are encouraged to produce builds which include both a "release" and a "debug" executable, and to bundle them together with the GDB debugger executable. In other words, put the <code>rawtherapee.exe</code> (release) file together with the <code>rawtherapee-debug.exe</code> (debug) file and the <code>gdb.exe</code> file together into the same installer or the same archive. An alternative is to produce "relwithdebinfo" builds - these are much faster than "debug" but not as optimized as "release" builds, yet they provide just about as much useful information as "debug" builds. When making "relwithdebinfo" or "debug" builds you must provide the GDB debugger executable. Windows binaries of the debugger <code>gdb.exe</code> can be downloaded from [http://www.equation.com/servlet/equation.cmd?fa=gdb here] in 32- and 64-bit versions.

The <code>gdb.exe</code> binary, available from http://www.gnu.org/software/gdb/, should be copied into the RawTherapee installation folder and, if using Inno Setup to generate the package, the <code>WindowsInnoSetup.iss</code> script should be edited by uncommenting (removing the semicolon from the front of) the following around line 114 of the script:

<pre style="white-space: pre-wrap">
;Source: "{#MyBuildBasePath}\gdb.exe"; DestDir: "{app}"; Flags: ignoreversion
</pre>

Now that everything is set up, to create the package right-click on the <code>WindowsInnoSetup.iss</code> script and choose ''Compile'' from the context menu. It will automatically generate the installer and place it in the parent folder.

To make your new package compatible with the RawTherapee website's upload panel, create a zip archive in which you will place both the newly created installer and the corresponding ''AboutThisBuild.txt'' file which can be found at the same place. Name the resulting zip archive following this template:
<code>RawTherapee_<WinXP|WinVista>_<32|64>_<version>_<buildtype>.zip</code>

* "WinXP" means that the build is only for Windows XP. "WinVista" means it can run on any version of Windows from Vista upwards, including 10.
* The "version" will either look like <code>5.2</code> if you checkout the <code>5.2</code> tag, or <code>5.2-dev-g1a2b3c4d</code> if you checkout the <code>dev</code> branch after 5.2 was tagged.
* If you are shipping more than one build type in an installer, include the names of all build types, e.g. <code>release_debug</code>.

For example:
* <code>RawTherapee_WinVista_64_5.2_release.zip</code>
* <code>RawTherapee_WinVista_64_5.2_release_debug.zip</code>
* <code>RawTherapee_WinVista_64_5.2-dev-g1a2b3c4d_release_debug.zip</code>

Linux

2017-09-13T15:03:40Z

Ingo: /* Arch */

This page details instructions for compiling RawTherapee on '''GNU/Linux''' systems. There are also instructions for compiling on [[Windows]] and [[OS X]].

When in doubt, [[IRC | join us on IRC]] and ask a human!

== Dependencies ==
To compile RawTherapee your system will need a set of tools. They are called dependencies, and here is a list of dependencies for both GTK2 and GTK3 versions of RawTherapee:

{| class="wikitable sortable"
|+ Build-time dependencies for RawTherapee 4 and 5.0.
! GTK+ !! Package !! Version !! Gentoo !! Debian/Ubuntu !! URL
|-
| GTK2, GTK3 || BZIP2 || bzip2>-1.0.4 || app-arch/bzip2 || libbz2-dev || http://www.bzip.org/
|-
| GTK2, GTK3 || EXIV2 || exiv2>=0.19 || media-gfx/exiv2 || libexiv2-dev || http://www.exiv2.org/
|-
| GTK2, GTK3 || EXPAT || expat>=2.1.0 || dev-libs/expat || libexpat-dev || http://expat.sourceforge.net/
|-
| GTK2, GTK3 || FFTW3 || fftw>=3.2.2 || sci-libs/fftw || fftw-dev || http://fftw.org/
|-
| GTK2, GTK3 || GCC || gcc>=4.9 || sys-devel/gcc || build-essential || http://gcc.gnu.org/
|-
| GTK2, GTK3 || GLIB2 || glib-2.0>=2.24 || dev-libs/glib || libglib2.0-dev || http://www.gtk.org/
|-
| GTK2, GTK3 || GLIBMM || glibmm-2.4>=2.24 || dev-cpp/glibmm || libglibmm-2.4-dev || http://www.gtkmm.org
|-
| GTK2 || GTK+ || gtk+-2.0>=2.24.18 || x11-libs/gtk+ || libgtk2.0-dev || http://www.gtk.org/
|-
| GTK3 || GTK+ || gtk+-3.16 || x11-libs/gtk+ || libgtk-3-dev || http://www.gtk.org/
|-
| GTK2 || GTK2-Engines || gtk-engines-2.20.2 || x11-themes/gtk-engines || gtk2-engines || http://www.gtk.org/
|-
| GTK2 || GTKMM || gtkmm-2.4>=2.22 || dev-cpp/gtkmm || libgtkmm-2.4-dev || http://www.gtkmm.org
|-
| GTK3 || GTKMM || gtkmm-3.16 || dev-cpp/gtkmm || libgtkmm-3.0-dev || http://www.gtkmm.org
|-
| GTK2, GTK3 || JPEG || libjpeg>=6b || media-libs/jpeg || libjpeg-dev || http://libjpeg-turbo.virtualgl.org/ http://jpegclub.org/ http://www.ijg.org/
|-
| GTK2, GTK3 || LCMS2 || lcms>=2.6 || media-libs/lcms || liblcms2-dev || http://www.littlecms.com/
|-
| GTK2, GTK3 || LIBCANBERRA || libcanberra>=0.29 || media-libs/libcanberra || libcanberra-gtk3-dev || http://0pointer.de/lennart/projects/libcanberra/ (Linux only)
|-
| GTK2, GTK3 || LIBIPTCDATA || libiptcdata>=1.0.2 || media-libs/libiptcdata || libiptcdata-dev || http://libiptcdata.sourceforge.net
|-
| GTK2, GTK3 || PNG || libpng>=1.2.44 || media-libs/libpng || libpng-dev || http://www.libpng.org/
|-
| GTK2, GTK3 || SIGC || sigc++-2.0 || dev-libs/libsigc++ || libsigc++-2.0-dev || http://libsigc.sourceforge.net/
|-
| GTK2, GTK3 || TIFF || libtiff>=3.9.4 || media-libs/tiff || libtiff-dev || http://www.remotesensing.org/libtiff/
|-
| GTK2, GTK3 || ZLIB || zlib>=1.2.3 || sys-libs/zlib || zlib1g-dev || http://www.zlib.net/
|}

To compile the outdated RawTherapee 3 you will need these:

{| class="wikitable"
|+ Build-time dependencies for RawTherapee 3
! Package !! Version !! Gentoo !! Debian/Ubuntu !! URL
|-
| LCMS1 || lcms<=1.99 || media-libs/lcms || liblcms1-dev || http://www.littlecms.com/
|}

In order to install all these dependencies, you will need to open a console and paste the code from the appropriate section into the console. Note that these code snippets include the GTK3 dependencies if available, so if you want to compile the legacy "gtk2" branch which uses GTK2 then replace the GTK3 dependencies with GTK2 ones as described in the list above.

=== Arch ===
The latest Arch supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo pacman -S bzip2 exiv2 expat fftw glib2 glibmm gtk3 gtkmm3 lcms2 lensfun libcanberra libiptcdata libjpeg-turbo libpng libsigc++ libtiff zlib</pre>

=== CentOS 7.1 ===
CentOS 7.1 does not support a recent enough version of GTK3, so you can only compile the <code>gtk2</code> branch.
As CentOS 7.1 does not seem to have the Clearlooks GTK2 theme engine, you will either need to install some other GTK2 theme engine, or after installing RawTherapee go to "Preferences > General > Default Theme" and enable "Use system theme".
<pre style="white-space: pre-wrap">sudo yum install bzip2-devel cmake curl exiv2-devel expat-devel fftw-devel gcc-c++ git glibmm24-devel gtk2-devel gtkmm24-devel lcms2-devel libjpeg-turbo-devel libcanberra-devel libiptcdata-devel libpng-devel libtiff-devel sigc++20-devel zlib-devel</pre>

=== Fedora ===
Fedora supports GTK3 from version 22, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
If you are using Fedora version 21 or older, use the legacy <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo dnf install bzip2-devel cmake exiv2-devel expat-devel fftw-devel gcc-c++ glib2-devel glibmm24-devel gtk3-devel gtkmm30-devel lcms2-devel libcanberra-devel libiptcdata-devel libjpeg-turbo-devel libpng-devel libsigc++20-devel libtiff-devel zlib-devel</pre>

=== Gentoo ===
Gentoo supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo emerge -uva app-arch/bzip2 dev-cpp/gtkmm:3.0 dev-libs/expat media-gfx/exiv2 media-libs/lcms media-libs/libcanberra media-libs/libiptcdata media-libs/libjpeg-turbo media-libs/libpng media-libs/tiff net-misc/curl sci-libs/fftw sys-libs/zlib x11-libs/gtk+:3</pre>

=== openSUSE ===
openSUSE 42.2 and Tumbleweed support GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
Note: openSUSE 42.1 supports GTK+ 3.16.7 but compilation fails as the sigc++-2.0>=2.4 requirement is not met.
If you are using openSUSE version 42.1 or older, use the legacy <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo zypper in cmake fftw3-devel gcc-c++ glib2-devel glibmm2-devel gtk3-devel gtkmm3-devel libbz2-devel libcanberra-devel libexpat-devel libiptcdata-devel libjpeg-devel liblcms2-devel libpng-devel libsigc++2-devel libtiff-devel zlib-devel</pre>

=== Sabayon ===
Sabayon supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo equo install app-arch/bzip2 dev-cpp/gtkmm:3.0 dev-libs/expat dev-util/cmake media-gfx/exiv2 media-libs/lcms media-libs/libcanberra media-libs/libiptcdata media-libs/libjpeg-turbo media-libs/libpng media-libs/tiff net-misc/curl sci-libs/fftw sys-libs/zlib x11-libs/gtk+:3</pre>

=== Ubuntu ===
Ubuntu as of version 15.10 (Wily Werewolf) supports GTK3, use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
Older versions of Ubuntu either do not support GTK3 at all, or the version of GTK3 they ship is not recent enough (RawTherapee GTK3 support requires GTK3 version 3.16 or newer), meaning you must use the legacy <code>gtk2</code> branch which uses GTK2.

==== Ubuntu 16.10 ====
Use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo apt update
sudo apt install build-essential cmake curl git libcanberra-gtk3-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk-3-dev libgtkmm-3.0-dev libiptcdata0-dev libjpeg-dev liblcms2-dev libpng-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 16.04 LTS and 15.10 ====
Use the <code>dev</code> branch (or checkout a "gtk3" release tag). The dependencies below are only for GTK3.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk3-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk-3-dev libgtkmm-3.0-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 15.04, 14.10, 14.04 LTS ====
Use the legacy <code>gtk2</code> branch. The dependencies below are only for the <code>gtk2</code> branch.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

RawTherapee requires GCC version 4.9 or higher. Ubuntu 14.04 LTS ships with GCC version 4.8.2 which is too old - to get 4.9, follow these steps: http://askubuntu.com/questions/466651/how-do-i-use-the-latest-gcc-on-ubuntu-14-04

==== Ubuntu 13.10, 13.04, 12.10, 12.04 LTS, 11.10 ====
These versions of Ubuntu are badly outdated. The code below used to work but it may stop working at any moment. Upgrade your operating system.

As these versions of Ubuntu only support GCC-4.8.1 and older, the latest commit you will be able to compile is [https://github.com/Beep6581/RawTherapee/commit/b343b9a7 commit b343b9a7] from 2015-12-29 - newer versions will not compile.
<pre style="white-space: pre-wrap">sudo apt-get update
sudo apt-get install build-essential cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libfftw3-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg8-dev liblcms2-dev libpng12-dev libsigc++-2.0-dev libtiff5-dev zlib1g-dev</pre>

==== Ubuntu 10.10 and 11.04 ====
These versions of Ubuntu are badly outdated. The code below used to work but it may stop working at any moment. Upgrade your operating system.

<pre style="white-space: pre-wrap">sudo apt-add-repository ppa:dasprid/rawtherapee
sudo apt-get update
sudo apt-get install cmake curl git libbz2-dev libcanberra-gtk-dev libexiv2-dev libexpat-dev libglibmm-2.4-dev libgtk2.0-dev libgtkmm-2.4-dev libiptcdata0-dev libjpeg62 liblcms2-dev libnm-glib2 libpng12-dev libsigc++-2.0-dev libtiff4-dev zlib1g-dev</pre>


== Compiling: The Manual Way ==
This section describes compiling RawTherapee manually.

=== Clone the source ===
First, you need to clone RawTherapee's source code repository. Bring up your console and run this:

<pre style="white-space: pre-wrap">git clone https://github.com/Beep6581/RawTherapee ~/repo-rt
cd ~/repo-rt</pre>

=== Choose a branch ===
* Features are developed on their own feature branches.
* Development happens on the <code>dev</code> branch. Feature branches are merged into the <code>dev</code> branch when they're ready. The <code>dev</code> branch is unstable.
* Releases are tagged on the <code>releases</code> branch.

Checkout the latest tag if you want the most stable code. To see all available tags, type:
<pre style="white-space: pre-wrap">git tag</pre>

Checkout the <code>dev</code> branch or some other feature branch if you want to test the latest bleeding-edge code. To see all available branches, type:
<pre style="white-space: pre-wrap">git branch -a</pre>

Checking out is done via the "git checkout" command. To checkout a tag or a branch, type:
<pre style="white-space: pre-wrap">git checkout <tag or branch></pre>

RawTherapee uses GTK+ for the user interface and requires GTK+ version 3.16 or newer. If your system does not support version 3.16 or newer then you must checkout the <code>5.0-r1-gtk2</code> tag. Our GTK2 support has officially ended on 2 February 2017 - update your system.

Note: Compiling old versions of RawTherapee will fail on a modern system, as you will be missing the old dependencies.

=== Compile RawTherapee ===
Now you will make an out-of-source compilation of RawTherapee, it will be built into the ~/repo-rt/build/release folder, and then you will move this folder to your home directory and rename it to "rt", so make sure there is no ~/rt folder already!

There are a few compilation settings you need to be aware of, you will pass these to CMake using the -D option as described below:

; BUILD_TYPE
: You must specify the <code>BUILD_TYPE</code> when building RawTherapee. You can set the <code>BUILD_TYPE</code> value to "<code>debug</code>", "<code>relwithdebinfo</code>" or "<code>release</code>". The "debug" and "relwithdebinfo" builds will let you [[How_to_write_useful_bug_reports | get a useful stack-backtrace]] if RawTherapee crashes while running through GDB which you can then submit to us so we can find the problem and fix it. The "debug" build is the slowest but generates the most detailed information. The "relwithdebinfo" build is almost as fast as a "release" build and generates often sufficient information, though not as detiled as a "debug" build. The "release" build will not provide any useful information when it crashes, but does contain many speed optimizations resulting in a program that works many times faster than the "debug" version would. For normal use, make a "release" or "relwithdebinfo" build. If you find a reproducible bug, then make a "debug" build and send us a stack-backtrace (or fix it yourself and send us the patch!). Alternatively use a "relwithdebinfo" build, and hope that it's detailed enough.
:: To make a "release" type build, write: <code>-DCMAKE_BUILD_TYPE="release"</code>
:: Replace "release" by "debug" or "relwithdebinfo" as needed.

; USE_OLD_CXX_ABI
: When compiling a program, one must use the same conventions as those used by the libraries which that program relies upon, otherwise compilation (linking) will fail. Generally one does not need to concern oneself with this, but we are now at a time when GCC4 is being phased out by GCC5, each by default uses a convention incompatible with the other, and so this issue is relevant. If the libraries on your system have been compiled using GCC5, they probably use a standard called C++11. This means that your RawTherapee build must use the same standard, which is the case by default. However if despite using GCC5 your libraries were built using the older C++03 standard, then RawTherapee must be set to use the same, and this is when you would set "USE_OLD_CXX_ABI" to "ON":
:: To enable USE_OLD_CXX_ABI, write: <code>-DUSE_OLD_CXX_ABI="ON"</code>

; CACHE_NAME_SUFFIX
: The CACHE_NAME_SUFFIX options dictates the suffix of the cache and config folder names the compiled RawTherapee build will use.
: See the [[File Paths]] article for a full explanation, or just use "5-dev".

; PROC_TARGET_NUMBER
: The PROC_TARGET_NUMBER option sets which CPU type to optimize for. "2" is a safe choice because it means "native", so the optimizations will be automatically detected for your CPU.
: For more info, see the file "ProcessorTargets.cmake" in the cloned repository.
:: To make a build using "native" optimizations, write: <code>-DPROC_TARGET_NUMBER="2"</code>

Finally, you need to find out how many threads your CPU supports. This will make compilation faster but it will have no effect on the speed of running RawTherapee.
; Threads
: To find out how many threads your CPU supports, run:
: <code>grep -c processor /proc/cpuinfo</code>
: Then replace the number in "-j8" below with this number.

Now you are ready to compile:
<pre style="white-space: pre-wrap">cd ~/repo-rt
rm -rf build
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE="release" \
-DPROC_TARGET_NUMBER="2" \
-DBUILD_BUNDLE="ON" \
-DCACHE_NAME_SUFFIX="5-dev" \
-DWITH_LTO="OFF" \
..
make -j4 install
mv release ~/rt</pre>

=== Run RawTherapee ===
To run RawTherapee:
<pre style="white-space: pre-wrap">~/rt/rawtherapee</pre>

The source code repository is in <code>~/repo-rt</code> and the compiled program is in <code>~/rt</code>

You can safely delete <code>~/repo-rt</code> if you so wish. The compiled program will still work, but then you will have to redo all the above steps if you want to update. Rather, leave the repository intact so that you can do the next step in a week or a month's time.

=== Update RawTherapee ===
Every time you want to update your RawTherapee to the latest code available, just do the following:
<pre style="white-space: pre-wrap">cd ~/repo-rt
git pull</pre>

Then repeat the [[Linux#Compile RawTherapee | Compile RawTherapee]] step above.

Windows

2017-09-13T14:23:59Z

Ingo: /* Install tools and libraries */

This guide documents how to build RawTherapee for 32-bit or 64-bit versions of Windows using the MinGW-w64 runtime. Begin by installing and updating MSYS2 using the instructions from the [https://msys2.github.io/ MSYS2 website]. Then run the following commands using either "''MinGW-w64 Win32 Shell''" if you want to build a 32-bit version, or "''MinGW-w64 Win64 Shell''" if you want to build a 64-bit version.

RawTherapee can be built using GTK+ versions 2 or 3. To build using GTK2 use the <code>gtk2</code> branch; to build using GTK3 use the <code>dev</code> branch. The last version of RawTherapee to support GTK2 is 5.0-r1-gtk2 released on 2017-02-02. Use the <code>dev</code> branch for the latest code - it requires GTK+ >=3.16.

== Install tools and libraries ==

First, install a few miscellaneous tools:
<pre style="white-space: pre-wrap">
$ pacman -S tar gzip nano make diffutils intltool git
</pre>

Then install the necessary development tools:
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gcc mingw-w64-i686-gdb mingw-w64-i686-make mingw-w64-i686-pkg-config mingw-w64-i686-cmake
# win64
$ pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-make mingw-w64-x86_64-pkg-config mingw-w64-x86_64-cmake
</pre>
and the required libraries:
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gtkmm mingw-w64-i686-gtkmm3 mingw-w64-i686-lcms2 mingw-w64-i686-fftw
# win64
$ pacman -S mingw-w64-x86_64-gtkmm mingw-w64-x86_64-gtkmm3 mingw-w64-x86_64-lcms2 mingw-w64-x86_64-fftw mingw-w64-x86_64-lensfun
</pre>

== Download and build libiptcdata ==

The libiptcdata library is not yet provided by MSYS2, therefore it should be downloaded and configured using:
<pre style="white-space: pre-wrap">
$ curl -LO http://downloads.sourceforge.net/project/libiptcdata/libiptcdata/1.0.4/libiptcdata-1.0.4.tar.gz
$ tar xzf libiptcdata-1.0.4.tar.gz
$ cd libiptcdata-1.0.4

# win32
$ ./configure --prefix=/mingw32
# win64
$ ./configure --prefix=/mingw64
</pre>

Afterwards the <code>Makefile</code> needs to be opened using a text editor to remove <code>iptc</code> and <code>docs</code> from the lists named <code>SUBDIRS</code> and <code>DIST_SUBDIRS</code>, as building or installing will fail otherwise:
<pre style="white-space: pre-wrap">
$ nano Makefile

# Replace
DIST_SUBDIRS = m4 libiptcdata po iptc docs win python
# with
DIST_SUBDIRS = m4 libiptcdata po win python

# And replace
SUBDIRS = m4 libiptcdata po iptc docs win $(MAYBE_PYTHONLIB)
# with
SUBDIRS = m4 libiptcdata po win $(MAYBE_PYTHONLIB)
</pre>

Finally build and install the library:
<pre style="white-space: pre-wrap">
$ make
$ make install
$ cd
</pre>

== Download and build Clearlooks ==

If you are building RawTherapee using GTK2 then you need the Clearlooks theme engine. You do not need it if you are building using GTK3.

Download and build it:
<pre style="white-space: pre-wrap">
$ curl -LO http://sources.archlinux.org/other/gtk-engines/gtk-engines-2.21.0.tar.gz
$ tar xzf gtk-engines-2.21.0.tar.gz
$ cd gtk-engines-2.21.0

# win32
$ ./configure --prefix=/mingw32 --disable-all --enable-clearlooks
# win64
$ ./configure --prefix=/mingw64 --disable-all --enable-clearlooks

$ make
$ make install
$ cd
</pre>

== Clone and build RawTherapee ==

Clone RawTherapee's Git repository. The build process will fail if there is a space character anywhere in your <code>build</code> folder path. For example if your Windows username is "Zank Frappa" then your home path will be <code>C:\Users\Zank Frappa\</code> and if you clone RawTherapee inside there then the build will fail during compilation. Simply clone to a folder where neither it nor its parent folders have a space in their name, for example <code>C:\code\repo-rt</code>
<pre style="white-space: pre-wrap">
$ git clone http://github.com/Beep6581/RawTherapee.git /c/code/repo-rt
$ cd /c/code/repo-rt
</pre>

RawTherapee can be built using GTK+ versions 2 or 3. To build using GTK2 use the <code>gtk2</code> branch; to build using GTK3 use the <code>dev</code> branch. The last version of RawTherapee to support GTK2 is 5.0-r1-gtk2 released on 2017-02-02. Use the <code>dev</code> branch for the latest code - it requires GTK+ >=3.16. When you clone the repository you will automatically find yourself in the <code>dev</code> branch. To switch to the <code>dev</code> branch manually, do the following:
<pre style="white-space: pre-wrap">
$ git checkout dev
</pre>

Create a separate directory for the build:
<pre style="white-space: pre-wrap">
$ mkdir build
$ cd build
</pre>

Note that if you switch branches then you must delete and recreate the <code>build</code> folder so that compilation starts from scratch in an empty folder, otherwise compilation is likely to fail. However if you are just updating without changing branches then you do not have to start with an empty build folder - you can just go into the existing one, and compilation will be faster because not everything will need to be recompiled.

Run CMake and Make:
<pre style="white-space: pre-wrap">
$ cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE="release" -DPROC_TARGET_NUMBER="2" -DCACHE_NAME_SUFFIX="5-dev" ..
$ make install
</pre>

Please refer to the [[Linux]] article for an explanation of the various options passed to CMake and Make, including which "BUILD_TYPE" to use.

If you are building for 32-bit Windows XP and are using the <code>release</code> or <code>relwithdebinfo</code> "BUILD_TYPE", you will need to add the <code>-mstackrealign</code> compiler flag before the last two dots <code>..</code> of the CMake command above:
<pre style="white-space: pre-wrap">
-DCMAKE_C_FLAGS="-mstackrealign" -DCMAKE_CXX_FLAGS="-mstackrealign"
</pre>

== Copy RawTherapee and required DLLs ==

RawTherapee can now be started from the MSYS2 command line:
<pre style="white-space: pre-wrap">
# for debug builds
$ cd debug
# for release builds
$ cd release
# for relwithdebinfo builds
$ cd relwithdebinfo
$ ./rawtherapee.exe
</pre>

The file manager can be used to copy the contents of <code>c:\code\repo-rt\build\<debug|release|relwithdebinfo></code> together with the necessary DLLs from <code><MSYS2>\<mingw32|mingw64>\bin</code> into a RawTherapee installation folder, where <code><MSYS2></code> is the MSYS2 installation folder.

A (possibly incomplete) list of required DLLs is:
<pre style="white-space: pre-wrap">
libatk-1.0-0.dll
libatkmm-1.6-1.dll
libsz-1.dll
libcairo-2.dll
libcairo-gobject-2.dll
libcairomm-1.0-1.dll
libcroco-0.6-3.dll
libepoxy-0.dll
libexpat-1.dll
libfﬁ-6.dll
libfftw3f-3.dll
libfontconﬁg-1.dll
libfreetype-6.dll
libgcc_s_seh-1.dll
libgdk_pixbuf-2.0-0.dll
libgdk-3-0.dll
libgdkmm-3.0-1.dll
libgio-2.0-0.dll
libgiomm-2.4-1.dll
libglib-2.0-0.dll
libglibmm-2.4-1.dll
libgmodule-2.0-0.dll
libgobject-2.0-0.dll
libgomp-1.dll
libgraphite2.dll
libgtk-3-0.dll
libgtkmm-3.0-1.dll
libharfbuzz-0.dll
libiconv-2.dll
libintl-8.dll
libjpeg-8.dll
liblcms2-2.dll
liblzma-5.dll
libpango-1.0-0.dll
libpangocairo-1.0-0.dll
libpangoft2-1.0-0.dll
libpangomm-1.4-1.dll
libpangowin32-1.0-0.dll
libpcre-1.dll
libpixman-1-0.dll
libpng16-16.dll
librsvg-2-2.dll
libsigc-2.0-0.dll
libstdc++-6.dll
libtiff-5.dll
libwinpthread-1.dll
libxml2-2.dll
zlib1.dll
</pre>

The following files also need to be copied:
<pre style="white-space: pre-wrap">
<prefix>\bin\gspawn-<win32|win64>-helper.exe -> .
<prefix>\bin\gspawn-<win32|win64>-helper-console.exe -> .

<prefix>\lib\gtk-2.0\include -> .
<prefix>\lib\gtk-2.0\modules -> .
<prefix>\lib\gtk-2.0\2.10.0\engines -> .

<prefix>\lib\gdk-pixbuf-2.0 -> .\lib\gdk-pixbuf-2.0

<prefix>\share\glib-2.0\schemas\gschemas.compiled -> .\share\glib-2.0\schemas
</pre>
where <code><prefix></code> is <code><MSYS2>\<mingw32|mingw64></code> from above and <code>.</code> is the installation folder.

== Creating a distributable package ==

If you plan to distribute RawTherapee packages for the Windows platform, as a first step you need to make sure that RawTherapee will be built for the "generic" processor target. To do so, use <code>-DPROC_TARGET_NUMBER="1"</code> in the CMake command.

During compilation, a script named <code>WindowsInnoSetup.iss</code> is created in the RawTherapee installation folder. This script is used by Inno Setup [http://www.jrsoftware.org/isinfo.php], a program which is used to generate installers for Windows programs. It is advised to download the Unicode version [http://www.jrsoftware.org/download.php/is-unicode.exe] to avoid problems with some languages.

The current <code>WindowsInnoSetup.iss</code> script is designed for the <code>gtk2</code> branch. If you want to create a package for a GTK3 build (<code>dev</code> or <code>releases</code> branches) you will need to edit the script and replace the line:

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\lib\*"; DestDir: "{app}\lib\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

with

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\share\*"; DestDir: "{app}\share\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

so that icons and schemas will be copied into the package.

To help users [[How_to_write_useful_bug_reports|write useful bug reports]], package maintainers are encouraged to produce builds which include both a "release" and a "debug" executable, and to bundle them together with the GDB debugger executable. In other words, put the <code>rawtherapee.exe</code> (release) file together with the <code>rawtherapee-debug.exe</code> (debug) file and the <code>gdb.exe</code> file together into the same installer or the same archive. An alternative is to produce "relwithdebinfo" builds - these are much faster than "debug" but not as optimized as "release" builds, yet they provide just about as much useful information as "debug" builds. When making "relwithdebinfo" or "debug" builds you must provide the GDB debugger executable. Windows binaries of the debugger <code>gdb.exe</code> can be downloaded from [http://www.equation.com/servlet/equation.cmd?fa=gdb here] in 32- and 64-bit versions.

The <code>gdb.exe</code> binary, available from http://www.gnu.org/software/gdb/, should be copied into the RawTherapee installation folder and, if using Inno Setup to generate the package, the <code>WindowsInnoSetup.iss</code> script should be edited by uncommenting (removing the semicolon from the front of) the following around line 114 of the script:

<pre style="white-space: pre-wrap">
;Source: "{#MyBuildBasePath}\gdb.exe"; DestDir: "{app}"; Flags: ignoreversion
</pre>

Now that everything is set up, to create the package right-click on the <code>WindowsInnoSetup.iss</code> script and choose ''Compile'' from the context menu. It will automatically generate the installer and place it in the parent folder.

To make your new package compatible with the RawTherapee website's upload panel, create a zip archive in which you will place both the newly created installer and the corresponding ''AboutThisBuild.txt'' file which can be found at the same place. Name the resulting zip archive following this template:
<code>RawTherapee_<WinXP|WinVista>_<32|64>_<version>_<buildtype>.zip</code>

* "WinXP" means that the build is only for Windows XP. "WinVista" means it can run on any version of Windows from Vista upwards, including 10.
* The "version" will either look like <code>5.2</code> if you checkout the <code>5.2</code> tag, or <code>5.2-dev-g1a2b3c4d</code> if you checkout the <code>dev</code> branch after 5.2 was tagged.
* If you are shipping more than one build type in an installer, include the names of all build types, e.g. <code>release_debug</code>.

For example:
* <code>RawTherapee_WinVista_64_5.2_release.zip</code>
* <code>RawTherapee_WinVista_64_5.2_release_debug.zip</code>
* <code>RawTherapee_WinVista_64_5.2-dev-g1a2b3c4d_release_debug.zip</code>

Demosaicing

2017-03-19T02:57:38Z

Ingo:

{{1:1}}

[[File:Chipincamera.jpg|thumb|Cutaway illustration of a camera showing the light sensor with a Bayer filter.]]
[[File:Bayer pattern on sensor.svg|thumb|Bayer pattern on sensor.]]
[[File:Bayer pattern on sensor profile.svg|thumb|Profile/cross-section of sensor.]]
Most digital cameras today use a [https://en.wikipedia.org/wiki/Color_filter_array color filter array] over their sensors. To display such raw files their data needs to be [http://www.cambridgeincolour.com/tutorials/camera-sensors.htm demosaiced]. Cameras with a [https://en.wikipedia.org/wiki/Foveon_X3_sensor Foveon X3 sensor] (Sigma) do not have color filter arrays and so do not need demosaicing. Demosaicing is why opening a raw file always takes a bit longer than opening a [https://en.wikipedia.org/wiki/JPEG JPEG] or [https://en.wikipedia.org/wiki/TIFF TIFF] file, where the data is already 'display-ready'. RawTherapee offers several demosaicing algorithms, each with its own characteristics. The differences between them are often very subtle - one might need to zoom in to 200-400% to discern them - but since the program works on a pixel-by-pixel basis and demosaicing is the basis upon which all other tools work, the choice of demosaicing algorithm can have a visually significant effect when combined with other tools, such as the sharpening ones. The choice of a certain algorithm influences, among other things, the quality of very fine details in the image, whether false maze patterns will appear, and decides how well colored edges are rendered.

RawTherapee supports demosaicing images from sensors with [https://en.wikipedia.org/wiki/Bayer_filter Bayer filters] and [https://en.wikipedia.org/wiki/Bayer_filter#Fujifilm_.22X-Trans.22_filter Fujifilm X-Trans filters]. If you take a look inside the "Raw" tab, you will notice there are two tools: "Sensor with Bayer Matrix" and "Sensor with X-Trans Matrix". The settings in one of these two tools have no influence over the settings in the other - if you open a raw image from a Bayer-type sensor, only the settings from the "Sensor with Bayer Matrix" tool will be used, the settings from the "Sensor with X-Trans Matrix" tool will be ignored, and vice versa if you open a raw image from an X-Trans type sensor. For simplicity, we will describe both here.

== Method ==
The following demosaicing algorithms are available for raw files from Bayer sensors:
* AMaZE
* IGV
* LMMSE
* EAHD
* HPHD
* VNG4
* DCB
* AHD
* Fast
* Mono
* None

The following demosaicing algorithms are available for raw files from X-Trans sensors:
* 3-Pass
* 1-Pass
* Fast
* Mono
* None

<div align="center">
<gallery caption="Comparison of RawTherapee's demosaicing algorithms" perrow="10">
Image:Demosaicing city1 amaze.png|AMaZE
Image:Demosaicing city1 igv.png|IGV
Image:Demosaicing city1 lmmse.png|LMMSE
Image:Demosaicing city1 eahd.png|EAHD
Image:Demosaicing city1 hphd.png|HPHD
Image:Demosaicing city1 vng4.png|VNG4
Image:Demosaicing city1 dcb.png|DCB
Image:Demosaicing city1 ahd.png|AHD
Image:Demosaicing city1 fast.png|Fast
Image:Demosaicing city1 none.png|None
</gallery>
</div>

Which demosaicing method should you use?<br>
This page aims to tell you as much about the various algorithms as is relevant to a photographer, but there is no much to say as the explanations would quickly become technical and of a programmatical and mathematical nature. After reading though this article you should know that LMMSE and IGV are to be used on high ISO photos and that for the majority of other cases you should stick with the default AMaZE method, but of course you are free to explore for yourself and to test each method out on your own raw files. It is of no use reading an article somewhere on the internet which claims that some specific method is best because in their test that method was the sharpest, as the performance of each method depends specifically on the sensor in your camera and even on ISO, so keeping our suggestions in mind, run your own test and make up your own mind!

RawTherapee versions 4.2.91 and newer always use the demosaicing method you choose regardless of zoom level.
RawTherapee versions older than 4.2.91 use the Fast algorithm to initially open the image for editing. After this, the selected demosaicing method is applied when the image is zoomed to 100% magnification or when the detail window is opened. The selected method is also used for batch processing. It is not recommended to select the Fast method for the final conversion, as it is a low-quality algorithm for display purposes.

'''AMaZE''' (Aliasing Minimization and Zipper Elimination) is the default demosaicing method, as it yields the best results in most cases. In RawTherapee versions 2.4 and older VNG4 used to be the preferred algorithm for Olympus cameras, as AMaZE didn't exist yet and VNG4 eliminated certain maze pattern artifacts that might have been created by the other methods, but with the introduction of the AMaZE method in RawTherapee version 3.0 Olympus users might prefer that instead.

'''DCB''' produces similar results to AMaZE. AMaZE can often be slightly superior in recovering details, while DCB can be better at avoiding false colors especially in images from cameras without anti-aliasing filters.

When working with very noisy, high ISO images in conjunction with the [[Noise Reduction]] tool, it is recommended to use the '''LMMSE''' or '''IGV''' demosaicing methods. They will prevent false maze patterns from appearing, and prevent the image from looking washed-out due to heavy noise reduction.

If you use a medium format technical camera with near-symmetrical wide angle lenses such as the Schneider Digitar 28mm or 35mm it's likely that your file will contain some crosstalk, especially if the lens is shifted (due to the low angle of incoming light from these lenses some light leaks over to the next pixel on the sensor), and in this case you can get mazing artifacts with AMaZE and DCB because of green channel separation caused by the crosstalk. If you, via adapters, combine a mirrorless camera with a wide angle lens designed for film, you may also get crosstalk. It can then be better to use the more robust '''VNG4''' algorithm (Variable Number of Gradients) which handles this situation well, at the cost of some fine detail. An alternative is to enable green equilibration to even-out the green channel differences.

'''AHD''' (Adaptive Homogeneity-Directed), '''EAHD''' (Horvath's AHD) and '''HPHD''' (Heterogeneity-Projection Hard-Decision) are old methods which are generally slow and inferior to the other methods.

'''None''' means no demosaicing is performed. This can be useful for diagnostics, but you would not use it for photography.

'''Mono''' is only useful for users of either monochrome cameras, or cameras with the color filter array removed.

'''Fast''' is a very fast but simple and low quality demosaicing method, not recommended.

'''3-Pass''' is a demosaicing method for cameras with X-Trans sensors (Fuji). It runs three passes over the image which leads to sharper results though you can only see this on low ISO photos. It is slower than 1-Pass.

'''1-Pass''' is a demosaicing method for cameras with X-Trans sensors (Fuji). It is faster than the 3-Pass method though a bit inferior in quality, though this difference is only visible in low ISO shots, so if speed is an issue you can use this method on high ISO shots with no visual difference in quality.

=== False Color Suppression Steps ===
Sets the number of median filter passes applied to suppress demosaicing artifacts when applying the demosaicing algorithm. False colors (speckles) could be introduced during the demosaicing phase where very fine detail is resolved. False color suppression is similar to color smoothing. The luminance channel is not affected by this suppression.

False colors are generally more apparent in images from cameras without anti-aliasing filters. Note that it is foremost the chosen demosaicing algorithm which is the deciding factor in how prominent will be the false color problem with which you will have to deal. In some situations it may be better to change the demosaicing algorithm than to enable false color suppression, as the latter reduces color resolution.

=== How to Find the Best Demosaicing Method ===
[[image:demosaicing_city1_example_bad.jpg|thumb|A good image to test the demosaicing algorithms on. Zoomed in to 800%, you can clearly see that VNG4 is not a good choice for this Pentax K10D raw file, as there are dots where there should be none, and the detail of the wall’s brickwork (the orange part on the right) is all washed out.]]
Zoom in to at least 100% (1:1) and try all the demosaicing algorithms, see which works best for you. Try them on sharp photos with fine detail and tiny patterns, such as the wavy and repetitive fabric of a sweater (watch for maze pattern artifacts), a distant brick wall, a distant round road sign (watch for aliasing along the round edges), and test with both low and high ISO shots. Use photos from your own camera; what's best for Nikon raw images may not be what's best for Olympus ones.

=== Monochrome Cameras ===
A monochrome camera has the same light filter in front of all pixels, that is you get a black-and-white image and no demosaicing is required. Some of these cameras have no infrared filter and are thus sensitive to infrared light, which can be used for creative black and white photography.

RawTherapee supports monochrome cameras, but the user interface is not adapted for it so when you load a monochrome file all color tools will still be enabled (they won't do anything meaningful of course). You will have to live with that, monochrome cameras are rare so we won't put any major effort into making the user interface morph into reduced monochrome-only version.

There are a few additional factors to consider when working with monochrome files: some monochrome cameras report that they have only a single monochrome channel and a neutral color matrix, like Leica M Monochrom, while others report RGB channels in a bayer configuration (like Phase One IQ260 Achromatic, or IR-modified cameras). If the camera reports only one channel, RawTherapee recognizes this and won't perform any demosaicing (the demosaicer selection is still enabled but does not do anything), and everything works normally. However, if the camera reports as an RGB bayer camera, demosaicing will be performed and a color matrix will be applied. To disable this, you should select the "Mono" demosaicing option, and select "No profile" as [[Color_Management#Input_Profile|input profile]] in the Color Management panel.

How to fix crashes on startup

2016-09-18T22:19:43Z

Ingo:

The most likely reason RawTherapee might crash immediately after starting is because it loads a problematic processing profile (PP3, they store all the tweaks you make in RawTherapee, one PP3 per photo) or a problematic photo. The reason one of those could be problematic might be because it is corrupt, but it could also be that the file in itself is fine but triggers a bug in RawTherapee, or some aspect of it is unsupported, such as character encoding of the metadata, multiple layers in an image, more or less than three color channels, etc.

'''Note:''' RawTherapee only supports images with three color channels - RGB (or possibly CMY). If you try opening a directory which contains grayscale image files, or ones with four color channels (e.g. CMYK) RawTherapee will throw up an error popup window. Move these out from the startup directory elsewhere, as described below. Of course it might be a valid RGB photo or processing profile that crashes RawTherapee, but first check for non-RGB ones, as these are quite common causes of crashes.

To find the cause of the problem, we will begin with the least invasive and most informative steps, and escalate up to the most destructive steps if the informative ones do not help.

# First, have RawTherapee use a different startup folder:
## Find the "options" file as described in the [[File paths]] page.
## Open the "options" file in a text editor like [http://notepad-plus-plus.org/ Notepad++] and see what these two lines are:
##: <code>StartupDirectory=last</code>
##: <code>StartupPath=C:\\Documents and Settings\\Administrator</code>
## Make sure the first one is
##: <code>StartupDirectory=last</code>
## Create a new empty directory somewhere on your disk,
##: Windows: <code>C:\\foo</code>
##: Linux: <code>/home/bob/foo</code>
## Change the <code>StartupPath=</code> argument to the directory you just created (it must be an '''existing''' directory which does not contain any photos or PP3 files, and you have to type the whole, absolute path, no shortcuts, with double back-slashes if you use Windows) e.g.
##: Windows: <code>StartupPath=C:\\foo</code>
##: Linux: <code>StartupPath=/home/bob/foo</code>
## Now try starting RawTherapee again. If it works, then you know that one of the photos or PP3 files in the original <code>StartupPath</code> is faulty, so skip step 2 and jump straight to step 3. However, if RawTherapee still crashes right after starting, proceed to the next step.
# Delete the <code>batch</code> folder:
## Find the "batch" folder as described in the [[File paths]] page, and delete it.
## Now try starting RawTherapee again. If it works, then you know that one of the processing profiles of the photos you sent to the Queue is faulty. Finding which one would be a pain in the ass and I wouldn't bother, but if you really want to, then the next main point section "Nail it down" applies. If it doesn't work, then the problem is not a faulty photo or PP3, the problem lies elsewhere, outside the scope of this guide.
# Delete the <code>cache</code> folder:
## Find the "cache" folder as described in the [[File paths]] page.
## Move (cut) the <code>cache</code> directory elsewhere, somewhere where RawTherapee will not look. Instead of moving it you can just delete this <code>cache</code> directory, but be warned: if you set RawTherapee to only store processing profiles (PP3) in the cache, then you will lose your tweaks. You will not lose any photos. If you do not know whether you did, then you did not, because by default RT stores processing profiles alongside the raw files, not in the cache.
## Now try starting RawTherapee again. If it works, then you know that one of the processing profiles files in the cache is faulty. Finding which one would be a pain in the ass and I wouldn't bother, but if you really want to, then the next main point section "Nail it down" applies. If it doesn't work, then the problem is not a faulty photo or PP3, the problem lies elsewhere, outside the scope of this guide.
# Nail it down
#:You've established that either a processing profile or photo is to blame for the crash. It would be most helpful if you could nail the problem down to a specific file, so that we can analyze it and develop techniques for dealing with such an enemy. See the [[How_to_write_useful_bug_reports#When_RawTherapee_crashes_-_An_introduction_to_stack_backtraces|guide to stack-backtraces]]. If you can follow those instructions, a backtrace would be of great value, yet even a backtrace might not expose the problematic file, so read on. By now you should know which directory contains the faulty file(s) and you should have either set RawTherapee to start up using a different directory, or you have moved the cache out somewhere else. To make it clear, let us assume three things:
#* That the directory which contains a file that crashes RawTherapee is <code>C:\photos\bugs</code> and that your options file had <code>StartupPath=C:\\photos\\bugs</code>
#* That you changed <code>StartupPath=C:\\photos\\bugs</code> in the "options" file to the existing and empty <code>StartupPath=C:\\foo</code>
#* That there are 100 photos in the faulty directory, <code>001.raw</code> - <code>100.raw</code>
#: Let's find the faulty file:
## This is grunt work. I use raw files as examples, but in your case it might be the processing profiles, not the raw files. Or it might be JPEG files, PNG files, or any other file in the faulty dir. What we're going to do is to keep halving the pool of possibilities until we find the problem. This is the fastest way.
## If RawTherapee is running, close it.
## Move half of the files (<code>001.raw</code> - <code>050.raw</code>) from this problematic directory (<code>C:\photos\bugs</code>) back into a directory that RawTherapee reads (<code>C:\foo</code>)
## Start RawTherapee.
## If it crashed, go to the next step. If it did not crash, then go back to step 4.3, but move the other half (<code>051.raw</code> - <code>100.raw</code>).
## Move half of the files you just moved (<code>001.raw</code> - <code>025.raw</code> or <code>051.raw</code> - <code>075.raw</code>) out from <code>C:\foo</code> and back into the directory which RawTherapee doesn't read (<code>C:\photos\bugs</code>).
## Jump back to step 4.4. Repeat until you find the faulty file.

Zip this faulty file (even if it's a text PP3 file, because zipping it will prevent any website from touching it and possibly removing the cause of the crash [it could be something you can't see]), upload it to [http://filebin.net/ FileBin] and link us to it in the [http://rawtherapee.com/forum/ Forum].

IRC

2016-09-18T22:15:17Z

Ingo:

If you would like to chat with other RawTherapee users about any topic in real time, or catch one of the devs, feel welcome to join our [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC] channel:
Channel: #rawtherapee
Network: freenode
Server: chat.freenode.net

To do so, follow these steps:
# Use [http://webchat.freenode.net/?randomnick=1&channels=rawtherapee&prompt=1 webchat], or download an [http://en.wikipedia.org/wiki/Comparison_of_Internet_Relay_Chat_clients IRC client] (which is a piece of software that lets users like us talk on IRC). There are many free clients for all platforms.
#* For Windows: [http://hexchat.github.io/ HexChat], [http://quassel-irc.org/ Quassel] or [http://chatzilla.hacksrus.com/ ChatZilla] (for Firefox).
#* For Linux: [http://konversation.kde.org/ Konversation], [http://hexchat.github.io/ HexChat] or [http://www.weechat.org/ WeeChat] or [http://chatzilla.hacksrus.com/ ChatZilla] (for Firefox).
#* For Mac OS X users the same suggestions apply as for Linux users.
#* For Android: [https://play.google.com/store/apps/details?id=org.yaaic Yaaic]
#: The Opera web browser also has native IRC support.
#: Once you've installed an IRC client, take a look at its settings. You might want to change and set some things, e.g. set your nickname, enable %H:%M:%S timestamps, etc.
# Connect to a freenode server. Type <code>/server chat.freenode.net</code>
# Join the #rawtherapee channel. Type: <code>/join #rawtherapee</code>

If you come to our IRC channel and nobody is around at the moment, don't quit after two minutes, just leave your IRC client running in the background and check back in a few hours. Your question will be seen and answered if you are still online, even if you asked it a few hours ago.

Windows

2016-06-29T18:49:28Z

Ingo: /* Creating a distributable package */

This guide documents how to build RawTherapee for 32-bit or 64-bit versions of Windows using the MinGW-w64 runtime. Begin by installing and updating MSYS2 using the instructions from [https://msys2.github.io/]. Then run the following commands using either ''MinGW-w64 Win32 Shell'' or ''MinGW-w64 Win64 Shell'' depending on whether you want to build a 32-bit or a 64-bit version.

== Install tools and libraries ==

First, install a few miscellaneous tools
<pre style="white-space: pre-wrap">
$ pacman -S tar gzip nano make diffutils intltool git
</pre>

Then install the necessary development tools
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gcc mingw-w64-i686-gdb mingw-w64-i686-make mingw-w64-i686-pkg-config mingw-w64-i686-cmake
# win64
$ pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-gdb mingw-w64-x86_64-make mingw-w64-x86_64-pkg-config mingw-w64-x86_64-cmake
</pre>
and the required libraries
<pre style="white-space: pre-wrap">
# win32
$ pacman -S mingw-w64-i686-gtkmm mingw-w64-i686-gtkmm3 mingw-w64-i686-lcms2 mingw-w64-i686-fftw
# win64
$ pacman -S mingw-w64-x86_64-gtkmm mingw-w64-x86_64-gtkmm3 mingw-w64-x86_64-lcms2 mingw-w64-x86_64-fftw
</pre>

== Download and build libiptcdata ==

The libiptcdata library is not yet provided by MSYS2, therefore it should be downloaded and configured using
<pre style="white-space: pre-wrap">
$ curl -LO http://downloads.sourceforge.net/project/libiptcdata/libiptcdata/1.0.4/libiptcdata-1.0.4.tar.gz
$ tar xzf libiptcdata-1.0.4.tar.gz
$ cd libiptcdata-1.0.4

# win32
$ ./configure --prefix=/mingw32
# win64
$ ./configure --prefix=/mingw64
</pre>

Afterwards ''Makefile'' needs to be opened using a text editor to remove ''iptc'' and ''docs'' from the lists named ''SUBDIRS'' and ''DIST_SUBDIRS'' as building or installing will fail otherwise.
<pre style="white-space: pre-wrap">
$ nano Makefile

# Replace
DIST_SUBDIRS = m4 libiptcdata po iptc docs win python
# by
DIST_SUBDIRS = m4 libiptcdata po win python

# And replace
SUBDIRS = m4 libiptcdata po iptc docs win $(MAYBE_PYTHONLIB)
# by
SUBDIRS = m4 libiptcdata po win $(MAYBE_PYTHONLIB)
</pre>

Finally build and install the library
<pre style="white-space: pre-wrap">
$ make
$ make install
$ cd
</pre>

== Download and build Clearlooks ==

RawTherapee versions that use version 2 of Gtk+ need the Clearlooks theme engine which can be downloaded and built using
<pre style="white-space: pre-wrap">
$ curl -LO http://sources.archlinux.org/other/gtk-engines/gtk-engines-2.21.0.tar.gz
$ tar xzf gtk-engines-2.21.0.tar.gz
$ cd gtk-engines-2.21.0

# win32
$ ./configure --prefix=/mingw32 --disable-all --enable-clearlooks
# win64
$ ./configure --prefix=/mingw64 --disable-all --enable-clearlooks

$ make
$ make install
$ cd
</pre>

== Clone and build RawTherapee ==

First, clone RawTherapee's Git repository
<pre style="white-space: pre-wrap">
$ git clone http://github.com/Beep6581/RawTherapee.git
$ cd RawTherapee
</pre>
and optionally checkout a specific branch if you do not want to build the default ''master'', e.g.
<pre style="white-space: pre-wrap">
$ git checkout gtk3
</pre>

Then, create a separate directory for the build
<pre style="white-space: pre-wrap">
$ mkdir build
$ cd build
</pre>
and run CMake and Make
<pre style="white-space: pre-wrap">
$ cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE="debug" -DPROC_TARGET_NUMBER="2" -DBUILD_BUNDLE="ON" -DCMAKE_INSTALL_PREFIX="." -DBINDIR="." -DDATADIR="." -DCACHE_NAME_SUFFIX=4 ..
$ make -j8
$ make install
</pre>

Please refer to the [[Linux]] article for an explanation of the various options passed to CMake and Make.

If you are doing an optimized build, e.g. ''release'' or ''relwithdebinfo'', for older 32-bit versions of Windows like XP, you will need to add the ''-mstackrealign'' compiler flag, i.e.
<pre style="white-space: pre-wrap">
-DCMAKE_C_FLAGS="-mstackrealign" -DCMAKE_CXX_FLAGS="-mstackrealign"
</pre>

== Copy RawTherapee and required DLL ==

RawTherapee can now be started from the MSYS2 command line
<pre style="white-space: pre-wrap">
# for debug builds
$ cd debug
# for release builds
$ cd release
$ ./rawtherapee.exe
</pre>

The file manager can be used to copy the contents of ''<MSYS2>\home\<User>\RawTherapee\build\<debug|release>'' together with the necessary DLL from ''<MSYS2>\<mingw32|mingw64>\bin'' into a RawTherapee installation folder, where ''<MSYS2>'' is the MSYS2 installation folder and ''<User>'' the Windows user name.

A (possibly incomplete) list of required DLL is
<pre style="white-space: pre-wrap">
libatk-1.0-0.dll
libatkmm-1.6-1.dll
libbz2-1.dll
libcairo-2.dll
libcairo-gobject-2.dll
libcairomm-1.0-1.dll
libepoxy-0.dll
libexpat-1.dll
libffi-6.dll
libfftw3f-3.dll
libfontconfig-1.dll
libfreetype-6.dll
libgcc_s_dw2-1.dll|libgcc_s_seh-1.dll
libgdk-3-0.dll
libgdk-win32-2.0-0.dll
libgdkmm-2.4-1.dll
libgdkmm-3.0-1.dll
libgdk_pixbuf-2.0-0.dll
libgio-2.0-0.dll
libgiomm-2.4-1.dll
libglib-2.0-0.dll
libglibmm-2.4-1.dll
libgmodule-2.0-0.dll
libgobject-2.0-0.dll
libgomp-1.dll
libgtk-3-0.dll
libgtk-win32-2.0-0.dll
libgtkmm-2.4-1.dll
libgtkmm-3.0-1.dll
libharfbuzz-0.dll
libiconv-2.dll
libintl-8.dll
libjpeg-8.dll
liblcms2-2.dll
liblzma-5.dll
libpango-1.0-0.dll
libpangocairo-1.0-0.dll
libpangoft2-1.0-0.dll
libpangomm-1.4-1.dll
libpangowin32-1.0-0.dll
libpixman-1-0.dll
libpng16-16.dll
libsigc-2.0-0.dll
libstdc++-6.dll
libtiff-5.dll
libwinpthread-1.dll
zlib1.dll
</pre>

The following files also need to be copied
<pre style="white-space: pre-wrap">
<prefix>\bin\gspawn-<win32|win64>-helper.exe -> .
<prefix>\bin\gspawn-<win32|win64>-helper-console.exe -> .

<prefix>\lib\gtk-2.0\include -> .
<prefix>\lib\gtk-2.0\modules -> .
<prefix>\lib\gtk-2.0\2.10.0\engines -> .

<prefix>\share\glib-2.0\schemas\gschemas.compiled -> .\share\glib-2.0\schemas
</pre>
where ''<prefix>'' is ''<MSYS2>\<mingw32|mingw64>'' from above and ''.'' is the installation folder.

== Creating a distributable package ==

If you plan to distribute Rawtherapee packages for the Windows platform, as a first step you need to make sure that Rawtherapee will be built for the generic processor target. To do so, use <code>-DPROC_TARGET_NUMBER="1"</code> in the cmake command.

During compilation, a script named ''WindowsInnoSetup.iss'' is created in the Rawtherapee installation folder. This script is used by Inno Setup [http://www.jrsoftware.org/isinfo.php], a program which is used to generate installers for Windows programs. It is advised to download the Unicode version [http://www.jrsoftware.org/download.php/is-unicode.exe] to avoid problems with some languages.
The current ''WindowsInnoSetup.iss'' script is designed for the current master branch (Gtk+2). If you want to create a package from the Gtk3 branch, you will need to edit the script and replace the line

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\lib\*"; DestDir: "{app}\lib\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

with

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\share\*"; DestDir: "{app}\share\"; Flags: ignoreversion recursesubdirs createallsubdirs
</pre>

so that icons and schemas will be copied into the package.

To help users [http://50.87.144.65/~rt/w/index.php?title=How_to_write_useful_bug_reports filing useful bug reports], package maintainers are encouraged to produce Debug builds along each of their Release builds, and to bundle them with the gdb debugger executable. Windows binaries of the debugger (gdb.exe) can be downloaded from [http://www.equation.com/servlet/equation.cmd?fa=gdb here] in 32 and 64 bits versions.

The ''gdb.exe'' binary should be copied in Rawtherapee installation folder and, if using Inno Setup to generate the package, the ''WindowsInnoSetup.iss'' script should be edited by adding the following line around line 121 of the script:

<pre style="white-space: pre-wrap">
Source: "{#MyBuildBasePath}\gdb.exe"; DestDir: "{app}"; Flags: ignoreversion
</pre>

Note that GDB is a program released under GNU GPL license, its soure code can be downloaded at http://www.gnu.org/software/gdb/.

Now that everything is set up, to create the package right click on the ''WindowsInnoSetup.iss'' script and choose ''Compile'' from the context menu. It will automatically generate the installer and place it in the parent folder. To make your new package compatible with the official Rawtherapee website uploader, create a zip archive in which you'll place both the newly created installer and the corresponding ''AboutThisBuild.txt'' which should be found at the same place. Name the resulting zip archive following this template: RawTherapee_<WinXP|WinVista>_<32|64>_branch_buildtype_version.zip (for example, Rawtherapee_WinVista_64_gtk3_Release_4.2.730.zip).

Resize

2015-12-02T22:07:05Z

Ingo: /* Post-Resize Sharpening */

Resizing can be applied to the cropped area or to the whole image.

Choose your preferred resizing algorithm:
* Nearest
* Lanczos
: Lanczos results in the highest quality sampling and is therefore the recommended and default option.

Versions of RawTherapee prior to 4.2.152 also have these additional resizing algorithms, but their use is discouraged as "Lanczos" produces the best results, which is why they were removed in newer versions:
* Bilinear
* Bicubic
* Bicubic (Softer)
* Bicubic (Sharper)

You can resize according to:
* Scale
: e.g. have the resulting image 0.5 times the size of the full one,
* Width
: by specifying the desired width so that the height is automatically and proportionally scaled,
* Height
: by specifying the desired height so that the width is automatically and proportionally scaled,
* Bounding Box
: by specifying the maximum width and height you want your image to have, and leave it up to RawTherapee to figure out how to proportionally fit your image into this box.

The effects of the ''Resize'' tool will not be shown in the preview. This is a limitation of RawTherapee's current engine. Resizing is done at the end of the processing pipeline. The output image will of course be resized.

== Post-Resize Sharpening ==
[[File:Rt-4.2.235_postresizesharpening.png|frame|right|Screenshot of the Post-Resize Sharpening tool which is part of the Resize tool available from RawTherapee-4.2.235 onwards.]]
Resizing an image often leads to a loss of sharpness, so it is common practice to sharpen the image again after having resized it. With the Post-Resize Sharpening tool you can save crystal-clear images straight away with no further hassle. Because this tool works on the image after it is resized, you cannot use the preview to see what it will do, though this is not a problem because the procedure for finding the right values is straightforward.

The default values work great, but if you want to change them, here's how:
# Tweak your image as you usually would and enable resizing (e.g. downscale using the Lanczos method to a 900px bounding box),
# Save the image to a lossless format such as TIFF,
# Open that saved TIFF, apply the (Neutral) processing profile if that wasn't done automatically, and enable the Sharpening tool in the Detail tab,
# Zoom to 100% (1:1) and tweak the Sharpening tool's parameters until you get a result that satisfies you. These are the values you should use in the Post-Resize Sharpening tool.
# Go back to the raw image, enable the Post-Resize Sharpening tool and set it up with the values from the previous step.

In most cases the default values in the Post-Resize Sharpening tool work great, so give them a try before fiddling.

For technical reasons, the Post-Resize Sharpening tool is only available when you use the "Lanczos" resizing method.

Toolchain Pipeline

2014-09-03T22:33:16Z

Ingo:

This page details the order in which RawTherapee processes images. Users can learn how to better use the tools, knowing what happens when in the pipeline, and programmers can use this reference to quickly find the right place in the code to insert new tools and to find which files a given tool resides in.

https://code.google.com/p/rawtherapee/issues/detail?id=2233

List of all tools in RawTherapee:
<pre>
Generic/Main preview
Input profile
Monitor Color Profile
Working profile
Output profile
Clipping indication
Red/Green/Blue/Luminosity/Focus mask previews
Colorimetric intent
---
Exposure
Highlight Reconstruction
Shadows/Highlights
Tone Mapping
Vignette Filter
Graduated Filter
Lab Adjustments
L, a, b
LH, CH, HH, CC, LC, CL
CIECAM02
---
Sharpening
Edges
Microcontrast
Impulse Noise Reduction
Noise Reduction
Defringe
Contrast by Detail Levels
---
White Balance
Vibrance
Channel Mixer
Black-and-White
HSV Equalizer
Film Simulation
RGB Curves
Color Toning
Color Management
---
Crop
Resize
Lens/Geometry
Rotate
Perspective
Lens Correction Profile
Distortion Correction
Chromatic Aberration Correction
Vignette Correction
---
Sensor with Bayer matrix
Demosaicing
Raw Black Points
Preprocessing
Chromatic Aberration
Sensor with X-Trans matrix
Demosaicing
Raw Black Points
Raw White Points
Preprocessing
Dark Frame
Flat-Field
</pre>

----

Order of tools

Dark Frame Subtraction

Flat Field Correction [http://code.google.com/p/rawtherapee/source/browse/rtengine/rawimagesource.cc#1270 RawImageSource::processFlatField]

Read Bad Pixels from .badpixel file (bp1)

Get Hot Pixels from Darkframe (bp2)

Scale Colors (internal, no tool)

Vignetting correction from lcp (only if Flat Field correction is disabled)

Raw Hot/Dead Pixel Detection (bp3)

Interpolation of all Hot/Dead Pixels collected in bp1, bp2 and bp3

Green equilibration

Line Noise Filter [http://code.google.com/p/rawtherapee/source/browse/rtengine/cfa_linedn_RT.cc#42 RawImageSource::CLASS cfa_linedn]

Raw CA correction [http://code.google.com/p/rawtherapee/source/browse/rtengine/CA_correct_RT.cc#105 RawImageSource::CA_correct_RT]

----

For now, this is a stub to test GraphViz and LaTeX/MathML.

GraphViz test diagram 1:
<graphviz border='frame' format='png' caption='Graph for example no. 1'>
digraph example1 {Hello->World}
</graphviz>

GraphViz test diagram 2:
<graphviz renderer='neato' caption='Graph for example no. 2'>
graph example2 {
run -- intr;
intr -- runbl;
runbl -- run;
run -- kernel;
kernel -- zombie;
kernel -- sleep;
kernel -- runmem;
sleep -- swap;
swap -- runswap;
runswap -- new;
runswap -- runmem;
new -- runmem;
sleep -- runmem;
}
</graphviz>

LaTeX math test:
<math> f(x) = x^2\,</math>