Cast: Refactoring Cast API's

media/cast/cast_sender.h

 // Copyright 2013 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.
 //
 // This is the main interface for the cast sender. All configuration are done
 // at creation.
 //
 // The FrameInput and PacketReciever interfaces should normally be accessed from
 // the IO thread. However they are allowed to be called from any thread.
 
 #ifndef MEDIA_CAST_CAST_SENDER_H_
 #define MEDIA_CAST_CAST_SENDER_H_
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/memory/ref_counted.h"
 #include "base/time/tick_clock.h"
 #include "base/time/time.h"
 #include "media/cast/cast_config.h"
 #include "media/cast/cast_environment.h"
 #include "media/cast/transport/cast_transport_sender.h"
 #include "media/filters/gpu_video_accelerator_factories.h"
 
 namespace media {
 class AudioBus;
+class GpuVideoAcceleratorFactories;
 class VideoFrame;
-}
 
-namespace media {
 namespace cast {
+class AudioSender;
+class VideoSender;
+
 
 // This Class is thread safe.

[Ami GONE FROM CHROMIUM, 2014/02/13 18:02:14]

"thread safe" usually implies callable from any thread.
The new API methods you've added use WeakPtr and thus imply being bound to a
particular thread.  What's up with that?

[mikhal1, 2014/02/14 18:03:16]

Comment irrelevant. New comments added.
On 2014/02/13 18:02:14, Ami Fischman wrote:

 class FrameInput : public base::RefCountedThreadSafe<FrameInput> {
  public:
   // The video_frame must be valid until the callback is called.
   // The callback is called from the main cast thread as soon as
   // the encoder is done with the frame; it does not mean that the encoded frame
   // has been sent out.
   virtual void InsertRawVideoFrame(
       const scoped_refptr<media::VideoFrame>& video_frame,
       const base::TimeTicks& capture_time) = 0;
 
   // The |audio_bus| must be valid until the |done_callback| is called.
   // The callback is called from the main cast thread as soon as the encoder is
   // done with |audio_bus|; it does not mean that the encoded data has been
   // sent out.
   virtual void InsertAudio(const AudioBus* audio_bus,
                            const base::TimeTicks& recorded_time,
                            const base::Closure& done_callback) = 0;
 
+  virtual void SetAudioSender(base::WeakPtr<AudioSender> audio_sender) = 0;

[Ami GONE FROM CHROMIUM, 2014/02/13 18:02:14]

doco (esp. for public, esp^2 for pure virtual)

[mikhal1, 2014/02/14 18:03:16]

Done.

+
+  virtual void SetVideoSender(base::WeakPtr<VideoSender> video_sender) = 0;
+
  protected:
   virtual ~FrameInput() {}
 
  private:
   friend class base::RefCountedThreadSafe<FrameInput>;
 };
 
 // This Class is thread safe.
 // The provided CastTransportSender object will always be called from the main
 // cast thread.
 //  At least one of AudioSenderConfig and VideoSenderConfig have to be provided.
 class CastSender {
  public:
   static CastSender* CreateCastSender(

[Ami GONE FROM CHROMIUM, 2014/02/13 18:02:14]

This doesn't doco ownership semantics of the returned object.
I believe this should instead return a scoped_ptr<CastSender> which would
obviate the need for a comment.

[Alpha Left Google, 2014/02/13 19:53:59]

This can just be CastSender::Create(...). CastSender::CreateCastSender is
clumsy.

[mikhal1, 2014/02/14 18:03:16]

Renamed.
On 2014/02/13 19:53:59, Alpha wrote:

       scoped_refptr<CastEnvironment> cast_environment,
-      const AudioSenderConfig* audio_config,
-      const VideoSenderConfig* video_config,
-      const scoped_refptr<GpuVideoAcceleratorFactories>& gpu_factories,
       const CastInitializationCallback& cast_initialization,
       transport::CastTransportSender* const transport_sender);
 
   virtual ~CastSender() {}
 
   // All audio and video frames for the session should be inserted to this
   // object.
   // Can be called from any thread.
   virtual scoped_refptr<FrameInput> frame_input() = 0;
 
   // All RTCP packets for the session should be inserted to this object.
   // Can be called from any thread.
   virtual transport::PacketReceiverCallback packet_receiver() = 0;
+
+  // Initialize the audio stack. Must be called in order to send audio frames.
+  virtual void InitializeAudio(const AudioSenderConfig& audio_config) = 0;
+
+  // Initialize the video stack. Must be called in order to send video frames.
+  virtual void InitializeVideo(
+      const VideoSenderConfig& video_config,
+      const scoped_refptr<GpuVideoAcceleratorFactories>& gpu_factories) = 0;
 };
 
 }  // namespace cast
 }  // namespace media
 
 #endif  // MEDIA_CAST_CAST_SENDER_H_