Introduce new interface for MediaInternals updates.

content/browser/media/media_internals.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/browser/media/media_internals.h"
 
-#include "base/memory/scoped_ptr.h"
 #include "base/strings/string16.h"
 #include "base/strings/stringprintf.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/web_ui.h"
 #include "media/audio/audio_parameters.h"
 #include "media/base/media_log.h"
 #include "media/base/media_log_event.h"
 
+namespace {
+
+static base::LazyInstance<content::MediaInternals>::Leaky g_media_internals =
+    LAZY_INSTANCE_INITIALIZER;
+
+string16 SerializeUpdate(const std::string& function,
+                         const base::Value* value) {
+  return content::WebUI::GetJavascriptCall(
+      function, std::vector<const base::Value*>(1, value));
+}
+
+const char kAudioLogStatusKey[] = "status";
+const char kAudioLogUpdateFunction[] = "media.updateAudioComponent";
+
+}  // namespace
+
 namespace content {
 
-MediaInternals* MediaInternals::GetInstance() {
-  return Singleton<MediaInternals>::get();
+class AudioLogImpl : public media::AudioLog {
+ public:
+  AudioLogImpl(int owner_id,
+               media::AudioLogFactory::AudioComponent component,
+               content::MediaInternals* media_internals);
+  virtual ~AudioLogImpl();
+
+  virtual void OnCreated(int component_id,
+                         const media::AudioParameters& params,
+                         const std::string& input_device_id,
+                         const std::string& output_device_id) OVERRIDE;
+  virtual void OnStarted(int component_id) OVERRIDE;
+  virtual void OnStopped(int component_id) OVERRIDE;
+  virtual void OnClosed(int component_id) OVERRIDE;
+  virtual void OnError(int component_id) OVERRIDE;
+  virtual void OnSetVolume(int component_id, double volume) OVERRIDE;
+
+ private:
+  void SendSingleStringUpdate(int component_id,
+                              const std::string& key,
+                              const std::string& value,
+                              bool purge_cache);
+  void StoreComponentMetadata(int component_id, base::DictionaryValue* dict);
+  std::string FormatCacheKey(int component_id);
+
+  const int owner_id_;
+  const media::AudioLogFactory::AudioComponent component_;
+  content::MediaInternals* const media_internals_;
+
+  DISALLOW_COPY_AND_ASSIGN(AudioLogImpl);
+};
+
+AudioLogImpl::AudioLogImpl(int owner_id,
+                           media::AudioLogFactory::AudioComponent component,
+                           content::MediaInternals* media_internals)
+    : owner_id_(owner_id),
+      component_(component),
+      media_internals_(media_internals) {}
+
+AudioLogImpl::~AudioLogImpl() {}
+
+void AudioLogImpl::OnCreated(int component_id,
+                             const media::AudioParameters& params,
+                             const std::string& input_device_id,
+                             const std::string& output_device_id) {
+  base::DictionaryValue dict;
+  StoreComponentMetadata(component_id, &dict);
+
+  dict.SetString(kAudioLogStatusKey, "created");
+  dict.SetString("input_device_id", input_device_id);
+  dict.SetInteger("input_channels", params.input_channels());
+  dict.SetInteger("frames_per_buffer", params.frames_per_buffer());
+  dict.SetInteger("sample_rate", params.sample_rate());
+  dict.SetString("output_device_id", output_device_id);
+  dict.SetInteger("output_channels", params.channels());
+  dict.SetString("output_channel_layout",
+                 ChannelLayoutToString(params.channel_layout()));
+
+  media_internals_->SendUpdateAndCache(
+      FormatCacheKey(component_id), kAudioLogUpdateFunction, &dict);
 }
 
-MediaInternals::~MediaInternals() {}
-
-namespace {
-std::string FormatAudioStreamName(void* host, int stream_id) {
-  return base::StringPrintf("audio_streams.%p:%d", host, stream_id);
-}
+void AudioLogImpl::OnStarted(int component_id) {
+  SendSingleStringUpdate(component_id, kAudioLogStatusKey, "started", false);
 }
 
-void MediaInternals::OnDeleteAudioStream(void* host, int stream_id) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  DeleteItem(FormatAudioStreamName(host, stream_id));
+void AudioLogImpl::OnStopped(int component_id) {
+  SendSingleStringUpdate(component_id, kAudioLogStatusKey, "stopped", false);
 }
 
-void MediaInternals::OnSetAudioStreamPlaying(
-    void* host, int stream_id, bool playing) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  UpdateAudioStream(host, stream_id,
-                    "playing", new base::FundamentalValue(playing));
+void AudioLogImpl::OnClosed(int component_id) {
+  SendSingleStringUpdate(component_id, kAudioLogStatusKey, "closed", true);

[acolwell GONE FROM CHROMIUM, 2013/11/22 21:01:21]

Since this is the only instance where purge_cache is true, perhaps we should put
the purge logic here and remove the bool param.

[DaleCurtis, 2013/11/22 21:16:03]

Fair enough, I originally had it that way, but it requires duplicating the
following lines:

  base::DictionaryValue dict;
  StoreComponentMetadata(component_id, &dict);
  dict.SetString(kAudioLogStatusKey, value);

Perhaps that's clearer than a bool you have to look up though.

 }
 
-void MediaInternals::OnAudioStreamCreated(void* host,
-                                          int stream_id,
-                                          const media::AudioParameters& params,
-                                          const std::string& input_device_id) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-
-  StoreAudioStream(host,
-                   stream_id,
-                   "input_device_id",
-                   Value::CreateStringValue(input_device_id));
-
-  StoreAudioStream(
-      host, stream_id, "status", Value::CreateStringValue("created"));
-
-  StoreAudioStream(
-      host, stream_id, "stream_id", Value::CreateIntegerValue(stream_id));
-
-  StoreAudioStream(host,
-                   stream_id,
-                   "input_channels",
-                   Value::CreateIntegerValue(params.input_channels()));
-
-  StoreAudioStream(host,
-                   stream_id,
-                   "frames_per_buffer",
-                   Value::CreateIntegerValue(params.frames_per_buffer()));
-
-  StoreAudioStream(host,
-                   stream_id,
-                   "sample_rate",
-                   Value::CreateIntegerValue(params.sample_rate()));
-
-  StoreAudioStream(host,
-                   stream_id,
-                   "output_channels",
-                   Value::CreateIntegerValue(params.channels()));
-
-  StoreAudioStream(
-      host,
-      stream_id,
-      "channel_layout",
-      Value::CreateStringValue(ChannelLayoutToString(params.channel_layout())));
-
-  SendEverything();
+void AudioLogImpl::OnError(int component_id) {
+  SendSingleStringUpdate(component_id, "error_occurred", "true", false);
 }
 
-void MediaInternals::OnSetAudioStreamStatus(void* host,
-                                            int stream_id,
-                                            const std::string& status) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  UpdateAudioStream(host, stream_id,
-                    "status", new base::StringValue(status));
+void AudioLogImpl::OnSetVolume(int component_id, double volume) {
+  base::DictionaryValue dict;
+  StoreComponentMetadata(component_id, &dict);
+  dict.SetDouble("volume", volume);
+  media_internals_->SendUpdateAndCache(
+      FormatCacheKey(component_id), kAudioLogUpdateFunction, &dict);
 }
 
-void MediaInternals::OnSetAudioStreamVolume(
-    void* host, int stream_id, double volume) {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  UpdateAudioStream(host, stream_id,
-                    "volume", new base::FundamentalValue(volume));
+std::string AudioLogImpl::FormatCacheKey(int component_id) {
+  return base::StringPrintf("%d:%d", owner_id_, component_id);
 }
 
+void AudioLogImpl::SendSingleStringUpdate(int component_id,
+                                          const std::string& key,
+                                          const std::string& value,
+                                          bool purge_cache) {
+  base::DictionaryValue dict;
+  StoreComponentMetadata(component_id, &dict);
+  dict.SetString(key, value);
+
+  if (purge_cache) {
+    media_internals_->SendUpdateAndPurgeCache(
+        FormatCacheKey(component_id), kAudioLogUpdateFunction, &dict);
+  } else {
+    media_internals_->SendUpdateAndCache(
+        FormatCacheKey(component_id), kAudioLogUpdateFunction, &dict);
+  }
+}
+
+void AudioLogImpl::StoreComponentMetadata(int component_id,
+                                          base::DictionaryValue* dict) {
+  dict->SetInteger("owner_id", owner_id_);
+  dict->SetInteger("component_id", component_id);
+  dict->SetInteger("component_type", component_);
+}
+
+MediaInternals* MediaInternals::GetInstance() {
+  return g_media_internals.Pointer();
+}
+
+MediaInternals::MediaInternals() : owner_ids_() {}
+MediaInternals::~MediaInternals() {}
+
 void MediaInternals::OnMediaEvents(
     int render_process_id, const std::vector<media::MediaLogEvent>& events) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-
   // Notify observers that |event| has occured.
   for (std::vector<media::MediaLogEvent>::const_iterator event = events.begin();
-      event != events.end(); ++event) {
+       event != events.end(); ++event) {
     base::DictionaryValue dict;
     dict.SetInteger("renderer", render_process_id);
     dict.SetInteger("player", event->id);
     dict.SetString("type", media::MediaLog::EventTypeToString(event->type));
 
-    int64 ticks = event->time.ToInternalValue();
-    double ticks_millis =
-        ticks / static_cast<double>(base::Time::kMicrosecondsPerMillisecond);
-
+    // TODO(dalecurtis): This is technically not correct.  TimeTicks "can't" be
+    // converted to to a human readable time format.  See base/time/time.h.
+    const double ticks = event->time.ToInternalValue();
+    const double ticks_millis = ticks / base::Time::kMicrosecondsPerMillisecond;
     dict.SetDouble("ticksMillis", ticks_millis);
     dict.Set("params", event->params.DeepCopy());
-    SendUpdate("media.onMediaEvent", &dict);
+    SendUpdate(SerializeUpdate("media.onMediaEvent", &dict));
   }
 }
 
 void MediaInternals::AddUpdateCallback(const UpdateCallback& callback) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   update_callbacks_.push_back(callback);
 }
 
 void MediaInternals::RemoveUpdateCallback(const UpdateCallback& callback) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
   for (size_t i = 0; i < update_callbacks_.size(); ++i) {
     if (update_callbacks_[i].Equals(callback)) {
       update_callbacks_.erase(update_callbacks_.begin() + i);
       return;
     }
   }
   NOTREACHED();
 }
 
 void MediaInternals::SendEverything() {
-  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO));
-  SendUpdate("media.onReceiveEverything", &data_);
+  base::AutoLock auto_lock(cache_lock_);
+  SendUpdate(SerializeUpdate("media.onReceiveEverything", &cached_data_));
 }
 
