Add support for PNG representation in gfx::Image

ui/gfx/image/image.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/gfx/image/image.h"
 
 #include <algorithm>
 
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "third_party/skia/include/core/SkBitmap.h"
+#include "ui/gfx/codec/png_codec.h"
 #include "ui/gfx/image/image_skia.h"
 #include "ui/gfx/size.h"
 
 #if defined(TOOLKIT_GTK)
 #include <gdk-pixbuf/gdk-pixbuf.h>
 #include <gdk/gdk.h>
 #include <glib-object.h>
+#include "ui/base/gtk/scoped_gobject.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/gtk_util.h"
 #include "ui/gfx/image/cairo_cached_surface.h"
 #elif defined(OS_MACOSX)
 #include "base/mac/mac_util.h"
 #include "ui/gfx/image/image_skia_util_mac.h"
 #endif
 
 namespace gfx {
 
 namespace internal {
 
 #if defined(TOOLKIT_GTK)
 const ImageSkia ImageSkiaFromGdkPixbuf(GdkPixbuf* pixbuf) {
   CHECK(pixbuf);
   gfx::Canvas canvas(gfx::Size(gdk_pixbuf_get_width(pixbuf),
                                gdk_pixbuf_get_height(pixbuf)), false);
   skia::ScopedPlatformPaint scoped_platform_paint(canvas.sk_canvas());
   cairo_t* cr = scoped_platform_paint.GetPlatformSurface();
   gdk_cairo_set_source_pixbuf(cr, pixbuf, 0, 0);
   cairo_paint(cr);
   return ImageSkia(SkBitmap(canvas.ExtractBitmap()));
 }
+
+GdkPixbuf* GdkPixbufFromPNG(const std::vector<unsigned char>& png) {
+  GdkPixbuf* pixbuf = NULL;
+  ui::ScopedGObject<GdkPixbufLoader>::Type loader(gdk_pixbuf_loader_new());
+
+  bool ok = gdk_pixbuf_loader_write(loader.get(),
+      reinterpret_cast<const guint8*>(&png.front()), png.size(), NULL);
+
+  // Calling gdk_pixbuf_loader_close forces the data to be parsed by the
+  // loader.  We must do this before calling gdk_pixbuf_loader_get_pixbuf.

[Robert Sesek, 2012/07/24 18:59:17]

"We must do this" -> "This must be done"

[cjhopman, 2012/07/25 21:13:29]

Done.

+  if (ok)
+    ok = gdk_pixbuf_loader_close(loader.get(), NULL);
+  if (ok)
+    pixbuf = gdk_pixbuf_loader_get_pixbuf(loader.get());
+
+  if (!pixbuf) {
+    LOG(WARNING) << "Unable to decode PNG, returning empty pixbuf.";
+    pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB, TRUE, 8, 1, 1);
+  }
+
+  g_object_ref(pixbuf);
+  return pixbuf;
+}
+
+void PNGFromGdkPixbuf(GdkPixbuf* pixbuf, std::vector<unsigned char>* png) {
+  gchar* image = NULL;
+  gsize image_size;
+  GError* error = NULL;
+  if (!gdk_pixbuf_save_to_buffer(
+      pixbuf, &image, &image_size, "png", &error, NULL)) {

[Robert Sesek, 2012/07/24 18:59:17]

nit: continuations are indented 4 from this (

[cjhopman, 2012/07/25 21:13:29]

Done.

+    LOG(WARNING) << "Unable to encode PNG, returning empty pixbuf: "
+                 << error->message;
+    g_error_free(error);
+  } else {
+    png->assign(image, image + image_size);
+    g_free(image);
+  }
+}
+
 #endif

[Robert Sesek, 2012/07/24 18:59:17]

  // defined(TOOLKIT_GTK)

[cjhopman, 2012/07/25 21:13:29]

Done.

 
+#if defined(OS_MACOSX)
+void PNGFromNSImage(NSImage* nsimage, std::vector<unsigned char>* png);
+NSImage* NSImageFromPNG(const std::vector<unsigned char>& png);
+#endif

[cjhopman, 2012/07/25 21:13:29]

// defined(OS_MACOSX) here? or unnecessary since it's close to the #if defined?

[Robert Sesek, 2012/07/31 14:07:16]

Optional. I'd maybe do it just for consistency.

+
+ImageSkia* ImageSkiaFromPNG(const std::vector<unsigned char>& png) {
+  SkBitmap bitmap;
+  if (!gfx::PNGCodec::Decode(&png.front(), png.size(), &bitmap))
+    LOG(WARNING) << "Unable to decode PNG, returning empty bitmap.";
+  return new ImageSkia(bitmap);
+}
+void PNGFromImageSkia(const ImageSkia* skia, std::vector<unsigned char>* png) {
+    if (!gfx::PNGCodec::EncodeBGRASkBitmap(*skia->bitmap(), false, png)) {

[Robert Sesek, 2012/07/24 18:59:17]

nit: over-indented

[cjhopman, 2012/07/25 21:13:29]

Done.

+      LOG(WARNING) << "Unable to encode bitmap, returning empty PNG.";
+      png->clear();
+    }
+}
+
+class ImageRepPNG;
 class ImageRepSkia;
 class ImageRepGdk;
 class ImageRepCairo;
 class ImageRepCocoa;
 
 // An ImageRep is the object that holds the backing memory for an Image. Each
 // RepresentationType has an ImageRep subclass that is responsible for freeing
 // the memory that the ImageRep holds. When an ImageRep is created, it expects
 // to take ownership of the image, without having to retain it or increase its
 // reference count.
 class ImageRep {
  public:
   explicit ImageRep(Image::RepresentationType rep) : type_(rep) {}
 
   // Deletes the associated pixels of an ImageRep.
   virtual ~ImageRep() {}
 
   // Cast helpers ("fake RTTI").
+  ImageRepPNG* AsImageRepPNG() {
+    CHECK_EQ(type_, Image::kImageRepPNG);
+    return reinterpret_cast<ImageRepPNG*>(this);
+  }
+
   ImageRepSkia* AsImageRepSkia() {
     CHECK_EQ(type_, Image::kImageRepSkia);
     return reinterpret_cast<ImageRepSkia*>(this);
   }
 
 #if defined(TOOLKIT_GTK)
   ImageRepGdk* AsImageRepGdk() {
     CHECK_EQ(type_, Image::kImageRepGdk);
     return reinterpret_cast<ImageRepGdk*>(this);
   }
@@ skipping 10 matching lines @@
     return reinterpret_cast<ImageRepCocoa*>(this);
   }
 #endif
 
   Image::RepresentationType type() const { return type_; }
 
  private:
   Image::RepresentationType type_;
 };
 
+class ImageRepPNG : public ImageRep {
+ public:
+  ImageRepPNG(const unsigned char* input, size_t input_size)
+      : ImageRep(Image::kImageRepPNG),
+        image_(input, input + input_size) {
+  }
+  ImageRepPNG() : ImageRep(Image::kImageRepPNG) {
+  }
+
+  virtual ~ImageRepPNG() {
+  }
+
+  std::vector<unsigned char>& image() { return image_; }

[Robert Sesek, 2012/07/24 18:59:17]

Generally non-const-ref is not used. Make this a pointer?

[cjhopman, 2012/07/25 21:13:29]

Done.

+
+ private:
+  std::vector<unsigned char> image_;
+
+  DISALLOW_COPY_AND_ASSIGN(ImageRepPNG);
+};
+
 class ImageRepSkia : public ImageRep {
  public:
   // Takes ownership of |image|.
   explicit ImageRepSkia(ImageSkia* image)
       : ImageRep(Image::kImageRepSkia),
         image_(image) {
   }
 
   virtual ~ImageRepSkia() {
   }
@@ skipping 110 matching lines @@
 
   friend class base::RefCounted<ImageStorage>;
 };
 
 }  // namespace internal
 
 Image::Image() {
   // |storage_| is NULL for empty Images.
 }
 
