struct pam¶

The main argument to most of the PAM functions is the address of a pam structure, which is defined as follows:

  


    struct pam {


        int size


        int len


        FILE *file   


        int format


        int plainformat


        int height


        int width


        int depth


        sample maxval


        int bytes_per_sample


        char tuple_type[256]


        int allocation_depth


        char **comment_p;


    }


    

See The Libnetbm User's Guide for information on the pam structure.

Memory Management¶

Synopsis

tuple ** pnm_allocpamarray( struct pam *pamP);

tuple * pnm_allocpamrow( struct pam *pamP);

void pnm_freepamarray( tuple **tuplearray, struct pam *pamP);

void pnm_freepamrow( tuple *tuplerow);

tuple * allocpamtuple( struct pam *pamP);

void pnm_freepamtuple( tuple tuple );

tuple * allocpamtuplen( struct pam *pamP);

tuplen * pnm_allocpamrown( struct pam *pamP);

void pnm_freepamrown( tuplen *tuplenrow);

Description

pnm_allocpamtuple allocates space for a tuple.
pnm_freepamtuple frees space allocated for a tuple.

pnm_allocpamarray() allocates space for an array of tuples. pnm_freepamarray() frees an array space allocated by pnm_allocpamarray() or pnm_readpam().

pnm_allocpamtuplen is the same as pnm_allocpamtuple except that it allocates space for a tuple in the normalized form. pnm_freepamtuplen is similarly like pnm_freepamtuple.

pnm_allocpamrow() allocates space for a row of a PAM image, in basic form. pnm_freepamrow() frees it.

pnm_allocpamrown() is the same as pnm_allocpamrow() except that it allocates space for a PAM row in the normalized form. pnm_freepamrown() is similarly like pnm_freepamrow.

Reading Netpbm Files¶

Synopsis

void pnm_readpaminit( FILE *file, struct pam *pamP, int size);

void pnm_readpamrow( struct pam *pamP, tuple *tuplerow);

tuple ** pnm_readpam( FILE *file, struct pam *pamP, int size);

void pnm_readpamrown( struct pam *pamP, tuplen *tuplenrow);

Description

pnm_readpaminit() reads the header of a Netpbm image.

See above for a general description of the pamP argument.

pnm_readpaminit() returns the information from the header in the *pamP structure. It does not require any members of *pamP through tuple_type to be set at invocation, and sets all of those members. It expects all members after tuple_type to be meaningful.

