Mir
buffer_stream.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2015 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Robert Carr <robert.carr@canonical.com>
17  */
18 
19 #ifndef MIR_CLIENT_BUFFER_STREAM_H
20 #define MIR_CLIENT_BUFFER_STREAM_H
21 
22 #include "mir_wait_handle.h"
23 #include "mir/egl_native_surface.h"
24 #include "mir/client_buffer.h"
25 #include "client_buffer_stream.h"
27 #include "mir/geometry/size.h"
28 
30 
31 #include <EGL/eglplatform.h>
32 
33 #include <queue>
34 #include <memory>
35 #include <mutex>
36 
37 namespace mir
38 {
39 namespace logging
40 {
41 class Logger;
42 }
43 namespace protobuf
44 {
45 class BufferStream;
46 class BufferStreamParameters;
47 class Void;
48 }
49 namespace client
50 {
51 namespace rpc
52 {
53 class DisplayServer;
54 }
56 class ClientBuffer;
57 class ClientPlatform;
58 class PerfReport;
59 struct MemoryRegion;
60 
62 {
63 Producer, // As in surfaces
64 Consumer // As in screencasts
65 };
66 
67 class ServerBufferSemantics;
69 {
70 public:
72  MirConnection* connection,
74  BufferStreamMode mode,
75  std::shared_ptr<ClientPlatform> const& native_window_factory,
76  mir::protobuf::BufferStream const& protobuf_bs,
77  std::shared_ptr<PerfReport> const& perf_report,
78  std::string const& surface_name,
79  geometry::Size ideal_size);
80  // For surfaceless buffer streams
82  MirConnection* connection,
84  std::shared_ptr<ClientPlatform> const& native_window_factory,
85  mir::protobuf::BufferStreamParameters const& parameters,
86  std::shared_ptr<PerfReport> const& perf_report,
88  void *context);
89 
90  virtual ~BufferStream();
91 
93  MirWaitHandle *release(mir_buffer_stream_callback callback, void* context) override;
94 
95  MirWaitHandle* next_buffer(std::function<void()> const& done) override;
96  std::shared_ptr<mir::client::ClientBuffer> get_current_buffer() override;
97  // Required by debug API
98  uint32_t get_current_buffer_id() override;
99 
100  int swap_interval() const override;
101  MirWaitHandle* set_swap_interval(int interval) override;
102  void set_buffer_cache_size(unsigned int) override;
103 
104  EGLNativeWindowType egl_native_window() override;
105  std::shared_ptr<MemoryRegion> secure_for_cpu_write() override;
106 
107  // mcl::EGLNativeSurface interface
108  MirSurfaceParameters get_parameters() const override;
109  void request_and_wait_for_next_buffer() override;
110 
111  void request_and_wait_for_configure(MirSurfaceAttrib attrib, int) override;
112 
114 
115  MirPlatformType platform_type() override;
116 
117  frontend::BufferStreamId rpc_id() const override;
118  bool valid() const override;
119 
120  void buffer_available(mir::protobuf::Buffer const& buffer) override;
121  void buffer_unavailable() override;
122  void set_size(geometry::Size) override;
123  MirWaitHandle* set_scale(float scale) override;
124 protected:
125  BufferStream(BufferStream const&) = delete;
126  BufferStream& operator=(BufferStream const&) = delete;
127 
128 private:
129  void created(mir_buffer_stream_callback callback, void* context);
130  void process_buffer(protobuf::Buffer const& buffer);
131  void process_buffer(protobuf::Buffer const& buffer, std::unique_lock<std::mutex> const&);
132  void screencast_buffer_received(std::function<void()> done);
133  void on_swap_interval_set(int interval);
134  void on_scale_set(float scale);
135  void release_cpu_region();
136 
137  mutable std::mutex mutex; // Protects all members of *this
138 
139  MirConnection* connection;
140  mir::client::rpc::DisplayServer& display_server;
141 
142  BufferStreamMode const mode;
143  std::shared_ptr<ClientPlatform> const client_platform;
144 
145  std::unique_ptr<mir::protobuf::BufferStream> protobuf_bs;
146 
147  int swap_interval_;
148  float scale_;
149 
150  std::shared_ptr<mir::client::PerfReport> const perf_report;
151 
152  std::shared_ptr<EGLNativeWindowType> egl_native_window_;
153 
154  MirWaitHandle create_wait_handle;
155  MirWaitHandle release_wait_handle;
156  MirWaitHandle screencast_wait_handle;
157  MirWaitHandle interval_wait_handle;
158  MirWaitHandle scale_wait_handle;
159  std::unique_ptr<mir::protobuf::Void> protobuf_void;
160 
161  std::shared_ptr<MemoryRegion> secured_region;
162 
163  geometry::Size cached_buffer_size;
164 
165  std::unique_ptr<ServerBufferSemantics> buffer_depository;
166  geometry::Size ideal_buffer_size;
167 };
168 
169 }
170 }
171 
172 #endif // MIR_CLIENT_BUFFER_STREAM_H
Definition: size.h:30
All things Mir.
Definition: atomic_callback.h:25
bool valid() const override
Definition: buffer_stream.cpp:639
A factory for creating client-side representations of graphics buffers.
Definition: client_buffer_factory.h:38
BufferStreamMode
Definition: buffer_stream.h:61
MirWaitHandle * set_swap_interval(int interval) override
Definition: buffer_stream.cpp:590
EGLNativeWindowType egl_native_window() override
Definition: buffer_stream.cpp:504
Definition: mir_wait_handle.h:31
void(* mir_buffer_stream_callback)(MirBufferStream *stream, void *client_context)
Callback to be passed when calling:
Definition: client_types.h:84
Definition: buffer_stream.h:64
virtual ~BufferStream()
Definition: buffer_stream.cpp:430
Definition: buffer_stream.h:68
std::shared_ptr< MemoryRegion > secure_for_cpu_write() override
Definition: buffer_stream.cpp:515
MirWaitHandle * next_buffer(std::function< void()> const &done) override
Definition: buffer_stream.cpp:464
void request_and_wait_for_configure(MirSurfaceAttrib attrib, int) override
Definition: buffer_stream.cpp:563
MirPlatformType platform_type() override
Definition: buffer_stream.cpp:613
Definition: mir_native_buffer.h:30
void buffer_unavailable() override
Definition: buffer_stream.cpp:657
BufferStream(MirConnection *connection, mir::client::rpc::DisplayServer &server, BufferStreamMode mode, std::shared_ptr< ClientPlatform > const &native_window_factory, mir::protobuf::BufferStream const &protobuf_bs, std::shared_ptr< PerfReport > const &perf_report, std::string const &surface_name, geometry::Size ideal_size)
Definition: logger.h:41
MirWaitHandle * get_create_wait_handle() override
Definition: buffer_stream.cpp:618
Definition: egl_native_surface.h:31
Definition: client_buffer.h:43
MirSurfaceAttrib
Attributes of a surface that the client and server/shell may wish to get or set over the wire...
Definition: common.h:34
Definition: perf_report.h:27
void request_and_wait_for_next_buffer() override
Definition: buffer_stream.cpp:544
MirWaitHandle * release(mir_buffer_stream_callback callback, void *context) override
Definition: buffer_stream.cpp:623
void set_buffer_cache_size(unsigned int) override
Definition: buffer_stream.cpp:645
Definition: client_buffer_stream.h:45
Interface to client-side platform specific support for graphics operations.
Definition: client_platform.h:42
BufferStream & operator=(BufferStream const &)=delete
Definition: mir_connection.h:88
Definition: client_buffer.h:52
int swap_interval() const override
Definition: buffer_stream.cpp:584
void buffer_available(mir::protobuf::Buffer const &buffer) override
Definition: buffer_stream.cpp:651
MirWaitHandle * set_scale(float scale) override
Definition: buffer_stream.cpp:668
std::shared_ptr< mir::client::ClientBuffer > get_current_buffer() override
Definition: buffer_stream.cpp:498
uint32_t get_current_buffer_id() override
Definition: buffer_stream.cpp:578
Definition: buffer_stream.h:63
MirSurfaceParameters get_parameters() const override
Definition: buffer_stream.cpp:532
MirPlatformType
The native buffer type for the system the client is connected on.
Definition: client_types.h:180
MirNativeBuffer * get_current_buffer_package() override
Definition: buffer_stream.cpp:606
frontend::BufferStreamId rpc_id() const override
Definition: buffer_stream.cpp:632
Definition: mir_display_server.h:33
MirSurfaceParameters is the structure of minimum required information that you must provide to Mir in...
Definition: client_types.h:157
void set_size(geometry::Size) override
Definition: buffer_stream.cpp:663

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015