Files @ ab7a90a03833
Branch filter:

Location: ATITD-Tools/Desert-Paint-Lab/ReactionRecorder.cs

Malkyne
README.md edited online with Bitbucket
/*
 * Copyright (c) 2015, Jason Maltzen

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
*/

using System;
using System.IO;

namespace DesertPaintLab
{
    // ReactionRecorder - business logic for recording paint reactions
    public class ReactionRecorder
    {
        const int COLOR_TOLERANCE = 3;

        const int DEFAULT_SWATCH_HEIGHT = 24; // including top and bottom borders
        const int DEFAULT_SWATCH_WIDTH = 260;
        const int DEFAULT_COLOR_BAR_WIDTH = 306;
        const int DEFAULT_RED_BAR_SPACING = 32;
        const int DEFAULT_GREEN_BAR_SPACING = 42;
        const int DEFAULT_BLUE_BAR_SPACING = 52;

        const int DEFAULT_SWATCH_TEST_WIDTH = 26; // width to test on ends of swatch (10% on either end)

        int swatchHeight = DEFAULT_SWATCH_HEIGHT;
        int swatchWidth = DEFAULT_SWATCH_WIDTH;
        int swatchTestWidth = DEFAULT_SWATCH_TEST_WIDTH;
        int colorBarWidth = DEFAULT_COLOR_BAR_WIDTH;
        int redBarSpacing = DEFAULT_RED_BAR_SPACING;
        int greenBarSpacing = DEFAULT_GREEN_BAR_SPACING;
        int blueBarSpacing = DEFAULT_BLUE_BAR_SPACING;
        int pixelMultiplier = 1;

        private static ReactionRecorder _instance;
        public static ReactionRecorder Instance
        {
            get {
                if (_instance == null)
                {
                    _instance = new ReactionRecorder();
                }
                return _instance;
            }
        }

        private StreamWriter _log;
        public StreamWriter Log
        {
            set
            {
                _log = value;
            }
        }
        private void WriteLog(string format, params object[] args)
        {
            if (_log != null)
            {
                _log.WriteLine(format, args);
            }
        }

        public ReactionRecorder()
        {
            this.pixelMultiplier = 1;
            swatchHeight = DEFAULT_SWATCH_HEIGHT * pixelMultiplier;
            swatchWidth = DEFAULT_SWATCH_WIDTH * pixelMultiplier;
            colorBarWidth = DEFAULT_COLOR_BAR_WIDTH * pixelMultiplier;
            redBarSpacing = DEFAULT_RED_BAR_SPACING * pixelMultiplier;
            greenBarSpacing = DEFAULT_GREEN_BAR_SPACING * pixelMultiplier;
            blueBarSpacing = DEFAULT_BLUE_BAR_SPACING * pixelMultiplier;
            swatchTestWidth = DEFAULT_SWATCH_TEST_WIDTH * pixelMultiplier;
        }

        public ReactionRecorder(int pixelMultiplier)
        {
            this.pixelMultiplier = pixelMultiplier;
            swatchHeight = DEFAULT_SWATCH_HEIGHT * pixelMultiplier;
            swatchWidth = DEFAULT_SWATCH_WIDTH * pixelMultiplier;
            colorBarWidth = DEFAULT_COLOR_BAR_WIDTH * pixelMultiplier;
            redBarSpacing = DEFAULT_RED_BAR_SPACING * pixelMultiplier;
            greenBarSpacing = DEFAULT_GREEN_BAR_SPACING * pixelMultiplier;
            blueBarSpacing = DEFAULT_BLUE_BAR_SPACING * pixelMultiplier;
            swatchTestWidth = DEFAULT_SWATCH_TEST_WIDTH * pixelMultiplier;
        }

        private static bool IsPapyTexture(byte r, byte g, byte b)
        {
            // red between 208 and 244
            // green between 192 and 237
            // blue between 145 and 205
            return ((r > 0xD0) && (g >= 0xC0) && (b >= 0x91)) &&
                   ((r < 0xF4) && (g <= 0xED) && (b <= 0xCD));
        }

