git.sesse.net Git - vlc/blob - modules/video_output/msw/direct3d.c

   1 /*****************************************************************************
   2  * direct3d.c: Windows Direct3D video output module
   3  *****************************************************************************
   4  * Copyright (C) 2006-2009 VLC authors and VideoLAN
   5  *$Id$
   6  *
   7  * Authors: Damien Fouilleul <damienf@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble:
  26  *
  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.
  30  *
  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.
  34  *
  35  *****************************************************************************/
  36 #ifdef HAVE_CONFIG_H
  37 # include "config.h"
  38 #endif
  39
  40 #include <vlc_common.h>
  41 #include <vlc_plugin.h>
  42 #include <vlc_vout_display.h>
  43
  44 #include <windows.h>
  45 #include <d3d9.h>
  46
  47 #include "common.h"
  48
  49 /*****************************************************************************
  50  * Module descriptor
  51  *****************************************************************************/
  52 static int  Open(vlc_object_t *);
  53 static void Close(vlc_object_t *);
  54
  55 #define DESKTOP_TEXT N_("Enable desktop mode ")
  56 #define DESKTOP_LONGTEXT N_(\
  57     "The desktop mode allows you to display the video on the desktop.")
  58
  59 #define HW_BLENDING_TEXT N_("Use hardware blending support")
  60 #define HW_BLENDING_LONGTEXT N_(\
  61     "Try to use hardware acceleration for subtitle/OSD blending.")
  62
  63 #define D3D_HELP N_("Recommended video output for Windows Vista and later versions")
  64
  65 vlc_module_begin ()
  66     set_shortname("Direct3D")
  67     set_description(N_("Direct3D video output"))
  68     set_help(D3D_HELP)
  69     set_category(CAT_VIDEO)
  70     set_subcategory(SUBCAT_VIDEO_VOUT)
  71
  72     add_bool("direct3d-hw-blending", true, HW_BLENDING_TEXT, HW_BLENDING_LONGTEXT, true)
  73
  74     set_capability("vout display", 240)
  75     add_shortcut("direct3d")
  76     set_callbacks(Open, Close)
  77
  78 vlc_module_end ()
  79
  80 /*****************************************************************************
  81  * Local prototypes.
  82  *****************************************************************************/
  83 static const vlc_fourcc_t d3d_subpicture_chromas[] = {
  84     VLC_CODEC_RGBA,
  85     0
  86 };
  87
  88 struct picture_sys_t
  89 {
  90     LPDIRECT3DSURFACE9 surface;
  91     picture_t          *fallback;
  92 };
  93
  94 static int  Open(vlc_object_t *);
  95
  96 static picture_pool_t *Pool  (vout_display_t *, unsigned);
  97 static void           Prepare(vout_display_t *, picture_t *, subpicture_t *subpicture);
  98 static void           Display(vout_display_t *, picture_t *, subpicture_t *subpicture);
  99 static int            Control(vout_display_t *, int, va_list);
 100 static void           Manage (vout_display_t *);
 101
 102 static int  Direct3DCreate (vout_display_t *);
 103 static int  Direct3DReset  (vout_display_t *);
 104 static void Direct3DDestroy(vout_display_t *);
 105
 106 static int  Direct3DOpen (vout_display_t *, video_format_t *);
 107 static void Direct3DClose(vout_display_t *);
 108
 109 /* */
 110 typedef struct
 111 {
 112     FLOAT       x,y,z;      // vertex untransformed position
 113     FLOAT       rhw;        // eye distance
 114     D3DCOLOR    diffuse;    // diffuse color
 115     FLOAT       tu, tv;     // texture relative coordinates
 116 } CUSTOMVERTEX;
 117 #define D3DFVF_CUSTOMVERTEX (D3DFVF_XYZRHW|D3DFVF_DIFFUSE|D3DFVF_TEX1)
 118
 119 typedef struct d3d_region_t {
 120     D3DFORMAT          format;
 121     unsigned           width;
 122     unsigned           height;
 123     CUSTOMVERTEX       vertex[4];
 124     LPDIRECT3DTEXTURE9 texture;
 125 } d3d_region_t;
 126
 127 static void Direct3DDeleteRegions(int, d3d_region_t *);
 128
 129 static int  Direct3DImportPicture(vout_display_t *vd, d3d_region_t *, LPDIRECT3DSURFACE9 surface);
 130 static void Direct3DImportSubpicture(vout_display_t *vd, int *, d3d_region_t **, subpicture_t *);
 131
 132 static void Direct3DRenderScene(vout_display_t *vd, d3d_region_t *, int, d3d_region_t *);
 133
 134 /* */
 135 static int DesktopCallback(vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *);
 136
 137 /**
 138  * It creates a Direct3D vout display.
 139  */
 140 static int Open(vlc_object_t *object)
 141 {
 142     vout_display_t *vd = (vout_display_t *)object;
 143     vout_display_sys_t *sys;
 144
 145     /* Allocate structure */
 146     vd->sys = sys = calloc(1, sizeof(vout_display_sys_t));
 147     if (!sys)
 148         return VLC_ENOMEM;
 149
 150     if (Direct3DCreate(vd)) {
 151         msg_Err(vd, "Direct3D could not be initialized");
 152         Direct3DDestroy(vd);
 153         free(sys);
 154         return VLC_EGENERIC;
 155     }
 156
 157     sys->use_desktop = var_CreateGetBool(vd, "video-wallpaper");
 158     sys->reset_device = false;
 159     sys->reset_device = false;
 160     sys->allow_hw_yuv = var_CreateGetBool(vd, "directx-hw-yuv");
 161     sys->desktop_save.is_fullscreen = vd->cfg->is_fullscreen;
 162     sys->desktop_save.is_on_top     = false;
 163     sys->desktop_save.win.left      = var_InheritInteger(vd, "video-x");
 164     sys->desktop_save.win.right     = vd->cfg->display.width;
 165     sys->desktop_save.win.top       = var_InheritInteger(vd, "video-y");
 166     sys->desktop_save.win.bottom    = vd->cfg->display.height;
 167
 168     if (CommonInit(vd))
 169         goto error;
 170
 171     /* */
 172     video_format_t fmt;
 173     if (Direct3DOpen(vd, &fmt)) {
 174         msg_Err(vd, "Direct3D could not be opened");
 175         goto error;
 176     }
 177
 178     /* */
 179     vout_display_info_t info = vd->info;
 180     info.is_slow = true;
 181     info.has_double_click = true;
 182     info.has_hide_mouse = false;
 183     info.has_pictures_invalid = true;
 184     info.has_event_thread = true;
 185     if (var_InheritBool(vd, "direct3d-hw-blending") &&
 186         sys->d3dregion_format != D3DFMT_UNKNOWN &&
 187         (sys->d3dcaps.SrcBlendCaps  & D3DPBLENDCAPS_SRCALPHA) &&
 188         (sys->d3dcaps.DestBlendCaps & D3DPBLENDCAPS_INVSRCALPHA) &&
 189         (sys->d3dcaps.TextureCaps   & D3DPTEXTURECAPS_ALPHA) &&
 190         (sys->d3dcaps.TextureOpCaps & D3DTEXOPCAPS_SELECTARG1) &&
 191         (sys->d3dcaps.TextureOpCaps & D3DTEXOPCAPS_MODULATE))
 192         info.subpicture_chromas = d3d_subpicture_chromas;
 193     else
 194         info.subpicture_chromas = NULL;
 195
 196     /* Interaction */
 197     vlc_mutex_init(&sys->lock);
 198     sys->ch_desktop = false;
 199     sys->desktop_requested = sys->use_desktop;
 200
 201     vlc_value_t val;
 202     val.psz_string = _("Desktop");
 203     var_Change(vd, "video-wallpaper", VLC_VAR_SETTEXT, &val, NULL);
 204     var_AddCallback(vd, "video-wallpaper", DesktopCallback, NULL);
 205
 206     /* Setup vout_display now that everything is fine */
 207     vd->fmt  = fmt;
 208     vd->info = info;
 209
 210     vd->pool    = Pool;
 211     vd->prepare = Prepare;
 212     vd->display = Display;
 213     vd->control = Control;
 214     vd->manage  = Manage;
 215
 216     /* Fix state in case of desktop mode */
 217     if (sys->use_desktop && vd->cfg->is_fullscreen)
 218         vout_display_SendEventFullscreen(vd, false);
 219
 220     return VLC_SUCCESS;
 221 error:
 222     Direct3DClose(vd);
 223     CommonClean(vd);
 224     Direct3DDestroy(vd);
 225     free(vd->sys);
 226     return VLC_EGENERIC;
 227 }
 228
 229 /**
 230  * It destroyes a Direct3D vout display.
 231  */
 232 static void Close(vlc_object_t *object)
 233 {
 234     vout_display_t * vd = (vout_display_t *)object;
 235
 236     var_DelCallback(vd, "video-wallpaper", DesktopCallback, NULL);
 237     vlc_mutex_destroy(&vd->sys->lock);
 238
 239     Direct3DClose(vd);
 240
 241     CommonClean(vd);
 242
 243     Direct3DDestroy(vd);
 244
 245     free(vd->sys);
 246 }
 247
 248 /* */
 249 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
 250 {
 251     VLC_UNUSED(count);
 252     return vd->sys->pool;
 253 }
 254
 255 static int  Direct3DLockSurface(picture_t *);
 256 static void Direct3DUnlockSurface(picture_t *);
 257
 258 static void Prepare(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
 259 {
 260     vout_display_sys_t *sys = vd->sys;
 261     LPDIRECT3DSURFACE9 surface = picture->p_sys->surface;
 262 #if 0
 263     picture_Release(picture);
 264     VLC_UNUSED(subpicture);
 265 #else
 266     /* FIXME it is a bit ugly, we need the surface to be unlocked for
 267      * rendering.
 268      *  The clean way would be to release the picture (and ensure that
 269      * the vout doesn't keep a reference). But because of the vout
 270      * wrapper, we can't */
 271
 272     Direct3DUnlockSurface(picture);
 273     VLC_UNUSED(subpicture);
 274 #endif
 275
 276     /* check if device is still available */
 277     HRESULT hr = IDirect3DDevice9_TestCooperativeLevel(sys->d3ddev);
 278     if (FAILED(hr)) {
 279         if (hr == D3DERR_DEVICENOTRESET && !sys->reset_device) {
 280             vout_display_SendEventPicturesInvalid(vd);
 281             sys->reset_device = true;
 282         }
 283         return;
 284     }
 285
 286     d3d_region_t picture_region;
 287     if (!Direct3DImportPicture(vd, &picture_region, surface)) {
 288         int subpicture_region_count     = 0;
 289         d3d_region_t *subpicture_region = NULL;
 290         if (subpicture)
 291             Direct3DImportSubpicture(vd, &subpicture_region_count, &subpicture_region,
 292                                      subpicture);
 293
 294         Direct3DRenderScene(vd, &picture_region,
 295                             subpicture_region_count, subpicture_region);
 296
 297         Direct3DDeleteRegions(sys->d3dregion_count, sys->d3dregion);
 298         sys->d3dregion_count = subpicture_region_count;
 299         sys->d3dregion       = subpicture_region;
 300     }
 301 }
 302
 303 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
 304 {
 305     vout_display_sys_t *sys = vd->sys;
 306     LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
 307
 308     // Present the back buffer contents to the display
 309     // No stretching should happen here !
 310     const RECT src = sys->rect_dest_clipped;
 311     const RECT dst = sys->rect_dest_clipped;
 312     HRESULT hr = IDirect3DDevice9_Present(d3ddev, &src, &dst, NULL, NULL);
 313     if (FAILED(hr)) {
 314         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
 315     }
 316
 317 #if 0
 318     VLC_UNUSED(picture);
 319     VLC_UNUSED(subpicture);
 320 #else
 321     /* XXX See Prepare() */
 322     Direct3DLockSurface(picture);
 323     picture_Release(picture);
 324 #endif
 325     if (subpicture)
 326         subpicture_Delete(subpicture);
 327
 328     CommonDisplay(vd);
 329 }
 330 static int ControlResetDevice(vout_display_t *vd)
 331 {
 332     return Direct3DReset(vd);
 333 }
 334 static int ControlReopenDevice(vout_display_t *vd)
 335 {
 336     vout_display_sys_t *sys = vd->sys;
 337
 338     if (!sys->use_desktop) {
 339         /* Save non-desktop state */
 340         sys->desktop_save.is_fullscreen = vd->cfg->is_fullscreen;
 341         sys->desktop_save.is_on_top     = sys->is_on_top;
 342
 343         WINDOWPLACEMENT wp = { .length = sizeof(wp), };
 344         GetWindowPlacement(sys->hparent ? sys->hparent : sys->hwnd, &wp);
 345         sys->desktop_save.win = wp.rcNormalPosition;
 346     }
 347
 348     /* */
 349     Direct3DClose(vd);
 350     EventThreadStop(sys->event);
 351
 352     /* */
 353     vlc_mutex_lock(&sys->lock);
 354     sys->use_desktop = sys->desktop_requested;
 355     sys->ch_desktop = false;
 356     vlc_mutex_unlock(&sys->lock);
 357
 358     /* */
 359     event_cfg_t cfg;
 360     memset(&cfg, 0, sizeof(cfg));
 361     cfg.use_desktop = sys->use_desktop;
 362     if (!sys->use_desktop) {
 363         cfg.win.type   = VOUT_WINDOW_TYPE_HWND;
 364         cfg.win.x      = sys->desktop_save.win.left;
 365         cfg.win.y      = sys->desktop_save.win.top;
 366         cfg.win.width  = sys->desktop_save.win.right  - sys->desktop_save.win.left;
 367         cfg.win.height = sys->desktop_save.win.bottom - sys->desktop_save.win.top;
 368     }
 369
 370     event_hwnd_t hwnd;
 371     if (EventThreadStart(sys->event, &hwnd, &cfg)) {
 372         msg_Err(vd, "Failed to restart event thread");
 373         return VLC_EGENERIC;
 374     }
 375     sys->parent_window = hwnd.parent_window;
 376     sys->hparent       = hwnd.hparent;
 377     sys->hwnd          = hwnd.hwnd;
 378     sys->hvideownd     = hwnd.hvideownd;
 379     sys->hfswnd        = hwnd.hfswnd;
 380     SetRectEmpty(&sys->rect_parent);
 381
 382     /* */
 383     video_format_t fmt;
 384     if (Direct3DOpen(vd, &fmt)) {
 385         CommonClean(vd);
 386         msg_Err(vd, "Failed to reopen device");
 387         return VLC_EGENERIC;
 388     }
 389     vd->fmt = fmt;
 390     sys->is_first_display = true;
 391
 392     if (sys->use_desktop) {
 393         /* Disable fullscreen/on_top while using desktop */
 394         if (sys->desktop_save.is_fullscreen)
 395             vout_display_SendEventFullscreen(vd, false);
 396         if (sys->desktop_save.is_on_top)
 397             vout_display_SendWindowState(vd, VOUT_WINDOW_STATE_NORMAL);
 398     } else {
 399         /* Restore fullscreen/on_top */
 400         if (sys->desktop_save.is_fullscreen)
 401             vout_display_SendEventFullscreen(vd, true);
 402         if (sys->desktop_save.is_on_top)
 403             vout_display_SendWindowState(vd, VOUT_WINDOW_STATE_ABOVE);
 404     }
 405     return VLC_SUCCESS;
 406 }
 407 static int Control(vout_display_t *vd, int query, va_list args)
 408 {
 409     vout_display_sys_t *sys = vd->sys;
 410
 411     switch (query) {
 412     case VOUT_DISPLAY_RESET_PICTURES:
 413         /* FIXME what to do here in case of failure */
 414         if (sys->reset_device) {
 415             if (ControlResetDevice(vd)) {
 416                 msg_Err(vd, "Failed to reset device");
 417                 return VLC_EGENERIC;
 418             }
 419             sys->reset_device = false;
 420         } else if(sys->reopen_device) {
 421             if (ControlReopenDevice(vd)) {
 422                 msg_Err(vd, "Failed to reopen device");
 423                 return VLC_EGENERIC;
 424             }
 425             sys->reopen_device = false;
 426         }
 427         return VLC_SUCCESS;
 428     default:
 429         return CommonControl(vd, query, args);
 430     }
 431 }
 432 static void Manage (vout_display_t *vd)
 433 {
 434     vout_display_sys_t *sys = vd->sys;
 435
 436     CommonManage(vd);
 437
 438     /* Desktop mode change */
 439     vlc_mutex_lock(&sys->lock);
 440     const bool ch_desktop = sys->ch_desktop;
 441     sys->ch_desktop = false;
 442     vlc_mutex_unlock(&sys->lock);
 443
 444     if (ch_desktop) {
 445         sys->reopen_device = true;
 446         vout_display_SendEventPicturesInvalid(vd);
 447     }
 448
 449     /* Position Change */
 450     if (sys->changes & DX_POSITION_CHANGE) {
 451 #if 0 /* need that when bicubic filter is available */
 452         RECT rect;
 453         UINT width, height;
 454
 455         GetClientRect(p_sys->hvideownd, &rect);
 456         width  = rect.right-rect.left;
 457         height = rect.bottom-rect.top;
 458
 459         if (width != p_sys->d3dpp.BackBufferWidth || height != p_sys->d3dpp.BackBufferHeight)
 460         {
 461             msg_Dbg(vd, "resizing device back buffers to (%lux%lu)", width, height);
 462             // need to reset D3D device to resize back buffer
 463             if (VLC_SUCCESS != Direct3DResetDevice(vd, width, height))
 464                 return VLC_EGENERIC;
 465         }
 466 #endif
 467         sys->clear_scene = true;
 468         sys->changes &= ~DX_POSITION_CHANGE;
 469     }
 470 }
 471
 472 /**
 473  * It initializes an instance of Direct3D9
 474  */
 475 static int Direct3DCreate(vout_display_t *vd)
 476 {
 477     vout_display_sys_t *sys = vd->sys;
 478
 479     sys->hd3d9_dll = LoadLibrary(TEXT("D3D9.DLL"));
 480     if (!sys->hd3d9_dll) {
 481         msg_Warn(vd, "cannot load d3d9.dll, aborting");
 482         return VLC_EGENERIC;
 483     }
 484
 485     LPDIRECT3D9 (WINAPI *OurDirect3DCreate9)(UINT SDKVersion);
 486     OurDirect3DCreate9 =
 487         (void *)GetProcAddress(sys->hd3d9_dll, "Direct3DCreate9");
 488     if (!OurDirect3DCreate9) {
 489         msg_Err(vd, "Cannot locate reference to Direct3DCreate9 ABI in DLL");
 490         return VLC_EGENERIC;
 491     }
 492
 493     /* Create the D3D object. */
 494     LPDIRECT3D9 d3dobj = OurDirect3DCreate9(D3D_SDK_VERSION);
 495     if (!d3dobj) {
 496        msg_Err(vd, "Could not create Direct3D9 instance.");
 497        return VLC_EGENERIC;
 498     }
 499     sys->d3dobj = d3dobj;
 500
 501     /*
 502     ** Get device capabilities
 503     */
 504     ZeroMemory(&sys->d3dcaps, sizeof(sys->d3dcaps));
 505     HRESULT hr = IDirect3D9_GetDeviceCaps(d3dobj, D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, &sys->d3dcaps);
 506     if (FAILED(hr)) {
 507        msg_Err(vd, "Could not read adapter capabilities. (hr=0x%lX)", hr);
 508        return VLC_EGENERIC;
 509     }
 510
 511     /* TODO: need to test device capabilities and select the right render function */
 512     if (!(sys->d3dcaps.DevCaps2 & D3DDEVCAPS2_CAN_STRETCHRECT_FROM_TEXTURES) ||
 513         !(sys->d3dcaps.TextureFilterCaps & (D3DPTFILTERCAPS_MAGFLINEAR)) ||
 514         !(sys->d3dcaps.TextureFilterCaps & (D3DPTFILTERCAPS_MINFLINEAR))) {
 515         msg_Err(vd, "Device does not support stretching from textures.");
 516         return VLC_EGENERIC;
 517     }
 518
 519     return VLC_SUCCESS;
 520 }
 521
 522 /**
 523  * It releases an instance of Direct3D9
 524  */
 525 static void Direct3DDestroy(vout_display_t *vd)
 526 {
 527     vout_display_sys_t *sys = vd->sys;
 528
 529     if (sys->d3dobj)
 530        IDirect3D9_Release(sys->d3dobj);
 531     if (sys->hd3d9_dll)
 532         FreeLibrary(sys->hd3d9_dll);
 533
 534     sys->d3dobj = NULL;
 535     sys->hd3d9_dll = NULL;
 536 }
 537
 538
 539 /**
 540  * It setup vout_display_sys_t::d3dpp and vout_display_sys_t::rect_display
 541  * from the default adapter.
 542  */
 543 static int Direct3DFillPresentationParameters(vout_display_t *vd)
 544 {
 545     vout_display_sys_t *sys = vd->sys;
 546
 547     /*
 548     ** Get the current desktop display mode, so we can set up a back
 549     ** buffer of the same format
 550     */
 551     D3DDISPLAYMODE d3ddm;
 552     HRESULT hr = IDirect3D9_GetAdapterDisplayMode(sys->d3dobj,
 553                                                   D3DADAPTER_DEFAULT, &d3ddm);
 554     if (FAILED(hr)) {
 555        msg_Err(vd, "Could not read adapter display mode. (hr=0x%lX)", hr);
 556        return VLC_EGENERIC;
 557     }
 558
 559     /* Set up the structure used to create the D3DDevice. */
 560     D3DPRESENT_PARAMETERS *d3dpp = &vd->sys->d3dpp;
 561     ZeroMemory(d3dpp, sizeof(D3DPRESENT_PARAMETERS));
 562     d3dpp->Flags                  = D3DPRESENTFLAG_VIDEO;
 563     d3dpp->Windowed               = TRUE;
 564     d3dpp->hDeviceWindow          = vd->sys->hvideownd;
 565     d3dpp->BackBufferWidth        = __MAX((unsigned int)GetSystemMetrics(SM_CXVIRTUALSCREEN),
 566                                           d3ddm.Width);
 567     d3dpp->BackBufferHeight       = __MAX((unsigned int)GetSystemMetrics(SM_CYVIRTUALSCREEN),
 568                                           d3ddm.Height);
 569     d3dpp->SwapEffect             = D3DSWAPEFFECT_COPY;
 570     d3dpp->MultiSampleType        = D3DMULTISAMPLE_NONE;
 571     d3dpp->PresentationInterval   = D3DPRESENT_INTERVAL_DEFAULT;
 572     d3dpp->BackBufferFormat       = d3ddm.Format;
 573     d3dpp->BackBufferCount        = 1;
 574     d3dpp->EnableAutoDepthStencil = FALSE;
 575
 576     /* */
 577     RECT *display = &vd->sys->rect_display;
 578     display->left   = 0;
 579     display->top    = 0;
 580     display->right  = d3dpp->BackBufferWidth;
 581     display->bottom = d3dpp->BackBufferHeight;
 582
 583     return VLC_SUCCESS;
 584 }
 585
 586 /* */
 587 static int  Direct3DCreateResources (vout_display_t *, video_format_t *);
 588 static void Direct3DDestroyResources(vout_display_t *);
 589
 590 /**
 591  * It creates a Direct3D device and the associated resources.
 592  */
 593 static int Direct3DOpen(vout_display_t *vd, video_format_t *fmt)
 594 {
 595     vout_display_sys_t *sys = vd->sys;
 596     LPDIRECT3D9 d3dobj = sys->d3dobj;
 597
 598     if (Direct3DFillPresentationParameters(vd))
 599         return VLC_EGENERIC;
 600
 601     // Create the D3DDevice
 602     LPDIRECT3DDEVICE9 d3ddev;
 603
 604     UINT AdapterToUse = D3DADAPTER_DEFAULT;
 605     D3DDEVTYPE DeviceType = D3DDEVTYPE_HAL;
 606
 607 #ifndef NDEBUG
 608     // Look for 'NVIDIA PerfHUD' adapter
 609     // If it is present, override default settings
 610     for (UINT Adapter=0; Adapter< IDirect3D9_GetAdapterCount(d3dobj); ++Adapter) {
 611         D3DADAPTER_IDENTIFIER9 Identifier;
 612         HRESULT Res = IDirect3D9_GetAdapterIdentifier(d3dobj,Adapter,0,&Identifier);
 613         if (SUCCEEDED(Res) && strstr(Identifier.Description,"PerfHUD") != 0) {
 614             AdapterToUse = Adapter;
 615             DeviceType = D3DDEVTYPE_REF;
 616             break;
 617         }
 618     }
 619 #endif
 620
 621     /* */
 622     D3DADAPTER_IDENTIFIER9 d3dai;
 623     if (FAILED(IDirect3D9_GetAdapterIdentifier(d3dobj,AdapterToUse,0, &d3dai))) {
 624         msg_Warn(vd, "IDirect3D9_GetAdapterIdentifier failed");
 625     } else {
 626         msg_Dbg(vd, "Direct3d Device: %s %lu %lu %lu", d3dai.Description,
 627                 d3dai.VendorId, d3dai.DeviceId, d3dai.Revision );
 628     }
 629
 630     HRESULT hr = IDirect3D9_CreateDevice(d3dobj, AdapterToUse,
 631                                          DeviceType, sys->hvideownd,
 632                                          D3DCREATE_SOFTWARE_VERTEXPROCESSING|
 633                                          D3DCREATE_MULTITHREADED,
 634                                          &sys->d3dpp, &d3ddev);
 635     if (FAILED(hr)) {
 636        msg_Err(vd, "Could not create the D3D device! (hr=0x%lX)", hr);
 637        return VLC_EGENERIC;
 638     }
 639     sys->d3ddev = d3ddev;
 640
 641     UpdateRects(vd, NULL, NULL, true);
 642
 643     if (Direct3DCreateResources(vd, fmt)) {
 644         msg_Err(vd, "Failed to allocate resources");
 645         return VLC_EGENERIC;
 646     }
 647
 648     /* Change the window title bar text */
 649     EventThreadUpdateTitle(sys->event, VOUT_TITLE " (Direct3D output)");
 650
 651     msg_Dbg(vd, "Direct3D device adapter successfully initialized");
 652     return VLC_SUCCESS;
 653 }
 654
 655 /**
 656  * It releases the Direct3D9 device and its resources.
 657  */
 658 static void Direct3DClose(vout_display_t *vd)
 659 {
 660     vout_display_sys_t *sys = vd->sys;
 661
 662     Direct3DDestroyResources(vd);
 663
 664     if (sys->d3ddev)
 665        IDirect3DDevice9_Release(sys->d3ddev);
 666
 667     sys->d3ddev = NULL;
 668 }
 669
 670 /**
 671  * It reset the Direct3D9 device and its resources.
 672  */
 673 static int Direct3DReset(vout_display_t *vd)
 674 {
 675     vout_display_sys_t *sys = vd->sys;
 676     LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
 677
 678     if (Direct3DFillPresentationParameters(vd))
 679         return VLC_EGENERIC;
 680
 681     /* release all D3D objects */
 682     Direct3DDestroyResources(vd);
 683
 684     /* */
 685     HRESULT hr = IDirect3DDevice9_Reset(d3ddev, &sys->d3dpp);
 686     if (FAILED(hr)) {
 687         msg_Err(vd, "%s failed ! (hr=%08lX)", __FUNCTION__, hr);
 688         return VLC_EGENERIC;
 689     }
 690
 691     UpdateRects(vd, NULL, NULL, true);
 692
 693     /* re-create them */
 694     if (Direct3DCreateResources(vd, &vd->fmt)) {
 695         msg_Dbg(vd, "%s failed !", __FUNCTION__);
 696         return VLC_EGENERIC;
 697     }
 698     return VLC_SUCCESS;
 699 }
 700
 701 /* */
 702 static int  Direct3DCreatePool(vout_display_t *vd, video_format_t *fmt);
 703 static void Direct3DDestroyPool(vout_display_t *vd);
 704
 705 static int  Direct3DCreateScene(vout_display_t *vd, const video_format_t *fmt);
 706 static void Direct3DDestroyScene(vout_display_t *vd);
 707
 708 /**
 709  * It creates the picture and scene resources.
 710  */
 711 static int Direct3DCreateResources(vout_display_t *vd, video_format_t *fmt)
 712 {
 713     vout_display_sys_t *sys = vd->sys;
 714
 715     if (Direct3DCreatePool(vd, fmt)) {
 716         msg_Err(vd, "Direct3D picture pool initialization failed");
 717         return VLC_EGENERIC;
 718     }
 719     if (Direct3DCreateScene(vd, fmt)) {
 720         msg_Err(vd, "Direct3D scene initialization failed !");
 721         return VLC_EGENERIC;
 722     }
 723     sys->d3dregion_format = D3DFMT_UNKNOWN;
 724     for (int i = 0; i < 2; i++) {
 725         D3DFORMAT fmt = i == 0 ? D3DFMT_A8B8G8R8 : D3DFMT_A8R8G8B8;
 726         if (SUCCEEDED(IDirect3D9_CheckDeviceFormat(sys->d3dobj,
 727                                                    D3DADAPTER_DEFAULT,
 728                                                    D3DDEVTYPE_HAL,
 729                                                    sys->d3dpp.BackBufferFormat,
 730                                                    D3DUSAGE_DYNAMIC,
 731                                                    D3DRTYPE_TEXTURE,
 732                                                    fmt))) {
 733             sys->d3dregion_format = fmt;
 734             break;
 735         }
 736     }
 737     return VLC_SUCCESS;
 738 }
 739 /**
 740  * It destroys the picture and scene resources.
 741  */
 742 static void Direct3DDestroyResources(vout_display_t *vd)
 743 {
 744     Direct3DDestroyScene(vd);
 745     Direct3DDestroyPool(vd);
 746 }
 747
 748 /**
 749  * It tests if the conversion from src to dst is supported.
 750  */
 751 static int Direct3DCheckConversion(vout_display_t *vd,
 752                                    D3DFORMAT src, D3DFORMAT dst)
 753 {
 754     vout_display_sys_t *sys = vd->sys;
 755     LPDIRECT3D9 d3dobj = sys->d3dobj;
 756     HRESULT hr;
 757
 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);
 762     if (SUCCEEDED(hr)) {
 763         /* test whether device can perform color-conversion
 764         ** from that format to target format
 765         */
 766         hr = IDirect3D9_CheckDeviceFormatConversion(d3dobj,
 767                                                     D3DADAPTER_DEFAULT,
 768                                                     D3DDEVTYPE_HAL,
 769                                                     src, dst);
 770     }
 771     if (!SUCCEEDED(hr)) {
 772         if (D3DERR_NOTAVAILABLE != hr)
 773             msg_Err(vd, "Could not query adapter supported formats. (hr=0x%lX)", hr);
 774         return VLC_EGENERIC;
 775     }
 776     return VLC_SUCCESS;
 777 }
 778
 779 typedef struct
 780 {
 781     const char   *name;
 782     D3DFORMAT    format;    /* D3D format */
 783     vlc_fourcc_t fourcc;    /* VLC fourcc */
 784     uint32_t     rmask;
 785     uint32_t     gmask;
 786     uint32_t     bmask;
 787 } d3d_format_t;
 788
 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 },
 801
 802     { NULL, 0, 0, 0,0,0}
 803 };
 804
 805 /**
 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)
 808 {
 809     vout_display_sys_t *sys = vd->sys;
 810
 811     for (unsigned pass = 0; pass < 2; pass++) {
 812         const vlc_fourcc_t *list;
 813
 814         if (pass == 0 && sys->allow_hw_yuv && vlc_fourcc_IsYUV(chroma))
 815             list = vlc_fourcc_GetYUVFallback(chroma);
 816         else if (pass == 1)
 817             list = vlc_fourcc_GetRGBFallback(chroma);
 818         else
 819             continue;
 820
 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];
 824
 825                 if (format->fourcc != list[i])
 826                     continue;
 827
 828                 msg_Warn(vd, "trying surface pixel format: %s",
 829                          format->name);
 830                 if (!Direct3DCheckConversion(vd, format->format, target)) {
 831                     msg_Dbg(vd, "selected surface pixel format is %s",
 832                             format->name);
 833                     return format;
 834                 }
 835             }
 836         }
 837     }
 838     return NULL;
 839 }
 840
 841 /**
 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.
 845  */
 846 static int Direct3DLockSurface(picture_t *picture)
 847 {
 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);
 851     if (FAILED(hr)) {
 852         //msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
 853         return CommonUpdatePicture(picture, &picture->p_sys->fallback, NULL, 0);
 854     }
 855
 856     CommonUpdatePicture(picture, NULL, d3drect.pBits, d3drect.Pitch);
 857     return VLC_SUCCESS;
 858 }
 859 /**
 860  * It unlocks the surface associated to the picture.
 861  */
 862 static void Direct3DUnlockSurface(picture_t *picture)
 863 {
 864     /* Unlock the Surface */
 865     HRESULT hr = IDirect3DSurface9_UnlockRect(picture->p_sys->surface);
 866     if (FAILED(hr)) {
 867         //msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
 868     }
 869 }
 870
 871 /**
 872  * It creates the pool of picture (only 1).
 873  *
 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
 878  */
 879 static int Direct3DCreatePool(vout_display_t *vd, video_format_t *fmt)
 880 {
 881     vout_display_sys_t *sys = vd->sys;
 882     LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
 883
 884     /* */
 885     *fmt = vd->source;
 886
 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);
 891     if (!d3dfmt) {
 892         msg_Err(vd, "surface pixel format is not supported.");
 893         return VLC_EGENERIC;
 894     }
 895     fmt->i_chroma = d3dfmt->fourcc;
 896     fmt->i_rmask  = d3dfmt->rmask;
 897     fmt->i_gmask  = d3dfmt->gmask;
 898     fmt->i_bmask  = d3dfmt->bmask;
 899
 900     /* We create one picture.
 901      * It is useless to create more as we can't be used for direct rendering */
 902
 903     /* Create a surface */
 904     LPDIRECT3DSURFACE9 surface;
 905     HRESULT hr = IDirect3DDevice9_CreateOffscreenPlainSurface(d3ddev,
 906                                                               fmt->i_width,
 907                                                               fmt->i_height,
 908                                                               d3dfmt->format,
 909                                                               D3DPOOL_DEFAULT,
 910                                                               &surface,
 911                                                               NULL);
 912     if (FAILED(hr)) {
 913         msg_Err(vd, "Failed to create picture surface. (hr=0x%lx)", hr);
 914         return VLC_EGENERIC;
 915     }
 916     /* fill surface with black color */
 917     IDirect3DDevice9_ColorFill(d3ddev, surface, NULL, D3DCOLOR_ARGB(0xFF, 0, 0, 0));
 918
 919     /* Create the associated picture */
 920     picture_resource_t *rsc = &sys->resource;
 921     rsc->p_sys = malloc(sizeof(*rsc->p_sys));
 922     if (!rsc->p_sys) {
 923         IDirect3DSurface9_Release(surface);
 924         return VLC_ENOMEM;
 925     }
 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);
 932     }
 933     picture_t *picture = picture_NewFromResource(fmt, rsc);
 934     if (!picture) {
 935         IDirect3DSurface9_Release(surface);
 936         free(rsc->p_sys);
 937         return VLC_ENOMEM;
 938     }
 939
 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;
 947
 948     sys->pool = picture_pool_NewExtended(&pool_cfg);
 949     if (!sys->pool) {
 950         picture_Release(picture);
 951         IDirect3DSurface9_Release(surface);
 952         return VLC_ENOMEM;
 953     }
 954     return VLC_SUCCESS;
 955 }
 956 /**
 957  * It destroys the pool of picture and its resources.
 958  */
 959 static void Direct3DDestroyPool(vout_display_t *vd)
 960 {
 961     vout_display_sys_t *sys = vd->sys;
 962
 963     if (sys->pool) {
 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);
 969     }
 970     sys->pool = NULL;
 971 }
 972
 973 /**
 974  * It allocates and initializes the resources needed to render the scene.
 975  */
 976 static int Direct3DCreateScene(vout_display_t *vd, const video_format_t *fmt)
 977 {
 978     vout_display_sys_t *sys = vd->sys;
 979     LPDIRECT3DDEVICE9       d3ddev = sys->d3ddev;
 980     HRESULT hr;
 981
 982     /*
 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
 986      */
 987     LPDIRECT3DTEXTURE9 d3dtex;
 988     hr = IDirect3DDevice9_CreateTexture(d3ddev,
 989                                         fmt->i_width,
 990                                         fmt->i_height,
 991                                         1,
 992                                         D3DUSAGE_RENDERTARGET,
 993                                         sys->d3dpp.BackBufferFormat,
 994                                         D3DPOOL_DEFAULT,
 995                                         &d3dtex,
 996                                         NULL);
 997     if (FAILED(hr)) {
 998         msg_Err(vd, "Failed to create texture. (hr=0x%lx)", hr);
 999         return VLC_EGENERIC;
1000     }
1001
1002     /*
1003     ** Create a vertex buffer for use when rendering scene
1004     */
1005     LPDIRECT3DVERTEXBUFFER9 d3dvtc;
1006     hr = IDirect3DDevice9_CreateVertexBuffer(d3ddev,
1007                                              sizeof(CUSTOMVERTEX)*4,
1008                                              D3DUSAGE_DYNAMIC|D3DUSAGE_WRITEONLY,
1009                                              D3DFVF_CUSTOMVERTEX,
1010                                              D3DPOOL_DEFAULT,
1011                                              &d3dvtc,
1012                                              NULL);
1013     if (FAILED(hr)) {
1014         msg_Err(vd, "Failed to create vertex buffer. (hr=0x%lx)", hr);
1015         IDirect3DTexture9_Release(d3dtex);
1016         return VLC_EGENERIC;
1017     }
1018
1019     /* */
1020     sys->d3dtex = d3dtex;
1021     sys->d3dvtc = d3dvtc;
1022
1023     sys->d3dregion_count = 0;
1024     sys->d3dregion       = NULL;
1025
1026     sys->clear_scene = true;
1027
1028     // Texture coordinates outside the range [0.0, 1.0] are set
1029     // to the texture color at 0.0 or 1.0, respectively.
1030     IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_ADDRESSU, D3DTADDRESS_CLAMP);
1031     IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_ADDRESSV, D3DTADDRESS_CLAMP);
1032
1033     // Set linear filtering quality
1034     if (sys->d3dcaps.TextureFilterCaps & D3DPTFILTERCAPS_MINFLINEAR) {
1035         msg_Dbg(vd, "Using D3DTEXF_LINEAR for minification");
1036         IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MINFILTER, D3DTEXF_LINEAR);
1037     } else {
1038         msg_Dbg(vd, "Using D3DTEXF_POINT for minification");
1039         IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MINFILTER, D3DTEXF_POINT);
1040     }
1041     if (sys->d3dcaps.TextureFilterCaps & D3DPTFILTERCAPS_MAGFLINEAR) {
1042         msg_Dbg(vd, "Using D3DTEXF_LINEAR for magnification");
1043         IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MAGFILTER, D3DTEXF_LINEAR);
1044     } else {
1045         msg_Dbg(vd, "Using D3DTEXF_POINT for magnification");
1046         IDirect3DDevice9_SetSamplerState(d3ddev, 0, D3DSAMP_MAGFILTER, D3DTEXF_POINT);
1047     }
1048
1049     // set maximum ambient light
1050     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_AMBIENT, D3DCOLOR_XRGB(255,255,255));
1051
1052     // Turn off culling
1053     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_CULLMODE, D3DCULL_NONE);
1054
1055     // Turn off the zbuffer
1056     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ZENABLE, D3DZB_FALSE);
1057
1058     // Turn off lights
1059     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_LIGHTING, FALSE);
1060
1061     // Enable dithering
1062     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_DITHERENABLE, TRUE);
1063
1064     // disable stencil
1065     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_STENCILENABLE, FALSE);
1066
1067     // manage blending
1068     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, FALSE);
1069     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_SRCBLEND,D3DBLEND_SRCALPHA);
1070     IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_DESTBLEND,D3DBLEND_INVSRCALPHA);
1071
1072     if (sys->d3dcaps.AlphaCmpCaps & D3DPCMPCAPS_GREATER) {
1073         IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHATESTENABLE,TRUE);
1074         IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHAREF, 0x00);
1075         IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHAFUNC,D3DCMP_GREATER);
1076     }
1077
1078     // Set texture states
1079     IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLOROP,D3DTOP_SELECTARG1);
1080     IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_COLORARG1,D3DTA_TEXTURE);
1081
1082     IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAOP, D3DTOP_MODULATE);
1083     IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAARG1,D3DTA_TEXTURE);
1084     IDirect3DDevice9_SetTextureStageState(d3ddev, 0, D3DTSS_ALPHAARG2,D3DTA_DIFFUSE);
1085
1086     msg_Dbg(vd, "Direct3D scene created successfully");
1087
1088     return VLC_SUCCESS;
1089 }
1090
1091 /**
1092  * It releases the scene resources.
1093  */
1094 static void Direct3DDestroyScene(vout_display_t *vd)
1095 {
1096     vout_display_sys_t *sys = vd->sys;
1097
1098     Direct3DDeleteRegions(sys->d3dregion_count, sys->d3dregion);
1099
1100     LPDIRECT3DVERTEXBUFFER9 d3dvtc = sys->d3dvtc;
1101     if (d3dvtc)
1102         IDirect3DVertexBuffer9_Release(d3dvtc);
1103
1104     LPDIRECT3DTEXTURE9 d3dtex = sys->d3dtex;
1105     if (d3dtex)
1106         IDirect3DTexture9_Release(d3dtex);
1107
1108     sys->d3dvtc = NULL;
1109     sys->d3dtex = NULL;
1110
1111     sys->d3dregion_count = 0;
1112     sys->d3dregion       = NULL;
1113
1114     msg_Dbg(vd, "Direct3D scene released successfully");
1115 }
1116
1117 static void Direct3DSetupVertices(CUSTOMVERTEX *vertices,
1118                                   const RECT src_full,
1119                                   const RECT src_crop,
1120                                   const RECT dst,
1121                                   int alpha)
1122 {
1123     const float src_full_width  = src_full.right  - src_full.left;
1124     const float src_full_height = src_full.bottom - src_full.top;
1125     vertices[0].x  = dst.left;
1126     vertices[0].y  = dst.top;
1127     vertices[0].tu = src_crop.left / src_full_width;
1128     vertices[0].tv = src_crop.top  / src_full_height;
1129
1130     vertices[1].x  = dst.right;
1131     vertices[1].y  = dst.top;
1132     vertices[1].tu = src_crop.right / src_full_width;
1133     vertices[1].tv = src_crop.top   / src_full_height;
1134
1135     vertices[2].x  = dst.right;
1136     vertices[2].y  = dst.bottom;
1137     vertices[2].tu = src_crop.right  / src_full_width;
1138     vertices[2].tv = src_crop.bottom / src_full_height;
1139
1140     vertices[3].x  = dst.left;
1141     vertices[3].y  = dst.bottom;
1142     vertices[3].tu = src_crop.left   / src_full_width;
1143     vertices[3].tv = src_crop.bottom / src_full_height;
1144
1145     for (int i = 0; i < 4; i++) {
1146         /* -0.5f is a "feature" of DirectX and it seems to apply to Direct3d also */
1147         /* http://www.sjbrown.co.uk/2003/05/01/fix-directx-rasterisation/ */
1148         vertices[i].x -= 0.5;
1149         vertices[i].y -= 0.5;
1150
1151         vertices[i].z       = 0.0f;
1152         vertices[i].rhw     = 1.0f;
1153         vertices[i].diffuse = D3DCOLOR_ARGB(alpha, 255, 255, 255);
1154     }
1155 }
1156
1157 /**
1158  * It copies picture surface into a texture and setup the associated d3d_region_t.
1159  */
1160 static int Direct3DImportPicture(vout_display_t *vd,
1161                                  d3d_region_t *region,
1162                                  LPDIRECT3DSURFACE9 source)
1163 {
1164     vout_display_sys_t *sys = vd->sys;
1165     HRESULT hr;
1166
1167     if (!source) {
1168         msg_Dbg(vd, "no surface to render ?");
1169         return VLC_EGENERIC;
1170     }
1171
1172     /* retrieve texture top-level surface */
1173     LPDIRECT3DSURFACE9 destination;
1174     hr = IDirect3DTexture9_GetSurfaceLevel(sys->d3dtex, 0, &destination);
1175     if (FAILED(hr)) {
1176         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1177         return VLC_EGENERIC;
1178     }
1179
1180     /* Copy picture surface into texture surface
1181      * color space conversion happen here */
1182     hr = IDirect3DDevice9_StretchRect(sys->d3ddev, source, NULL, destination, NULL, D3DTEXF_LINEAR);
1183     IDirect3DSurface9_Release(destination);
1184     if (FAILED(hr)) {
1185         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1186         return VLC_EGENERIC;
1187     }
1188
1189     /* */
1190     region->texture = sys->d3dtex;
1191     Direct3DSetupVertices(region->vertex,
1192                           vd->sys->rect_src,
1193                           vd->sys->rect_src_clipped,
1194                           vd->sys->rect_dest_clipped, 255);
1195     return VLC_SUCCESS;
1196 }
1197
1198 static void Direct3DDeleteRegions(int count, d3d_region_t *region)
1199 {
1200     for (int i = 0; i < count; i++) {
1201         if (region[i].texture)
1202             IDirect3DTexture9_Release(region[i].texture);
1203     }
1204     free(region);
1205 }
1206
1207 static void Direct3DImportSubpicture(vout_display_t *vd,
1208                                      int *count_ptr, d3d_region_t **region,
1209                                      subpicture_t *subpicture)
1210 {
1211     vout_display_sys_t *sys = vd->sys;
1212
1213     int count = 0;
1214     for (subpicture_region_t *r = subpicture->p_region; r; r = r->p_next)
1215         count++;
1216
1217     *count_ptr = count;
1218     *region    = calloc(count, sizeof(**region));
1219     if (*region == NULL) {
1220         *count_ptr = 0;
1221         return;
1222     }
1223
1224     int i = 0;
1225     for (subpicture_region_t *r = subpicture->p_region; r; r = r->p_next, i++) {
1226         d3d_region_t *d3dr = &(*region)[i];
1227         HRESULT hr;
1228
1229         d3dr->texture = NULL;
1230         for (int j = 0; j < sys->d3dregion_count; j++) {
1231             d3d_region_t *cache = &sys->d3dregion[j];
1232             if (cache->texture &&
1233                 cache->format == sys->d3dregion_format &&
1234                 cache->width  == r->fmt.i_visible_width &&
1235                 cache->height == r->fmt.i_visible_height) {
1236 #ifndef NDEBUG
1237                 msg_Dbg(vd, "Reusing %dx%d texture for OSD",
1238                         cache->width, cache->height);
1239 #endif
1240                 *d3dr = *cache;
1241                 memset(cache, 0, sizeof(*cache));
1242             }
1243         }
1244         if (!d3dr->texture) {
1245             d3dr->format = sys->d3dregion_format;
1246             d3dr->width  = r->fmt.i_visible_width;
1247             d3dr->height = r->fmt.i_visible_height;
1248             hr = IDirect3DDevice9_CreateTexture(sys->d3ddev,
1249                                                 d3dr->width, d3dr->height,
1250                                                 1,
1251                                                 D3DUSAGE_DYNAMIC,
1252                                                 d3dr->format,
1253                                                 D3DPOOL_DEFAULT,
1254                                                 &d3dr->texture,
1255                                                 NULL);
1256             if (FAILED(hr)) {
1257                 d3dr->texture = NULL;
1258                 msg_Err(vd, "Failed to create %dx%d texture for OSD (hr=0x%0lX)",
1259                         d3dr->width, d3dr->height, hr);
1260                 continue;
1261             }
1262             msg_Dbg(vd, "Created %dx%d texture for OSD",
1263                     r->fmt.i_visible_width, r->fmt.i_visible_height);
1264         }
1265
1266         D3DLOCKED_RECT lock;
1267         hr = IDirect3DTexture9_LockRect(d3dr->texture, 0, &lock, NULL, 0);
1268         if (SUCCEEDED(hr)) {
1269             uint8_t  *dst_data   = lock.pBits;
1270             int       dst_pitch  = lock.Pitch;
1271             const int src_offset = r->fmt.i_y_offset * r->p_picture->p->i_pitch +
1272                                    r->fmt.i_x_offset * r->p_picture->p->i_pixel_pitch;
1273             uint8_t  *src_data   = &r->p_picture->p->p_pixels[src_offset];
1274             int       src_pitch  = r->p_picture->p->i_pitch;
1275             for (unsigned y = 0; y < r->fmt.i_visible_height; y++) {
1276                 int copy_pitch = __MIN(dst_pitch, r->p_picture->p->i_visible_pitch);
1277                 if (d3dr->format == D3DFMT_A8B8G8R8) {
1278                     memcpy(&dst_data[y * dst_pitch], &src_data[y * src_pitch],
1279                            copy_pitch);
1280                 } else {
1281                     for (int x = 0; x < copy_pitch; x += 4) {
1282                         dst_data[y * dst_pitch + x + 0] = src_data[y * src_pitch + x + 2];
1283                         dst_data[y * dst_pitch + x + 1] = src_data[y * src_pitch + x + 1];
1284                         dst_data[y * dst_pitch + x + 2] = src_data[y * src_pitch + x + 0];
1285                         dst_data[y * dst_pitch + x + 3] = src_data[y * src_pitch + x + 3];
1286                     }
1287                 }
1288             }
1289             hr = IDirect3DTexture9_UnlockRect(d3dr->texture, 0);
1290             if (FAILED(hr))
1291                 msg_Err(vd, "Failed to unlock the texture");
1292         } else {
1293             msg_Err(vd, "Failed to lock the texture");
1294         }
1295
1296         /* Map the subpicture to sys->rect_dest */
1297         RECT src;
1298         src.left   = 0;
1299         src.right  = src.left + r->fmt.i_visible_width;
1300         src.top    = 0;
1301         src.bottom = src.top  + r->fmt.i_visible_height;
1302
1303         const RECT video = sys->rect_dest;
1304         const float scale_w = (float)(video.right  - video.left) / subpicture->i_original_picture_width;
1305         const float scale_h = (float)(video.bottom - video.top)  / subpicture->i_original_picture_height;
1306
1307         RECT dst;
1308         dst.left   = video.left + scale_w * r->i_x,
1309         dst.right  = dst.left + scale_w * r->fmt.i_visible_width,
1310         dst.top    = video.top  + scale_h * r->i_y,
1311         dst.bottom = dst.top  + scale_h * r->fmt.i_visible_height,
1312         Direct3DSetupVertices(d3dr->vertex,
1313                               src, src, dst,
1314                               subpicture->i_alpha * r->i_alpha / 255);
1315     }
1316 }
1317
1318 static int Direct3DRenderRegion(vout_display_t *vd,
1319                                 d3d_region_t *region)
1320 {
1321     vout_display_sys_t *sys = vd->sys;
1322
1323     LPDIRECT3DDEVICE9 d3ddev = vd->sys->d3ddev;
1324
1325     LPDIRECT3DVERTEXBUFFER9 d3dvtc = sys->d3dvtc;
1326     LPDIRECT3DTEXTURE9      d3dtex = region->texture;
1327
1328     HRESULT hr;
1329
1330     /* Import vertices */
1331     void *vertex;
1332     hr = IDirect3DVertexBuffer9_Lock(d3dvtc, 0, 0, &vertex, D3DLOCK_DISCARD);
1333     if (FAILED(hr)) {
1334         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1335         return -1;
1336     }
1337     memcpy(vertex, region->vertex, sizeof(region->vertex));
1338     hr = IDirect3DVertexBuffer9_Unlock(d3dvtc);
1339     if (FAILED(hr)) {
1340         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1341         return -1;
1342     }
1343
1344     // Setup our texture. Using textures introduces the texture stage states,
1345     // which govern how textures get blended together (in the case of multiple
1346     // textures) and lighting information. In this case, we are modulating
1347     // (blending) our texture with the diffuse color of the vertices.
1348     hr = IDirect3DDevice9_SetTexture(d3ddev, 0, (LPDIRECT3DBASETEXTURE9)d3dtex);
1349     if (FAILED(hr)) {
1350         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1351         return -1;
1352     }
1353
1354     // Render the vertex buffer contents
1355     hr = IDirect3DDevice9_SetStreamSource(d3ddev, 0, d3dvtc, 0, sizeof(CUSTOMVERTEX));
1356     if (FAILED(hr)) {
1357         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1358         return -1;
1359     }
1360
1361     // we use FVF instead of vertex shader
1362     hr = IDirect3DDevice9_SetFVF(d3ddev, D3DFVF_CUSTOMVERTEX);
1363     if (FAILED(hr)) {
1364         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1365         return -1;
1366     }
1367
1368     // draw rectangle
1369     hr = IDirect3DDevice9_DrawPrimitive(d3ddev, D3DPT_TRIANGLEFAN, 0, 2);
1370     if (FAILED(hr)) {
1371         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1372         return -1;
1373     }
1374     return 0;
1375 }
1376
1377 /**
1378  * It renders the scene.
1379  *
1380  * This function is intented for higher end 3D cards, with pixel shader support
1381  * and at least 64 MiB of video RAM.
1382  */
1383 static void Direct3DRenderScene(vout_display_t *vd,
1384                                 d3d_region_t *picture,
1385                                 int subpicture_count,
1386                                 d3d_region_t *subpicture)
1387 {
1388     vout_display_sys_t *sys = vd->sys;
1389     LPDIRECT3DDEVICE9 d3ddev = sys->d3ddev;
1390     HRESULT hr;
1391
1392     if (sys->clear_scene) {
1393         /* Clear the backbuffer and the zbuffer */
1394         hr = IDirect3DDevice9_Clear(d3ddev, 0, NULL, D3DCLEAR_TARGET,
1395                                   D3DCOLOR_XRGB(0, 0, 0), 1.0f, 0);
1396         if (FAILED(hr)) {
1397             msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1398             return;
1399         }
1400         sys->clear_scene = false;
1401     }
1402
1403     // Begin the scene
1404     hr = IDirect3DDevice9_BeginScene(d3ddev);
1405     if (FAILED(hr)) {
1406         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1407         return;
1408     }
1409
1410     Direct3DRenderRegion(vd, picture);
1411
1412     if (subpicture_count > 0)
1413         IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, TRUE);
1414     for (int i = 0; i < subpicture_count; i++) {
1415         d3d_region_t *r = &subpicture[i];
1416         if (r->texture)
1417             Direct3DRenderRegion(vd, r);
1418     }
1419     if (subpicture_count > 0)
1420         IDirect3DDevice9_SetRenderState(d3ddev, D3DRS_ALPHABLENDENABLE, FALSE);
1421
1422     // End the scene
1423     hr = IDirect3DDevice9_EndScene(d3ddev);
1424     if (FAILED(hr)) {
1425         msg_Dbg(vd, "%s:%d (hr=0x%0lX)", __FUNCTION__, __LINE__, hr);
1426         return;
1427     }
1428 }
1429
1430 /*****************************************************************************
1431  * DesktopCallback: desktop mode variable callback
1432  *****************************************************************************/
1433 static int DesktopCallback(vlc_object_t *object, char const *psz_cmd,
1434                             vlc_value_t oldval, vlc_value_t newval,
1435                             void *p_data)
1436 {
1437     vout_display_t *vd = (vout_display_t *)object;
1438     vout_display_sys_t *sys = vd->sys;
1439     VLC_UNUSED(psz_cmd);
1440     VLC_UNUSED(oldval);
1441     VLC_UNUSED(p_data);
1442
1443     vlc_mutex_lock(&sys->lock);
1444     const bool ch_desktop = !sys->desktop_requested != !newval.b_bool;
1445     sys->ch_desktop |= ch_desktop;
1446     sys->desktop_requested = newval.b_bool;
1447     vlc_mutex_unlock(&sys->lock);
1448
1449     /* FIXME we should have a way to export variable to be saved */
1450     if (ch_desktop) {
1451         /* Modify playlist as well because the vout might have to be
1452          * restarted */
1453         var_Create(object->p_parent, "video-wallpaper", VLC_VAR_BOOL);
1454         var_SetBool(object->p_parent, "video-wallpaper", newval.b_bool);
1455     }
1456     return VLC_SUCCESS;
1457 }