Class: Magick::ImageList

Inherits:
Object
  • Object
show all
Includes:
Comparable, Enumerable
Defined in:
lib/rmagick_internal.rb,
ext/RMagick/rmmain.c

Overview

class Magick::Image

Defined Under Namespace

Classes: Montage

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*filenames, &block) ⇒ ImageList

Initialize new instances



1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'lib/rmagick_internal.rb', line 1537

def initialize(*filenames, &block)
  @images = []
  @scene = nil
  filenames.each do |f|
    Magick::Image.read(f, &block).each { |n| @images << n }
  end
  if length > 0
    @scene = length - 1 # last image in array
  end
  self
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(meth_id, *args, &block) ⇒ Object

The ImageList class supports the Magick::Image class methods by simply sending the method to the current image. If the method isn’t explicitly supported, send it to the current image in the array. If there are no images, send it up the line. Catch a NameError and emit a useful message.



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
 
# File 'lib/rmagick_internal.rb', line 1602

def method_missing(meth_id, *args, &block)
  if @scene
    @images[@scene].send(meth_id, *args, &block)
  else
    super
  end
rescue NoMethodError
  Kernel.raise NoMethodError, "undefined method `#{meth_id.id2name}' for #{self.class}"
rescue Exception
  $ERROR_POSITION.delete_if { |s| /:in `send'$/.match(s) || /:in `method_missing'$/.match(s) }
  Kernel.raise
end

Instance Attribute Details

#scene ⇒ Object

Returns the value of attribute scene.



1221
1222
1223
 
# File 'lib/rmagick_internal.rb', line 1221

def scene
  @scene
end

Instance Method Details

#*(other) ⇒ Object 



1307
1308
1309
1310
1311
1312
1313
1314
 
# File 'lib/rmagick_internal.rb', line 1307

def *(other)
  Kernel.raise ArgumentError, "Integer required (#{other.class} given)" unless other.is_a? Integer
  current = get_current
  ilist = self.class.new
  (@images * other).each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#<<(obj) ⇒ Object 



1316
1317
1318
1319
1320
1321
 
# File 'lib/rmagick_internal.rb', line 1316

def <<(obj)
  is_an_image obj
  @images << obj
  @scene = @images.length - 1
  self
end

#<=>(other) ⇒ Object

Compare ImageLists Compare each image in turn until the result of a comparison is not 0. If all comparisons return 0, then

return if A.scene != B.scene
return A.length <=> B.length



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/rmagick_internal.rb', line 1328

def <=>(other)
  Kernel.raise TypeError, "#{self.class} required (#{other.class} given)" unless other.is_a? self.class
  size = [length, other.length].min
  size.times do |x|
    r = self[x] <=> other[x]
    return r unless r.zero?
  end
  return 0 if @scene.nil? && other.scene.nil?

  Kernel.raise TypeError, "cannot convert nil into #{other.scene.class}" if @scene.nil? && !other.scene.nil?
  Kernel.raise TypeError, "cannot convert nil into #{scene.class}" if !@scene.nil? && other.scene.nil?
  r = scene <=> other.scene
  return r unless r.zero?

  length <=> other.length
end

#[](*args) ⇒ Object 



1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/rmagick_internal.rb', line 1345

def [](*args)
  a = @images[*args]
  if a.respond_to?(:each)
    ilist = self.class.new
    a.each { |image| ilist << image }
    a = ilist
  end
  a
end

#[]=(*args) ⇒ Object 



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'lib/rmagick_internal.rb', line 1355

def []=(*args)
  obj = @images.[]=(*args)
  if obj && obj.respond_to?(:each)
    is_an_image_array(obj)
    set_current obj.last.__id__
  elsif obj
    is_an_image(obj)
    set_current obj.__id__
  else
    set_current nil
  end
  obj
end

#__respond_to__? ⇒ Object

Ensure respond_to? answers correctly when we are delegating to Image



1696
 
# File 'lib/rmagick_internal.rb', line 1696

alias __respond_to__? respond_to?

#animate(*args) ⇒ Object

Repeatedly display the images in the images array to an XWindow screen. The “delay” argument is the number of 1/100ths of a second (0 to 65535) to delay between images.

Ruby usage:

- @verbatim ImageList#animate @endverbatim
- @verbatim ImageList#animate(delay) @endverbatim

Parameters:

  • argc —

    number of input arguments

  • argv —

    array of input arguments

  • self —

    this object

Returns:

  • self



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
 
# File 'ext/RMagick/rmilist.c', line 42

VALUE
ImageList_animate(int argc, VALUE *argv, VALUE self)
{
    Image *images;
    Info *info;
    VALUE info_obj;

    if (argc > 1)
    {
        rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 or 1)", argc);
    }

    // Create a new Info object to use with this call
    info_obj = rm_info_new();

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    if (argc == 1)
    {
        Image *img;
        unsigned int delay;

        delay = NUM2UINT(argv[0]);
        for (img = images; img; img = GetNextImageInList(img))
        {
            img->delay = delay;
        }
    }

    Data_Get_Struct(info_obj, Info, info);
    (void) AnimateImages(info, images);
    rm_check_image_exception(images, RetainOnError);
    rm_split(images);

    RB_GC_GUARD(info_obj);

    return self;
}

#append(stack_arg) ⇒ Object

Append all the images by calling ImageAppend.

Ruby usage:

- @verbatim ImageList#append(stack) @endverbatim

Parameters:

  • self —

    this object

  • stack_arg —

    the stack of images

Returns:

  • a Frame object for the result



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'ext/RMagick/rmilist.c', line 93

