src/nsimage.m

   1 /* Image support for the NeXT/Open/GNUstep and macOS window system.
   2    Copyright (C) 1989, 1992-1994, 2005-2006, 2008-2017 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 (at
  10 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 macOS/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 #include "coding.h"
  37
  38
  39
  40 /* ==========================================================================
  41
  42    C interface.  This allows easy calling from C files.  We could just
  43    compile everything as Objective-C, but that might mean slower
  44    compilation and possible difficulties on some platforms..
  45
  46    ========================================================================== */
  47
  48 void *
  49 ns_image_from_XBM (char *bits, int width, int height,
  50                    unsigned long fg, unsigned long bg)
  51 {
  52   NSTRACE ("ns_image_from_XBM");
  53   return [[EmacsImage alloc] initFromXBM: (unsigned char *) bits
  54                                    width: width height: height
  55                                       fg: fg bg: bg];
  56 }
  57
  58 void *
  59 ns_image_for_XPM (int width, int height, int depth)
  60 {
  61   NSTRACE ("ns_image_for_XPM");
  62   return [[EmacsImage alloc] initForXPMWithDepth: depth
  63                                            width: width height: height];
  64 }
  65
  66 void *
  67 ns_image_from_file (Lisp_Object file)
  68 {
  69   NSTRACE ("ns_image_from_file");
  70   return [EmacsImage allocInitFromFile: file];
  71 }
  72
  73 bool
  74 ns_load_image (struct frame *f, struct image *img,
  75                Lisp_Object spec_file, Lisp_Object spec_data)
  76 {
  77   EmacsImage *eImg = nil;
  78   NSSize size;
  79
  80   NSTRACE ("ns_load_image");
  81
  82   if (STRINGP (spec_file))
  83     {
  84       eImg = [EmacsImage allocInitFromFile: spec_file];
  85     }
  86   else if (STRINGP (spec_data))
  87     {
  88       NSData *data;
  89
  90       data = [NSData dataWithBytes: SSDATA (spec_data)
  91                             length: SBYTES (spec_data)];
  92       eImg = [[EmacsImage alloc] initWithData: data];
  93       [eImg setPixmapData];
  94     }
  95
  96   if (eImg == nil)
  97     {
  98       add_to_log ("Unable to load image %s", img->spec);
  99       return 0;
 100     }
 101
 102   size = [eImg size];
 103   img->width = size.width;
 104   img->height = size.height;
 105
 106   /* 4) set img->pixmap = emacsimage */
 107   img->pixmap = eImg;
 108   return 1;
 109 }
 110
 111
 112 int
 113 ns_image_width (void *img)
 114 {
 115   return [(id)img size].width;
 116 }
 117
 118 int
 119 ns_image_height (void *img)
 120 {
 121   return [(id)img size].height;
 122 }
 123
 124 unsigned long
 125 ns_get_pixel (void *img, int x, int y)
 126 {
 127   return [(EmacsImage *)img getPixelAtX: x Y: y];
 128 }
 129
 130 void
 131 ns_put_pixel (void *img, int x, int y, unsigned long argb)
 132 {
 133   unsigned char alpha = (argb >> 24) & 0xFF;
 134   if (alpha == 0)
 135     alpha = 0xFF;
 136   [(EmacsImage *)img setPixelAtX: x Y: y toRed: (argb >> 16) & 0xFF
 137    green: (argb >> 8) & 0xFF blue: (argb & 0xFF) alpha: alpha];
 138 }
 139
 140 void
 141 ns_set_alpha (void *img, int x, int y, unsigned char a)
 142 {
 143   [(EmacsImage *)img setAlphaAtX: x Y: y to: a];
 144 }
 145
 146
 147 /* ==========================================================================
 148
 149    Class supporting bitmaps and images of various sorts.
 150
 151    ========================================================================== */
 152
 153 @implementation EmacsImage
 154
 155 + allocInitFromFile: (Lisp_Object)file
 156 {
 157   NSImageRep *imgRep;
 158   Lisp_Object found;
 159   EmacsImage *image;
 160
 161   /* Search bitmap-file-path for the file, if appropriate.  */
 162   found = x_find_image_file (file);
 163   if (!STRINGP (found))
 164     return nil;
 165   found = ENCODE_FILE (found);
 166
 167   image = [[EmacsImage alloc] initByReferencingFile:
 168                      [NSString stringWithUTF8String: SSDATA (found)]];
 169
 170   image->bmRep = nil;
 171 #ifdef NS_IMPL_COCOA
 172   imgRep = [NSBitmapImageRep imageRepWithData:[image TIFFRepresentation]];
 173 #else
 174   imgRep = [image bestRepresentationForDevice: nil];
 175 #endif
 176   if (imgRep == nil)
 177     {
 178       [image release];
 179       return nil;
 180     }
 181
 182   /* The next two lines cause the DPI of the image to be ignored.
 183      This seems to be the behavior users expect. */
 184 #ifdef NS_IMPL_COCOA
 185 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
 186   [image setScalesWhenResized: YES];
 187 #endif
 188 #endif
 189   [image setSize: NSMakeSize([imgRep pixelsWide], [imgRep pixelsHigh])];
 190
 191   [image setName: [NSString stringWithUTF8String: SSDATA (file)]];
 192
 193   return image;
 194 }
 195
 196
 197 - (void)dealloc
 198 {
 199   [stippleMask release];
 200   [bmRep release];
 201   [super dealloc];
 202 }
 203
 204
 205 /* Create image from monochrome bitmap. If both FG and BG are 0
 206    (black), set the background to white and make it transparent. */
 207 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
 208            fg: (unsigned long)fg bg: (unsigned long)bg
 209 {
 210   unsigned char *planes[5];
 211   unsigned char bg_alpha = 0xff;
 212
 213   [self initWithSize: NSMakeSize (w, h)];
 214
 215   bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
 216                                     pixelsWide: w pixelsHigh: h
 217                                     bitsPerSample: 8 samplesPerPixel: 4
 218                                     hasAlpha: YES isPlanar: YES
 219                                     colorSpaceName: NSCalibratedRGBColorSpace
 220                                     bytesPerRow: w bitsPerPixel: 0];
 221
 222   [bmRep getBitmapDataPlanes: planes];
 223
 224   if (fg == 0 && bg == 0)
 225     {
 226       bg = 0xffffff;
 227       bg_alpha = 0;
 228     }
 229
 230   {
 231     /* pull bits out to set the (bytewise) alpha mask */
 232     int i, j, k;
 233     unsigned char *s = bits;
 234     unsigned char *rr = planes[0];
 235     unsigned char *gg = planes[1];
 236     unsigned char *bb = planes[2];
 237     unsigned char *alpha = planes[3];
 238     unsigned char fgr = (fg >> 16) & 0xff;
 239     unsigned char fgg = (fg >> 8) & 0xff;
 240     unsigned char fgb = fg & 0xff;
 241     unsigned char bgr = (bg >> 16) & 0xff;
 242     unsigned char bgg = (bg >> 8) & 0xff;
 243     unsigned char bgb = bg & 0xff;
 244     unsigned char c;
 245
 246     int idx = 0;
 247     for (j = 0; j < h; ++j)
 248       for (i = 0; i < w; )
 249         {
 250           c = *s++;
 251           for (k = 0; i < w && k < 8; ++k, ++i)
 252             {
 253               if (c & 0x80)
 254                 {
 255                   *rr++ = fgr;
 256                   *gg++ = fgg;
 257                   *bb++ = fgb;
 258                   *alpha++ = 0xff;
 259                 }
 260               else
 261                 {
 262                   *rr++ = bgr;
 263                   *gg++ = bgg;
 264                   *bb++ = bgb;
 265                   *alpha++ = bg_alpha;
 266                 }
 267               idx++;
 268               c <<= 1;
 269             }
 270         }
 271   }
 272
 273   xbm_fg = fg;
 274   [self addRepresentation: bmRep];
 275   return self;
 276 }
 277
 278 /* Set color for a bitmap image.  */
 279 - setXBMColor: (NSColor *)color
 280 {
 281   NSSize s = [self size];
 282   unsigned char *planes[5];
 283   EmacsCGFloat r, g, b, a;
 284   NSColor *rgbColor;
 285
 286   if (bmRep == nil || color == nil)
 287     return self;
 288
 289   if ([color colorSpaceName] != NSCalibratedRGBColorSpace)
 290     rgbColor = [color colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
 291   else
 292     rgbColor = color;
 293
 294   [rgbColor getRed: &r green: &g blue: &b alpha: &a];
 295
 296   [bmRep getBitmapDataPlanes: planes];
 297
 298   {
 299     int i, len = s.width*s.height;
 300     int rr = r * 0xff, gg = g * 0xff, bb = b * 0xff;
 301     unsigned char fgr = (xbm_fg >> 16) & 0xff;
 302     unsigned char fgg = (xbm_fg >> 8) & 0xff;
 303     unsigned char fgb = xbm_fg & 0xff;
 304
 305     for (i = 0; i < len; ++i)
 306       if (planes[0][i] == fgr && planes[1][i] == fgg && planes[2][i] == fgb)
 307         {
 308           planes[0][i] = rr;
 309           planes[1][i] = gg;
 310           planes[2][i] = bb;
 311         }
 312     xbm_fg = ((rr << 16) & 0xff) + ((gg << 8) & 0xff) + (bb & 0xff);
 313   }
 314
 315   return self;
 316 }
 317
 318
 319 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height
 320 {
 321   NSSize s = {width, height};
 322   int i;
 323
 324   [self initWithSize: s];
 325
 326   bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
 327                                   pixelsWide: width pixelsHigh: height
 328                                   /* keep things simple for now */
 329                                   bitsPerSample: 8 samplesPerPixel: 4 /*RGB+A*/
 330                                   hasAlpha: YES isPlanar: YES
 331                                   colorSpaceName: NSCalibratedRGBColorSpace
 332                                   bytesPerRow: width bitsPerPixel: 0];
 333
 334   [bmRep getBitmapDataPlanes: pixmapData];
 335   for (i =0; i<4; i++)
 336     memset (pixmapData[i], 0, width*height);
 337   [self addRepresentation: bmRep];
 338   return self;
 339 }
 340
 341
 342 /* attempt to pull out pixmap data from a BitmapImageRep; returns NO if fails */
 343 - (void) setPixmapData
 344 {
 345   NSEnumerator *reps;
 346   NSImageRep *rep;
 347
 348   reps = [[self representations] objectEnumerator];
 349   while ((rep = (NSImageRep *) [reps nextObject]))
 350     {
 351       if ([rep respondsToSelector: @selector (getBitmapDataPlanes:)])
 352         {
 353           NSBitmapImageRep *bmr = (NSBitmapImageRep *) rep;
 354
 355           if ([bmr numberOfPlanes] >= 3)
 356               [bmr getBitmapDataPlanes: pixmapData];
 357
 358           /* The next two lines cause the DPI of the image to be ignored.
 359              This seems to be the behavior users expect. */
 360 #ifdef NS_IMPL_COCOA
 361 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
 362           [self setScalesWhenResized: YES];
 363 #endif
 364 #endif
 365           [self setSize: NSMakeSize([bmr pixelsWide], [bmr pixelsHigh])];
 366
 367           break;
 368         }
 369     }
 370 }
 371
 372
 373 /* note; this and next work only for image created with initForXPMWithDepth,
 374          initFromSkipXBM, or where setPixmapData was called successfully */
 375 /* return ARGB */
 376 - (unsigned long) getPixelAtX: (int)x Y: (int)y
 377 {
 378   if (bmRep == nil)
 379     return 0;
 380
 381   /* this method is faster but won't work for bitmaps */
 382   if (pixmapData[0] != NULL)
 383     {
 384       int loc = x + y * [self size].width;
 385       return (pixmapData[3][loc] << 24) /* alpha */
 386        | (pixmapData[0][loc] << 16) | (pixmapData[1][loc] << 8)
 387        | (pixmapData[2][loc]);
 388     }
 389   else
 390     {
 391       NSColor *color = [bmRep colorAtX: x y: y];
 392       EmacsCGFloat r, g, b, a;
 393       [color getRed: &r green: &g blue: &b alpha: &a];
 394       return ((int)(a * 255.0) << 24)
 395         | ((int)(r * 255.0) << 16) | ((int)(g * 255.0) << 8)
 396         | ((int)(b * 255.0));
 397
 398     }
 399 }
 400
 401 - (void) setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
 402                green: (unsigned char)g blue: (unsigned char)b
 403                alpha:(unsigned char)a;
 404 {
 405   if (bmRep == nil)
 406     return;
 407
 408   if (pixmapData[0] != NULL)
 409     {
 410       int loc = x + y * [self size].width;
 411       pixmapData[0][loc] = r;
 412       pixmapData[1][loc] = g;
 413       pixmapData[2][loc] = b;
 414       pixmapData[3][loc] = a;
 415     }
 416   else
 417     {
 418       [bmRep setColor:
 419                [NSColor colorWithCalibratedRed: (r/255.0) green: (g/255.0)
 420                                           blue: (b/255.0) alpha: (a/255.0)]
 421                   atX: x y: y];
 422     }
 423 }
 424
 425 - (void) setAlphaAtX: (int) x Y: (int) y to: (unsigned char) a
 426 {
 427   if (bmRep == nil)
 428     return;
 429
 430   if (pixmapData[0] != NULL)
 431     {
 432       int loc = x + y * [self size].width;
 433
 434       pixmapData[3][loc] = a;
 435     }
 436   else
 437     {
 438       NSColor *color = [bmRep colorAtX: x y: y];
 439       color = [color colorWithAlphaComponent: (a / 255.0)];
 440       [bmRep setColor: color atX: x y: y];
 441     }
 442 }
 443
 444 /* returns a pattern color, which is cached here */
 445 - (NSColor *)stippleMask
 446 {
 447   if (stippleMask == nil)
 448       stippleMask = [[NSColor colorWithPatternImage: self] retain];
 449   return stippleMask;
 450 }
 451
 452 @end