Introduction
An image unit is a Core Image filter that is packaged as an NSBundle
object. Any image processing filter that uses Core Image should be packaged as an image unit. Doing so makes it easy to distribute your filter. An image unit is not only a Core Image filter packaged as a bundle, it is a distribution mechanism for an image processing filter. This means that when you create an image unit, you also get the benefit of consistent packaging and an Apple-provided logo that you can license to use.
This tutorial provides the steps you need to write an image processing filter for OS X. More specifically, it shows you how to create image units that contain an executable filter. An executable filter has one portion that uses the central processing unit (CPU) to execute and another portion that uses the graphics processing unit (GPU). This document does not discuss nonexecutable filters, because they consist only of code that runs on the GPU and therefore have limitations.
Organization of This Document
The document is organized into these chapter:
An Image Unit and Its Parts describes the major parts of an image processing unit, what each does, and how they work together.
Writing Kernels provides examples, from simple to complex, of
kernel
routines.Writing the Objective-C Portion describes the image unit template provided by Xcode, discusses each of the files provided in the template, and shows how to package some of the
kernel
routines from the previous chapter as image units.Preparing an Image Unit for Distribution discusses installing, validating, and testing image units and tells where to get more information on licensing the image unit logo.
Prerequisite Reading
Before reading this document you should:
Be familiar with the Core Image API. See Core Image Reference Collection.
Write code that uses one of the built-in Core Image filters. See Using Core Image Filters in Core Image Programming Guide.
Take a look at Core Image Kernel Language Reference, which describes the procedural programming language used to write the kernel portion of an image unit.
If you are not a Cocoa programmer, don’t panic! The kernel
routine portion of an image processing filter uses a procedural language. If you know C, you’ll catch on fast. The higher-level portion of an image processing filter uses the Core Image API, which is an Objective-C API, but is not part of the Cocoa framework. Because Xcode provides a template for writing an image unit, you’ll see that it’s relatively straightforward to use Objective-C to write an image unit.
If you are not an OpenGL programmer, don’t worry. The Core Image API was designed to hide all the messy details of dealing with the GPU from you. Although the kernel
routine portion of an image processing filter uses a subset of the OpenGL Shading Language (glslang), you’ll see by looking at the examples that you don’t need prior knowledge to write kernel
routines. You do, however, need to have an understanding of the mathematics behind the processing that you want to implement.
See Also
The resources in this section are valuable to any developer who is writing an image unit. You’ll find them most helpful as you work your way through this document and later on, when you are writing your own image units.
ImageUnitAnalyzer is a tool that you use to ensure that any image unit you write is valid. After you install the developer tools, you can find the analyzer in
/Developer/usr/bin
.CIFilterBrowser is a widget that lets you inspect all installed image units as well as Core Image built-in filters. You can view the input parameters and attributes of a filter and see a preview of an output image produced by the filter.
Core Image Fun House is an application that lets you explore all installed image units and Core Image built-in filters. You can choose any image to process and then apply one or more filters to the image by stacking the filters together. You can also turn off or on any filter in the stack to more closely examine filter effects. After you install the developer tools, you can find Core Image Fun House in
/Developer/Applications/Graphics Tools/
.CIAnnotation is a sample application that contains two image unit projects and uses them for compositing images and painting over them.
Quartz Composer is an application that you can use to explore motion graphics. Core Image developers can use this application to test image units and to try out
kernel
routines. After you install the developer tools, you can find Quartz Composer in /Developer/Applications/
.Quartz Composer User Guide describes how to use the Quartz Composer development tool.
The
Quartz-dev
mailing list is a technical discussion forum for developers using Quartz technologies on OS X, including Core Image. To sign up, see http://lists.apple.com/mailman/listinfo/quartz-dev.
Copyright © 2011 Apple Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2011-06-06