VALUE
ImageList_append(VALUE self, VALUE stack_arg)
{
    Image *images, *new_image;
    unsigned int stack;
    ExceptionInfo *exception;

    // Convert the image array to an image sequence.
    images = images_from_imagelist(self);

    // If stack == true, stack rectangular images top-to-bottom,
    // otherwise left-to-right.
    stack = RTEST(stack_arg);

    exception = AcquireExceptionInfo();
    new_image = AppendImages(images, stack, exception);
    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_image);

    return rm_image_new(new_image);
}

#average ⇒ Object

Average all images together by calling AverageImages.

Ruby usage:

- @verbatim ImageList#average @endverbatim

Parameters:

  • self —

    this object

Returns:

  • a Frame object for the averaged image



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'ext/RMagick/rmilist.c', line 128

VALUE
ImageList_average(VALUE self)
{
    Image *images, *new_image;
    ExceptionInfo *exception;

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
#if defined(HAVE_EVALUATEIMAGES)
    new_image = EvaluateImages(images, MeanEvaluateOperator, exception);
#else
    new_image = AverageImages(images, exception);
#endif

    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_image);

    return rm_image_new(new_image);
}

#clear ⇒ Object 



1386
1387
1388
1389
 
# File 'lib/rmagick_internal.rb', line 1386

def clear
  @scene = nil
  @images.clear
end

#clone ⇒ Object 



1391
1392
1393
1394
1395
 
# File 'lib/rmagick_internal.rb', line 1391

def clone
  ditto = dup
  ditto.freeze if frozen?
  ditto
end

#coalesce ⇒ Object

Call CoalesceImages.

Ruby usage:

- @verbatim ImageList#coalesce @endverbatim

Notes:

- Respects the delay, matte, and start_loop fields in each image.

images array

Parameters:

  • self —

    this object

Returns:

  • a new Image with the coalesced image sequence return stored in the



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'ext/RMagick/rmilist.c', line 167

VALUE
ImageList_coalesce(VALUE self)
{
    Image *images, *new_images;
    ExceptionInfo *exception;

    // Convert the image array to an image sequence.
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    new_images = CoalesceImages(images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_images);

    return rm_imagelist_from_images(new_images);
}

#collect(&block) ⇒ Object Also known as: __map__

override Enumerable#collect



1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/rmagick_internal.rb', line 1398

def collect(&block)
  current = get_current
  a = @images.collect(&block)
  ilist = self.class.new
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#collect!(&block) ⇒ Object Also known as: map!, __map__! 



1407
1408
1409
1410
1411
 
# File 'lib/rmagick_internal.rb', line 1407

def collect!(&block)
  @images.collect!(&block)
  is_an_image_array @images
  self
end

#compact ⇒ Object 



1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/rmagick_internal.rb', line 1436

def compact
  current = get_current
  ilist = self.class.new
  a = @images.compact
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#compact! ⇒ Object 



1445
1446
1447
1448
1449
1450
 
# File 'lib/rmagick_internal.rb', line 1445

def compact!
  current = get_current
  a = @images.compact! # returns nil if no changes were made
  set_current current
  a.nil? ? nil : self
end

#composite_layers(*args) ⇒ Object

Equivalent to convert’s -layers composite option.

Ruby usage:

- @verbatim ImageList#composite_layers(images) @endverbatim
- @verbatim ImageList#composite_layers(images,operator) @endverbatim

Notes:

- Default operator is OverCompositeOp

Parameters:

  • argc —

    number of input arguments

  • argv —

    array of input arguments

  • self —

    this object

Returns:

  • a new imagelist

See Also:

  • in ImageMagick


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
 
# File 'ext/RMagick/rmilist.c', line 204

VALUE
ImageList_composite_layers(int argc, VALUE *argv, VALUE self)
{
    VALUE source_images;
    Image *dest, *source, *new_images;
    RectangleInfo geometry;
    CompositeOperator operator = OverCompositeOp;
    ExceptionInfo *exception;

    switch (argc)
    {
        case 2:
            VALUE_TO_ENUM(argv[1], operator, CompositeOperator);
        case 1:
            source_images = argv[0];
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (expected 1 or 2, got %d)", argc);
            break;
    }

    // Convert ImageLists to image sequences.
    dest = images_from_imagelist(self);
    new_images = clone_imagelist(dest);
    rm_split(dest);

    source = images_from_imagelist(source_images);

    SetGeometry(new_images,&geometry);
    (void) ParseAbsoluteGeometry(new_images->geometry, &geometry);

    geometry.width  = source->page.width != 0 ? source->page.width : source->columns;
    geometry.height = source->page.height != 0 ? source->page.height : source->rows;
    GravityAdjustGeometry(new_images->page.width  != 0 ? new_images->page.width  : new_images->columns
                        , new_images->page.height != 0 ? new_images->page.height : new_images->rows
                        , new_images->gravity, &geometry);

    exception = AcquireExceptionInfo();
    CompositeLayers(new_images, operator, source, geometry.x, geometry.y, exception);
    rm_split(source);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    RB_GC_GUARD(source_images);

    return rm_imagelist_from_images(new_images);
}

#concat(other) ⇒ Object 



1452
1453
1454
1455
1456
1457
 
# File 'lib/rmagick_internal.rb', line 1452

def concat(other)
  is_an_image_array other
  other.each { |image| @images << image }
  @scene = length - 1
  self
end

#copy ⇒ Object

Make a deep copy



1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/rmagick_internal.rb', line 1414

