/src/Data/Document.cs

Large files files are truncated, but you can click here to view the full file

/////////////////////////////////////////////////////////////////////////////////

// Paint.NET                                                                   //

// Copyright (C) dotPDN LLC, Rick Brewster, Tom Jackson, and contributors.     //

// Portions Copyright (C) Microsoft Corporation. All Rights Reserved.          //

// See src/Resources/Files/License.txt for full licensing and attribution      //

// details.                                                                    //

// .                                                                           //

/////////////////////////////////////////////////////////////////////////////////



using PaintDotNet.SystemLayer;

using System;

using System.Collections;

using System.Collections.Specialized;

using System.ComponentModel;

using System.Drawing;

using System.Drawing.Drawing2D;

using System.Drawing.Imaging;

using System.Globalization;

using System.IO;

using System.IO.Compression;

using System.Reflection;

using System.Runtime.Remoting.Messaging;

using System.Runtime.Serialization;

using System.Runtime.Serialization.Formatters.Binary;

using System.Text;

using System.Threading;

using System.Windows.Forms;

using System.Xml;



namespace PaintDotNet

{

    [Serializable]

    public sealed class Document

        : IDeserializationCallback,

          IDisposable,

          ICloneable

    {

        private LayerList layers;

        private int width;

        private int height;

        private NameValueCollection userMetaData;



        [NonSerialized]

        private PaintDotNet.Threading.ThreadPool threadPool = new PaintDotNet.Threading.ThreadPool();



        [NonSerialized]

        private InvalidateEventHandler layerInvalidatedDelegate;



        // TODO: the document class should not manage its own update region, its owner should

        [NonSerialized]

        private Vector<Rectangle> updateRegion;



        [NonSerialized]

        private bool dirty;



        private Version savedWith;



        [NonSerialized]

        private Metadata metadata = null;



        [NonSerialized]

        private XmlDocument headerXml;



        private const string headerXmlSkeleton = "<pdnImage><custom></custom></pdnImage>";



        private XmlDocument HeaderXml

        {

            get

            {

                if (this.disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                if (this.headerXml == null)

                {

                    this.headerXml = new XmlDocument();

                    this.headerXml.LoadXml(headerXmlSkeleton);

                }



                return this.headerXml;

            }

        }



        public string Header

        {

            get

            {

                if (this.disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                return this.HeaderXml.OuterXml;

            }

        }



        public string CustomHeaders

        {

            get

            {

                if (this.disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                return this.HeaderXml.SelectSingleNode("/pdnImage/custom").InnerXml;

            }



            set

            {

                if (this.disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                this.HeaderXml.SelectSingleNode("/pdnImage/custom").InnerXml = value;

                Dirty = true;

            }

        }



        /// <summary>

        /// Gets or sets the units that are used for measuring the document's physical (printed) size.

        /// </summary>

        /// <remarks>

        /// If this property is set to MeasurementUnit.Pixel, then Dpu will be reset to 1. 

        /// If this property has not been set in the image's metadata, its default value 

        /// will be MeasurementUnit.Inch.

        /// If the EXIF data for the image is invalid (such as "ResolutionUnit = 0" or something),

        /// then the default DpuUnit will be returned.

        /// </remarks>

        public MeasurementUnit DpuUnit

        {

            get

            {

                PropertyItem[] pis = this.Metadata.GetExifValues(ExifTagID.ResolutionUnit);



                if (pis.Length == 0)

                {

                    this.DpuUnit = DefaultDpuUnit;

                    return DefaultDpuUnit;

                }

                else

                {

                    try

                    {

                        ushort unit = Exif.DecodeShortValue(pis[0]);



                        // Guard against bad data in the EXIF store

                        switch ((MeasurementUnit)unit)

                        {

                            case MeasurementUnit.Centimeter:

                            case MeasurementUnit.Inch:

                            case MeasurementUnit.Pixel:

                                return (MeasurementUnit)unit;



                            default:

                                this.Metadata.RemoveExifValues(ExifTagID.ResolutionUnit);

                                return this.DpuUnit; // recursive call

                        }

                    }



                    catch (Exception)

                    {

                        this.Metadata.RemoveExifValues(ExifTagID.ResolutionUnit);

                        return this.DpuUnit; // recursive call

                    }

                }

            }



            set

            {

                PropertyItem pi = Exif.CreateShort(ExifTagID.ResolutionUnit, (ushort)value);

                this.Metadata.ReplaceExifValues(ExifTagID.ResolutionUnit, new PropertyItem[1] { pi });



                if (value == MeasurementUnit.Pixel)

                {

                    this.DpuX = 1.0;

                    this.DpuY = 1.0;

                }



                Dirty = true;

            }

        }



        public static MeasurementUnit DefaultDpuUnit

        {

            get

            {

                return MeasurementUnit.Inch;

            }

        }



#if false

        [Obsolete("Use DefaultDpuUnit property instead.")]

        public static MeasurementUnit GetDefaultDpuUnit()

        {

            return DefaultDpuUnit;

        }

#endif



        private const double defaultDpi = 96.0;



        public static double DefaultDpi

        {

            get

            {

                return defaultDpi;

            }

        }



        public const double CmPerInch = 2.54;

        private const double defaultDpcm = defaultDpi / CmPerInch;



        public static double DefaultDpcm

        {

            get

            {

                return defaultDpcm;

            }

        }



        public const double MinimumDpu = 0.01;

        public const double MaximumDpu = 32767.0;



        public static double InchesToCentimeters(double inches)

        {

            return inches * CmPerInch;

        }



        public static double CentimetersToInches(double centimeters)

        {

            return centimeters / CmPerInch;

        }



        public static double DotsPerInchToDotsPerCm(double dpi)

        {

            return dpi / CmPerInch;

        }



        public static double DotsPerCmToDotsPerInch(double dpcm)

        {

            return dpcm * CmPerInch;

        }



        public static double GetDefaultDpu(MeasurementUnit units)

        {

            double dpu;



            switch (units)

            {

                case MeasurementUnit.Inch:

                    dpu = defaultDpi;

                    break;



                case MeasurementUnit.Centimeter:

                    dpu = defaultDpcm;

                    break;



                case MeasurementUnit.Pixel:

                    dpu = 1.0;

                    break;



                default:

                    throw new InvalidEnumArgumentException("DpuUnit", (int)units, typeof(MeasurementUnit));

            }



            return dpu;

        }



        /// <summary>

        /// Ensures that the document's DpuX, DpuY, and DpuUnits properties are set.

        /// If they are not already set, they are initialized to their default values (96, 96 , inches).

        /// </summary>

        private void InitializeDpu()

        {

            this.DpuUnit = this.DpuUnit;

            this.DpuX = this.DpuX;

            this.DpuY = this.DpuY;

        }



        private byte[] GetDoubleAsRationalExifData(double value)

        {

            uint numerator;

            uint denominator;



            if (Math.IEEERemainder(value, 1.0) == 0)

            {

                numerator = (uint)value;

                denominator = 1;

            }

            else

            {

                double s = value * 1000.0;

                numerator = (uint)Math.Floor(s);

                denominator = 1000;

            }

            

            return Exif.EncodeRationalValue(numerator, denominator);

        }



        /// <summary>

        /// Gets or sets the Document's dots-per-unit scale in the X direction.

        /// </summary>

        /// <remarks>

        /// If DpuUnit is equal to MeasurementUnit.Pixel, then this property may not be set

        /// to any value other than 1.0. Setting DpuUnit to MeasurementUnit.Pixel will reset

        /// this property to 1.0. This property may only be set to a value greater than 0.

        /// One dot is always equal to one pixel. This property will not return a value less

        /// than MinimumDpu, nor a value larger than MaximumDpu.

        /// </remarks>

        public double DpuX

        {

            get

            {

                PropertyItem[] pis = this.Metadata.GetExifValues(ExifTagID.XResolution);



                if (pis.Length == 0)

                {

                    double defaultDpu = GetDefaultDpu(this.DpuUnit);

                    this.DpuX = defaultDpu;

                    return defaultDpu;

                }

                else

                {

                    try

                    {

                        uint numerator;

                        uint denominator;



                        Exif.DecodeRationalValue(pis[0], out numerator, out denominator);



                        if (denominator == 0)

                        {

                            throw new DivideByZeroException(); // will be caught by the below catch{}

                        }

                        else

                        {

                            return Math.Min(MaximumDpu, Math.Max(MinimumDpu, (double)numerator / (double)denominator));

                        }

                    }



                    catch

                    {

                        this.Metadata.RemoveExifValues(ExifTagID.XResolution);

                        return this.DpuX; // recursive call;

                    }

                }

            }



            set

            {

                if (value <= 0.0)

                {

                    throw new ArgumentOutOfRangeException("value", value, "must be > 0.0");

                }



                if (this.DpuUnit == MeasurementUnit.Pixel && value != 1.0)

                {

                    throw new ArgumentOutOfRangeException("value", value, "if DpuUnit == Pixel, then value must equal 1.0");

                }



                byte[] data = GetDoubleAsRationalExifData(value);

               

                PropertyItem pi = Exif.CreatePropertyItem(ExifTagID.XResolution, ExifTagType.Rational, data);

                this.Metadata.ReplaceExifValues(ExifTagID.XResolution, new PropertyItem[1] { pi });

                Dirty = true;

            }

        }



        /// <summary>

        /// Gets or sets the Document's dots-per-unit scale in the Y direction.

        /// </summary>

        /// <remarks>

        /// If DpuUnit is equal to MeasurementUnit.Pixel, then this property may not be set

        /// to any value other than 1.0. Setting DpuUnit to MeasurementUnit.Pixel will reset

        /// this property to 1.0. This property may only be set to a value greater than 0.

        /// One dot is always equal to one pixel. This property will not return a value less

        /// than MinimumDpu, nor a value larger than MaximumDpu.

        /// </remarks>

        public double DpuY

        {

            get

            {

                PropertyItem[] pis = this.Metadata.GetExifValues(ExifTagID.YResolution);



                if (pis.Length == 0)

                {

                    // If there's no DpuY setting, default to the DpuX setting

                    double dpu = this.DpuX;

                    this.DpuY = dpu;

                    return dpu;

                }

                else

                {

                    try

                    {

                        uint numerator;

                        uint denominator;



                        Exif.DecodeRationalValue(pis[0], out numerator, out denominator);



                        if (denominator == 0)

                        {

                            throw new DivideByZeroException(); // will be caught by the below catch{}

                        }

                        else

                        {

                            return Math.Min(MaximumDpu, Math.Max(MinimumDpu, (double)numerator / (double)denominator));

                        }

                    }



                    catch

                    {

                        this.Metadata.RemoveExifValues(ExifTagID.YResolution);

                        return this.DpuY; // recursive call;

                    }

                }

            }



            set

            {

                if (value <= 0.0)

                {

                    throw new ArgumentOutOfRangeException("value", value, "must be > 0.0");

                }



                if (this.DpuUnit == MeasurementUnit.Pixel && value != 1.0)

                {

                    throw new ArgumentOutOfRangeException("value", value, "if DpuUnit == Pixel, then value must equal 1.0");

                }



                byte[] data = GetDoubleAsRationalExifData(value);

               

                PropertyItem pi = Exif.CreatePropertyItem(ExifTagID.YResolution, ExifTagType.Rational, data);

                this.Metadata.ReplaceExifValues(ExifTagID.YResolution, new PropertyItem[1] { pi });

                Dirty = true;

            }

        }



        /// <summary>

        /// Gets the Document's measured physical width based on the DpuUnit and DpuX properties.

        /// </summary>

        public double PhysicalWidth

        {

            get

            {

                return (double)this.Width / (double)this.DpuX;

            }

        }



        /// <summary>

        /// Gets the Document's measured physical height based on the DpuUnit and DpuY properties.

        /// </summary>

        public double PhysicalHeight

        {

            get

            {

                return (double)this.Height / (double)this.DpuY;

            }

        }



        // 

        //   Conversion Matrix:

        //

        // GetPhysical[X|Y](x, unit), where dpu = this.dpuX or dpuY

        //

        //            dpu |  px  |  in  |  cm        |

        //        unit    |      |      |            |

        //   -------------+------+------+------------+

        //        px      |  x   |  x   |      x     |

        //   -------------+------+------+------------+

        //        in      | x /  | x /  | x /        | 

        //                |  96  | dpuX | (dpuX*2.54)| 

        //   -------------+------+------+------------+

        //        cm      | x /  |x*2.54| x / dpuX   |

        //                |  37.8| /dpuX|            |

        //   -------------+------+------+------------+



        public static double PixelToPhysical(double pixel, MeasurementUnit resultUnit, MeasurementUnit dpuUnit, double dpu)

        {

            double result;



            if (resultUnit == MeasurementUnit.Pixel)

            {

                result = pixel;

            }

            else

            {

                if (resultUnit == dpuUnit)

                {

                    result = pixel / dpu;

                }

                else if (dpuUnit == MeasurementUnit.Pixel)

                {

                    double defaultDpu = GetDefaultDpu(dpuUnit);

                    result = pixel / defaultDpu;

                }

                else if (dpuUnit == MeasurementUnit.Centimeter && resultUnit == MeasurementUnit.Inch)

                {

                    result = pixel / (CmPerInch * dpu);

                }

                else // if (dpuUnit == MeasurementUnit.Inch && resultUnit == MeasurementUnit.Centimeter)

                {

                    result = (pixel * CmPerInch) / dpu;

                }

            }



            return result;

        }



        public double PixelToPhysicalX(double pixel, MeasurementUnit resultUnit)

        {

            double result;



            if (resultUnit == MeasurementUnit.Pixel)

            {

                result = pixel;

            }

            else 

            {

                MeasurementUnit dpuUnit = this.DpuUnit;



                if (resultUnit == dpuUnit)

                {

                    result = pixel / this.DpuX;

                }

                else if (dpuUnit == MeasurementUnit.Pixel)

                {

                    double defaultDpuX = GetDefaultDpu(dpuUnit);

                    result = pixel / defaultDpuX;

                }

                else if (dpuUnit == MeasurementUnit.Centimeter && resultUnit == MeasurementUnit.Inch)

                {

                    result = pixel / (CmPerInch * this.DpuX);

                }

                else //if (dpuUnit == MeasurementUnit.Inch && resultUnit == MeasurementUnit.Centimeter)

                {

                    result = (pixel * CmPerInch) / this.DpuX;

                }

            }



            return result;

        }



        public double PixelToPhysicalY(double pixel, MeasurementUnit resultUnit)

        {

            double result;



            if (resultUnit == MeasurementUnit.Pixel)

            {

                result = pixel;

            }

            else 

            {

                MeasurementUnit dpuUnit = this.DpuUnit;



                if (resultUnit == dpuUnit)

                {

                    result = pixel / this.DpuY;

                }

                else if (dpuUnit == MeasurementUnit.Pixel)

                {

                    double defaultDpuY = GetDefaultDpu(dpuUnit);

                    result = pixel / defaultDpuY;

                }

                else if (dpuUnit == MeasurementUnit.Centimeter && resultUnit == MeasurementUnit.Inch)

                {

                    result = pixel / (CmPerInch * this.DpuY);

                }

                else //if (dpuUnit == MeasurementUnit.Inch && resultUnit == MeasurementUnit.Centimeter)

                {

                    result = (pixel * CmPerInch) / this.DpuY;

                }

            }



            return result;

        }



        private static bool IsValidMeasurementUnit(MeasurementUnit unit)

        {

            switch (unit)

            {

                case MeasurementUnit.Pixel:

                case MeasurementUnit.Centimeter:

                case MeasurementUnit.Inch:

                    return true;



                default:

                    return false;

            }

        }



        public static double ConvertMeasurement(

            double sourceLength, 

            MeasurementUnit sourceUnits, 

            MeasurementUnit basisDpuUnits, 

            double basisDpu, 

            MeasurementUnit resultDpuUnits)

        {

            // Validation

            if (!IsValidMeasurementUnit(sourceUnits))

            {

                throw new InvalidEnumArgumentException("sourceUnits", (int)sourceUnits, typeof(MeasurementUnit));

            }



            if (!IsValidMeasurementUnit(basisDpuUnits))

            {

                throw new InvalidEnumArgumentException("basisDpuUnits", (int)basisDpuUnits, typeof(MeasurementUnit));

            }



            if (!IsValidMeasurementUnit(resultDpuUnits))

            {

                throw new InvalidEnumArgumentException("resultDpuUnits", (int)resultDpuUnits, typeof(MeasurementUnit));

            }



            if (basisDpuUnits == MeasurementUnit.Pixel && basisDpu != 1.0)

            {

                throw new ArgumentOutOfRangeException("basisDpuUnits, basisDpu", "if basisDpuUnits is Pixel, then basisDpu must equal 1.0");

            }



            // Case 1. No conversion is necessary if they want the same units out.

            if (sourceUnits == resultDpuUnits)

            {

                return sourceLength;

            }



            // Case 2. Simple inches -> centimeters

            if (sourceUnits == MeasurementUnit.Inch && resultDpuUnits == MeasurementUnit.Centimeter)

            {

                return InchesToCentimeters(sourceLength);

            }



            // Case 3. Simple centimeters -> inches.

            if (sourceUnits == MeasurementUnit.Centimeter && resultDpuUnits == MeasurementUnit.Inch)

            {

                return CentimetersToInches(sourceLength);

            }



            // At this point we know we are converting from non-pixels to pixels, or from pixels

            // to non-pixels. 

            // Cases 4 through 8 cover conversion from non-pixels to pixels. 

            // Cases 9 through 11 cover conversion from pixels to non-pixels.



            // Case 4. Conversion from pixels to inches/centimeters when basis is in pixels too. 

            // This means we must use the default DPU for the desired result measurement.

            // No need to compare lengthUnits != resultDpuUnits, since we already know this to 

            // be true from case 1.

            if (sourceUnits == MeasurementUnit.Pixel && basisDpuUnits == MeasurementUnit.Pixel)

            {

                double dpu = GetDefaultDpu(resultDpuUnits);

                double lengthInOrCm = sourceLength / dpu;

                return lengthInOrCm;

            }



            // Case 5. Conversion from inches/centimeters to pixels when basis is in pixels too.

            // This means we must use the default DPU for the given input measurement.

            if (sourceUnits != MeasurementUnit.Pixel && basisDpuUnits == MeasurementUnit.Pixel)

            {

                double dpu = GetDefaultDpu(sourceUnits);

                double resultPx = sourceLength * dpu;

                return resultPx;

            }



            // Case 6. Conversion from inches/centimeters to pixels, when basis is in same units as input.

            if (sourceUnits == basisDpuUnits && resultDpuUnits == MeasurementUnit.Pixel)

            {

                double resultPx = sourceLength * basisDpu;

                return resultPx;

            }



            // Case 7. Conversion from inches to pixels, when basis is in centimeters.

            if (sourceUnits == MeasurementUnit.Inch && basisDpuUnits == MeasurementUnit.Centimeter)

            {

                double dpi = DotsPerCmToDotsPerInch(basisDpu);

                double resultPx = sourceLength * dpi;

                return resultPx;

            }



            // Case 8. Conversion from centimeters to pixels, when basis is in inches.

            if (sourceUnits == MeasurementUnit.Centimeter && basisDpuUnits == MeasurementUnit.Inch)

            {

                double dpcm = DotsPerInchToDotsPerCm(basisDpu);

                double resultPx = sourceLength * dpcm;

                return resultPx;

            }



            // Case 9. Converting from pixels to inches/centimeters, when the basis and result

            // units are the same.

            if (basisDpuUnits == resultDpuUnits)

            {

                double resultInOrCm = sourceLength / basisDpu;

                return resultInOrCm;

            }

            

            // Case 10. Converting from pixels to centimeters, when the basis is in inches.

            if (resultDpuUnits == MeasurementUnit.Centimeter && basisDpuUnits == MeasurementUnit.Inch)

            {

                double dpcm = DotsPerInchToDotsPerCm(basisDpu);

                double resultCm = sourceLength / dpcm;

                return resultCm;

            }



            // Case 11. Converting from pixels to inches, when the basis is in centimeters.

            if (resultDpuUnits == MeasurementUnit.Inch && basisDpuUnits == MeasurementUnit.Centimeter)

            {

                double dpi = DotsPerCmToDotsPerInch(basisDpu);

                double resultIn = sourceLength / dpi;

                return resultIn;

            }



            // Should not be possible to get here, but must appease the compiler.

            throw new InvalidOperationException();

        }



        public double PixelAreaToPhysicalArea(double area, MeasurementUnit resultUnit)

        {

            double xScale = PixelToPhysicalX(1.0, resultUnit);

            double yScale = PixelToPhysicalY(1.0, resultUnit);



            return area * xScale * yScale;

        }



        private static string GetUnitsAbbreviation(MeasurementUnit units)

        {

            string result;



            switch (units)

            {

                case MeasurementUnit.Pixel:

                    result = string.Empty;

                    break;



                case MeasurementUnit.Centimeter:

                    result = PdnResources.GetString("MeasurementUnit.Centimeter.Abbreviation");

                    break;



                case MeasurementUnit.Inch:

                    result = PdnResources.GetString("MeasurementUnit.Inch.Abbreviation");

                    break;



                default:

                    throw new InvalidEnumArgumentException("MeasurementUnit was invalid");

            }



            return result;

        }



        public void CoordinatesToStrings(MeasurementUnit units, int x, int y, out string xString, out string yString, out string unitsString)

        {

            string unitsAbbreviation = GetUnitsAbbreviation(units);



            unitsString = GetUnitsAbbreviation(units);



            if (units == MeasurementUnit.Pixel)

            {

                xString = x.ToString();

                yString = y.ToString();

            }

            else

            {

                double physicalX = PixelToPhysicalX(x, units);

                xString = physicalX.ToString("F2");



                double physicalY = PixelToPhysicalY(y, units);

                yString = physicalY.ToString("F2");

            }

        }



        /// <summary>

        /// This is provided for future use.

        /// If you want to add new stuff that must be serialized, create a new class,

        /// then point 'tag' to a new instance of this class that is initialized

        /// during construction. Make sure the new class has a 'tag' variable as well.

        /// We effectively set up a 'linked list' where new versions of the code

        /// can open old versions of the document, as .NET serialization is fickle in

        /// certain areas. You might also add a new property to simplify using 

        /// this stuff...

        ///    public DocumentVersion2Data DocV2Data { get { return (DocumentVersion2Data)tag; } }

        /// </summary>

        // In practice, this has never been used, and .NET 2.0+ has better facilities for adding

        // new data to a serialization schema. Therefore, marking as obsolete.

        [Obsolete]

        private object tag = null;



        /// <summary>

        /// Reports the version of Paint.NET that this file was saved with.

        /// This is reset when SaveToStream is used. This can be used to

        /// determine file format compatibility if necessary.

        /// </summary>

        public Version SavedWithVersion

        {

            get

            {

                if (disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                if (savedWith == null)

                {

                    savedWith = PdnInfo.GetVersion();

                }



                return savedWith;

            }

        }



        [field: NonSerialized]

        public event EventHandler DirtyChanged;



        private void OnDirtyChanged()

        {

            if (DirtyChanged != null)

            {

                DirtyChanged(this, EventArgs.Empty);

            }

        }



        /// <summary>

        /// Keeps track of whether the document has changed at all since it was last opened

        /// or saved. This is something that is not reset to true by any method in the Document

        /// class, but is set to false anytime anything is changed.

        /// This way we can prompt the user to save a changed document when they go to quit.

        /// </summary>

        public bool Dirty

        {

            get

            {

                if (this.disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                return this.dirty;

            }



            set

            {

                if (this.disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                if (this.dirty != value)

                {

                    this.dirty = value;

                    OnDirtyChanged();

                }

            }

        }



        /// <summary>

        /// Exposes a collection for access to the layers, and for manipulation of

        /// the way the document contains the layers (add/remove/move).

        /// </summary>

        public LayerList Layers

        {

            get

            {

                if (disposed)

                {

                    throw new ObjectDisposedException("Document");

                }



                return layers;

            }

        }



        /// <summary>

        /// Width of the document, in pixels. All contained layers must be this wide as well.

        /// </summary>

        public int Width

        {

            get

            {

                return width;

            }

        }



        /// <summary>

        /// Height of the document, in pixels. All contained layers must be this tall as well.

        /// </summary>

        public int Height

        {

            get

            {

                return height;

            }

        }



        /// <summary>

        /// The size of the document, in pixels. This is a convenience property that wraps up

        /// the Width and Height properties in one Size structure.

        /// </summary>

        public Size Size

        {

            get

            {

                return new Size(Width, Height);

            }

        }



        public Rectangle Bounds

        {

            get

            {

                return new Rectangle(0, 0, Width, Height);

            }

        }



        public Metadata Metadata

        {

            get

            {

                if (metadata == null)

                {

                    metadata = new Metadata(userMetaData);

                }



                return metadata;

            }

        }



        public void ReplaceMetaDataFrom(Document other)

        {

            this.Metadata.ReplaceWithDataFrom(other.Metadata);

        }



        public void ClearMetaData()

        {

            this.Metadata.Clear();

        }



        [Obsolete("don't use this property; implementors should expose type-safe properties instead", false)]

        // Note, we can not remove this property because then the compiler complains that 'tag' is unused.

        public object Tag

        {

            get

            {

                return this.tag;

            }



            set

            {

                this.tag = value;

            }

        }



        /// <summary>

        /// Clears a portion of a surface to transparent.

        /// </summary>

        /// <param name="surface">The surface to partially clear</param>

        /// <param name="roi">The rectangle to clear</param>

        private unsafe void ClearBackground(Surface surface, Rectangle roi)

        {

            roi.Intersect(surface.Bounds);



            for (int y = roi.Top; y < roi.Bottom; y++)

            {

                ColorBgra *ptr = surface.GetPointAddressUnchecked(roi.Left, y);

                Memory.SetToZero(ptr, (ulong)roi.Width * ColorBgra.SizeOf);

            }

        }



        /// <summary>

        /// Clears a portion of a surface to transparent.

        /// </summary>

        /// <param name="surface">The surface to partially clear</param>

        /// <param name="rois">The array of Rectangles designating the areas to clear</param>

        /// <param name="startIndex">The start index within the rois array to clear</param>

        /// <param name="length">The number of Rectangles in the rois array (staring with startIndex) to clear</param>

        private void ClearBackground(Surface surface, Rectangle[] rois, int startIndex, int length)

        {

            for (int i = startIndex; i < startIndex + length; i++)

            {

                ClearBackground(surface, rois[i]);

            }

        }



        public void Render(RenderArgs args)

        {

            Render(args, args.Surface.Bounds);

        }



        public void Render(RenderArgs args, Rectangle roi)

        {

            Render(args, roi, false);

        }



        public void Render(RenderArgs args, bool clearBackground)

        {

            Render(args, args.Surface.Bounds, clearBackground);

        }



        /// <summary>

        /// Renders a requested region of the document. Will clear the background of the input

        /// before rendering if requested.

        /// </summary>

        /// <param name="args">Contains information used to control where rendering occurs.</param>

        /// <param name="roi">The rectangular region to render.</param>

        /// <param name="clearBackground">If true, 'args' will be cleared to zero before rendering.</param>

        public void Render(RenderArgs args, Rectangle roi, bool clearBackground)

        {

            int startIndex;



            if (clearBackground)

            {

                BitmapLayer layer0;

                layer0 = this.layers[0] as BitmapLayer;



                // Special case: if the first layer is a visible BitmapLayer with full opacity using 

                // the default blend op, we can just copy the pixels straight over

                if (layer0 != null && 

                    layer0.Visible && 

                    layer0.Opacity == 255 &&

                    layer0.BlendOp.GetType() == UserBlendOps.GetDefaultBlendOp())

                {

                    args.Surface.CopySurface(layer0.Surface);

                    startIndex = 1;

                }

                else

                {

                    ClearBackground(args.Surface, roi);

                    startIndex = 0;

                }

            }

            else

            {

                startIndex = 0;

            }



            for (int i = startIndex; i < this.layers.Count; ++i)

            {

                Layer layer = (Layer)this.layers[i];



                if (layer.Visible)

                {

                    layer.Render(args, roi);

                }

            }

        }



        public void Render(RenderArgs args, Rectangle[] roi, bool clearBackground)

        {

            this.Render(args, roi, 0, roi.Length, clearBackground);

        }



        public void Render(RenderArgs args, Rectangle[] roi, int startIndex, int length, bool clearBackground)

        {

            int startLayerIndex;



            if (clearBackground)

            {

                BitmapLayer layer0;

                layer0 = this.layers[0] as BitmapLayer;



                // Special case: if the first layer is a visible BitmapLayer with full opacity using 

                // the default blend op, we can just copy the pixels straight over

                if (layer0 != null && 

                    layer0.Visible && 

                    layer0.Opacity == 255 &&

                    layer0.BlendOp.GetType() == UserBlendOps.GetDefaultBlendOp())

                {

                    args.Surface.CopySurface(layer0.Surface, roi, startIndex, length);

                    startLayerIndex = 1;

                }

                else

                {

                    ClearBackground(args.Surface, roi, startIndex, length);

                    startLayerIndex = 0;

                }

            }

            else

            {

                startLayerIndex = 0;

            }



            for (int i = startLayerIndex; i < this.layers.Count; ++i)

            {

                Layer layer = (Layer)this.layers[i];



                if (layer.Visible)

                {

                    layer.RenderUnchecked(args, roi, startIndex, length);

                }

            }

        }



        private sealed class UpdateScansContext

        {

            private Document document;

            private RenderArgs dst;

            private Rectangle[] scans;

            private int startIndex;

            private int length;



            public void UpdateScans(object context)

            {

                document.Render(dst, scans, startIndex, length, true);

            }



            public UpdateScansContext(Document document, RenderArgs dst, Rectangle[] scans, int startIndex, int length)

            {

                this.document = document;

                this.dst = dst;

                this.scans = scans;

                this.startIndex = startIndex;

                this.length = length;

            }

        }



        /// <summary>

        /// Renders only the portions of the document that have changed (been Invalidated) since 

        /// the last call to this function.

        /// </summary>

        /// <param name="args">Contains information used to control where rendering occurs.</param>

        /// <returns>true if any rendering was done (the update list was non-empty), false otherwise</returns>

        public bool Update(RenderArgs dst)

        {

            if (disposed)

            {

                throw new ObjectDisposedException("Document");

            }



            Rectangle[] updateRects;

            int updateRectsLength;

            updateRegion.GetArrayReadOnly(out updateRects, out updateRectsLength);



            if (updateRectsLength == 0)

            {

                return false;

            }



            PdnRegion region = Utility.RectanglesToRegion(updateRects, 0, updateRectsLength);

            Rectangle[] rectsOriginal = region.GetRegionScansReadOnlyInt();

            Rectangle[] rectsToUse;



            // Special case where we're drawing 1 big rectangle: split it up!

            // This case happens quite frequently, but we don't want to spend a lot of

            // time analyzing any other case that is more complicated.

            if (rectsOriginal.Length == 1 && rectsOriginal[0].Height > 1)

            {

                Rectangle[] rectsNew = new Rectangle[Processor.LogicalCpuCount];

                Utility.SplitRectangle(rectsOriginal[0], rectsNew);

                rectsToUse = rectsNew;

            }

            else

            {

                rectsToUse = rectsOriginal;

            }



            int cpuCount = Processor.LogicalCpuCount;

            for (int i = 0; i < cpuCount; ++i)

            {

                int start = (i * rectsToUse.Length) / cpuCount;

                int end = ((i + 1) * rectsToUse.Length) / cpuCount;



                UpdateScansContext usc = new UpdateScansContext(this, dst, rectsToUse, start, end - start);



                if (i == cpuCount - 1)

                {   

                    // Reuse this thread for the last job -- no sense creating a new thread.

                    usc.UpdateScans(usc);

                }

                else

                {

                    threadPool.QueueUserWorkItem(new WaitCallback(usc.UpdateScans), usc);

                }

            }



            this.threadPool.Drain();

            Validate();

            return true;

        }



        /// <summary>

        /// Constructs a blank document (zero layers) of the given width and height.

        /// </summary>

        /// <param name="width"></param>

        /// <param name="height"></param>

        public Document(int width, int height)

        {

            this.width = width;

            this.height = height;

            this.Dirty = true;

            this.updateRegion = new Vector<Rectangle>();

            layers = new LayerList(this);

            SetupEvents();

            userMetaData = new NameValueCollection();

            Invalidate();

        }



        public Document(Size size)

            : this(size.Width, size.Height)

        {

        }



        /// <summary>

        /// Sets up event handling for contained objects.

        /// </summary>

        private void SetupEvents()

        {

            layers.Changed += new EventHandler(LayerListChangedHandler);

            layers.Changing += new EventHandler(LayerListChangingHandler);

            layerInvalidatedDelegate = new InvalidateEventHandler(LayerInvalidatedHandler);



            foreach (Layer layer in layers)

            {

                layer.Invalidated += layerInvalidatedDelegate;

            }

        }



        /// <summary>

        /// Called after deserialization occurs so that certain things that are non-serializable

        /// can be set up.

        /// </summary>

        /// <param name="sender"></param>

        public void OnDeserialization(object sender)

        {

            this.updateRegion = new Vector<Rectangle>();

            this.updateRegion.Add(this.Bounds);

            this.threadPool = new PaintDotNet.Threading.ThreadPool();

            SetupEvents();

            Dirty = true;

        }



        [field: NonSerialized]

        public event InvalidateEventHandler Invalidated;



        /// <summary>

        /// Raises the Invalidated event.

        /// </summary>

        /// <param name="e"></param>

        private void OnInvalidated(InvalidateEventArgs e)

        {

            if (Invalidated != null)

            {

                Invalidated(this, e);

            }

        }



        /// <summary>

        /// Handles the Changing event that is raised from the contained LayerList.

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="e"></param>

        private void LayerListChangingHandler(object sender, EventArgs e)

        {

            if (disposed)

            {

                throw new ObjectDisposedException("Document");

            }



            foreach (Layer layer in Layers)

            {

                layer.Invalidated -= layerInvalidatedDelegate;

            }

        }



        /// <summary>

        /// Handles the Changed event that is raised from the contained LayerList.

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="e"></param>

        private void LayerListChangedHandler(object sender, EventArgs e)

        {

            foreach (Layer layer in Layers)

            {

                layer.Invalidated += layerInvalidatedDelegate;

            }



            Invalidate();

        }



        /// <summary>

        /// Handles the Invalidated event that is raised from any contained Layer.

        /// </summary>

        /// <param name="sender"></param>

        /// <param name="e"></param>

        private void LayerInvalidatedHandler(object sender, InvalidateEventArgs e)

        {

            Invalidate(e.InvalidRect);

        }



        /// <summary>

        /// Causes the whole document to be invalidated, forcing a full rerender on

        /// the next call to Update.

        /// </summary>

        public void Invalidate()

        {

            Dirty = true;

            Rectangle rect = new Rectangle(0, 0, Width, Height);

            updateRegion.Clear();

            updateRegion.Add(rect);

            OnInvalidated(new InvalidateEventArgs(rect));

        }



        /// <summary>

        /// Invalidates a portion of the document. The given region is then tagged

        /// for rerendering during the next call to Update.

        /// </summary>

        /// <param name="roi">The region of interest to be invalidated.</param>

        public void Invalidate(PdnRegion roi)

        {

            Dirty = true;



            foreach (Rectangle rect in roi.GetRegionScansReadOnlyInt())

            {

                rect.Intersect(this.Bounds);

                updateRegion.Add(rect);



                if (!rect.IsEmpty)

                {

                    InvalidateEventArgs iea = new InvalidateEventArgs(rect);

                    OnInvalidated(iea);

                }

            }

        }



        public void Invalidate(RectangleF[] roi)

        {

            foreach (RectangleF rectF in roi)

            {

                Invalidate(Rectangle.Truncate(rectF));

            }

        }



        public void Invalidate(RectangleF roi)

        {

            Invalidate(Rectangle.Truncate(roi));

        }



        public void Invalidate(Rectangle[] roi)

        {

            foreach (Rectangle rect in roi)

            {

                Invalidate(rect);

            }

        }



        /// <summary>

        /// Invalidates a portion of the document. The given region is then tagged

        /// for rerendering during the next call to Update.

        /// </summary>

        /// <param name="roi">The region of interest to be invalidated.</param>

        public void Invalidate(Rectangle roi)

        {

            Dirty = true;

            Rectangle rect = Rectangle.Intersect(roi, this.Bounds);

            updateRegion.Add(rect);

            OnInvalidated(new InvalidateEventArgs(rect));

        }



        /// <summary>

        /// Clears the document's update region. This is called at the end of the

        /// Update method.

        /// </summary>

        private void Validate()

        {

            updateRegion.Clear();

        }



        /// <summary>

        /// Creates a document that consists of one BitmapLayer.

        /// </summary>

        /// <param name="image">The Image to make a copy of that will be the first layer ("Background") in the document.</param>

        public static Document FromImage(Image image)

        {

            if (image == null)

            {

                throw new ArgumentNullException("image");

            }



            Document document = new Document(image.Width, image.Height);

            BitmapLayer layer = Layer.CreateBackgroundLayer(image.Width, image.Height);

            layer.Surface.Clear(ColorBgra.FromBgra(0, 0, 0, 0));



            Bitmap asBitmap = image as Bitmap;



            // Copy pixels

            if (asBitmap != null && asBitmap.PixelFormat == PixelFormat.Format32bppArgb)

            {

                unsafe

                {

                    BitmapData bData = asBitmap.LockBits(new Rectangle(0, 0, asBitmap.Width, asBitmap.Height), ImageLockMode.ReadOnly, PixelFormat.Format32bppArgb);



                    try

                    {

                        for (int y = 0; y < bData.Height; ++y)

                        {

                            uint* srcPtr = (uint*)((byte*)bData.Scan0.ToPointer() + (y * bData.Stride));

                            ColorBgra* dstPtr = layer.Surface.GetRowAddress(y);



                            for (int x = 0; x < bData.Width; ++x)

                            {

                                dstPtr->Bgra = *srcPtr;

                                ++srcPtr;

                                ++dstPtr;

                            }

                        }

                    }



                    finally

                    {

                        asBitmap.UnlockBits(bData);

                        bData = null;

                    }

                }

            }

            else if (asBitmap != null && asBitmap.PixelFormat == PixelFormat.Format24bppRgb)

            {

                unsafe

                {

                    BitmapData bData = asBitmap.LockBits(new Rectangle(0, 0, asBitmap.Width, asBitmap.Height), ImageLockMode.ReadOnly, PixelFormat.Format24bppRgb);



                    try

                    {

                        for (int y = 0; y < bData.Height; ++y)

                        {

                            byte* srcPtr = (byte*)bData.Scan0.ToPointer() + (y * bData.Stride);

                     …

Large files files are truncated, but you can click here to view the full file