webrtc/modules/desktop_capture/shared_desktop_frame.h
Mirko Bonadei d970807e0c Remove rtc_base/scoped_ref_ptr.h.
The type rtc::scoped_refptr<T> is now part of api/. Please include it from
api/scoped_refptr.h.

More info: See: https://groups.google.com/forum/#!topic/discuss-webrtc/Mme2MSz4z4o.

Bug: webrtc:9887, webrtc:8205
No-Try: True
Change-Id: Ic6c7c81e226e59f12f7933e472f573ae097b55bf
Reviewed-on: https://webrtc-review.googlesource.com/c/119041
Commit-Queue: Mirko Bonadei <mbonadei@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#26414}
2019-01-25 20:29:58 +00:00

65 lines
2.1 KiB
C++

/*
* Copyright (c) 2013 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 MODULES_DESKTOP_CAPTURE_SHARED_DESKTOP_FRAME_H_
#define MODULES_DESKTOP_CAPTURE_SHARED_DESKTOP_FRAME_H_
#include <memory>
#include "api/scoped_refptr.h"
#include "modules/desktop_capture/desktop_frame.h"
#include "rtc_base/constructor_magic.h"
#include "rtc_base/ref_counted_object.h"
#include "rtc_base/system/rtc_export.h"
namespace webrtc {
// SharedDesktopFrame is a DesktopFrame that may have multiple instances all
// sharing the same buffer.
class RTC_EXPORT SharedDesktopFrame : public DesktopFrame {
public:
~SharedDesktopFrame() override;
static std::unique_ptr<SharedDesktopFrame> Wrap(
std::unique_ptr<DesktopFrame> desktop_frame);
// Deprecated.
// TODO(sergeyu): remove this method.
static SharedDesktopFrame* Wrap(DesktopFrame* desktop_frame);
// Deprecated. Clients do not need to know the underlying DesktopFrame
// instance.
// TODO(zijiehe): Remove this method.
// Returns the underlying instance of DesktopFrame.
DesktopFrame* GetUnderlyingFrame();
// Returns whether |this| and |other| share the underlying DesktopFrame.
bool ShareFrameWith(const SharedDesktopFrame& other) const;
// Creates a clone of this object.
std::unique_ptr<SharedDesktopFrame> Share();
// Checks if the frame is currently shared. If it returns false it's
// guaranteed that there are no clones of the object.
bool IsShared();
private:
typedef rtc::RefCountedObject<std::unique_ptr<DesktopFrame>> Core;
SharedDesktopFrame(rtc::scoped_refptr<Core> core);
const rtc::scoped_refptr<Core> core_;
RTC_DISALLOW_COPY_AND_ASSIGN(SharedDesktopFrame);
};
} // namespace webrtc
#endif // MODULES_DESKTOP_CAPTURE_SHARED_DESKTOP_FRAME_H_