Documentation - C API
pgm.c File Reference

Portable graymap format (PGM) parser - Definition. More...

#include "pgm.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Functions

static int remove_line (FILE *f)
 Remove all characters to the next new-line.
static int remove_blanks (FILE *f)
 Remove white-spaces and comments.
vl_size vl_pgm_get_npixels (VlPgmImage const *im)
 Get PGM image number of pixels.
vl_size vl_pgm_get_bpp (VlPgmImage const *im)
 Get PGM image bytes per pixel.
int vl_pgm_extract_head (FILE *f, VlPgmImage *im)
 Extract PGM header from stream.
int vl_pgm_extract_data (FILE *f, VlPgmImage const *im, void *data)
 Extract PGM data from stream.
int vl_pgm_insert (FILE *f, VlPgmImage const *im, void const *data)
 Insert a PGM image into a stream.
int vl_pgm_read_new (char const *name, VlPgmImage *im, vl_uint8 **data)
 Read a PGM file.
int vl_pgm_read_new_f (char const *name, VlPgmImage *im, float **data)
 Read floats from a PGM file.
int vl_pgm_write (char const *name, vl_uint8 const *data, int width, int height)
 Write bytes to a PGM file.
int vl_pgm_write_f (char const *name, float const *data, int width, int height)
 Write floats to PGM file.

Detailed Description

Author:
Andrea Vedaldi

Function Documentation

static int remove_blanks ( FILE *  f)
static
Parameters:
ffile to strip.
Returns:
number of characters removed.
static int remove_line ( FILE *  f)
static
Parameters:
ffile to strip.
Returns:
number of characters removed.
int vl_pgm_extract_data ( FILE *  f,
VlPgmImage const *  im,
void *  data 
)
Parameters:
finput file.
imPGM image descriptor.
datadata buffer to fill.
Returns:
error code.

The function extracts from the file f the data section of an image encoded in PGM format. The function fills the buffer data according. The buffer data should be vl_pgm_get_npixels() by vl_pgm_get_bpp() bytes large.

int vl_pgm_extract_head ( FILE *  f,
VlPgmImage im 
)
Parameters:
finput file.
imimage structure to fill.
Returns:
error code.

The function extracts from the file f the meta-data section of an image encoded in PGM format. The function fills the structure VlPgmImage accordingly.

The error may be either VL_ERR_PGM_INV_HEAD or VL_ERR_PGM_INV_META depending whether the error occurred in decoding the header or meta section of the PGM file.

vl_size vl_pgm_get_bpp ( VlPgmImage const *  im)
Parameters:
imPGM image descriptor.
Returns:
number of bytes per pixel.

The function returns the number of bytes for each pixel of the PGM image im.

vl_size vl_pgm_get_npixels ( VlPgmImage const *  im)
Parameters:
imPGM image descriptor.
Returns:
number of pixels of the image.

The functions returns the number of pixels of the PGM image im.

To calculate the image data size in bytes, this value must be multiplied by the number of byte per pixels (see vl_pgm_get_bpp()).

int vl_pgm_insert ( FILE *  f,
VlPgmImage const *  im,
void const *  data 
)
Parameters:
foutput file.
imPGM image meta-data.
dataimage data.
Returns:
error code.
int vl_pgm_read_new ( char const *  name,
VlPgmImage im,
vl_uint8 **  data 
)
Parameters:
namefile name.
ima pointer to the PGM image structure to fill.
dataa pointer to the pointer to the allocated buffer.
Returns:
error code.

The function reads a PGM image from file name and initializes the structure im and the buffer data accordingly.

The ownership of the buffer data is transfered to the caller. data should be freed by means of vl_free().

Bug:
Only PGM files with 1 BPP are supported.
int vl_pgm_read_new_f ( char const *  name,
VlPgmImage im,
float **  data 
)
Parameters:
namefile name.
ima pointer to the PGM image structure to fill.
dataa pointer to the pointer to the allocated buffer.
Returns:
error code.

The function reads a PGM image from file name and initializes the structure im and the buffer data accordingly. The buffer data is an array of floats in the range [0, 1].

The ownership of the buffer data is transfered to the caller. data should be freed by means of vl_free().

Bug:
Only PGM files with 1 BPP are supported.
int vl_pgm_write ( char const *  name,
vl_uint8 const *  data,
int  width,
int  height 
)
Parameters:
namefile name.
datadata to write.
widthwidth of the image.
heightheight of the image.
Returns:
error code.

The function dumps the image data to the PGM file of the specified name. This is an helper function simplifying the usage of vl_pgm_insert().

int vl_pgm_write_f ( char const *  name,
float const *  data,
int  width,
int  height 
)
Parameters:
namefile name.
datadata to write.
widthwidth of the image.
heightheight of the image.
Returns:
error code.

The function dumps the image data to the PGM file of the specified name. The data is re-scaled to fit in the range 0-255. This is an helper function simplifying the usage of vl_pgm_insert().