def copy
  ditto = self.class.new
  @images.each { |f| ditto << f.copy }
  ditto.scene = @scene
  ditto.taint if tainted?
  ditto
end

#cur_image ⇒ Object

Return the current image



1423
1424
1425
1426
 
# File 'lib/rmagick_internal.rb', line 1423

def cur_image
  Kernel.raise IndexError, 'no images in this list' unless @scene
  @images[@scene]
end

#deconstruct ⇒ Object

Compare each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.

Ruby usage:

- @verbatim ImageList#deconstruct @endverbatim

Parameters:

  • self —

    this object

Returns:

  • a new imagelist



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'ext/RMagick/rmilist.c', line 263

VALUE
ImageList_deconstruct(VALUE self)
{
    Image *new_images, *images;
    ExceptionInfo *exception;

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();
    new_images = DeconstructImages(images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_images);

    return rm_imagelist_from_images(new_images);
}

#delay=(d) ⇒ Object

Set same delay for all images

Raises:

  • (ArgumentError) 


1460
1461
1462
1463
1464
 
# File 'lib/rmagick_internal.rb', line 1460

def delay=(d)
  raise ArgumentError, 'delay must be greater than or equal to 0' if Integer(d) < 0

  @images.each { |f| f.delay = Integer(d) }
end

#delete(obj, &block) ⇒ Object 



1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/rmagick_internal.rb', line 1466

def delete(obj, &block)
  is_an_image obj
  current = get_current
  a = @images.delete(obj, &block)
  set_current current
  a
end

#delete_at(ndx) ⇒ Object 



1474
1475
1476
1477
1478
1479
 
# File 'lib/rmagick_internal.rb', line 1474

def delete_at(ndx)
  current = get_current
  a = @images.delete_at(ndx)
  set_current current
  a
end

#delete_if(&block) ⇒ Object 



1481
1482
1483
1484
1485
1486
 
# File 'lib/rmagick_internal.rb', line 1481

def delete_if(&block)
  current = get_current
  @images.delete_if(&block)
  set_current current
  self
end

#display ⇒ Object Also known as: __display__

Display all the images to an X window screen.

Ruby usage:

- @verbatim ImageList#display @endverbatim

Parameters:

  • self —

    this object

Returns:

  • self



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'ext/RMagick/rmilist.c', line 291

VALUE
ImageList_display(VALUE self)
{
    Image *images;
    Info *info;
    VALUE info_obj;

    // Create a new Info object to use with this call
    info_obj = rm_info_new();
    Data_Get_Struct(info_obj, Info, info);

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    (void) DisplayImages(info, images);
    rm_split(images);
    rm_check_image_exception(images, RetainOnError);

    RB_GC_GUARD(info_obj);

    return self;
}

#dup ⇒ Object 



1488
1489
1490
1491
1492
1493
1494
 
# File 'lib/rmagick_internal.rb', line 1488

def dup
  ditto = self.class.new
  @images.each { |img| ditto << img }
  ditto.scene = @scene
  ditto.taint if tainted?
  ditto
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
 
# File 'lib/rmagick_internal.rb', line 1496

def eql?(other)
  is_an_image_array other
  eql = other.eql?(@images)
  begin # "other" is another ImageList
    eql &&= @scene == other.scene
  rescue NoMethodError
    # "other" is a plain Array
  end
  eql
end

#fill(*args, &block) ⇒ Object 



1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/rmagick_internal.rb', line 1507

def fill(*args, &block)
  is_an_image args[0] unless block_given?
  current = get_current
  @images.fill(*args, &block)
  is_an_image_array self
  set_current current
  self
end

#find_all(&block) ⇒ Object Also known as: select

Override Enumerable’s find_all



1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/rmagick_internal.rb', line 1517

def find_all(&block)
  current = get_current
  a = @images.find_all(&block)
  ilist = self.class.new
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#flatten_images ⇒ Object

Merge all the images into a single image.

Ruby usage:

- @verbatim ImageList#flatten_images @endverbatim

Notes:

- Can't use "flatten" because that's an Array method

Parameters:

  • self —

    this object

Returns:

  • the new image



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'ext/RMagick/rmilist.c', line 327

VALUE
ImageList_flatten_images(VALUE self)
{
    Image *images, *new_image;
    ExceptionInfo *exception;

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();

#if defined(HAVE_ENUM_FLATTENLAYER)
    new_image = MergeImageLayers(images, FlattenLayer, exception);
#else
    new_image = FlattenImages(images, exception);
#endif

    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_image);

    return rm_image_new(new_image);
}

#from_blob(*blobs, &block) ⇒ Object 



1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/rmagick_internal.rb', line 1527

def from_blob(*blobs, &block)
  Kernel.raise ArgumentError, 'no blobs given' if blobs.length.zero?
  blobs.each do |b|
    Magick::Image.from_blob(b, &block).each { |n| @images << n }
  end
  @scene = length - 1
  self
end

#fx(*args) ⇒ Object

Apply fx on the images.

Ruby usage:

- @verbatim ImageList#fx(expression) @endverbatim
- @verbatim ImageList#fx(expression, channel) @endverbatim
- @verbatim ImageList#fx(expression, channel, ...) @endverbatim

Notes:

- Default channel is AllChannels

Parameters:

  • argc —

    number of input arguments

  • argv —

    array of input arguments

  • self —

    this object

Returns:

  • a new image



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
 
# File 'ext/RMagick/rmilist.c', line 368

