mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-09-10 11:54:40 +00:00
735 lines
26 KiB
C
735 lines
26 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 NSDOMMEDIASTREAM_H_
|
||
|
#define NSDOMMEDIASTREAM_H_
|
||
|
|
||
|
#include "ImageContainer.h"
|
||
|
|
||
|
#include "nsCycleCollectionParticipant.h"
|
||
|
#include "nsWrapperCache.h"
|
||
|
#include "StreamBuffer.h"
|
||
|
#include "nsIDOMWindow.h"
|
||
|
#include "nsIPrincipal.h"
|
||
|
#include "mozilla/PeerIdentity.h"
|
||
|
#include "mozilla/DOMEventTargetHelper.h"
|
||
|
#include "mozilla/CORSMode.h"
|
||
|
|
||
|
// GetCurrentTime is defined in winbase.h as zero argument macro forwarding to
|
||
|
// GetTickCount() and conflicts with NS_DECL_NSIDOMMEDIASTREAM, containing
|
||
|
// currentTime getter.
|
||
|
#ifdef GetCurrentTime
|
||
|
#undef GetCurrentTime
|
||
|
#endif
|
||
|
// X11 has a #define for CurrentTime. Unbelievable :-(.
|
||
|
// See dom/media/webaudio/AudioContext.h for more fun!
|
||
|
#ifdef CurrentTime
|
||
|
#undef CurrentTime
|
||
|
#endif
|
||
|
|
||
|
namespace mozilla {
|
||
|
|
||
|
class DOMHwMediaStream;
|
||
|
class DOMLocalMediaStream;
|
||
|
class MediaStream;
|
||
|
class MediaEngineSource;
|
||
|
class MediaInputPort;
|
||
|
class MediaStreamGraph;
|
||
|
class ProcessedMediaStream;
|
||
|
|
||
|
namespace dom {
|
||
|
class AudioNode;
|
||
|
class HTMLCanvasElement;
|
||
|
class MediaStreamTrack;
|
||
|
class AudioStreamTrack;
|
||
|
class VideoStreamTrack;
|
||
|
class AudioTrack;
|
||
|
class VideoTrack;
|
||
|
class AudioTrackList;
|
||
|
class VideoTrackList;
|
||
|
class MediaTrackListListener;
|
||
|
struct MediaTrackConstraints;
|
||
|
} // namespace dom
|
||
|
|
||
|
namespace layers {
|
||
|
class ImageContainer;
|
||
|
class OverlayImage;
|
||
|
} // namespace layers
|
||
|
|
||
|
class MediaStreamDirectListener;
|
||
|
|
||
|
#define NS_DOMMEDIASTREAM_IID \
|
||
|
{ 0x8cb65468, 0x66c0, 0x444e, \
|
||
|
{ 0x89, 0x9f, 0x89, 0x1d, 0x9e, 0xd2, 0xbe, 0x7c } }
|
||
|
|
||
|
/**
|
||
|
* DOM wrapper for MediaStreams.
|
||
|
*
|
||
|
* To account for track operations such as clone(), addTrack() and
|
||
|
* removeTrack(), a DOMMediaStream wraps three internal (and chained)
|
||
|
* MediaStreams:
|
||
|
* 1. mInputStream
|
||
|
* - Controlled by the owner/source of the DOMMediaStream.
|
||
|
* It's a stream of the type indicated by
|
||
|
* - DOMMediaStream::CreateSourceStream/CreateTrackUnionStream. A source
|
||
|
* typically creates its DOMMediaStream, creates the MediaStreamTracks
|
||
|
* owned by said stream, then gets the internal input stream to which it
|
||
|
* feeds data for the previously created tracks.
|
||
|
* - When necessary it can create tracks on the internal stream only and
|
||
|
* their corresponding MediaStreamTracks will be asynchronously created.
|
||
|
* 2. mOwnedStream
|
||
|
* - A TrackUnionStream containing tracks owned by this stream.
|
||
|
* - The internal model of a MediaStreamTrack consists of its owning
|
||
|
* DOMMediaStream and the TrackID of the corresponding internal track in
|
||
|
* the owning DOMMediaStream's mOwnedStream.
|
||
|
* - The owned stream is different from the input stream since a cloned
|
||
|
* DOMMediaStream is also the owner of its (cloned) MediaStreamTracks.
|
||
|
* - Stopping an original track shall not stop its clone. This is
|
||
|
* solved by stopping it at the owned stream, while the clone's owned
|
||
|
* stream gets data directly from the original input stream.
|
||
|
* - A DOMMediaStream (original or clone) gets all tracks dynamically
|
||
|
* added by the source automatically forwarded by having a TRACK_ANY
|
||
|
* MediaInputPort set up from the owning DOMMediaStream's input stream
|
||
|
* to this DOMMediaStream's owned stream.
|
||
|
* 3. mPlaybackStream
|
||
|
* - A TrackUnionStream containing the tracks corresponding to the
|
||
|
* MediaStreamTracks currently in this DOMMediaStream (per getTracks()).
|
||
|
* - Similarly as for mOwnedStream, there's a TRACK_ANY MediaInputPort set
|
||
|
* up from the owned stream to the playback stream to allow tracks
|
||
|
* dynamically added by the source to be automatically forwarded to any
|
||
|
* audio or video sinks.
|
||
|
* - MediaStreamTracks added by addTrack() are set up with a MediaInputPort
|
||
|
* locked to their internal TrackID, from their owning DOMMediaStream's
|
||
|
* owned stream to this playback stream.
|
||
|
*
|
||
|
*
|
||
|
* A graphical representation of how tracks are connected in various cases as
|
||
|
* follows:
|
||
|
*
|
||
|
* addTrack()ed case:
|
||
|
* DOMStream A
|
||
|
* Input Owned Playback
|
||
|
* t1 ---------> t1 ------------> t1 <- MediaStreamTrack X
|
||
|
* (pointing to t1 in A)
|
||
|
* --------> t2 <- MediaStreamTrack Y
|
||
|
* / (pointing to t1 in B)
|
||
|
* DOMStream B /
|
||
|
* Input Owned / Playback
|
||
|
* t1 ---------> t1 ------------> t1 <- MediaStreamTrack Y
|
||
|
* (pointing to t1 in B)
|
||
|
*
|
||
|
* removeTrack()ed case:
|
||
|
* DOMStream A
|
||
|
* Input Owned Playback
|
||
|
* t1 ---------> t1 <- No tracks
|
||
|
*
|
||
|
*
|
||
|
* clone()d case:
|
||
|
* DOMStream A
|
||
|
* Input Owned Playback
|
||
|
* t1 ---------> t1 ------------> t1 <- MediaStreamTrack X
|
||
|
* \ (pointing to t1 in A)
|
||
|
* -----
|
||
|
* DOMStream B \
|
||
|
* Input \ Owned Playback
|
||
|
* -> t1 ------------> t1 <- MediaStreamTrack Y
|
||
|
* (pointing to t1 in B)
|
||
|
*
|
||
|
*
|
||
|
* addTrack()ed, removeTrack()ed and clone()d case:
|
||
|
*
|
||
|
* Here we have done the following:
|
||
|
* var A = someStreamWithTwoTracks;
|
||
|
* var B = someStreamWithOneTrack;
|
||
|
* var X = A.getTracks()[0];
|
||
|
* var Y = A.getTracks()[1];
|
||
|
* var Z = B.getTracks()[0];
|
||
|
* A.addTrack(Z);
|
||
|
* A.removeTrack(X);
|
||
|
* B.removeTrack(Z);
|
||
|
* var A' = A.clone();
|
||
|
*
|
||
|
* DOMStream A
|
||
|
* Input Owned Playback
|
||
|
* t1 ---------> t1 <- MediaStreamTrack X (removed)
|
||
|
* (pointing to t1 in A)
|
||
|
* t2 ---------> t2 ------------> t2 <- MediaStreamTrack Y
|
||
|
* \ (pointing to t2 in A)
|
||
|
* \ ------> t3 <- MediaStreamTrack Z
|
||
|
* \ / (pointing to t1 in B)
|
||
|
* DOMStream B \ /
|
||
|
* Input \ Owned / Playback
|
||
|
* t1 ---^-----> t1 --- <- MediaStreamTrack Z (removed)
|
||
|
* \ \ (pointing to t1 in B)
|
||
|
* \ \
|
||
|
* DOMStream A' \ \
|
||
|
* Input \ \ Owned Playback
|
||
|
* \ -> t1 ------------> t1 <- MediaStreamTrack Y'
|
||
|
* \ (pointing to t1 in A')
|
||
|
* ----> t2 ------------> t2 <- MediaStreamTrack Z'
|
||
|
* (pointing to t2 in A')
|
||
|
*/
|
||
|
class DOMMediaStream : public DOMEventTargetHelper
|
||
|
{
|
||
|
friend class DOMLocalMediaStream;
|
||
|
typedef dom::MediaStreamTrack MediaStreamTrack;
|
||
|
typedef dom::AudioStreamTrack AudioStreamTrack;
|
||
|
typedef dom::VideoStreamTrack VideoStreamTrack;
|
||
|
typedef dom::AudioTrack AudioTrack;
|
||
|
typedef dom::VideoTrack VideoTrack;
|
||
|
typedef dom::AudioTrackList AudioTrackList;
|
||
|
typedef dom::VideoTrackList VideoTrackList;
|
||
|
|
||
|
public:
|
||
|
typedef dom::MediaTrackConstraints MediaTrackConstraints;
|
||
|
|
||
|
class TrackListener {
|
||
|
NS_INLINE_DECL_REFCOUNTING(TrackListener)
|
||
|
|
||
|
public:
|
||
|
/**
|
||
|
* Called when the DOMMediaStream has a new track added, either by
|
||
|
* JS (addTrack()) or the source creating one.
|
||
|
*/
|
||
|
virtual void
|
||
|
NotifyTrackAdded(const RefPtr<MediaStreamTrack>& aTrack) {};
|
||
|
|
||
|
/**
|
||
|
* Called when the DOMMediaStream removes a track, either by
|
||
|
* JS (removeTrack()) or the source ending it.
|
||
|
*/
|
||
|
virtual void
|
||
|
NotifyTrackRemoved(const RefPtr<MediaStreamTrack>& aTrack) {};
|
||
|
|
||
|
protected:
|
||
|
virtual ~TrackListener() {}
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* TrackPort is a representation of a MediaStreamTrack-MediaInputPort pair
|
||
|
* that make up a link between the Owned stream and the Playback stream.
|
||
|
*
|
||
|
* Semantically, the track is the identifier/key and the port the value of this
|
||
|
* connection.
|
||
|
*
|
||
|
* The input port can be shared between several TrackPorts. This is the case
|
||
|
* for DOMMediaStream's mPlaybackPort which forwards all tracks in its
|
||
|
* mOwnedStream automatically.
|
||
|
*
|
||
|
* If the MediaStreamTrack is owned by another DOMMediaStream (called A) than
|
||
|
* the one owning the TrackPort (called B), the input port (locked to the
|
||
|
* MediaStreamTrack's TrackID) connects A's mOwnedStream to B's mPlaybackStream.
|
||
|
*
|
||
|
* A TrackPort may never leave the DOMMediaStream it was created in. Internal
|
||
|
* use only.
|
||
|
*/
|
||
|
class TrackPort
|
||
|
{
|
||
|
public:
|
||
|
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(TrackPort)
|
||
|
NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(TrackPort)
|
||
|
|
||
|
/**
|
||
|
* Indicates MediaInputPort ownership to the TrackPort.
|
||
|
*
|
||
|
* OWNED - Owned by the TrackPort itself. TrackPort must destroy the
|
||
|
* input port when it's destructed.
|
||
|
* EXTERNAL - Owned by another entity. It's the caller's responsibility to
|
||
|
* ensure the the MediaInputPort outlives the TrackPort.
|
||
|
*/
|
||
|
enum class InputPortOwnership {
|
||
|
OWNED = 1,
|
||
|
EXTERNAL
|
||
|
};
|
||
|
|
||
|
TrackPort(MediaInputPort* aInputPort,
|
||
|
MediaStreamTrack* aTrack,
|
||
|
const InputPortOwnership aOwnership);
|
||
|
|
||
|
protected:
|
||
|
virtual ~TrackPort();
|
||
|
|
||
|
public:
|
||
|
void DestroyInputPort();
|
||
|
|
||
|
/**
|
||
|
* Returns the source stream of the input port.
|
||
|
*/
|
||
|
MediaStream* GetSource() const;
|
||
|
|
||
|
/**
|
||
|
* Returns the track ID this track is locked to in the source stream of the
|
||
|
* input port.
|
||
|
*/
|
||
|
TrackID GetSourceTrackId() const;
|
||
|
|
||
|
MediaInputPort* GetInputPort() const { return mInputPort; }
|
||
|
MediaStreamTrack* GetTrack() const { return mTrack; }
|
||
|
|
||
|
/**
|
||
|
* Blocks aTrackId from going into mInputPort unless the port has been
|
||
|
* destroyed.
|
||
|
*/
|
||
|
void BlockTrackId(TrackID aTrackId);
|
||
|
|
||
|
private:
|
||
|
RefPtr<MediaInputPort> mInputPort;
|
||
|
RefPtr<MediaStreamTrack> mTrack;
|
||
|
|
||
|
// Defines if we've been given ownership of the input port or if it's owned
|
||
|
// externally. The owner is responsible for destroying the port.
|
||
|
const InputPortOwnership mOwnership;
|
||
|
};
|
||
|
|
||
|
DOMMediaStream();
|
||
|
|
||
|
NS_DECL_ISUPPORTS_INHERITED
|
||
|
NS_REALLY_FORWARD_NSIDOMEVENTTARGET(DOMEventTargetHelper)
|
||
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DOMMediaStream,
|
||
|
DOMEventTargetHelper)
|
||
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_DOMMEDIASTREAM_IID)
|
||
|
|
||
|
nsIDOMWindow* GetParentObject() const
|
||
|
{
|
||
|
return mWindow;
|
||
|
}
|
||
|
virtual JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
|
||
|
|
||
|
// WebIDL
|
||
|
|
||
|
static already_AddRefed<DOMMediaStream>
|
||
|
Constructor(const dom::GlobalObject& aGlobal,
|
||
|
ErrorResult& aRv);
|
||
|
|
||
|
static already_AddRefed<DOMMediaStream>
|
||
|
Constructor(const dom::GlobalObject& aGlobal,
|
||
|
const DOMMediaStream& aStream,
|
||
|
ErrorResult& aRv);
|
||
|
|
||
|
static already_AddRefed<DOMMediaStream>
|
||
|
Constructor(const dom::GlobalObject& aGlobal,
|
||
|
const dom::Sequence<OwningNonNull<MediaStreamTrack>>& aTracks,
|
||
|
ErrorResult& aRv);
|
||
|
|
||
|
double CurrentTime();
|
||
|
|
||
|
void GetId(nsAString& aID) const;
|
||
|
|
||
|
void GetAudioTracks(nsTArray<RefPtr<AudioStreamTrack> >& aTracks) const;
|
||
|
void GetVideoTracks(nsTArray<RefPtr<VideoStreamTrack> >& aTracks) const;
|
||
|
void GetTracks(nsTArray<RefPtr<MediaStreamTrack> >& aTracks) const;
|
||
|
void AddTrack(MediaStreamTrack& aTrack);
|
||
|
void RemoveTrack(MediaStreamTrack& aTrack);
|
||
|
|
||
|
// NON-WebIDL
|
||
|
|
||
|
/**
|
||
|
* Returns true if this DOMMediaStream has aTrack in its mPlaybackStream.
|
||
|
*/
|
||
|
bool HasTrack(const MediaStreamTrack& aTrack) const;
|
||
|
|
||
|
/**
|
||
|
* Returns true if this DOMMediaStream owns aTrack.
|
||
|
*/
|
||
|
bool OwnsTrack(const MediaStreamTrack& aTrack) const;
|
||
|
|
||
|
/**
|
||
|
* Returns the corresponding MediaStreamTrack if it's in our mOwnedStream.
|
||
|
*/
|
||
|
MediaStreamTrack* FindOwnedDOMTrack(MediaStream* aOwningStream, TrackID aTrackID) const;
|
||
|
|
||
|
/**
|
||
|
* Returns the corresponding MediaStreamTrack if it's in our mPlaybackStream.
|
||
|
*/
|
||
|
MediaStreamTrack* FindPlaybackDOMTrack(MediaStream* aOwningStream, TrackID aTrackID) const;
|
||
|
|
||
|
/**
|
||
|
* Returns the TrackPort connecting mOwnedStream to mPlaybackStream for aTrack.
|
||
|
*/
|
||
|
TrackPort* FindPlaybackTrackPort(const MediaStreamTrack& aTrack) const;
|
||
|
|
||
|
MediaStream* GetInputStream() const { return mInputStream; }
|
||
|
ProcessedMediaStream* GetOwnedStream() const { return mOwnedStream; }
|
||
|
ProcessedMediaStream* GetPlaybackStream() const { return mPlaybackStream; }
|
||
|
|
||
|
/**
|
||
|
* Allows a video element to identify this stream as a camera stream, which
|
||
|
* needs special treatment.
|
||
|
*/
|
||
|
virtual MediaStream* GetCameraStream() const { return nullptr; }
|
||
|
|
||
|
/**
|
||
|
* Overridden in DOMLocalMediaStreams to allow getUserMedia to pass
|
||
|
* data directly to RTCPeerConnection without going through graph queuing.
|
||
|
* Returns a bool to let us know if direct data will be delivered.
|
||
|
*/
|
||
|
virtual bool AddDirectListener(MediaStreamDirectListener *aListener) { return false; }
|
||
|
virtual void RemoveDirectListener(MediaStreamDirectListener *aListener) {}
|
||
|
|
||
|
/**
|
||
|
* Overridden in DOMLocalMediaStreams to allow getUserMedia to disable
|
||
|
* media at the SourceMediaStream.
|
||
|
*/
|
||
|
virtual void SetTrackEnabled(TrackID aTrackID, bool aEnabled);
|
||
|
|
||
|
virtual void StopTrack(TrackID aTrackID);
|
||
|
|
||
|
virtual already_AddRefed<dom::Promise>
|
||
|
ApplyConstraintsToTrack(TrackID aTrackID,
|
||
|
const MediaTrackConstraints& aConstraints,
|
||
|
ErrorResult &aRv);
|
||
|
|
||
|
virtual DOMLocalMediaStream* AsDOMLocalMediaStream() { return nullptr; }
|
||
|
virtual DOMHwMediaStream* AsDOMHwMediaStream() { return nullptr; }
|
||
|
|
||
|
bool IsFinished();
|
||
|
/**
|
||
|
* Returns a principal indicating who may access this stream. The stream contents
|
||
|
* can only be accessed by principals subsuming this principal.
|
||
|
*/
|
||
|
nsIPrincipal* GetPrincipal() { return mPrincipal; }
|
||
|
mozilla::CORSMode GetCORSMode();
|
||
|
void SetCORSMode(mozilla::CORSMode aCORSMode);
|
||
|
|
||
|
/**
|
||
|
* These are used in WebRTC. A peerIdentity constrained MediaStream cannot be sent
|
||
|
* across the network to anything other than a peer with the provided identity.
|
||
|
* If this is set, then mPrincipal should be an instance of nsNullPrincipal.
|
||
|
*/
|
||
|
PeerIdentity* GetPeerIdentity() const { return mPeerIdentity; }
|
||
|
void SetPeerIdentity(PeerIdentity* aPeerIdentity)
|
||
|
{
|
||
|
mPeerIdentity = aPeerIdentity;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Indicate that data will be contributed to this stream from origin aPrincipal.
|
||
|
* If aPrincipal is null, this is ignored. Otherwise, from now on the contents
|
||
|
* of this stream can only be accessed by principals that subsume aPrincipal.
|
||
|
* Returns true if the stream's principal changed.
|
||
|
*/
|
||
|
bool CombineWithPrincipal(nsIPrincipal* aPrincipal);
|
||
|
|
||
|
/**
|
||
|
* This is used in WebRTC to move from a protected state (nsNullPrincipal) to
|
||
|
* one where the stream is accessible to script. Don't call this.
|
||
|
* CombineWithPrincipal is almost certainly more appropriate.
|
||
|
*/
|
||
|
void SetPrincipal(nsIPrincipal* aPrincipal);
|
||
|
|
||
|
/**
|
||
|
* Used to learn about dynamic changes in principal occur.
|
||
|
* Operations relating to these observers must be confined to the main thread.
|
||
|
*/
|
||
|
class PrincipalChangeObserver
|
||
|
{
|
||
|
public:
|
||
|
virtual void PrincipalChanged(DOMMediaStream* aMediaStream) = 0;
|
||
|
};
|
||
|
bool AddPrincipalChangeObserver(PrincipalChangeObserver* aObserver);
|
||
|
bool RemovePrincipalChangeObserver(PrincipalChangeObserver* aObserver);
|
||
|
|
||
|
/**
|
||
|
* Called when this stream's MediaStreamGraph has been shut down. Normally
|
||
|
* MSGs are only shut down when all streams have been removed, so this
|
||
|
* will only be called during a forced shutdown due to application exit.
|
||
|
*/
|
||
|
void NotifyMediaStreamGraphShutdown();
|
||
|
/**
|
||
|
* Called when the main-thread state of the MediaStream goes to finished.
|
||
|
*/
|
||
|
void NotifyStreamFinished();
|
||
|
|
||
|
// Webrtc allows the remote side to name a stream whatever it wants, and we
|
||
|
// need to surface this to content.
|
||
|
void AssignId(const nsAString& aID) { mID = aID; }
|
||
|
|
||
|
/**
|
||
|
* Create a DOMMediaStream whose underlying input stream is a SourceMediaStream.
|
||
|
*/
|
||
|
static already_AddRefed<DOMMediaStream> CreateSourceStream(nsIDOMWindow* aWindow,
|
||
|
MediaStreamGraph* aGraph);
|
||
|
|
||
|
/**
|
||
|
* Create a DOMMediaStream whose underlying input stream is a TrackUnionStream.
|
||
|
*/
|
||
|
static already_AddRefed<DOMMediaStream> CreateTrackUnionStream(nsIDOMWindow* aWindow,
|
||
|
MediaStreamGraph* aGraph);
|
||
|
|
||
|
/**
|
||
|
* Create an DOMMediaStream whose underlying input stream is an
|
||
|
* AudioCaptureStream.
|
||
|
*/
|
||
|
static already_AddRefed<DOMMediaStream> CreateAudioCaptureStream(
|
||
|
nsIDOMWindow* aWindow, MediaStreamGraph* aGraph);
|
||
|
|
||
|
void SetLogicalStreamStartTime(StreamTime aTime)
|
||
|
{
|
||
|
mLogicalStreamStartTime = aTime;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Called for each track in our owned stream to indicate to JS that we
|
||
|
* are carrying that track.
|
||
|
*
|
||
|
* Creates a MediaStreamTrack, adds it to mTracks and returns it.
|
||
|
*/
|
||
|
MediaStreamTrack* CreateOwnDOMTrack(TrackID aTrackID, MediaSegment::Type aType);
|
||
|
|
||
|
class OnTracksAvailableCallback {
|
||
|
public:
|
||
|
virtual ~OnTracksAvailableCallback() {}
|
||
|
virtual void NotifyTracksAvailable(DOMMediaStream* aStream) = 0;
|
||
|
};
|
||
|
// When the initial set of tracks has been added, run
|
||
|
// aCallback->NotifyTracksAvailable.
|
||
|
// It is allowed to do anything, including run script.
|
||
|
// aCallback may run immediately during this call if tracks are already
|
||
|
// available!
|
||
|
// We only care about track additions, we'll fire the notification even if
|
||
|
// some of the tracks have been removed.
|
||
|
// Takes ownership of aCallback.
|
||
|
void OnTracksAvailable(OnTracksAvailableCallback* aCallback);
|
||
|
|
||
|
/**
|
||
|
* Add an nsISupports object that this stream will keep alive as long as
|
||
|
* the stream is not finished.
|
||
|
*/
|
||
|
void AddConsumerToKeepAlive(nsISupports* aConsumer)
|
||
|
{
|
||
|
if (!IsFinished() && !mNotifiedOfMediaStreamGraphShutdown) {
|
||
|
mConsumersToKeepAlive.AppendElement(aConsumer);
|
||
|
}
|
||
|
}
|
||
|
|
||
|
void RegisterTrackListener(TrackListener* aListener);
|
||
|
void UnregisterTrackListener(TrackListener* aListener);
|
||
|
|
||
|
protected:
|
||
|
virtual ~DOMMediaStream();
|
||
|
|
||
|
void Destroy();
|
||
|
void InitSourceStream(nsIDOMWindow* aWindow, MediaStreamGraph* aGraph);
|
||
|
void InitTrackUnionStream(nsIDOMWindow* aWindow, MediaStreamGraph* aGraph);
|
||
|
void InitAudioCaptureStream(nsIDOMWindow* aWindow, MediaStreamGraph* aGraph);
|
||
|
|
||
|
// Sets up aStream as mInputStream. A producer may append data to a
|
||
|
// SourceMediaStream input stream, or connect another stream to a
|
||
|
// TrackUnionStream input stream.
|
||
|
void InitInputStreamCommon(MediaStream* aStream, MediaStreamGraph* aGraph);
|
||
|
|
||
|
// Sets up a new TrackUnionStream as mOwnedStream and connects it to
|
||
|
// mInputStream with a TRACK_ANY MediaInputPort if available.
|
||
|
// If this DOMMediaStream should have an input stream (producing data),
|
||
|
// it has to be initiated before the owned stream.
|
||
|
void InitOwnedStreamCommon(MediaStreamGraph* aGraph);
|
||
|
|
||
|
// Sets up a new TrackUnionStream as mPlaybackStream and connects it to
|
||
|
// mOwnedStream with a TRACK_ANY MediaInputPort if available.
|
||
|
// If this DOMMediaStream should have an owned stream (producer or clone),
|
||
|
// it has to be initiated before the playback stream.
|
||
|
void InitPlaybackStreamCommon(MediaStreamGraph* aGraph);
|
||
|
|
||
|
void CheckTracksAvailable();
|
||
|
|
||
|
// Called when MediaStreamGraph has finished an iteration where tracks were
|
||
|
// created.
|
||
|
void NotifyTracksCreated();
|
||
|
|
||
|
// Dispatches NotifyTrackAdded() to all registered track listeners.
|
||
|
void NotifyTrackAdded(const RefPtr<MediaStreamTrack>& aTrack);
|
||
|
|
||
|
// Dispatches NotifyTrackRemoved() to all registered track listeners.
|
||
|
void NotifyTrackRemoved(const RefPtr<MediaStreamTrack>& aTrack);
|
||
|
|
||
|
class OwnedStreamListener;
|
||
|
friend class OwnedStreamListener;
|
||
|
|
||
|
class PlaybackStreamListener;
|
||
|
friend class PlaybackStreamListener;
|
||
|
|
||
|
// XXX Bug 1124630. Remove with CameraPreviewMediaStream.
|
||
|
void CreateAndAddPlaybackStreamListener(MediaStream*);
|
||
|
|
||
|
// StreamTime at which the currentTime attribute would return 0.
|
||
|
StreamTime mLogicalStreamStartTime;
|
||
|
|
||
|
// We need this to track our parent object.
|
||
|
nsCOMPtr<nsIDOMWindow> mWindow;
|
||
|
|
||
|
// MediaStreams are owned by the graph, but we tell them when to die,
|
||
|
// and they won't die until we let them.
|
||
|
|
||
|
// This stream contains tracks used as input by us. Cloning happens from this
|
||
|
// stream. Tracks may exist in these stream but not in |mOwnedStream| if they
|
||
|
// have been stopped.
|
||
|
MediaStream* mInputStream;
|
||
|
|
||
|
// This stream contains tracks owned by us (if we were created directly from
|
||
|
// source, or cloned from some other stream). Tracks map to |mOwnedTracks|.
|
||
|
ProcessedMediaStream* mOwnedStream;
|
||
|
|
||
|
// This stream contains tracks currently played by us, despite of owner.
|
||
|
// Tracks map to |mTracks|.
|
||
|
ProcessedMediaStream* mPlaybackStream;
|
||
|
|
||
|
// This port connects mInputStream to mOwnedStream. All tracks forwarded.
|
||
|
RefPtr<MediaInputPort> mOwnedPort;
|
||
|
|
||
|
// This port connects mOwnedStream to mPlaybackStream. All tracks not
|
||
|
// explicitly blocked due to removal are forwarded.
|
||
|
RefPtr<MediaInputPort> mPlaybackPort;
|
||
|
|
||
|
// MediaStreamTracks corresponding to tracks in our mOwnedStream.
|
||
|
nsAutoTArray<RefPtr<TrackPort>, 2> mOwnedTracks;
|
||
|
|
||
|
// MediaStreamTracks corresponding to tracks in our mPlaybackStream.
|
||
|
nsAutoTArray<RefPtr<TrackPort>, 2> mTracks;
|
||
|
|
||
|
RefPtr<OwnedStreamListener> mOwnedListener;
|
||
|
RefPtr<PlaybackStreamListener> mPlaybackListener;
|
||
|
|
||
|
nsTArray<nsAutoPtr<OnTracksAvailableCallback> > mRunOnTracksAvailable;
|
||
|
|
||
|
// Set to true after MediaStreamGraph has created tracks for mPlaybackStream.
|
||
|
bool mTracksCreated;
|
||
|
|
||
|
nsString mID;
|
||
|
|
||
|
// Keep these alive until the stream finishes
|
||
|
nsTArray<nsCOMPtr<nsISupports> > mConsumersToKeepAlive;
|
||
|
|
||
|
bool mNotifiedOfMediaStreamGraphShutdown;
|
||
|
|
||
|
// The track listeners subscribe to changes in this stream's track set.
|
||
|
nsTArray<RefPtr<TrackListener>> mTrackListeners;
|
||
|
|
||
|
private:
|
||
|
void NotifyPrincipalChanged();
|
||
|
|
||
|
// Principal identifying who may access the contents of this stream.
|
||
|
// If null, this stream can be used by anyone because it has no content yet.
|
||
|
nsCOMPtr<nsIPrincipal> mPrincipal;
|
||
|
nsTArray<PrincipalChangeObserver*> mPrincipalChangeObservers;
|
||
|
// this is used in gUM and WebRTC to identify peers that this stream
|
||
|
// is allowed to be sent to
|
||
|
nsAutoPtr<PeerIdentity> mPeerIdentity;
|
||
|
CORSMode mCORSMode;
|
||
|
};
|
||
|
|
||
|
NS_DEFINE_STATIC_IID_ACCESSOR(DOMMediaStream,
|
||
|
NS_DOMMEDIASTREAM_IID)
|
||
|
|
||
|
#define NS_DOMLOCALMEDIASTREAM_IID \
|
||
|
{ 0xb1437260, 0xec61, 0x4dfa, \
|
||
|
{ 0x92, 0x54, 0x04, 0x44, 0xe2, 0xb5, 0x94, 0x9c } }
|
||
|
|
||
|
class DOMLocalMediaStream : public DOMMediaStream
|
||
|
{
|
||
|
public:
|
||
|
DOMLocalMediaStream() {}
|
||
|
|
||
|
NS_DECL_ISUPPORTS_INHERITED
|
||
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_DOMLOCALMEDIASTREAM_IID)
|
||
|
|
||
|
virtual JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
|
||
|
|
||
|
void Stop();
|
||
|
|
||
|
virtual MediaEngineSource* GetMediaEngine(TrackID aTrackID) { return nullptr; }
|
||
|
|
||
|
/**
|
||
|
* Create an nsDOMLocalMediaStream whose underlying stream is a SourceMediaStream.
|
||
|
*/
|
||
|
static already_AddRefed<DOMLocalMediaStream>
|
||
|
CreateSourceStream(nsIDOMWindow* aWindow,
|
||
|
MediaStreamGraph* aGraph);
|
||
|
|
||
|
/**
|
||
|
* Create an nsDOMLocalMediaStream whose underlying stream is a TrackUnionStream.
|
||
|
*/
|
||
|
static already_AddRefed<DOMLocalMediaStream>
|
||
|
CreateTrackUnionStream(nsIDOMWindow* aWindow,
|
||
|
MediaStreamGraph* aGraph);
|
||
|
|
||
|
/**
|
||
|
* Create an nsDOMLocalMediaStream whose underlying stream is an
|
||
|
* AudioCaptureStream. */
|
||
|
static already_AddRefed<DOMLocalMediaStream> CreateAudioCaptureStream(
|
||
|
nsIDOMWindow* aWindow, MediaStreamGraph* aGraph);
|
||
|
|
||
|
protected:
|
||
|
virtual ~DOMLocalMediaStream();
|
||
|
|
||
|
void StopImpl();
|
||
|
};
|
||
|
|
||
|
NS_DEFINE_STATIC_IID_ACCESSOR(DOMLocalMediaStream,
|
||
|
NS_DOMLOCALMEDIASTREAM_IID)
|
||
|
|
||
|
class DOMAudioNodeMediaStream : public DOMMediaStream
|
||
|
{
|
||
|
typedef dom::AudioNode AudioNode;
|
||
|
public:
|
||
|
explicit DOMAudioNodeMediaStream(AudioNode* aNode);
|
||
|
|
||
|
NS_DECL_ISUPPORTS_INHERITED
|
||
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DOMAudioNodeMediaStream, DOMMediaStream)
|
||
|
|
||
|
/**
|
||
|
* Create a DOMAudioNodeMediaStream whose underlying stream is a TrackUnionStream.
|
||
|
*/
|
||
|
static already_AddRefed<DOMAudioNodeMediaStream>
|
||
|
CreateTrackUnionStream(nsIDOMWindow* aWindow,
|
||
|
AudioNode* aNode,
|
||
|
MediaStreamGraph* aGraph);
|
||
|
|
||
|
protected:
|
||
|
~DOMAudioNodeMediaStream();
|
||
|
|
||
|
private:
|
||
|
// If this object wraps a stream owned by an AudioNode, we need to ensure that
|
||
|
// the node isn't cycle-collected too early.
|
||
|
RefPtr<AudioNode> mStreamNode;
|
||
|
};
|
||
|
|
||
|
class DOMHwMediaStream : public DOMLocalMediaStream
|
||
|
{
|
||
|
typedef mozilla::gfx::IntSize IntSize;
|
||
|
typedef layers::ImageContainer ImageContainer;
|
||
|
#ifdef MOZ_WIDGET_GONK
|
||
|
typedef layers::OverlayImage OverlayImage;
|
||
|
typedef layers::OverlayImage::Data Data;
|
||
|
#endif
|
||
|
|
||
|
public:
|
||
|
DOMHwMediaStream();
|
||
|
|
||
|
static already_AddRefed<DOMHwMediaStream> CreateHwStream(nsIDOMWindow* aWindow);
|
||
|
virtual DOMHwMediaStream* AsDOMHwMediaStream() override { return this; }
|
||
|
int32_t RequestOverlayId();
|
||
|
void SetOverlayId(int32_t aOverlayId);
|
||
|
void SetImageSize(uint32_t width, uint32_t height);
|
||
|
|
||
|
protected:
|
||
|
~DOMHwMediaStream();
|
||
|
|
||
|
private:
|
||
|
void Init(MediaStream* aStream);
|
||
|
|
||
|
#ifdef MOZ_WIDGET_GONK
|
||
|
RefPtr<ImageContainer> mImageContainer;
|
||
|
const int DEFAULT_IMAGE_ID = 0x01;
|
||
|
const int DEFAULT_IMAGE_WIDTH = 400;
|
||
|
const int DEFAULT_IMAGE_HEIGHT = 300;
|
||
|
RefPtr<OverlayImage> mOverlayImage;
|
||
|
Data mImageData;
|
||
|
#endif
|
||
|
};
|
||
|
|
||
|
} // namespace mozilla
|
||
|
|
||
|
#endif /* NSDOMMEDIASTREAM_H_ */
|