pgmppm.h

Go to the documentation of this file.

/*
 * pgmppm.h
 *
 * Copyright (C) 2008  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_PGMPPM_H__
#define WAVEPACKET_PGMPPM_H__

// includes --------------------------------------------------------------------
#include "common/common.h"

#include <iostream>


namespace pgmppm {


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

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup pgmppm PGM/PPM Library
///
/// My own library to read/write pgm/ppm files.
/// See internet searches for libnetpbm and the PGM/PPM file formats.
///
/// The authority: http://netpbm.sourceforge.net/doc/pgm.html 
///
/// WHY did I write my own?  Partly because it is simple, and partly because I
/// wanted to base it on std::iostreams so I could break any dependency on files.
/// For instance, gzipped files, or in-memory data, etc.
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup pgmppm
/// \defgroup pgmppm_write      File Writing
///
///     To write a file, the caller specifies the dimensions and a callback.
///     The file-writing routine will call back to retrieve per-pixel info.
///
///     These are designed to be safe and agnostic to image storage, not fast.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/

typedef int (*pgm_pixel_fn)(IN void * context, IN int x, IN int y);

/// write a pgm file to an output stream
void writePgm(IO std::ostream& out,
                        IN int width,
                        IN int height,
                        IN int max_gray,        // 0 < m_g < 65536
                        IN pgm_pixel_fn fn,
                        IN void * context);


struct color_t {
        int     red;
        int     green;
        int     blue;
};

typedef color_t (*ppm_pixel_fn)(IN void * context, IN int x, IN int y);

void writePpm(IO std::ostream& out,
                        IN int width,
                        IN int height,
                        IN int max_color,       // 0 < max_color < 65536
                        IN ppm_pixel_fn fn,
                        IN void * context);

/*@}*/


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup pgmppm
/// \defgroup pgmppm_read       File Reading
///
///     Caller provides the stream to be read, and two callbacks.  The first
///     callback (notify_size) lets the caller know the size of the image.  The
///     second callback (write_pixel) is called per pixel in the image.
///
///     Again, designed for reusability and safety, not speed.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


// return true if okay, false if read should be cancelled
typedef bool (*notify_size_fn)(IN void * context,
                        IN int width,
                        IN int length,
                        IN int max_val);

typedef void (*pgm_write_pixel_fn)(IN void * context,
                        IN int x, IN int y, IN int height);

bool readPgm(IO std::istream& in,
                        IN notify_size_fn notify_size,
                        IN pgm_write_pixel_fn write_pixel,
                        IN void * context);



};      // pgmppm namespace

#endif  // WAVEPACKET_PGMPPM_H__