VALUE
ImageList_fx(int argc, VALUE *argv, VALUE self)
{
    Image *images, *new_image;
    char *expression;
    ChannelType channels;
    ExceptionInfo *exception;


    channels = extract_channels(&argc, argv);

    // There must be exactly 1 remaining argument.
    if (argc == 0)
    {
        rb_raise(rb_eArgError, "wrong number of arguments (0 for 1 or more)");
    }
    else if (argc > 1)
    {
        raise_ChannelType_error(argv[argc-1]);
    }

    expression = StringValuePtr(argv[0]);

    images = images_from_imagelist(self);
    exception = AcquireExceptionInfo();
    new_image = FxImageChannel(images, channels, expression, exception);
    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_image);

    return rm_image_new(new_image);
}

#insert(index, *args) ⇒ Object 



1549
1550
1551
1552
1553
1554
1555
 
# File 'lib/rmagick_internal.rb', line 1549

def insert(index, *args)
  args.each { |image| is_an_image image }
  current = get_current
  @images.insert(index, *args)
  set_current current
  self
end

#inspect ⇒ Object

Call inspect for all the images



1558
1559
1560
1561
1562
 
# File 'lib/rmagick_internal.rb', line 1558

def inspect
  img = []
  @images.each { |image| img << image.inspect }
  img = '[' + img.join(",\n") + "]\nscene=#{@scene}"
end

#iterations=(n) ⇒ Object

Set the number of iterations of an animated GIF



1565
1566
1567
1568
1569
1570
 
# File 'lib/rmagick_internal.rb', line 1565

def iterations=(n)
  n = Integer(n)
  Kernel.raise ArgumentError, 'iterations must be between 0 and 65535' if n < 0 || n > 65_535
  @images.each { |f| f.iterations = n }
  self
end

#last(*args) ⇒ Object 



1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
 
# File 'lib/rmagick_internal.rb', line 1572

def last(*args)
  if args.length.zero?
    a = @images.last
  else
    a = @images.last(*args)
    ilist = self.class.new
    a.each { |img| ilist << img }
    @scene = a.length - 1
    a = ilist
  end
  a
end

#map(*args) ⇒ Object

Call MapImages.

Ruby usage:

- @verbatim ImageList#map(reference) @endverbatim
- @verbatim ImageList#map(reference, dither) @endverbatim

Notes:

- Default dither is false
- Sets \@scene to self.scene

Parameters:

  • argc —

    number of input arguments

  • argv —

    array of input arguments

  • self —

    this object

Returns:

  • a new ImageList with mapped images.



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
 
# File 'ext/RMagick/rmilist.c', line 420

VALUE
ImageList_map(int argc, VALUE *argv, VALUE self)
{
    Image *images, *new_images = NULL;
    Image *map;
    unsigned int dither = MagickFalse;
    VALUE scene, new_imagelist, t;
    ExceptionInfo *exception;

#if defined(HAVE_REMAPIMAGES)
    QuantizeInfo quantize_info;
    rb_warning("ImageList#map is deprecated. Use ImageList#remap instead.");
#endif

    switch (argc)
    {
        case 2:
            dither = RTEST(argv[1]);
        case 1:
            t = rm_cur_image(argv[0]);
            map = rm_check_destroyed(t);
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 1 or 2)", argc);
            break;
    }


    // Convert image array to image sequence, clone image sequence.
    exception = AcquireExceptionInfo();

    images = images_from_imagelist(self);
    new_images = CloneImageList(images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_images);

    // Call ImageMagick
#if defined(HAVE_REMAPIMAGES)
    GetQuantizeInfo(&quantize_info);
    quantize_info.dither = dither;
    (void) RemapImages(&quantize_info, new_images, map);
#else
    (void) MapImages(new_images, map, dither);
#endif
    rm_check_image_exception(new_images, DestroyOnError);

    // Set @scene in new ImageList object to same value as in self.
    new_imagelist = rm_imagelist_from_images(new_images);
    scene = rb_iv_get(self, "@scene");
    (void) imagelist_scene_eq(new_imagelist, scene);

    RB_GC_GUARD(scene);
    RB_GC_GUARD(new_imagelist);
    RB_GC_GUARD(t);

    return new_imagelist;
}

#marshal_dump ⇒ Object

Custom marshal/unmarshal for Ruby 1.8.



1586
1587
1588
1589
1590
 
# File 'lib/rmagick_internal.rb', line 1586

def marshal_dump
  ary = [@scene]
  @images.each { |i| ary << Marshal.dump(i) }
  ary
end

#marshal_load(ary) ⇒ Object 



1592
1593
1594
1595
1596
 
# File 'lib/rmagick_internal.rb', line 1592

def marshal_load(ary)
  @scene = ary.shift
  @images = []
  ary.each { |a| @images << Marshal.load(a) }
end

#montage ⇒ Object

Call MontageImages.

Ruby usage:

- @verbatim ImageList#montage <{parm block}> @endverbatim

Notes:

- Creates Montage object, yields to block if present in Montage object's
  scope.

Parameters:

  • self —

    this object

Returns:

  • a new image list



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
 
# File 'ext/RMagick/rmilist.c', line 495

VALUE
ImageList_montage(VALUE self)
{
    VALUE montage_obj;
    Montage *montage;
    Image *new_images, *images;
    ExceptionInfo *exception;

    // Create a new instance of the Magick::Montage class
    montage_obj = rm_montage_new();
    if (rb_block_given_p())
    {
        // Run the block in the instance's context, allowing the app to modify the
        // object's attributes.
        (void) rb_obj_instance_eval(0, NULL, montage_obj);
    }

    Data_Get_Struct(montage_obj, Montage, montage);

    images = images_from_imagelist(self);

    // If app specified a non-default composition operator, use it for all images.
    if (montage->compose != UndefinedCompositeOp)
    {
        Image *i;
        for (i = images; i; i = GetNextImageInList(i))
        {
            i->compose = montage->compose;
        }
    }

    exception = AcquireExceptionInfo();

    // MontageImage can return more than one image.
    new_images = MontageImages(images, montage->info, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_images);

    RB_GC_GUARD(montage_obj);

    return rm_imagelist_from_images(new_images);
}

