% MagickCore Image Layering Methods %
% %
% Software Design %
-% John Cristy %
+% Cristy %
% Anthony Thyssen %
% January 2006 %
% %
% %
-% Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
+% Copyright 1999-2014 ImageMagick Studio LLC, a non-profit organization %
% dedicated to making software imaging solutions freely available. %
% %
% You may not use this file except in compliance with the License. You may %
#include "MagickCore/studio.h"
#include "MagickCore/artifact.h"
#include "MagickCore/cache.h"
+#include "MagickCore/channel.h"
#include "MagickCore/color.h"
#include "MagickCore/color-private.h"
#include "MagickCore/composite.h"
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% ClearBounds() Clear the area specified by the bounds in an image to
-% transparency. This typically used to handle Background Disposal
-% for the previous frame in an animation sequence.
+% transparency. This typically used to handle Background Disposal for the
+% previous frame in an animation sequence.
%
-% WARNING: no bounds checks are performed, except for the null or
-% missed image, for images that don't change. in all other cases
-% bound must fall within the image.
+% Warning: no bounds checks are performed, except for the null or missed
+% image, for images that don't change. in all other cases bound must fall
+% within the image.
%
% The format is:
%
-% void ClearBounds(Image *image,RectangleInfo *bounds
+% void ClearBounds(Image *image,RectangleInfo *bounds,
% ExceptionInfo *exception)
%
% A description of each parameter follows:
if (bounds->x < 0)
return;
- if (image->matte == MagickFalse)
+ if (image->alpha_trait != BlendPixelTrait)
(void) SetImageAlphaChannel(image,OpaqueAlphaChannel,exception);
for (y=0; y < (ssize_t) bounds->height; y++)
{
% to check if a proposed disposal method will work successfully to generate
% the second frame image from the first disposed form of the previous frame.
%
+% Warning: no bounds checks are performed, except for the null or missed
+% image, for images that don't change. in all other cases bound must fall
+% within the image.
+%
% The format is:
%
% MagickBooleanType IsBoundsCleared(const Image *image1,
%
% o exception: return any errors or warnings in this structure.
%
-% WARNING: no bounds checks are performed, except for the null or
-% missed image, for images that don't change. in all other cases
-% bound must fall within the image.
-%
*/
static MagickBooleanType IsBoundsCleared(const Image *image1,
const Image *image2,RectangleInfo *bounds,ExceptionInfo *exception)
{
- register ssize_t
- x;
-
register const Quantum
*p,
*q;
+ register ssize_t
+ x;
+
ssize_t
y;
return(MagickFalse);
for (y=0; y < (ssize_t) bounds->height; y++)
{
- p=GetVirtualPixels(image1,bounds->x,bounds->y+y,bounds->width,1,
- exception);
- q=GetVirtualPixels(image2,bounds->x,bounds->y+y,bounds->width,1,
- exception);
+ p=GetVirtualPixels(image1,bounds->x,bounds->y+y,bounds->width,1,exception);
+ q=GetVirtualPixels(image2,bounds->x,bounds->y+y,bounds->width,1,exception);
if ((p == (const Quantum *) NULL) || (q == (Quantum *) NULL))
break;
for (x=0; x < (ssize_t) bounds->width; x++)
(void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
assert(exception != (ExceptionInfo *) NULL);
assert(exception->signature == MagickSignature);
-
- /* initialise first image */
next=GetFirstImageInList(image);
bounds=next->page;
if (bounds.width == 0)
exception);
if (coalesce_image == (Image *) NULL)
return((Image *) NULL);
+ (void) SetImageBackgroundColor(coalesce_image,exception);
+ coalesce_image->alpha_trait=next->alpha_trait;
coalesce_image->page=bounds;
coalesce_image->dispose=NoneDispose;
- coalesce_image->background_color.alpha=(Quantum) TransparentAlpha;
- (void) SetImageBackgroundColor(coalesce_image,exception);
/*
Coalesce rest of the images.
*/
dispose_image=CloneImage(coalesce_image,0,0,MagickTrue,exception);
- (void) CompositeImage(coalesce_image,CopyCompositeOp,next,next->page.x,
- next->page.y,exception);
+ (void) CompositeImage(coalesce_image,next,CopyCompositeOp,MagickTrue,
+ next->page.x,next->page.y,exception);
next=GetNextImageInList(next);
for ( ; next != (Image *) NULL; next=GetNextImageInList(next))
{
coalesce_image->next->previous=coalesce_image;
previous=coalesce_image;
coalesce_image=GetNextImageInList(coalesce_image);
- coalesce_image->matte=MagickTrue;
- (void) CompositeImage(coalesce_image,next->matte != MagickFalse ?
- OverCompositeOp : CopyCompositeOp,next,next->page.x,next->page.y,
- exception);
+ (void) CompositeImage(coalesce_image,next,
+ next->alpha_trait == BlendPixelTrait ? OverCompositeOp : CopyCompositeOp,
+ MagickTrue,next->page.x,next->page.y,exception);
(void) CloneImageProfiles(coalesce_image,next);
(void) CloneImageProperties(coalesce_image,next);
(void) CloneImageArtifacts(coalesce_image,next);
/*
If a pixel goes opaque to transparent, use background dispose.
*/
- if (IsBoundsCleared(previous,coalesce_image,&bounds,exception))
+ if (IsBoundsCleared(previous,coalesce_image,&bounds,exception) != MagickFalse)
coalesce_image->dispose=BackgroundDispose;
else
coalesce_image->dispose=NoneDispose;
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% DisposeImages() returns the coalesced frames of a GIF animation as it would
-% appear after the GIF dispose method of that frame has been applied. That
-% is it returned the appearance of each frame before the next is overlaid.
+% appear after the GIF dispose method of that frame has been applied. That is
+% it returned the appearance of each frame before the next is overlaid.
%
% The format of the DisposeImages method is:
%
%
% A description of each parameter follows:
%
-% o image: the image sequence.
+% o images: the image sequence.
%
% o exception: return any errors or warnings in this structure.
%
*/
-MagickExport Image *DisposeImages(const Image *image,ExceptionInfo *exception)
+MagickExport Image *DisposeImages(const Image *images,ExceptionInfo *exception)
{
Image
*dispose_image,
*dispose_images;
- register Image
- *curr;
-
RectangleInfo
bounds;
+ register Image
+ *image,
+ *next;
+
/*
Run the image through the animation sequence
*/
- assert(image != (Image *) NULL);
- assert(image->signature == MagickSignature);
- if (image->debug != MagickFalse)
- (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
+ assert(images != (Image *) NULL);
+ assert(images->signature == MagickSignature);
+ if (images->debug != MagickFalse)
+ (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
assert(exception != (ExceptionInfo *) NULL);
assert(exception->signature == MagickSignature);
- curr=GetFirstImageInList(image);
- dispose_image=CloneImage(curr,curr->page.width,curr->page.height,MagickTrue,
- exception);
+ image=GetFirstImageInList(images);
+ dispose_image=CloneImage(image,image->page.width,image->page.height,
+ MagickTrue,exception);
if (dispose_image == (Image *) NULL)
return((Image *) NULL);
- dispose_image->page=curr->page;
+ dispose_image->page=image->page;
dispose_image->page.x=0;
dispose_image->page.y=0;
dispose_image->dispose=NoneDispose;
dispose_image->background_color.alpha=(Quantum) TransparentAlpha;
(void) SetImageBackgroundColor(dispose_image,exception);
dispose_images=NewImageList();
- for ( ; curr != (Image *) NULL; curr=GetNextImageInList(curr))
+ for (next=image; image != (Image *) NULL; image=GetNextImageInList(image))
{
Image
*current_image;
dispose_image=DestroyImage(dispose_image);
return((Image *) NULL);
}
- (void) CompositeImage(current_image,curr->matte != MagickFalse ?
- OverCompositeOp : CopyCompositeOp,curr,curr->page.x,curr->page.y,
- exception);
+ (void) CompositeImage(current_image,next,
+ next->alpha_trait == BlendPixelTrait ? OverCompositeOp : CopyCompositeOp,
+ MagickTrue,next->page.x,next->page.y,exception);
/*
Handle Background dispose: image is displayed for the delay period.
*/
- if (curr->dispose == BackgroundDispose)
+ if (next->dispose == BackgroundDispose)
{
- bounds=curr->page;
- bounds.width=curr->columns;
- bounds.height=curr->rows;
+ bounds=next->page;
+ bounds.width=next->columns;
+ bounds.height=next->rows;
if (bounds.x < 0)
{
bounds.width+=bounds.x;
/*
Select the appropriate previous/disposed image.
*/
- if (curr->dispose == PreviousDispose)
+ if (next->dispose == PreviousDispose)
current_image=DestroyImage(current_image);
else
{
dispose_image=DestroyImage(dispose_image);
dispose_image=current_image;
- current_image=(Image *)NULL;
+ current_image=(Image *) NULL;
}
/*
Save the dispose image just calculated for return.
dispose_image=DestroyImage(dispose_image);
return((Image *) NULL);
}
- (void) CloneImageProfiles(dispose,curr);
- (void) CloneImageProperties(dispose,curr);
- (void) CloneImageArtifacts(dispose,curr);
+ (void) CloneImageProfiles(dispose,next);
+ (void) CloneImageProperties(dispose,next);
+ (void) CloneImageArtifacts(dispose,next);
dispose->page.x=0;
dispose->page.y=0;
- dispose->dispose=curr->dispose;
+ dispose->dispose=next->dispose;
AppendImageToList(&dispose_images,dispose);
}
}
%
% The format of the ComparePixels method is:
%
-% MagickBooleanType *ComparePixels(const ImageLayerMethod method,
+% MagickBooleanType *ComparePixels(const LayerMethod method,
% const PixelInfo *p,const PixelInfo *q)
%
% A description of each parameter follows:
%
*/
-static MagickBooleanType ComparePixels(const ImageLayerMethod method,
+static MagickBooleanType ComparePixels(const LayerMethod method,
const PixelInfo *p,const PixelInfo *q)
{
- MagickRealType
+ double
o1,
o2;
if (method == CompareAnyLayer)
return((MagickBooleanType)(IsFuzzyEquivalencePixelInfo(p,q) == MagickFalse));
- o1 = (p->matte != MagickFalse) ? p->alpha : OpaqueAlpha;
- o2 = (q->matte != MagickFalse) ? q->alpha : OpaqueAlpha;
-
+ o1 = (p->alpha_trait == BlendPixelTrait) ? p->alpha : OpaqueAlpha;
+ o2 = (q->alpha_trait == BlendPixelTrait) ? q->alpha : OpaqueAlpha;
/*
- Pixel goes from opaque to transprency
+ Pixel goes from opaque to transprency.
*/
if (method == CompareClearLayer)
- return((MagickBooleanType) ( (o1 <= ((MagickRealType) QuantumRange/2.0)) &&
- (o2 > ((MagickRealType) QuantumRange/2.0)) ) );
-
+ return((MagickBooleanType) ( (o1 <= ((double) QuantumRange/2.0)) &&
+ (o2 > ((double) QuantumRange/2.0)) ) );
/*
- overlay would change first pixel by second
+ Overlay would change first pixel by second.
*/
if (method == CompareOverlayLayer)
{
- if (o2 > ((MagickRealType) QuantumRange/2.0))
+ if (o2 > ((double) QuantumRange/2.0))
return MagickFalse;
return((MagickBooleanType) (IsFuzzyEquivalencePixelInfo(p,q) == MagickFalse));
}
%
% The format of the CompareImagesBounds method is:
%
-% RectangleInfo *CompareImagesBounds(const ImageLayerMethod method,
+% RectangleInfo *CompareImagesBounds(const LayerMethod method,
% const Image *image1, const Image *image2, ExceptionInfo *exception)
%
% A description of each parameter follows:
%
*/
-static RectangleInfo CompareImagesBounds(const Image *image1,const Image *image2,
- const ImageLayerMethod method,ExceptionInfo *exception)
+static RectangleInfo CompareImagesBounds(const Image *image1,
+ const Image *image2,const LayerMethod method,ExceptionInfo *exception)
{
RectangleInfo
bounds;
%
% CompareImagesLayers() compares each image with the next in a sequence and
% returns the minimum bounding region of all the pixel differences (of the
-% ImageLayerMethod specified) it discovers.
+% LayerMethod specified) it discovers.
%
% Images do NOT have to be the same size, though it is best that all the
% images are 'coalesced' (images are all the same size, on a flattened
% The format of the CompareImagesLayers method is:
%
% Image *CompareImagesLayers(const Image *images,
-% const ImageLayerMethod method,ExceptionInfo *exception)
+% const LayerMethod method,ExceptionInfo *exception)
%
% A description of each parameter follows:
%
*/
MagickExport Image *CompareImagesLayers(const Image *image,
- const ImageLayerMethod method, ExceptionInfo *exception)
+ const LayerMethod method, ExceptionInfo *exception)
{
Image
*image_a,
image_a->page=next->page;
image_a->page.x=0;
image_a->page.y=0;
- (void) CompositeImage(image_a,CopyCompositeOp,next,next->page.x,next->page.y,
- exception);
+ (void) CompositeImage(image_a,next,CopyCompositeOp,MagickTrue,next->page.x,
+ next->page.y,exception);
/*
Compute the bounding box of changes for the later images
*/
bounds=(RectangleInfo *) RelinquishMagickMemory(bounds);
return((Image *) NULL);
}
- (void) CompositeImage(image_a,CopyCompositeOp,next,next->page.x,
+ (void) CompositeImage(image_a,next,CopyCompositeOp,MagickTrue,next->page.x,
next->page.y,exception);
bounds[i]=CompareImagesBounds(image_b,image_a,method,exception);
-
image_b=DestroyImage(image_b);
i++;
}
% The format of the OptimizeLayerFrames method is:
%
% Image *OptimizeLayerFrames(const Image *image,
-% const ImageLayerMethod method, ExceptionInfo *exception)
+% const LayerMethod method, ExceptionInfo *exception)
%
% A description of each parameter follows:
%
#define DEBUG_OPT_FRAME 0
static Image *OptimizeLayerFrames(const Image *image,
- const ImageLayerMethod method, ExceptionInfo *exception)
+ const LayerMethod method, ExceptionInfo *exception)
{
ExceptionInfo
*sans_exception;
assert(method == OptimizeLayer ||
method == OptimizeImageLayer ||
method == OptimizePlusLayer);
-
/*
- Are we allowed to add/remove frames from animation
+ Are we allowed to add/remove frames from animation?
*/
add_frames=method == OptimizePlusLayer ? MagickTrue : MagickFalse;
/*
- Ensure all the images are the same size
+ Ensure all the images are the same size.
*/
curr=GetFirstImageInList(image);
for (; curr != (Image *) NULL; curr=GetNextImageInList(curr))
dispose_image=DestroyImage(dispose_image);
return;
}
- (void) CompositeImage(current_image,next->matte != MagickFalse ?
- OverCompositeOp : CopyCompositeOp, next,next->page.x,next->page.y,
+ (void) CompositeImage(current_image,next,next->alpha_trait == BlendPixelTrait ?
+ OverCompositeOp : CopyCompositeOp,MagickTrue,next->page.x,next->page.y,
exception);
/*
At this point the image would be displayed, for the delay period
Optimize Transparency of the next frame (if present)
*/
next=GetNextImageInList(next);
- if ( next != (Image *) NULL ) {
- (void) CompositeImage(next, ChangeMaskCompositeOp,
- dispose_image, -(next->page.x), -(next->page.y), exception );
+ if (next != (Image *) NULL) {
+ (void) CompositeImage(next,dispose_image,ChangeMaskCompositeOp,
+ MagickTrue,-(next->page.x),-(next->page.y),exception);
}
}
dispose_image=DestroyImage(dispose_image);
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
-% CompositeLayers() compose first image sequence (source) over the second
-% image sequence (destination), using the given compose method and offsets.
+% CompositeLayers() compose the source image sequence over the destination
+% image sequence, starting with the current image in both lists.
+%
+% Each layer from the two image lists are composted together until the end of
+% one of the image lists is reached. The offset of each composition is also
+% adjusted to match the virtual canvas offsets of each layer. As such the
+% given offset is relative to the virtual canvas, and not the actual image.
%
-% The pointers to the image list does not have to be the start of that image
-% list, but may start somewhere in the middle. Each layer from the two image
-% lists are composted together until the end of one of the image lists is
-% reached. The offset of each composition is also adjusted to match the
-% virtual canvas offsets of each layer. As such the given offset is relative
-% to the virtual canvas, and not the actual image.
+% Composition uses given x and y offsets, as the 'origin' location of the
+% source images virtual canvas (not the real image) allowing you to compose a
+% list of 'layer images' into the destiantioni images. This makes it well
+% sutiable for directly composing 'Clears Frame Animations' or 'Coaleased
+% Animations' onto a static or other 'Coaleased Animation' destination image
+% list. GIF disposal handling is not looked at.
%
-% No GIF disposal handling is performed, so GIF animations should be
-% coalesced before use. However this not a requirement, and individual
-% layer images may have any size or offset, for special compositions.
+% Special case:- If one of the image sequences is the last image (just a
+% single image remaining), that image is repeatally composed with all the
+% images in the other image list. Either the source or destination lists may
+% be the single image, for this situation.
%
-% Special case:- If one of the image sequences is just a single image that
-% image is repeatally composed with all the images in the other image list.
-% Either the source or destination lists may be the single image, for this
-% situation.
+% In the case of a single destination image (or last image given), that image
+% will ve cloned to match the number of images remaining in the source image
+% list.
+%
+% This is equivelent to the "-layer Composite" Shell API operator.
%
-% The destination list will be expanded as needed to match number of source
-% image overlaid (from current position to end of list).
%
% The format of the CompositeLayers method is:
%
-% void CompositeLayers(Image *destination,
-% const CompositeOperator compose, Image *source,
-% const ssize_t x_offset, const ssize_t y_offset,
-% ExceptionInfo *exception);
+% void CompositeLayers(Image *destination, const CompositeOperator
+% compose, Image *source, const ssize_t x_offset, const ssize_t y_offset,
+% ExceptionInfo *exception);
%
% A description of each parameter follows:
%
{
x_offset+=source->page.x-destination->page.x;
y_offset+=source->page.y-destination->page.y;
- (void) CompositeImage(destination,compose,source,x_offset,y_offset,
- exception);
+ (void) CompositeImage(destination,source,compose,MagickTrue,x_offset,
+ y_offset,exception);
}
MagickExport void CompositeLayers(Image *destination,
/*
Overlay single source image over destation image/list
*/
- if ( source->previous == (Image *) NULL && source->next == (Image *) NULL )
+ if ( source->next == (Image *) NULL )
while ( destination != (Image *) NULL )
{
CompositeCanvas(destination, compose, source, x_offset, y_offset,
}
/*
- Overlay source image list over single destination
- Generating multiple clones of destination image to match source list.
+ Overlay source image list over single destination.
+ Multiple clones of destination image are created to match source list.
Original Destination image becomes first image of generated list.
As such the image list pointer does not require any change in caller.
Some animation attributes however also needs coping in this case.
*/
- else if ( destination->previous == (Image *) NULL &&
- destination->next == (Image *) NULL )
+ else if ( destination->next == (Image *) NULL )
{
Image *dest = CloneImage(destination,0,0,MagickTrue,exception);
% MergeImageLayers() composes all the image layers from the current given
% image onward to produce a single image of the merged layers.
%
-% The inital canvas's size depends on the given ImageLayerMethod, and is
+% The inital canvas's size depends on the given LayerMethod, and is
% initialized using the first images background color. The images
% are then compositied onto that image in sequence using the given
% composition that has been assigned to each individual image.
% The format of the MergeImageLayers is:
%
% Image *MergeImageLayers(const Image *image,
-% const ImageLayerMethod method, ExceptionInfo *exception)
+% const LayerMethod method, ExceptionInfo *exception)
%
% A description of each parameter follows:
%
% o exception: return any errors or warnings in this structure.
%
*/
-MagickExport Image *MergeImageLayers(Image *image,const ImageLayerMethod method,
+MagickExport Image *MergeImageLayers(Image *image,const LayerMethod method,
ExceptionInfo *exception)
{
#define MergeLayersTag "Merge/Layers"
number_images=GetImageListLength(image);
for (scene=0; scene < (ssize_t) number_images; scene++)
{
- (void) CompositeImage(canvas,image->compose,image,image->page.x-
+ (void) CompositeImage(canvas,image,image->compose,MagickTrue,image->page.x-
canvas->page.x,image->page.y-canvas->page.y,exception);
proceed=SetImageProgress(image,MergeLayersTag,(MagickOffsetType) scene,
number_images);