src/nsimage.m

   1 /* Image support for the NeXT/Open/GNUstep and MacOSX window system.
   2    Copyright (C) 1989, 1992-1994, 2005-2006, 2008-2015 Free Software
   3    Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 /*
  21 Originally by Carl Edman
  22 Updated by Christian Limpach (chris@nice.ch)
  23 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
  24 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
  25 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
  26 */
  27
  28 /* This should be the first include, as it may set up #defines affecting
  29    interpretation of even the system includes. */
  30 #include <config.h>
  31
  32 #include "lisp.h"
  33 #include "dispextern.h"
  34 #include "nsterm.h"
  35 #include "frame.h"
  36
  37 extern Lisp_Object QCfile, QCdata;
  38
  39 /* call tracing */
  40 #if 0
  41 int image_trace_num = 0;
  42 #define NSTRACE(x)        fprintf (stderr, "%s:%d: [%d] " #x "\n",         \
  43                                 __FILE__, __LINE__, ++image_trace_num)
  44 #else
  45 #define NSTRACE(x)
  46 #endif
  47
  48
  49 /* ==========================================================================
  50
  51    C interface.  This allows easy calling from C files.  We could just
  52    compile everything as Objective-C, but that might mean slower
  53    compilation and possible difficulties on some platforms..
  54
  55    ========================================================================== */
  56
  57 void *
  58 ns_image_from_XBM (unsigned char *bits, int width, int height)
  59 {
  60   NSTRACE (ns_image_from_XBM);
  61   return [[EmacsImage alloc] initFromXBM: bits
  62                                    width: width height: height
  63                                     flip: YES];
  64 }
  65
  66 void *
  67 ns_image_for_XPM (int width, int height, int depth)
  68 {
  69   NSTRACE (ns_image_for_XPM);
  70   return [[EmacsImage alloc] initForXPMWithDepth: depth
  71                                            width: width height: height];
  72 }
  73
  74 void *
  75 ns_image_from_file (Lisp_Object file)
  76 {
  77   NSTRACE (ns_image_from_bitmap_file);
  78   return [EmacsImage allocInitFromFile: file];
  79 }
  80
  81 bool
  82 ns_load_image (struct frame *f, struct image *img,
  83                Lisp_Object spec_file, Lisp_Object spec_data)
  84 {
  85   EmacsImage *eImg = nil;
  86   NSSize size;
  87
  88   NSTRACE (ns_load_image);
  89
  90   if (STRINGP (spec_file))
  91     {
  92       eImg = [EmacsImage allocInitFromFile: spec_file];
  93     }
  94   else if (STRINGP (spec_data))
  95     {
  96       NSData *data;
  97
  98       data = [NSData dataWithBytes: SSDATA (spec_data)
  99                             length: SBYTES (spec_data)];
 100       eImg = [[EmacsImage alloc] initWithData: data];
 101       [eImg setPixmapData];
 102     }
 103
 104   if (eImg == nil)
 105     {
 106       add_to_log ("Unable to load image %s", img->spec, Qnil);
 107       return 0;
 108     }
 109
 110   size = [eImg size];
 111   img->width = size.width;
 112   img->height = size.height;
 113
 114   /* 4) set img->pixmap = emacsimage */
 115   img->pixmap = eImg;
 116   return 1;
 117 }
 118
 119
 120 int
 121 ns_image_width (void *img)
 122 {
 123   return [(id)img size].width;
 124 }
 125
 126 int
 127 ns_image_height (void *img)
 128 {
 129   return [(id)img size].height;
 130 }
 131
 132 unsigned long
 133 ns_get_pixel (void *img, int x, int y)
 134 {
 135   return [(EmacsImage *)img getPixelAtX: x Y: y];
 136 }
 137
 138 void
 139 ns_put_pixel (void *img, int x, int y, unsigned long argb)
 140 {
 141   unsigned char alpha = (argb >> 24) & 0xFF;
 142   if (alpha == 0)
 143     alpha = 0xFF;
 144   [(EmacsImage *)img setPixelAtX: x Y: y toRed: (argb >> 16) & 0xFF
 145    green: (argb >> 8) & 0xFF blue: (argb & 0xFF) alpha: alpha];
 146 }
 147
 148 void
 149 ns_set_alpha (void *img, int x, int y, unsigned char a)
 150 {
 151   [(EmacsImage *)img setAlphaAtX: x Y: y to: a];
 152 }
 153
 154
 155 /* ==========================================================================
 156
 157    Class supporting bitmaps and images of various sorts.
 158
 159    ========================================================================== */
 160
 161 @implementation EmacsImage
 162
 163 + allocInitFromFile: (Lisp_Object)file
 164 {
 165   NSImageRep *imgRep;
 166   Lisp_Object found;
 167   EmacsImage *image;
 168
 169   /* Search bitmap-file-path for the file, if appropriate.  */
 170   found = x_find_image_file (file);
 171   if (!STRINGP (found))
 172     return nil;
 173
 174   image = [[EmacsImage alloc] initByReferencingFile:
 175                      [NSString stringWithUTF8String: SSDATA (found)]];
 176
 177   image->bmRep = nil;
 178 #ifdef NS_IMPL_COCOA
 179   imgRep = [NSBitmapImageRep imageRepWithData:[image TIFFRepresentation]];
 180 #else
 181   imgRep = [image bestRepresentationForDevice: nil];
 182 #endif
 183   if (imgRep == nil)
 184     {
 185       [image release];
 186       return nil;
 187     }
 188
 189   /* The next two lines cause the DPI of the image to be ignored.
 190      This seems to be the behavior users expect. */
 191   [image setScalesWhenResized: YES];
 192   [image setSize: NSMakeSize([imgRep pixelsWide], [imgRep pixelsHigh])];
 193
 194   [image setName: [NSString stringWithUTF8String: SSDATA (file)]];
 195
 196   return image;
 197 }
 198
 199
 200 - (void)dealloc
 201 {
 202   [stippleMask release];
 203   [bmRep release];
 204   [super dealloc];
 205 }
 206
 207
 208 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
 209          flip: (BOOL)flip
 210 {
 211   return [self initFromSkipXBM: bits width: w height: h flip: flip length: 0];
 212 }
 213
 214
 215 - initFromSkipXBM: (unsigned char *)bits width: (int)w height: (int)h
 216              flip: (BOOL)flip length: (int)length;
 217 {
 218   int bpr = (w + 7) / 8;
 219   unsigned char *planes[5];
 220
 221   [self initWithSize: NSMakeSize (w, h)];
 222
 223   bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
 224                                     pixelsWide: w pixelsHigh: h
 225                                     bitsPerSample: 8 samplesPerPixel: 4
 226                                     hasAlpha: YES isPlanar: YES
 227                                     colorSpaceName: NSCalibratedRGBColorSpace
 228                                     bytesPerRow: w bitsPerPixel: 0];
 229
 230   [bmRep getBitmapDataPlanes: planes];
 231   {
 232     /* pull bits out to set the (bytewise) alpha mask */
 233     int i, j, k;
 234     unsigned char *s = bits;
 235     unsigned char *alpha = planes[3];
 236     unsigned char swt[16] = {0, 8, 4, 12, 2, 10, 6, 14, 1, 9, 5, 13,
 237                              3, 11, 7, 15};
 238     unsigned char c, bitPat;
 239
 240     for (j = 0; j < h; j++)
 241       for (i = 0; i < bpr; i++)
 242         {
 243           if (length)
 244             {
 245               unsigned char s1, s2;
 246               while (*s++ != 'x' && s < bits + length);
 247               if (s >= bits + length)
 248                 {
 249                   [bmRep release];
 250                   bmRep = nil;
 251                   return nil;
 252                 }
 253 #define hexchar(x) ('0' <= (x) && (x) <= '9' ? (x) - '0' : (x) - 'a' + 10)
 254               s1 = *s++;
 255               s2 = *s++;
 256               c = hexchar (s1) * 0x10 + hexchar (s2);
 257             }
 258           else
 259             c = *s++;
 260
 261           bitPat = flip ? swt[c >> 4] | (swt[c & 0xf] << 4) : c ^ 255;
 262           for (k =0; k<8; k++)
 263             {
 264               *alpha++ = (bitPat & 0x80) ? 0xff : 0;
 265               bitPat <<= 1;
 266             }
 267         }
 268   }
 269
 270   [self addRepresentation: bmRep];
 271
 272   memset (planes[0], 0, w*h);
 273   memset (planes[1], 0, w*h);
 274   memset (planes[2], 0, w*h);
 275   [self setXBMColor: [NSColor blackColor]];
 276   return self;
 277 }
 278
 279
 280 /* Set color for a bitmap image (see initFromSkipXBM).  Note that the alpha
 281    is used as a mask, so we just memset the entire array. */
 282 - setXBMColor: (NSColor *)color
 283 {
 284   NSSize s = [self size];
 285   unsigned char *planes[5];
 286   EmacsCGFloat r, g, b, a;
 287   NSColor *rgbColor;
 288
 289   if (bmRep == nil || color == nil)
 290     return self;
 291
 292   if ([color colorSpaceName] != NSCalibratedRGBColorSpace)
 293     rgbColor = [color colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
 294   else
 295     rgbColor = color;
 296
 297   [rgbColor getRed: &r green: &g blue: &b alpha: &a];
 298
 299   [bmRep getBitmapDataPlanes: planes];
 300
 301   /* we used to just do this, but Cocoa seems to have a bug when rendering
 302      an alpha-masked image onto a dark background where it bloats the mask */
 303    /* memset (planes[0..2], r, g, b*0xff, len); */
 304   {
 305     int i, len = s.width*s.height;
 306     int rr = r * 0xff, gg = g * 0xff, bb = b * 0xff;
 307     for (i =0; i<len; i++)
 308       if (planes[3][i] != 0)
 309         {
 310           planes[0][i] = rr;
 311           planes[1][i] = gg;
 312           planes[2][i] = bb;
 313         }
 314   }
 315
 316   return self;
 317 }
 318
 319
 320 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height
 321 {
 322   NSSize s = {width, height};
 323   int i;
 324
 325   [self initWithSize: s];
 326
 327   bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
 328                                   pixelsWide: width pixelsHigh: height
 329                                   /* keep things simple for now */
 330                                   bitsPerSample: 8 samplesPerPixel: 4 /*RGB+A*/
 331                                   hasAlpha: YES isPlanar: YES
 332                                   colorSpaceName: NSCalibratedRGBColorSpace
 333                                   bytesPerRow: width bitsPerPixel: 0];
 334
 335   [bmRep getBitmapDataPlanes: pixmapData];
 336   for (i =0; i<4; i++)
 337     memset (pixmapData[i], 0, width*height);
 338   [self addRepresentation: bmRep];
 339   return self;
 340 }
 341
 342
 343 /* attempt to pull out pixmap data from a BitmapImageRep; returns NO if fails */
 344 - (void) setPixmapData
 345 {
 346   NSEnumerator *reps;
 347   NSImageRep *rep;
 348
 349   reps = [[self representations] objectEnumerator];
 350   while ((rep = (NSImageRep *) [reps nextObject]))
 351     {
 352       if ([rep respondsToSelector: @selector (getBitmapDataPlanes:)])
 353         {
 354           NSBitmapImageRep *bmr = (NSBitmapImageRep *) rep;
 355
 356           if ([bmr numberOfPlanes] >= 3)
 357               [bmr getBitmapDataPlanes: pixmapData];
 358
 359           /* The next two lines cause the DPI of the image to be ignored.
 360              This seems to be the behavior users expect. */
 361           [self setScalesWhenResized: YES];
 362           [self setSize: NSMakeSize([bmr pixelsWide], [bmr pixelsHigh])];
 363
 364           break;
 365         }
 366     }
 367 }
 368
 369
 370 /* note; this and next work only for image created with initForXPMWithDepth,
 371          initFromSkipXBM, or where setPixmapData was called successfully */
 372 /* return ARGB */
 373 - (unsigned long) getPixelAtX: (int)x Y: (int)y
 374 {
 375   if (bmRep == nil)
 376     return 0;
 377
 378   /* this method is faster but won't work for bitmaps */
 379   if (pixmapData[0] != NULL)
 380     {
 381       int loc = x + y * [self size].width;
 382       return (pixmapData[3][loc] << 24) /* alpha */
 383        | (pixmapData[0][loc] << 16) | (pixmapData[1][loc] << 8)
 384        | (pixmapData[2][loc]);
 385     }
 386   else
 387     {
 388       NSColor *color = [bmRep colorAtX: x y: y];
 389       EmacsCGFloat r, g, b, a;
 390       [color getRed: &r green: &g blue: &b alpha: &a];
 391       return ((int)(a * 255.0) << 24)
 392         | ((int)(r * 255.0) << 16) | ((int)(g * 255.0) << 8)
 393         | ((int)(b * 255.0));
 394
 395     }
 396 }
 397
 398 - (void) setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
 399                green: (unsigned char)g blue: (unsigned char)b
 400                alpha:(unsigned char)a;
 401 {
 402   if (bmRep == nil)
 403     return;
 404
 405   if (pixmapData[0] != NULL)
 406     {
 407       int loc = x + y * [self size].width;
 408       pixmapData[0][loc] = r;
 409       pixmapData[1][loc] = g;
 410       pixmapData[2][loc] = b;
 411       pixmapData[3][loc] = a;
 412     }
 413   else
 414     {
 415       [bmRep setColor:
 416                [NSColor colorWithCalibratedRed: (r/255.0) green: (g/255.0)
 417                                           blue: (b/255.0) alpha: (a/255.0)]
 418                   atX: x y: y];
 419     }
 420 }
 421
 422 - (void) setAlphaAtX: (int) x Y: (int) y to: (unsigned char) a
 423 {
 424   if (bmRep == nil)
 425     return;
 426
 427   if (pixmapData[0] != NULL)
 428     {
 429       int loc = x + y * [self size].width;
 430
 431       pixmapData[3][loc] = a;
 432     }
 433   else
 434     {
 435       NSColor *color = [bmRep colorAtX: x y: y];
 436       color = [color colorWithAlphaComponent: (a / 255.0)];
 437       [bmRep setColor: color atX: x y: y];
 438     }
 439 }
 440
 441 /* returns a pattern color, which is cached here */
 442 - (NSColor *)stippleMask
 443 {
 444   if (stippleMask == nil)
 445       stippleMask = [[NSColor colorWithPatternImage: self] retain];
 446   return stippleMask;
 447 }
 448
 449 @end