1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
// The MIT License (MIT)
//
// Copyright (c) 2015 Johan Johansson
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

//! Capture the screen with DXGI in rust

#![cfg(windows)]

#![allow(dead_code, non_snake_case)]

extern crate winapi;
extern crate dxgi_win;
extern crate d3d11_win;

use winapi::{ HRESULT, DWORD, RECT, HMONITOR, BOOL };
use dxgi_win::constants::*;
use dxgi_win::interfaces::*;
use dxgi_win::{ CreateDXGIFactory1, DXGI_OUTPUT_DESC, DXGI_MODE_ROTATION };
use d3d11_win::constants::*;
use d3d11_win::interfaces::*;
use d3d11_win::{ D3D11_USAGE, D3D11_CPU_ACCESS_FLAG, D3D_DRIVER_TYPE,
	D3D_FEATURE_LEVEL, D3D11CreateDevice };
use std::{ mem, slice, ptr };
use std::mem::zeroed;

#[repr(C)] struct MONITORINFO {
	cbSize: DWORD,
	rcMonitor: RECT,
	rcWork: RECT,
	dwFlags: DWORD,
}

#[link(name = "user32")]
extern "C" {
	fn GetMonitorInfoW(monitor: HMONITOR, monitor_info: *mut MONITORINFO) -> BOOL;
}

/// Color represented by additive channels: Blue (b), Green (g), Red (r), and Alpha (a).
#[derive(Copy, Clone, Debug, PartialOrd, PartialEq, Eq, Ord)]
pub struct BGRA8 {
	pub b: u8,
	pub g: u8,
	pub r: u8,
	pub a: u8,
}

/// A unique pointer to a COM object. Handles refcounting.
///
/// Similar to windows [CComQIPtr](https://msdn.microsoft.com/en-us/library/wc177dxw.aspx)
pub struct UniqueCOMPtr<T: COMInterface> {
	ptr: *mut T,
}
impl<T: COMInterface> UniqueCOMPtr<T> {
	/// Construct a new unique COM pointer from a pointer to a COM interface.
	/// It is the users responsibility to guarantee that no copies of the pointer exists beforehand
	pub unsafe fn new(ptr: *mut T) -> UniqueCOMPtr<T> {
		UniqueCOMPtr{ ptr: ptr }
	}

	// TODO: Use associated constant instead of explicit IID with `interface_identifier`
	/// Convert target interface by retrieving pointer to a supported interface of the object.
	///
	/// # Examples
	/// ```ignore
	/// let output = {
	///     let mut output_ptr = ptr::null_mut();
	///     adapter.EnumOutputs(0, &mut output_ptr);
	///     UniqueCOMPtr::new(output)
	/// };
	/// let output1 = output.query_interface::<IDXGIOutput1>();
	/// ```
	pub fn query_interface<U>(mut self) -> Result<UniqueCOMPtr<U>, HRESULT>
		where U: COMInterface + QueryIID
	{
		let mut interface = ptr::null_mut();
		let hr = unsafe { self.i_unknown_mut().QueryInterface(&U::iid(), &mut interface) };
		if hr_failed(hr) {
			Err(hr)
		} else {
			Ok(unsafe { UniqueCOMPtr::new(interface as *mut U) })
		}
	}
}
impl<T: COMInterface> std::ops::Deref for UniqueCOMPtr<T> {
	type Target = T;

	fn deref(&self) -> &T {
		unsafe { &*self.ptr }
	}
}
impl<T: COMInterface> std::ops::DerefMut for UniqueCOMPtr<T> {
	fn deref_mut(&mut self) -> &mut T {
		unsafe { &mut *self.ptr }
	}
}
impl<T: COMInterface> std::ops::Drop for UniqueCOMPtr<T> {
	fn drop(&mut self) {
		unsafe { self.i_unknown_mut().Release() };
	}
}
unsafe impl<T: COMInterface> Send for UniqueCOMPtr<T> { }