#morph(nimages) ⇒ Object

Requires a minimum of two images. The first image is transformed into the second by a number of intervening images as specified by “number_images”.

Ruby usage:

- @verbatim ImageList#morph(number_images) @endverbatim

Notes:

- Sets \@scenes to 0

Parameters:

  • self —

    this object

  • nimages —

    the number of images

Returns:

  • a new image list with the images array set to the morph sequence.



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
 
# File 'ext/RMagick/rmilist.c', line 556

VALUE
ImageList_morph(VALUE self, VALUE nimages)
{
    Image *images, *new_images;
    ExceptionInfo *exception;
    long number_images;


    // Use a signed long so we can test for a negative argument.
    number_images = NUM2LONG(nimages);
    if (number_images <= 0)
    {
        rb_raise(rb_eArgError, "number of intervening images must be > 0");
    }

    exception = AcquireExceptionInfo();
    images = images_from_imagelist(self);
    new_images = MorphImages(images, (unsigned long)number_images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_images);

    return rm_imagelist_from_images(new_images);
}

#mosaic ⇒ Object

Merge all the images into a single image.

Ruby usage:

- @verbatim ImageList#mosaic @endverbatim

Parameters:

  • self —

    this object

Returns:

  • the new image



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'ext/RMagick/rmilist.c', line 593

VALUE
ImageList_mosaic(VALUE self)
{
    Image *images, *new_image;
    ExceptionInfo *exception;

    exception = AcquireExceptionInfo();
    images = images_from_imagelist(self);

#if defined(HAVE_ENUM_MOSAICLAYER)
    new_image = MergeImageLayers(images, MosaicLayer, exception);
#else
    new_image = MosaicImages(images, exception);
#endif

    rm_split(images);
    rm_check_exception(exception, new_image, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_image);

    return rm_image_new(new_image);
}

#new_image(cols, rows, *fill, &info_blk) ⇒ Object

Create a new image and add it to the end



1616
1617
1618
 
# File 'lib/rmagick_internal.rb', line 1616

def new_image(cols, rows, *fill, &info_blk)
  self << Magick::Image.new(cols, rows, *fill, &info_blk)
end

#nitems ⇒ Object 



1381
1382
1383
 
# File 'lib/rmagick_internal.rb', line 1381

def nitems
  @images.nitems
end

#optimize_layers(method) ⇒ Object

Equivalent to -layers option in ImageMagick 6.2.6.

Ruby usage:

- @verbatim ImageList#optimize_layers(method) @endverbatim

Parameters:

  • self —

    this object

  • method —

    the method to use

Returns:

  • a new imagelist



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
 
# File 'ext/RMagick/rmilist.c', line 628

VALUE
ImageList_optimize_layers(VALUE self, VALUE method)
{
    Image *images, *new_images, *new_images2;
    LAYERMETHODTYPE mthd;
    ExceptionInfo *exception;
    QuantizeInfo quantize_info;

    new_images2 = NULL;     // defeat "unused variable" message

    exception = AcquireExceptionInfo();
#if defined(HAVE_TYPE_IMAGELAYERMETHOD)
    VALUE_TO_ENUM(method, mthd, ImageLayerMethod);
#else
    VALUE_TO_ENUM(method, mthd, MagickLayerMethod);
#endif
    images = images_from_imagelist(self);

    switch (mthd)
    {
        case CoalesceLayer:
            new_images = CoalesceImages(images, exception);
            break;
        case DisposeLayer:
            new_images = DisposeImages(images, exception);
            break;
        case OptimizeTransLayer:
            new_images = clone_imagelist(images);
            OptimizeImageTransparency(new_images, exception);
            break;
        case RemoveDupsLayer:
            new_images = clone_imagelist(images);
            RemoveDuplicateLayers(&new_images, exception);
            break;
        case RemoveZeroLayer:
            new_images = clone_imagelist(images);
            RemoveZeroDelayLayers(&new_images, exception);
            break;
        case CompositeLayer:
            rm_split(images);
            rb_raise(rb_eNotImpError, "Magick::CompositeLayer is not supported. Use the composite_layers method instead.");
            break;
            // In 6.3.4-ish, OptimizeImageLayer replaced OptimizeLayer
        case OptimizeImageLayer:
            new_images = OptimizeImageLayers(images, exception);
            break;
            // and OptimizeLayer became a "General Purpose, GIF Animation Optimizer" (ref. mogrify.c)
        case OptimizeLayer:
            new_images = CoalesceImages(images, exception);
            rm_split(images);
            rm_check_exception(exception, new_images, DestroyOnError);
            new_images2 = OptimizeImageLayers(new_images, exception);
            DestroyImageList(new_images);
            rm_check_exception(exception, new_images2, DestroyOnError);
            new_images = new_images2;
            OptimizeImageTransparency(new_images, exception);
            rm_check_exception(exception, new_images, DestroyOnError);
            // mogrify supports -dither here. We don't.
#if defined(HAVE_REMAPIMAGE)
            GetQuantizeInfo(&quantize_info);
            (void) RemapImages(&quantize_info, new_images, NULL);
#else
            (void) MapImages(new_images, NULL, 0);
#endif
            break;
        case OptimizePlusLayer:
            new_images = OptimizePlusImageLayers(images, exception);
            break;
        case CompareAnyLayer:
        case CompareClearLayer:
        case CompareOverlayLayer:
            new_images = CompareImageLayers(images, mthd, exception);
            break;
#if defined(HAVE_ENUM_MOSAICLAYER)
        case MosaicLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
#endif
#if defined(HAVE_ENUM_FLATTENLAYER)
        case FlattenLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
#endif
#if defined(HAVE_ENUM_MERGELAYER)
        case MergeLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
#endif
#if defined(HAVE_ENUM_TRIMBOUNDSLAYER)
        case TrimBoundsLayer:
            new_images = MergeImageLayers(images, mthd, exception);
            break;
#endif
        default:
            rm_split(images);
            rb_raise(rb_eArgError, "undefined layer method");
            break;
    }

    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    rm_ensure_result(new_images);

    return rm_imagelist_from_images(new_images);
}

