refactor EnumerateDevices to make it a persistent request.

content/renderer/media/media_stream_dispatcher.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "content/renderer/media/media_stream_dispatcher.h"
 
 #include "base/logging.h"
 #include "content/common/media/media_stream_messages.h"
 #include "content/renderer/media/media_stream_dispatcher_eventhandler.h"
 #include "content/renderer/render_view_impl.h"
@@ skipping 13 matching lines @@
 };
 
 struct MediaStreamDispatcher::Stream {
   Stream() {}
   ~Stream() {}
   base::WeakPtr<MediaStreamDispatcherEventHandler> handler;
   media_stream::StreamDeviceInfoArray audio_array;
   media_stream::StreamDeviceInfoArray video_array;
 };
 
+MediaStreamDispatcher::EnumerationRequest::EnumerationRequest(
+    const base::WeakPtr<MediaStreamDispatcherEventHandler>& handler,
+    int request_id)
+    : handler(handler),
+      request_id(request_id) {
+}
+
+MediaStreamDispatcher::EnumerationRequest::~EnumerationRequest() {}
+
+MediaStreamDispatcher::EnumerationState::EnumerationState()
+    : ipc_id(-1) {
+}
+
+MediaStreamDispatcher::EnumerationState::~EnumerationState() {}
+
+struct MediaStreamDispatcher::EnumerationState::CachedDevices {
+  CachedDevices(const std::string& label,
+                const media_stream::StreamDeviceInfoArray& device_array)
+      : label(label),
+        device_array(device_array) {
+  }
+  ~CachedDevices() {}
+
+  std::string label;
+  media_stream::StreamDeviceInfoArray device_array;

[scherkus (not reviewing), 2012/08/02 22:45:18]

nit: this can be |devices| -- no need to annotate variables names with their
type

[wjia(left Chromium), 2012/08/03 21:53:45]

Done.

+};
+
 MediaStreamDispatcher::MediaStreamDispatcher(RenderViewImpl* render_view)
     : content::RenderViewObserver(render_view),
+      main_loop_(base::MessageLoopProxy::current()),
       next_ipc_id_(0) {
 }
 
 MediaStreamDispatcher::~MediaStreamDispatcher() {}
 
 void MediaStreamDispatcher::GenerateStream(
     int request_id,
     const base::WeakPtr<MediaStreamDispatcherEventHandler>& event_handler,
     media_stream::StreamOptions components,
     const GURL& security_origin) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   DVLOG(1) << "MediaStreamDispatcher::GenerateStream(" << request_id << ")";
 
   requests_.push_back(Request(event_handler, request_id, next_ipc_id_));
   Send(new MediaStreamHostMsg_GenerateStream(routing_id(),
                                              next_ipc_id_++,
                                              components,
                                              security_origin));
 }
 
 void MediaStreamDispatcher::CancelGenerateStream(int request_id) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   DVLOG(1) << "MediaStreamDispatcher::CancelGenerateStream"
            << ", {request_id = " << request_id << "}";
 
   RequestList::iterator it = requests_.begin();
   for (; it != requests_.end(); ++it) {
     Request& request = *it;
     if (request.request_id == request_id) {
       requests_.erase(it);
       Send(new MediaStreamHostMsg_CancelGenerateStream(routing_id(),
                                                        request_id));
       break;
     }
   }
 }
 
 void MediaStreamDispatcher::StopStream(const std::string& label) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   DVLOG(1) << "MediaStreamDispatcher::StopStream"
            << ", {label = " << label << "}";
 
   LabelStreamMap::iterator it = label_stream_map_.find(label);
   if (it == label_stream_map_.end())
     return;
 
   Send(new MediaStreamHostMsg_StopGeneratedStream(routing_id(), label));
   label_stream_map_.erase(it);
 }
 
 void MediaStreamDispatcher::EnumerateDevices(
     int request_id,
     const base::WeakPtr<MediaStreamDispatcherEventHandler>& event_handler,
     media_stream::MediaStreamType type,
     const GURL& security_origin) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
+  DCHECK(type == content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE ||
+         type == content::MEDIA_STREAM_DEVICE_TYPE_VIDEO_CAPTURE);
   DVLOG(1) << "MediaStreamDispatcher::EnumerateDevices("
            << request_id << ")";
 
-  requests_.push_back(Request(event_handler, request_id, next_ipc_id_));
-  Send(new MediaStreamHostMsg_EnumerateDevices(routing_id(),
-                                               next_ipc_id_++,
-                                               type,
-                                               security_origin));
+  EnumerationState* state =
+      (type == content::MEDIA_STREAM_DEVICE_TYPE_AUDIO_CAPTURE ?
+       &audio_enumeration_state_ : &video_enumeration_state_);
+  state->requests.push_back(
+      EnumerationRequest(event_handler, request_id));
+
+  if (state->cached_devices.get()) {
+    event_handler->OnDevicesEnumerated(
+        request_id, state->cached_devices->device_array);
+  } else if (state->ipc_id < 0) {
+    Send(new MediaStreamHostMsg_EnumerateDevices(routing_id(),
+                                                 next_ipc_id_,
+                                                 type,
+                                                 security_origin));
+    state->ipc_id = next_ipc_id_++;
+  }
+}
+
+void MediaStreamDispatcher::StopEnumerateDevices(
+    int request_id,
+    const base::WeakPtr<MediaStreamDispatcherEventHandler>& event_handler) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
+  DVLOG(1) << "MediaStreamDispatcher::StopEnumerateDevices("
+           << request_id << ")";
+
+  // Remove the request.
+  RemoveEnumerationRequest(
+      request_id, event_handler, &audio_enumeration_state_);
+  RemoveEnumerationRequest(
+      request_id, event_handler, &video_enumeration_state_);
+}
+
+bool MediaStreamDispatcher::RemoveEnumerationRequest(

[scherkus (not reviewing), 2012/08/02 22:45:18]

RER() no longer needs to return a bool

[wjia(left Chromium), 2012/08/03 21:53:45]

Done.

+    int request_id,
+    const base::WeakPtr<MediaStreamDispatcherEventHandler>& event_handler,
+    EnumerationState* state) {
+  EnumerationRequestList* requests = &state->requests;
+  for (EnumerationRequestList::iterator it = requests->begin();
+       it != requests->end(); ++it) {
+    if (it->request_id == request_id && it->handler == event_handler) {
+      requests->erase(it);
+      if (requests->empty() && !state->cached_devices.get()) {
+        // No more request and has a label, try to stop the label
+        // and invalidate the state.
+        Send(new MediaStreamHostMsg_StopGeneratedStream(
+            routing_id(), state->cached_devices->label));
+        state->ipc_id = -1;
+        state->cached_devices.reset();
+      }
+      return true;
+    }
+  }
+  return false;
 }
 
 void MediaStreamDispatcher::OpenDevice(
     int request_id,
     const base::WeakPtr<MediaStreamDispatcherEventHandler>& event_handler,
     const std::string& device_id,
     media_stream::MediaStreamType type,
     const GURL& security_origin) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   DVLOG(1) << "MediaStreamDispatcher::OpenDevice(" << request_id << ")";
 
   requests_.push_back(Request(event_handler, request_id, next_ipc_id_));
   Send(new MediaStreamHostMsg_OpenDevice(routing_id(),
                                          next_ipc_id_++,
                                          device_id,
                                          type,
                                          security_origin));
 }
 
 void MediaStreamDispatcher::CloseDevice(const std::string& label) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   DVLOG(1) << "MediaStreamDispatcher::CloseDevice"
            << ", {label = " << label << "}";
 
   StopStream(label);
 }
 
 bool MediaStreamDispatcher::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   IPC_BEGIN_MESSAGE_MAP(MediaStreamDispatcher, message)
     IPC_MESSAGE_HANDLER(MediaStreamMsg_StreamGenerated,
@@ skipping 15 matching lines @@
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
   return handled;
 }
 
 void MediaStreamDispatcher::OnStreamGenerated(
     int request_id,
     const std::string& label,
     const media_stream::StreamDeviceInfoArray& audio_array,
     const media_stream::StreamDeviceInfoArray& video_array) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
 
   for (RequestList::iterator it = requests_.begin();
        it != requests_.end(); ++it) {
     Request& request = *it;
     if (request.ipc_request == request_id) {
       Stream new_stream;
       new_stream.handler = request.handler;
       new_stream.audio_array = audio_array;
       new_stream.video_array = video_array;
       label_stream_map_[label] = new_stream;
       if (request.handler) {
         request.handler->OnStreamGenerated(request.request_id, label,
                                            audio_array, video_array);
         DVLOG(1) << "MediaStreamDispatcher::OnStreamGenerated("
                  << request.request_id << ", " << label << ")";
       }
       requests_.erase(it);
       break;
     }
   }
 }
 
 void MediaStreamDispatcher::OnStreamGenerationFailed(int request_id) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   for (RequestList::iterator it = requests_.begin();
        it != requests_.end(); ++it) {
     Request& request = *it;
     if (request.ipc_request == request_id) {
       if (request.handler) {
         request.handler->OnStreamGenerationFailed(request.request_id);
         DVLOG(1) << "MediaStreamDispatcher::OnStreamGenerationFailed("
                  << request.request_id << ")\n";
       }
       requests_.erase(it);
       break;
     }
   }
 }
 
 void MediaStreamDispatcher::OnVideoDeviceFailed(const std::string& label,
                                                 int index) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   LabelStreamMap::iterator it = label_stream_map_.find(label);
   if (it == label_stream_map_.end())
     return;
 
   // index is the index in the video_array that has failed.
   DCHECK_GT(it->second.video_array.size(), static_cast<size_t>(index));
   media_stream::StreamDeviceInfoArray::iterator device_it =
       it->second.video_array.begin();
   it->second.video_array.erase(device_it + index);
   if (it->second.handler)
     it->second.handler->OnVideoDeviceFailed(label, index);
 }
 
 void MediaStreamDispatcher::OnAudioDeviceFailed(const std::string& label,
                                                 int index) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   LabelStreamMap::iterator it = label_stream_map_.find(label);
   if (it == label_stream_map_.end())
     return;
 
   // index is the index in the audio_array that has failed.
   DCHECK_GT(it->second.audio_array.size(), static_cast<size_t>(index));
   media_stream::StreamDeviceInfoArray::iterator device_it =
       it->second.audio_array.begin();
   it->second.audio_array.erase(device_it + index);
   if (it->second.handler)
     it->second.handler->OnAudioDeviceFailed(label, index);
 }
 
 void MediaStreamDispatcher::OnDevicesEnumerated(
     int request_id,
+    const std::string& label,
     const media_stream::StreamDeviceInfoArray& device_array) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
