d3d11compositor: Performance optimization
[platform/upstream/gstreamer.git] / subprojects / gst-plugins-bad / sys / d3d11 / plugin.cpp
1 /* GStreamer
2  * Copyright (C) 2019 Seungha Yang <seungha.yang@navercorp.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 /**
21  * SECTION:plugin-d3d11
22  *
23  * Microsoft Direct3D11 plugin.
24  *
25  * This plugin consists of various video filter, screen capture source,
26  * video sink, and video decoder elements.
27  *
28  * GstD3D11 plugin supports H.264/AVC, H.265/HEVC, VP8, VP9, H.262/MPEG-2 video,
29  * and AV1 codecs for decoding as well as hardware-accelerated video
30  * deinterlacing. Note that minimum required OS version for video decoder and
31  * deinterlacing elements is Windows 8.
32  *
33  * Plugin feature names of decoders:
34  * - d3d11h264dec
35  * - d3d11h265dec
36  * - d3d11vp8dec
37  * - d3d11vp9dec
38  * - d3d11mpeg2dec
39  * - d3d11av1dec
40  *
41  * Similar to the video decoder case, deinterlacing element would be registered
42  * only if its supported by hardware with the feature name `d3d11deinterlace`
43  *
44  * However, depending on the hardware it runs on, some elements might not be
45  * registered in case that underlying hardware doesn't support the feature.
46  * For a system with multiple Direct3D11 compatible hardwares (i.e., GPU),
47  * there can be multiple plugin features having the same role.
48  * The naming rule for the non-primary decoder element is
49  * `d3d11{codec}device{index}dec` where `index` is an arbitrary index number of
50  * hardware starting from 1.
51  *
52  * To get a list of all available elements, user can run
53  * ```sh
54  * gst-inspect-1.0.exe d3d11
55  * ```
56  *
57  */
58
59 #ifdef HAVE_CONFIG_H
60 #include "config.h"
61 #endif
62
63 #include <gst/gst.h>
64 #include <gst/d3d11/gstd3d11.h>
65 #include "gstd3d11videosink.h"
66 #include "gstd3d11upload.h"
67 #include "gstd3d11download.h"
68 #include "gstd3d11convert.h"
69 #include "gstd3d11shader.h"
70 #include "gstd3d11compositor.h"
71 #include "gstd3d11h264dec.h"
72 #include "gstd3d11h265dec.h"
73 #include "gstd3d11vp9dec.h"
74 #include "gstd3d11vp8dec.h"
75 #include "gstd3d11mpeg2dec.h"
76 #include "gstd3d11av1dec.h"
77 #include "gstd3d11deinterlace.h"
78 #include "gstd3d11testsrc.h"
79
80 #if !GST_D3D11_WINAPI_ONLY_APP
81 #include "gstd3d11screencapturesrc.h"
82 #include "gstd3d11screencapturedevice.h"
83 #endif
84
85 GST_DEBUG_CATEGORY (gst_d3d11_debug);
86 GST_DEBUG_CATEGORY (gst_d3d11_shader_debug);
87 GST_DEBUG_CATEGORY (gst_d3d11_plugin_utils_debug);
88 GST_DEBUG_CATEGORY (gst_d3d11_format_debug);
89 GST_DEBUG_CATEGORY (gst_d3d11_device_debug);
90 GST_DEBUG_CATEGORY (gst_d3d11_overlay_compositor_debug);
91 GST_DEBUG_CATEGORY (gst_d3d11_window_debug);
92 GST_DEBUG_CATEGORY (gst_d3d11_video_processor_debug);
93 GST_DEBUG_CATEGORY (gst_d3d11_decoder_debug);
94 GST_DEBUG_CATEGORY (gst_d3d11_h264_dec_debug);
95 GST_DEBUG_CATEGORY (gst_d3d11_h265_dec_debug);
96 GST_DEBUG_CATEGORY (gst_d3d11_vp9_dec_debug);
97 GST_DEBUG_CATEGORY (gst_d3d11_vp8_dec_debug);
98 GST_DEBUG_CATEGORY (gst_d3d11_mpeg2_dec_debug);
99 GST_DEBUG_CATEGORY (gst_d3d11_av1_dec_debug);
100 GST_DEBUG_CATEGORY (gst_d3d11_deinterlace_debug);
101
102 #if !GST_D3D11_WINAPI_ONLY_APP
103 GST_DEBUG_CATEGORY (gst_d3d11_screen_capture_debug);
104 GST_DEBUG_CATEGORY (gst_d3d11_screen_capture_device_debug);
105 #endif
106
107 #define GST_CAT_DEFAULT gst_d3d11_debug
108
109 static gboolean
110 plugin_init (GstPlugin * plugin)
111 {
112   GstRank video_sink_rank = GST_RANK_PRIMARY;
113   D3D_FEATURE_LEVEL max_feature_level = D3D_FEATURE_LEVEL_9_3;
114   guint i;
115
116   GST_DEBUG_CATEGORY_INIT (gst_d3d11_debug, "d3d11", 0, "direct3d 11 plugin");
117   GST_DEBUG_CATEGORY_INIT (gst_d3d11_shader_debug,
118       "d3d11shader", 0, "d3d11shader");
119   GST_DEBUG_CATEGORY_INIT (gst_d3d11_plugin_utils_debug,
120       "d3d11pluginutils", 0, "d3d11 plugin utility functions");
121   GST_DEBUG_CATEGORY_INIT (gst_d3d11_overlay_compositor_debug,
122       "d3d11overlaycompositor", 0, "d3d11overlaycompositor");
123   GST_DEBUG_CATEGORY_INIT (gst_d3d11_window_debug,
124       "d3d11window", 0, "d3d11window");
125   GST_DEBUG_CATEGORY_INIT (gst_d3d11_video_processor_debug,
126       "d3d11videoprocessor", 0, "d3d11videoprocessor");
127
128   if (!gst_d3d11_shader_init ()) {
129     GST_WARNING ("Cannot initialize d3d11 shader");
130     return TRUE;
131   }
132
133   /* DXVA2 API is availble since Windows 8 */
134   if (gst_d3d11_is_windows_8_or_greater ()) {
135     GST_DEBUG_CATEGORY_INIT (gst_d3d11_decoder_debug,
136         "d3d11decoder", 0, "Direct3D11 Video Decoder object");
137     GST_DEBUG_CATEGORY_INIT (gst_d3d11_h264_dec_debug,
138         "d3d11h264dec", 0, "Direct3D11 H.264 Video Decoder");
139     GST_DEBUG_CATEGORY_INIT (gst_d3d11_vp9_dec_debug,
140         "d3d11vp9dec", 0, "Direct3D11 VP9 Video Decoder");
141     GST_DEBUG_CATEGORY_INIT (gst_d3d11_h265_dec_debug,
142         "d3d11h265dec", 0, "Direct3D11 H.265 Video Decoder");
143     GST_DEBUG_CATEGORY_INIT (gst_d3d11_vp8_dec_debug,
144         "d3d11vp8dec", 0, "Direct3D11 VP8 Decoder");
145     GST_DEBUG_CATEGORY_INIT (gst_d3d11_mpeg2_dec_debug,
146         "d3d11mpeg2dec", 0, "Direct3D11 MPEG2 Decoder");
147     GST_DEBUG_CATEGORY_INIT (gst_d3d11_av1_dec_debug,
148         "d3d11av1dec", 0, "Direct3D11 AV1 Decoder");
149     GST_DEBUG_CATEGORY_INIT (gst_d3d11_deinterlace_debug,
150         "d3d11deinterlace", 0, "Direct3D11 Deinterlacer");
151   }
152
153   /* Enumerate devices to register decoders per device and to get the highest
154    * feature level */
155   /* AMD seems supporting up to 12 cards, and 8 for NVIDIA */
156   for (i = 0; i < 12; i++) {
157     GstD3D11Device *device = NULL;
158     ID3D11Device *device_handle;
159     D3D_FEATURE_LEVEL feature_level;
160
161     device = gst_d3d11_device_new (i, D3D11_CREATE_DEVICE_BGRA_SUPPORT);
162     if (!device)
163       break;
164
165     device_handle = gst_d3d11_device_get_device_handle (device);
166     feature_level = device_handle->GetFeatureLevel ();
167
168     if (feature_level > max_feature_level)
169       max_feature_level = feature_level;
170
171     /* DXVA2 API is availble since Windows 8 */
172     if (gst_d3d11_is_windows_8_or_greater () &&
173         gst_d3d11_device_get_video_device_handle (device)) {
174       gboolean legacy = gst_d3d11_decoder_util_is_legacy_device (device);
175
176       /* avdec_h264 has primary rank, make this higher than it */
177       gst_d3d11_h264_dec_register (plugin,
178           device, GST_RANK_PRIMARY + 1, legacy);
179       if (!legacy) {
180         /* avdec_h265 has primary rank, make this higher than it */
181         gst_d3d11_h265_dec_register (plugin, device, GST_RANK_PRIMARY + 1);
182         gst_d3d11_vp9_dec_register (plugin, device, GST_RANK_PRIMARY);
183         gst_d3d11_vp8_dec_register (plugin, device, GST_RANK_PRIMARY);
184         gst_d3d11_av1_dec_register (plugin, device, GST_RANK_PRIMARY);
185         gst_d3d11_mpeg2_dec_register (plugin, device, GST_RANK_SECONDARY);
186       }
187
188       gst_d3d11_deinterlace_register (plugin, device, GST_RANK_MARGINAL);
189     }
190
191     gst_object_unref (device);
192   }
193
194   /* FIXME: Our shader code is not compatible with D3D_FEATURE_LEVEL_9_3
195    * or lower. So HLSL compiler cannot understand our shader code and
196    * therefore d3d11colorconverter cannot be configured.
197    *
198    * Known D3D_FEATURE_LEVEL_9_3 driver is
199    * "VirtualBox Graphics Adapter (WDDM)"
200    * ... and there might be some more old physical devices which don't support
201    * D3D_FEATURE_LEVEL_10_0.
202    */
203   if (max_feature_level < D3D_FEATURE_LEVEL_10_0)
204     video_sink_rank = GST_RANK_NONE;
205
206   gst_d3d11_plugin_utils_init (max_feature_level);
207
208   gst_element_register (plugin,
209       "d3d11upload", GST_RANK_NONE, GST_TYPE_D3D11_UPLOAD);
210   gst_element_register (plugin,
211       "d3d11download", GST_RANK_NONE, GST_TYPE_D3D11_DOWNLOAD);
212   gst_element_register (plugin,
213       "d3d11convert", GST_RANK_NONE, GST_TYPE_D3D11_CONVERT);
214   gst_element_register (plugin,
215       "d3d11colorconvert", GST_RANK_NONE, GST_TYPE_D3D11_COLOR_CONVERT);
216   gst_element_register (plugin,
217       "d3d11scale", GST_RANK_NONE, GST_TYPE_D3D11_SCALE);
218   gst_element_register (plugin,
219       "d3d11videosink", video_sink_rank, GST_TYPE_D3D11_VIDEO_SINK);
220
221   gst_element_register (plugin,
222       "d3d11compositor", GST_RANK_SECONDARY, GST_TYPE_D3D11_COMPOSITOR);
223   gst_element_register (plugin,
224       "d3d11testsrc", GST_RANK_NONE, GST_TYPE_D3D11_TEST_SRC);
225
226 #if !GST_D3D11_WINAPI_ONLY_APP
227   if (gst_d3d11_is_windows_8_or_greater ()) {
228     GST_DEBUG_CATEGORY_INIT (gst_d3d11_screen_capture_debug,
229         "d3d11screencapturesrc", 0, "d3d11screencapturesrc");
230     GST_DEBUG_CATEGORY_INIT (gst_d3d11_screen_capture_device_debug,
231         "d3d11screencapturedevice", 0, "d3d11screencapturedevice");
232
233     gst_element_register (plugin,
234         "d3d11screencapturesrc", GST_RANK_NONE,
235         GST_TYPE_D3D11_SCREEN_CAPTURE_SRC);
236     gst_device_provider_register (plugin,
237         "d3d11screencapturedeviceprovider", GST_RANK_PRIMARY,
238         GST_TYPE_D3D11_SCREEN_CAPTURE_DEVICE_PROVIDER);
239   }
240 #endif
241
242   return TRUE;
243 }
244
245 GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
246     GST_VERSION_MINOR,
247     d3d11,
248     "Direct3D11 plugin",
249     plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN)