Make image_decoder a Leaky LazyInstance

chrome/browser/image_decoder.h

 // 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.
 
 #ifndef CHROME_BROWSER_IMAGE_DECODER_H_
 #define CHROME_BROWSER_IMAGE_DECODER_H_
 
+#include <map>
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
+#include "base/lazy_instance.h"
 #include "base/memory/ref_counted.h"
 #include "base/threading/sequenced_worker_pool.h"
+#include "content/public/browser/utility_process_host.h"
 #include "content/public/browser/utility_process_host_client.h"
 
 class SkBitmap;
 
-// Decodes an image in a sandboxed process.
-class ImageDecoder : public content::UtilityProcessHostClient {
+// Singleton to decode images in a sandboxed process.
+class ImageDecoder {
  public:
   class Delegate {
    public:
     // Called when image is decoded.
-    // |decoder| is used to identify the image in case of decoding several
-    // images simultaneously.
-    virtual void OnImageDecoded(const ImageDecoder* decoder,
-                                const SkBitmap& decoded_image) = 0;
+    virtual void OnImageDecoded(const SkBitmap& decoded_image) = 0;
 
     // Called when decoding image failed. Delegate can do some cleanup in
     // this handler.
-    virtual void OnDecodeImageFailed(const ImageDecoder* decoder) {}
+    virtual void OnDecodeImageFailed() {}
 
    protected:
     virtual ~Delegate() {}
   };
 
   enum ImageCodec {
     DEFAULT_CODEC = 0,  // Uses WebKit image decoding (via WebImage).
     ROBUST_JPEG_CODEC,  // Restrict decoding to robust jpeg codec.
   };
 
-  ImageDecoder(Delegate* delegate,
-               const std::string& image_data,
-               ImageCodec image_codec);
-
-  ImageDecoder(Delegate* delegate,
-               const std::vector<char>& image_data,
-               ImageCodec image_codec);
+  static ImageDecoder* GetInstance();
 
   // Starts asynchronous image decoding. Once finished, the callback will be
   // posted back to |task_runner|.
-  void Start(scoped_refptr<base::SequencedTaskRunner> task_runner);
-
-  const std::vector<unsigned char>& get_image_data() const {
-    return image_data_;
-  }
-
-  void set_delegate(Delegate* delegate) { delegate_ = delegate; }
-  void set_shrink_to_fit(bool shrink_to_fit) { shrink_to_fit_ = shrink_to_fit; }
+  void Start(Delegate* delegate,
+             const std::string& image_data,
+             ImageCodec image_codec,
+             scoped_refptr<base::SequencedTaskRunner> task_runner,
+             bool shrink_to_fit);
 
  private:
-  // It's a reference counted object, so destructor is private.
-  ~ImageDecoder() override;
+  friend struct base::DefaultLazyInstanceTraits<ImageDecoder>;
+  ImageDecoder();
+  ~ImageDecoder();
 
-  // Overidden from UtilityProcessHostClient:
-  bool OnMessageReceived(const IPC::Message& message) override;
+  class ImageDecoderImpl : public content::UtilityProcessHostClient {
+   public:
+    ImageDecoderImpl();
+    void Start(Delegate* delegate,
+               const std::string& image_data,
+               ImageCodec image_codec,
+               scoped_refptr<base::SequencedTaskRunner> task_runner,
+               bool shrink_to_fit);
 
-  // IPC message handlers.
-  void OnDecodeImageSucceeded(const SkBitmap& decoded_image);
-  void OnDecodeImageFailed();
+   private:
+    // It's a reference counted object, so destructor is private.
+    ~ImageDecoderImpl() override;
 
-  // Launches sandboxed process that will decode the image.
-  void DecodeImageInSandbox(const std::vector<unsigned char>& image_data);
+    // Contains attributes we need to know about each image decode
+    // request we send.
+    struct RequestInfo {
+      RequestInfo(Delegate* delegate,
+                  scoped_refptr<base::SequencedTaskRunner> task_runner);
+      ~RequestInfo();
 
-  Delegate* delegate_;
-  std::vector<unsigned char> image_data_;
-  const ImageCodec image_codec_;
-  scoped_refptr<base::SequencedTaskRunner> task_runner_;
-  bool shrink_to_fit_; // if needed for IPC msg size limit
+      Delegate* delegate;
+      scoped_refptr<base::SequencedTaskRunner> task_runner;
+    };
+
+    typedef std::map<int, RequestInfo*> RequestMap;

[dcheng, 2015/03/10 15:49:12]

I have the vague impression that using foo = bar; is preferred over typedefs
now, but I don't really care (based on https://chromium-cpp.appspot.com).

[Theresa, 2015/03/10 23:50:54]

Acknowledged.

+
+    // Starts UtilityProcessHost in batch mode and calls
+    // PostDelayedStopBatchModeTask.
+    void StartBatchMode(Delegate* delegate,
+                        const std::string& image_data,
+                        ImageCodec image_codec,
+                        bool shrink_to_fit);
+
+    // Posts a delayed task to stop the UtilityProcessHost running in
+    // batch mode.
+    void PostDelayedStopBatchModeTask();
+
+    // Stops batch mode if no requests have come in since
+    // |batch_mode_timeout_seconds_|; else calls PostDelayedStopBatchModeTask.
+    void StopBatchMode();
+
+    // Overidden from UtilityProcessHostClient.
+    bool OnMessageReceived(const IPC::Message& message) override;
+
+    // IPC message handlers.
+    void OnDecodeImageSucceeded(const SkBitmap& decoded_image, int id);
+    void OnDecodeImageFailed(int id);
+
+    void NotifyDelegateDecodeSucceeded(const SkBitmap& decoded_image,
+                                       Delegate* delegate);
+    void NotifyDelegateDecodeFailed(Delegate* delegate);
+
+    // Sends a request to the sandboxed process to decode the image.
+    void DecodeImageInSandbox(Delegate* delegate,
+                              const std::vector<unsigned char>& image_data,
+                              ImageCodec image_codec,
+                              bool shrink_to_fit,
+                              int delegate_id);
+
+    // id to use for the next Start request that comes in.
+    int delegate_id_counter_;
+
+    // Map of request id's to RequestInfo
+    RequestMap request_info_id_map_;
+
+    // The SequencedTaskRunner provided when Start is called before batch mode
+    // is started. base::Bind does not accept scoped_refptr objects, so the
+    // value must be saved instead.

[dcheng, 2015/03/10 15:49:12]

I don't quite follow this comment. base::Bind() does handle binding to
refcounted objects. What sort of error were you seeing?

[Theresa, 2015/03/10 23:50:54]

If I recall correctly, I was seeing this message (in bind.h):

static_assert(!internal::HasRefCountedParamAsRawPtr<is_method, Args...>::value,
"a_parameter_is_refcounted_type_and_needs_scoped_refptr");


But I must have been doing something wrong because I don't see it anymore.

+    scoped_refptr<base::SequencedTaskRunner> task_runner_at_start_;
+
+    // The UtilityProcessHost requests are sent to.
+    base::WeakPtr<content::UtilityProcessHost> utility_process_host_;
+
+    // The time Start was last called.
+    base::TimeTicks last_request_;
+
+    // How many seconds to wait after the last request has been received
+    // before ending batch mode.
+    const int kBatchModeTimeoutSeconds = 5;
+
+    // True iff utility_process_host_ has been created and started in
+    // batch bode.
+    bool batch_mode_started_;
+  };
+
+  const scoped_refptr<ImageDecoderImpl> image_decoder_impl_;
 
   DISALLOW_COPY_AND_ASSIGN(ImageDecoder);
 };
 
 #endif  // CHROME_BROWSER_IMAGE_DECODER_H_