OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_IMAGE_DECODER_H_ | 5 #ifndef CHROME_BROWSER_IMAGE_DECODER_H_ |
6 #define CHROME_BROWSER_IMAGE_DECODER_H_ | 6 #define CHROME_BROWSER_IMAGE_DECODER_H_ |
7 | 7 |
| 8 #include <map> |
8 #include <string> | 9 #include <string> |
9 #include <vector> | 10 #include <vector> |
10 | 11 |
11 #include "base/compiler_specific.h" | 12 #include "base/compiler_specific.h" |
| 13 #include "base/lazy_instance.h" |
12 #include "base/memory/ref_counted.h" | 14 #include "base/memory/ref_counted.h" |
| 15 #include "base/synchronization/lock.h" |
13 #include "base/threading/sequenced_worker_pool.h" | 16 #include "base/threading/sequenced_worker_pool.h" |
| 17 #include "base/timer/timer.h" |
| 18 #include "content/public/browser/utility_process_host.h" |
14 #include "content/public/browser/utility_process_host_client.h" | 19 #include "content/public/browser/utility_process_host_client.h" |
15 | 20 |
16 class SkBitmap; | 21 class SkBitmap; |
17 | 22 |
18 // Decodes an image in a sandboxed process. | 23 // This is a helper class for decoding images safely in a utility process. To |
19 class ImageDecoder : public content::UtilityProcessHostClient { | 24 // use this, call ImageDecoder::Start(...) on any thread. |
| 25 // |
| 26 // Internally, all of the work happens on the IO thread, and then |
| 27 // the result (ImageRequest::OnImageDecoded or |
| 28 // ImageRequest::OnDecodeImageFailed) is posted back to the task runner |
| 29 // specified when Start(...) was called. |
| 30 class ImageDecoder { |
20 public: | 31 public: |
21 class Delegate { | 32 class ImageRequest { |
22 public: | 33 public: |
23 // Called when image is decoded. | 34 // Called when image is decoded. |
24 // |decoder| is used to identify the image in case of decoding several | 35 virtual void OnImageDecoded(const SkBitmap& decoded_image) = 0; |
25 // images simultaneously. | |
26 virtual void OnImageDecoded(const ImageDecoder* decoder, | |
27 const SkBitmap& decoded_image) = 0; | |
28 | 36 |
29 // Called when decoding image failed. Delegate can do some cleanup in | 37 // Called when decoding image failed. ImageRequest can do some cleanup in |
30 // this handler. | 38 // this handler. |
31 virtual void OnDecodeImageFailed(const ImageDecoder* decoder) {} | 39 virtual void OnDecodeImageFailed() {} |
| 40 |
| 41 base::SequencedTaskRunner* task_runner() const { |
| 42 return task_runner_.get(); |
| 43 } |
32 | 44 |
33 protected: | 45 protected: |
34 virtual ~Delegate() {} | 46 explicit ImageRequest( |
| 47 const scoped_refptr<base::SequencedTaskRunner>& task_runner); |
| 48 virtual ~ImageRequest(); |
| 49 |
| 50 private: |
| 51 const scoped_refptr<base::SequencedTaskRunner> task_runner_; |
35 }; | 52 }; |
36 | 53 |
37 enum ImageCodec { | 54 enum ImageCodec { |
38 DEFAULT_CODEC = 0, // Uses WebKit image decoding (via WebImage). | 55 DEFAULT_CODEC = 0, // Uses WebKit image decoding (via WebImage). |
39 ROBUST_JPEG_CODEC, // Restrict decoding to robust jpeg codec. | 56 ROBUST_JPEG_CODEC, // Restrict decoding to robust jpeg codec. |
40 }; | 57 }; |
41 | 58 |
42 ImageDecoder(Delegate* delegate, | |
43 const std::string& image_data, | |
44 ImageCodec image_codec); | |
45 | |
46 ImageDecoder(Delegate* delegate, | |
47 const std::vector<char>& image_data, | |
48 ImageCodec image_codec); | |
49 | |
50 // Starts asynchronous image decoding. Once finished, the callback will be | 59 // Starts asynchronous image decoding. Once finished, the callback will be |
51 // posted back to |task_runner|. | 60 // posted back to |task_runner|. |
52 void Start(scoped_refptr<base::SequencedTaskRunner> task_runner); | 61 static void Start(ImageRequest* image_request, |
| 62 const std::string& image_data, |
| 63 ImageCodec image_codec, |
| 64 bool shrink_to_fit); |
53 | 65 |
54 const std::vector<unsigned char>& get_image_data() const { | 66 // Removes all instances of image_request from image_request_id_map_, |
55 return image_data_; | 67 // ensuring callbacks are not made to the image_request after it is destroyed. |
56 } | 68 static void Cancel(ImageRequest* image_request); |
57 | |
58 void set_delegate(Delegate* delegate) { delegate_ = delegate; } | |
59 void set_shrink_to_fit(bool shrink_to_fit) { shrink_to_fit_ = shrink_to_fit; } | |
60 | 69 |
61 private: | 70 private: |
62 // It's a reference counted object, so destructor is private. | 71 friend struct base::DefaultLazyInstanceTraits<ImageDecoder>; |
63 ~ImageDecoder() override; | 72 static ImageDecoder* GetInstance(); |
| 73 ImageDecoder(); |
| 74 ~ImageDecoder(); |
64 | 75 |
65 // Overidden from UtilityProcessHostClient: | 76 class ImageDecoderImpl : public content::UtilityProcessHostClient { |
66 bool OnMessageReceived(const IPC::Message& message) override; | 77 public: |
| 78 ImageDecoderImpl(); |
67 | 79 |
68 // IPC message handlers. | 80 // Sends a request to the sandboxed process to decode the image. Starts |
69 void OnDecodeImageSucceeded(const SkBitmap& decoded_image); | 81 // batch mode if necessary. |
70 void OnDecodeImageFailed(); | 82 void DecodeImageInSandbox(ImageRequest* image_request, |
| 83 const std::vector<unsigned char>& image_data, |
| 84 ImageCodec image_codec, |
| 85 bool shrink_to_fit); |
71 | 86 |
72 // Launches sandboxed process that will decode the image. | 87 void Cancel(ImageRequest* image_request); |
73 void DecodeImageInSandbox(const std::vector<unsigned char>& image_data); | |
74 | 88 |
75 Delegate* delegate_; | 89 private: |
76 std::vector<unsigned char> image_data_; | 90 using RequestMap = std::map<int, ImageRequest*>; |
77 const ImageCodec image_codec_; | 91 |
78 scoped_refptr<base::SequencedTaskRunner> task_runner_; | 92 // It's a reference counted object, so destructor is private. |
79 bool shrink_to_fit_; // if needed for IPC msg size limit | 93 ~ImageDecoderImpl() override; |
| 94 |
| 95 // Starts UtilityProcessHost in batch mode and starts batch_mode_timer_. |
| 96 void StartBatchMode(); |
| 97 |
| 98 // Stops batch mode if no requests have come in since kBatchModeTimeout. |
| 99 void StopBatchMode(); |
| 100 |
| 101 // Overidden from UtilityProcessHostClient. |
| 102 bool OnMessageReceived(const IPC::Message& message) override; |
| 103 |
| 104 // IPC message handlers. |
| 105 void OnDecodeImageSucceeded(const SkBitmap& decoded_image, int id); |
| 106 void OnDecodeImageFailed(int id); |
| 107 |
| 108 // id to use for the next Start request that comes in. |
| 109 int image_request_id_counter_; |
| 110 |
| 111 // Map of request id's to ImageRequests. |
| 112 RequestMap image_request_id_map_; |
| 113 |
| 114 // Protects image_request_id_map_ and image_request_id_counter_. |
| 115 base::Lock map_lock_; |
| 116 |
| 117 // The UtilityProcessHost requests are sent to. |
| 118 base::WeakPtr<content::UtilityProcessHost> utility_process_host_; |
| 119 |
| 120 // Calls StopBatchMode after kBatchModeTimeout has elapsed. |
| 121 base::RepeatingTimer<ImageDecoderImpl> batch_mode_timer_; |
| 122 |
| 123 // The time Start was last called. |
| 124 base::TimeTicks last_request_; |
| 125 }; |
| 126 |
| 127 const scoped_refptr<ImageDecoderImpl> image_decoder_impl_; |
80 | 128 |
81 DISALLOW_COPY_AND_ASSIGN(ImageDecoder); | 129 DISALLOW_COPY_AND_ASSIGN(ImageDecoder); |
82 }; | 130 }; |
83 | 131 |
84 #endif // CHROME_BROWSER_IMAGE_DECODER_H_ | 132 #endif // CHROME_BROWSER_IMAGE_DECODER_H_ |
OLD | NEW |