Note: We no longer publish the latest version of our code here. We primarily use a kumc-bmi github organization. The heron ETL repository, in particular, is not public. Peers in the informatics community should see MultiSiteDev for details on requesting access.

source: webrtc/talk/media/base/capturemanager.h @ 0:4bda6873e34c

pub_scrub_3792 tip
Last change on this file since 0:4bda6873e34c was 0:4bda6873e34c, checked in by Michael Prittie <mprittie@…>, 6 years ago

Scrubbed password for publication.

File size: 5.0 KB
Line 
1/*
2 * libjingle
3 * Copyright 2012 Google Inc.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 *  1. Redistributions of source code must retain the above copyright notice,
9 *     this list of conditions and the following disclaimer.
10 *  2. Redistributions in binary form must reproduce the above copyright notice,
11 *     this list of conditions and the following disclaimer in the documentation
12 *     and/or other materials provided with the distribution.
13 *  3. The name of the author may not be used to endorse or promote products
14 *     derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28// The CaptureManager class manages VideoCapturers to make it possible to share
29// the same VideoCapturers across multiple instances. E.g. if two instances of
30// some class want to listen to same VideoCapturer they can't individually stop
31// and start capturing as doing so will affect the other instance.
32// The class employs reference counting on starting and stopping of capturing of
33// frames such that if anyone is still listening it will not be stopped. The
34// class also provides APIs for attaching VideoRenderers to a specific capturer
35// such that the VideoRenderers are fed frames directly from the capturer. In
36// addition, these frames can be altered before being sent to the capturers by
37// way of VideoProcessors.
38// CaptureManager is Thread-unsafe. This means that none of its APIs may be
39// called concurrently. Note that callbacks are called by the VideoCapturer's
40// thread which is normally a separate unmarshalled thread and thus normally
41// require lock protection.
42
43#ifndef TALK_MEDIA_BASE_CAPTUREMANAGER_H_
44#define TALK_MEDIA_BASE_CAPTUREMANAGER_H_
45
46#include <map>
47#include <vector>
48
49#include "talk/base/sigslotrepeater.h"
50#include "talk/media/base/capturerenderadapter.h"
51#include "talk/media/base/videocommon.h"
52
53namespace cricket {
54
55class VideoCapturer;
56class VideoProcessor;
57class VideoRenderer;
58class VideoCapturerState;
59
60class CaptureManager : public sigslot::has_slots<> {
61 public:
62  enum RestartOptions {
63    kRequestRestart,
64    kForceRestart
65  };
66
67  CaptureManager() {}
68  virtual ~CaptureManager();
69
70  virtual bool StartVideoCapture(VideoCapturer* video_capturer,
71                                 const VideoFormat& desired_format);
72  virtual bool StopVideoCapture(VideoCapturer* video_capturer,
73                                const VideoFormat& format);
74
75  // Possibly restarts the capturer. If |options| is set to kRequestRestart,
76  // the CaptureManager chooses whether this request can be handled with the
77  // current state or if a restart is actually needed. If |options| is set to
78  // kForceRestart, the capturer is restarted.
79  virtual bool RestartVideoCapture(VideoCapturer* video_capturer,
80                                   const VideoFormat& previous_format,
81                                   const VideoFormat& desired_format,
82                                   RestartOptions options);
83
84  virtual bool AddVideoRenderer(VideoCapturer* video_capturer,
85                                VideoRenderer* video_renderer);
86  virtual bool RemoveVideoRenderer(VideoCapturer* video_capturer,
87                                   VideoRenderer* video_renderer);
88
89  virtual bool AddVideoProcessor(VideoCapturer* video_capturer,
90                                 VideoProcessor* video_processor);
91  virtual bool RemoveVideoProcessor(VideoCapturer* video_capturer,
92                                    VideoProcessor* video_processor);
93
94  sigslot::repeater2<VideoCapturer*, CaptureState> SignalCapturerStateChange;
95
96 private:
97  typedef std::map<VideoCapturer*, VideoCapturerState*> CaptureStates;
98
99  bool IsCapturerRegistered(VideoCapturer* video_capturer) const;
100  bool RegisterVideoCapturer(VideoCapturer* video_capturer);
101  void UnregisterVideoCapturer(VideoCapturerState* capture_state);
102
103  bool StartWithBestCaptureFormat(VideoCapturerState* capture_info,
104                                  VideoCapturer* video_capturer);
105
106  VideoCapturerState* GetCaptureState(VideoCapturer* video_capturer) const;
107  CaptureRenderAdapter* GetAdapter(VideoCapturer* video_capturer) const;
108
109  CaptureStates capture_states_;
110};
111
112}  // namespace cricket
113
114#endif  // TALK_MEDIA_BASE_CAPTUREMANAGER_H_
Note: See TracBrowser for help on using the repository browser.