gecko-dev/dom/media/CanvasCaptureMediaStream.h
Andreas Pehrson be74876e25 Bug 1208371 - Add PrincipalHandle to MediaChunks. r=mt,jesup
PrincipalHandle is a thread safe pointer to a holder of (the main-thread-only
nsIPrincipal) that can be passed around the MSG.

A MediaStreamTrack whose source has just updated its principal, sets the new
principal aside (as its "pending principal"), and combines the new principal
into its current principal.

Then the source starts passing the new principal to the MediaStreamGraph as
a PrincipalHandle.

Changes to a track's PrincipalHandle on the MSG will be surfaced through the
MediaStreamTrackListener API. These changes are dispatched to main thread
and compared to a MediaStreamTrack's pending principal. In case of a match
the track knows the correct principal is flowing and can move the pending
principal to be the current principal and update any main thread principal
observers.

MozReview-Commit-ID: D0JXGWhQFFU

--HG--
extra : rebase_source : 296e269bb46fc5a85a9c3f90dfc0dc40e53572bc
2016-04-06 14:56:44 +02:00

136 lines
4.8 KiB
C++

/* -*- 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 "StreamBuffer.h"
class nsIPrincipal;
namespace mozilla {
class DOMMediaStream;
class MediaStreamListener;
class SourceMediaStream;
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()
* v
* ___________________
* | StreamListener |
* ---------------------------------------| (All image access |----------------
* === MediaStreamGraph Thread === | Mutex Guarded) |
* |___________________|
* ^ |
* NotifyPull() | | AppendToTrack()
* | v
* ___________________________
* | |
* | MSG / SourceMediaStream |
* |___________________________|
* ----------------------------------------------------------------------------
*/
/*
* 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(SourceMediaStream* aSourceStream,
const TrackID& aTrackId,
const PrincipalHandle& aPrincipalHandle);
NS_INLINE_DECL_THREADSAFE_REFCOUNTING(OutputStreamDriver);
/*
* Sub classes can SetImage() to update the image being appended to the
* output stream. It will be appended on the next NotifyPull from MSG.
*/
void SetImage(const RefPtr<layers::Image>& aImage);
/*
* Makes sure any internal resources this driver is holding that may create
* reference cycles are released.
*/
virtual void Forget() {}
protected:
virtual ~OutputStreamDriver();
class StreamListener;
private:
RefPtr<SourceMediaStream> mSourceStream;
RefPtr<StreamListener> mStreamListener;
};
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, const TrackID& aTrackId,
nsIPrincipal* aPrincipal);
JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
// WebIDL
HTMLCanvasElement* Canvas() const { return mCanvas; }
void RequestFrame();
dom::FrameCaptureListener* FrameCaptureListener();
/**
* Create a CanvasCaptureMediaStream whose underlying stream is a SourceMediaStream.
*/
static already_AddRefed<CanvasCaptureMediaStream>
CreateSourceStream(nsPIDOMWindowInner* aWindow,
HTMLCanvasElement* aCanvas);
protected:
~CanvasCaptureMediaStream();
private:
RefPtr<HTMLCanvasElement> mCanvas;
RefPtr<OutputStreamDriver> mOutputStreamDriver;
};
} // namespace dom
} // namespace mozilla
#endif /* mozilla_dom_CanvasCaptureMediaStream_h_ */