content/browser/renderer_host/media/video_capture_controller_event_handler.h

   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.
   4
   5 #ifndef CONTENT_BROWSER_RENDERER_HOST_MEDIA_VIDEO_CAPTURE_CONTROLLER_EVENT_HANDLER_H_
   6 #define CONTENT_BROWSER_RENDERER_HOST_MEDIA_VIDEO_CAPTURE_CONTROLLER_EVENT_HANDLER_H_
   7
   8 #include "base/shared_memory.h"
   9 #include "base/time.h"
  10 #include "content/common/content_export.h"
  11
  12 namespace content {
  13
  14 // ID used for identifying an object of VideoCaptureController.
  15 struct CONTENT_EXPORT VideoCaptureControllerID {
  16   explicit VideoCaptureControllerID(int device_id);
  17
  18   bool operator<(const VideoCaptureControllerID& vc) const;
  19   bool operator==(const VideoCaptureControllerID& vc) const;
  20
  21   int device_id;
  22 };
  23
  24 // VideoCaptureControllerEventHandler is the interface for
  25 // VideoCaptureController to notify clients about the events such as
  26 // BufferReady, FrameInfo, Error, etc.
  27 class CONTENT_EXPORT VideoCaptureControllerEventHandler {
  28  public:
  29   // An Error has occurred in the VideoCaptureDevice.
  30   virtual void OnError(const VideoCaptureControllerID& id) = 0;
  31
  32   // A buffer has been newly created.
  33   virtual void OnBufferCreated(const VideoCaptureControllerID& id,
  34                                base::SharedMemoryHandle handle,
  35                                int length, int buffer_id) = 0;
  36
  37   // A buffer has been filled with I420 video.
  38   virtual void OnBufferReady(const VideoCaptureControllerID& id,
  39                              int buffer_id,
  40                              base::Time timestamp) = 0;
  41
  42   // The frame resolution the VideoCaptureDevice capture video in.
  43   virtual void OnFrameInfo(const VideoCaptureControllerID& id,
  44                            int width,
  45                            int height,
  46                            int frame_rate) = 0;
  47
  48   // The capture session has ended and no more frames will be sent.
  49   virtual void OnEnded(const VideoCaptureControllerID& id) = 0;
  50
  51  protected:
  52   virtual ~VideoCaptureControllerEventHandler() {}
  53 };
  54
  55 }  // namespace content
  56
  57 #endif  // CONTENT_BROWSER_RENDERER_HOST_MEDIA_VIDEO_CAPTURE_CONTROLLER_EVENT_HANDLER_H_