Introduce webrtc::VideoFrame::timestamp_us, and corresponding constructor.

webrtc/video_frame.h

 /*
  *  Copyright (c) 2014 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #ifndef WEBRTC_VIDEO_FRAME_H_
 #define WEBRTC_VIDEO_FRAME_H_
 
 #include "webrtc/base/scoped_ref_ptr.h"
+#include "webrtc/base/timeutils.h"
 #include "webrtc/common_types.h"
 #include "webrtc/common_video/include/video_frame_buffer.h"
 #include "webrtc/common_video/rotation.h"
 #include "webrtc/typedefs.h"
 
 namespace webrtc {
 
 // TODO(nisse): This class duplicates cricket::VideoFrame. There's
 // ongoing work to merge the classes. See
 // https://bugs.chromium.org/p/webrtc/issues/detail?id=5682.
 class VideoFrame {
  public:
   // TODO(nisse): Deprecated. Using the default constructor violates the
   // reasonable assumption that video_frame_buffer() returns a valid buffer.
   VideoFrame();
 
-  // Preferred constructor.
-  VideoFrame(const rtc::scoped_refptr<webrtc::VideoFrameBuffer>& buffer,
+  // New style constructor, consistent with cricket::WebRtcVideoFrame.

[danilchap, 2016/08/26 13:19:30]

do not use word 'new'
it will be old quickly.
"Constructor consistent with cricket::WebRtcVideFrame"
might be better comment if you plan to keep both constructors.
No comment probably better otherwise.

[nisse-webrtc, 2016/08/29 07:49:58]

I rephrased as a TODO comment pointing out the direction.

+  VideoFrame(const rtc::scoped_refptr<VideoFrameBuffer>& buffer,

[danilchap, 2016/08/26 13:19:30]

might be cleaner to pass this refptr by value instead of by const&
(since it is moved into video_frame_buffer_)

That would give class user choice - give a refcopy or move ptr<VideFrameBuffer>,
where const& force copy and thus might add unnecessary AddRef/Release calls.
e.g. black_buffer can be moved.

[nisse-webrtc, 2016/08/29 07:49:58]

Makes sense. But I think it's for a different cl, doing this change to all
similar VideoFrame constructors.

+             webrtc::VideoRotation rotation,

[danilchap, 2016/08/26 13:19:30]

for consistency might be better to order parameters like members (and similar to
next constructor), i.e. timestamp before rotation.

[nisse-webrtc, 2016/08/29 07:49:58]

Sorry about that. But this argument ordering is a workaround to get distinct
signatures for the deprecated nanosec constructor and the new microsec
constructor, on the cricket::WebRtcVideoFrame class.

[danilchap, 2016/08/29 08:28:16]

Acknowledged.
Not sure why consistency with WebRtcVideFrame matter.

+             int64_t timestamp_us);
+
+  // Preferred old style constructor.

[danilchap, 2016/08/26 13:19:30]

avoice using word 'old' too for same reason as word 'new'.
If you plan to remove it, write deprecated.

[nisse-webrtc, 2016/08/29 07:49:58]

Done.

+  VideoFrame(const rtc::scoped_refptr<VideoFrameBuffer>& buffer,
              uint32_t timestamp,
              int64_t render_time_ms,
              VideoRotation rotation);
 
   // CreateEmptyFrame: Sets frame dimensions and allocates buffers based
   // on set dimensions - height and plane stride.
   // If required size is bigger than the allocated one, new buffers of adequate
   // size will be allocated.
 
   // TODO(nisse): Deprecated. Should be deleted in the cricket::VideoFrame and
@@ skipping 53 matching lines @@
   // webrtc::VideoFrame merge. When used with memset, consider using
   // libyuv::I420Rect instead.
   int allocated_size(PlaneType type) const;
 
   // Get frame width.
   int width() const;
 
   // Get frame height.
   int height() const;
 
+  // System monotonic clock, same timebase as rtc::TimeMicros().
+  int64_t timestamp_us() const { return timestamp_us_; }
+  void set_timestamp_us(int64_t timestamp_us) {
+    timestamp_us_ = timestamp_us;
+  }
+
   // TODO(nisse): After the cricket::VideoFrame and webrtc::VideoFrame
-  // merge, we'll have methods timestamp_us and set_timestamp_us, all
-  // other frame timestamps will likely be deprecated.
+  // merge, timestamps other than timestamp_us will likely be
+  // deprecated.
 
   // Set frame timestamp (90kHz).
   void set_timestamp(uint32_t timestamp) { timestamp_ = timestamp; }
 
   // Get frame timestamp (90kHz).
   uint32_t timestamp() const { return timestamp_; }
 
   // Set capture ntp time in milliseconds.
   void set_ntp_time_ms(int64_t ntp_time_ms) {
     ntp_time_ms_ = ntp_time_ms;
@@ skipping 12 matching lines @@
   // "apply rotation" = modify a frame from being "pending" to being "not
   //                    pending" rotation (a no-op for "unrotated").
   //
   VideoRotation rotation() const { return rotation_; }
   void set_rotation(VideoRotation rotation) {
     rotation_ = rotation;
   }
 
   // Set render time in milliseconds.
   void set_render_time_ms(int64_t render_time_ms) {
-    render_time_ms_ = render_time_ms;
+    set_timestamp_us(render_time_ms * rtc::kNumMicrosecsPerMillisec);;
   }
 
   // Get render time in milliseconds.
-  int64_t render_time_ms() const { return render_time_ms_; }
+  int64_t render_time_ms() const {
+    return timestamp_us() / rtc::kNumMicrosecsPerMillisec;
+  }
 
   // Return true if and only if video_frame_buffer() is null. Which is possible
   // only if the object was default-constructed.
   // TODO(nisse): Deprecated. Should be deleted in the cricket::VideoFrame and
   // webrtc::VideoFrame merge. The intention is that video_frame_buffer() never
   // should return nullptr. To handle potentially uninitialized or non-existent
   // frames, consider using rtc::Optional. Otherwise, IsZeroSize() can be
   // replaced by video_frame_buffer() == nullptr.
   bool IsZeroSize() const;
 
   // Return the underlying buffer. Never nullptr for a properly
   // initialized VideoFrame.
   // Creating a new reference breaks the HasOneRef and IsMutable
   // logic. So return a const ref to our reference.
   const rtc::scoped_refptr<webrtc::VideoFrameBuffer>& video_frame_buffer()
       const;
 
   // Return true if the frame is stored in a texture.
   bool is_texture() {
     return video_frame_buffer() &&
            video_frame_buffer()->native_handle() != nullptr;
   }
 
  private:
   // An opaque reference counted handle that stores the pixel data.
   rtc::scoped_refptr<webrtc::VideoFrameBuffer> video_frame_buffer_;
   uint32_t timestamp_;
   int64_t ntp_time_ms_;
-  int64_t render_time_ms_;
+  int64_t timestamp_us_;
   VideoRotation rotation_;
 };
 
 
 // TODO(pbos): Rename EncodedFrame and reformat this class' members.
 class EncodedImage {
  public:
   static const size_t kBufferPaddingBytesH264;
 
   // Some decoders require encoded image buffers to be padded with a small
@@ skipping 33 matching lines @@
   int qp_ = -1;  // Quantizer value.
 
   // When an application indicates non-zero values here, it is taken as an
   // indication that all future frames will be constrained with those limits
   // until the application indicates a change again.
   PlayoutDelay playout_delay_ = {-1, -1};
 };
 
 }  // namespace webrtc
 #endif  // WEBRTC_VIDEO_FRAME_H_