README for OpenImageIO
The primary target audience for OIIO is VFX studios and developers of tools such as renderers, compositors, viewers, and other image-related software you'd find in a production pipeline.
OpenImageIO consists of:
- Simple but powerful ImageInput and ImageOutput APIs that provide an abstraction for reading and writing image files of nearly any format, without the calling application needing to know any of the details of these file formats, and indeed without the calling application needing to be aware of which formats are available.
- A library that manages subclasses of ImageInput and ImageOutput that implement I/O from specific file formats, with each file format's implementation stored as a plug-in. Therefore, an application using OpenImageIO's APIs can read and write any image file for which a plugin can be found at runtime.
- Plugins implementing I/O for several popular image file formats, including TIFF, JPEG/JFIF, OpenEXR, PNG, HDR/RGBE, ICO, BMP, Targa, JPEG-2000, RMan Zfile, FITS, DDS, Softimage PIC, PNM, DPX, Cineon, IFF, Field3D, Ptex, Photoshop PSD, Wavefront RLA, SGI, WebP, GIF, and a variety of "RAW" digital camera formats, and a variety of movie formats (readable as individual frames). More are being developed all the time.
- Several command line image tools based on these classes, including oiiotool (command-line format conversion and image processing), iinfo (print detailed info about images), iconvert (convert among formats, data types, or modify metadata), idiff (compare images), igrep (search images for matching metadata), and iv (an image viewer). Because these tools are based on ImageInput/ImageOutput, they work with any image formats for which ImageIO plugins are available.
- An ImageCache class that transparently manages a cache so that it can access truly vast amounts of image data (tens of thousands of image files totaling multiple TB) very efficiently using only a tiny amount (tens of megabytes at most) of runtime memory.
- A TextureSystem class that provides filtered MIP-map texture lookups, atop the nice caching behavior of ImageCache. This is used in commercial renderers and has been used on many large VFX and animated films.
- ImageBuf and ImageBufAlgo functions -- a simple class for storing and manipulating whole images in memory, and a collection of the most useful computations you might want to do involving those images, including many image processing operations.
- Python bindings for all of the major APIs.
OpenImageIO is (c) Copyright 2008-2015 by Larry Gritz et al. All Rights Reserved.
OpenImageIO is distributed using the modified BSD license (also known as the "new BSD" or "3-clause BSD" license). Please read the "LICENSE" file for the legal wording. The documentation is licensed under the Creative Commons Attribution 3.0 Unported License (http://creativecommons.org/licenses/by/3.0/).
The plain English bottom line is that OpenImageIO is free, as well as freely modifiable and redistributable (in both source and binary form). You may use part or all of it in your own applications, whether proprietary or open, free or commercial. Using it in a commercial or proprietary application DOES NOT obligate you to pay us, or to use any particular licensing terms in your own application.
Some code and resources are distributed along with OIIO that have highly compatible, though slightly different, licenses (generally MIT or Apache). See the PDF documentation Acknowledgements section for details.
Main web page: http://www.openimageio.org
GitHub page: http://github.com/OpenImageIO/oiio
Mail list subscriptions and archives:
- Developer mail list: http://lists.openimageio.org/listinfo.cgi/oiio-dev-openimageio.org
- Just release announcements: http://lists.openimageio.org/listinfo.cgi/oiio-announce-openimageio.org
Building and Installation
Please read the "INSTALL" file for detailed instructions on how to build and install OpenImageIO.
Remember that you need to set the environment variable IMAGEIO_LIBRARY_PATH to point to the 'lib' directory where OpenImageIO is installed, or else it will not be able to find the plugins.
The primary user and programmer documentation can be found in src/doc/openimageio.pdf (in a source distribution) or in the doc/openimageio.pdf file of an installed binary distribution.