blob: d5f61605aa4bfb5458c9fa1a8226cf3b1ba65654 [file] [log] [blame]
/* im_extract
*
* Copyright: 1990, J. Cupitt
*
* Author: J. Cupitt
* Written on: 12/02/1990
* Modified on: 4/6/92, J.Cupitt
* - speed up! why wasn't this done before? Why am I stupid?
* - layout, messages fixed
* now extracts IM_CODING_LABQ to IM_CODING_LABQ file: K.Martinez 1/7/93
* 2/7/93 JC
* - adapted for partial v2
* - ANSIfied
* 7/7/93 JC
* - behaviour for IM_CODING_LABQ fixed
* - better messages
* 7/10/94 JC
* - new IM_NEW()
* 22/2/95 JC
* - new use of im_region_region()
* 6/7/98 JC
* - im_extract_area() and im_extract_band() added
* 11/7/01 JC
* - im_extract_band() now numbers from zero
* 7/11/01 JC
* - oh what pain, im_extract now numbers bands from zero as well
* 6/9/02 JC
* - zero xoff/yoff for extracted area
* 14/4/04 JC
* - nope, -ve the origin
* 17/7/04
* - added im_extract_bands(), remove many bands from image
* 24/3/09
* - added IM_CODING_RAD support
* 29/1/10
* - cleanups
* - gtkdoc
*/
/*
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <vips/intl.h>
#include <stdio.h>
#include <vips/vips.h>
#ifdef WITH_DMALLOC
#include <dmalloc.h>
#endif /*WITH_DMALLOC*/
typedef struct _Extract {
IMAGE *in;
IMAGE *out;
int left;
int top;
int width;
int height;
int band;
int nbands;
} Extract;
/* Extract one or more bands. This needs pixel copying.
*/
static int
extract_band( REGION *or, void *seq, void *a, void *b )
{
REGION *ir = (REGION *) seq;
Extract *extract = (Extract *) b;
Rect *r = &or->valid;
int es = IM_IMAGE_SIZEOF_ELEMENT( ir->im );
int ipel = IM_IMAGE_SIZEOF_PEL( ir->im );
int opel = IM_IMAGE_SIZEOF_PEL( or->im );
Rect iarea;
char *p, *q;
int x, y, z;
/* Ask for input we need.
*/
iarea = or->valid;
iarea.left += extract->left;
iarea.top += extract->top;
if( im_prepare( ir, &iarea ) )
return( -1 );
for( y = 0; y < r->height; y++ ) {
p = IM_REGION_ADDR( ir,
extract->left + r->left,
extract->top + r->top + y ) +
extract->band * es;
q = IM_REGION_ADDR( or, r->left, r->top + y );
for( x = 0; x < r->width; x++ ) {
for( z = 0; z < opel; z++ )
q[z] = p[z];
p += ipel;
q += opel;
}
}
return( 0 );
}
/* Extract an area. Can just use pointers.
*/
static int
extract_area( REGION *or, void *seq, void *a, void *b )
{
REGION *ir = (REGION *) seq;
Extract *extract = (Extract *) b;
Rect iarea;
/* Ask for input we need. Translate from demand in or's space to
* demand in ir's space.
*/
iarea = or->valid;
iarea.left += extract->left;
iarea.top += extract->top;
if( im_prepare( ir, &iarea ) )
return( -1 );
/* Attach or to ir.
*/
if( im_region_region( or, ir, &or->valid, iarea.left, iarea.top ) )
return( -1 );
return( 0 );
}
/**
* im_extract_areabands:
* @in: input image
* @out: output image
* @left: left edge of rectangle
* @top: top edge rectangle
* @width: width of rectangle
* @height: height of rectangle
* @band: first band to extract
* @nbands: number of bands to extract
*
* Extract an area and a number of bands from an image. Bands number from
* zero. Extracting outside @in will trigger an error.
*
* See also: im_embed(), im_insert(), im_extract_area(), im_extract_bands().
*
* Returns: 0 on success, -1 on error
*/
int
im_extract_areabands( IMAGE *in, IMAGE *out,
int left, int top, int width, int height, int band, int nbands )
{
Extract *extract;
if( im_piocheck( in, out ) ||
im_check_coding_known( "im_extract_areabands", in ) )
return( -1 );
if( band < 0 || nbands < 1 || band + nbands > in->Bands ) {
im_error( "im_extract_areabands",
"%s", _( "band selection out of range" ) );
return( -1 );
}
if( left + width > in->Xsize ||
top + height > in->Ysize ||
left < 0 || top < 0 ||
width <= 0 || height <= 0 ) {
im_error( "im_extract_areabands",
"%s", _( "bad extract area" ) );
return( -1 );
}
/* Set up the output header.
*/
if( im_cp_desc( out, in ) )
return( -1 );
out->Bands = nbands;
out->Xsize = width;
out->Ysize = height;
if( im_demand_hint( out, IM_THINSTRIP, in, NULL ) )
return( -1 );
if( !(extract = IM_NEW( out, Extract )) )
return( -1 );
extract->in = in;
extract->out = out;
extract->left = left;
extract->top = top;
extract->width = width;
extract->height = height;
extract->band = band;
extract->nbands = nbands;
/* Extracting all bands is a special case ... we can do it with
* pointers.
*/
if( band == 0 && nbands == in->Bands ) {
if( im_generate( out,
im_start_one, extract_area, im_stop_one, in, extract ) )
return( -1 );
}
else {
if( im_generate( out,
im_start_one, extract_band, im_stop_one, in, extract ) )
return( -1 );
}
out->Xoffset = -left;
out->Yoffset = -top;
return( 0 );
}
/**
* im_extract_area:
* @in: input image
* @out: output image
* @left: left edge of rectangle
* @top: top edge of rectangle
* @width: width of rectangle
* @height: height of rectangle
*
* Extract an area from an image.
* Extracting outside @in will trigger an error.
*
* See also: im_embed(), im_insert(), im_extract_bands().
*
* Returns: 0 on success, -1 on error
*/
int
im_extract_area( IMAGE *in, IMAGE *out,
int left, int top, int width, int height )
{
return( im_extract_areabands( in, out,
left, top, width, height, 0, in->Bands ) );
}
/**
* im_extract_bands:
* @in: input image
* @out: output image
* @band: first band to extract
* @nbands: number of bands to extract
*
* Extract a number of bands from an image.
* Extracting outside @in will trigger an error.
*
* See also: im_bandjoin().
*
* Returns: 0 on success, -1 on error
*/
int
im_extract_bands( IMAGE *in, IMAGE *out, int band, int nbands )
{
return( im_extract_areabands( in, out,
0, 0, in->Xsize, in->Ysize, band, nbands ) );
}
/**
* im_extract_band:
* @in: input image
* @out: output image
* @band: band to extract
*
* Extract a single band from an image.
* Extracting outside @in will trigger an error.
*
* See also: im_bandjoin().
*
* Returns: 0 on success, -1 on error
*/
int
im_extract_band( IMAGE *in, IMAGE *out, int band )
{
return( im_extract_bands( in, out, band, 1 ) );
}