gfxWindowsSurface.cpp

/* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "gfxWindowsSurface.h"
#include "gfxContext.h"
#include "gfxPlatform.h"
#include "mozilla/gfx/2D.h"
#include "mozilla/gfx/HelpersCairo.h"
#include "mozilla/gfx/Logging.h"

#include "cairo.h"
#include "cairo-win32.h"

#include "nsString.h"

gfxWindowsSurface::gfxWindowsSurface(HDC dc, uint32_t flags)
    : mOwnsDC(false), mDC(dc), mWnd(nullptr) {
  InitWithDC(flags);
}

gfxWindowsSurface::gfxWindowsSurface(IDirect3DSurface9* surface, uint32_t flags)
    : mOwnsDC(false), mDC(0), mWnd(nullptr) {
  cairo_surface_t* surf = cairo_win32_surface_create_with_d3dsurface9(surface);
  Init(surf);
}

void gfxWindowsSurface::MakeInvalid(mozilla::gfx::IntSize& size) {
  size = mozilla::gfx::IntSize(-1, -1);
}

gfxWindowsSurface::gfxWindowsSurface(const mozilla::gfx::IntSize& realSize,
                                     gfxImageFormat imageFormat)
    : mOwnsDC(false), mWnd(nullptr) {
  mozilla::gfx::IntSize size(realSize);
  if (!mozilla::gfx::Factory::CheckSurfaceSize(size)) MakeInvalid(size);

  cairo_format_t cformat = GfxFormatToCairoFormat(imageFormat);
  cairo_surface_t* surf =
      cairo_win32_surface_create_with_dib(cformat, size.width, size.height);

  Init(surf);

  if (CairoStatus() == CAIRO_STATUS_SUCCESS) {
    mDC = cairo_win32_surface_get_dc(CairoSurface());
    RecordMemoryUsed(size.width * size.height * 4 + sizeof(gfxWindowsSurface));
  } else {
    mDC = nullptr;
  }
}

gfxWindowsSurface::gfxWindowsSurface(cairo_surface_t* csurf)
    : mOwnsDC(false), mWnd(nullptr) {
  if (cairo_surface_status(csurf) == 0)
    mDC = cairo_win32_surface_get_dc(csurf);
  else
    mDC = nullptr;

  MOZ_ASSERT(cairo_surface_get_type(csurf) !=
             CAIRO_SURFACE_TYPE_WIN32_PRINTING);

  Init(csurf, true);
}

void gfxWindowsSurface::InitWithDC(uint32_t flags) {
  if (flags & FLAG_IS_TRANSPARENT) {
    Init(cairo_win32_surface_create_with_alpha(mDC));
  } else {
    Init(cairo_win32_surface_create(mDC));
  }
}

already_AddRefed<gfxASurface> gfxWindowsSurface::CreateSimilarSurface(
    gfxContentType aContent, const mozilla::gfx::IntSize& aSize) {
  if (!mSurface || !mSurfaceValid) {
    return nullptr;
  }

  cairo_surface_t* surface;
  if (GetContentType() == gfxContentType::COLOR_ALPHA) {
    // When creating a similar surface to a transparent surface, ensure
    // the new surface uses a DIB. cairo_surface_create_similar won't
    // use  a DIB for a gfxContentType::COLOR surface if this surface doesn't
    // have a DIB (e.g. if we're a transparent window surface). But
    // we need a DIB to perform well if the new surface is composited into
    // a surface that's the result of
    // create_similar(gfxContentType::COLOR_ALPHA) (e.g. a backbuffer for the
    // window) --- that new surface *would* have a DIB.
    gfxImageFormat gformat =
        gfxPlatform::GetPlatform()->OptimalFormatForContent(aContent);
    cairo_format_t cformat = GfxFormatToCairoFormat(gformat);
    surface =
        cairo_win32_surface_create_with_dib(cformat, aSize.width, aSize.height);
  } else {
    surface = cairo_surface_create_similar(
        mSurface, (cairo_content_t)(int)aContent, aSize.width, aSize.height);
  }

  if (cairo_surface_status(surface)) {
    cairo_surface_destroy(surface);
    return nullptr;
  }

  RefPtr<gfxASurface> result = Wrap(surface, aSize);
  cairo_surface_destroy(surface);
  return result.forget();
}

gfxWindowsSurface::~gfxWindowsSurface() {
  if (mOwnsDC) {
    if (mWnd)
      ::ReleaseDC(mWnd, mDC);
    else
      ::DeleteDC(mDC);
  }
}

HDC gfxWindowsSurface::GetDC() {
  return cairo_win32_surface_get_dc(CairoSurface());
}

already_AddRefed<gfxImageSurface> gfxWindowsSurface::GetAsImageSurface() {
  if (!mSurfaceValid) {
    NS_WARNING(
        "GetImageSurface on an invalid (null) surface; who's calling this "
        "without checking for surface errors?");
    return nullptr;
  }

  NS_ASSERTION(
      CairoSurface() != nullptr,
      "CairoSurface() shouldn't be nullptr when mSurfaceValid is TRUE!");

  cairo_surface_t* isurf = cairo_win32_surface_get_image(CairoSurface());
  if (!isurf) return nullptr;

  RefPtr<gfxImageSurface> result =
      gfxASurface::Wrap(isurf).downcast<gfxImageSurface>();
  result->SetOpaqueRect(GetOpaqueRect());

  return result.forget();
}

const mozilla::gfx::IntSize gfxWindowsSurface::GetSize() const {
  if (!mSurfaceValid) {
    NS_WARNING(
        "GetImageSurface on an invalid (null) surface; who's calling this "
        "without checking for surface errors?");
    return mozilla::gfx::IntSize(-1, -1);
  }

  NS_ASSERTION(
      mSurface != nullptr,
      "CairoSurface() shouldn't be nullptr when mSurfaceValid is TRUE!");

  return mozilla::gfx::IntSize(cairo_win32_surface_get_width(mSurface),
                               cairo_win32_surface_get_height(mSurface));
}