/// Possible errors when capturing
#[derive(Debug)]
pub enum CaptureError {
	/// Could not duplicate output, access denied. Might be in protected fullscreen.
	AccessDenied,
	/// Access to the duplicated output was lost. Likely, mode was changed e.g. window => full
	AccessLost,
	/// Error when trying to refresh outputs after some failure.
	RefreshFailure,
	/// AcquireNextFrame timed out.
	Timeout,
	/// General/Unexpected failure
	Fail(&'static str),
}

/// Check whether the HRESULT represents a failure
pub fn hr_failed(hr: HRESULT) -> bool { hr < 0 }

fn create_dxgi_factory_1() -> UniqueCOMPtr<IDXGIFactory1> {
	unsafe {
		let mut factory = ptr::null_mut();

		let hr = CreateDXGIFactory1(&IID_IDXGIFactory1, &mut factory);
		if hr_failed(hr) {
			panic!("Failed to create DXGIFactory1, {:x}", hr)
		} else {
			UniqueCOMPtr::new(factory as *mut IDXGIFactory1)
		}
	}
}

fn d3d11_create_device(adapter: &mut IDXGIAdapter)
	-> (UniqueCOMPtr<ID3D11Device>, UniqueCOMPtr<ID3D11DeviceContext>)
{
	unsafe {
		let (mut d3d11_device, mut device_context) = (ptr::null_mut(), ptr::null_mut());

		let hr = D3D11CreateDevice(adapter,
			D3D_DRIVER_TYPE::UNKNOWN,
			ptr::null_mut(), 0, ptr::null_mut(), 0,
			D3D11_SDK_VERSION,
			&mut d3d11_device,
			&mut D3D_FEATURE_LEVEL::FL_9_1,
			&mut device_context);
		if hr_failed(hr) {
			panic!("Failed to create d3d11 device and device context, {:x}", hr)
		} else {
			(UniqueCOMPtr::new(d3d11_device as *mut ID3D11Device),
				UniqueCOMPtr::new(device_context))
		}
	}
}

fn get_adater_outputs(adapter: &mut IDXGIAdapter1) -> Vec<UniqueCOMPtr<IDXGIOutput>> {
	(0..).map(|i| unsafe {
			let mut output = ptr::null_mut();
			if hr_failed(adapter.EnumOutputs(i, &mut output)) {
				None
			} else {
				let mut out_desc = zeroed();
				(*output).GetDesc(&mut out_desc);

				if out_desc.AttachedToDesktop != 0 {
					Some(UniqueCOMPtr::new(output))
				} else {
					None
				}
			}
		})
		.take_while(Option::is_some).map(Option::unwrap)
		.collect()
}

fn output_is_primary(output: &UniqueCOMPtr<IDXGIOutput1>) -> bool {
	unsafe {
		let mut output_desc = zeroed();
		(*output.ptr).GetDesc(&mut output_desc);

		let mut monitor_info: MONITORINFO = zeroed();
		monitor_info.cbSize = mem::size_of::<MONITORINFO>() as u32;
		GetMonitorInfoW(output_desc.Monitor, &mut monitor_info);

		(monitor_info.dwFlags & 1) != 0
	}
}

fn get_capture_source(
	output_dups: Vec<(UniqueCOMPtr<IDXGIOutputDuplication>, UniqueCOMPtr<IDXGIOutput1>)>,
	cs_index: usize)
	-> Option<(UniqueCOMPtr<IDXGIOutputDuplication>, UniqueCOMPtr<IDXGIOutput1>)>
{
	if cs_index == 0 {
		output_dups.into_iter().find(|&(_, ref out)| output_is_primary(out))
	} else {
		output_dups.into_iter()
			.filter(|&(_, ref out)| !output_is_primary(out))
			.nth(cs_index - 1)
	}
}

fn duplicate_outputs(device: UniqueCOMPtr<ID3D11Device>, outputs: Vec<UniqueCOMPtr<IDXGIOutput>>)
	-> (UniqueCOMPtr<ID3D11Device>,
		Vec<(UniqueCOMPtr<IDXGIOutputDuplication>, UniqueCOMPtr<IDXGIOutput1>)>)
{
	unsafe {
		outputs.into_iter()
			.map(|out| out.query_interface::<IDXGIOutput1>().unwrap())
			.fold((device, Vec::new()), |(device, mut out_dups), mut output| {
				let mut dxgi_device = device.query_interface::<IDXGIDevice1>().unwrap();

				let output_duplication = {
					let mut output_duplication = ptr::null_mut();
					assert_eq!(
						0,
						output.DuplicateOutput(
							(&mut dxgi_device as &mut IUnknown),
							&mut output_duplication));
					UniqueCOMPtr::new(output_duplication) };

				out_dups.push((output_duplication, output));
				(dxgi_device.query_interface().unwrap(), out_dups)
			})
	}
}

struct DuplicatedOutput {
	device: UniqueCOMPtr<ID3D11Device>,
	device_context: UniqueCOMPtr<ID3D11DeviceContext>,
	output: UniqueCOMPtr<IDXGIOutput1>,
	output_duplication: UniqueCOMPtr<IDXGIOutputDuplication>,
}
impl DuplicatedOutput {
	fn get_desc(&self) -> DXGI_OUTPUT_DESC {
		unsafe {
			let mut desc = zeroed();
			(*self.output.ptr).GetDesc(&mut desc);
			desc
		}
	}