-MediaInternals::MediaInternals() {
-}
+void MediaInternals::SendUpdate(const string16& update) {
+  // SendUpdate() may be called from any thread, but must run on the IO thread.
+  // TODO(dalecurtis): This is pretty silly since the update callbacks simply
+  // forward the calls to the UI thread.  We should avoid the extra hop.
+  if (!BrowserThread::CurrentlyOn(BrowserThread::IO)) {
+    BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(
+        &MediaInternals::SendUpdate, base::Unretained(this), update));
+    return;
+  }
 
-void MediaInternals::StoreAudioStream(void* host,
-                                      int stream_id,
-                                      const std::string& property,
-                                      base::Value* value) {
-  StoreItem(FormatAudioStreamName(host, stream_id), property, value);
-}
-
-void MediaInternals::UpdateAudioStream(void* host,
-                                       int stream_id,
-                                       const std::string& property,
-                                       base::Value* value) {
-  UpdateItem("media.updateAudioStream",
-             FormatAudioStreamName(host, stream_id),
-             property,
-             value);
-}
-
-void MediaInternals::DeleteItem(const std::string& item) {
-  data_.Remove(item, NULL);
-  scoped_ptr<base::Value> value(new base::StringValue(item));
-  SendUpdate("media.onItemDeleted", value.get());
-}
-
-base::DictionaryValue* MediaInternals::StoreItem(const std::string& id,
-                                                 const std::string& property,
-                                                 base::Value* value) {
-  base::DictionaryValue* item_properties;
-  if (!data_.GetDictionary(id, &item_properties)) {
-    item_properties = new base::DictionaryValue();
-    data_.Set(id, item_properties);
-    item_properties->SetString("id", id);
-  }
-  item_properties->Set(property, value);
-  return item_properties;
-}
-
-void MediaInternals::UpdateItem(const std::string& update_fn,
-                                const std::string& id,
-                                const std::string& property,
-                                base::Value* value) {
-  base::DictionaryValue* item_properties = StoreItem(id, property, value);
-  SendUpdate(update_fn, item_properties);
-}
-
-void MediaInternals::SendUpdate(const std::string& function,
-                                base::Value* value) {
-  // Only bother serializing the update to JSON if someone is watching.
-  if (update_callbacks_.empty())
-    return;
-
-  std::vector<const base::Value*> args;
-  args.push_back(value);
-  string16 update = WebUI::GetJavascriptCall(function, args);
   for (size_t i = 0; i < update_callbacks_.size(); i++)
     update_callbacks_[i].Run(update);
 }
 
