Add still image capture interface for VideoCaptureDevice.

media/video/capture/video_capture_device.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.
 //
 // VideoCaptureDevice is the abstract base class for realizing video capture
 // device support in Chromium. It provides the interface for OS dependent
 // implementations.
 // The class is created and functions are invoked on a thread owned by
 // VideoCaptureManager. Capturing is done on other threads, depending on the OS
 // specific implementation.
@@ skipping 213 matching lines @@
         const VideoCaptureFormat& buffer_format,
         const scoped_refptr<media::VideoFrame>& frame,
         base::TimeTicks timestamp) = 0;
 
     // An error has occurred that cannot be handled and VideoCaptureDevice must
     // be StopAndDeAllocate()-ed. |reason| is a text description of the error.
     virtual void OnError(const std::string& reason) = 0;
 
     // VideoCaptureDevice requests the |message| to be logged.
     virtual void OnLog(const std::string& message) {}
+
+    // The video stream has been muted. After this callback, no more
+    // OnIncomingCapturedData() will be called. This may happen when
+    // CaptureImage() has called. After the still image captured, the client
+    // will get notified by OnUnmute() and the video stream will be resumed.
+    virtual void OnMute() {}
+
+    // The video stream has resumed.
+    virtual void OnUnmute() {}
+  };
+
+  // Interface for clients that use VideoCaptureDevice for taking still images.
+  class MEDIA_EXPORT ImageClient {
+   public:
+    virtual ~ImageClient() {}
+
+    // Callback function to notify the client a captured image is available.
+    //
+    // The captured still image is stored at address |data| and is of |length|
+    // bytes. The format of the frame is described by |format|, and is assumed
+    // to be tightly packed. The still image should be rotated |rotation|
+    // degrees clockwise for viewing.
+    //
+    // Note that the content in |data| will not be valid after this callback
+    // returns. Copy the content to use it later.
+    virtual void OnIncomingCapturedData(const uint8* data,
+                                        size_t length,
+                                        const ImageCaptureFormat& format,
+                                        int rotation,
+                                        base::TimeTicks timestamp) = 0;
+
+    // Callback function to notify the client about a failure of the image
+    // capture. The VideoCaptureDevice must be StopAndDeAllocate()-ed.
+    // |reason| contains a text description of the error.
+    virtual void OnError(const std::string& reason) = 0;
   };
 
   virtual ~VideoCaptureDevice();
 
   // Prepares the camera for use. After this function has been called no other
   // applications can use the camera. StopAndDeAllocate() must be called before
   // the object is deleted.
   virtual void AllocateAndStart(const VideoCaptureParams& params,
                                 scoped_ptr<Client> client) = 0;
 
   // Deallocates the camera, possibly asynchronously.
   //
   // This call requires the device to do the following things, eventually: put
   // camera hardware into a state where other applications could use it, free
   // the memory associated with capture, and delete the |client| pointer passed
   // into AllocateAndStart.
   //
   // If deallocation is done asynchronously, then the device implementation must
   // ensure that a subsequent AllocateAndStart() operation targeting the same ID
   // would be sequenced through the same task runner, so that deallocation
   // happens first.
   virtual void StopAndDeAllocate() = 0;
 
   // Gets the power line frequency from the current system time zone if this is
   // defined, otherwise returns 0.
   int GetPowerLineFrequencyForLocation() const;
 
+  // Initializes the device for still image capture for the given image format.
+  // This call is synchronous and returns true iff the initialization is
+  // successful.
+  //
+  // This function must be called between AllocateAndStart() and
+  // StopAndDeAllocate().
+  virtual bool InitializeImageCapture(const ImageCaptureFormat& image_format,
+                                      scoped_ptr<ImageClient> client);
+
+  // Releases resources for image capture.
+  //
+  // The ImageClient passed from InitializeImageCapture will be freed. This
+  // method must be called between InitializeImageCapture() and
+  // StopAndDeAllocate().
+  virtual void ReleaseImageCapture() {}
+
+  // Requests one image from the device.
+  //
+  // The image will be returned via the ImageClient::OnIncomingCapturedData()
+  // callback. If the video stream has to be stopped to capture the still image,
+  // the Client::OnMute() and Client::OnUnmute() will be called.
+  //
+  // This function must be called between InitializeImageCapture() and
+  // ReleaseImageCapture().
+  virtual void CaptureImage() {}
+
  protected:
   static const int kPowerLine50Hz = 50;
   static const int kPowerLine60Hz = 60;
 };
 
 }  // namespace media
 
 #endif  // MEDIA_VIDEO_CAPTURE_VIDEO_CAPTURE_DEVICE_H_