blob: bd9d9b42e6f91a9ec486718b303e9d3c4a2da29f [file] [log] [blame]
// Copyright 2017 The PDFium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
#ifndef CORE_FXGE_DIB_CFX_DIBITMAP_H_
#define CORE_FXGE_DIB_CFX_DIBITMAP_H_
#include <stddef.h>
#include <stdint.h>
#include <optional>
#include "core/fxcrt/compiler_specific.h"
#include "core/fxcrt/fx_memory_wrappers.h"
#include "core/fxcrt/maybe_owned.h"
#include "core/fxcrt/retain_ptr.h"
#include "core/fxcrt/span.h"
#include "core/fxge/dib/cfx_dibbase.h"
#include "core/fxge/dib/fx_dib.h"
class CFX_DIBitmap final : public CFX_DIBBase {
public:
struct PitchAndSize {
uint32_t pitch;
uint32_t size;
};
CONSTRUCT_VIA_MAKE_RETAIN;
[[nodiscard]] bool Create(int width, int height, FXDIB_Format format);
[[nodiscard]] bool Create(int width,
int height,
FXDIB_Format format,
uint8_t* pBuffer,
uint32_t pitch);
bool Copy(RetainPtr<const CFX_DIBBase> source);
// CFX_DIBBase
pdfium::span<const uint8_t> GetScanline(int line) const override;
size_t GetEstimatedImageMemoryBurden() const override;
#if BUILDFLAG(IS_WIN) || defined(PDF_USE_SKIA)
RetainPtr<const CFX_DIBitmap> RealizeIfNeeded() const override;
#endif
pdfium::span<const uint8_t> GetBuffer() const;
pdfium::span<uint8_t> GetWritableBuffer() {
pdfium::span<const uint8_t> src = GetBuffer();
// SAFETY: const_cast<>() doesn't change size.
return UNSAFE_BUFFERS(
pdfium::make_span(const_cast<uint8_t*>(src.data()), src.size()));
}
pdfium::span<uint8_t> GetWritableScanline(int line) {
pdfium::span<const uint8_t> src = GetScanline(line);
return UNSAFE_BUFFERS(
pdfium::make_span(const_cast<uint8_t*>(src.data()), src.size()));
}
void TakeOver(RetainPtr<CFX_DIBitmap>&& pSrcBitmap);
bool ConvertFormat(FXDIB_Format format);
void Clear(uint32_t color);
#if defined(PDF_USE_SKIA)
uint32_t GetPixelForTesting(int x, int y) const;
#endif // defined(PDF_USE_SKIA)
// Requires `this` to be of format `FXDIB_Format::kArgb`.
void SetRedFromAlpha();
// Requires `this` to be of format `FXDIB_Format::kArgb`.
bool SetUniformOpaqueAlpha();
// TODO(crbug.com/pdfium/2007): Migrate callers to `CFX_RenderDevice`.
bool MultiplyAlpha(float alpha);
bool MultiplyAlphaMask(RetainPtr<const CFX_DIBitmap> mask);
bool TransferBitmap(int dest_left,
int dest_top,
int width,
int height,
RetainPtr<const CFX_DIBBase> source,
int src_left,
int src_top);
bool CompositeBitmap(int dest_left,
int dest_top,
int width,
int height,
RetainPtr<const CFX_DIBBase> source,
int src_left,
int src_top,
BlendMode blend_type,
const CFX_ClipRgn* pClipRgn,
bool bRgbByteOrder);
bool CompositeMask(int dest_left,
int dest_top,
int width,
int height,
const RetainPtr<const CFX_DIBBase>& pMask,
uint32_t color,
int src_left,
int src_top,
BlendMode blend_type,
const CFX_ClipRgn* pClipRgn,
bool bRgbByteOrder);
void CompositeOneBPPMask(int dest_left,
int dest_top,
int width,
int height,
RetainPtr<const CFX_DIBBase> source,
int src_left,
int src_top);
bool CompositeRect(int dest_left,
int dest_top,
int width,
int height,
uint32_t color);
bool ConvertColorScale(uint32_t forecolor, uint32_t backcolor);
// |width| and |height| must be greater than 0.
// |format| must have a valid bits per pixel count.
// If |pitch| is zero, then the actual pitch will be calculated based on
// |width| and |format|.
// If |pitch| is non-zero, then that be used as the actual pitch.
// The actual pitch will be used to calculate the size.
// Returns the calculated pitch and size on success, or nullopt on failure.
static std::optional<PitchAndSize> CalculatePitchAndSize(int width,
int height,
FXDIB_Format format,
uint32_t pitch);
#if defined(PDF_USE_SKIA)
// Converts to un-pre-multiplied alpha if necessary.
void UnPreMultiply();
// Forces pre-multiplied alpha without conversion.
// TODO(crbug.com/pdfium/2011): Remove the need for this.
void ForcePreMultiply();
#endif
protected:
#if defined(PDF_USE_SKIA)
bool IsPremultiplied() const override;
#endif // defined(PDF_USE_SKIA)
private:
enum class Channel : uint8_t { kRed, kAlpha };
#if defined(PDF_USE_SKIA)
enum class Format { kCleared, kPreMultiplied, kUnPreMultiplied };
#endif
CFX_DIBitmap();
CFX_DIBitmap(const CFX_DIBitmap& src);
~CFX_DIBitmap() override;
void ConvertBGRColorScale(uint32_t forecolor, uint32_t backcolor);
bool TransferWithUnequalFormats(FXDIB_Format dest_format,
int dest_left,
int dest_top,
int width,
int height,
RetainPtr<const CFX_DIBBase> source,
int src_left,
int src_top);
void TransferWithMultipleBPP(int dest_left,
int dest_top,
int width,
int height,
RetainPtr<const CFX_DIBBase> source,
int src_left,
int src_top);
void TransferEqualFormatsOneBPP(int dest_left,
int dest_top,
int width,
int height,
RetainPtr<const CFX_DIBBase> source,
int src_left,
int src_top);
MaybeOwned<uint8_t, FxFreeDeleter> m_pBuffer;
#if defined(PDF_USE_SKIA)
Format m_nFormat = Format::kCleared;
#endif
};
#endif // CORE_FXGE_DIB_CFX_DIBITMAP_H_