ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles

CloneImageProfiles • DeleteImageProfile • DestroyImageProfiles • GetImageProfile • GetNextImageProfile • ProfileImage • RemoveImageProfile • ResetImageProfileIterator • SetImageProfile • SyncImageProfiles

CloneImageProfiles

CloneImageProfiles() clones one or more image profiles.

The format of the CloneImageProfiles method is:

MagickBooleanType CloneImageProfiles(Image *image,
  const Image *clone_image)

A description of each parameter follows:

image: the image.
clone_image: the clone image.

DeleteImageProfile

DeleteImageProfile() deletes a profile from the image by its name.

The format of the DeleteImageProfile method is:

MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)

A description of each parameter follows:

image: the image.
name: the profile name.

DestroyImageProfiles

DestroyImageProfiles() releases memory associated with an image profile map.

The format of the DestroyProfiles method is:

void DestroyImageProfiles(Image *image)

A description of each parameter follows:

image: the image.

GetImageProfile

GetImageProfile() gets a profile associated with an image by name.

The format of the GetImageProfile method is:

const StringInfo *GetImageProfile(const Image *image,const char *name)

A description of each parameter follows:

image: the image.
name: the profile name.

GetNextImageProfile

GetNextImageProfile() gets the next profile name for an image.

The format of the GetNextImageProfile method is:

char *GetNextImageProfile(const Image *image)

A description of each parameter follows:

hash_info: the hash info.

ProfileImage() associates, applies, or removes an ICM, IPTC, or generic profile with / to / from an image. If the profile is NULL, it is removed from the image otherwise added or applied. Use a name of '*' and a profile of NULL to remove all profiles from the image.

ICC and ICM profiles are handled as follows: If the image does not have an associated color profile, the one you provide is associated with the image and the image pixels are not transformed. Otherwise, the colorspace transform defined by the existing and new profile are applied to the image pixels and the new profile is associated with the image.

The format of the ProfileImage method is:

MagickBooleanType ProfileImage(Image *image,const char *name,
  const void *datum,const size_t length,const MagickBooleanType clone)

A description of each parameter follows:

image: the image.
name: Name of profile to add or remove: ICC, IPTC, or generic profile.
datum: the profile data.
length: the length of the profile.
clone: should be MagickFalse.

RemoveImageProfile

RemoveImageProfile() removes a named profile from the image and returns its value.

The format of the RemoveImageProfile method is:

void *RemoveImageProfile(Image *image,const char *name)

A description of each parameter follows:

image: the image.
name: the profile name.

ResetImageProfileIterator

ResetImageProfileIterator() resets the image profile iterator. Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.

The format of the ResetImageProfileIterator method is:

ResetImageProfileIterator(Image *image)

A description of each parameter follows:

image: the image.

SetImageProfile

SetImageProfile() adds a named profile to the image. If a profile with the same name already exists, it is replaced. This method differs from the ProfileImage() method in that it does not apply CMS color profiles.

The format of the SetImageProfile method is:

MagickBooleanType SetImageProfile(Image *image,const char *name,
  const StringInfo *profile)

A description of each parameter follows:

image: the image.
name: the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).
profile: A StringInfo structure that contains the named profile.

SyncImageProfiles

SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.

The format of the SyncImageProfiles method is:

MagickBooleanType SyncImageProfiles(Image *image)

A description of each parameter follows:

image: the image.