content/browser/media/media_internals.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_MEDIA_MEDIA_INTERNALS_H_
   6 #define CONTENT_BROWSER_MEDIA_MEDIA_INTERNALS_H_
   7
   8 #include <list>
   9 #include <map>
  10 #include <string>
  11 #include <vector>
  12
  13 #include "base/callback_forward.h"
  14 #include "base/compiler_specific.h"
  15 #include "base/lazy_instance.h"
  16 #include "base/strings/string16.h"
  17 #include "base/synchronization/lock.h"
  18 #include "base/values.h"
  19 #include "content/common/content_export.h"
  20 #include "content/public/browser/notification_observer.h"
  21 #include "content/public/browser/notification_registrar.h"
  22 #include "media/audio/audio_logging.h"
  23 #include "media/base/media_log.h"
  24 #include "media/capture/video/video_capture_device_info.h"
  25
  26 namespace media {
  27 class AudioParameters;
  28 struct MediaLogEvent;
  29 }
  30
  31 namespace content {
  32
  33 // This class stores information about currently active media.
  34 class CONTENT_EXPORT MediaInternals
  35     : NON_EXPORTED_BASE(public media::AudioLogFactory),
  36       public NotificationObserver {
  37  public:
  38   // Called with the update string.
  39   typedef base::Callback<void(const base::string16&)> UpdateCallback;
  40
  41   static MediaInternals* GetInstance();
  42
  43   ~MediaInternals() override;
  44
  45   // NotificationObserver implementation.
  46   void Observe(int type,
  47                const NotificationSource& source,
  48                const NotificationDetails& details) override;
  49
  50   // Called when a MediaEvent occurs.
  51   void OnMediaEvents(int render_process_id,
  52                      const std::vector<media::MediaLogEvent>& events);
  53
  54   // Add/remove update callbacks (see above). Must be called on the UI thread.
  55   // The callbacks must also be fired on UI thread.
  56   void AddUpdateCallback(const UpdateCallback& callback);
  57   void RemoveUpdateCallback(const UpdateCallback& callback);
  58
  59   // Whether there are any update callbacks available. Can be called on any
  60   // thread.
  61   bool CanUpdate();
  62
  63   // Replay all saved media events.
  64   void SendHistoricalMediaEvents();
  65
  66   // Sends all audio cached data to each registered UpdateCallback.
  67   void SendAudioStreamData();
  68
  69   // Sends all video capture capabilities cached data to each registered
  70   // UpdateCallback.
  71   void SendVideoCaptureDeviceCapabilities();
  72
  73   // Called to inform of the capabilities enumerated for video devices.
  74   void UpdateVideoCaptureDeviceCapabilities(
  75       const media::VideoCaptureDeviceInfos& video_capture_device_infos);
  76
  77   // AudioLogFactory implementation.  Safe to call from any thread.
  78   scoped_ptr<media::AudioLog> CreateAudioLog(AudioComponent component) override;
  79
  80   // If possible, i.e. a WebContents exists for the given RenderFrameHostID,
  81   // tells an existing AudioLogEntry the WebContents title for easier
  82   // differentiation on the UI.
  83   void SetWebContentsTitleForAudioLogEntry(int component_id,
  84                                            int render_process_id,
  85                                            int render_frame_id,
  86                                            media::AudioLog* audio_log);
  87
  88  private:
  89   // Inner class to handle reporting pipelinestatus to UMA
  90   class MediaInternalsUMAHandler;
  91
  92   friend class AudioLogImpl;
  93   friend class MediaInternalsTest;
  94   friend struct base::DefaultLazyInstanceTraits<MediaInternals>;
  95
  96   // Pending events for a particular process.
  97   using PendingEvents = std::list<media::MediaLogEvent>;
  98
  99   // The maps between process ID and PendingEvents.
 100   using PendingEventsMap = std::map<int, PendingEvents>;
 101
 102   MediaInternals();
 103
 104   // Sends |update| to each registered UpdateCallback.  Safe to call from any
 105   // thread, but will forward to the IO thread.
 106   void SendUpdate(const base::string16& update);
 107
 108   // Saves |event| so that it can be sent later in SendHistoricalMediaEvents().
 109   void SaveEvent(int process_id, const media::MediaLogEvent& event);
 110
 111   // Caches |value| under |cache_key| so that future UpdateAudioLog() calls
 112   // will include the current data.  Calls JavaScript |function|(|value|) for
 113   // each registered UpdateCallback (if any).
 114   enum AudioLogUpdateType {
 115     CREATE,             // Creates a new AudioLog cache entry.
 116     UPDATE_IF_EXISTS,   // Updates an existing AudioLog cache entry, does
 117                         // nothing if it doesn't exist.
 118     UPDATE_AND_DELETE,  // Deletes an existing AudioLog cache entry.
 119   };
 120   void UpdateAudioLog(AudioLogUpdateType type,
 121                       const std::string& cache_key,
 122                       const std::string& function,
 123                       const base::DictionaryValue* value);
 124
 125   // Must only be accessed on the UI thread.
 126   std::vector<UpdateCallback> update_callbacks_;
 127   PendingEventsMap pending_events_map_;
 128
 129   // Must only be accessed on the IO thread.
 130   base::ListValue video_capture_capabilities_cached_data_;
 131
 132   NotificationRegistrar registrar_;
 133
 134   // All variables below must be accessed under |lock_|.
 135   base::Lock lock_;
 136   bool can_update_;
 137   base::DictionaryValue audio_streams_cached_data_;
 138   int owner_ids_[AUDIO_COMPONENT_MAX];
 139   scoped_ptr<MediaInternalsUMAHandler> uma_handler_;
 140
 141   DISALLOW_COPY_AND_ASSIGN(MediaInternals);
 142 };
 143
 144 }  // namespace content
 145
 146 #endif  // CONTENT_BROWSER_MEDIA_MEDIA_INTERNALS_H_