wave-png.h

Go to the documentation of this file.

/*
 * wave-png.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.
 *
 *
 */

#ifndef WAVEPACKET_PNG_H__
#define WAVEPACKET_PNG_H__

// includes --------------------------------------------------------------------
#include "wave-image/image-base/image-base.h"

#include "threadsafe/smart_ptr.h"



namespace media {

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

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup wave_png PNG Library
///
/// My own library to read png files.  Shamelessly stolen from
/// http://tfcduke.developpez.com/tutoriel/format/png/
///
/// In particular, thanks to the author of the png.c file there, David Henry.
/// See the licensing terms in that file (renamed and updated as wave-png.cpp
/// here).  Basically, it is distributed freely (as is this library).
///
/// However, <b>don't use this file or methods!</b>  Use media::loadImage()
/// instead.  That uses this code internally for PNG files.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// creates an image loader for use by the \ref wave_image library.  Use that
///     library to load PNG images.
smart_ptr<ImageLoader> createPngImageLoader(void);


};      // media namespace


#endif  // WAVEPACKET_PNG_H__