• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *  Copyright (c) 2013 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #ifndef WEBRTC_MODULES_DESKTOP_CAPTURE_SHARED_MEMORY_H_
12 #define WEBRTC_MODULES_DESKTOP_CAPTURE_SHARED_MEMORY_H_
13 
14 #include <stddef.h>
15 
16 #if defined(WEBRTC_WIN)
17 #include <windows.h>
18 #endif
19 
20 #include "webrtc/base/constructormagic.h"
21 #include "webrtc/typedefs.h"
22 
23 namespace webrtc {
24 
25 // SharedMemory is a base class for shared memory. It stores all required
26 // parameters of the buffer, but doesn't have any logic to allocate or destroy
27 // the actual buffer. DesktopCapturer consumers that need to use shared memory
28 // for video frames must extend this class with creation and destruction logic
29 // specific for the target platform and then implement
30 // DesktopCapturer::Delegate::CreateSharedMemory() as appropriate.
31 class SharedMemory {
32  public:
33 #if defined(WEBRTC_WIN)
34   typedef HANDLE Handle;
35   static const Handle kInvalidHandle;
36 #else
37   typedef int Handle;
38   static const Handle kInvalidHandle;
39 #endif
40 
data()41   void* data() const { return data_; }
size()42   size_t size() const { return size_; }
43 
44   // Platform-specific handle of the buffer.
handle()45   Handle handle() const { return handle_; }
46 
47   // Integer identifier that can be used used by consumers of DesktopCapturer
48   // interface to identify shared memory buffers it created.
id()49   int id() const { return id_; }
50 
~SharedMemory()51   virtual ~SharedMemory() {}
52 
53  protected:
54   SharedMemory(void* data, size_t size, Handle handle, int id);
55 
56   void* const data_;
57   const size_t size_;
58   const Handle handle_;
59   const int id_;
60 
61  private:
62   RTC_DISALLOW_COPY_AND_ASSIGN(SharedMemory);
63 };
64 
65 }  // namespace webrtc
66 
67 #endif  // WEBRTC_MODULES_DESKTOP_CAPTURE_SHARED_MEMORY_H_
68 
69