Add TODO comments on deprecated VideoFrame methods.

webrtc/media/base/videoframe.h

 /*
  *  Copyright (c) 2004 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_MEDIA_BASE_VIDEOFRAME_H_
 #define WEBRTC_MEDIA_BASE_VIDEOFRAME_H_
 
 #include "webrtc/base/basictypes.h"
 #include "webrtc/base/stream.h"
 #include "webrtc/common_video/include/video_frame_buffer.h"
 #include "webrtc/common_video/rotation.h"
 
 namespace cricket {
 
 // Represents a YUV420 (a.k.a. I420) video frame.
+
+// TODO(nisse): This class duplicates webrtc::VideoFrame. There's
+// ongoing work to merge the classes. See
+// https://bugs.chromium.org/p/webrtc/issues/detail?id=5682.
 class VideoFrame {
  public:
   VideoFrame() {}

[nisse-webrtc, 2016/06/22 11:58:36]

Why does it even have a constructor? It's an abstract class.

   virtual ~VideoFrame() {}
 
   // Basic accessors.
   // Note this is the width and height without rotation applied.
   virtual int width() const = 0;
   virtual int height() const = 0;
 
   // Returns the underlying video frame buffer. This function is ok to call
   // multiple times, but the returned object will refer to the same memory.
   virtual const rtc::scoped_refptr<webrtc::VideoFrameBuffer>&
@@ skipping 12 matching lines @@
   virtual void SetTimeStamp(int64_t time_ns) {
     set_timestamp_us(time_ns / rtc::kNumNanosecsPerMicrosec);
   }
 
   // Indicates the rotation angle in degrees.
   virtual webrtc::VideoRotation rotation() const = 0;
 
   // Make a shallow copy of the frame. The frame buffer itself is not copied.
   // Both the current and new VideoFrame will share a single reference-counted
   // frame buffer.
+  // TODO(nisse): Should be deleted in the cricket::VideoFrame and

[pbos-webrtc, 2016/06/22 10:23:46]

Mark more clearly that they're deprecated and explain what users should use
instead. Here, below and the other files. Be clear about what any new users
should do.

[nisse-webrtc, 2016/06/22 11:01:48]

Problem is, that it's only clear that the methods are in the way, it's less
clear if and how the functionality will be replaced.

But I can try to add some per-method advice.

[nisse-webrtc, 2016/06/22 11:58:36]

Done.

+  // webrtc::VideoFrame merge.
   virtual VideoFrame *Copy() const = 0;
 
   // Return a copy of frame which has its pending rotation applied. The
   // ownership of the returned frame is held by this frame.
+
+  // TODO(nisse): Should be moved or deleted in the cricket::VideoFrame and
+  // webrtc::VideoFrame merge.
   virtual const VideoFrame* GetCopyWithRotationApplied() const = 0;
 
   // Converts the I420 data to RGB of a certain type such as ARGB and ABGR.
   // Returns the frame's actual size, regardless of whether it was written or
   // not (like snprintf). Parameters size and stride_rgb are in units of bytes.
   // If there is insufficient space, nothing is written.
+  // TODO(nisse): Should be moved or deleted in the cricket::VideoFrame and
+  // webrtc::VideoFrame merge.
   virtual size_t ConvertToRgbBuffer(uint32_t to_fourcc,
                                     uint8_t* buffer,
                                     size_t size,
                                     int stride_rgb) const;
 
-  // Tests if sample is valid.  Returns true if valid.
+  // Tests if sample is valid. Returns true if valid.
+  // TODO(nisse): Should be deleted in the cricket::VideoFrame and
+  // webrtc::VideoFrame merge. Validation of sample_size possibly moved to
+  // libyuv::ConvertToI420.
   static bool Validate(uint32_t fourcc,

[nisse-webrtc, 2016/06/22 11:58:36]

This method could probably be moved from public to protected right away. But I'd
prefer to have this cl change comments only.

                        int w,
                        int h,
                        const uint8_t* sample,
                        size_t sample_size);
 
  protected:
   // Creates an empty frame.
   virtual VideoFrame* CreateEmptyFrame(int w,
                                        int h,
                                        int64_t timestamp_us) const = 0;
 
   virtual void set_rotation(webrtc::VideoRotation rotation) = 0;
 };
 
 }  // namespace cricket
 
 #endif  // WEBRTC_MEDIA_BASE_VIDEOFRAME_H_