size is the size of the *pamP structure as understood by the program processing the image. pnm_readpaminit() does not attempt to use or set any members of the structure beyond that. The point of this argument is that the definition of the structure may change over time, with additional fields being added to the end. This argument allows pnm_readpaminit to distinguish between a new program that wants to exploit the additional features and an old program that cannot (or a new program that just doesn't want to deal with the added complexity). At a minimum, this size must contain the members up through tuple_type. You should use the PAM_STRUCT_SIZE macro to compute this argument. E.g. PAM_STRUCT_SIZE(tuple_type).

PAM_STRUCT_SIZE was introduced in Netpbm 10.23 (July 2004). In older Netpbm, you can just use sizeof(), but then your code is not forward compatible at the source code level with newer libnetpbm (because when you compile it with newer libnetpbm header files, you'll be saying your structure contains all the new members that have been invented, but your code doesn't actually initialize them). So you might want to compute a proper size yourself.

The function expects to find the image file positioned to the start of the header and leaves it positioned to the start of the raster.

pnm_readpamrow() reads a row of the raster from a Netpbm image file. It expects all of the members of the *pamP structure to be set upon invocation and does not modify any of them. It expects to find the file positioned to the start of the row in question in the raster and leaves it positioned just after it. It returns the row as the array of tuples tuplerow, which must already have its column pointers set up so that it forms a C 2-dimensional array. The leftmost tuple is Element 0 of this array.

pnm_readpam() reads an entire image from a PAM or PNM image file and allocates the space in which to return the raster. It expects to find the file positioned to the first byte of the image and leaves it positioned just after the image.

*pamP is the same as for pnm_readpaminit().

The return value is a newly allocated array of the rows of the image, with the top row being Element 0 of the array. Each row is represented as pnm_readpamrow() would return.

The return value is also effectively a 3-dimensional C array of samples, with the dimensions corresponding to the height, width, and depth of the image, in that order.

pnm_readpam() combines the functions of pnm_allocpamarray(), pnm_readpaminit(), and iterations of pnm_readpamrow(). It may require more dynamic storage than you can afford.

pnm_readpamrown() is like pnm_readpamrow() except that it returns the row contents in normalized form (composed of normalized tuples (tuplen) instead of basic form (tuple).

pnm_readpaminit() and pnm_readpam abort the program with a message to Standard Error if the PAM or PNM image header is not syntactically valid, including if it contains a number too large to be processed using the system's normal data structures (to wit, a number that won't fit in a C 'int').

Writing Netpbm Files¶

Synopsis

void pnm_writepaminit( struct pam *pamP);

void pnm_writepamrow( struct pam *pamP, const tuple *tuplerow);

void pnm_writepam( struct pam *pamP, const tuple * const *tuplearray);

void pnm_writepamrown( struct pam *pamP, const tuplen *tuplerown);

void pnm_formatpamrow( struct pam *pamP, const tuple *tuplerow unsigned char * const outbuf, unsigned int * const rowSizeP );

Description

pnm_writepaminit() writes the header of a PAM or PNM image and computes some of the fields of the pam structure.

See above for a description of the pamP argument.

The following members of the *pamP structure must be set upon invocation to tell the function how and what to write. size, len, file, format, height, width, depth, maxval. Furthermore, if format is PAM_FORMAT, tuple_type must be set and if format is not PAM_FORMAT, plainformat must be set.

pnm_writepaminit() sets the bytes_per_sample member based on the information supplied.

pnm_writepamrow() writes a row of the raster into a PAM or PNM image file. It expects to find the file positioned where the row should start and leaves it positioned just after the row. The function requires all the elements of *pamP to be set upon invocation and doesn't modify them.

tuplerow is an array of tuples representing the row. The leftmost tuple is Element 0 of this array.

pnm_writepam() writes an entire PAM or PNM image to a PAM or PNM image file. It expects to find the file positioned to where the image should start and leaves it positioned just after the image.

The members of the *pamP structure that must be set up invocation, and their meanings, is the same as for pnm_writepaminit.

pnm_writepam() sets the bytes_per_sample member based on the information supplied.

tuplearray is an array of rows such that you would pass to pnm_writepamrow(), with the top row being Element 0 of the array.

pnm_writepam() combines the functions of pnm_writepaminit(), and iterations of pnm_writepamrow(). Its raster input may be more storage than you can afford.

pnm_writepamrown() is like pnm_writepamrow() except that it takes the row contents in normalized form (composed of normalized tuples (tuplen) instead of basic form (tuple).

pnm_formatpamrow() is like pnm_writepamrow(), except that instead of writing a row to a file, it places the same bytes that would go in the file in a buffer you supply. There isn't an equivalent function to construct an image header; i.e. there is no analog to pnm_writepaminit(). But the header format, particularly for PAM, is so simple that you can easily build it yourself with standard C library string functions.

pnm_formatpamrow() was new in Netpbm 10.25 (October 2004).

Transforming Pixels¶

Synopsis

void pnm_YCbCrtuple( tuple tuple, double *YP, double *CrP, double *CbP);

void pnm_YCbCr_to_rgbtuple( const struct pam * const pamP, tuple const tuple, double const Y, double const Cb, double const Cr, int * const overflowP);

extern double pnm_lumin_factor[3];

void pnm_normalizetuple( struct pam * const pamP, tuple const tuple, tuplen const tuplen);

void pnm_unnormalizetuple( struct pam * const pamP, tuplen const tuplen, tuple const tuple);

void pnm_normalizeRow( struct pam * const pamP, const tuple * const tuplerow, pnm_transformMap * const transform, tuplen * const tuplenrow);

void pnm_unnormalizeRow( struct pam * const pamP, const tuplen * const tuplenrow, pnm_transformMap * const transform, tuple * const tuplerow);

void pnm_gammarown( struct pam * const pamP, tuplen * const row);

void pnm_ungammarown( struct pam * const pamP, tuplen * const row);

void pnm_applyopacityrown( struct pam * const pamP, tuplen * const tuplenrow);

void pnm_unapplyopacityrown( struct pam * const pamP, tuplen * const tuplenrow);

pnm_transformMap * pnm_creategammatransform( const struct pam * const pamP);

void pnm_freegammatransform( const pnm_transformMap * const transform, const struct pam * const pamP);

pnm_transformMap * pnm_createungammatransform( const struct pam * const pamP);

void pnm_freeungammatransform( const pnm_transformMap * const transform, const struct pam * const pamP);

Description

pnm_YCbCrtuple() returns the Y/Cb/Cr luminance/chrominance representation of the color represented by the input tuple, assuming that the tuple is an RGB color representation (which is the case if it was read from a PPM image). The output components are based on the same scale (maxval) as the input tuple, but are floating point nonetheless to avoid losing information because of rounding. Divide them by the maxval to get normalized [0..1] values.

pnm_YCbCr_to_rgbtuple() does the reverse. pamP indicates the maxval for the returned tuple, and the Y, Cb, and Cr arguments are of the same scale.

It is possible for Y, Cb, and Cr to describe a color that cannot be represented in RGB form. In that case, pnm_YCbCr_to_rgbtuple() chooses a color as close as possible (by clipping each component to 0 and the maxval) and sets *overflowP true. It otherwise sets *overflowP false.

pnm_lumin_factor[] is the factors (weights) one uses to compute the intensity of a color (according to some standard -- I don't know which). pnm_lumin_factor[0] is for the red component, [1] is for the green, and [2] is for the blue. They add up to 1.

pnm_gammarown() and pnm_ungammarown() apply and unapply gamma correction to a row of an image using the same transformation as pm_gamma709() and pm_ungamma709() . Note that these operate on a row of normalized tuples (tuplen, not tuple).

pnm_applyopacityrown() reduces the intensity of samples in accordance with the opacity plane of an image. The opacity plane, if it exists, tells how much of the light from that pixel should show when the image is composed with another image. You use pnm_applyopacityrown() in preparation for doing such a composition. For example, if the opacity plane says that the left half of the image is 50% opaque and the right half 100% opaque, pnm_applyopacityrown() will reduce the intensity of each sample of each tuple (pixel) in the left half of the image by 50%, and leave the rest alone.

If the image does not have an opacity plane (i.e. its tuple type is not one that libnetpbm recognizes as having an opacity plane), pnm_applyopacityrown() does nothing (which is the same as assuming opacity 100%). The tuple types that libnetpbm recognizes as having opacity are RGB_ALPHA and GRAYSCALE_ALPHA.

pnm_unapplyopacityrown() does the reverse. It assumes the intensities are already reduced according to the opacity plane, and raises back to normal.

pnm_applyopacityrown() works on (takes as input and produces as output) normalized, intensity-proportional tuples. That means you will typically read the row from the image file with pnm_readpamrown() and then gamma-correct it with pnm_ungammarown(), and then do pnm_applyopacityrown(). You then manipulate the row further (perhaps add it with other rows you've processed similarly), then do pnm_unapplyopacityrown(), then pnm_gammarown(), then pnm_writepamrown().

pnm_applyopacityrown() and pnm_unapplyopacityrown() were new in Netpbm 10.25 (October 2004).

pnm_normalizetuple() and pnm_unnormalizetuple() convert between a tuple data type and a tuplen data type. The former represents a sample value using the same unsigned integer that is in the PAM image, while the latter represents a sample value as a number scaled by the maxval to the range 0..1. I.e. pnm_normalizetuple() divides every sample value by the maxval and pnm_unnormalizetuple() multiples every sample by the maxval.

pnm_normalizeRow() and pnm_unnormalizeRow() do the same thing on an entire tuple row, but also have an extra feature: You can specify a transform function to be applied in addition. Typically, this is a gamma transform function. You can of course more easily apply your transform function separately from normalizing, but doing it all at once is usually way faster. Why? Because you can use a lookup table that is indexed by an integer on one side and produces a floating point number on the other. To do it separately, you'd either have to do floating point arithmetic on the normalized value or do the transform on the integer values and lose a lot of precision.

If you don't have any transformation to apply, just specify NULL for the transform argument and the function will just normalize (i.e. divide or multiply by the maxval).

Here's an example of doing a transformation. The example composes two images together, something that has to be done with intensity-linear sample values.

pnm_transformMap * const transform1 = pnm_createungammatransform(&inpam1);
pnm_transformMap * const transform2 = pnm_createungammatransform(&inpam2);
pnm_transformMap * const transformOut = pnm_creategammatransform(&outpam);
pnm_readpamrow(&inpam1, inrow1);
pnm_readpamrow(&inpam2, inrow2);
pnm_normalizeRow(&inpam1, inrow1, transform1, normInrow1);
pnm_normalizeRow(&inpam2, inrow2, transform2, normInrow2);
for (col = 0; col < outpam.width; ++col)


    normOutrow[col] = (normInrow1[col] + normInrow2[col])/2;
pnm_unnormalizeRow(&outpam, normOutrow, transformOut, outrow);
pnm_writepamrow(&outpam, outrow);

To specify a transform, you must create a special pnm_transformMap object and pass it as the transform argument. Typically, your transform is a gamma transformation because you want to work in intensity-proportional sample values and the PAM image format uses gamma-adjusted ones. In that case, just use pnm_creategammatransform() and pnm_createungammatransform() to create this object and don't worry about what's inside it.

pnm_creategammatransform() and pnm_createungammatransform() create objects that you use with pnm_normalizeRow() and pnm_unnormalizeRow() as described above. The created object describes a transform that applies or reverses the ITU-R Recommendation BT.709 gamma adjustment that is used in PAM visual images and normalizes or unnormalizes the sample values.

pnm_freegammatransform() and pnm_freeungammatransform() destroy the objects.

Color specification¶

These are functions you use that deal with names or identifiers for colors.

Synopsis

tuple pnm_parsecolor( const char * colorname, sample maxval );

tuple pnm_parsecolor2( const char * colorname, sample maxval, int closeOk );

tuplen pnm_parsecolorn( const char * colorname );

pnm_colorspec_rgb_integer( struct pam * pamP, tuple color, sample maxval );

pnm_colorspec_rgb_norm( struct pam * pamP, tuple color unsigned int digitCt );

pnm_colorspec_rgb_x11( struct pam * pamP, tuple color, unsigned int hexDigitCt );

pnm_colorspec_dict( struct pam * pamP, tuple color );

pnm_colorspec_dict_close( struct pam * pamP, tuple color );

Description

pnm_parsecolor, pnm_parsecolor2, and pnm_parsecolorn return a color in the conventional form used by libnetpbm to represent a color, given a human-intelligible name for the color such as 'red' or 'rgbi:1.0/0.5/0.25'.

pnm_parsecolorn returns a normalized tuple (type tuplen), whereas pnm_parsecolor and pnm_parsecolor2 return a tuple that
uses an integer scale with a specified maxval.

When you use an integer scale, only certain discrete colors can be represented, so the functions may round. For example, 'wheat' which is 245/222/179 with maxval 255, cannot be represented exactly with maxval 15, so if you call pnm_parsecolor to produce a wheat color tuple with maxval 15, you get 14/13/11, which is not quite the same. With pnm_parsecolor2, you get a warning message to Standard Error when such rounding occurs, unless you specify closeOk = true. pnm_parsecolor never warns about this.

pnm_colorspec_rgb_integer returns the color specification for the color color in integer/maxval form like 'rgb-255:0/128/254'. maxval is the maxval to be used in the color specification (255 in this example);

pnm_colorspec_rgb_norm returns the color specification for the color color in normalized form like 'rgbi:0.000/0.052/0.996'. digitCt is the number of digits after the decimal point (3 in this example). The function rounds and zero-fills as necessary.

pnm_colorspec_rgb_x11 returns the color specification for the color color in X11 form like 'rgb:00/80/fe'. hexDigitCt is the number of hexadecimal digits to use for each component (2 in this example). The function rounds and zero-fills as necessary.

pnm_colorspec_dict returns the color specification for the color color as name such as 'pink' from the color dictionary. If the color is not in the dictionary, including where the function does not find a color dictionary file, the return value is null.

pnm_colorspect_dict_close is the same as pnm_colorspec_dict except that when the color is not in the dictionary, it returns the closest color to it that is in the dictionary. As an exception, if the function cannot find a color dictionary file or the file it finds does not contain even a single color definition, the function returns a null string.

Color name

Color names in Netpbm are ASCII text in one of the formats described below. This is what you use for the colorname argument of functions such as pnm_parsecolor and is the return value of functions such as pnm_colorspec_rgb_norm.

• a name, as defined in the system color dictionary .

• 
  An X11-style hexadecimal specifier: rgb:r/g/b, where r, g, and b are each 1- to 4-digit hexadecimal numbers. For each, the maxval is the maximum number that can be represented in the number of hexadecimal digits given. Example: rgb:01/ff/8000 specifies 1/255 red intensity, maximum green intensity, and about half blue intensity.

• 
  An X11-style decimal specifier: rgbi:r/g/b, where r, g, and b are floating point numbers from 0 to 1. Example: rgbi:1.0/0.5/.25.

• rgb-maxval:r/g/b, where r, g, and b are decimal integers from 0 to maxval. Example: rgb-255:255/128/64. maxval can be from 1 to 65535.

  This format was new in Netpbm 10.83 (June 2018).

• an old-X11-style hexadecimal triple: #rgb, #rrggbb, #rrrgggbbb, or #rrrrggggbbbb.

• A triplet of decimal floating point numbers from 0.0 to 1.0, representing red, green, and blue intensities respectively, separated by commas. Example: 1.0,0.5,.25. This is for backwards compatibility; it was in use before MIT came up with the similar and preferred rgbi style).

If colorname does not conform to any of these formats, including the case that it is a name, but is not in the system color dictionary, pnm_parsecolor() throws an error(1).

Miscellaneous¶

Synopsis

void pnm_checkpam( struct pam *pamP, const enum pm_check_type check_type, enum pm_check_code *retvalP);

void pnm_nextimage( FILE *file, int * const eofP);

Description

pnm_checkpam() checks for the common file integrity error where the file is the wrong size to contain the raster, according to the information in the header.

pnm_nextimage()positions a Netpbm image input file to the next image in it (so that a subsequent pnm_readpaminit() reads its header).