Add MediaStream.active attribute

Source/modules/mediastream/MediaStream.cpp

 /*
  * Copyright (C) 2011 Google Inc. All rights reserved.
  * Copyright (C) 2011, 2012 Ericsson AB. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
@@ skipping 99 matching lines @@
         m_audioTracks.append(newTrack);
     }
 
     size_t numberOfVideoTracks = m_descriptor->numberOfVideoComponents();
     m_videoTracks.reserveCapacity(numberOfVideoTracks);
     for (size_t i = 0; i < numberOfVideoTracks; i++) {
         MediaStreamTrack* newTrack = MediaStreamTrack::create(context, m_descriptor->videoComponent(i));
         newTrack->registerMediaStream(this);
         m_videoTracks.append(newTrack);
     }
+
+    if (emptyOrOnlyEndedTracks()) {
+        m_descriptor->setActive(false);
+    }
 }
 
 MediaStream::MediaStream(ExecutionContext* context, const MediaStreamTrackVector& audioTracks, const MediaStreamTrackVector& videoTracks)
     : ContextLifecycleObserver(context)
     , m_stopped(false)
     , m_scheduledEventTimer(this, &MediaStream::scheduledEventTimerFired)
 {
     MediaStreamComponentVector audioComponents;
     MediaStreamComponentVector videoComponents;
 
     MediaStreamTrackVector::const_iterator iter;
     for (iter = audioTracks.begin(); iter != audioTracks.end(); ++iter) {
         (*iter)->registerMediaStream(this);
         audioComponents.append((*iter)->component());
     }
     for (iter = videoTracks.begin(); iter != videoTracks.end(); ++iter) {
         (*iter)->registerMediaStream(this);
         videoComponents.append((*iter)->component());
     }
 
     m_descriptor = MediaStreamDescriptor::create(audioComponents, videoComponents);
     m_descriptor->setClient(this);
     MediaStreamCenter::instance().didCreateMediaStream(m_descriptor.get());
 
     m_audioTracks = audioTracks;
     m_videoTracks = videoTracks;
+    if (emptyOrOnlyEndedTracks()) {
+        m_descriptor->setActive(false);
+    }
 }
 
 MediaStream::~MediaStream()
 {
     m_descriptor->setClient(0);
 }
 
+bool MediaStream::emptyOrOnlyEndedTracks()
+{
+    if (!m_audioTracks.size() && !m_videoTracks.size()) {
+        return true;
+    }
+    for (MediaStreamTrackVector::iterator iter = m_audioTracks.begin(); iter != m_audioTracks.end(); ++iter) {
+        if (!iter->get()->ended())
+            return false;
+    }
+    for (MediaStreamTrackVector::iterator iter = m_videoTracks.begin(); iter != m_videoTracks.end(); ++iter) {
+        if (!iter->get()->ended())
+            return false;
+    }
+    return true;
+}
+
 bool MediaStream::ended() const
 {
     return m_stopped || m_descriptor->ended();
 }
 
 MediaStreamTrackVector MediaStream::getTracks()
 {
     MediaStreamTrackVector tracks;
     for (MediaStreamTrackVector::iterator iter = m_audioTracks.begin(); iter != m_audioTracks.end(); ++iter)
         tracks.append(iter->get());
     for (MediaStreamTrackVector::iterator iter = m_videoTracks.begin(); iter != m_videoTracks.end(); ++iter)
         tracks.append(iter->get());
     return tracks;
 }
 
 void MediaStream::addTrack(MediaStreamTrack* track, ExceptionState& exceptionState)
 {
-    if (ended()) {
-        exceptionState.throwDOMException(InvalidStateError, "The MediaStream is finished.");
-        return;
-    }
-
     if (!track) {
         exceptionState.throwDOMException(TypeMismatchError, "The MediaStreamTrack provided is invalid.");
         return;
     }
 
     if (getTrackById(track->id()))
         return;
 
     switch (track->component()->source()->type()) {
     case MediaStreamSource::TypeAudio:
         m_audioTracks.append(track);
         break;
     case MediaStreamSource::TypeVideo:
         m_videoTracks.append(track);
         break;
     }
     track->registerMediaStream(this);
     m_descriptor->addComponent(track->component());
+
+    if (!active() && !track->ended()) {
+        m_descriptor->setActive(true);
+        scheduleDispatchEvent(Event::create(EventTypeNames::active));
+    }
+
     MediaStreamCenter::instance().didAddMediaStreamTrack(m_descriptor.get(), track->component());
 }
 
 void MediaStream::removeTrack(MediaStreamTrack* track, ExceptionState& exceptionState)
 {
-    if (ended()) {
-        exceptionState.throwDOMException(InvalidStateError, "The MediaStream is finished.");
-        return;
-    }
-
     if (!track) {
         exceptionState.throwDOMException(TypeMismatchError, "The MediaStreamTrack provided is invalid.");
         return;
     }
 
     size_t pos = kNotFound;
     switch (track->component()->source()->type()) {
     case MediaStreamSource::TypeAudio:
         pos = m_audioTracks.find(track);
         if (pos != kNotFound)
             m_audioTracks.remove(pos);
         break;
     case MediaStreamSource::TypeVideo:
         pos = m_videoTracks.find(track);
         if (pos != kNotFound)
             m_videoTracks.remove(pos);
         break;
     }
 
     if (pos == kNotFound)
         return;
     track->unregisterMediaStream(this);
     m_descriptor->removeComponent(track->component());
 
-    if (!m_audioTracks.size() && !m_videoTracks.size())
-        m_descriptor->setEnded();
+    if (active() && emptyOrOnlyEndedTracks()) {
+        m_descriptor->setActive(false);
+        scheduleDispatchEvent(Event::create(EventTypeNames::inactive));
+    }
 
     MediaStreamCenter::instance().didRemoveMediaStreamTrack(m_descriptor.get(), track->component());
 }
 
 MediaStreamTrack* MediaStream::getTrackById(String id)
 {
     for (MediaStreamTrackVector::iterator iter = m_audioTracks.begin(); iter != m_audioTracks.end(); ++iter) {
         if ((*iter)->id() == id)
             return iter->get();
     }
@@ skipping 36 matching lines @@
     for (MediaStreamTrackVector::iterator iter = m_videoTracks.begin(); iter != m_videoTracks.end(); ++iter) {
         if (!(*iter)->ended())
             return;
     }
 
     streamEnded();
 }
 
 void MediaStream::streamEnded()
 {
-    if (ended())
+    if (!active())

[hta - Chromium, 2015/01/14 14:12:02]

Wrong test. Ended streams (as previously defined) could not later become
non-ended. Inactive streams can become active.

Suggest not touching the "active" concept when ending a stream.

         return;
 
+    m_descriptor->setActive(false);
     m_descriptor->setEnded();
+    scheduleDispatchEvent(Event::create(EventTypeNames::inactive));
     scheduleDispatchEvent(Event::create(EventTypeNames::ended));
 }
 
 void MediaStream::contextDestroyed()
 {
     ContextLifecycleObserver::contextDestroyed();
     m_stopped = true;
 }
 
 const AtomicString& MediaStream::interfaceName() const
 {
     return EventTargetNames::MediaStream;
 }
 
 ExecutionContext* MediaStream::executionContext() const
 {
     return ContextLifecycleObserver::executionContext();
 }
 
 void MediaStream::addRemoteTrack(MediaStreamComponent* component)
 {
     ASSERT(component);
-    if (ended())
-        return;

[hta - Chromium, 2015/01/14 14:12:02]

Until we delete the ended code altogether, keep this code.

 
     MediaStreamTrack* track = MediaStreamTrack::create(executionContext(), component);
     switch (component->source()->type()) {
     case MediaStreamSource::TypeAudio:
         m_audioTracks.append(track);
         break;
     case MediaStreamSource::TypeVideo:
         m_videoTracks.append(track);
         break;
     }
     track->registerMediaStream(this);
     m_descriptor->addComponent(component);
 
     scheduleDispatchEvent(MediaStreamTrackEvent::create(EventTypeNames::addtrack, false, false, track));
+
+    if (!active() && !track->ended()) {
+        m_descriptor->setActive(true);
+        scheduleDispatchEvent(Event::create(EventTypeNames::active));
+    }
 }
 
 void MediaStream::removeRemoteTrack(MediaStreamComponent* component)
 {
-    if (m_stopped)
-        return;

[hta - Chromium, 2015/01/14 14:12:02]

m_stopped is not relevant to either active or ended. Please don't touch it
without expert advice (I think it's a DOM thing).

+    ASSERT(component);
 
     MediaStreamTrackVector* tracks = 0;
     switch (component->source()->type()) {
     case MediaStreamSource::TypeAudio:
         tracks = &m_audioTracks;
         break;
     case MediaStreamSource::TypeVideo:
         tracks = &m_videoTracks;
         break;
     }
 
     size_t index = kNotFound;
     for (size_t i = 0; i < tracks->size(); ++i) {
         if ((*tracks)[i]->component() == component) {
             index = i;
             break;
         }
     }
     if (index == kNotFound)
         return;
 
     m_descriptor->removeComponent(component);
 
     MediaStreamTrack* track = (*tracks)[index];
     track->unregisterMediaStream(this);
     tracks->remove(index);
     scheduleDispatchEvent(MediaStreamTrackEvent::create(EventTypeNames::removetrack, false, false, track));
+
+    if (active() && emptyOrOnlyEndedTracks()) {
+        m_descriptor->setActive(false);
+        scheduleDispatchEvent(Event::create(EventTypeNames::inactive));
+    }
 }
 
 void MediaStream::scheduleDispatchEvent(PassRefPtrWillBeRawPtr<Event> event)
 {
     m_scheduledEvents.append(event);
 
     if (!m_scheduledEventTimer.isActive())
         m_scheduledEventTimer.startOneShot(0, FROM_HERE);
 }
 
@@ skipping 19 matching lines @@
 
 void MediaStream::trace(Visitor* visitor)
 {
     visitor->trace(m_audioTracks);
     visitor->trace(m_videoTracks);
     visitor->trace(m_scheduledEvents);
     RefCountedGarbageCollectedEventTargetWithInlineData<MediaStream>::trace(visitor);
 }
 
 } // namespace blink