        public void SetPixelMultiplier(int pixelMultiplier)
        {
            swatchHeight    = DEFAULT_SWATCH_HEIGHT * pixelMultiplier;
            swatchWidth     = DEFAULT_SWATCH_WIDTH * pixelMultiplier;
            colorBarWidth   = DEFAULT_COLOR_BAR_WIDTH * pixelMultiplier;
            redBarSpacing   = DEFAULT_RED_BAR_SPACING * pixelMultiplier;
            greenBarSpacing = DEFAULT_GREEN_BAR_SPACING * pixelMultiplier;
            blueBarSpacing  = DEFAULT_BLUE_BAR_SPACING * pixelMultiplier;
            swatchTestWidth = DEFAULT_SWATCH_TEST_WIDTH * pixelMultiplier;
            this.pixelMultiplier = pixelMultiplier;
        }

        unsafe private void ColorAt(byte *pixBytes, int x, int y, int stride, out byte r, out byte g, out byte b)
        {
            int pixelStart = (y * stride) + (x * 3);
                    r = pixBytes[pixelStart];
                    g = pixBytes[pixelStart + 1];
                    b = pixBytes[pixelStart + 2];
        }

        private bool IsDarkPixel(int r, int g, int b)
        {
            return ((r < 0x46) && (g < 0x46) && (b < 0x47));
        }

        private bool IsColorMatch(byte test_r, byte test_g, byte test_b, byte target_r, byte target_g, byte target_b)
        {
            return ((Math.Abs(test_r - target_r) <= COLOR_TOLERANCE) &&
                (Math.Abs(test_g - target_g) <= COLOR_TOLERANCE) &&
                (Math.Abs(test_b - target_b) <= COLOR_TOLERANCE));
        }

        unsafe private bool IsPossibleSwatchSlice(byte* pixBytes, int x, int y, int stride)
        {
            int testPixelStart = (y * stride) + (x * 3);
            byte r = pixBytes[testPixelStart];
            byte g = pixBytes[testPixelStart+1];
            byte b = pixBytes[testPixelStart+2];

            bool isDarkPixel = false;
            //bool isPapyAbove = false;
            //bool isPapyBelow = false;

            // 1.) Check if the top pixel is a dark pixel.
            isDarkPixel = IsDarkPixel(r, g, b); // ((r < 0x46) && (g < 0x46) && (b < 0x46));
            
            //// 2.) Check the pixel above it to see if it's from the papy texture.
            //int otherPixelStart = testPixelStart - stride;
            //isPapyAbove = ((otherPixelStart >= 0) &&
            //    IsPapyTexture(pixBytes[otherPixelStart++], pixBytes[otherPixelStart++], pixBytes[otherPixelStart]));

            //// 3.) Check the pixel below where the swatch should be to see if it's also from the papy texture.
            //otherPixelStart = testPixelStart + (stride * swatchHeight);
            //isPapyBelow = (IsPapyTexture(pixBytes[otherPixelStart++], pixBytes[otherPixelStart++], pixBytes[otherPixelStart]));

            //bool result = isDarkPixel && isPapyAbove && isPapyBelow;
            bool result = isDarkPixel;

            // grab the swatch color
            int swatchColorStart = testPixelStart + (2 * pixelMultiplier * stride); // 2 rows below the test pixel, skipping the faded color
            r = pixBytes[swatchColorStart];
            g = pixBytes[swatchColorStart+1];
            b = pixBytes[swatchColorStart+2];

            // scan the column from 2 below the top to 2 above the bottom to ensure the color matches
            for (int i = (2*pixelMultiplier); result && (i < swatchHeight-(2*pixelMultiplier)); ++i)
            {
                int otherPixelStart = testPixelStart + (stride * i);
                result &= IsColorMatch(pixBytes[otherPixelStart], pixBytes[otherPixelStart+1], pixBytes[otherPixelStart+2], r, g, b);
            }

            if (!result)
            {
                WriteLog("Swatch slice at {0}, {1} failed to match", x, y);
            }

            return result;
        }

