Notifications API support for images with multiple scale factors.

chrome/browser/extensions/api/notifications/notifications_api.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 "chrome/browser/extensions/api/notifications/notifications_api.h"
 
 #include "base/callback.h"
 #include "base/guid.h"
 #include "base/rand_util.h"
 #include "base/strings/string_number_conversions.h"
@@ skipping 35 matching lines @@
     "Unable to successfully use the provided image.";
 const char kUnexpectedProgressValueForNonProgressType[] =
     "The progress value should not be specified for non-progress notification";
 const char kInvalidProgressValue[] =
     "The progress value should range from 0 to 100";
 const char kExtraListItemsProvided[] =
     "List items provided for notification type != list";
 const char kExtraImageProvided[] =
     "Image resource provided for notification type != image";
 
-// Converts an object with width, height, and data in RGBA format into an
-// gfx::Image (in ARGB format).
-bool NotificationBitmapToGfxImage(
-    float max_scale,
-    const gfx::Size& target_size_dips,
-    api::notifications::NotificationBitmap* notification_bitmap,
-    gfx::Image* return_image) {
-  if (!notification_bitmap)
+typedef std::vector<linked_ptr<notifications::ImageRepresentation> >
+    ImageRepresentationList;
+
+bool ImageRepresentationToImageSkiaRep(float max_scale,
+                                       const gfx::Size& target_size_dips,
+                                       notifications::BitmapData* bitmap_data,
+                                       float configured_scale,
+                                       gfx::ImageSkiaRep* return_rep) {
+  if (!bitmap_data || !return_rep) {
+    LOG(WARNING) << "Bitmap data: " << bitmap_data;
+    LOG(WARNING) << "return_rep: " << return_rep;
+
     return false;
+  }
 
   const int max_device_pixel_width = target_size_dips.width() * max_scale;
   const int max_device_pixel_height = target_size_dips.height() * max_scale;
 
   const int BYTES_PER_PIXEL = 4;
 
-  const int width = notification_bitmap->width;
-  const int height = notification_bitmap->height;
+  const int width = bitmap_data->width;
+  const int height = bitmap_data->height;
 
-  if (width < 0 || height < 0 || width > max_device_pixel_width ||
-      height > max_device_pixel_height)
+  if (configured_scale < 1.0f || width < 0 || height < 0 ||
+      width > max_device_pixel_width || height > max_device_pixel_height) {
+    LOG(WARNING) << "Configured scale: " << configured_scale;
+    LOG(WARNING) << "width: " << width;
+    LOG(WARNING) << "height: " << height;
+    return false;
+  }
+
+  // Ensure we have rgba data.
+  if (!bitmap_data->data.length())
     return false;
 
-  // Ensure we have rgba data.
-  std::string* rgba_data = notification_bitmap->data.get();
-  if (!rgba_data)
-    return false;
-
-  const size_t rgba_data_length = rgba_data->length();
+  const size_t rgba_data_length = bitmap_data->data.length();
   const size_t rgba_area = width * height;
 
   if (rgba_data_length != rgba_area * BYTES_PER_PIXEL)
     return false;
 
   // Now configure the bitmap with the sanitized dimensions.
   SkBitmap bitmap;
   bitmap.setConfig(SkBitmap::kARGB_8888_Config, width, height);
 
   // Allocate the actual backing store.
   if (!bitmap.allocPixels())
     return false;
 
   // Ensure that our bitmap and our data now refer to the same number of pixels.
   if (rgba_data_length != bitmap.getSafeSize())
     return false;
 
   uint32_t* pixels = bitmap.getAddr32(0, 0);
-  const char* c_rgba_data = rgba_data->data();
+  const char* c_rgba_data = bitmap_data->data.data();
 
   for (size_t t = 0; t < rgba_area; ++t) {
     // |c_rgba_data| is RGBA, pixels is ARGB.
     size_t rgba_index = t * BYTES_PER_PIXEL;
     pixels[t] = SkPreMultiplyColor(
         ((c_rgba_data[rgba_index + 3] & 0xFF) << 24) |
         ((c_rgba_data[rgba_index + 0] & 0xFF) << 16) |
         ((c_rgba_data[rgba_index + 1] & 0xFF) << 8) |
         ((c_rgba_data[rgba_index + 2] & 0xFF) << 0));
   }
 
   // TODO(dewittj): Handle HiDPI images with more than one scale factor
   // representation.
-  gfx::ImageSkia skia(gfx::ImageSkiaRep(bitmap, 1.0f));
-  *return_image = gfx::Image(skia);
+  *return_rep = gfx::ImageSkiaRep(bitmap, configured_scale);
   return true;
 }
 
+// Converts an object with width, height, and data in RGBA format into an
+// gfx::Image (in ARGB format).
+bool ImageRepresentationListToGfxImage(float max_scale,
+                                       const gfx::Size& target_size_dips,
+                                       ImageRepresentationList* bitmap_list,
+                                       gfx::Image* return_image) {
+  if (!bitmap_list || bitmap_list->size() == 0)
+    return false;
+
+  gfx::ImageSkia out;
+  ImageRepresentationList::iterator iter = bitmap_list->begin();
+  while (iter != bitmap_list->end()) {
+    notifications::ImageRepresentation* rep = (*iter).get();
+    if (rep->scale > max_scale)
+      return false;
+
+    notifications::BitmapData* bitmap = rep->data.as_bitmap_data.get();
+    gfx::ImageSkiaRep skia_rep;
+    if (!ImageRepresentationToImageSkiaRep(
+            max_scale, target_size_dips, bitmap, rep->scale, &skia_rep))
+      return false;
+
+    out.AddRepresentation(skia_rep);
+
+    ++iter;
+  }
+  *return_image = gfx::Image(out);
+  return true;
+}
+
 // Given an extension id and another id, returns an id that is unique
 // relative to other extensions.
 std::string CreateScopedIdentifier(const std::string& extension_id,
                                    const std::string& id) {
   return extension_id + "-" + id;
 }
 
 // Removes the unique internal identifier to send the ID as the
 // extension expects it.
 std::string StripScopeFromIdentifier(const std::string& extension_id,
@@ skipping 122 matching lines @@
 NotificationsApiFunction::~NotificationsApiFunction() {
 }
 
 bool NotificationsApiFunction::CreateNotification(
     const std::string& id,
     api::notifications::NotificationOptions* options) {
   // First, make sure the required fields exist: type, title, message,  icon.
   // These fields are defined as optional in IDL such that they can be used as
   // optional for notification updates. But for notification creations, they
   // should be present.
-  if (options->type == api::notifications::TEMPLATE_TYPE_NONE ||
-      !options->icon_url || !options->title || !options->message) {
+  if (options->icons == NULL || options->icons->size() < 1) {
     SetError(kMissingRequiredPropertiesForCreateNotification);
     return false;
   }
+  if (options->type == api::notifications::TEMPLATE_TYPE_NONE ||
+      !options->title || !options->message) {
+    SetError(kMissingRequiredPropertiesForCreateNotification);
+    return false;
+  }
 
   NotificationBitmapSizes bitmap_sizes = GetNotificationBitmapSizes();
 
   float image_scale =
       ui::GetScaleForScaleFactor(ui::GetSupportedScaleFactors().back());
 
   // Extract required fields: type, title, message, and icon.
   message_center::NotificationType type =
       MapApiTemplateTypeToType(options->type);
   const base::string16 title(base::UTF8ToUTF16(*options->title));
   const base::string16 message(base::UTF8ToUTF16(*options->message));
   gfx::Image icon;
 
-  if (!NotificationBitmapToGfxImage(image_scale,
-                                    bitmap_sizes.icon_size,
-                                    options->icon_bitmap.get(),
-                                    &icon)) {
+  if (!ImageRepresentationListToGfxImage(
+          image_scale, bitmap_sizes.icon_size, options->icons.get(), &icon)) {
     SetError(kUnableToDecodeIconError);
     return false;
   }
 
   // Then, handle any optional data that's been provided.
   message_center::RichNotificationData optional_fields;
   if (options->priority.get())
     optional_fields.priority = *options->priority;
 
   if (options->event_time.get())
     optional_fields.timestamp = base::Time::FromJsTime(*options->event_time);
 
   if (options->buttons.get()) {
     // Currently we allow up to 2 buttons.
     size_t number_of_buttons = options->buttons->size();
     number_of_buttons = number_of_buttons > 2 ? 2 : number_of_buttons;
 
     for (size_t i = 0; i < number_of_buttons; i++) {
       message_center::ButtonInfo info(
           base::UTF8ToUTF16((*options->buttons)[i]->title));
-      NotificationBitmapToGfxImage(image_scale,
-                                   bitmap_sizes.button_icon_size,
-                                   (*options->buttons)[i]->icon_bitmap.get(),
-                                   &info.icon);
+      ImageRepresentationListToGfxImage(image_scale,
+                                        bitmap_sizes.button_icon_size,
+                                        (*options->buttons)[i]->icons.get(),
+                                        &info.icon);
       optional_fields.buttons.push_back(info);
     }
   }
 
   if (options->context_message) {
     optional_fields.context_message =
         base::UTF8ToUTF16(*options->context_message);
   }
 
-  bool has_image = NotificationBitmapToGfxImage(image_scale,
-                                                bitmap_sizes.image_size,
-                                                options->image_bitmap.get(),
-                                                &optional_fields.image);
+  bool has_image = ImageRepresentationListToGfxImage(image_scale,
+                                                     bitmap_sizes.image_size,
+                                                     options->images.get(),
+                                                     &optional_fields.image);
   // We should have an image if and only if the type is an image type.
   if (has_image != (type == message_center::NOTIFICATION_TYPE_IMAGE)) {
     SetError(kExtraImageProvided);
     return false;
   }
 
   // We should have list items if and only if the type is a multiple type.
   bool has_list_items = options->items.get() && options->items->size() > 0;
   if (has_list_items != (type == message_center::NOTIFICATION_TYPE_MULTIPLE)) {
     SetError(kExtraListItemsProvided);
@@ skipping 59 matching lines @@
 
   // Update optional fields if provided.
   if (options->type != api::notifications::TEMPLATE_TYPE_NONE)
     notification->set_type(MapApiTemplateTypeToType(options->type));
   if (options->title)
     notification->set_title(base::UTF8ToUTF16(*options->title));
   if (options->message)
     notification->set_message(base::UTF8ToUTF16(*options->message));
 
   // TODO(dewittj): Return error if this fails.
-  if (options->icon_bitmap) {
+  if (options->icons) {
     gfx::Image icon;
-    NotificationBitmapToGfxImage(
-        image_scale, bitmap_sizes.icon_size, options->icon_bitmap.get(), &icon);
+    ImageRepresentationListToGfxImage(
+        image_scale, bitmap_sizes.icon_size, options->icons.get(), &icon);
     notification->set_icon(icon);
   }
 
   if (options->priority)
     notification->set_priority(*options->priority);
 
   if (options->event_time)
     notification->set_timestamp(base::Time::FromJsTime(*options->event_time));
 
   if (options->buttons) {
     // Currently we allow up to 2 buttons.
     size_t number_of_buttons = options->buttons->size();
     number_of_buttons = number_of_buttons > 2 ? 2 : number_of_buttons;
 
     std::vector<message_center::ButtonInfo> buttons;
     for (size_t i = 0; i < number_of_buttons; i++) {
       message_center::ButtonInfo button(
           base::UTF8ToUTF16((*options->buttons)[i]->title));
-      NotificationBitmapToGfxImage(image_scale,
-                                   bitmap_sizes.button_icon_size,
-                                   (*options->buttons)[i]->icon_bitmap.get(),
-                                   &button.icon);
+      ImageRepresentationListToGfxImage(image_scale,
+                                        bitmap_sizes.button_icon_size,
+                                        (*options->buttons)[i]->icons.get(),
+                                        &button.icon);
       buttons.push_back(button);
     }
     notification->set_buttons(buttons);
   }
 
   if (options->context_message) {
     notification->set_context_message(
         base::UTF8ToUTF16(*options->context_message));
   }
 
   gfx::Image image;
-  bool has_image = NotificationBitmapToGfxImage(image_scale,
-                                                bitmap_sizes.image_size,
-                                                options->image_bitmap.get(),
-                                                &image);
+  bool has_image = ImageRepresentationListToGfxImage(
+      image_scale, bitmap_sizes.image_size, options->images.get(), &image);
   if (has_image) {
     // We should have an image if and only if the type is an image type.
     if (notification->type() != message_center::NOTIFICATION_TYPE_IMAGE) {
       SetError(kExtraImageProvided);
       return false;
     }
     notification->set_image(image);
   }
 
   if (options->progress) {
@@ skipping 217 matching lines @@
           ? api::notifications::PERMISSION_LEVEL_GRANTED
           : api::notifications::PERMISSION_LEVEL_DENIED;
 
   SetResult(new base::StringValue(api::notifications::ToString(result)));
   SendResponse(true);
 
   return true;
 }
 
 }  // namespace extensions