#partition(&block) ⇒ Object 



1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/rmagick_internal.rb', line 1620

def partition(&block)
  a = @images.partition(&block)
  t = self.class.new
  a[0].each { |img| t << img }
  t.set_current nil
  f = self.class.new
  a[1].each { |img| f << img }
  f.set_current nil
  [t, f]
end

#ping(*files, &block) ⇒ Object

Ping files and concatenate the new images



1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/rmagick_internal.rb', line 1632

def ping(*files, &block)
  Kernel.raise ArgumentError, 'no files given' if files.length.zero?
  files.each do |f|
    Magick::Image.ping(f, &block).each { |n| @images << n }
  end
  @scene = length - 1
  self
end

#pop ⇒ Object 



1641
1642
1643
1644
1645
1646
 
# File 'lib/rmagick_internal.rb', line 1641

def pop
  current = get_current
  a = @images.pop # can return nil
  set_current current
  a
end

#push(*objs) ⇒ Object 



1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/rmagick_internal.rb', line 1648

def push(*objs)
  objs.each do |image|
    is_an_image image
    @images << image
  end
  @scene = length - 1
  self
end

#quantize(*args) ⇒ Object

Call QuantizeImages.

Ruby usage:

- @verbatim ImageList#quantize @endverbatim
- @verbatim ImageList#quantize(number_colors) @endverbatim
- @verbatim ImageList#quantize(number_colors, colorspace) @endverbatim
- @verbatim ImageList#quantize(number_colors, colorspace, dither) @endverbatim
- @verbatim ImageList#quantize(number_colors, colorspace, dither, tree_depth) @endverbatim
- @verbatim ImageList#quantize(number_colors, colorspace, dither, tree_depth, measure_error) @endverbatim

Notes:

- Default number_colors is 256
- Default coorspace is Magick::RGBColorsapce
- Default dither is true
- Default tree_depth is 0
- Default measure_error is false
- Sets \@scene to the same value as self.scene

Parameters:

  • argc —

    number of input arguments

  • argv —

    array of input arguments

  • self —

    this object

Returns:

  • a new ImageList with quantized images



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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'ext/RMagick/rmilist.c', line 964

VALUE
ImageList_quantize(int argc, VALUE *argv, VALUE self)
{
    Image *images, *new_images;
    Image *new_image;
    QuantizeInfo quantize_info;
    ExceptionInfo *exception;
    VALUE new_imagelist, scene;

    GetQuantizeInfo(&quantize_info);

    switch (argc)
    {
        case 5:
            quantize_info.measure_error = (MagickBooleanType) RTEST(argv[4]);
        case 4:
            quantize_info.tree_depth = (unsigned long)NUM2INT(argv[3]);
        case 3:
#if defined(HAVE_TYPE_DITHERMETHOD) && defined(HAVE_ENUM_NODITHERMETHOD)
            if (rb_obj_is_kind_of(argv[2], Class_DitherMethod))
            {
                VALUE_TO_ENUM(argv[2], quantize_info.dither_method, DitherMethod);
                quantize_info.dither = quantize_info.dither_method != NoDitherMethod;
            }
#else
            quantize_info.dither = (MagickBooleanType) RTEST(argv[2]);
#endif
        case 2:
            VALUE_TO_ENUM(argv[1], quantize_info.colorspace, ColorspaceType);
        case 1:
            quantize_info.number_colors = NUM2ULONG(argv[0]);
        case 0:
            break;
        default:
            rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 to 5)", argc);
            break;
    }


    // Convert image array to image sequence, clone image sequence.
    exception = AcquireExceptionInfo();
    images = images_from_imagelist(self);
    new_images = CloneImageList(images, exception);
    rm_split(images);
    rm_check_exception(exception, new_images, DestroyOnError);

    rm_ensure_result(new_images);


    (void) QuantizeImages(&quantize_info, new_images);
    rm_check_exception(exception, new_images, DestroyOnError);
    (void) DestroyExceptionInfo(exception);

    // Create new ImageList object, convert mapped image sequence to images,
    // append to images array.
    new_imagelist = ImageList_new();
    while ((new_image = RemoveFirstImageFromList(&new_images)))
    {
        imagelist_push(new_imagelist, rm_image_new(new_image));
    }

    // Set @scene in new ImageList object to same value as in self.
    scene = rb_iv_get(self, "@scene");
    (void) rb_iv_set(new_imagelist, "@scene", scene);

    RB_GC_GUARD(new_imagelist);
    RB_GC_GUARD(scene);

    return new_imagelist;
}

#read(*files, &block) ⇒ Object

