Plug-In API Overview

Command Extension (CX)

Definitions:

Called to retrieve the details of the plug-in, such as the plug-in title, the icon for the plug-in, and, most importantly, the number and details of the commands supported by the plug-in.

Called to initialize the plug-in. This will be called before any other function.

Invokes a specified command on a set of files.

Optional Functions:

Shows an "About" dialog for the plug-in.

Called to un-initialize the plug-in. This will be called after a matching Init call.

Displays a help document for either the plug-in or a specified command.

Exception handler for a plug-in-caused exception.

Called to determine if the cached information about the commands that are supported by the plug-in should be updated.

Image Decoder (ID)

Definitions:

Called once the plug-in is no longer needed to decode an image. This is where any memory allocated for the decoding reference by the ID_StateHdl should be freed.

Called to retrieve information about the image being decoded.

Called to retrieve information about a specific page being decoded.

Called to retrieve the details of the plug-in, such as the plug-in title, the icon for the plug-in, and, most importantly, the number and details of the commands supported by the plug-in.

Called to initialize the plug-in. This will be called before any other function.

Called to start the decoding of an image. The plug-in should store any state related to decoding the image in an object pointed to by ID_StateHdl. This state will be passed back to the plug-in in all subsequent calls related to that image.

Decodes a page of the image into a Windows bitmap.

Additionally, the plug-in may export other optional functions.

Optional Functions:

Creates a CWnd (MFC)-derived window that will be displayed in the application. This should be used to implement a custom view of the image format. See the CreateView sample plug-in for more details.

Exception handler for a plug-in-caused exception.

Called to determine if the cached information about the image formats supported by the plug-in should be updated.

Called to un-initialize the plug-in. This will be called after a matching Init call.

Called after the plug-in returned a non-standard error. Returns an error string that is relevant to the error code.

Called to retrieve all or some metadata from an image. The metadata is returned in a linked list.

Called to retrieve the rotate and flip values that should be applied to a RAW file.

Retrieves a list of the supported metadata types for an image format.

Displays a help document for either the plug-in or a specified image format.

Returns true if the plug-in has auto-rotated the image when decoding, false if not.

Called to start incremental page decoding.

Does one step of incremental page decoding.

Called to finish incremental page decoding.

Pre-translates message handler for the plug-in view created by ID_CreateView.

Shows an "About" dialog for the plug-in.

Image Encoder (IE)

Definitions:

Called to retrieve the details of the plug-in, such as the plug-in title, the icon for the plug-in, and, most importantly, the number and details of the commands supported by the plug-in.

Called to retrieve an enumeration of the valid pixel formats of bitmaps that can be passed to the plug-in as input for image encoding of the specified format.

Writes a single page image to disk.

Called to initialize the plug-in. This will be called before any other function.

Shows an "About" dialog for the plug-in.

Additionally, the plug-in may export other optional functions.

Optional Functions:

Exception handler for a plug-in-caused exception.

Called to determine if the cached information about the image formats supported by the plug-in should be updated.

Called to un-initialize the plug-in. This will be called after a matching Init call.

Initializes and returns a default encoding parameters struct for the given format type.

Called after the plug-in returned a non-standard error. Returns an error string that is relevant to the error code.

Retrieves a list of GUIDs representing the natively supported metadata types of the image format.

Retrieves a list of GUIDs representing the supported metadata types of the image format.

Displays a help document for either the plug-in or a specified image format.

Ends image encoding for an image. The plug-in should free any memory referenced by IE_StateHdl.

Appends or replaces a page in the current image being encoded.

Starts image encoding for an image. The plug-in should store any state related to encoding the image in an object pointed to by IE_StateHdl. This state will be passed back to the plug-in in all subsequent calls related to that image.

Encodes a single page image to a memory buffer, instead of to disk.

Sets metadata for a specific page of an image.

Displays a dialog box allowing the user to customize the encoding options for the specified format.

Image Filter (IF)

Definitions:

Called to initialize the plug-in. This will be called before any other function.

Called to retrieve the details of the plug-in, such as the plug-in title, the icon for the plug-in, and, most importantly, the number of and details of the commands supported by the plug-in.

as well as

Runs a filter on an image using ACDSee’s GUI. Parameters were specified in the IF_UISpecification for the filter.

and/or

Runs a filter from a menu. Any UI must be fully implemented by the plug-in. If the user set parameters for the filter, return those parameters via outParams so that ACDSee can re-run the filter via ACDSee Actions later.

Runs a menu filter during an action playback. Similar to RunMenuFilter but with no user interaction.

Frees the parameters returned via IF_RunMenuFilter.

Additionally, the plug-in may export other optional functions.

Optional Functions:

Exception handler for a plug-in-caused exception.

Called to un-initialize the plug-in. This will be called after a matching Init call.

Displays a help document for either the plug-in or a specified filter.