wave-image.h

Go to the documentation of this file.

/*
 * wave-image.h
 *
 * Copyright (C) 2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Basic 2D image support.
 */

#ifndef WAVEPACKET_IMAGE_H__
#define WAVEPACKET_IMAGE_H__

// includes --------------------------------------------------------------------
#include "image-base/image-base.h"      // declares the media::image_t struct



namespace media {

/// \ingroup media
/*@{*/

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup wave_image Image Library
///
/// This is a basic library for the reading (not necessarily writing!) of
/// images.
///
/// This library just declares a generic image type, which is common to all
/// formats (JPG, PNG, BMP, etc.).  Callers can use this API to read images.
///
/// The main use case is to call loadImage() with a path, and then
/// this library will load the image and return it to you.  Then you can work
/// with the generic image_t object, regardless of the actual format of the
/// persisted image.
///
/// For instance, if you want to load an image from a local file, you would
/// use code like this:
/// \code
///
///     smart_ptr<nstream::Manager> fsManager =
///         nstream::getFilesystemManager("/my/home/directory");
///
///     media::image_t image;
///     if (!media::loadImage(fsManager, "some/cool/image.jpg", image)) {
///             throw "I couldn't load the image!";
///     }
///
///     std::cout << "I just read an image that is " << image.width;
///     std::cout << " pixels wide.\n";
///
/// \endcode
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// use this nstream-based routine to load images (see \ref nstream).
bool loadImage(IN nstream::Manager * mgr,
                        IN const char * name,
                        OUT image_t& image);


};      // media namespace



#endif  // WAVEPACKET_IMAGE_H__