Read files and concatenate the new images



1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/rmagick_internal.rb', line 1658

def read(*files, &block)
  Kernel.raise ArgumentError, 'no files given' if files.length.zero?
  files.each do |f|
    Magick::Image.read(f, &block).each { |n| @images << n }
  end
  @scene = length - 1
  self
end

#reject(&block) ⇒ Object

override Enumerable’s reject



1668
1669
1670
1671
1672
1673
1674
1675
 
# File 'lib/rmagick_internal.rb', line 1668

def reject(&block)
  current = get_current
  ilist = self.class.new
  a = @images.reject(&block)
  a.each { |image| ilist << image }
  ilist.set_current current
  ilist
end

#reject!(&block) ⇒ Object 



1677
1678
1679
1680
1681
1682
1683
 
# File 'lib/rmagick_internal.rb', line 1677

def reject!(&block)
  current = get_current
  a = @images.reject!(&block)
  @images = a unless a.nil?
  set_current current
  a.nil? ? nil : self
end

#remap(*args) ⇒ Object Also known as: affinity

Call RemapImages.

Ruby usage:

- @verbatim ImageList#remap @endverbatim
- @verbatim ImageList#remap(remap_image) @endverbatim
- @verbatim ImageList#remap(remap_image, dither_method) @endverbatim

Notes:

- Default remap_image is nil
- Default dither_method is RiemersmaDitherMethod
- Modifies images in-place.

Parameters:

  • argc —

    number of input arguments

  • argv —

    array of input arguments

  • self —

    this object

See Also:

  • Image_remap


1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'ext/RMagick/rmilist.c', line 1054

VALUE
ImageList_remap(int argc, VALUE *argv, VALUE self)
{
#if defined(HAVE_REMAPIMAGES) || defined(HAVE_AFFINITYIMAGES)
    Image *images, *remap_image = NULL;
    QuantizeInfo quantize_info;


    if (argc > 0 && argv[0] != Qnil)
    {
        VALUE t = rm_cur_image(argv[0]);
        remap_image = rm_check_destroyed(t);
        RB_GC_GUARD(t);
    }

    GetQuantizeInfo(&quantize_info);

    if (argc > 1)
    {
        VALUE_TO_ENUM(argv[1], quantize_info.dither_method, DitherMethod);
        quantize_info.dither = MagickTrue;
    }
    if (argc > 2)
    {
        rb_raise(rb_eArgError, "wrong number of arguments (%d for 1 or 2)", argc);
    }

    images = images_from_imagelist(self);

#if defined(HAVE_REMAPIMAGE)
    (void) RemapImages(&quantize_info, images, remap_image);
#else
    (void) AffinityImages(&quantize_info, images, remap_image);
#endif
    rm_check_image_exception(images, RetainOnError);
    rm_split(images);

    return self;
#else
    self = self;
    argc = argc;
    argv = argv;
    rm_not_implemented();
    return(VALUE)0;
#endif
}

#replace(other) ⇒ Object 



1685
1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/rmagick_internal.rb', line 1685

def replace(other)
  is_an_image_array other
  current = get_current
  @images.clear
  other.each { |image| @images << image }
  @scene = length.zero? ? nil : 0
  set_current current
  self
end

#respond_to?(meth_id, priv = false) ⇒ Boolean

Returns:

  • (Boolean) 


1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'lib/rmagick_internal.rb', line 1697

def respond_to?(meth_id, priv = false)
  return true if __respond_to__?(meth_id, priv)

  if @scene
    @images[@scene].respond_to?(meth_id, priv)
  else
    super
  end
end

#reverse ⇒ Object 



1707
1708
1709
1710
1711
1712
1713
 
# File 'lib/rmagick_internal.rb', line 1707

def reverse
  current = get_current
  a = self.class.new
  @images.reverse_each { |image| a << image }
  a.set_current current
  a
end

#reverse! ⇒ Object 



1715
1716
1717
1718
1719
1720
 
# File 'lib/rmagick_internal.rb', line 1715

def reverse!
  current = get_current
  @images.reverse!
  set_current current
  self
end

#reverse_each ⇒ Object 



1722
1723
1724
1725
 
# File 'lib/rmagick_internal.rb', line 1722

def reverse_each
  @images.reverse_each { |image| yield(image) }
  self
end

#shift ⇒ Object 



1727
1728
1729
1730
1731
1732
 
# File 'lib/rmagick_internal.rb', line 1727

def shift
  current = get_current
  a = @images.shift
  set_current current
  a
end

#slice(*args) ⇒ Object 



1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
 
# File 'lib/rmagick_internal.rb', line 1734

def slice(*args)
  slice = @images.slice(*args)
  if slice
    ilist = self.class.new
    if slice.respond_to?(:each)
      slice.each { |image| ilist << image }
    else
      ilist << slice
    end
  else
    ilist = nil
  end
  ilist
end

#slice!(*args) ⇒ Object 



1749
1750
1751
1752
1753
1754
 
# File 'lib/rmagick_internal.rb', line 1749

def slice!(*args)
  current = get_current
  a = @images.slice!(*args)
  set_current current
  a
end

#ticks_per_second=(t) ⇒ Object 



1756
1757
1758
1759
 
# File 'lib/rmagick_internal.rb', line 1756

def ticks_per_second=(t)
  Kernel.raise ArgumentError, 'ticks_per_second must be greater than or equal to 0' if Integer(t) < 0
  @images.each { |f| f.ticks_per_second = Integer(t) }
end

#to_a ⇒ Object 



1761
1762
1763
1764
1765
 
