# Copyright 2013 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import its.image
import its.caps
import its.device
import its.objects
import its.target
import matplotlib
import matplotlib.pyplot
import numpy
import os.path
import pylab

def main():
    """Test that the android.noiseReduction.mode param is applied when set.

    Capture images with the camera dimly lit. Uses a high analog gain to
    ensure the captured image is noisy.

    Captures three images, for NR off, "fast", and "high quality".
    Also captures an image with low gain and NR off, and uses the variance
    of this as the baseline.
    """
    NAME = os.path.basename(__file__).split(".")[0]

    RELATIVE_ERROR_TOLERANCE = 0.1

    # List of variances for Y,U,V.
    variances = [[],[],[]]

    # Reference (baseline) variance for each of Y,U,V.
    ref_variance = []

    nr_modes_reported = []

    with its.device.ItsSession() as cam:
        props = cam.get_camera_properties()
        its.caps.skip_unless(its.caps.compute_target_exposure(props) and
                             its.caps.per_frame_control(props) and
                             its.caps.noise_reduction_mode(props, 0))

        # NR mode 0 with low gain
        e, s = its.target.get_target_exposure_combos(cam)["minSensitivity"]
        req = its.objects.manual_capture_request(s, e)
        req["android.noiseReduction.mode"] = 0
        cap = cam.do_capture(req)
        its.image.write_image(
                its.image.convert_capture_to_rgb_image(cap),
                "%s_low_gain.jpg" % (NAME))
        planes = its.image.convert_capture_to_planes(cap)
        for j in range(3):
            img = planes[j]
            tile = its.image.get_image_patch(img, 0.45, 0.45, 0.1, 0.1)
            ref_variance.append(its.image.compute_image_variances(tile)[0])
        print "Ref variances:", ref_variance

        # NR modes 0, 1, 2, 3, 4 with high gain
        for mode in range(5):
            # Skip unavailable modes
            if not its.caps.noise_reduction_mode(props, mode):
                nr_modes_reported.append(mode)
                for channel in range(3):
                    variances[channel].append(0)
                continue;

            e, s = its.target.get_target_exposure_combos(cam)["maxSensitivity"]
            req = its.objects.manual_capture_request(s, e)
            req["android.noiseReduction.mode"] = mode
            cap = cam.do_capture(req)
            nr_modes_reported.append(
                    cap["metadata"]["android.noiseReduction.mode"])
            its.image.write_image(
                    its.image.convert_capture_to_rgb_image(cap),
                    "%s_high_gain_nr=%d.jpg" % (NAME, mode))
            planes = its.image.convert_capture_to_planes(cap)
            for j in range(3):
                img = planes[j]
                tile = its.image.get_image_patch(img, 0.45, 0.45, 0.1, 0.1)
                variance = its.image.compute_image_variances(tile)[0]
                variances[j].append(variance / ref_variance[j])
        print "Variances with NR mode [0,1,2,3,4]:", variances

    # Draw a plot.
    for j in range(3):
        pylab.plot(range(5), variances[j], "rgb"[j])
    matplotlib.pyplot.savefig("%s_plot_variances.png" % (NAME))

    assert(nr_modes_reported == [0,1,2,3,4])

    for j in range(3):
        # Smaller variance is better
        # Verify OFF(0) is not better than FAST(1)
        assert(variances[j][0] >
               variances[j][1] * (1.0 - RELATIVE_ERROR_TOLERANCE))
        # Verify FAST(1) is not better than HQ(2)
        assert(variances[j][1] >
               variances[j][2] * (1.0 - RELATIVE_ERROR_TOLERANCE))
        # Verify HQ(2) is better than OFF(0)
        assert(variances[j][0] > variances[j][2])
        if its.caps.noise_reduction_mode(props, 3):
            # Verify OFF(0) is not better than MINIMAL(3)
            assert(variances[j][0] >
                   variances[j][3] * (1.0 - RELATIVE_ERROR_TOLERANCE))
            # Verify MINIMAL(3) is not better than HQ(2)
            assert(variances[j][3] >
                   variances[j][2] * (1.0 - RELATIVE_ERROR_TOLERANCE))
        if its.caps.noise_reduction_mode(props, 4):
            # Verify ZSL(4) is close to OFF(0)
            assert(numpy.isclose(variances[j][4], variances[j][0],
                                 RELATIVE_ERROR_TOLERANCE))

if __name__ == '__main__':
    main()