src/content/browser/renderer_host/media/audio_sync_reader.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_RENDERER_HOST_MEDIA_AUDIO_SYNC_READER_H_
   6 #define CONTENT_BROWSER_RENDERER_HOST_MEDIA_AUDIO_SYNC_READER_H_
   7
   8 #include "base/file_descriptor_posix.h"
   9 #include "base/process/process.h"
  10 #include "base/sync_socket.h"
  11 #include "base/synchronization/lock.h"
  12 #include "base/time/time.h"
  13 #include "media/audio/audio_output_controller.h"
  14 #include "media/base/audio_bus.h"
  15
  16 namespace base {
  17 class SharedMemory;
  18 }
  19
  20 namespace content {
  21
  22 // A AudioOutputController::SyncReader implementation using SyncSocket. This
  23 // is used by AudioOutputController to provide a low latency data source for
  24 // transmitting audio packets between the browser process and the renderer
  25 // process.
  26 class AudioSyncReader : public media::AudioOutputController::SyncReader {
  27  public:
  28   AudioSyncReader(base::SharedMemory* shared_memory,
  29                   const media::AudioParameters& params);
  30
  31   virtual ~AudioSyncReader();
  32
  33   // media::AudioOutputController::SyncReader implementations.
  34   virtual void UpdatePendingBytes(uint32 bytes) OVERRIDE;
  35   virtual void Read(const media::AudioBus* source,
  36                     media::AudioBus* dest) OVERRIDE;
  37   virtual void Close() OVERRIDE;
  38
  39   bool Init();
  40   bool PrepareForeignSocketHandle(base::ProcessHandle process_handle,
  41 #if defined(OS_WIN)
  42                                   base::SyncSocket::Handle* foreign_handle);
  43 #else
  44                                   base::FileDescriptor* foreign_handle);
  45 #endif
  46
  47  private:
  48   // Blocks until data is ready for reading or a timeout expires.  Returns false
  49   // if an error or timeout occurs.
  50   bool WaitUntilDataIsReady();
  51
  52   const base::SharedMemory* const shared_memory_;
  53
  54   // Mutes all incoming samples. This is used to prevent audible sound
  55   // during automated testing.
  56   const bool mute_audio_;
  57
  58   // Socket for transmitting audio data.
  59   scoped_ptr<base::CancelableSyncSocket> socket_;
  60
  61   // Socket to be used by the renderer. The reference is released after
  62   // PrepareForeignSocketHandle() is called and ran successfully.
  63   scoped_ptr<base::CancelableSyncSocket> foreign_socket_;
  64
  65   // Shared memory wrapper used for transferring audio data to Read() callers.
  66   scoped_ptr<media::AudioBus> output_bus_;
  67
  68   // Maximum amount of audio data which can be transferred in one Read() call.
  69   const int packet_size_;
  70
  71   // Track the number of times the renderer missed its real-time deadline and
  72   // report a UMA stat during destruction.
  73   size_t renderer_callback_count_;
  74   size_t renderer_missed_callback_count_;
  75
  76   // The maximum amount of time to wait for data from the renderer.  Calculated
  77   // from the parameters given at construction.
  78   const base::TimeDelta maximum_wait_time_;
  79
  80   // The index of the audio buffer we're expecting to be sent from the renderer;
  81   // used to block with timeout for audio data.
  82   uint32 buffer_index_;
  83
  84   DISALLOW_COPY_AND_ASSIGN(AudioSyncReader);
  85 };
  86
  87 }  // namespace content
  88
  89 #endif  // CONTENT_BROWSER_RENDERER_HOST_MEDIA_AUDIO_SYNC_READER_H_