+Image::Image(const unsigned char* png, size_t input_size)
+    : storage_(new internal::ImageStorage(Image::kImageRepPNG)) {
+  internal::ImageRepPNG* rep = new internal::ImageRepPNG(png, input_size);
+  AddRepresentation(rep);
+}
+
 Image::Image(const ImageSkia& image)
     : storage_(new internal::ImageStorage(Image::kImageRepSkia)) {
   internal::ImageRepSkia* rep = new internal::ImageRepSkia(
       new ImageSkia(image));
   AddRepresentation(rep);
 }
 
 Image::Image(const ImageSkiaRep& image_skia_rep)
     : storage_(new internal::ImageStorage(Image::kImageRepSkia)) {
   internal::ImageRepSkia* rep =
@@ skipping 28 matching lines @@
 }
 
 Image& Image::operator=(const Image& other) {
   storage_ = other.storage_;
   return *this;
 }
 
 Image::~Image() {
 }
 
+const std::vector<unsigned char>* Image::ToImagePNG() const {
+  internal::ImageRep* rep = GetRepresentation(kImageRepPNG, false);
+  if (!rep) {
+    switch (DefaultRepresentationType()) {
+#if defined(TOOLKIT_GTK)
+      case kImageRepGdk: {
+        internal::ImageRepGdk* gdk_rep =
+            GetRepresentation(kImageRepGdk, true)->AsImageRepGdk();
+        internal::ImageRepPNG* png_rep = new internal::ImageRepPNG();
+        internal::PNGFromGdkPixbuf(gdk_rep->pixbuf(), &png_rep->image());
+        rep = png_rep;
+        break;
+      }
+#elif defined(OS_MACOSX)
+      case kImageRepCocoa: {
+        internal::ImageRepCocoa* cocoa_rep =
+            GetRepresentation(kImageRepCocoa, true)->AsImageRepCocoa();
+        internal::ImageRepPNG* png_rep = new internal::ImageRepPNG();
+        internal::PNGFromNSImage(cocoa_rep->image(), &png_rep->image());
+        rep = png_rep;
+        break;
+      }
+#endif
+      case kImageRepSkia: {
+        internal::ImageRepSkia* skia_rep =
+            GetRepresentation(kImageRepSkia, true)->AsImageRepSkia();
+        internal::ImageRepPNG* png_rep = new internal::ImageRepPNG();
+        internal::PNGFromImageSkia(skia_rep->image(), &png_rep->image());
+        rep = png_rep;
+        break;
+      }
+      default:
+        NOTREACHED();
+    }
+    CHECK(rep);
+    AddRepresentation(rep);
+  }
+  return &rep->AsImageRepPNG()->image();
+}
+
 const SkBitmap* Image::ToSkBitmap() const {
   // Possibly create and cache an intermediate ImageRepSkia.
   return ToImageSkia()->bitmap();
 }
 
 const ImageSkia* Image::ToImageSkia() const {
   internal::ImageRep* rep = GetRepresentation(kImageRepSkia, false);
   if (!rep) {
+    switch (DefaultRepresentationType()) {
+      case kImageRepPNG: {
+        internal::ImageRepPNG* png_rep =
+            GetRepresentation(kImageRepPNG, true)->AsImageRepPNG();
+        rep = new internal::ImageRepSkia(
+            internal::ImageSkiaFromPNG(png_rep->image()));
+        break;
+      }
 #if defined(TOOLKIT_GTK)
-    internal::ImageRepGdk* native_rep =
-        GetRepresentation(kImageRepGdk, true)->AsImageRepGdk();
-    rep = new internal::ImageRepSkia(new ImageSkia(
-        internal::ImageSkiaFromGdkPixbuf(native_rep->pixbuf())));
+      case kImageRepGdk: {
+        internal::ImageRepGdk* native_rep =
+            GetRepresentation(kImageRepGdk, true)->AsImageRepGdk();
+        rep = new internal::ImageRepSkia(new ImageSkia(
+            internal::ImageSkiaFromGdkPixbuf(native_rep->pixbuf())));
+        break;
+      }
 #elif defined(OS_MACOSX)
-    internal::ImageRepCocoa* native_rep =
-        GetRepresentation(kImageRepCocoa, true)->AsImageRepCocoa();
-    rep = new internal::ImageRepSkia(new ImageSkia(
-        ImageSkiaFromNSImage(native_rep->image())));
+      case kImageRepCocoa: {
+        internal::ImageRepCocoa* native_rep =
+            GetRepresentation(kImageRepCocoa, true)->AsImageRepCocoa();
+        rep = new internal::ImageRepSkia(new ImageSkia(
+            ImageSkiaFromNSImage(native_rep->image())));
+        break;
+      }
 #endif
+      default:
+        NOTREACHED();
+    }
     CHECK(rep);
     AddRepresentation(rep);
   }
   return rep->AsImageRepSkia()->image();
 }
 
 #if defined(TOOLKIT_GTK)
 GdkPixbuf* Image::ToGdkPixbuf() const {
   internal::ImageRep* rep = GetRepresentation(kImageRepGdk, false);
   if (!rep) {
-    internal::ImageRepSkia* skia_rep =
-        GetRepresentation(kImageRepSkia, true)->AsImageRepSkia();
-    rep = new internal::ImageRepGdk(gfx::GdkPixbufFromSkBitmap(
-        *skia_rep->image()->bitmap()));
+    switch (DefaultRepresentationType()) {
+      case kImageRepPNG: {
+        internal::ImageRepPNG* png_rep =
+            GetRepresentation(kImageRepPNG, true)->AsImageRepPNG();
+        rep = new internal::ImageRepGdk(internal::GdkPixbufFromPNG(
+            png_rep->image()));
+        break;
+      }
+      case kImageRepSkia: {
+        internal::ImageRepSkia* skia_rep =
+            GetRepresentation(kImageRepSkia, true)->AsImageRepSkia();
+        rep = new internal::ImageRepGdk(gfx::GdkPixbufFromSkBitmap(
+            *skia_rep->image()->bitmap()));
+        break;
+      }
+      default:
+        NOTREACHED();
+    }
     CHECK(rep);
     AddRepresentation(rep);
   }
   return rep->AsImageRepGdk()->pixbuf();
 }
 
 CairoCachedSurface* const Image::ToCairo() const {
   internal::ImageRep* rep = GetRepresentation(kImageRepCairo, false);
   if (!rep) {
     // Handle any-to-Cairo conversion. This may create and cache an intermediate
     // pixbuf before sending the data to the display server.
     rep = new internal::ImageRepCairo(ToGdkPixbuf());
     CHECK(rep);
     AddRepresentation(rep);
   }
   return rep->AsImageRepCairo()->surface();
 }
 #endif
 
 #if defined(OS_MACOSX)
 NSImage* Image::ToNSImage() const {
   internal::ImageRep* rep = GetRepresentation(kImageRepCocoa, false);
   if (!rep) {
-    internal::ImageRepSkia* skia_rep =
-        GetRepresentation(kImageRepSkia, true)->AsImageRepSkia();
-    NSImage* image = NSImageFromImageSkia(*skia_rep->image());
-    base::mac::NSObjectRetain(image);
-    rep = new internal::ImageRepCocoa(image);
+    switch (DefaultRepresentationType()) {
+      case kImageRepPNG: {
+        internal::ImageRepPNG* png_rep =
+            GetRepresentation(kImageRepPNG, true)->AsImageRepPNG();
+        rep = new internal::ImageRepCocoa(internal::NSImageFromPNG(
+            png_rep->image()));
+        break;
+      }
+      case kImageRepSkia: {
+        internal::ImageRepSkia* skia_rep =
+            GetRepresentation(kImageRepSkia, true)->AsImageRepSkia();
+        NSImage* image = NSImageFromImageSkia(*skia_rep->image());
+        base::mac::NSObjectRetain(image);
+        rep = new internal::ImageRepCocoa(image);
+        break;
+      }
+      default:
+        NOTREACHED();
+    }
     CHECK(rep);
     AddRepresentation(rep);
   }
   return rep->AsImageRepCocoa()->image();
 }
 #endif
 
+std::vector<unsigned char>* Image::CopyImagePNG() const {
+  return new std::vector<unsigned char>(*ToImagePNG());
+}
+
 ImageSkia* Image::CopyImageSkia() const {
   return new ImageSkia(*ToImageSkia());
 }
 
 SkBitmap* Image::CopySkBitmap() const {
   return new SkBitmap(*ToSkBitmap());
 }
 
 #if defined(TOOLKIT_GTK)
 GdkPixbuf* Image::CopyGdkPixbuf() const {
@@ skipping 55 matching lines @@
   }
   return it->second;
 }
 
 void Image::AddRepresentation(internal::ImageRep* rep) const {
   CHECK(storage_.get());
   storage_->representations().insert(std::make_pair(rep->type(), rep));
 }
 
 }  // namespace gfx