1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "ui/gfx/image/image.h"
10 #include "base/logging.h"
11 #include "base/stl_util.h"
12 #include "third_party/skia/include/core/SkBitmap.h"
13 #include "ui/gfx/geometry/size.h"
14 #include "ui/gfx/image/image_png_rep.h"
15 #include "ui/gfx/image/image_skia.h"
16 #include "ui/gfx/image/image_skia_source.h"
19 #include "ui/gfx/codec/png_codec.h"
23 #include "base/mac/foundation_util.h"
24 #include "ui/gfx/image/image_skia_util_ios.h"
25 #elif defined(OS_MACOSX)
26 #include "base/mac/foundation_util.h"
27 #include "base/mac/mac_util.h"
28 #include "ui/gfx/image/image_skia_util_mac.h"
36 scoped_refptr
<base::RefCountedMemory
> Get1xPNGBytesFromUIImage(
38 // Caller takes ownership of the returned UIImage.
39 UIImage
* CreateUIImageFromPNG(
40 const std::vector
<ImagePNGRep
>& image_png_reps
);
41 gfx::Size
UIImageSize(UIImage
* image
);
42 #elif defined(OS_MACOSX)
43 scoped_refptr
<base::RefCountedMemory
> Get1xPNGBytesFromNSImage(
45 // Caller takes ownership of the returned NSImage.
46 NSImage
* NSImageFromPNG(const std::vector
<ImagePNGRep
>& image_png_reps
,
47 CGColorSpaceRef color_space
);
48 gfx::Size
NSImageSize(NSImage
* image
);
49 #endif // defined(OS_MACOSX)
52 ImageSkia
* ImageSkiaFromPNG(
53 const std::vector
<ImagePNGRep
>& image_png_reps
);
54 scoped_refptr
<base::RefCountedMemory
> Get1xPNGBytesFromImageSkia(
55 const ImageSkia
* skia
);
57 // Returns a 16x16 red image to visually show error in decoding PNG.
58 // Caller takes ownership of returned ImageSkia.
59 ImageSkia
* GetErrorImageSkia() {
61 bitmap
.allocN32Pixels(16, 16);
62 bitmap
.eraseARGB(0xff, 0xff, 0, 0);
63 return new ImageSkia(ImageSkiaRep(bitmap
, 1.0f
));
66 class PNGImageSource
: public ImageSkiaSource
{
69 ~PNGImageSource() override
{}
71 ImageSkiaRep
GetImageForScale(float scale
) override
{
72 if (image_skia_reps_
.empty())
73 return ImageSkiaRep();
75 const ImageSkiaRep
* rep
= NULL
;
76 // gfx::ImageSkia passes one of the resource scale factors. The source
78 // 1) The ImageSkiaRep with the highest scale if all available
79 // scales are smaller than |scale|.
80 // 2) The ImageSkiaRep with the smallest one that is larger than |scale|.
81 for (ImageSkiaRepSet::const_iterator iter
= image_skia_reps_
.begin();
82 iter
!= image_skia_reps_
.end(); ++iter
) {
83 if ((*iter
).scale() == scale
)
85 if (!rep
|| rep
->scale() < (*iter
).scale())
87 if (rep
->scale() >= scale
)
90 return rep
? *rep
: ImageSkiaRep();
93 const gfx::Size
size() const {
97 bool AddPNGData(const ImagePNGRep
& png_rep
) {
98 const gfx::ImageSkiaRep rep
= ToImageSkiaRep(png_rep
);
102 size_
= gfx::Size(rep
.GetWidth(), rep
.GetHeight());
103 image_skia_reps_
.insert(rep
);
107 static ImageSkiaRep
ToImageSkiaRep(const ImagePNGRep
& png_rep
) {
108 scoped_refptr
<base::RefCountedMemory
> raw_data
= png_rep
.raw_data
;
109 CHECK(raw_data
.get());
111 if (!PNGCodec::Decode(raw_data
->front(), raw_data
->size(),
113 LOG(ERROR
) << "Unable to decode PNG for " << png_rep
.scale
<< ".";
114 return ImageSkiaRep();
116 return ImageSkiaRep(bitmap
, png_rep
.scale
);
121 bool operator()(const ImageSkiaRep
& rep1
, const ImageSkiaRep
& rep2
) {
122 return rep1
.scale() < rep2
.scale();
126 typedef std::set
<ImageSkiaRep
, Compare
> ImageSkiaRepSet
;
127 ImageSkiaRepSet image_skia_reps_
;
130 DISALLOW_COPY_AND_ASSIGN(PNGImageSource
);
133 ImageSkia
* ImageSkiaFromPNG(
134 const std::vector
<ImagePNGRep
>& image_png_reps
) {
135 if (image_png_reps
.empty())
136 return GetErrorImageSkia();
137 scoped_ptr
<PNGImageSource
> image_source(new PNGImageSource
);
139 for (size_t i
= 0; i
< image_png_reps
.size(); ++i
) {
140 if (!image_source
->AddPNGData(image_png_reps
[i
]))
141 return GetErrorImageSkia();
143 const gfx::Size
& size
= image_source
->size();
144 DCHECK(!size
.IsEmpty());
146 return GetErrorImageSkia();
147 return new ImageSkia(image_source
.release(), size
);
150 scoped_refptr
<base::RefCountedMemory
> Get1xPNGBytesFromImageSkia(
151 const ImageSkia
* image_skia
) {
152 ImageSkiaRep image_skia_rep
= image_skia
->GetRepresentation(1.0f
);
154 scoped_refptr
<base::RefCountedBytes
> png_bytes(new base::RefCountedBytes());
155 if (image_skia_rep
.scale() != 1.0f
||
156 !PNGCodec::EncodeBGRASkBitmap(image_skia_rep
.sk_bitmap(), false,
157 &png_bytes
->data())) {
167 class ImageRepCocoaTouch
;
169 // An ImageRep is the object that holds the backing memory for an Image. Each
170 // RepresentationType has an ImageRep subclass that is responsible for freeing
171 // the memory that the ImageRep holds. When an ImageRep is created, it expects
172 // to take ownership of the image, without having to retain it or increase its
176 explicit ImageRep(Image::RepresentationType rep
) : type_(rep
) {}
178 // Deletes the associated pixels of an ImageRep.
179 virtual ~ImageRep() {}
181 // Cast helpers ("fake RTTI").
182 ImageRepPNG
* AsImageRepPNG() {
183 CHECK_EQ(type_
, Image::kImageRepPNG
);
184 return reinterpret_cast<ImageRepPNG
*>(this);
187 ImageRepSkia
* AsImageRepSkia() {
188 CHECK_EQ(type_
, Image::kImageRepSkia
);
189 return reinterpret_cast<ImageRepSkia
*>(this);
193 ImageRepCocoaTouch
* AsImageRepCocoaTouch() {
194 CHECK_EQ(type_
, Image::kImageRepCocoaTouch
);
195 return reinterpret_cast<ImageRepCocoaTouch
*>(this);
197 #elif defined(OS_MACOSX)
198 ImageRepCocoa
* AsImageRepCocoa() {
199 CHECK_EQ(type_
, Image::kImageRepCocoa
);
200 return reinterpret_cast<ImageRepCocoa
*>(this);
204 Image::RepresentationType
type() const { return type_
; }
206 virtual int Width() const = 0;
207 virtual int Height() const = 0;
208 virtual gfx::Size
Size() const = 0;
211 Image::RepresentationType type_
;
214 class ImageRepPNG
: public ImageRep
{
216 ImageRepPNG() : ImageRep(Image::kImageRepPNG
) {
219 ImageRepPNG(const std::vector
<ImagePNGRep
>& image_png_reps
)
220 : ImageRep(Image::kImageRepPNG
),
221 image_png_reps_(image_png_reps
) {
224 ~ImageRepPNG() override
{}
226 int Width() const override
{ return Size().width(); }
228 int Height() const override
{ return Size().height(); }
230 gfx::Size
Size() const override
{
231 // Read the PNG data to get the image size, caching it.
233 for (std::vector
<ImagePNGRep
>::const_iterator it
= image_reps().begin();
234 it
!= image_reps().end(); ++it
) {
235 if (it
->scale
== 1.0f
) {
236 size_cache_
.reset(new gfx::Size(it
->Size()));
240 size_cache_
.reset(new gfx::Size
);
246 const std::vector
<ImagePNGRep
>& image_reps() const { return image_png_reps_
; }
249 std::vector
<ImagePNGRep
> image_png_reps_
;
251 // Cached to avoid having to parse the raw data multiple times.
252 mutable scoped_ptr
<gfx::Size
> size_cache_
;
254 DISALLOW_COPY_AND_ASSIGN(ImageRepPNG
);
257 class ImageRepSkia
: public ImageRep
{
259 // Takes ownership of |image|.
260 explicit ImageRepSkia(ImageSkia
* image
)
261 : ImageRep(Image::kImageRepSkia
),
265 ~ImageRepSkia() override
{}
267 int Width() const override
{ return image_
->width(); }
269 int Height() const override
{ return image_
->height(); }
271 gfx::Size
Size() const override
{ return image_
->size(); }
273 ImageSkia
* image() { return image_
.get(); }
276 scoped_ptr
<ImageSkia
> image_
;
278 DISALLOW_COPY_AND_ASSIGN(ImageRepSkia
);
282 class ImageRepCocoaTouch
: public ImageRep
{
284 explicit ImageRepCocoaTouch(UIImage
* image
)
285 : ImageRep(Image::kImageRepCocoaTouch
),
290 ~ImageRepCocoaTouch() override
{
291 base::mac::NSObjectRelease(image_
);
295 int Width() const override
{ return Size().width(); }
297 int Height() const override
{ return Size().height(); }
299 gfx::Size
Size() const override
{ return internal::UIImageSize(image_
); }
301 UIImage
* image() const { return image_
; }
306 DISALLOW_COPY_AND_ASSIGN(ImageRepCocoaTouch
);
308 #elif defined(OS_MACOSX)
309 class ImageRepCocoa
: public ImageRep
{
311 explicit ImageRepCocoa(NSImage
* image
)
312 : ImageRep(Image::kImageRepCocoa
),
317 ~ImageRepCocoa() override
{
318 base::mac::NSObjectRelease(image_
);
322 int Width() const override
{ return Size().width(); }
324 int Height() const override
{ return Size().height(); }
326 gfx::Size
Size() const override
{ return internal::NSImageSize(image_
); }
328 NSImage
* image() const { return image_
; }
333 DISALLOW_COPY_AND_ASSIGN(ImageRepCocoa
);
335 #endif // defined(OS_MACOSX)
337 // The Storage class acts similarly to the pixels in a SkBitmap: the Image
338 // class holds a refptr instance of Storage, which in turn holds all the
339 // ImageReps. This way, the Image can be cheaply copied.
340 class ImageStorage
: public base::RefCounted
<ImageStorage
> {
342 ImageStorage(Image::RepresentationType default_type
)
343 : default_representation_type_(default_type
),
344 #if defined(OS_MACOSX) && !defined(OS_IOS)
345 default_representation_color_space_(
346 base::mac::GetGenericRGBColorSpace()),
347 #endif // defined(OS_MACOSX) && !defined(OS_IOS)
348 representations_deleter_(&representations_
) {
351 Image::RepresentationType
default_representation_type() {
352 return default_representation_type_
;
354 Image::RepresentationMap
& representations() { return representations_
; }
356 #if defined(OS_MACOSX) && !defined(OS_IOS)
357 void set_default_representation_color_space(CGColorSpaceRef color_space
) {
358 default_representation_color_space_
= color_space
;
360 CGColorSpaceRef
default_representation_color_space() {
361 return default_representation_color_space_
;
363 #endif // defined(OS_MACOSX) && !defined(OS_IOS)
366 friend class base::RefCounted
<ImageStorage
>;
370 // The type of image that was passed to the constructor. This key will always
371 // exist in the |representations_| map.
372 Image::RepresentationType default_representation_type_
;
374 #if defined(OS_MACOSX) && !defined(OS_IOS)
375 // The default representation's colorspace. This is used for converting to
376 // NSImage. This field exists to compensate for PNGCodec not writing or
377 // reading colorspace ancillary chunks. (sRGB, iCCP).
379 CGColorSpaceRef default_representation_color_space_
;
380 #endif // defined(OS_MACOSX) && !defined(OS_IOS)
382 // All the representations of an Image. Size will always be at least one, with
383 // more for any converted representations.
384 Image::RepresentationMap representations_
;
386 STLValueDeleter
<Image::RepresentationMap
> representations_deleter_
;
388 DISALLOW_COPY_AND_ASSIGN(ImageStorage
);
391 } // namespace internal
394 // |storage_| is NULL for empty Images.
397 Image::Image(const std::vector
<ImagePNGRep
>& image_reps
) {
398 // Do not store obviously invalid ImagePNGReps.
399 std::vector
<ImagePNGRep
> filtered
;
400 for (size_t i
= 0; i
< image_reps
.size(); ++i
) {
401 if (image_reps
[i
].raw_data
.get() && image_reps
[i
].raw_data
->size())
402 filtered
.push_back(image_reps
[i
]);
405 if (filtered
.empty())
408 storage_
= new internal::ImageStorage(Image::kImageRepPNG
);
409 AddRepresentation(make_scoped_ptr(new internal::ImageRepPNG(filtered
)));
412 Image::Image(const ImageSkia
& image
) {
413 if (!image
.isNull()) {
414 storage_
= new internal::ImageStorage(Image::kImageRepSkia
);
416 make_scoped_ptr(new internal::ImageRepSkia(new ImageSkia(image
))));
421 Image::Image(UIImage
* image
)
422 : storage_(new internal::ImageStorage(Image::kImageRepCocoaTouch
)) {
424 AddRepresentation(make_scoped_ptr(new internal::ImageRepCocoaTouch(image
)));
426 #elif defined(OS_MACOSX)
427 Image::Image(NSImage
* image
) {
429 storage_
= new internal::ImageStorage(Image::kImageRepCocoa
);
430 AddRepresentation(make_scoped_ptr(new internal::ImageRepCocoa(image
)));
435 Image::Image(const Image
& other
) : storage_(other
.storage_
) {
438 Image
& Image::operator=(const Image
& other
) {
439 storage_
= other
.storage_
;
447 Image
Image::CreateFrom1xBitmap(const SkBitmap
& bitmap
) {
448 return Image(ImageSkia::CreateFrom1xBitmap(bitmap
));
452 Image
Image::CreateFrom1xPNGBytes(const unsigned char* input
,
454 if (input_size
== 0u)
457 scoped_refptr
<base::RefCountedBytes
> raw_data(new base::RefCountedBytes());
458 raw_data
->data().assign(input
, input
+ input_size
);
460 return CreateFrom1xPNGBytes(raw_data
);
463 Image
Image::CreateFrom1xPNGBytes(
464 const scoped_refptr
<base::RefCountedMemory
>& input
) {
465 if (!input
.get() || input
->size() == 0u)
468 std::vector
<ImagePNGRep
> image_reps
;
469 image_reps
.push_back(ImagePNGRep(input
, 1.0f
));
470 return Image(image_reps
);
473 const SkBitmap
* Image::ToSkBitmap() const {
474 // Possibly create and cache an intermediate ImageRepSkia.
475 return ToImageSkia()->bitmap();
478 const ImageSkia
* Image::ToImageSkia() const {
479 internal::ImageRep
* rep
= GetRepresentation(kImageRepSkia
, false);
481 scoped_ptr
<internal::ImageRep
> scoped_rep
;
482 switch (DefaultRepresentationType()) {
484 internal::ImageRepPNG
* png_rep
=
485 GetRepresentation(kImageRepPNG
, true)->AsImageRepPNG();
486 scoped_rep
.reset(new internal::ImageRepSkia(
487 internal::ImageSkiaFromPNG(png_rep
->image_reps())));
491 case kImageRepCocoaTouch
: {
492 internal::ImageRepCocoaTouch
* native_rep
=
493 GetRepresentation(kImageRepCocoaTouch
, true)
494 ->AsImageRepCocoaTouch();
495 scoped_rep
.reset(new internal::ImageRepSkia(
496 new ImageSkia(ImageSkiaFromUIImage(native_rep
->image()))));
499 #elif defined(OS_MACOSX)
500 case kImageRepCocoa
: {
501 internal::ImageRepCocoa
* native_rep
=
502 GetRepresentation(kImageRepCocoa
, true)->AsImageRepCocoa();
503 scoped_rep
.reset(new internal::ImageRepSkia(
504 new ImageSkia(ImageSkiaFromNSImage(native_rep
->image()))));
512 rep
= scoped_rep
.get();
513 AddRepresentation(scoped_rep
.Pass());
515 return rep
->AsImageRepSkia()->image();
519 UIImage
* Image::ToUIImage() const {
520 internal::ImageRep
* rep
= GetRepresentation(kImageRepCocoaTouch
, false);
522 scoped_ptr
<internal::ImageRep
> scoped_rep
;
523 switch (DefaultRepresentationType()) {
525 internal::ImageRepPNG
* png_rep
=
526 GetRepresentation(kImageRepPNG
, true)->AsImageRepPNG();
527 scoped_rep
.reset(new internal::ImageRepCocoaTouch(
528 internal::CreateUIImageFromPNG(png_rep
->image_reps())));
531 case kImageRepSkia
: {
532 internal::ImageRepSkia
* skia_rep
=
533 GetRepresentation(kImageRepSkia
, true)->AsImageRepSkia();
534 UIImage
* image
= UIImageFromImageSkia(*skia_rep
->image());
535 base::mac::NSObjectRetain(image
);
536 scoped_rep
.reset(new internal::ImageRepCocoaTouch(image
));
543 rep
= scoped_rep
.get();
544 AddRepresentation(scoped_rep
.Pass());
546 return rep
->AsImageRepCocoaTouch()->image();
548 #elif defined(OS_MACOSX)
549 NSImage
* Image::ToNSImage() const {
550 internal::ImageRep
* rep
= GetRepresentation(kImageRepCocoa
, false);
552 scoped_ptr
<internal::ImageRep
> scoped_rep
;
553 CGColorSpaceRef default_representation_color_space
=
554 storage_
->default_representation_color_space();
556 switch (DefaultRepresentationType()) {
558 internal::ImageRepPNG
* png_rep
=
559 GetRepresentation(kImageRepPNG
, true)->AsImageRepPNG();
560 scoped_rep
.reset(new internal::ImageRepCocoa(internal::NSImageFromPNG(
561 png_rep
->image_reps(), default_representation_color_space
)));
564 case kImageRepSkia
: {
565 internal::ImageRepSkia
* skia_rep
=
566 GetRepresentation(kImageRepSkia
, true)->AsImageRepSkia();
567 NSImage
* image
= NSImageFromImageSkiaWithColorSpace(*skia_rep
->image(),
568 default_representation_color_space
);
569 base::mac::NSObjectRetain(image
);
570 scoped_rep
.reset(new internal::ImageRepCocoa(image
));
577 rep
= scoped_rep
.get();
578 AddRepresentation(scoped_rep
.Pass());
580 return rep
->AsImageRepCocoa()->image();
584 scoped_refptr
<base::RefCountedMemory
> Image::As1xPNGBytes() const {
586 return new base::RefCountedBytes();
588 internal::ImageRep
* rep
= GetRepresentation(kImageRepPNG
, false);
591 const std::vector
<ImagePNGRep
>& image_png_reps
=
592 rep
->AsImageRepPNG()->image_reps();
593 for (size_t i
= 0; i
< image_png_reps
.size(); ++i
) {
594 if (image_png_reps
[i
].scale
== 1.0f
)
595 return image_png_reps
[i
].raw_data
;
597 return new base::RefCountedBytes();
600 scoped_refptr
<base::RefCountedMemory
> png_bytes(NULL
);
601 switch (DefaultRepresentationType()) {
603 case kImageRepCocoaTouch
: {
604 internal::ImageRepCocoaTouch
* cocoa_touch_rep
=
605 GetRepresentation(kImageRepCocoaTouch
, true)
606 ->AsImageRepCocoaTouch();
607 png_bytes
= internal::Get1xPNGBytesFromUIImage(
608 cocoa_touch_rep
->image());
611 #elif defined(OS_MACOSX)
612 case kImageRepCocoa
: {
613 internal::ImageRepCocoa
* cocoa_rep
=
614 GetRepresentation(kImageRepCocoa
, true)->AsImageRepCocoa();
615 png_bytes
= internal::Get1xPNGBytesFromNSImage(cocoa_rep
->image());
619 case kImageRepSkia
: {
620 internal::ImageRepSkia
* skia_rep
=
621 GetRepresentation(kImageRepSkia
, true)->AsImageRepSkia();
622 png_bytes
= internal::Get1xPNGBytesFromImageSkia(skia_rep
->image());
628 if (!png_bytes
.get() || !png_bytes
->size()) {
629 // Add an ImageRepPNG with no data such that the conversion is not
630 // attempted each time we want the PNG bytes.
631 AddRepresentation(make_scoped_ptr(new internal::ImageRepPNG()));
632 return new base::RefCountedBytes();
635 // Do not insert representations for scale factors other than 1x even if
636 // they are available because:
637 // - Only the 1x PNG bytes can be accessed.
638 // - ImageRepPNG is not used as an intermediate type in converting to a
639 // final type eg (converting from ImageRepSkia to ImageRepPNG to get an
641 std::vector
<ImagePNGRep
> image_png_reps
;
642 image_png_reps
.push_back(ImagePNGRep(png_bytes
, 1.0f
));
643 AddRepresentation(make_scoped_ptr(new internal::ImageRepPNG(image_png_reps
)));
647 SkBitmap
Image::AsBitmap() const {
648 return IsEmpty() ? SkBitmap() : *ToSkBitmap();
651 ImageSkia
Image::AsImageSkia() const {
652 return IsEmpty() ? ImageSkia() : *ToImageSkia();
655 #if defined(OS_MACOSX) && !defined(OS_IOS)
656 NSImage
* Image::AsNSImage() const {
657 return IsEmpty() ? nil
: ToNSImage();
661 scoped_refptr
<base::RefCountedMemory
> Image::Copy1xPNGBytes() const {
662 scoped_refptr
<base::RefCountedMemory
> original
= As1xPNGBytes();
663 scoped_refptr
<base::RefCountedBytes
> copy(new base::RefCountedBytes());
664 copy
->data().assign(original
->front(), original
->front() + original
->size());
668 ImageSkia
* Image::CopyImageSkia() const {
669 return new ImageSkia(*ToImageSkia());
672 SkBitmap
* Image::CopySkBitmap() const {
673 return new SkBitmap(*ToSkBitmap());
677 UIImage
* Image::CopyUIImage() const {
678 UIImage
* image
= ToUIImage();
679 base::mac::NSObjectRetain(image
);
682 #elif defined(OS_MACOSX)
683 NSImage
* Image::CopyNSImage() const {
684 NSImage
* image
= ToNSImage();
685 base::mac::NSObjectRetain(image
);
690 bool Image::HasRepresentation(RepresentationType type
) const {
691 return storage_
.get() && storage_
->representations().count(type
) != 0;
694 size_t Image::RepresentationCount() const {
698 return storage_
->representations().size();
701 bool Image::IsEmpty() const {
702 return RepresentationCount() == 0;
705 int Image::Width() const {
708 return GetRepresentation(DefaultRepresentationType(), true)->Width();
711 int Image::Height() const {
714 return GetRepresentation(DefaultRepresentationType(), true)->Height();
717 gfx::Size
Image::Size() const {
720 return GetRepresentation(DefaultRepresentationType(), true)->Size();
723 void Image::SwapRepresentations(Image
* other
) {
724 storage_
.swap(other
->storage_
);
727 #if defined(OS_MACOSX) && !defined(OS_IOS)
728 void Image::SetSourceColorSpace(CGColorSpaceRef color_space
) {
730 storage_
->set_default_representation_color_space(color_space
);
732 #endif // defined(OS_MACOSX) && !defined(OS_IOS)
734 Image::RepresentationType
Image::DefaultRepresentationType() const {
735 CHECK(storage_
.get());
736 return storage_
->default_representation_type();
739 internal::ImageRep
* Image::GetRepresentation(
740 RepresentationType rep_type
, bool must_exist
) const {
741 CHECK(storage_
.get());
742 RepresentationMap::iterator it
= storage_
->representations().find(rep_type
);
743 if (it
== storage_
->representations().end()) {
750 void Image::AddRepresentation(scoped_ptr
<internal::ImageRep
> rep
) const {
751 CHECK(storage_
.get());
752 RepresentationType type
= rep
->type();
753 storage_
->representations().insert(std::make_pair(type
, rep
.release()));