summaryrefslogtreecommitdiffstats
path: root/dom/media/CanvasCaptureMediaStream.h
blob: faa5972142e5ed32c61b1e6e064b28e3fe51af5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-*/
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_dom_CanvasCaptureMediaStream_h_
#define mozilla_dom_CanvasCaptureMediaStream_h_

#include "DOMMediaStream.h"
#include "mozilla/dom/HTMLCanvasElement.h"
#include "PrincipalHandle.h"

class nsIPrincipal;

namespace mozilla {
class DOMMediaStream;
class SourceMediaTrack;

namespace layers {
class Image;
}  // namespace layers

namespace dom {
class CanvasCaptureMediaStream;
class HTMLCanvasElement;
class OutputStreamFrameListener;

/*
 * The CanvasCaptureMediaStream is a MediaStream subclass that provides a video
 * track containing frames from a canvas. See an architectural overview below.
 *
 * ----------------------------------------------------------------------------
 *     === Main Thread ===              __________________________
 *                                     |                          |
 *                                     | CanvasCaptureMediaStream |
 *                                     |__________________________|
 *                                                  |
 *                                                  | RequestFrame()
 *                                                  v
 *                                       ________________________
 *  ________   FrameCaptureRequested?   |                        |
 * |        | ------------------------> |   OutputStreamDriver   |
 * | Canvas |  SetFrameCapture()        | (FrameCaptureListener) |
 * |________| ------------------------> |________________________|
 *                                                  |
 *                                                  | SetImage() -
 *                                                  | AppendToTrack()
 *                                                  |
 *                                                  v
 *                                      __________________________
 *                                     |                          |
 *                                     |  MTG / SourceMediaTrack  |
 *                                     |__________________________|
 * ----------------------------------------------------------------------------
 */

/*
 * Base class for drivers of the output stream.
 * It is up to each sub class to implement the NewFrame() callback of
 * FrameCaptureListener.
 */
class OutputStreamDriver : public FrameCaptureListener {
 public:
  OutputStreamDriver(SourceMediaTrack* aSourceStream,
                     const PrincipalHandle& aPrincipalHandle);

  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(OutputStreamDriver);

  /*
   * Called from js' requestFrame() when it wants the next painted frame to be
   * explicitly captured.
   */
  virtual void RequestFrameCapture() = 0;

  /*
   * Sub classes can SetImage() to update the image being appended to the
   * output stream. It will be appended on the next NotifyPull from MTG.
   */
  void SetImage(RefPtr<layers::Image>&& aImage, const TimeStamp& aTime);

  /*
   * Ends the track in mSourceStream when we know there won't be any more images
   * requested for it.
   */
  void EndTrack();

  const RefPtr<SourceMediaTrack> mSourceStream;
  const PrincipalHandle mPrincipalHandle;

 protected:
  virtual ~OutputStreamDriver();
};

class CanvasCaptureMediaStream : public DOMMediaStream {
 public:
  CanvasCaptureMediaStream(nsPIDOMWindowInner* aWindow,
                           HTMLCanvasElement* aCanvas);

  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(CanvasCaptureMediaStream,
                                           DOMMediaStream)

  nsresult Init(const dom::Optional<double>& aFPS, nsIPrincipal* aPrincipal);

  JSObject* WrapObject(JSContext* aCx,
                       JS::Handle<JSObject*> aGivenProto) override;

  // WebIDL
  HTMLCanvasElement* Canvas() const { return mCanvas; }
  void RequestFrame();

  dom::FrameCaptureListener* FrameCaptureListener();

  /**
   * Stops capturing for this stream at mCanvas.
   */
  void StopCapture();

  SourceMediaTrack* GetSourceStream() const;

 protected:
  ~CanvasCaptureMediaStream();

 private:
  RefPtr<HTMLCanvasElement> mCanvas;
  RefPtr<OutputStreamDriver> mOutputStreamDriver;
};

}  // namespace dom
}  // namespace mozilla

#endif /* mozilla_dom_CanvasCaptureMediaStream_h_ */