        unsafe private bool IsPossibleSwatchUpperLeft(byte* pixBytes, int x, int y, int stride)
        {
            int testPixelStart = (y * stride) + (x * 3);

            bool result = true;
            // test the left edge for dark pixels
            int i = 0;
            for (i = 0; result && (i < swatchHeight-pixelMultiplier); ++i)
            {
                int otherPixelStart = testPixelStart + (stride * i);
                result &= IsDarkPixel(pixBytes[otherPixelStart], pixBytes[otherPixelStart+1], pixBytes[otherPixelStart+2]);
            }

            // test the dark top border and for papyrus above and below the swatch
            int papyErrorCount = 0;
            for (i = 0; result && (i < swatchWidth); ++i)
            {
                int otherPixelStart = testPixelStart + (3 * i);
                result &= IsDarkPixel(pixBytes[otherPixelStart], pixBytes[otherPixelStart+1], pixBytes[otherPixelStart+2]);
                otherPixelStart = otherPixelStart - stride;
                papyErrorCount += (IsPapyTexture(pixBytes[otherPixelStart], pixBytes[otherPixelStart+1], pixBytes[otherPixelStart+2]) ? 0 : 1);
                otherPixelStart = testPixelStart + (stride * swatchHeight) + (3 * i);
                papyErrorCount += (IsPapyTexture(pixBytes[otherPixelStart], pixBytes[otherPixelStart+1], pixBytes[otherPixelStart+2]) ? 0 : 1);
            }

            result &= (papyErrorCount < (swatchWidth / 20)); // allow up to 5% error rate checking for papy texture, because this seems to be inconsistent
            if (!result && ((i > (swatchWidth*0.8)) || (papyErrorCount >= (swatchWidth/20))))
            {
                WriteLog("Found a potential swatch candidate of width {0} at {1},{2} that had {3} failures matching papyrus texture", i, x, y, papyErrorCount);
            }

            return result;
        }

        unsafe public bool CaptureReaction(byte* pixBytes, int screenshotWidth, int screenshotHeight, int stride, ref PaintColor reactedColor, ref int redPixelStart)
        {
            byte pixel_r, pixel_g, pixel_b;
            int pixelStart, otherPixelStart;
            bool colorMatch = true;
            for (int x = 0; x < screenshotWidth - colorBarWidth; ++x)
            {
                for (int y = 0; y < (screenshotHeight - (blueBarSpacing + 1)  /*53*/); ++y)
                {
                    // Look for the color swatch.
                    pixelStart = (y * stride) + (x * 3);
                    pixel_r = pixBytes[pixelStart];
                    pixel_g = pixBytes[pixelStart + 1];
                    pixel_b = pixBytes[pixelStart + 2];
                    
                    bool foundSwatch = IsPossibleSwatchUpperLeft(pixBytes, x, y, stride); // ((pixel_r < 0x46) && (pixel_g < 0x46) && (pixel_b < 0x46));
                    if (foundSwatch)
                    {
                        int borderXOffset = 0;
                        for (borderXOffset = (2 * pixelMultiplier); foundSwatch && (borderXOffset < swatchTestWidth); ++borderXOffset)
                        {
                            foundSwatch &= IsPossibleSwatchSlice(pixBytes, x + borderXOffset, y, stride);
                            foundSwatch &= IsPossibleSwatchSlice(pixBytes, x + swatchWidth - borderXOffset, y, stride);
                        }
                    }

                    if (foundSwatch)
                    {
                        // found a swatch with an appropriate dark top border with papyrus texture above it and papyrus a jump below it
                        // 4.) Scan the left border of the potential swatch
                        // location.
                        colorMatch = true;
                        for (int i = 2; i < swatchHeight - (2 * pixelMultiplier); ++i)
                        {
                            otherPixelStart = pixelStart + (stride * i);
                            if (!IsColorMatch(pixel_r, pixel_g, pixel_b, pixBytes[otherPixelStart], pixBytes[otherPixelStart+1], pixBytes[otherPixelStart+2]))
                            {
                                colorMatch = false;
                                break;
                            }
                        }
                        
                        if (colorMatch)
                        {
                            // WE FOUND THE SWATCH!
                            // Now we know where the color bars are.
                            redPixelStart = pixelStart + (redBarSpacing * stride);
                            int redPixelCount = 0;
                            while ((pixBytes[redPixelStart] > 0x9F) &&
                                   (pixBytes[redPixelStart + 1] < 0x62) &&
                                   (pixBytes[redPixelStart + 2]  < 0x62))
                            {
                                redPixelCount++;
                                // pixBytes[redPixelStart] = 0x00;
                                // pixBytes[redPixelStart + 1] = 0xFF;
                                // pixBytes[redPixelStart + 2] = 0xFF;
                                redPixelStart += 3;
                            }
                                
                            reactedColor.Red = (byte)Math.Round((float)redPixelCount * 255f / (float)colorBarWidth);
                            int greenPixelStart = pixelStart + (greenBarSpacing * stride);
                            
                            int greenPixelCount = 0;
                            while ((pixBytes[greenPixelStart] < 0x62) &&
                                   (pixBytes[greenPixelStart + 1] > 0x9F) &&
                                   (pixBytes[greenPixelStart + 2] < 0x62))
                            {
                                greenPixelCount++;
                                // pixBytes[greenPixelStart] = 0x00;
                                // pixBytes[greenPixelStart + 1] = 0xFF;
                                // pixBytes[greenPixelStart + 2] = 0xFF;
                                greenPixelStart += 3;
                            }

                            reactedColor.Green = (byte)Math.Round((float)greenPixelCount * 255f / (float)colorBarWidth);
                            int bluePixelStart = pixelStart + (blueBarSpacing * stride);
                            
                            int bluePixelCount = 0;
                            while ((pixBytes[bluePixelStart] < 0x62) &&
                                (pixBytes[bluePixelStart + 1] < 0x62) &&
                                (pixBytes[bluePixelStart + 2] > 0x9F))
                            {
                                bluePixelCount++;
                                // pixBytes[bluePixelStart] = 0x00;
                                // pixBytes[bluePixelStart + 1] = 0xFF;
                                // pixBytes[bluePixelStart + 2] = 0xFF;
                                bluePixelStart += 3;
                            }

                            reactedColor.Blue = (byte)Math.Round((float)bluePixelCount * 255f / (float)colorBarWidth);
                            WriteLog("Found the color swatch at {0}, {1}. Color={2}", x, y, reactedColor);
                            return true;
                        }
                    }
                }
            }
            return false;
        }

