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/id_map.h" | |
14 #include "base/lazy_instance.h" | |
12 #include "base/memory/ref_counted.h" | 15 #include "base/memory/ref_counted.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 (Delegate::OnImageDecoded or Delegate::OnDecodeImageFailed) is | |
28 // posted back to the task runner specified when Start(...) was called. | |
29 class ImageDecoder { | |
20 public: | 30 public: |
21 class Delegate { | 31 class Delegate { |
22 public: | 32 public: |
23 // Called when image is decoded. | 33 // Called when image is decoded. |
24 // |decoder| is used to identify the image in case of decoding several | 34 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 | 35 |
29 // Called when decoding image failed. Delegate can do some cleanup in | 36 // Called when decoding image failed. Delegate can do some cleanup in |
30 // this handler. | 37 // this handler. |
31 virtual void OnDecodeImageFailed(const ImageDecoder* decoder) {} | 38 virtual void OnDecodeImageFailed() {} |
39 | |
40 base::SequencedTaskRunner* task_runner() const { return t.get(); } | |
32 | 41 |
33 protected: | 42 protected: |
34 virtual ~Delegate() {} | 43 explicit Delegate(const scoped_refptr<base::SequencedTaskRunner>& t); |
44 virtual ~Delegate(); | |
45 | |
46 private: | |
47 const scoped_refptr<base::SequencedTaskRunner> t; | |
35 }; | 48 }; |
36 | 49 |
37 enum ImageCodec { | 50 enum ImageCodec { |
38 DEFAULT_CODEC = 0, // Uses WebKit image decoding (via WebImage). | 51 DEFAULT_CODEC = 0, // Uses WebKit image decoding (via WebImage). |
39 ROBUST_JPEG_CODEC, // Restrict decoding to robust jpeg codec. | 52 ROBUST_JPEG_CODEC, // Restrict decoding to robust jpeg codec. |
40 }; | 53 }; |
41 | 54 |
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 | 55 // Starts asynchronous image decoding. Once finished, the callback will be |
51 // posted back to |task_runner|. | 56 // posted back to |task_runner|. |
52 void Start(scoped_refptr<base::SequencedTaskRunner> task_runner); | 57 static void Start(Delegate* delegate, |
58 const std::string& image_data, | |
59 ImageCodec image_codec, | |
60 bool shrink_to_fit); | |
53 | 61 |
54 const std::vector<unsigned char>& get_image_data() const { | 62 // Removes all instances of delegate from the IDMap, ensuring callbacks |
55 return image_data_; | 63 // are not made to the delegate after it is destroyed. |
56 } | 64 static void RemoveDelegate(Delegate* delegate); |
dcheng
2015/03/20 00:14:45
Cancel() is probably a clearer name for this.
Theresa
2015/03/20 19:09:01
Done.
| |
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 | 65 |
61 private: | 66 private: |
62 // It's a reference counted object, so destructor is private. | 67 friend struct base::DefaultLazyInstanceTraits<ImageDecoder>; |
63 ~ImageDecoder() override; | 68 static ImageDecoder* GetInstance(); |
69 ImageDecoder(); | |
70 ~ImageDecoder(); | |
64 | 71 |
65 // Overidden from UtilityProcessHostClient: | 72 class ImageDecoderImpl : public content::UtilityProcessHostClient { |
66 bool OnMessageReceived(const IPC::Message& message) override; | 73 public: |
74 ImageDecoderImpl(); | |
67 | 75 |
68 // IPC message handlers. | 76 // Sends a request to the sandboxed process to decode the image. Starts |
69 void OnDecodeImageSucceeded(const SkBitmap& decoded_image); | 77 // batch mode if necessary. |
70 void OnDecodeImageFailed(); | 78 void DecodeImageInSandbox(Delegate* delegate, |
79 const std::vector<unsigned char>& image_data, | |
80 ImageCodec image_codec, | |
81 bool shrink_to_fit); | |
71 | 82 |
72 // Launches sandboxed process that will decode the image. | 83 void RemoveDelegate(Delegate* delegate); |
73 void DecodeImageInSandbox(const std::vector<unsigned char>& image_data); | |
74 | 84 |
75 Delegate* delegate_; | 85 private: |
76 std::vector<unsigned char> image_data_; | 86 // It's a reference counted object, so destructor is private. |
77 const ImageCodec image_codec_; | 87 ~ImageDecoderImpl() override; |
78 scoped_refptr<base::SequencedTaskRunner> task_runner_; | 88 |
79 bool shrink_to_fit_; // if needed for IPC msg size limit | 89 // Starts UtilityProcessHost in batch mode and starts batch_mode_timer_. |
90 void StartBatchMode(); | |
91 | |
92 // Stops batch mode if no requests have come in since kBatchModeTimeout. | |
93 void StopBatchMode(); | |
94 | |
95 // Overidden from UtilityProcessHostClient. | |
96 bool OnMessageReceived(const IPC::Message& message) override; | |
97 | |
98 // IPC message handlers. | |
99 void OnDecodeImageSucceeded(const SkBitmap& decoded_image, int id); | |
100 void OnDecodeImageFailed(int id); | |
101 | |
102 // id to use for the next Start request that comes in. | |
103 int delegate_id_counter_; | |
104 | |
105 // Map of request id's to Delegates. | |
106 IDMap<Delegate> delegate_id_map_; | |
107 | |
108 // The UtilityProcessHost requests are sent to. | |
109 base::WeakPtr<content::UtilityProcessHost> utility_process_host_; | |
110 | |
111 // Calls StopBatchMode after kBatchModeTimeout has elapsed. | |
112 base::RepeatingTimer<ImageDecoderImpl> batch_mode_timer_; | |
113 | |
114 // The time Start was last called. | |
115 base::TimeTicks last_request_; | |
116 | |
117 // How long to wait after the last request has been received before ending | |
118 // batch mode. | |
119 const base::TimeDelta kBatchModeTimeout = base::TimeDelta::FromSeconds(5); | |
120 | |
121 // True iff utility_process_host_ has been created and started in | |
122 // batch mode. | |
123 bool batch_mode_started_; | |
124 }; | |
125 | |
126 const scoped_refptr<ImageDecoderImpl> image_decoder_impl_; | |
80 | 127 |
81 DISALLOW_COPY_AND_ASSIGN(ImageDecoder); | 128 DISALLOW_COPY_AND_ASSIGN(ImageDecoder); |
82 }; | 129 }; |
83 | 130 |
84 #endif // CHROME_BROWSER_IMAGE_DECODER_H_ | 131 #endif // CHROME_BROWSER_IMAGE_DECODER_H_ |
OLD | NEW |