-
-
Notifications
You must be signed in to change notification settings - Fork 648
/
region.c
2084 lines (1804 loc) · 49 KB
/
region.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Make and destroy partial image regions.
*
* J.Cupitt, 8/4/93.
* 1/7/93 JC
* - adapted for partial v2
* - ANSIfied
* 15/8/94 JC
* - start & stop can now be NULL for no-op
* 12/5/94 JC
* - threads v2.0 added
* 22/2/95 JC
* - im_region_region() args changed
* 22/6/95 JC
* - im_region_local() did not always reset the data pointer
* 18/11/98 JC
* - init a, b, c also now, to help rtc avoid spurious checks
* 29/6/01 JC
* - im_region_free() now frees immediately
* 6/8/02 JC
* - new mmap() window regions
* 5/11/02 JC
* - fix for mmap a local region
* 28/2/05
* - shrink local region memory if required much-greater-than allocated
* 3/6/05
* - im_region_region() allows Bands and BandFmt to differ, provided
* sizeof( pel ) is the same ... makes im_copy_morph() work
* 30/10/06
* - switch to im_window_t for mmap window stuff
* 29/11/06
* - switch to im_buffer_t for local mem buffer stuff
* 19/1/07
* - im_region_image() only sets r, not whole image
* 1'2'07
* - gah, im_region_image() could still break (thanks Mikkel)
* 23/7/08
* - added im_region_print()
* 7/10/09
* - gtkdoc comments
* 5/3/10
* - move invalid stuff to region
* 3/3/11
* - move on top of VipsObject, rename as VipsRegion
* 23/2/17
* - multiply transparent images through alpha in vips_region_shrink()
* 13/6/18 harukizaemon
* - add VipsRegionShrink parameter to vips_region_shrink()
* 9/6/19
* - saner behaviour for vips_region_fetch() if the request is partly
* outside the image
* 22/2/21 f1ac
* - fix int overflow in vips_region_copy(), could cause crashes with
* very wide images
*/
/*
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_MOVE
#define DEBUG_ENVIRONMENT 1
#define DEBUG_CREATE
#define DEBUG
#define VIPS_DEBUG
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <glib/gi18n-lib.h>
#include <stdio.h>
#include <stdlib.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif /*HAVE_UNISTD_H*/
#include <string.h>
#include <vips/vips.h>
#include <vips/internal.h>
#include <vips/thread.h>
#include <vips/debug.h>
/**
* SECTION: region
* @short_description: small, rectangular parts of images
* @stability: Stable
* @see_also: <link linkend="VipsImage">image</link>,
* <link linkend="libvips-generate">generate</link>
* @include: vips/vips.h
*
* A #VipsRegion is a small part of an image. You use regions to
* read pixels out of images without having to have the whole image in memory
* at once.
*
* A region can be a memory buffer, part of a memory-mapped file, part of some
* other image, or part of some other region.
*
* Regions must be created, used and freed all within the same thread, since
* they can reference private per-thread caches. VIPS sanity-checks region
* ownership in various places, so you are likely to see g_assert() errors if
* you don't follow this rule.
*
* There
* is API to transfer ownership of regions between threads, but hopefully this
* is only needed within VIPS, so we don't expose it. Hopefully.
*/
/**
* VipsRegion:
* @im: the #VipsImage that this region is defined on
* @valid: the #VipsRect of pixels that this region represents
*
* A small part of a #VipsImage. @valid holds the left/top/width/height of the
* area of pixels that are available from the region.
*
* See also: VIPS_REGION_ADDR(), vips_region_new(), vips_region_prepare().
*/
/**
* VIPS_REGION_LSKIP:
* @R: a #VipsRegion
*
* Returns: The number of bytes to add to move down a scanline.
*/
/**
* VIPS_REGION_N_ELEMENTS:
* @R: a #VipsRegion
*
* Returns: The number of band elements across a region.
*/
/**
* VIPS_REGION_SIZEOF_LINE:
* @R: a #VipsRegion
*
* Returns: The number of bytes across a region.
*/
/**
* VIPS_REGION_ADDR:
* @R: a #VipsRegion
* @X: x coordinate
* @Y: y coordinate
*
* This macro returns a pointer to a pixel in a region. The (@X, @Y)
* coordinates need to be within the #VipsRect (@R->valid).
*
* If DEBUG is defined, you get a version that checks bounds for you.
*
* See also: vips_region_prepare().
*
* Returns: The address of pixel (@X,@Y) in @R.
*/
/**
* VIPS_REGION_ADDR_TOPLEFT:
* @R: a #VipsRegion
*
* This macro returns a pointer to the top-left pixel in the #VipsRegion, that
* is, the pixel at (@R->valid.left, @R->valid.top).
*
* See also: vips_region_prepare().
*
* Returns: The address of the top-left pixel in the region.
*/
/* Properties.
*/
enum {
PROP_IMAGE = 1,
PROP_LAST
};
G_DEFINE_TYPE(VipsRegion, vips_region, VIPS_TYPE_OBJECT);
#ifdef VIPS_DEBUG
static GSList *vips__regions_all = NULL;
#endif /*VIPS_DEBUG*/
static void
vips_region_finalize(GObject *gobject)
{
#ifdef VIPS_DEBUG
VIPS_DEBUG_MSG("vips_region_finalize: ");
vips_object_print_name(VIPS_OBJECT(gobject));
VIPS_DEBUG_MSG("\n");
#endif /*VIPS_DEBUG*/
#ifdef VIPS_DEBUG
g_mutex_lock(vips__global_lock);
vips__regions_all = g_slist_remove(vips__regions_all, gobject);
g_mutex_unlock(vips__global_lock);
#endif /*VIPS_DEBUG*/
G_OBJECT_CLASS(vips_region_parent_class)->finalize(gobject);
}
/* Call a start function if no sequence is running on this VipsRegion.
*/
int
vips__region_start(VipsRegion *region)
{
VipsImage *image = region->im;
if (!region->seq && image->start_fn) {
VIPS_GATE_START("vips__region_start: wait");
g_mutex_lock(image->sslock);
VIPS_GATE_STOP("vips__region_start: wait");
region->seq = image->start_fn(image,
image->client1, image->client2);
g_mutex_unlock(image->sslock);
if (!region->seq) {
#ifdef DEBUG
printf("vips__region_start: start function failed for image %s",
image->filename);
#endif /*DEBUG*/
return -1;
}
}
return 0;
}
/* Call a stop function if a sequence is running in this VipsRegion.
*/
void
vips__region_stop(VipsRegion *region)
{
VipsImage *image = region->im;
if (region->seq && image->stop_fn) {
int result;
VIPS_GATE_START("vips__region_stop: wait");
g_mutex_lock(image->sslock);
VIPS_GATE_STOP("vips__region_stop: wait");
result = image->stop_fn(region->seq,
image->client1, image->client2);
g_mutex_unlock(image->sslock);
/* stop function can return an error, but we have nothing we
* can really do with it, sadly.
*/
if (result)
g_warning("stop callback failed for image %s",
image->filename);
region->seq = NULL;
}
}
static void
vips_region_dispose(GObject *gobject)
{
VipsRegion *region = VIPS_REGION(gobject);
VipsImage *image = region->im;
#ifdef VIPS_DEBUG
VIPS_DEBUG_MSG("vips_region_dispose: ");
vips_object_print_name(VIPS_OBJECT(gobject));
VIPS_DEBUG_MSG("\n");
#endif /*VIPS_DEBUG*/
vips_object_preclose(VIPS_OBJECT(gobject));
/* Stop this sequence.
*/
vips__region_stop(region);
/* Free any attached memory.
*/
VIPS_FREEF(vips_window_unref, region->window);
VIPS_FREEF(vips_buffer_unref, region->buffer);
/* Detach from image.
*/
VIPS_GATE_START("vips_region_dispose: wait");
g_mutex_lock(image->sslock);
VIPS_GATE_STOP("vips_region_dispose: wait");
image->regions = g_slist_remove(image->regions, region);
g_mutex_unlock(image->sslock);
region->im = NULL;
g_object_unref(image);
G_OBJECT_CLASS(vips_region_parent_class)->dispose(gobject);
}
static void
vips_region_dump(VipsObject *object, VipsBuf *buf)
{
VipsRegion *region = VIPS_REGION(object);
vips_buf_appendf(buf, "VipsRegion: %p, ", region);
vips_buf_appendf(buf, "im = %p, ", region->im);
vips_buf_appendf(buf, "valid.left = %d, ", region->valid.left);
vips_buf_appendf(buf, "valid.top = %d, ", region->valid.top);
vips_buf_appendf(buf, "valid.width = %d, ", region->valid.width);
vips_buf_appendf(buf, "valid.height = %d, ", region->valid.height);
vips_buf_appendf(buf, "type = %d, ", region->type);
vips_buf_appendf(buf, "data = %p, ", region->data);
vips_buf_appendf(buf, "bpl = %d, ", region->bpl);
vips_buf_appendf(buf, "seq = %p, ", region->seq);
vips_buf_appendf(buf, "thread = %p, ", region->thread);
vips_buf_appendf(buf, "window = %p, ", region->window);
vips_buf_appendf(buf, "buffer = %p, ", region->buffer);
vips_buf_appendf(buf, "invalid = %d", region->invalid);
VIPS_OBJECT_CLASS(vips_region_parent_class)->dump(object, buf);
}
static void
vips_region_summary(VipsObject *object, VipsBuf *buf)
{
VipsRegion *region = VIPS_REGION(object);
vips_buf_appendf(buf, "VipsRegion: %p, ", region);
vips_buf_appendf(buf, "im = %p, ", region->im);
vips_buf_appendf(buf, "left = %d, ", region->valid.left);
vips_buf_appendf(buf, "top = %d, ", region->valid.top);
vips_buf_appendf(buf, "width = %d, ", region->valid.width);
vips_buf_appendf(buf, "height = %d", region->valid.height);
if (region->buffer && region->buffer->buf)
vips_buf_appendf(buf, ", %.3gMB",
region->buffer->bsize / (1024 * 1024.0));
VIPS_OBJECT_CLASS(vips_region_parent_class)->summary(object, buf);
}
/* If a region is being created in one thread (eg. the main thread) and then
* used in another (eg. a worker thread), the new thread needs to tell VIPS
* to stop sanity g_assert() fails. The previous owner needs to
* vips__region_no_ownership() before we can call this.
*/
void
vips__region_take_ownership(VipsRegion *region)
{
/* Lock so that there's a memory barrier with the thread doing the
* vips__region_no_ownership() before us.
*/
VIPS_GATE_START("vips__region_take_ownership: wait");
g_mutex_lock(region->im->sslock);
VIPS_GATE_STOP("vips__region_take_ownership: wait");
if (region->thread != g_thread_self()) {
g_assert(region->thread == NULL);
/* We don't want to move shared buffers: the other region
* using this buffer will still be on the other thread.
* Not sure if this will ever happen: if it does, we'll
* need to dup the buffer.
*/
g_assert(!region->buffer ||
region->buffer->ref_count == 1);
region->thread = g_thread_self();
}
g_mutex_unlock(region->im->sslock);
}
void
vips__region_check_ownership(VipsRegion *region)
{
if (region->thread) {
g_assert(region->thread == g_thread_self());
if (region->buffer && region->buffer->cache)
g_assert(region->thread ==
region->buffer->cache->thread);
}
}
/* Call this from the relinquishing thread. Removes the buffer (if any) from
* this thread's buffer cache.
*/
void
vips__region_no_ownership(VipsRegion *region)
{
VIPS_GATE_START("vips__region_no_ownership: wait");
g_mutex_lock(region->im->sslock);
VIPS_GATE_STOP("vips__region_no_ownership: wait");
vips__region_check_ownership(region);
region->thread = NULL;
if (region->buffer)
vips_buffer_undone(region->buffer);
g_mutex_unlock(region->im->sslock);
}
static int
vips_region_build(VipsObject *object)
{
VipsRegion *region = VIPS_REGION(object);
VipsImage *image = region->im;
VIPS_DEBUG_MSG("vips_region_build: %p\n", region);
if (VIPS_OBJECT_CLASS(vips_region_parent_class)->build(object))
return -1;
vips__region_take_ownership(region);
/* We're usually inside the ss lock anyway. But be safe ...
*/
VIPS_GATE_START("vips_region_build: wait");
g_mutex_lock(image->sslock);
VIPS_GATE_STOP("vips_region_build: wait");
image->regions = g_slist_prepend(image->regions, region);
g_mutex_unlock(image->sslock);
return 0;
}
static void
vips_region_class_init(VipsRegionClass *class)
{
GObjectClass *gobject_class = G_OBJECT_CLASS(class);
VipsObjectClass *vobject_class = VIPS_OBJECT_CLASS(class);
gobject_class->finalize = vips_region_finalize;
gobject_class->dispose = vips_region_dispose;
vobject_class->summary = vips_region_summary;
vobject_class->dump = vips_region_dump;
vobject_class->build = vips_region_build;
}
static void
vips_region_init(VipsRegion *region)
{
region->type = VIPS_REGION_NONE;
#ifdef VIPS_DEBUG
g_mutex_lock(vips__global_lock);
vips__regions_all = g_slist_prepend(vips__regions_all, region);
printf("vips_region_init: %d regions in vips\n",
g_slist_length(vips__regions_all));
g_mutex_unlock(vips__global_lock);
#endif /*VIPS_DEBUG*/
}
/**
* vips_region_new: (constructor)
* @image: image to create this region on
*
* Create a region. #VipsRegion s start out empty, you need to call
* vips_region_prepare() to fill them with pixels.
*
* See also: vips_region_prepare().
*/
VipsRegion *
vips_region_new(VipsImage *image)
{
VipsRegion *region;
/* Ref quickly, we want to make sure we keep the image around.
* We can't use the property system, we need to be very threaded.
*/
g_object_ref(image);
g_assert(G_OBJECT(image)->ref_count > 1);
g_assert(vips_object_sanity(VIPS_OBJECT(image)));
region = VIPS_REGION(g_object_new(VIPS_TYPE_REGION, NULL));
region->im = image;
if (vips_object_build(VIPS_OBJECT(region))) {
VIPS_UNREF(region);
return NULL;
}
g_assert(vips_object_sanity(VIPS_OBJECT(region)));
return region;
}
/* Region should be a pixel buffer. On return, check
* reg->buffer->done to see if there are pixels there already. Otherwise, you
* need to calculate.
*/
/**
* vips_region_buffer:
* @reg: region to operate upon
* @r: #VipsRect of pixels you need to be able to address
*
* The region is transformed so that at least @r pixels are available as a
* memory buffer that can be written to.
*
* Returns: 0 on success, or -1 for error.
*/
int
vips_region_buffer(VipsRegion *reg, const VipsRect *r)
{
VipsImage *im = reg->im;
VipsRect image;
VipsRect clipped;
vips__region_check_ownership(reg);
/* Clip against image.
*/
image.top = 0;
image.left = 0;
image.width = im->Xsize;
image.height = im->Ysize;
vips_rect_intersectrect(r, &image, &clipped);
/* Test for empty.
*/
if (vips_rect_isempty(&clipped)) {
vips_error("VipsRegion",
"%s", _("valid clipped to nothing"));
return -1;
}
VIPS_FREEF(vips_window_unref, reg->window);
/* Have we been asked to drop caches? We want to throw everything
* away.
*
* If not, try to reuse the current buffer.
*/
if (reg->invalid) {
VIPS_FREEF(vips_buffer_unref, reg->buffer);
reg->invalid = FALSE;
if (!(reg->buffer = vips_buffer_new(im, &clipped)))
return -1;
}
else {
/* We combine buffer unref and new buffer ref in one call
* to reduce malloc/free cycling.
*/
if (!(reg->buffer =
vips_buffer_unref_ref(reg->buffer, im, &clipped)))
return -1;
}
/* Init new stuff.
*/
reg->valid = reg->buffer->area;
reg->bpl = VIPS_IMAGE_SIZEOF_PEL(im) * reg->buffer->area.width;
reg->type = VIPS_REGION_BUFFER;
reg->data = reg->buffer->buf;
return 0;
}
/**
* vips_region_image:
* @reg: region to operate upon
* @r: #VipsRect of pixels you need to be able to address
*
* The region is transformed so that at least @r pixels are available to be
* read from the image. The image needs to be a memory buffer or represent a
* file on disc that has been mapped or can be mapped.
*
* Returns: 0 on success, or -1 for error.
*/
int
vips_region_image(VipsRegion *reg, const VipsRect *r)
{
VipsImage *image = reg->im;
VipsRect all;
VipsRect clipped;
/* Sanity check.
*/
vips__region_check_ownership(reg);
/* Clip against image.
*/
all.top = 0;
all.left = 0;
all.width = image->Xsize;
all.height = image->Ysize;
vips_rect_intersectrect(r, &all, &clipped);
if (vips_rect_isempty(&clipped)) {
vips_error("VipsRegion",
"%s", _("valid clipped to nothing"));
return -1;
}
reg->invalid = FALSE;
VIPS_FREEF(vips_buffer_unref, reg->buffer);
if (image->data) {
/* We have the whole image available ... easy!
*/
VIPS_FREEF(vips_window_unref, reg->window);
/* We can't just set valid = whole image, since this may be an
* incompletely calculated memory buffer. Just set valid to r.
*/
reg->valid = clipped;
reg->bpl = VIPS_IMAGE_SIZEOF_LINE(image);
reg->data = VIPS_IMAGE_ADDR(image, clipped.left, clipped.top);
reg->type = VIPS_REGION_OTHER_IMAGE;
}
else if (image->dtype == VIPS_IMAGE_OPENIN) {
/* No complete image data ... but we can use a rolling window.
*/
reg->type = VIPS_REGION_WINDOW;
if (!(reg->window = vips_window_take(reg->window, image,
clipped.top, clipped.height)))
return -1;
/* Note the area the window actually represents.
*/
reg->valid.left = 0;
reg->valid.top = reg->window->top;
reg->valid.width = image->Xsize;
reg->valid.height = reg->window->height;
reg->bpl = VIPS_IMAGE_SIZEOF_LINE(image);
reg->data = reg->window->data;
}
else {
VIPS_FREEF(vips_window_unref, reg->window);
vips_error("VipsRegion", "%s", _("bad image type"));
return -1;
}
return 0;
}
/**
* vips_region_region:
* @reg: region to operate upon
* @dest: region to connect to
* @r: #VipsRect of pixels you need to be able to address
* @x: position of @r in @dest
* @y: position of @r in @dest
*
* Make VIPS_REGION_ADDR() on @reg go to @dest instead.
*
* @r is the part of @reg which you want to be able to address (this
* effectively becomes the valid field), (@x, @y) is the top LH corner of the
* corresponding area in @dest.
*
* Performs all clipping necessary to ensure that @reg->valid is indeed
* valid.
*
* If the region we attach to is moved or destroyed, we can be left with
* dangling pointers! If the region we attach to is on another image, the
* two images must have the same sizeof(pel).
*
* Returns: 0 on success, or -1 for error.
*/
int
vips_region_region(VipsRegion *reg,
VipsRegion *dest, const VipsRect *r, int x, int y)
{
VipsRect image;
VipsRect wanted;
VipsRect clipped;
VipsRect clipped2;
VipsRect final;
/* Sanity check.
*/
if (!dest->data) {
vips_error("VipsRegion",
"%s", _("no pixel data on attached image"));
return -1;
}
if (VIPS_IMAGE_SIZEOF_PEL(dest->im) !=
VIPS_IMAGE_SIZEOF_PEL(reg->im)) {
vips_error("VipsRegion",
"%s", _("images do not match in pixel size"));
return -1;
}
vips__region_check_ownership(reg);
/* We can't test
g_assert(dest->thread == g_thread_self());
* since we can have several threads writing to the same region in
* threadgroup.
*/
/* Clip r against size of the image.
*/
image.top = 0;
image.left = 0;
image.width = reg->im->Xsize;
image.height = reg->im->Ysize;
vips_rect_intersectrect(r, &image, &clipped);
/* Translate to dest's coordinate space and clip against the available
* pixels.
*/
wanted.left = x + (clipped.left - r->left);
wanted.top = y + (clipped.top - r->top);
wanted.width = clipped.width;
wanted.height = clipped.height;
/* Test that dest->valid is large enough.
*/
if (!vips_rect_includesrect(&dest->valid, &wanted)) {
vips_error("VipsRegion",
"%s", _("dest too small"));
return -1;
}
/* Clip against the available pixels.
*/
vips_rect_intersectrect(&wanted, &dest->valid, &clipped2);
/* Translate back to reg's coordinate space and set as valid.
*/
final.left = r->left + (clipped2.left - wanted.left);
final.top = r->top + (clipped2.top - wanted.top);
final.width = clipped2.width;
final.height = clipped2.height;
/* Test for empty.
*/
if (vips_rect_isempty(&final)) {
vips_error("VipsRegion",
"%s", _("valid clipped to nothing"));
return -1;
}
/* Init new stuff.
*/
VIPS_FREEF(vips_buffer_unref, reg->buffer);
VIPS_FREEF(vips_window_unref, reg->window);
reg->invalid = FALSE;
reg->valid = final;
reg->bpl = dest->bpl;
reg->data = VIPS_REGION_ADDR(dest, clipped2.left, clipped2.top);
reg->type = VIPS_REGION_OTHER_REGION;
return 0;
}
/**
* vips_region_equalsregion:
* @reg1: region to test
* @reg2: region to test
*
* Do two regions point to the same piece of image? ie.
*
* |[
* VIPS_REGION_ADDR(reg1, x, y) == VIPS_REGION_ADDR(reg2, x, y) &&
* *VIPS_REGION_ADDR(reg1, x, y) ==
* *VIPS_REGION_ADDR(reg2, x, y) for all x, y, reg1, reg2.
* ]|
*
* Returns: non-zero on equality.
*/
int
vips_region_equalsregion(VipsRegion *reg1, VipsRegion *reg2)
{
return reg1->im == reg2->im &&
vips_rect_equalsrect(®1->valid, ®2->valid) &&
reg1->data == reg2->data;
}
/**
* vips_region_position:
* @reg: region to operate upon
* @x: position to move to
* @y: position to move to
*
* Set the position of a region. This only affects reg->valid, ie. the way
* pixels are addressed, not reg->data, the pixels which are addressed. Clip
* against the size of the image. Do not allow negative positions, or
* positions outside the image.
*
* Returns: 0 on success, or -1 for error.
*/
int
vips_region_position(VipsRegion *reg, int x, int y)
{
VipsRect req, image, clipped;
/* Clip!
*/
image.top = 0;
image.left = 0;
image.width = reg->im->Xsize;
image.height = reg->im->Ysize;
req.top = y;
req.left = x;
req.width = reg->valid.width;
req.height = reg->valid.height;
vips_rect_intersectrect(&image, &req, &clipped);
if (x < 0 || y < 0 || vips_rect_isempty(&clipped)) {
vips_error("VipsRegion", "%s", _("bad position"));
return -1;
}
reg->valid = clipped;
reg->invalid = FALSE;
return 0;
}
int
vips_region_fill(VipsRegion *reg,
const VipsRect *r, VipsRegionFillFn fn, void *a)
{
g_assert(reg->im->dtype == VIPS_IMAGE_PARTIAL);
g_assert(reg->im->generate_fn);
/* You'd think we could check reg and see if it already has some of
* the pixels we need. If it does, we could copy them and only
* generate the new ones.
*
* However, we usually have neighbouring regions on different threads,
* so from the point of view of this thread, we will get no overlaps
* on successive prepare requests.
*/
/* Should have local memory.
*/
if (vips_region_buffer(reg, r))
return -1;
/* Evaluate into out_region, if we've not got calculated pixels.
*/
if (!reg->buffer->done) {
if (fn(reg, a))
return -1;
/* Publish our results.
*/
if (reg->buffer)
vips_buffer_done(reg->buffer);
}
return 0;
}
#define FILL_LINE(TYPE, Q, N, V) \
{ \
int x; \
TYPE *QT = (TYPE *) Q; \
\
for (x = 0; x < (N); x++) \
QT[x] = (V); \
}
/**
* vips_region_paint:
* @reg: region to operate upon
* @r: area to paint
* @value: value to paint
*
* Paints @value into @reg covering rectangle @r.
* @r is clipped against
* @reg->valid.
*
* For int images, @value is
* passed to memset(), so it usually needs to be 0 or 255. For float images,
* value is cast to a float and copied in to each band element.
*
* @r is clipped against
* @reg->valid.
*
* See also: vips_region_black().
*/
void
vips_region_paint(VipsRegion *reg, const VipsRect *r, int value)
{
VipsRect clipped;
vips_rect_intersectrect(r, ®->valid, &clipped);
if (!vips_rect_isempty(&clipped)) {
VipsPel *q = VIPS_REGION_ADDR(reg, clipped.left, clipped.top);
size_t ls = VIPS_REGION_LSKIP(reg);
size_t wd = clipped.width * VIPS_IMAGE_SIZEOF_PEL(reg->im);
int y;
if (vips_band_format_isint(reg->im->BandFmt)) {
for (y = 0; y < clipped.height; y++) {
memset((char *) q, value, wd);
q += ls;
}
}
else {
gboolean iscomplex =
vips_band_format_iscomplex(reg->im->BandFmt);
int nele = clipped.width * reg->im->Bands *
(iscomplex ? 2 : 1);
VipsPel *q1;
switch (reg->im->BandFmt) {
case VIPS_FORMAT_FLOAT:
case VIPS_FORMAT_COMPLEX:
FILL_LINE(float, q, nele, value);
break;
case VIPS_FORMAT_DOUBLE:
case VIPS_FORMAT_DPCOMPLEX:
FILL_LINE(double, q, nele, value);
break;
default:
g_assert_not_reached();
}
q1 = q + ls;
for (y = 1; y < clipped.height; y++) {
memcpy((char *) q1, (char *) q, wd);
q1 += ls;
}
}
}
}
/**
* vips_region_paint_pel:
* @reg: region to operate upon
* @r: area to paint
* @ink: value to paint
*
* Paints @ink into @reg covering rectangle @r. @r is clipped against
* @reg->valid.
*
* @ink should be a byte array of the same size as an image pixel containing
* the binary value to write into the pixels.
*
* See also: vips_region_paint().
*/
void
vips_region_paint_pel(VipsRegion *reg, const VipsRect *r, const VipsPel *ink)
{
VipsRect ovl;
vips_rect_intersectrect(r, ®->valid, &ovl);
if (!vips_rect_isempty(&ovl)) {
int ps = VIPS_IMAGE_SIZEOF_PEL(reg->im);
int ws = ovl.width * ps;
int ls = VIPS_REGION_LSKIP(reg);
VipsPel *to, *q;
int x, y, z;
/* We plot the first line pointwise, then memcpy() it for the
* subsequent lines.