1 /*****************************************************************************
2 * direct3d.c: Windows Direct3D video output module
3 *****************************************************************************
4 * Copyright (C) 2006-2009 the VideoLAN team
7 * Authors: Damien Fouilleul <damienf@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
27 * This plugin will use YUV surface if supported, using YUV will result in
28 * the best video quality (hardware filering when rescaling the picture)
29 * and the fastest display as it requires less processing.
31 * If YUV overlay is not supported this plugin will use RGB offscreen video
32 * surfaces that will be blitted onto the primary surface (display) to
33 * effectively display the pictures.
35 *****************************************************************************/
40 #include <vlc_common.h>
41 #include <vlc_plugin.h>
42 #include <vlc_playlist.h>
43 #include <vlc_vout_display.h>
50 /*****************************************************************************
52 *****************************************************************************/
53 static int OpenVideoXP(vlc_object_t *);
54 static int OpenVideoVista(vlc_object_t *);
55 static void Close(vlc_object_t *);
57 #define DESKTOP_TEXT N_("Enable desktop mode ")
58 #define DESKTOP_LONGTEXT N_(\
59 "The desktop mode allows you to display the video on the desktop.")
61 #define HW_BLENDING_TEXT N_("Use hardware blending support")
62 #define HW_BLENDING_LONGTEXT N_(\
63 "Try to use hardware acceleration for subtitles/OSD blending.")
65 #define D3D_HELP N_("Recommended video output for Windows Vista and later versions")
68 set_shortname("Direct3D")
69 set_description(N_("Direct3D video output"))
71 set_category(CAT_VIDEO)
72 set_subcategory(SUBCAT_VIDEO_VOUT)
74 add_bool("direct3d-desktop", false, DESKTOP_TEXT, DESKTOP_LONGTEXT, true)
75 add_bool("direct3d-hw-blending", true, HW_BLENDING_TEXT, HW_BLENDING_LONGTEXT, true)
77 set_capability("vout display", 240)
78 add_shortcut("direct3d")
79 set_callbacks(OpenVideoVista, Close)
82 set_description(N_("Direct3D video output (XP)"))
83 set_capability("vout display", 220)
84 add_shortcut("direct3d_xp")
85 set_callbacks(OpenVideoXP, Close)
89 /*****************************************************************************
91 *****************************************************************************/
92 static const vlc_fourcc_t d3d_subpicture_chromas[] = {
99 LPDIRECT3DSURFACE9 surface;
103 static int Open(vlc_object_t *);
105 static picture_pool_t *Pool (vout_display_t *, unsigned);
106 static void Prepare(vout_display_t *, picture_t *, subpicture_t *subpicture);
107 static void Display(vout_display_t *, picture_t *, subpicture_t *subpicture);
108 static int Control(vout_display_t *, int, va_list);
109 static void Manage (vout_display_t *);
111 static int Direct3DCreate (vout_display_t *);
112 static int Direct3DReset (vout_display_t *);
113 static void Direct3DDestroy(vout_display_t *);
115 static int Direct3DOpen (vout_display_t *, video_format_t *);
116 static void Direct3DClose(vout_display_t *);
121 FLOAT x,y,z; // vertex untransformed position
122 FLOAT rhw; // eye distance
123 D3DCOLOR diffuse; // diffuse color
124 FLOAT tu, tv; // texture relative coordinates
126 #define D3DFVF_CUSTOMVERTEX (D3DFVF_XYZRHW|D3DFVF_DIFFUSE|D3DFVF_TEX1)
128 typedef struct d3d_region_t {
132 CUSTOMVERTEX vertex[4];
133 LPDIRECT3DTEXTURE9 texture;
136 static void Direct3DDeleteRegions(int, d3d_region_t *);
138 static int Direct3DImportPicture(vout_display_t *vd, d3d_region_t *, LPDIRECT3DSURFACE9 surface);
139 static void Direct3DImportSubpicture(vout_display_t *vd, int *, d3d_region_t **, subpicture_t *);
141 static void Direct3DRenderScene(vout_display_t *vd, d3d_region_t *, int, d3d_region_t *);
144 static int DesktopCallback(vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *);
147 * It creates a Direct3D vout display.
149 static int Open(vlc_object_t *object)
151 vout_display_t *vd = (vout_display_t *)object;
152 vout_display_sys_t *sys;
154 /* Allocate structure */
155 vd->sys = sys = calloc(1, sizeof(vout_display_sys_t));
159 if (Direct3DCreate(vd)) {
160 msg_Err(vd, "Direct3D could not be initialized");
166 sys->use_desktop = var_CreateGetBool(vd, "direct3d-desktop");
167 sys->reset_device = false;
168 sys->reset_device = false;
169 sys->allow_hw_yuv = var_CreateGetBool(vd, "directx-hw-yuv");
170 sys->desktop_save.is_fullscreen = vd->cfg->is_fullscreen;
171 sys->desktop_save.is_on_top = false;
172 sys->desktop_save.win.left = var_InheritInteger(vd, "video-x");
173 sys->desktop_save.win.right = vd->cfg->display.width;
174 sys->desktop_save.win.top = var_InheritInteger(vd, "video-y");
175 sys->desktop_save.win.bottom = vd->cfg->display.height;
182 if (Direct3DOpen(vd, &fmt)) {
183 msg_Err(vd, "Direct3D could not be opened");
188 vout_display_info_t info = vd->info;
190 info.has_double_click = true;
191 info.has_hide_mouse = false;
192 info.has_pictures_invalid = true;
193 info.has_event_thread = true;
194 if (var_InheritBool(vd, "direct3d-hw-blending") &&
195 (sys->d3dcaps.SrcBlendCaps & D3DPBLENDCAPS_SRCALPHA) &&
196 (sys->d3dcaps.DestBlendCaps & D3DPBLENDCAPS_INVSRCALPHA) &&
197 (sys->d3dcaps.TextureCaps & D3DPTEXTURECAPS_ALPHA) &&
198 (sys->d3dcaps.TextureOpCaps & D3DTEXOPCAPS_SELECTARG1) &&
199 (sys->d3dcaps.TextureOpCaps & D3DTEXOPCAPS_MODULATE))
200 info.subpicture_chromas = d3d_subpicture_chromas;
202 info.subpicture_chromas = NULL;
205 vlc_mutex_init(&sys->lock);
206 sys->ch_desktop = false;
207 sys->desktop_requested = sys->use_desktop;
210 val.psz_string = _("Desktop");
211 var_Change(vd, "direct3d-desktop", VLC_VAR_SETTEXT, &val, NULL);
212 var_AddCallback(vd, "direct3d-desktop", DesktopCallback, NULL);
214 /* Setup vout_display now that everything is fine */
219 vd->prepare = Prepare;
220 vd->display = Display;
221 vd->control = Control;
224 /* Fix state in case of desktop mode */
225 if (sys->use_desktop && vd->cfg->is_fullscreen)
226 vout_display_SendEventFullscreen(vd, false);
237 static bool IsVistaOrAbove(void)
239 OSVERSIONINFO winVer;
240 winVer.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
241 return GetVersionEx(&winVer) && winVer.dwMajorVersion > 5;
244 static int OpenVideoXP(vlc_object_t *obj)
246 /* Windows XP or lower, make sure this module isn't the default */
247 return IsVistaOrAbove() ? VLC_EGENERIC : Open(obj);
250 static int OpenVideoVista(vlc_object_t *obj)
252 /* Windows Vista or above, make this module the default */
253 return IsVistaOrAbove() ? Open(obj) : VLC_EGENERIC;
257 * It destroyes a Direct3D vout display.
259 static void Close(vlc_object_t *object)
261 vout_display_t * vd = (vout_display_t *)object;
263 var_DelCallback(vd, "direct3d-desktop", DesktopCallback, NULL);
264 vlc_mutex_destroy(&vd->sys->lock);
276 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
279 return vd->sys->pool;
282 static int Direct3DLockSurface(picture_t *);
283 static void Direct3DUnlockSurface(picture_t *);
285 static void Prepare(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
287 vout_display_sys_t *sys = vd->sys;
288 LPDIRECT3DSURFACE9 surface = picture->p_sys->surface;
290 picture_Release(picture);
291 VLC_UNUSED(subpicture);
293 /* FIXME it is a bit ugly, we need the surface to be unlocked for
295 * The clean way would be to release the picture (and ensure that
296 * the vout doesn't keep a reference). But because of the vout
297 * wrapper, we can't */
299 Direct3DUnlockSurface(picture);
300 VLC_UNUSED(subpicture);
303 /* check if device is still available */
304 HRESULT hr = IDirect3DDevice9_TestCooperativeLevel(sys->d3ddev);
306 if (hr == D3DERR_DEVICENOTRESET && !sys->reset_device) {
307 vout_display_SendEventPicturesInvalid(vd);
308 sys->reset_device = true;
313 d3d_region_t picture_region;
314 if (!Direct3DImportPicture(vd, &picture_region, surface)) {
315 int subpicture_region_count = 0;
316 d3d_region_t *subpicture_region = NULL;
318 Direct3DImportSubpicture(vd, &subpicture_region_count, &subpicture_region,
321 Direct3DRenderScene(vd, &picture_region,
322 subpicture_region_count, subpicture_region);
324 Direct3DDeleteRegions(sys->d3dregion_count, sys->d3dregion);
325 sys->d3dregion_count = subpicture_region_count;
326 sys->d3dregion = subpicture_region;
330 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
332 vout_display_sys_t *sys = vd->sys;
333 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
335 // Present the back buffer contents to the display
336 // No stretching should happen here !
337 const RECT src = sys->rect_dest_clipped;
338 const RECT dst = sys->rect_dest_clipped;
339 HRESULT hr = IDirect3DDevice9_Present(d3ddev, &src, &dst, NULL, NULL);
341 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
346 VLC_UNUSED(subpicture);
348 /* XXX See Prepare() */
349 Direct3DLockSurface(picture);
350 picture_Release(picture);
353 subpicture_Delete(subpicture);
357 static int ControlResetDevice(vout_display_t *vd)
359 return Direct3DReset(vd);
361 static int ControlReopenDevice(vout_display_t *vd)
363 vout_display_sys_t *sys = vd->sys;
365 if (!sys->use_desktop) {
366 /* Save non-desktop state */
367 sys->desktop_save.is_fullscreen = vd->cfg->is_fullscreen;
368 sys->desktop_save.is_on_top = sys->is_on_top;
370 WINDOWPLACEMENT wp = { .length = sizeof(wp), };
371 GetWindowPlacement(sys->hparent ? sys->hparent : sys->hwnd, &wp);
372 sys->desktop_save.win = wp.rcNormalPosition;
377 EventThreadStop(sys->event);
380 vlc_mutex_lock(&sys->lock);
381 sys->use_desktop = sys->desktop_requested;
382 sys->ch_desktop = false;
383 vlc_mutex_unlock(&sys->lock);
387 memset(&cfg, 0, sizeof(cfg));
388 cfg.use_desktop = sys->use_desktop;
389 if (!sys->use_desktop) {
390 cfg.win.type = VOUT_WINDOW_TYPE_HWND;
391 cfg.win.x = sys->desktop_save.win.left;
392 cfg.win.y = sys->desktop_save.win.top;
393 cfg.win.width = sys->desktop_save.win.right - sys->desktop_save.win.left;
394 cfg.win.height = sys->desktop_save.win.bottom - sys->desktop_save.win.top;
398 if (EventThreadStart(sys->event, &hwnd, &cfg)) {
399 msg_Err(vd, "Failed to restart event thread");
402 sys->parent_window = hwnd.parent_window;
403 sys->hparent = hwnd.hparent;
404 sys->hwnd = hwnd.hwnd;
405 sys->hvideownd = hwnd.hvideownd;
406 sys->hfswnd = hwnd.hfswnd;
407 SetRectEmpty(&sys->rect_parent);
411 if (Direct3DOpen(vd, &fmt)) {
413 msg_Err(vd, "Failed to reopen device");
417 sys->is_first_display = true;
419 if (sys->use_desktop) {
420 /* Disable fullscreen/on_top while using desktop */
421 if (sys->desktop_save.is_fullscreen)
422 vout_display_SendEventFullscreen(vd, false);
423 if (sys->desktop_save.is_on_top)
424 vout_display_SendWindowState(vd, VOUT_WINDOW_STATE_NORMAL);
426 /* Restore fullscreen/on_top */
427 if (sys->desktop_save.is_fullscreen)
428 vout_display_SendEventFullscreen(vd, true);
429 if (sys->desktop_save.is_on_top)
430 vout_display_SendWindowState(vd, VOUT_WINDOW_STATE_ABOVE);
434 static int Control(vout_display_t *vd, int query, va_list args)
436 vout_display_sys_t *sys = vd->sys;
439 case VOUT_DISPLAY_RESET_PICTURES:
440 /* FIXME what to do here in case of failure */
441 if (sys->reset_device) {
442 if (ControlResetDevice(vd)) {
443 msg_Err(vd, "Failed to reset device");
446 sys->reset_device = false;
447 } else if(sys->reopen_device) {
448 if (ControlReopenDevice(vd)) {
449 msg_Err(vd, "Failed to reopen device");
452 sys->reopen_device = false;
456 return CommonControl(vd, query, args);
459 static void Manage (vout_display_t *vd)
461 vout_display_sys_t *sys = vd->sys;
465 /* Desktop mode change */
466 vlc_mutex_lock(&sys->lock);
467 const bool ch_desktop = sys->ch_desktop;
468 sys->ch_desktop = false;
469 vlc_mutex_unlock(&sys->lock);
472 sys->reopen_device = true;
473 vout_display_SendEventPicturesInvalid(vd);
480 if (sys->changes & DX_POSITION_CHANGE) {
481 #if 0 /* need that when bicubic filter is available */
485 GetClientRect(p_sys->hvideownd, &rect);
486 width = rect.right-rect.left;
487 height = rect.bottom-rect.top;
489 if (width != p_sys->d3dpp.BackBufferWidth || height != p_sys->d3dpp.BackBufferHeight)
491 msg_Dbg(vd, "resizing device back buffers to (%lux%lu)", width, height);
492 // need to reset D3D device to resize back buffer
493 if (VLC_SUCCESS != Direct3DResetDevice(vd, width, height))
497 sys->changes &= ~DX_POSITION_CHANGE;
503 * It initializes an instance of Direct3D9
505 static int Direct3DCreate(vout_display_t *vd)
507 vout_display_sys_t *sys = vd->sys;
509 sys->hd3d9_dll = LoadLibrary(TEXT("D3D9.DLL"));
510 if (!sys->hd3d9_dll) {
511 msg_Warn(vd, "cannot load d3d9.dll, aborting");
515 LPDIRECT3D9 (WINAPI *OurDirect3DCreate9)(UINT SDKVersion);
517 (void *)GetProcAddress(sys->hd3d9_dll, TEXT("Direct3DCreate9"));
518 if (!OurDirect3DCreate9) {
519 msg_Err(vd, "Cannot locate reference to Direct3DCreate9 ABI in DLL");
523 /* Create the D3D object. */
524 LPDIRECT3D9 d3dobj = OurDirect3DCreate9(D3D_SDK_VERSION);
526 msg_Err(vd, "Could not create Direct3D9 instance.");
529 sys->d3dobj = d3dobj;
532 ** Get device capabilities
534 ZeroMemory(&sys->d3dcaps, sizeof(sys->d3dcaps));
535 HRESULT hr = IDirect3D9_GetDeviceCaps(d3dobj, D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, &sys->d3dcaps);
537 msg_Err(vd, "Could not read adapter capabilities. (hr=0x%lX)", hr);
541 /* TODO: need to test device capabilities and select the right render function */
547 * It releases an instance of Direct3D9
549 static void Direct3DDestroy(vout_display_t *vd)
551 vout_display_sys_t *sys = vd->sys;
554 IDirect3D9_Release(sys->d3dobj);
556 FreeLibrary(sys->hd3d9_dll);
559 sys->hd3d9_dll = NULL;
564 * It setup vout_display_sys_t::d3dpp and vout_display_sys_t::rect_display
565 * from the default adapter.
567 static int Direct3DFillPresentationParameters(vout_display_t *vd)
569 vout_display_sys_t *sys = vd->sys;
572 ** Get the current desktop display mode, so we can set up a back
573 ** buffer of the same format
575 D3DDISPLAYMODE d3ddm;
576 HRESULT hr = IDirect3D9_GetAdapterDisplayMode(sys->d3dobj,
577 D3DADAPTER_DEFAULT, &d3ddm);
579 msg_Err(vd, "Could not read adapter display mode. (hr=0x%lX)", hr);
583 /* Set up the structure used to create the D3DDevice. */
584 D3DPRESENT_PARAMETERS *d3dpp = &vd->sys->d3dpp;
585 ZeroMemory(d3dpp, sizeof(D3DPRESENT_PARAMETERS));
586 d3dpp->Flags = D3DPRESENTFLAG_VIDEO;
587 d3dpp->Windowed = TRUE;
588 d3dpp->hDeviceWindow = vd->sys->hvideownd;
589 d3dpp->BackBufferWidth = __MAX((unsigned int)GetSystemMetrics(SM_CXVIRTUALSCREEN),
591 d3dpp->BackBufferHeight = __MAX((unsigned int)GetSystemMetrics(SM_CYVIRTUALSCREEN),
593 d3dpp->SwapEffect = D3DSWAPEFFECT_COPY;
594 d3dpp->MultiSampleType = D3DMULTISAMPLE_NONE;
595 d3dpp->PresentationInterval = D3DPRESENT_INTERVAL_DEFAULT;
596 d3dpp->BackBufferFormat = d3ddm.Format;
597 d3dpp->BackBufferCount = 1;
598 d3dpp->EnableAutoDepthStencil = FALSE;
601 RECT *display = &vd->sys->rect_display;
604 display->right = d3dpp->BackBufferWidth;
605 display->bottom = d3dpp->BackBufferHeight;
611 static int Direct3DCreateResources (vout_display_t *, video_format_t *);
612 static void Direct3DDestroyResources(vout_display_t *);
615 * It creates a Direct3D device and the associated resources.
617 static int Direct3DOpen(vout_display_t *vd, video_format_t *fmt)
619 vout_display_sys_t *sys = vd->sys;
620 LPDIRECT3D9 d3dobj = sys->d3dobj;
622 if (Direct3DFillPresentationParameters(vd))
625 // Create the D3DDevice
626 LPDIRECT3DDEVICE9 d3ddev;
628 UINT AdapterToUse = D3DADAPTER_DEFAULT;
629 D3DDEVTYPE DeviceType = D3DDEVTYPE_HAL;
632 // Look for 'NVIDIA PerfHUD' adapter
633 // If it is present, override default settings
634 for (UINT Adapter=0; Adapter< IDirect3D9_GetAdapterCount(d3dobj); ++Adapter) {
635 D3DADAPTER_IDENTIFIER9 Identifier;
637 Res = IDirect3D9_GetAdapterIdentifier(d3dobj,Adapter,0,&Identifier);
638 if (strstr(Identifier.Description,"PerfHUD") != 0) {
639 AdapterToUse = Adapter;
640 DeviceType = D3DDEVTYPE_REF;
646 HRESULT hr = IDirect3D9_CreateDevice(d3dobj, AdapterToUse,
647 DeviceType, sys->hvideownd,
648 D3DCREATE_SOFTWARE_VERTEXPROCESSING|
649 D3DCREATE_MULTITHREADED,
650 &sys->d3dpp, &d3ddev);
652 msg_Err(vd, "Could not create the D3D device! (hr=0x%lX)", hr);
655 sys->d3ddev = d3ddev;
657 UpdateRects(vd, NULL, NULL, true);
659 if (Direct3DCreateResources(vd, fmt)) {
660 msg_Err(vd, "Failed to allocate resources");
664 /* Change the window title bar text */
665 EventThreadUpdateTitle(sys->event, VOUT_TITLE " (Direct3D output)");
667 msg_Dbg(vd, "Direct3D device adapter successfully initialized");
672 * It releases the Direct3D9 device and its resources.
674 static void Direct3DClose(vout_display_t *vd)
676 vout_display_sys_t *sys = vd->sys;
678 Direct3DDestroyResources(vd);
681 IDirect3DDevice9_Release(sys->d3ddev);
687 * It reset the Direct3D9 device and its resources.
689 static int Direct3DReset(vout_display_t *vd)
691 vout_display_sys_t *sys = vd->sys;
692 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
694 if (Direct3DFillPresentationParameters(vd))
697 /* release all D3D objects */
698 Direct3DDestroyResources(vd);
701 HRESULT hr = IDirect3DDevice9_Reset(d3ddev, &sys->d3dpp);
703 msg_Err(vd, "%s failed ! (hr=%08lX)", __FUNCTION__, hr);
707 UpdateRects(vd, NULL, NULL, true);
710 if (Direct3DCreateResources(vd, &vd->fmt)) {
711 msg_Dbg(vd, "%s failed !", __FUNCTION__);
718 static int Direct3DCreatePool(vout_display_t *vd, video_format_t *fmt);
719 static void Direct3DDestroyPool(vout_display_t *vd);
721 static int Direct3DCreateScene(vout_display_t *vd, const video_format_t *fmt);
722 static void Direct3DDestroyScene(vout_display_t *vd);
725 * It creates the picture and scene resources.
727 static int Direct3DCreateResources(vout_display_t *vd, video_format_t *fmt)
729 if (Direct3DCreatePool(vd, fmt)) {
730 msg_Err(vd, "Direct3D picture pool initialization failed");
733 if (Direct3DCreateScene(vd, fmt)) {
734 msg_Err(vd, "Direct3D scene initialization failed !");
740 * It destroys the picture and scene resources.
742 static void Direct3DDestroyResources(vout_display_t *vd)
744 Direct3DDestroyScene(vd);
745 Direct3DDestroyPool(vd);
749 * It tests if the conversion from src to dst is supported.
751 static int Direct3DCheckConversion(vout_display_t *vd,
752 D3DFORMAT src, D3DFORMAT dst)
754 vout_display_sys_t *sys = vd->sys;
755 LPDIRECT3D9 d3dobj = sys->d3dobj;
758 /* test whether device can create a surface of that format */
759 hr = IDirect3D9_CheckDeviceFormat(d3dobj, D3DADAPTER_DEFAULT,
760 D3DDEVTYPE_HAL, dst, 0,
761 D3DRTYPE_SURFACE, src);
763 /* test whether device can perform color-conversion
764 ** from that format to target format
766 hr = IDirect3D9_CheckDeviceFormatConversion(d3dobj,
771 if (!SUCCEEDED(hr)) {
772 if (D3DERR_NOTAVAILABLE != hr)
773 msg_Err(vd, "Could not query adapter supported formats. (hr=0x%lX)", hr);
782 D3DFORMAT format; /* D3D format */
783 vlc_fourcc_t fourcc; /* VLC fourcc */
789 static const d3d_format_t d3d_formats[] = {
790 /* YV12 is always used for planar 420, the planes are then swapped in Lock() */
791 { "YV12", MAKEFOURCC('Y','V','1','2'), VLC_CODEC_YV12, 0,0,0 },
792 { "YV12", MAKEFOURCC('Y','V','1','2'), VLC_CODEC_I420, 0,0,0 },
793 { "YV12", MAKEFOURCC('Y','V','1','2'), VLC_CODEC_J420, 0,0,0 },
794 { "UYVY", D3DFMT_UYVY, VLC_CODEC_UYVY, 0,0,0 },
795 { "YUY2", D3DFMT_YUY2, VLC_CODEC_YUYV, 0,0,0 },
796 { "X8R8G8B8", D3DFMT_X8R8G8B8,VLC_CODEC_RGB32, 0xff0000, 0x00ff00, 0x0000ff },
797 { "A8R8G8B8", D3DFMT_A8R8G8B8,VLC_CODEC_RGB32, 0xff0000, 0x00ff00, 0x0000ff },
798 { "8G8B8", D3DFMT_R8G8B8, VLC_CODEC_RGB24, 0xff0000, 0x00ff00, 0x0000ff },
799 { "R5G6B5", D3DFMT_R5G6B5, VLC_CODEC_RGB16, 0x1f<<11, 0x3f<<5, 0x1f<<0 },
800 { "X1R5G5B5", D3DFMT_X1R5G5B5,VLC_CODEC_RGB15, 0x1f<<10, 0x1f<<5, 0x1f<<0 },
806 * It returns the format (closest to chroma) that can be converted to target */
807 static const d3d_format_t *Direct3DFindFormat(vout_display_t *vd, vlc_fourcc_t chroma, D3DFORMAT target)
809 vout_display_sys_t *sys = vd->sys;
811 for (unsigned pass = 0; pass < 2; pass++) {
812 const vlc_fourcc_t *list;
814 if (pass == 0 && sys->allow_hw_yuv && vlc_fourcc_IsYUV(chroma))
815 list = vlc_fourcc_GetYUVFallback(chroma);
817 list = vlc_fourcc_GetRGBFallback(chroma);
821 for (unsigned i = 0; list[i] != 0; i++) {
822 for (unsigned j = 0; d3d_formats[j].name; j++) {
823 const d3d_format_t *format = &d3d_formats[j];
825 if (format->fourcc != list[i])
828 msg_Warn(vd, "trying surface pixel format: %s",
830 if (!Direct3DCheckConversion(vd, format->format, target)) {
831 msg_Dbg(vd, "selected surface pixel format is %s",
842 * It locks the surface associated to the picture and get the surface
843 * descriptor which amongst other things has the pointer to the picture
844 * data and its pitch.
846 static int Direct3DLockSurface(picture_t *picture)
848 /* Lock the surface to get a valid pointer to the picture buffer */
849 D3DLOCKED_RECT d3drect;
850 HRESULT hr = IDirect3DSurface9_LockRect(picture->p_sys->surface, &d3drect, NULL, 0);
852 //msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
853 return CommonUpdatePicture(picture, &picture->p_sys->fallback, NULL, 0);
856 CommonUpdatePicture(picture, NULL, d3drect.pBits, d3drect.Pitch);
860 * It unlocks the surface associated to the picture.
862 static void Direct3DUnlockSurface(picture_t *picture)
864 /* Unlock the Surface */
865 HRESULT hr = IDirect3DSurface9_UnlockRect(picture->p_sys->surface);
867 //msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
872 * It creates the pool of picture (only 1).
874 * Each picture has an associated offscreen surface in video memory
875 * depending on hardware capabilities the picture chroma will be as close
876 * as possible to the orginal render chroma to reduce CPU conversion overhead
877 * and delegate this work to video card GPU
879 static int Direct3DCreatePool(vout_display_t *vd, video_format_t *fmt)
881 vout_display_sys_t *sys = vd->sys;
882 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
887 /* Find the appropriate D3DFORMAT for the render chroma, the format will be the closest to
888 * the requested chroma which is usable by the hardware in an offscreen surface, as they
889 * typically support more formats than textures */
890 const d3d_format_t *d3dfmt = Direct3DFindFormat(vd, fmt->i_chroma, sys->d3dpp.BackBufferFormat);
892 msg_Err(vd, "surface pixel format is not supported.");
895 fmt->i_chroma = d3dfmt->fourcc;
896 fmt->i_rmask = d3dfmt->rmask;
897 fmt->i_gmask = d3dfmt->gmask;
898 fmt->i_bmask = d3dfmt->bmask;
900 /* We create one picture.
901 * It is useless to create more as we can't be used for direct rendering */
903 /* Create a surface */
904 LPDIRECT3DSURFACE9 surface;
905 HRESULT hr = IDirect3DDevice9_CreateOffscreenPlainSurface(d3ddev,
913 msg_Err(vd, "Failed to create picture surface. (hr=0x%lx)", hr);
916 /* fill surface with black color */
917 IDirect3DDevice9_ColorFill(d3ddev, surface, NULL, D3DCOLOR_ARGB(0xFF, 0, 0, 0));
919 /* Create the associated picture */
920 picture_resource_t *rsc = &sys->resource;
921 rsc->p_sys = malloc(sizeof(*rsc->p_sys));
923 IDirect3DSurface9_Release(surface);
926 rsc->p_sys->surface = surface;
927 rsc->p_sys->fallback = NULL;
928 for (int i = 0; i < PICTURE_PLANE_MAX; i++) {
929 rsc->p[i].p_pixels = NULL;
930 rsc->p[i].i_pitch = 0;
931 rsc->p[i].i_lines = fmt->i_height / (i > 0 ? 2 : 1);
933 picture_t *picture = picture_NewFromResource(fmt, rsc);
935 IDirect3DSurface9_Release(surface);
940 /* Wrap it into a picture pool */
941 picture_pool_configuration_t pool_cfg;
942 memset(&pool_cfg, 0, sizeof(pool_cfg));
943 pool_cfg.picture_count = 1;
944 pool_cfg.picture = &picture;
945 pool_cfg.lock = Direct3DLockSurface;
946 pool_cfg.unlock = Direct3DUnlockSurface;
948 sys->pool = picture_pool_NewExtended(&pool_cfg);
950 picture_Release(picture);
951 IDirect3DSurface9_Release(surface);
957 * It destroys the pool of picture and its resources.
959 static void Direct3DDestroyPool(vout_display_t *vd)
961 vout_display_sys_t *sys = vd->sys;
964 picture_resource_t *rsc = &sys->resource;
965 IDirect3DSurface9_Release(rsc->p_sys->surface);
966 if (rsc->p_sys->fallback)
967 picture_Release(rsc->p_sys->fallback);
968 picture_pool_Delete(sys->pool);
974 * It allocates and initializes the resources needed to render the scene.
976 static int Direct3DCreateScene(vout_display_t *vd, const video_format_t *fmt)
978 vout_display_sys_t *sys = vd->sys;
979 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
983 * Create a texture for use when rendering a scene
984 * for performance reason, texture format is identical to backbuffer
985 * which would usually be a RGB format
987 LPDIRECT3DTEXTURE9 d3dtex;
988 hr = IDirect3DDevice9_CreateTexture(d3ddev,
992 D3DUSAGE_RENDERTARGET,
993 sys->d3dpp.BackBufferFormat,
998 msg_Err(vd, "Failed to create texture. (hr=0x%lx)", hr);
1003 ** Create a vertex buffer for use when rendering scene
1005 LPDIRECT3DVERTEXBUFFER9 d3dvtc;
1006 hr = IDirect3DDevice9_CreateVertexBuffer(d3ddev,
1007 sizeof(CUSTOMVERTEX)*4,
1008 D3DUSAGE_DYNAMIC|D3DUSAGE_WRITEONLY,
1009 D3DFVF_CUSTOMVERTEX,
1014 msg_Err(vd, "Failed to create vertex buffer. (hr=0x%lx)", hr);
1015 IDirect3DTexture9_Release(d3dtex);
1016 return VLC_EGENERIC;
1020 sys->d3dtex = d3dtex;
1021 sys->d3dvtc = d3dvtc;
1023 sys->d3dregion_count = 0;
1024 sys->d3dregion = NULL;
1026 // Texture coordinates outside the range [0.0, 1.0] are set
1027 // to the texture color at 0.0 or 1.0, respectively.
1028 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_ADDRESSU, D3DTADDRESS_CLAMP);
1029 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_ADDRESSV, D3DTADDRESS_CLAMP);
1031 // Set linear filtering quality
1032 if (sys->d3dcaps.TextureFilterCaps & D3DPTFILTERCAPS_MINFLINEAR) {
1033 msg_Dbg(vd, "Using D3DTEXF_LINEAR for minification");
1034 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MINFILTER, D3DTEXF_LINEAR);
1036 msg_Dbg(vd, "Using D3DTEXF_POINT for minification");
1037 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MINFILTER, D3DTEXF_POINT);
1039 if (sys->d3dcaps.TextureFilterCaps & D3DPTFILTERCAPS_MAGFLINEAR) {
1040 msg_Dbg(vd, "Using D3DTEXF_LINEAR for magnification");
1041 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MAGFILTER, D3DTEXF_LINEAR);
1043 msg_Dbg(vd, "Using D3DTEXF_POINT for magnification");
1044 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MAGFILTER, D3DTEXF_POINT);
1047 // set maximum ambient light
1048 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_AMBIENT, D3DCOLOR_XRGB(255,255,255));
1051 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_CULLMODE, D3DCULL_NONE);
1053 // Turn off the zbuffer
1054 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ZENABLE, D3DZB_FALSE);
1057 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_LIGHTING, FALSE);
1060 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_DITHERENABLE, TRUE);
1063 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_STENCILENABLE, FALSE);
1066 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, FALSE);
1067 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_SRCBLEND,D3DBLEND_SRCALPHA);
1068 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_DESTBLEND,D3DBLEND_INVSRCALPHA);
1070 if (sys->d3dcaps.AlphaCmpCaps & D3DPCMPCAPS_GREATER) {
1071 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHATESTENABLE,TRUE);
1072 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHAREF, 0x00);
1073 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHAFUNC,D3DCMP_GREATER);
1076 // Set texture states
1077 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLOROP,D3DTOP_SELECTARG1);
1078 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLORARG1,D3DTA_TEXTURE);
1080 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAOP, D3DTOP_MODULATE);
1081 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAARG1,D3DTA_TEXTURE);
1082 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAARG2,D3DTA_DIFFUSE);
1084 msg_Dbg(vd, "Direct3D scene created successfully");
1090 * It releases the scene resources.
1092 static void Direct3DDestroyScene(vout_display_t *vd)
1094 vout_display_sys_t *sys = vd->sys;
1096 Direct3DDeleteRegions(sys->d3dregion_count, sys->d3dregion);
1098 LPDIRECT3DVERTEXBUFFER9 d3dvtc = sys->d3dvtc;
1100 IDirect3DVertexBuffer9_Release(d3dvtc);
1102 LPDIRECT3DTEXTURE9 d3dtex = sys->d3dtex;
1104 IDirect3DTexture9_Release(d3dtex);
1109 sys->d3dregion_count = 0;
1110 sys->d3dregion = NULL;
1112 msg_Dbg(vd, "Direct3D scene released successfully");
1115 static void Direct3DSetupVertices(CUSTOMVERTEX *vertices,
1116 const RECT src_full,
1117 const RECT src_crop,
1121 const float src_full_width = src_full.right - src_full.left;
1122 const float src_full_height = src_full.bottom - src_full.top;
1123 vertices[0].x = dst.left;
1124 vertices[0].y = dst.top;
1125 vertices[0].tu = src_crop.left / src_full_width;
1126 vertices[0].tv = src_crop.top / src_full_height;
1128 vertices[1].x = dst.right;
1129 vertices[1].y = dst.top;
1130 vertices[1].tu = src_crop.right / src_full_width;
1131 vertices[1].tv = src_crop.top / src_full_height;
1133 vertices[2].x = dst.right;
1134 vertices[2].y = dst.bottom;
1135 vertices[2].tu = src_crop.right / src_full_width;
1136 vertices[2].tv = src_crop.bottom / src_full_height;
1138 vertices[3].x = dst.left;
1139 vertices[3].y = dst.bottom;
1140 vertices[3].tu = src_crop.left / src_full_width;
1141 vertices[3].tv = src_crop.bottom / src_full_height;
1143 for (int i = 0; i < 4; i++) {
1144 /* -0.5f is a "feature" of DirectX and it seems to apply to Direct3d also */
1145 /* http://www.sjbrown.co.uk/2003/05/01/fix-directx-rasterisation/ */
1146 vertices[i].x -= 0.5;
1147 vertices[i].y -= 0.5;
1149 vertices[i].z = 0.0f;
1150 vertices[i].rhw = 1.0f;
1151 vertices[i].diffuse = D3DCOLOR_ARGB(alpha, 255, 255, 255);
1156 * It copies picture surface into a texture and setup the associated d3d_region_t.
1158 static int Direct3DImportPicture(vout_display_t *vd,
1159 d3d_region_t *region,
1160 LPDIRECT3DSURFACE9 source)
1162 vout_display_sys_t *sys = vd->sys;
1166 msg_Dbg(vd, "no surface to render ?");
1167 return VLC_EGENERIC;
1170 /* retrieve texture top-level surface */
1171 LPDIRECT3DSURFACE9 destination;
1172 hr = IDirect3DTexture9_GetSurfaceLevel(sys->d3dtex, 0, &destination);
1174 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1175 return VLC_EGENERIC;
1178 /* Copy picture surface into texture surface
1179 * color space conversion happen here */
1180 hr = IDirect3DDevice9_StretchRect(sys->d3ddev, source, NULL, destination, NULL, D3DTEXF_NONE);
1181 IDirect3DSurface9_Release(destination);
1183 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1184 return VLC_EGENERIC;
1188 region->texture = sys->d3dtex;
1189 Direct3DSetupVertices(region->vertex,
1191 vd->sys->rect_src_clipped,
1192 vd->sys->rect_dest_clipped, 255);
1196 static void Direct3DDeleteRegions(int count, d3d_region_t *region)
1198 for (int i = 0; i < count; i++) {
1199 if (region[i].texture)
1200 IDirect3DTexture9_Release(region[i].texture);
1205 static void Direct3DImportSubpicture(vout_display_t *vd,
1206 int *count_ptr, d3d_region_t **region,
1207 subpicture_t *subpicture)
1209 vout_display_sys_t *sys = vd->sys;
1212 for (subpicture_region_t *r = subpicture->p_region; r; r = r->p_next)
1216 *region = calloc(count, sizeof(**region));
1217 if (*region == NULL) {
1223 for (subpicture_region_t *r = subpicture->p_region; r; r = r->p_next, i++) {
1224 d3d_region_t *d3dr = &(*region)[i];
1227 d3dr->texture = NULL;
1228 for (int j = 0; j < sys->d3dregion_count; j++) {
1229 d3d_region_t *cache = &sys->d3dregion[j];
1230 if (cache->texture &&
1231 cache->format == D3DFMT_A8R8G8B8 &&
1232 cache->width == r->fmt.i_visible_width &&
1233 cache->height == r->fmt.i_visible_height) {
1234 msg_Dbg(vd, "Reusing %dx%d texture for OSD",
1235 cache->width, cache->height);
1237 memset(cache, 0, sizeof(*cache));
1240 if (!d3dr->texture) {
1241 d3dr->format = D3DFMT_A8R8G8B8;
1242 d3dr->width = r->fmt.i_visible_width;
1243 d3dr->height = r->fmt.i_visible_height;
1244 hr = IDirect3DDevice9_CreateTexture(sys->d3ddev,
1245 d3dr->width, d3dr->height,
1253 d3dr->texture = NULL;
1254 msg_Err(vd, "Failed to create %dx%d texture for OSD",
1255 d3dr->width, d3dr->height);
1258 msg_Dbg(vd, "Created %dx%d texture for OSD",
1259 r->fmt.i_visible_width, r->fmt.i_visible_height);
1262 D3DLOCKED_RECT lock;
1263 hr = IDirect3DTexture9_LockRect(d3dr->texture, 0, &lock, NULL, 0);
1264 if (SUCCEEDED(hr)) {
1265 uint8_t *dst_data = lock.pBits;
1266 int dst_pitch = lock.Pitch;
1267 for (unsigned y = 0; y < r->fmt.i_visible_height; y++) {
1268 int copy_pitch = __MIN(dst_pitch, r->p_picture->p->i_visible_pitch);
1269 memcpy(&dst_data[y * dst_pitch],
1270 &r->p_picture->p->p_pixels[y * r->p_picture->p->i_pitch],
1273 hr = IDirect3DTexture9_UnlockRect(d3dr->texture, 0);
1275 msg_Err(vd, "Failed to unlock the texture");
1277 msg_Err(vd, "Failed to lock the texture");
1280 /* Map the subpicture to sys->rect_dest */
1283 src.right = src.left + r->fmt.i_visible_width;
1285 src.bottom = src.top + r->fmt.i_visible_height;
1287 const RECT video = sys->rect_dest;
1288 const float scale_w = (float)(video.right - video.left) / subpicture->i_original_picture_width;
1289 const float scale_h = (float)(video.bottom - video.top) / subpicture->i_original_picture_height;
1292 dst.left = video.left + scale_w * r->i_x,
1293 dst.right = dst.left + scale_w * r->fmt.i_visible_width,
1294 dst.top = video.top + scale_h * r->i_y,
1295 dst.bottom = dst.top + scale_h * r->fmt.i_visible_height,
1296 Direct3DSetupVertices(d3dr->vertex,
1298 subpicture->i_alpha * r->i_alpha / 255);
1302 static int Direct3DRenderRegion(vout_display_t *vd,
1303 d3d_region_t *region)
1305 vout_display_sys_t *sys = vd->sys;
1307 LPDIRECT3DDEVICE9 d3ddev = vd->sys->d3ddev;
1309 LPDIRECT3DVERTEXBUFFER9 d3dvtc = sys->d3dvtc;
1310 LPDIRECT3DTEXTURE9 d3dtex = region->texture;
1314 /* Import vertices */
1316 hr = IDirect3DVertexBuffer9_Lock(d3dvtc, 0, 0, &vertex, D3DLOCK_DISCARD);
1318 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1321 memcpy(vertex, region->vertex, sizeof(region->vertex));
1322 hr = IDirect3DVertexBuffer9_Unlock(d3dvtc);
1324 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1328 // Setup our texture. Using textures introduces the texture stage states,
1329 // which govern how textures get blended together (in the case of multiple
1330 // textures) and lighting information. In this case, we are modulating
1331 // (blending) our texture with the diffuse color of the vertices.
1332 hr = IDirect3DDevice9_SetTexture(d3ddev, 0, (LPDIRECT3DBASETEXTURE9)d3dtex);
1334 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1338 // Render the vertex buffer contents
1339 hr = IDirect3DDevice9_SetStreamSource(d3ddev, 0, d3dvtc, 0, sizeof(CUSTOMVERTEX));
1341 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1345 // we use FVF instead of vertex shader
1346 hr = IDirect3DDevice9_SetFVF(d3ddev, D3DFVF_CUSTOMVERTEX);
1348 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1353 hr = IDirect3DDevice9_DrawPrimitive(d3ddev, D3DPT_TRIANGLEFAN, 0, 2);
1355 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1362 * It renders the scene.
1364 * This function is intented for higher end 3D cards, with pixel shader support
1365 * and at least 64 MiB of video RAM.
1367 static void Direct3DRenderScene(vout_display_t *vd,
1368 d3d_region_t *picture,
1369 int subpicture_count,
1370 d3d_region_t *subpicture)
1372 vout_display_sys_t *sys = vd->sys;
1373 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
1376 /* Clear the backbuffer and the zbuffer */
1377 hr = IDirect3DDevice9_Clear(d3ddev, 0, NULL, D3DCLEAR_TARGET,
1378 D3DCOLOR_XRGB(0, 0, 0), 1.0f, 0);
1380 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1385 hr = IDirect3DDevice9_BeginScene(d3ddev);
1387 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1391 Direct3DRenderRegion(vd, picture);
1393 if (subpicture_count > 0)
1394 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, TRUE);
1395 for (int i = 0; i < subpicture_count; i++) {
1396 d3d_region_t *r = &subpicture[i];
1398 Direct3DRenderRegion(vd, r);
1400 if (subpicture_count > 0)
1401 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, FALSE);
1404 hr = IDirect3DDevice9_EndScene(d3ddev);
1406 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1411 /*****************************************************************************
1412 * DesktopCallback: desktop mode variable callback
1413 *****************************************************************************/
1414 static int DesktopCallback(vlc_object_t *object, char const *psz_cmd,
1415 vlc_value_t oldval, vlc_value_t newval,
1418 vout_display_t *vd = (vout_display_t *)object;
1419 vout_display_sys_t *sys = vd->sys;
1420 VLC_UNUSED(psz_cmd);
1424 vlc_mutex_lock(&sys->lock);
1425 const bool ch_desktop = !sys->desktop_requested != !newval.b_bool;
1426 sys->ch_desktop |= ch_desktop;
1427 sys->desktop_requested = newval.b_bool;
1428 vlc_mutex_unlock(&sys->lock);
1430 /* FIXME we should have a way to export variable to be saved */
1432 playlist_t *p_playlist = pl_Get(vd);
1433 /* Modify playlist as well because the vout might have to be
1435 var_Create(p_playlist, "direct3d-desktop", VLC_VAR_BOOL);
1436 var_SetBool(p_playlist, "direct3d-desktop", newval.b_bool);