	fn capture_frame_to_surface(&mut self, timeout_ms: u32) ->
		Result<UniqueCOMPtr<IDXGISurface1>, HRESULT>
	{
		let frame_resource = unsafe {
			let mut frame_resource = ptr::null_mut();
			let mut frame_info = zeroed();
			let hr = self.output_duplication
				.AcquireNextFrame(timeout_ms, &mut frame_info, &mut frame_resource);
			if hr_failed(hr) {
				return Err(hr);
			}
			UniqueCOMPtr::new(frame_resource)
		};

		let mut frame_texture: UniqueCOMPtr<ID3D11Texture2D> =
			frame_resource.query_interface().unwrap();

		let mut texture_desc = unsafe {
			let mut texture_desc = zeroed();
			frame_texture.GetDesc(&mut texture_desc);
			texture_desc
		};

		// Configure the description to make the texture readable
		texture_desc.Usage = D3D11_USAGE::STAGING;
		texture_desc.BindFlags = 0;
		texture_desc.CPUAccessFlags = D3D11_CPU_ACCESS_FLAG::READ as u32;
		texture_desc.MiscFlags = 0;

		let mut readable_texture = unsafe {
			let mut readable_texture = ptr::null_mut();
			let hr = self.device
				.CreateTexture2D(&mut texture_desc, ptr::null(), &mut readable_texture);
			if hr_failed(hr) {
				return Err(hr);
			}
			UniqueCOMPtr::new(readable_texture)
		};

		// Lower priorities causes stuff to be needlessly copied from gpu to ram,
		// causing huge fluxuations on some systems.
		unsafe { readable_texture.SetEvictionPriority(DXGI_RESOURCE_PRIORITY_MAXIMUM) };

		let mut readable_surface = readable_texture.query_interface().unwrap();

		unsafe {
			self.device_context.CopyResource(
				&mut *readable_surface,
				&mut *frame_texture.query_interface().unwrap());

			self.output_duplication.ReleaseFrame();
		}

		readable_surface.query_interface()
	}

	fn release_frame(&mut self) -> Result<(), HRESULT> {
		let hr = unsafe { self.output_duplication.ReleaseFrame() };
		if hr_failed(hr) {
			Err(hr)
		} else {
			Ok(())
		}
	}
}

/// Manager of DXGI duplicated outputs
pub struct DXGIManager {
	duplicated_output: Option<DuplicatedOutput>,
	capture_source_index: usize,
	timeout_ms: u32,
}
impl DXGIManager {
	/// Construct a new manager with capture timeout
	pub fn new(timeout_ms: u32) -> Result<DXGIManager, &'static str> {
		let mut manager = DXGIManager{
			duplicated_output: None,
			capture_source_index: 0,
			timeout_ms: timeout_ms
		};

		match manager.acquire_output_duplication() {
			Ok(_) => Ok(manager),
			Err(_) => Err("Failed to get outputs")
		}
	}

	/// Set index of capture source to capture from
	pub fn set_capture_source_index(&mut self, cs: usize) {
		self.capture_source_index = cs;
		self.acquire_output_duplication().unwrap()
	}

	pub fn get_capture_source_index(&self) -> usize {
		self.capture_source_index
	}

	/// Set timeout to use when capturing
	pub fn set_timeout_ms(&mut self, timeout_ms: u32) {
		self.timeout_ms = timeout_ms
	}

	/// Duplicate and acquire output selected by `capture_source_index`
	pub fn acquire_output_duplication(&mut self) -> Result<(), ()> {
		self.duplicated_output = None;

		let mut factory = create_dxgi_factory_1();

		for (outputs, mut adapter) in (0..).map(|i| {
				let mut adapter = ptr::null_mut();
				unsafe { if factory.EnumAdapters1(i, &mut adapter) != DXGI_ERROR_NOT_FOUND {
					Some( UniqueCOMPtr::new(adapter))
				} else {
					None
				}}
			})
			.take_while(Option::is_some).map(Option::unwrap)
			.map(|mut adapter| (get_adater_outputs(&mut adapter), adapter))
			.filter(|&(ref outs, _)| !outs.is_empty())
		{
			// Creating device for each adapter that has the output
			let (d3d11_device, device_context) = d3d11_create_device(&mut *adapter);

			let (d3d11_device, output_duplications) = duplicate_outputs(d3d11_device, outputs);

			if let Some((output_duplication, output)) =
				get_capture_source(output_duplications, self.capture_source_index)
			{
				self.duplicated_output = Some(DuplicatedOutput{
					device: d3d11_device,
					device_context: device_context,
					output: output,
					output_duplication: output_duplication
				});
				return Ok(())
			}
		}

		Err(())
	}