# File 'lib/rmagick_internal.rb', line 1761

def to_a
  a = []
  @images.each { |image| a << image }
  a
end

#to_blob ⇒ Object

Return the imagelist as a blob (a String).

Ruby usage:

- @verbatim ImageList#to_blob @endverbatim

Notes:

- Runs an info parm block if present - the user can specify the image
  format and depth

Parameters:

  • self —

    this object

Returns:

  • the blob



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'ext/RMagick/rmilist.c', line 1115

VALUE
ImageList_to_blob(VALUE self)
{
    Image *images, *image;
    Info *info;
    VALUE info_obj;
    VALUE blob_str;
    void *blob = NULL;
    size_t length = 0;
    ExceptionInfo *exception;

    info_obj = rm_info_new();
    Data_Get_Struct(info_obj, Info, info);

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    exception = AcquireExceptionInfo();
    (void) SetImageInfo(info, MagickTrue, exception);
    rm_check_exception(exception, images, RetainOnError);

    if (*info->magick != '\0')
    {
        Image *img;
        for (img = images; img; img = GetNextImageInList(img))
        {
            strncpy(img->magick, info->magick, sizeof(info->magick)-1);
        }
    }

    for (image = images; image; image = GetNextImageInList(image))
    {
        rm_sync_image_options(image, info);
    }

    // Unconditionally request multi-images support. The worst that
    // can happen is that there's only one image or the format
    // doesn't support multi-image files.
    info->adjoin = MagickTrue;
    blob = ImagesToBlob(info, images, &length, exception);
    if (blob && exception->severity >= ErrorException)
    {
        magick_free((void*)blob);
        blob = NULL;
        length = 0;
    }
    rm_split(images);
    CHECK_EXCEPTION()
    (void) DestroyExceptionInfo(exception);


    if (length == 0 || !blob)
    {
        return Qnil;
    }

    blob_str = rb_str_new(blob, (long)length);
    magick_free((void*)blob);

    RB_GC_GUARD(info_obj);
    RB_GC_GUARD(blob_str);

    return blob_str;
}

#uniq ⇒ Object 



1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/rmagick_internal.rb', line 1767

def uniq
  current = get_current
  a = self.class.new
  @images.uniq.each { |image| a << image }
  a.set_current current
  a
end

#uniq!(*_args) ⇒ Object 



1775
1776
1777
1778
1779
1780
 
# File 'lib/rmagick_internal.rb', line 1775

def uniq!(*_args)
  current = get_current
  a = @images.uniq!
  set_current current
  a.nil? ? nil : self
end

#unshift(obj) ⇒ Object 



1783
1784
1785
1786
1787
1788
 
# File 'lib/rmagick_internal.rb', line 1783

def unshift(obj)
  is_an_image obj
  @images.unshift(obj)
  @scene = 0
  self
end

#values_at(*args) ⇒ Object Also known as: indexes, indices 



1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/rmagick_internal.rb', line 1790

def values_at(*args)
  a = @images.values_at(*args)
  a = self.class.new
  @images.values_at(*args).each { |image| a << image }
  a.scene = a.length - 1
  a
end

#write(file) ⇒ Object

Write all the images to the specified file. If the file format supports multi-image files, and the ‘images’ array contains more than one image, then the images will be written as a single multi-image file. Otherwise each image will be written to a separate file.

Ruby usage:

- @verbatim ImageList#write(file) @endverbatim

Parameters:

  • self —

    this object

  • file —

    the file

Returns:

  • self



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'ext/RMagick/rmilist.c', line 1194

VALUE
ImageList_write(VALUE self, VALUE file)
{
    Image *images, *img;
    Info *info;
    const MagickInfo *m;
    VALUE info_obj;
    unsigned long scene;
    ExceptionInfo *exception;

    info_obj = rm_info_new();
    Data_Get_Struct(info_obj, Info, info);


    if (TYPE(file) == T_FILE)
    {
        OpenFile *fptr;

        // Ensure file is open - raise error if not
        GetOpenFile(file, fptr);
#if defined(_WIN32)
        add_format_prefix(info, fptr->pathv);
        SetImageInfoFile(info, NULL);
#else
        SetImageInfoFile(info, GetReadFile(fptr));
#endif
    }
    else
    {
        add_format_prefix(info, file);
        SetImageInfoFile(info, NULL);
    }

    // Convert the images array to an images sequence.
    images = images_from_imagelist(self);

    // Copy the filename into each image. Set a scene number to be used if
    // writing multiple files. (Ref: ImageMagick's utilities/convert.c
    for (scene = 0, img = images; img; img = GetNextImageInList(img))
    {
        img->scene = scene++;
        strcpy(img->filename, info->filename);
    }

    // Find out if the format supports multi-images files.
    exception = AcquireExceptionInfo();
    (void) SetImageInfo(info, MagickTrue, exception);
    rm_check_exception(exception, images, RetainOnError);

    m = GetMagickInfo(info->magick, exception);
    rm_check_exception(exception, images, RetainOnError);
    (void) DestroyExceptionInfo(exception);

    // Tell WriteImage if we want a multi-images file.
    if (imagelist_length(self) > 1L && m->adjoin)
    {
        info->adjoin = MagickTrue;
    }

    for (img = images; img; img = GetNextImageInList(img))
    {
        rm_sync_image_options(img, info);
        (void) WriteImage(info, img);
        // images will be split before raising an exception
        rm_check_image_exception(images, RetainOnError);
        if (info->adjoin)
        {
            break;
        }
    }

    rm_split(images);

    RB_GC_GUARD(info_obj);

    return self;
}