        public bool RecordReaction(PlayerProfile profile, PaintColor expectedColor, PaintColor reactedColor, Reagent[] reagents)
        {
            bool saved = false;
            int r, g, b;
            if (reagents[2] != null)
            {
                // A 3-reagent reaction.
                Reaction reaction1 = profile.FindReaction(reagents[0], reagents[1]);
                Reaction reaction2 = profile.FindReaction(reagents[0], reagents[2]);
                Reaction reaction3 = profile.FindReaction(reagents[1], reagents[2]);
                
                r = reactedColor.Red - expectedColor.Red;
                g = reactedColor.Green - expectedColor.Green;
                b = reactedColor.Blue - expectedColor.Blue;
                
                if (reaction2 == null)
                {
                    r = r - reaction1.Red - reaction3.Red;
                    g = g - reaction1.Green - reaction3.Green;
                    b = b - reaction1.Blue - reaction3.Blue;
                    profile.SetReaction(reagents[0], reagents[2], new Reaction(r, g, b));
                    profile.Save();
                    saved = true;
                }
                else if (reaction3 == null)
                {
                    r = r - reaction1.Red - reaction2.Red;
                    g = g - reaction1.Green - reaction2.Green;
                    b = b - reaction1.Blue - reaction2.Blue;
                    profile.SetReaction(reagents[1], reagents[2], new Reaction(r, g, b));
                    profile.Save();
                    saved = true;
                }   
            }
            else if ((reagents[0] != null) && (reagents[1] != null))
            {
                // A 2-reagent reaction.
                r = reactedColor.Red - expectedColor.Red;
                g = reactedColor.Green - expectedColor.Green;
                b = reactedColor.Blue - expectedColor.Blue;
                profile.SetReaction(reagents[0], reagents[1], new Reaction(r, g, b));
                profile.Save();
                saved = true;
            }
            return saved;
        }
    }
}