+scoped_ptr<media::AudioLog> MediaInternals::CreateAudioLog(
+    AudioComponent component) {
+  base::AutoLock auto_lock(cache_lock_);
+  return scoped_ptr<media::AudioLog>(new AudioLogImpl(
+      owner_ids_[component]++, component, this));
+}
+
+void MediaInternals::SendUpdateAndCache(const std::string& cache_key,
+                                        const std::string& function,
+                                        const base::DictionaryValue* value) {
+  base::AutoLock auto_lock(cache_lock_);
+  SendUpdate(SerializeUpdate(function, value));
+
+  if (!cached_data_.HasKey(cache_key)) {
+    cached_data_.Set(cache_key, value->DeepCopy());
+    return;
+  }
+
+  base::DictionaryValue* existing_dict = NULL;
+  CHECK(cached_data_.GetDictionary(cache_key, &existing_dict));
+  existing_dict->MergeDictionary(value);
+}
+
+void MediaInternals::SendUpdateAndPurgeCache(
+    const std::string& cache_key,
+    const std::string& function,
+    const base::DictionaryValue* value) {
+  base::AutoLock auto_lock(cache_lock_);
+  SendUpdate(SerializeUpdate(function, value));
+
+  scoped_ptr<base::Value> out_value;
+  CHECK(cached_data_.Remove(cache_key, &out_value));
+}
+
 }  // namespace content