# wave-image.h

Go to the documentation of this file.
00001 /*
00002  * wave-image.h
00003  *
00004  * Copyright (C) 2009  Thomas A. Vaughan
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * Basic 2D image support.
00032  */
00033
00034 #ifndef WAVEPACKET_IMAGE_H__
00035 #define WAVEPACKET_IMAGE_H__
00036
00037 // includes --------------------------------------------------------------------
00038 #include "image-base/image-base.h"      // declares the media::image_t struct
00039
00040
00041
00042 namespace media {
00043
00044 /// \ingroup media
00045 /*@{*/
00046
00047 ////////////////////////////////////////////////////////////////////////////////
00048 ///
00049 /// \defgroup wave_image Image Library
00050 ///
00051 /// This is a basic library for the reading (not necessarily writing!) of
00052 /// images.
00053 ///
00054 /// This library just declares a generic image type, which is common to all
00055 /// formats (JPG, PNG, BMP, etc.).  Callers can use this API to read images.
00056 ///
00057 /// The main use case is to call loadImage() with a path, and then
00058 /// this library will load the image and return it to you.  Then you can work
00059 /// with the generic image_t object, regardless of the actual format of the
00060 /// persisted image.
00061 ///
00062 /// For instance, if you want to load an image from a local file, you would
00063 /// use code like this:
00064 /// \code
00065 ///
00066 ///     smart_ptr<nstream::Manager> fsManager =
00067 ///         nstream::getFilesystemManager("/my/home/directory");
00068 ///
00069 ///     media::image_t image;
00070 ///     if (!media::loadImage(fsManager, "some/cool/image.jpg", image)) {
00071 ///             throw "I couldn't load the image!";
00072 ///     }
00073 ///
00074 ///     std::cout << "I just read an image that is " << image.width;
00075 ///     std::cout << " pixels wide.\n";
00076 ///
00077 /// \endcode
00078 ///
00079 ////////////////////////////////////////////////////////////////////////////////
00080 /*@{*/
00081
00082
00083 /// use this nstream-based routine to load images (see \ref nstream).
00084 bool loadImage(IN nstream::Manager * mgr,
00085                         IN const char * name,
00086                         OUT image_t& image);
00087
00088
00089 };      // media namespace
00090
00091
00092
00093 #endif  // WAVEPACKET_IMAGE_H__
00094