	fn capture_frame_to_surface(&mut self) -> Result<UniqueCOMPtr<IDXGISurface1>, CaptureError> {
		if let None = self.duplicated_output {
			if let Ok(_) = self.acquire_output_duplication() {
				return Err(CaptureError::Fail("No valid duplicated output"))
			} else {
				return Err(CaptureError::RefreshFailure)
			}
		}

		let timeout_ms = self.timeout_ms;

		match self.duplicated_output.as_mut().unwrap().capture_frame_to_surface(timeout_ms) {
			Ok(surface) => Ok(surface),
			Err(DXGI_ERROR_ACCESS_LOST) => if let Ok(_) = self.acquire_output_duplication() {
				Err(CaptureError::AccessLost)
			} else {
				Err(CaptureError::RefreshFailure) },
			Err(E_ACCESSDENIED) => Err(CaptureError::AccessDenied),
			Err(DXGI_ERROR_WAIT_TIMEOUT) => Err(CaptureError::Timeout),
			Err(_) => if let Ok(_) = self.acquire_output_duplication() {
				Err(CaptureError::Fail("Failure when acquiring frame"))
			} else {
				Err(CaptureError::RefreshFailure)
			}
		}
	}

	/// Capture a frame
	///
	/// On success, return Vec with pixels and width and height of frame.
	/// On failure, return CaptureError.
	pub fn capture_frame(&mut self) -> Result<(Vec<BGRA8>, (usize, usize)), CaptureError> {
		let mut frame_surface = match self.capture_frame_to_surface() {
			Ok(surface) => surface,
			Err(e) => return Err(e)
		};

		let mapped_surface = unsafe {
			let mut mapped_surface = zeroed();
			if hr_failed(frame_surface.Map(&mut mapped_surface, DXGI_MAP_READ)) {
				frame_surface.Release();
				return Err(CaptureError::Fail("Failed to map surface"));
			}
			mapped_surface
		};

		let output_desc = self.duplicated_output.as_mut().unwrap().get_desc();
		let (output_width, output_height) = {
			let RECT{ left, top, right, bottom } = output_desc.DesktopCoordinates;
			((right - left) as usize, (bottom - top) as usize)
		};

		let map_pitch_n_pixels = mapped_surface.Pitch as usize / mem::size_of::<BGRA8>() as usize;
		let mut pixel_buf = Vec::with_capacity(output_width * output_height);

		let pixel_index: Box<Fn(usize, usize) -> usize> = match output_desc.Rotation {
			DXGI_MODE_ROTATION::IDENTITY | DXGI_MODE_ROTATION::UNSPECIFIED => Box::new(
				|row, col| row * map_pitch_n_pixels + col),
			DXGI_MODE_ROTATION::ROTATE90 => Box::new(
				|row, col| (output_width-1-col) * map_pitch_n_pixels + row),
			DXGI_MODE_ROTATION::ROTATE180 => Box::new(
				|row, col| (output_height-1-row) * map_pitch_n_pixels + (output_width-col-1)),
			DXGI_MODE_ROTATION::ROTATE270 => Box::new(
				|row, col| col * map_pitch_n_pixels + (output_height-row-1))
		};

		let mapped_pixels = unsafe { slice::from_raw_parts(
			mapped_surface.pBits as *mut BGRA8,
			output_width * output_height * map_pitch_n_pixels) };

		for row in 0..output_height {
			for col in 0..output_width {
				pixel_buf.push(mapped_pixels[pixel_index(row, col)]);
			}
		}

		unsafe { frame_surface.Unmap() };

		Ok((pixel_buf, (output_width, output_height)))
	}
}

#[test]
fn test() {
	let mut manager = DXGIManager::new(200).unwrap();
	for _ in 0..10 {
		match manager.capture_frame() {
			Ok((pixels, (_, _))) => {
				let len = pixels.len() as u64;
				let (r, g, b) = pixels.into_iter()
					.fold((0u64, 0u64, 0u64), |(r, g, b), p|
						(r+p.r as u64, g+p.g as u64, b+p.b as u64));
				println!("avg: {} {} {}", r/len, g/len, b/len)
			},
			Err(e) => println!("error: {:?}", e)
		}
	}
}