515 lines
12 KiB
C
515 lines
12 KiB
C
/* save to ppm
|
|
*
|
|
* 2/12/11
|
|
* - wrap a class around the ppm writer
|
|
* 13/11/19
|
|
* - redone with targets
|
|
* 18/6/20
|
|
* - add "bitdepth" param, cf. tiffsave
|
|
*/
|
|
|
|
/*
|
|
|
|
This file is part of VIPS.
|
|
|
|
VIPS is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA
|
|
|
|
*/
|
|
|
|
/*
|
|
|
|
These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
|
|
|
|
*/
|
|
|
|
/*
|
|
#define DEBUG_VERBOSE
|
|
#define DEBUG
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include <config.h>
|
|
#endif /*HAVE_CONFIG_H*/
|
|
#include <vips/intl.h>
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
#include <vips/vips.h>
|
|
#include <vips/internal.h>
|
|
|
|
#include "pforeign.h"
|
|
|
|
#ifdef HAVE_PPM
|
|
|
|
typedef struct _VipsForeignSavePpm VipsForeignSavePpm;
|
|
|
|
typedef int (*VipsSavePpmFn)( VipsForeignSavePpm *, VipsImage *, VipsPel * );
|
|
|
|
typedef struct _VipsForeignSavePpm {
|
|
VipsForeignSave parent_object;
|
|
|
|
VipsTarget *target;
|
|
gboolean ascii;
|
|
int bitdepth;
|
|
|
|
VipsSavePpmFn fn;
|
|
|
|
/* Deprecated.
|
|
*/
|
|
gboolean squash;
|
|
} VipsForeignSavePpm;
|
|
|
|
typedef VipsForeignSaveClass VipsForeignSavePpmClass;
|
|
|
|
G_DEFINE_ABSTRACT_TYPE( VipsForeignSavePpm, vips_foreign_save_ppm,
|
|
VIPS_TYPE_FOREIGN_SAVE );
|
|
|
|
static void
|
|
vips_foreign_save_ppm_dispose( GObject *gobject )
|
|
{
|
|
VipsForeignSavePpm *ppm = (VipsForeignSavePpm *) gobject;
|
|
|
|
if( ppm->target )
|
|
vips_target_finish( ppm->target );
|
|
VIPS_UNREF( ppm->target );
|
|
|
|
G_OBJECT_CLASS( vips_foreign_save_ppm_parent_class )->
|
|
dispose( gobject );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm_line_ascii( VipsForeignSavePpm *ppm,
|
|
VipsImage *image, VipsPel *p )
|
|
{
|
|
const int n_elements = image->Xsize * image->Bands;
|
|
|
|
int i;
|
|
|
|
for( i = 0; i < n_elements; i++ ) {
|
|
switch( image->BandFmt ) {
|
|
case VIPS_FORMAT_UCHAR:
|
|
vips_target_writef( ppm->target,
|
|
"%d ", p[i] );
|
|
break;
|
|
|
|
case VIPS_FORMAT_USHORT:
|
|
vips_target_writef( ppm->target,
|
|
"%d ", ((unsigned short *) p)[i] );
|
|
break;
|
|
|
|
case VIPS_FORMAT_UINT:
|
|
vips_target_writef( ppm->target,
|
|
"%d ", ((unsigned int *) p)[i] );
|
|
break;
|
|
|
|
default:
|
|
g_assert_not_reached();
|
|
}
|
|
}
|
|
|
|
if( vips_target_writes( ppm->target, "\n" ) )
|
|
return( -1 );
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm_line_ascii_1bit( VipsForeignSavePpm *ppm,
|
|
VipsImage *image, VipsPel *p )
|
|
{
|
|
int x;
|
|
|
|
for( x = 0; x < image->Xsize; x++ )
|
|
vips_target_writef( ppm->target, "%d ", p[x] ? 0 : 1 );
|
|
|
|
if( vips_target_writes( ppm->target, "\n" ) )
|
|
return( -1 );
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm_line_binary( VipsForeignSavePpm *ppm,
|
|
VipsImage *image, VipsPel *p )
|
|
{
|
|
if( vips_target_write( ppm->target,
|
|
p, VIPS_IMAGE_SIZEOF_LINE( image ) ) )
|
|
return( -1 );
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm_line_binary_1bit( VipsForeignSavePpm *ppm,
|
|
VipsImage *image, VipsPel *p )
|
|
{
|
|
int x;
|
|
int bits;
|
|
int n_bits;
|
|
|
|
bits = 0;
|
|
n_bits = 0;
|
|
for( x = 0; x < image->Xsize; x++ ) {
|
|
bits = VIPS_LSHIFT_INT( bits, 1 );
|
|
n_bits += 1;
|
|
bits |= p[x] > 128 ? 0 : 1;
|
|
|
|
if( n_bits == 8 ) {
|
|
if( VIPS_TARGET_PUTC( ppm->target, bits ) )
|
|
return( -1 );
|
|
|
|
bits = 0;
|
|
n_bits = 0;
|
|
}
|
|
}
|
|
|
|
/* Flush any remaining bits in this line.
|
|
*/
|
|
if( n_bits &&
|
|
VIPS_TARGET_PUTC( ppm->target, bits ) )
|
|
return( -1 );
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm_block( VipsRegion *region, VipsRect *area, void *a )
|
|
{
|
|
VipsForeignSavePpm *ppm = (VipsForeignSavePpm *) a;
|
|
VipsImage *image = region->im;
|
|
|
|
int y;
|
|
|
|
for( y = 0; y < area->height; y++ ) {
|
|
VipsPel *p = VIPS_REGION_ADDR( region, 0, area->top + y );
|
|
|
|
if( ppm->fn( ppm, image, p ) )
|
|
return( -1 );
|
|
}
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm( VipsForeignSavePpm *ppm, VipsImage *image )
|
|
{
|
|
char *magic;
|
|
char *date;
|
|
|
|
magic = "unset";
|
|
if( image->BandFmt == VIPS_FORMAT_FLOAT &&
|
|
image->Bands == 3 )
|
|
magic = "PF";
|
|
else if( image->BandFmt == VIPS_FORMAT_FLOAT &&
|
|
image->Bands == 1 )
|
|
magic = "Pf";
|
|
else if( image->Bands == 1 &&
|
|
ppm->ascii &&
|
|
ppm->bitdepth )
|
|
magic = "P1";
|
|
else if( image->Bands == 1 &&
|
|
ppm->ascii )
|
|
magic = "P2";
|
|
else if( image->Bands == 1 &&
|
|
!ppm->ascii &&
|
|
ppm->bitdepth )
|
|
magic = "P4";
|
|
else if( image->Bands == 1 &&
|
|
!ppm->ascii )
|
|
magic = "P5";
|
|
else if( image->Bands == 3 &&
|
|
ppm->ascii )
|
|
magic = "P3";
|
|
else if( image->Bands == 3 &&
|
|
!ppm->ascii )
|
|
magic = "P6";
|
|
else
|
|
g_assert_not_reached();
|
|
|
|
vips_target_writef( ppm->target, "%s\n", magic );
|
|
date = vips__get_iso8601();
|
|
vips_target_writef( ppm->target,
|
|
"#vips2ppm - %s\n", date );
|
|
g_free( date );
|
|
vips_target_writef( ppm->target,
|
|
"%d %d\n", image->Xsize, image->Ysize );
|
|
|
|
if( !ppm->bitdepth )
|
|
switch( image->BandFmt ) {
|
|
case VIPS_FORMAT_UCHAR:
|
|
vips_target_writef( ppm->target,
|
|
"%d\n", UCHAR_MAX );
|
|
break;
|
|
|
|
case VIPS_FORMAT_USHORT:
|
|
vips_target_writef( ppm->target,
|
|
"%d\n", USHRT_MAX );
|
|
break;
|
|
|
|
case VIPS_FORMAT_UINT:
|
|
vips_target_writef( ppm->target,
|
|
"%d\n", UINT_MAX );
|
|
break;
|
|
|
|
case VIPS_FORMAT_FLOAT:
|
|
{
|
|
double scale;
|
|
char buf[G_ASCII_DTOSTR_BUF_SIZE];
|
|
|
|
if( vips_image_get_double( image,
|
|
"pfm-scale", &scale ) )
|
|
scale = 1;
|
|
if( !vips_amiMSBfirst() )
|
|
scale *= -1;
|
|
/* Need to be locale independent.
|
|
*/
|
|
g_ascii_dtostr( buf, G_ASCII_DTOSTR_BUF_SIZE, scale );
|
|
vips_target_writes( ppm->target, buf );
|
|
}
|
|
break;
|
|
|
|
default:
|
|
g_assert_not_reached();
|
|
}
|
|
|
|
if( ppm->bitdepth )
|
|
ppm->fn = ppm->ascii ?
|
|
vips_foreign_save_ppm_line_ascii_1bit :
|
|
vips_foreign_save_ppm_line_binary_1bit;
|
|
else
|
|
ppm->fn = ppm->ascii ?
|
|
vips_foreign_save_ppm_line_ascii :
|
|
vips_foreign_save_ppm_line_binary;
|
|
|
|
if( vips_sink_disc( image, vips_foreign_save_ppm_block, ppm ) )
|
|
return( -1 );
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
static int
|
|
vips_foreign_save_ppm_build( VipsObject *object )
|
|
{
|
|
VipsForeignSave *save = (VipsForeignSave *) object;
|
|
VipsForeignSavePpm *ppm = (VipsForeignSavePpm *) object;
|
|
|
|
VipsImage *image;
|
|
|
|
if( VIPS_OBJECT_CLASS( vips_foreign_save_ppm_parent_class )->
|
|
build( object ) )
|
|
return( -1 );
|
|
|
|
/* Handle the deprecated squash parameter.
|
|
*/
|
|
if( vips_object_argument_isset( object, "squash" ) )
|
|
ppm->bitdepth = 1;
|
|
|
|
image = save->ready;
|
|
if( vips_check_uintorf( "vips2ppm", image ) ||
|
|
vips_check_bands_1or3( "vips2ppm", image ) ||
|
|
vips_check_uncoded( "vips2ppm", image ) ||
|
|
vips_image_pio_input( image ) )
|
|
return( -1 );
|
|
|
|
if( ppm->ascii &&
|
|
image->BandFmt == VIPS_FORMAT_FLOAT ) {
|
|
g_warning( "%s",
|
|
_( "float images must be binary -- disabling ascii" ) );
|
|
ppm->ascii = FALSE;
|
|
}
|
|
|
|
/* One bit images must come from a 8 bit, one band source.
|
|
*/
|
|
if( ppm->bitdepth &&
|
|
(image->Bands != 1 ||
|
|
image->BandFmt != VIPS_FORMAT_UCHAR) ) {
|
|
g_warning( "%s",
|
|
_( "can only save 1 band uchar images as 1 bit -- "
|
|
"disabling 1 bit save" ) );
|
|
ppm->bitdepth = 0;
|
|
}
|
|
|
|
if( vips_foreign_save_ppm( ppm, image ) )
|
|
return( -1 );
|
|
|
|
return( 0 );
|
|
}
|
|
|
|
/* Save a bit of typing.
|
|
*/
|
|
#define UC VIPS_FORMAT_UCHAR
|
|
#define C VIPS_FORMAT_CHAR
|
|
#define US VIPS_FORMAT_USHORT
|
|
#define S VIPS_FORMAT_SHORT
|
|
#define UI VIPS_FORMAT_UINT
|
|
#define I VIPS_FORMAT_INT
|
|
#define F VIPS_FORMAT_FLOAT
|
|
#define X VIPS_FORMAT_COMPLEX
|
|
#define D VIPS_FORMAT_DOUBLE
|
|
#define DX VIPS_FORMAT_DPCOMPLEX
|
|
|
|
static int bandfmt_ppm[10] = {
|
|
/* UC C US S UI I F X D DX */
|
|
UC, UC, US, US, UI, UI, F, F, F, F
|
|
};
|
|
|
|
static void
|
|
vips_foreign_save_ppm_class_init( VipsForeignSavePpmClass *class )
|
|
{
|
|
GObjectClass *gobject_class = G_OBJECT_CLASS( class );
|
|
VipsObjectClass *object_class = (VipsObjectClass *) class;
|
|
VipsForeignClass *foreign_class = (VipsForeignClass *) class;
|
|
VipsForeignSaveClass *save_class = (VipsForeignSaveClass *) class;
|
|
|
|
gobject_class->dispose = vips_foreign_save_ppm_dispose;
|
|
gobject_class->set_property = vips_object_set_property;
|
|
gobject_class->get_property = vips_object_get_property;
|
|
|
|
object_class->nickname = "ppmsave_base";
|
|
object_class->description = _( "save to ppm" );
|
|
object_class->build = vips_foreign_save_ppm_build;
|
|
|
|
foreign_class->suffs = vips__ppm_suffs;
|
|
|
|
save_class->saveable = VIPS_SAVEABLE_RGB;
|
|
save_class->format_table = bandfmt_ppm;
|
|
|
|
VIPS_ARG_BOOL( class, "ascii", 10,
|
|
_( "ASCII" ),
|
|
_( "save as ascii" ),
|
|
VIPS_ARGUMENT_OPTIONAL_INPUT,
|
|
G_STRUCT_OFFSET( VipsForeignSavePpm, ascii ),
|
|
FALSE );
|
|
|
|
VIPS_ARG_INT( class, "bitdepth", 15,
|
|
_( "bitdepth" ),
|
|
_( "Write as a 1 bit image" ),
|
|
VIPS_ARGUMENT_OPTIONAL_INPUT,
|
|
G_STRUCT_OFFSET( VipsForeignSavePpm, bitdepth ),
|
|
0, 1, 0 );
|
|
|
|
VIPS_ARG_BOOL( class, "squash", 11,
|
|
_( "Squash" ),
|
|
_( "save as one bit" ),
|
|
VIPS_ARGUMENT_OPTIONAL_INPUT | VIPS_ARGUMENT_DEPRECATED,
|
|
G_STRUCT_OFFSET( VipsForeignSavePpm, squash ),
|
|
FALSE );
|
|
|
|
}
|
|
|
|
static void
|
|
vips_foreign_save_ppm_init( VipsForeignSavePpm *ppm )
|
|
{
|
|
}
|
|
|
|
typedef struct _VipsForeignSavePpmFile {
|
|
VipsForeignSavePpm parent_object;
|
|
|
|
char *filename;
|
|
} VipsForeignSavePpmFile;
|
|
|
|
typedef VipsForeignSavePpmClass VipsForeignSavePpmFileClass;
|
|
|
|
G_DEFINE_TYPE( VipsForeignSavePpmFile, vips_foreign_save_ppm_file,
|
|
vips_foreign_save_ppm_get_type() );
|
|
|
|
static int
|
|
vips_foreign_save_ppm_file_build( VipsObject *object )
|
|
{
|
|
VipsForeignSavePpm *ppm = (VipsForeignSavePpm *) object;
|
|
VipsForeignSavePpmFile *file = (VipsForeignSavePpmFile *) object;
|
|
|
|
if( file->filename &&
|
|
!(ppm->target = vips_target_new_to_file( file->filename )) )
|
|
return( -1 );
|
|
|
|
return( VIPS_OBJECT_CLASS( vips_foreign_save_ppm_file_parent_class )->
|
|
build( object ) );
|
|
}
|
|
|
|
static void
|
|
vips_foreign_save_ppm_file_class_init( VipsForeignSavePpmFileClass *class )
|
|
{
|
|
GObjectClass *gobject_class = G_OBJECT_CLASS( class );
|
|
VipsObjectClass *object_class = (VipsObjectClass *) class;
|
|
|
|
gobject_class->set_property = vips_object_set_property;
|
|
gobject_class->get_property = vips_object_get_property;
|
|
|
|
object_class->nickname = "ppmsave";
|
|
object_class->description = _( "save image to ppm file" );
|
|
object_class->build = vips_foreign_save_ppm_file_build;
|
|
|
|
VIPS_ARG_STRING( class, "filename", 1,
|
|
_( "Filename" ),
|
|
_( "Filename to save to" ),
|
|
VIPS_ARGUMENT_REQUIRED_INPUT,
|
|
G_STRUCT_OFFSET( VipsForeignSavePpmFile, filename ),
|
|
NULL );
|
|
|
|
}
|
|
|
|
static void
|
|
vips_foreign_save_ppm_file_init( VipsForeignSavePpmFile *file )
|
|
{
|
|
}
|
|
|
|
#endif /*HAVE_PPM*/
|
|
|
|
/**
|
|
* vips_ppmsave: (method)
|
|
* @in: image to save
|
|
* @filename: file to write to
|
|
* @...: %NULL-terminated list of optional named arguments
|
|
*
|
|
* Optional arguments:
|
|
*
|
|
* * @ascii: save as ASCII rather than binary
|
|
* * @squash: squash 8-bit images down to one bit
|
|
*
|
|
* Write a VIPS image to a file as PPM. It can write 1, 8, 16 or
|
|
* 32 bit unsigned integer images, float images, colour or monochrome,
|
|
* stored as binary or ASCII.
|
|
* Integer images of more than 8 bits can only be stored in ASCII.
|
|
*
|
|
* When writing float (PFM) images the scale factor is set from the
|
|
* "pfm-scale" metadata.
|
|
*
|
|
* Set @ascii to %TRUE to write as human-readable ASCII. Normally data is
|
|
* written in binary.
|
|
*
|
|
* Set @squash to %TRUE to squash 8-bit images down to one bit. The saver does
|
|
* no dithering, that's up to you.
|
|
*
|
|
* See also: vips_image_write_to_file().
|
|
*
|
|
* Returns: 0 on success, -1 on error.
|
|
*/
|
|
int
|
|
vips_ppmsave( VipsImage *in, const char *filename, ... )
|
|
{
|
|
va_list ap;
|
|
int result;
|
|
|
|
va_start( ap, filename );
|
|
result = vips_call_split( "ppmsave", ap, in, filename );
|
|
va_end( ap );
|
|
|
|
return( result );
|
|
}
|