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 D3D_HELP N_("Recommended video output for Windows Vista and later versions")
64 set_shortname("Direct3D")
65 set_description(N_("Direct3D video output"))
67 set_category(CAT_VIDEO)
68 set_subcategory(SUBCAT_VIDEO_VOUT)
70 add_bool("direct3d-desktop", false, NULL, DESKTOP_TEXT, DESKTOP_LONGTEXT, true)
72 set_capability("vout display", 150)
73 add_shortcut("direct3d")
74 set_callbacks(OpenVideoVista, Close)
77 set_description(N_("Direct3D video output (XP)"))
78 set_capability("vout display", 70)
79 add_shortcut("direct3d_xp")
80 set_callbacks(OpenVideoXP, Close)
84 /*****************************************************************************
86 *****************************************************************************/
89 LPDIRECT3DSURFACE9 surface;
92 static int Open(vlc_object_t *);
94 static picture_pool_t *Pool (vout_display_t *, unsigned);
95 static void Prepare(vout_display_t *, picture_t *);
96 static void Display(vout_display_t *, picture_t *);
97 static int Control(vout_display_t *, int, va_list);
98 static void Manage (vout_display_t *);
100 static int Direct3DCreate (vout_display_t *);
101 static int Direct3DReset (vout_display_t *);
102 static void Direct3DDestroy(vout_display_t *);
104 static int Direct3DOpen (vout_display_t *, video_format_t *);
105 static void Direct3DClose(vout_display_t *);
107 static void Direct3DRenderScene(vout_display_t *vd, LPDIRECT3DSURFACE9 surface);
110 static int DesktopCallback(vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *);
113 * It creates a Direct3D vout display.
115 static int Open(vlc_object_t *object)
117 vout_display_t *vd = (vout_display_t *)object;
118 vout_display_sys_t *sys;
120 /* Allocate structure */
121 vd->sys = sys = calloc(1, sizeof(vout_display_sys_t));
125 if (Direct3DCreate(vd)) {
126 msg_Err(vd, "Direct3D could not be initialized");
132 sys->use_desktop = var_CreateGetBool(vd, "direct3d-desktop");
133 sys->reset_device = false;
134 sys->reset_device = false;
135 sys->allow_hw_yuv = var_CreateGetBool(vd, "directx-hw-yuv");
136 sys->desktop_save.is_fullscreen = vd->cfg->is_fullscreen;
137 sys->desktop_save.is_on_top = false;
138 sys->desktop_save.win.left = var_InheritInteger(vd, "video-x");
139 sys->desktop_save.win.right = vd->cfg->display.width;
140 sys->desktop_save.win.top = var_InheritInteger(vd, "video-y");
141 sys->desktop_save.win.bottom = vd->cfg->display.height;
148 if (Direct3DOpen(vd, &fmt)) {
149 msg_Err(vd, "Direct3D could not be opened");
154 vout_display_info_t info = vd->info;
156 info.has_double_click = true;
157 info.has_hide_mouse = false;
158 info.has_pictures_invalid = true;
159 info.has_event_thread = true;
162 vlc_mutex_init(&sys->lock);
163 sys->ch_desktop = false;
164 sys->desktop_requested = sys->use_desktop;
167 val.psz_string = _("Desktop");
168 var_Change(vd, "direct3d-desktop", VLC_VAR_SETTEXT, &val, NULL);
169 var_AddCallback(vd, "direct3d-desktop", DesktopCallback, NULL);
171 /* Setup vout_display now that everything is fine */
176 vd->prepare = Prepare;
177 vd->display = Display;
178 vd->control = Control;
181 /* Fix state in case of desktop mode */
182 if (sys->use_desktop && vd->cfg->is_fullscreen)
183 vout_display_SendEventFullscreen(vd, false);
194 static bool IsVistaOrAbove(void)
196 OSVERSIONINFO winVer;
197 winVer.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
198 return GetVersionEx(&winVer) && winVer.dwMajorVersion > 5;
201 static int OpenVideoXP(vlc_object_t *obj)
203 /* Windows XP or lower, make sure this module isn't the default */
204 return IsVistaOrAbove() ? VLC_EGENERIC : Open(obj);
207 static int OpenVideoVista(vlc_object_t *obj)
209 /* Windows Vista or above, make this module the default */
210 return IsVistaOrAbove() ? Open(obj) : VLC_EGENERIC;
214 * It destroyes a Direct3D vout display.
216 static void Close(vlc_object_t *object)
218 vout_display_t * vd = (vout_display_t *)object;
220 var_DelCallback(vd, "direct3d-desktop", DesktopCallback, NULL);
232 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
235 return vd->sys->pool;
238 static int Direct3DLockSurface(picture_t *);
239 static void Direct3DUnlockSurface(picture_t *);
241 static void Prepare(vout_display_t *vd, picture_t *picture)
243 LPDIRECT3DSURFACE9 surface = picture->p_sys->surface;
245 picture_Release(picture);
246 Direct3DRenderScene(vd, surface);
248 /* FIXME it is a bit ugly, we need the surface to be unlocked for
250 * The clean way would be to release the picture (and ensure that
251 * the vout doesn't keep a reference). But because of the vout
252 * wrapper, we can't */
254 Direct3DUnlockSurface(picture);
256 Direct3DRenderScene(vd, surface);
258 Direct3DLockSurface(picture);
262 static void Display(vout_display_t *vd, picture_t *picture)
264 vout_display_sys_t *sys = vd->sys;
265 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
267 // Present the back buffer contents to the display
268 // No stretching should happen here !
269 const RECT src = sys->rect_dest_clipped;
270 const RECT dst = sys->rect_dest_clipped;
271 HRESULT hr = IDirect3DDevice9_Present(d3ddev, &src, &dst, NULL, NULL);
273 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
278 /* XXX See Prepare() */
279 picture_Release(picture);
284 static int ControlResetDevice(vout_display_t *vd)
286 return Direct3DReset(vd);
288 static int ControlReopenDevice(vout_display_t *vd)
290 vout_display_sys_t *sys = vd->sys;
292 if (!sys->use_desktop) {
293 /* Save non-desktop state */
294 sys->desktop_save.is_fullscreen = vd->cfg->is_fullscreen;
295 sys->desktop_save.is_on_top = sys->is_on_top;
297 WINDOWPLACEMENT wp = { .length = sizeof(wp), };
298 GetWindowPlacement(sys->hparent ? sys->hparent : sys->hwnd, &wp);
299 sys->desktop_save.win = wp.rcNormalPosition;
304 EventThreadStop(sys->event);
307 vlc_mutex_lock(&sys->lock);
308 sys->use_desktop = sys->desktop_requested;
309 sys->ch_desktop = false;
310 vlc_mutex_unlock(&sys->lock);
314 memset(&cfg, 0, sizeof(cfg));
315 cfg.use_desktop = sys->use_desktop;
316 if (!sys->use_desktop) {
317 cfg.win.type = VOUT_WINDOW_TYPE_HWND;
318 cfg.win.x = sys->desktop_save.win.left;
319 cfg.win.y = sys->desktop_save.win.top;
320 cfg.win.width = sys->desktop_save.win.right - sys->desktop_save.win.left;
321 cfg.win.height = sys->desktop_save.win.bottom - sys->desktop_save.win.top;
325 if (EventThreadStart(sys->event, &hwnd, &cfg)) {
326 msg_Err(vd, "Failed to restart event thread");
329 sys->parent_window = hwnd.parent_window;
330 sys->hparent = hwnd.hparent;
331 sys->hwnd = hwnd.hwnd;
332 sys->hvideownd = hwnd.hvideownd;
333 sys->hfswnd = hwnd.hfswnd;
334 SetRectEmpty(&sys->rect_parent);
338 if (Direct3DOpen(vd, &fmt)) {
340 msg_Err(vd, "Failed to reopen device");
344 sys->is_first_display = true;
346 if (sys->use_desktop) {
347 /* Disable fullscreen/on_top while using desktop */
348 if (sys->desktop_save.is_fullscreen)
349 vout_display_SendEventFullscreen(vd, false);
350 if (sys->desktop_save.is_on_top)
351 vout_display_SendWindowState(vd, VOUT_WINDOW_STATE_NORMAL);
353 /* Restore fullscreen/on_top */
354 if (sys->desktop_save.is_fullscreen)
355 vout_display_SendEventFullscreen(vd, true);
356 if (sys->desktop_save.is_on_top)
357 vout_display_SendWindowState(vd, VOUT_WINDOW_STATE_ABOVE);
361 static int Control(vout_display_t *vd, int query, va_list args)
363 vout_display_sys_t *sys = vd->sys;
366 case VOUT_DISPLAY_RESET_PICTURES:
367 /* FIXME what to do here in case of failure */
368 if (sys->reset_device) {
369 if (ControlResetDevice(vd)) {
370 msg_Err(vd, "Failed to reset device");
373 sys->reset_device = false;
374 } else if(sys->reopen_device) {
375 if (ControlReopenDevice(vd)) {
376 msg_Err(vd, "Failed to reopen device");
379 sys->reopen_device = false;
383 return CommonControl(vd, query, args);
386 static void Manage (vout_display_t *vd)
388 vout_display_sys_t *sys = vd->sys;
392 /* Desktop mode change */
393 vlc_mutex_lock(&sys->lock);
394 const bool ch_desktop = sys->ch_desktop;
395 sys->ch_desktop = false;
396 vlc_mutex_unlock(&sys->lock);
399 sys->reopen_device = true;
400 vout_display_SendEventPicturesInvalid(vd);
407 if (sys->changes & DX_POSITION_CHANGE) {
408 #if 0 /* need that when bicubic filter is available */
412 GetClientRect(p_sys->hvideownd, &rect);
413 width = rect.right-rect.left;
414 height = rect.bottom-rect.top;
416 if (width != p_sys->d3dpp.BackBufferWidth || height != p_sys->d3dpp.BackBufferHeight)
418 msg_Dbg(vd, "resizing device back buffers to (%lux%lu)", width, height);
419 // need to reset D3D device to resize back buffer
420 if (VLC_SUCCESS != Direct3DResetDevice(vd, width, height))
424 sys->changes &= ~DX_POSITION_CHANGE;
430 * It initializes an instance of Direct3D9
432 static int Direct3DCreate(vout_display_t *vd)
434 vout_display_sys_t *sys = vd->sys;
436 sys->hd3d9_dll = LoadLibrary(TEXT("D3D9.DLL"));
437 if (!sys->hd3d9_dll) {
438 msg_Warn(vd, "cannot load d3d9.dll, aborting");
442 LPDIRECT3D9 (WINAPI *OurDirect3DCreate9)(UINT SDKVersion);
444 (void *)GetProcAddress(sys->hd3d9_dll, TEXT("Direct3DCreate9"));
445 if (!OurDirect3DCreate9) {
446 msg_Err(vd, "Cannot locate reference to Direct3DCreate9 ABI in DLL");
450 /* Create the D3D object. */
451 LPDIRECT3D9 d3dobj = OurDirect3DCreate9(D3D_SDK_VERSION);
453 msg_Err(vd, "Could not create Direct3D9 instance.");
456 sys->d3dobj = d3dobj;
459 ** Get device capabilities
462 ZeroMemory(&d3dCaps, sizeof(d3dCaps));
463 HRESULT hr = IDirect3D9_GetDeviceCaps(d3dobj, D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, &d3dCaps);
465 msg_Err(vd, "Could not read adapter capabilities. (hr=0x%lX)", hr);
468 /* TODO: need to test device capabilities and select the right render function */
474 * It releases an instance of Direct3D9
476 static void Direct3DDestroy(vout_display_t *vd)
478 vout_display_sys_t *sys = vd->sys;
481 IDirect3D9_Release(sys->d3dobj);
483 FreeLibrary(sys->hd3d9_dll);
486 sys->hd3d9_dll = NULL;
491 * It setup vout_display_sys_t::d3dpp and vout_display_sys_t::rect_display
492 * from the default adapter.
494 static int Direct3DFillPresentationParameters(vout_display_t *vd)
496 vout_display_sys_t *sys = vd->sys;
499 ** Get the current desktop display mode, so we can set up a back
500 ** buffer of the same format
502 D3DDISPLAYMODE d3ddm;
503 HRESULT hr = IDirect3D9_GetAdapterDisplayMode(sys->d3dobj,
504 D3DADAPTER_DEFAULT, &d3ddm);
506 msg_Err(vd, "Could not read adapter display mode. (hr=0x%lX)", hr);
510 /* Set up the structure used to create the D3DDevice. */
511 D3DPRESENT_PARAMETERS *d3dpp = &vd->sys->d3dpp;
512 ZeroMemory(d3dpp, sizeof(D3DPRESENT_PARAMETERS));
513 d3dpp->Flags = D3DPRESENTFLAG_VIDEO;
514 d3dpp->Windowed = TRUE;
515 d3dpp->hDeviceWindow = vd->sys->hvideownd;
516 d3dpp->BackBufferWidth = __MAX(GetSystemMetrics(SM_CXVIRTUALSCREEN),
518 d3dpp->BackBufferHeight = __MAX(GetSystemMetrics(SM_CYVIRTUALSCREEN),
520 d3dpp->SwapEffect = D3DSWAPEFFECT_COPY;
521 d3dpp->MultiSampleType = D3DMULTISAMPLE_NONE;
522 d3dpp->PresentationInterval = D3DPRESENT_INTERVAL_DEFAULT;
523 d3dpp->BackBufferFormat = d3ddm.Format;
524 d3dpp->BackBufferCount = 1;
525 d3dpp->EnableAutoDepthStencil = FALSE;
528 RECT *display = &vd->sys->rect_display;
531 display->right = d3dpp->BackBufferWidth;
532 display->bottom = d3dpp->BackBufferHeight;
538 static int Direct3DCreateResources (vout_display_t *, video_format_t *);
539 static void Direct3DDestroyResources(vout_display_t *);
542 * It creates a Direct3D device and the associated resources.
544 static int Direct3DOpen(vout_display_t *vd, video_format_t *fmt)
546 vout_display_sys_t *sys = vd->sys;
547 LPDIRECT3D9 d3dobj = sys->d3dobj;
549 if (Direct3DFillPresentationParameters(vd))
552 // Create the D3DDevice
553 LPDIRECT3DDEVICE9 d3ddev;
554 HRESULT hr = IDirect3D9_CreateDevice(d3dobj, D3DADAPTER_DEFAULT,
555 D3DDEVTYPE_HAL, sys->hvideownd,
556 D3DCREATE_SOFTWARE_VERTEXPROCESSING|
557 D3DCREATE_MULTITHREADED,
558 &sys->d3dpp, &d3ddev);
560 msg_Err(vd, "Could not create the D3D device! (hr=0x%lX)", hr);
563 sys->d3ddev = d3ddev;
565 UpdateRects(vd, NULL, NULL, true);
567 if (Direct3DCreateResources(vd, fmt)) {
568 msg_Err(vd, "Failed to allocate resources");
572 /* Change the window title bar text */
573 EventThreadUpdateTitle(sys->event, VOUT_TITLE " (Direct3D output)");
575 msg_Dbg(vd, "Direct3D device adapter successfully initialized");
580 * It releases the Direct3D9 device and its resources.
582 static void Direct3DClose(vout_display_t *vd)
584 vout_display_sys_t *sys = vd->sys;
586 Direct3DDestroyResources(vd);
589 IDirect3DDevice9_Release(sys->d3ddev);
595 * It reset the Direct3D9 device and its resources.
597 static int Direct3DReset(vout_display_t *vd)
599 vout_display_sys_t *sys = vd->sys;
600 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
602 if (Direct3DFillPresentationParameters(vd))
605 /* release all D3D objects */
606 Direct3DDestroyResources(vd);
609 HRESULT hr = IDirect3DDevice9_Reset(d3ddev, &sys->d3dpp);
611 msg_Err(vd, "%s failed ! (hr=%08lX)", __FUNCTION__, hr);
615 UpdateRects(vd, NULL, NULL, true);
618 if (Direct3DCreateResources(vd, &vd->fmt)) {
619 msg_Dbg(vd, "%s failed !", __FUNCTION__);
626 static int Direct3DCreatePool(vout_display_t *vd, video_format_t *fmt);
627 static void Direct3DDestroyPool(vout_display_t *vd);
629 static int Direct3DCreateScene(vout_display_t *vd);
630 static void Direct3DDestroyScene(vout_display_t *vd);
633 * It creates the picture and scene resources.
635 static int Direct3DCreateResources(vout_display_t *vd, video_format_t *fmt)
637 if (Direct3DCreatePool(vd, fmt)) {
638 msg_Err(vd, "Direct3D picture pool initialization failed");
641 if (Direct3DCreateScene(vd)) {
642 msg_Err(vd, "Direct3D scene initialization failed !");
648 * It destroys the picture and scene resources.
650 static void Direct3DDestroyResources(vout_display_t *vd)
652 Direct3DDestroyScene(vd);
653 Direct3DDestroyPool(vd);
657 * It tests if the conversion from src to dst is supported.
659 static int Direct3DCheckConversion(vout_display_t *vd,
660 D3DFORMAT src, D3DFORMAT dst)
662 vout_display_sys_t *sys = vd->sys;
663 LPDIRECT3D9 d3dobj = sys->d3dobj;
666 /* test whether device can create a surface of that format */
667 hr = IDirect3D9_CheckDeviceFormat(d3dobj, D3DADAPTER_DEFAULT,
668 D3DDEVTYPE_HAL, dst, 0,
669 D3DRTYPE_SURFACE, src);
671 /* test whether device can perform color-conversion
672 ** from that format to target format
674 hr = IDirect3D9_CheckDeviceFormatConversion(d3dobj,
679 if (!SUCCEEDED(hr)) {
680 if (D3DERR_NOTAVAILABLE != hr)
681 msg_Err(vd, "Could not query adapter supported formats. (hr=0x%lX)", hr);
690 D3DFORMAT format; /* D3D format */
691 vlc_fourcc_t fourcc; /* VLC fourcc */
697 static const d3d_format_t d3d_formats[] = {
698 /* YV12 is always used for planar 420, the planes are then swapped in Lock() */
699 { "YV12", MAKEFOURCC('Y','V','1','2'), VLC_CODEC_YV12, 0,0,0 },
700 { "YV12", MAKEFOURCC('Y','V','1','2'), VLC_CODEC_I420, 0,0,0 },
701 { "YV12", MAKEFOURCC('Y','V','1','2'), VLC_CODEC_J420, 0,0,0 },
702 { "UYVY", D3DFMT_UYVY, VLC_CODEC_UYVY, 0,0,0 },
703 { "YUY2", D3DFMT_YUY2, VLC_CODEC_YUYV, 0,0,0 },
704 { "X8R8G8B8", D3DFMT_X8R8G8B8,VLC_CODEC_RGB32, 0xff0000, 0x00ff00, 0x0000ff },
705 { "A8R8G8B8", D3DFMT_A8R8G8B8,VLC_CODEC_RGB32, 0xff0000, 0x00ff00, 0x0000ff },
706 { "8G8B8", D3DFMT_R8G8B8, VLC_CODEC_RGB24, 0xff0000, 0x00ff00, 0x0000ff },
707 { "R5G6B5", D3DFMT_R5G6B5, VLC_CODEC_RGB16, 0x1f<<11, 0x3f<<5, 0x1f<<0 },
708 { "X1R5G5B5", D3DFMT_X1R5G5B5,VLC_CODEC_RGB15, 0x1f<<10, 0x1f<<5, 0x1f<<0 },
714 * It returns the format (closest to chroma) that can be converted to target */
715 static const d3d_format_t *Direct3DFindFormat(vout_display_t *vd, vlc_fourcc_t chroma, D3DFORMAT target)
717 vout_display_sys_t *sys = vd->sys;
719 for (unsigned pass = 0; pass < 2; pass++) {
720 const vlc_fourcc_t *list;
722 if (pass == 0 && sys->allow_hw_yuv && vlc_fourcc_IsYUV(chroma))
723 list = vlc_fourcc_GetYUVFallback(chroma);
725 list = vlc_fourcc_GetRGBFallback(chroma);
729 for (unsigned i = 0; list[i] != 0; i++) {
730 for (unsigned j = 0; d3d_formats[j].name; j++) {
731 const d3d_format_t *format = &d3d_formats[j];
733 if (format->fourcc != list[i])
736 msg_Warn(vd, "trying surface pixel format: %s",
738 if (!Direct3DCheckConversion(vd, format->format, target)) {
739 msg_Dbg(vd, "selected surface pixel format is %s",
750 * It locks the surface associated to the picture and get the surface
751 * descriptor which amongst other things has the pointer to the picture
752 * data and its pitch.
754 static int Direct3DLockSurface(picture_t *picture)
756 /* Lock the surface to get a valid pointer to the picture buffer */
757 D3DLOCKED_RECT d3drect;
758 HRESULT hr = IDirect3DSurface9_LockRect(picture->p_sys->surface, &d3drect, NULL, 0);
760 //msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
764 /* fill in buffer info in first plane */
765 picture->p->p_pixels = d3drect.pBits;
766 picture->p->i_pitch = d3drect.Pitch;
768 /* Fill chroma planes for planar YUV */
769 if (picture->format.i_chroma == VLC_CODEC_I420 ||
770 picture->format.i_chroma == VLC_CODEC_J420 ||
771 picture->format.i_chroma == VLC_CODEC_YV12) {
773 for (int n = 1; n < picture->i_planes; n++) {
774 const plane_t *o = &picture->p[n-1];
775 plane_t *p = &picture->p[n];
777 p->p_pixels = o->p_pixels + o->i_lines * o->i_pitch;
778 p->i_pitch = d3drect.Pitch / 2;
780 /* The d3d buffer is always allocated as YV12 */
781 if (vlc_fourcc_AreUVPlanesSwapped(picture->format.i_chroma, VLC_CODEC_YV12)) {
782 uint8_t *p_tmp = picture->p[1].p_pixels;
783 picture->p[1].p_pixels = picture->p[2].p_pixels;
784 picture->p[2].p_pixels = p_tmp;
790 * It unlocks the surface associated to the picture.
792 static void Direct3DUnlockSurface(picture_t *picture)
794 /* Unlock the Surface */
795 HRESULT hr = IDirect3DSurface9_UnlockRect(picture->p_sys->surface);
797 //msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
802 * It creates the pool of picture (only 1).
804 * Each picture has an associated offscreen surface in video memory
805 * depending on hardware capabilities the picture chroma will be as close
806 * as possible to the orginal render chroma to reduce CPU conversion overhead
807 * and delegate this work to video card GPU
809 static int Direct3DCreatePool(vout_display_t *vd, video_format_t *fmt)
811 vout_display_sys_t *sys = vd->sys;
812 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
817 /* Find the appropriate D3DFORMAT for the render chroma, the format will be the closest to
818 * the requested chroma which is usable by the hardware in an offscreen surface, as they
819 * typically support more formats than textures */
820 const d3d_format_t *d3dfmt = Direct3DFindFormat(vd, fmt->i_chroma, sys->d3dpp.BackBufferFormat);
822 msg_Err(vd, "surface pixel format is not supported.");
825 fmt->i_chroma = d3dfmt->fourcc;
826 fmt->i_rmask = d3dfmt->rmask;
827 fmt->i_gmask = d3dfmt->gmask;
828 fmt->i_bmask = d3dfmt->bmask;
830 /* We create one picture.
831 * It is useless to create more as we can't be used for direct rendering */
833 /* Create a surface */
834 LPDIRECT3DSURFACE9 surface;
835 HRESULT hr = IDirect3DDevice9_CreateOffscreenPlainSurface(d3ddev,
843 msg_Err(vd, "Failed to create picture surface. (hr=0x%lx)", hr);
846 /* fill surface with black color */
847 IDirect3DDevice9_ColorFill(d3ddev, surface, NULL, D3DCOLOR_ARGB(0xFF, 0, 0, 0));
849 /* Create the associated picture */
850 picture_resource_t *rsc = &sys->resource;
851 rsc->p_sys = malloc(sizeof(*rsc->p_sys));
853 IDirect3DSurface9_Release(surface);
856 rsc->p_sys->surface = surface;
857 for (int i = 0; i < PICTURE_PLANE_MAX; i++) {
858 rsc->p[i].p_pixels = NULL;
859 rsc->p[i].i_pitch = 0;
860 rsc->p[i].i_lines = fmt->i_height / (i > 0 ? 2 : 1);
862 picture_t *picture = picture_NewFromResource(fmt, rsc);
864 IDirect3DSurface9_Release(surface);
869 /* Wrap it into a picture pool */
870 picture_pool_configuration_t pool_cfg;
871 memset(&pool_cfg, 0, sizeof(pool_cfg));
872 pool_cfg.picture_count = 1;
873 pool_cfg.picture = &picture;
874 pool_cfg.lock = Direct3DLockSurface;
875 pool_cfg.unlock = Direct3DUnlockSurface;
877 sys->pool = picture_pool_NewExtended(&pool_cfg);
879 picture_Release(picture);
880 IDirect3DSurface9_Release(surface);
886 * It destroys the pool of picture and its resources.
888 static void Direct3DDestroyPool(vout_display_t *vd)
890 vout_display_sys_t *sys = vd->sys;
893 picture_resource_t *rsc = &sys->resource;
894 IDirect3DSurface9_Release(rsc->p_sys->surface);
896 picture_pool_Delete(sys->pool);
904 FLOAT x,y,z; // vertex untransformed position
905 FLOAT rhw; // eye distance
906 D3DCOLOR diffuse; // diffuse color
907 FLOAT tu, tv; // texture relative coordinates
910 #define D3DFVF_CUSTOMVERTEX (D3DFVF_XYZRHW|D3DFVF_DIFFUSE|D3DFVF_TEX1)
913 * It allocates and initializes the resources needed to render the scene.
915 static int Direct3DCreateScene(vout_display_t *vd)
917 vout_display_sys_t *sys = vd->sys;
918 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
922 * Create a texture for use when rendering a scene
923 * for performance reason, texture format is identical to backbuffer
924 * which would usually be a RGB format
926 LPDIRECT3DTEXTURE9 d3dtex;
927 hr = IDirect3DDevice9_CreateTexture(d3ddev,
928 sys->d3dpp.BackBufferWidth,
929 sys->d3dpp.BackBufferHeight,
931 D3DUSAGE_RENDERTARGET,
932 sys->d3dpp.BackBufferFormat,
937 msg_Err(vd, "Failed to create texture. (hr=0x%lx)", hr);
942 ** Create a vertex buffer for use when rendering scene
944 LPDIRECT3DVERTEXBUFFER9 d3dvtc;
945 hr = IDirect3DDevice9_CreateVertexBuffer(d3ddev,
946 sizeof(CUSTOMVERTEX)*4,
947 D3DUSAGE_DYNAMIC|D3DUSAGE_WRITEONLY,
953 msg_Err(vd, "Failed to create vertex buffer. (hr=0x%lx)", hr);
954 IDirect3DTexture9_Release(d3dtex);
959 sys->d3dtex = d3dtex;
960 sys->d3dvtc = d3dvtc;
962 // Texture coordinates outside the range [0.0, 1.0] are set
963 // to the texture color at 0.0 or 1.0, respectively.
964 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_ADDRESSU, D3DTADDRESS_CLAMP);
965 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_ADDRESSV, D3DTADDRESS_CLAMP);
967 // Set linear filtering quality
968 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MINFILTER, D3DTEXF_LINEAR);
969 IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MAGFILTER, D3DTEXF_LINEAR);
971 // set maximum ambient light
972 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_AMBIENT, D3DCOLOR_XRGB(255,255,255));
975 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_CULLMODE, D3DCULL_NONE);
977 // Turn off the zbuffer
978 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ZENABLE, D3DZB_FALSE);
981 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_LIGHTING, FALSE);
984 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_DITHERENABLE, TRUE);
987 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_STENCILENABLE, FALSE);
990 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, TRUE);
991 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_SRCBLEND,D3DBLEND_SRCALPHA);
992 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_DESTBLEND,D3DBLEND_INVSRCALPHA);
993 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHATESTENABLE,TRUE);
994 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHAREF, 0x10);
995 IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHAFUNC,D3DCMP_GREATER);
997 // Set texture states
998 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLOROP,D3DTOP_MODULATE);
999 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLORARG1,D3DTA_TEXTURE);
1000 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLORARG2,D3DTA_DIFFUSE);
1002 // turn off alpha operation
1003 IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAOP, D3DTOP_DISABLE);
1005 msg_Dbg(vd, "Direct3D scene created successfully");
1011 * It releases the scene resources.
1013 static void Direct3DDestroyScene(vout_display_t *vd)
1015 vout_display_sys_t *sys = vd->sys;
1017 LPDIRECT3DVERTEXBUFFER9 d3dvtc = sys->d3dvtc;
1019 IDirect3DVertexBuffer9_Release(d3dvtc);
1021 LPDIRECT3DTEXTURE9 d3dtex = sys->d3dtex;
1023 IDirect3DTexture9_Release(d3dtex);
1027 msg_Dbg(vd, "Direct3D scene released successfully");
1031 * It copies picture surface into a texture and renders into a scene.
1033 * This function is intented for higher end 3D cards, with pixel shader support
1034 * and at least 64 MiB of video RAM.
1036 static void Direct3DRenderScene(vout_display_t *vd, LPDIRECT3DSURFACE9 surface)
1038 vout_display_sys_t *sys = vd->sys;
1039 LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
1042 // check if device is still available
1043 hr = IDirect3DDevice9_TestCooperativeLevel(d3ddev);
1045 if (hr == D3DERR_DEVICENOTRESET && !sys->reset_device) {
1046 vout_display_SendEventPicturesInvalid(vd);
1047 sys->reset_device = true;
1052 LPDIRECT3DTEXTURE9 d3dtex = sys->d3dtex;
1053 LPDIRECT3DVERTEXBUFFER9 d3dvtc = sys->d3dvtc;
1055 /* Clear the backbuffer and the zbuffer */
1056 hr = IDirect3DDevice9_Clear(d3ddev, 0, NULL, D3DCLEAR_TARGET,
1057 D3DCOLOR_XRGB(0, 0, 0), 1.0f, 0);
1059 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1062 /* retrieve picture surface */
1063 LPDIRECT3DSURFACE9 d3dsrc = surface;
1065 msg_Dbg(vd, "no surface to render ?");
1069 /* retrieve texture top-level surface */
1070 LPDIRECT3DSURFACE9 d3ddest;
1071 hr = IDirect3DTexture9_GetSurfaceLevel(d3dtex, 0, &d3ddest);
1073 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1077 /* Copy picture surface into texture surface
1078 * color space conversion and scaling happen here */
1079 RECT src = vd->sys->rect_src_clipped;
1080 RECT dst = vd->sys->rect_dest_clipped;
1082 hr = IDirect3DDevice9_StretchRect(d3ddev, d3dsrc, &src, d3ddest, &dst, D3DTEXF_LINEAR);
1083 IDirect3DSurface9_Release(d3ddest);
1085 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1089 /* Update the vertex buffer */
1090 CUSTOMVERTEX *vertices;
1091 hr = IDirect3DVertexBuffer9_Lock(d3dvtc, 0, 0, &vertices, D3DLOCK_DISCARD);
1093 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1097 /* Setup vertices */
1098 const float f_width = vd->sys->d3dpp.BackBufferWidth;
1099 const float f_height = vd->sys->d3dpp.BackBufferHeight;
1101 /* -0.5f is a "feature" of DirectX and it seems to apply to Direct3d also */
1102 /* http://www.sjbrown.co.uk/2003/05/01/fix-directx-rasterisation/ */
1103 vertices[0].x = -0.5f; // left
1104 vertices[0].y = -0.5f; // top
1105 vertices[0].z = 0.0f;
1106 vertices[0].diffuse = D3DCOLOR_ARGB(255, 255, 255, 255);
1107 vertices[0].rhw = 1.0f;
1108 vertices[0].tu = 0.0f;
1109 vertices[0].tv = 0.0f;
1111 vertices[1].x = f_width - 0.5f; // right
1112 vertices[1].y = -0.5f; // top
1113 vertices[1].z = 0.0f;
1114 vertices[1].diffuse = D3DCOLOR_ARGB(255, 255, 255, 255);
1115 vertices[1].rhw = 1.0f;
1116 vertices[1].tu = 1.0f;
1117 vertices[1].tv = 0.0f;
1119 vertices[2].x = f_width - 0.5f; // right
1120 vertices[2].y = f_height - 0.5f; // bottom
1121 vertices[2].z = 0.0f;
1122 vertices[2].diffuse = D3DCOLOR_ARGB(255, 255, 255, 255);
1123 vertices[2].rhw = 1.0f;
1124 vertices[2].tu = 1.0f;
1125 vertices[2].tv = 1.0f;
1127 vertices[3].x = -0.5f; // left
1128 vertices[3].y = f_height - 0.5f; // bottom
1129 vertices[3].z = 0.0f;
1130 vertices[3].diffuse = D3DCOLOR_ARGB(255, 255, 255, 255);
1131 vertices[3].rhw = 1.0f;
1132 vertices[3].tu = 0.0f;
1133 vertices[3].tv = 1.0f;
1135 hr= IDirect3DVertexBuffer9_Unlock(d3dvtc);
1137 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1142 hr = IDirect3DDevice9_BeginScene(d3ddev);
1144 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1148 // Setup our texture. Using textures introduces the texture stage states,
1149 // which govern how textures get blended together (in the case of multiple
1150 // textures) and lighting information. In this case, we are modulating
1151 // (blending) our texture with the diffuse color of the vertices.
1152 hr = IDirect3DDevice9_SetTexture(d3ddev, 0, (LPDIRECT3DBASETEXTURE9)d3dtex);
1154 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1155 IDirect3DDevice9_EndScene(d3ddev);
1159 // Render the vertex buffer contents
1160 hr = IDirect3DDevice9_SetStreamSource(d3ddev, 0, d3dvtc, 0, sizeof(CUSTOMVERTEX));
1162 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1163 IDirect3DDevice9_EndScene(d3ddev);
1167 // we use FVF instead of vertex shader
1168 hr = IDirect3DDevice9_SetFVF(d3ddev, D3DFVF_CUSTOMVERTEX);
1170 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1171 IDirect3DDevice9_EndScene(d3ddev);
1176 hr = IDirect3DDevice9_DrawPrimitive(d3ddev, D3DPT_TRIANGLEFAN, 0, 2);
1178 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1179 IDirect3DDevice9_EndScene(d3ddev);
1184 hr = IDirect3DDevice9_EndScene(d3ddev);
1186 msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1191 /*****************************************************************************
1192 * DesktopCallback: desktop mode variable callback
1193 *****************************************************************************/
1194 static int DesktopCallback(vlc_object_t *object, char const *psz_cmd,
1195 vlc_value_t oldval, vlc_value_t newval,
1198 vout_display_t *vd = (vout_display_t *)object;
1199 vout_display_sys_t *sys = vd->sys;
1200 VLC_UNUSED(psz_cmd);
1204 vlc_mutex_lock(&sys->lock);
1205 const bool ch_desktop = !sys->desktop_requested != !newval.b_bool;
1206 sys->ch_desktop |= ch_desktop;
1207 sys->desktop_requested = newval.b_bool;
1208 vlc_mutex_unlock(&sys->lock);
1210 /* FIXME we should have a way to export variable to be saved */
1212 playlist_t *p_playlist = pl_Get(vd);
1213 /* Modify playlist as well because the vout might have to be
1215 var_Create(p_playlist, "direct3d-desktop", VLC_VAR_BOOL);
1216 var_SetBool(p_playlist, "direct3d-desktop", newval.b_bool);