+  DCHECK_GE(request_id, 0);
 
-  for (RequestList::iterator it = requests_.begin();
-       it != requests_.end(); ++it) {
-    Request& request = *it;
-    if (request.ipc_request == request_id) {
-      if (request.handler) {
-        request.handler->OnDevicesEnumerated(request.request_id, device_array);
-        DVLOG(1) << "MediaStreamDispatcher::OnDevicesEnumerated("
-                 << request.request_id << ")";
-      }
-      requests_.erase(it);
-      break;
+  EnumerationState* state;
+  if (request_id == audio_enumeration_state_.ipc_id) {
+    state = &audio_enumeration_state_;
+  } else if (request_id == video_enumeration_state_.ipc_id) {
+    state = &video_enumeration_state_;
+  } else {
+    // This could happen when requester has stopped enumeration while some
+    // enumerated response is on the way. Have to stop the |label| because
+    // this might be the first enumerated device list is received. This also
+    // lead to same label being stopped multiple times.
+    Send(new MediaStreamHostMsg_StopGeneratedStream(routing_id(), label));
+    return;
+  }
+
+  DCHECK(!label.empty());
+  state->cached_devices.reset(new EnumerationState::CachedDevices(
+      label, device_array));
+
+  for (EnumerationRequestList::iterator it = state->requests.begin();
+       it != state->requests.end(); ++it) {
+    if (it->handler) {
+      it->handler->OnDevicesEnumerated(it->request_id, device_array);
+      DVLOG(1) << "MediaStreamDispatcher::OnDevicesEnumerated("
+               << it->request_id << ")";
     }
   }
 }
 
 void MediaStreamDispatcher::OnDevicesEnumerationFailed(int request_id) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   for (RequestList::iterator it = requests_.begin();
        it != requests_.end(); ++it) {
     Request& request = *it;
     if (request.ipc_request == request_id) {
       if (request.handler) {
         request.handler->OnStreamGenerationFailed(request.request_id);
         DVLOG(1) << "MediaStreamDispatcher::OnDevicesEnumerationFailed("
                  << request.request_id << ")\n";
       }
       requests_.erase(it);
       break;
     }
   }
 }
 
 void MediaStreamDispatcher::OnDeviceOpened(
     int request_id,
     const std::string& label,
     const media_stream::StreamDeviceInfo& device_info) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   for (RequestList::iterator it = requests_.begin();
        it != requests_.end(); ++it) {
     Request& request = *it;
     if (request.ipc_request == request_id) {
       Stream new_stream;
       new_stream.handler = request.handler;
       if (device_info.stream_type ==
               content::MEDIA_STREAM_DEVICE_TYPE_VIDEO_CAPTURE) {
         new_stream.video_array.push_back(device_info);
       } else {
         new_stream.audio_array.push_back(device_info);
       }
       label_stream_map_[label] = new_stream;
       if (request.handler) {
         request.handler->OnDeviceOpened(request.request_id, label,
                                         device_info);
         DVLOG(1) << "MediaStreamDispatcher::OnDeviceOpened("
                  << request.request_id << ", " << label << ")";
       }
       requests_.erase(it);
       break;
     }
   }
 }
 
 void MediaStreamDispatcher::OnDeviceOpenFailed(int request_id) {
+  DCHECK(main_loop_->BelongsToCurrentThread());
   for (RequestList::iterator it = requests_.begin();
        it != requests_.end(); ++it) {
     Request& request = *it;
     if (request.ipc_request == request_id) {
       if (request.handler) {
         request.handler->OnDeviceOpenFailed(request.request_id);
         DVLOG(1) << "MediaStreamDispatcher::OnDeviceOpenFailed("
                  << request.request_id << ")\n";
       }
       requests_.erase(it);
@@ skipping 18 matching lines @@
 
 int MediaStreamDispatcher::video_session_id(const std::string& label,
                                             int index) {
   LabelStreamMap::iterator it = label_stream_map_.find(label);
   if (it == label_stream_map_.end())
     return media_stream::StreamDeviceInfo::kNoId;
 
   DCHECK_GT(it->second.video_array.size(), static_cast<size_t>(index));
   return it->second.video_array[index].session_id;
 }