523 lines
17 KiB
C++
523 lines
17 KiB
C++
//
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
// Copyright (c) Contributors to the OpenEXR Project.
|
|
//
|
|
|
|
#ifndef INCLUDED_IMF_TILED_RGBA_FILE_H
|
|
#define INCLUDED_IMF_TILED_RGBA_FILE_H
|
|
|
|
//-----------------------------------------------------------------------------
|
|
//
|
|
// Simplified RGBA image I/O for tiled files
|
|
//
|
|
// class TiledRgbaOutputFile
|
|
// class TiledRgbaInputFile
|
|
//
|
|
//-----------------------------------------------------------------------------
|
|
|
|
#include "ImfForward.h"
|
|
|
|
#include "ImfCompression.h"
|
|
#include "ImfLineOrder.h"
|
|
#include "ImfRgba.h"
|
|
#include "ImfThreading.h"
|
|
#include "ImfTileDescription.h"
|
|
|
|
#include "ImfContextInit.h"
|
|
|
|
#include <ImathBox.h>
|
|
#include <ImathVec.h>
|
|
#include <half.h>
|
|
|
|
#include <string>
|
|
|
|
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
|
|
|
|
//
|
|
// Tiled RGBA output file.
|
|
//
|
|
|
|
class IMF_EXPORT_TYPE TiledRgbaOutputFile
|
|
{
|
|
public:
|
|
//---------------------------------------------------
|
|
// Constructor -- rgbaChannels, tileXSize, tileYSize,
|
|
// levelMode, and levelRoundingMode overwrite the
|
|
// channel list and tile description attribute in the
|
|
// header that is passed as an argument to the
|
|
// constructor.
|
|
//---------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaOutputFile (
|
|
const char name[],
|
|
const Header& header,
|
|
RgbaChannels rgbaChannels,
|
|
int tileXSize,
|
|
int tileYSize,
|
|
LevelMode mode,
|
|
LevelRoundingMode rmode = ROUND_DOWN,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
//---------------------------------------------------
|
|
// Constructor -- like the previous one, but the new
|
|
// TiledRgbaOutputFile is attached to a file that has
|
|
// already been opened by the caller. Destroying
|
|
// TiledRgbaOutputFileObjects constructed with this
|
|
// constructor does not automatically close the
|
|
// corresponding files.
|
|
//---------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaOutputFile (
|
|
OPENEXR_IMF_INTERNAL_NAMESPACE::OStream& os,
|
|
const Header& header,
|
|
RgbaChannels rgbaChannels,
|
|
int tileXSize,
|
|
int tileYSize,
|
|
LevelMode mode,
|
|
LevelRoundingMode rmode = ROUND_DOWN,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
//------------------------------------------------------
|
|
// Constructor -- header data are explicitly specified
|
|
// as function call arguments (an empty dataWindow means
|
|
// "same as displayWindow")
|
|
//------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaOutputFile (
|
|
const char name[],
|
|
int tileXSize,
|
|
int tileYSize,
|
|
LevelMode mode,
|
|
LevelRoundingMode rmode,
|
|
const IMATH_NAMESPACE::Box2i& displayWindow,
|
|
const IMATH_NAMESPACE::Box2i& dataWindow = IMATH_NAMESPACE::Box2i (),
|
|
RgbaChannels rgbaChannels = WRITE_RGBA,
|
|
float pixelAspectRatio = 1,
|
|
const IMATH_NAMESPACE::V2f screenWindowCenter =
|
|
IMATH_NAMESPACE::V2f (0, 0),
|
|
float screenWindowWidth = 1,
|
|
LineOrder lineOrder = INCREASING_Y,
|
|
Compression compression = ZIP_COMPRESSION,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
//-----------------------------------------------
|
|
// Constructor -- like the previous one, but both
|
|
// the display window and the data window are
|
|
// Box2i (V2i (0, 0), V2i (width - 1, height -1))
|
|
//-----------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaOutputFile (
|
|
const char name[],
|
|
int width,
|
|
int height,
|
|
int tileXSize,
|
|
int tileYSize,
|
|
LevelMode mode,
|
|
LevelRoundingMode rmode = ROUND_DOWN,
|
|
RgbaChannels rgbaChannels = WRITE_RGBA,
|
|
float pixelAspectRatio = 1,
|
|
const IMATH_NAMESPACE::V2f screenWindowCenter =
|
|
IMATH_NAMESPACE::V2f (0, 0),
|
|
float screenWindowWidth = 1,
|
|
LineOrder lineOrder = INCREASING_Y,
|
|
Compression compression = ZIP_COMPRESSION,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
IMF_EXPORT
|
|
virtual ~TiledRgbaOutputFile ();
|
|
|
|
//------------------------------------------------
|
|
// Define a frame buffer as the pixel data source:
|
|
// Pixel (x, y) is at address
|
|
//
|
|
// base + x * xStride + y * yStride
|
|
//
|
|
//------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void setFrameBuffer (const Rgba* base, size_t xStride, size_t yStride);
|
|
|
|
//--------------------------
|
|
// Access to the file header
|
|
//--------------------------
|
|
|
|
IMF_EXPORT
|
|
const Header& header () const;
|
|
IMF_EXPORT
|
|
const FrameBuffer& frameBuffer () const;
|
|
IMF_EXPORT
|
|
const IMATH_NAMESPACE::Box2i& displayWindow () const;
|
|
IMF_EXPORT
|
|
const IMATH_NAMESPACE::Box2i& dataWindow () const;
|
|
IMF_EXPORT
|
|
float pixelAspectRatio () const;
|
|
IMF_EXPORT
|
|
const IMATH_NAMESPACE::V2f screenWindowCenter () const;
|
|
IMF_EXPORT
|
|
float screenWindowWidth () const;
|
|
IMF_EXPORT
|
|
LineOrder lineOrder () const;
|
|
IMF_EXPORT
|
|
Compression compression () const;
|
|
IMF_EXPORT
|
|
RgbaChannels channels () const;
|
|
|
|
//----------------------------------------------------
|
|
// Utility functions (same as in Imf::TiledOutputFile)
|
|
//----------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
unsigned int tileXSize () const;
|
|
IMF_EXPORT
|
|
unsigned int tileYSize () const;
|
|
IMF_EXPORT
|
|
LevelMode levelMode () const;
|
|
IMF_EXPORT
|
|
LevelRoundingMode levelRoundingMode () const;
|
|
|
|
IMF_EXPORT
|
|
int numLevels () const;
|
|
IMF_EXPORT
|
|
int numXLevels () const;
|
|
IMF_EXPORT
|
|
int numYLevels () const;
|
|
IMF_EXPORT
|
|
bool isValidLevel (int lx, int ly) const;
|
|
|
|
IMF_EXPORT
|
|
int levelWidth (int lx) const;
|
|
IMF_EXPORT
|
|
int levelHeight (int ly) const;
|
|
|
|
IMF_EXPORT
|
|
int numXTiles (int lx = 0) const;
|
|
IMF_EXPORT
|
|
int numYTiles (int ly = 0) const;
|
|
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i dataWindowForLevel (int l = 0) const;
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i dataWindowForLevel (int lx, int ly) const;
|
|
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i dataWindowForTile (int dx, int dy, int l = 0) const;
|
|
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i
|
|
dataWindowForTile (int dx, int dy, int lx, int ly) const;
|
|
|
|
//------------------------------------------------------------------
|
|
// Write pixel data:
|
|
//
|
|
// writeTile(dx, dy, lx, ly) writes the tile with tile
|
|
// coordinates (dx, dy), and level number (lx, ly) to
|
|
// the file.
|
|
//
|
|
// dx must lie in the interval [0, numXTiles(lx)-1]
|
|
// dy must lie in the interval [0, numYTiles(ly)-1]
|
|
//
|
|
// lx must lie in the interval [0, numXLevels()-1]
|
|
// ly must lie in the interval [0, numYLevels()-1]
|
|
//
|
|
// writeTile(dx, dy, level) is a convenience function
|
|
// used for ONE_LEVEL and MIPMAP_LEVEL files. It calls
|
|
// writeTile(dx, dy, level, level).
|
|
//
|
|
// The two writeTiles(dx1, dx2, dy1, dy2, ...) functions allow
|
|
// writing multiple tiles at once. If multi-threading is used
|
|
// multiple tiles are written concurrently.
|
|
//
|
|
// Pixels that are outside the pixel coordinate range for the tile's
|
|
// level, are never accessed by writeTile().
|
|
//
|
|
// Each tile in the file must be written exactly once.
|
|
//
|
|
//------------------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void writeTile (int dx, int dy, int l = 0);
|
|
IMF_EXPORT
|
|
void writeTile (int dx, int dy, int lx, int ly);
|
|
|
|
IMF_EXPORT
|
|
void
|
|
writeTiles (int dxMin, int dxMax, int dyMin, int dyMax, int lx, int ly);
|
|
|
|
IMF_EXPORT
|
|
void writeTiles (int dxMin, int dxMax, int dyMin, int dyMax, int l = 0);
|
|
|
|
// -------------------------------------------------------------------------
|
|
// Update the preview image (see Imf::TiledOutputFile::updatePreviewImage())
|
|
// -------------------------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void updatePreviewImage (const PreviewRgba[]);
|
|
|
|
//------------------------------------------------
|
|
// Break a tile -- for testing and debugging only
|
|
// (see Imf::TiledOutputFile::breakTile())
|
|
//
|
|
// Warning: Calling this function usually results
|
|
// in a broken image file. The file or parts of
|
|
// it may not be readable, or the file may contain
|
|
// bad data.
|
|
//
|
|
//------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void
|
|
breakTile (int dx, int dy, int lx, int ly, int offset, int length, char c);
|
|
|
|
private:
|
|
//
|
|
// Copy constructor and assignment are not implemented
|
|
//
|
|
|
|
TiledRgbaOutputFile (const TiledRgbaOutputFile&) = delete;
|
|
TiledRgbaOutputFile& operator= (const TiledRgbaOutputFile&) = delete;
|
|
TiledRgbaOutputFile (TiledRgbaOutputFile&&) = delete;
|
|
TiledRgbaOutputFile& operator= (TiledRgbaOutputFile&&) = delete;
|
|
|
|
class IMF_HIDDEN ToYa;
|
|
|
|
TiledOutputFile* _outputFile;
|
|
ToYa* _toYa;
|
|
};
|
|
|
|
//
|
|
// Tiled RGBA input file
|
|
//
|
|
|
|
class IMF_EXPORT_TYPE TiledRgbaInputFile
|
|
{
|
|
public:
|
|
//--------------------------------------------------------
|
|
// Constructor -- opens the file with the specified name.
|
|
// Destroying TiledRgbaInputFile objects constructed with
|
|
// this constructor automatically closes the corresponding
|
|
// files.
|
|
//--------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaInputFile (
|
|
const char name[],
|
|
const ContextInitializer &ctxt,
|
|
const std::string& layerName,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
//--------------------------------------------------------
|
|
// Constructor -- opens the file with the specified name.
|
|
// Destroying TiledRgbaInputFile objects constructed with
|
|
// this constructor automatically closes the corresponding
|
|
// files.
|
|
//--------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaInputFile (
|
|
const char name[], int numThreads = globalThreadCount ());
|
|
|
|
//-------------------------------------------------------
|
|
// Constructor -- attaches the new TiledRgbaInputFile
|
|
// object to a file that has already been opened by the
|
|
// caller.
|
|
// Destroying TiledRgbaInputFile objects constructed with
|
|
// this constructor does not automatically close the
|
|
// corresponding files.
|
|
//-------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaInputFile (
|
|
OPENEXR_IMF_INTERNAL_NAMESPACE::IStream& is,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
//------------------------------------------------------------
|
|
// Constructors -- the same as the previous two, but the names
|
|
// of the red, green, blue, alpha, and luminance channels are
|
|
// expected to be layerName.R, layerName.G, etc.
|
|
//------------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaInputFile (
|
|
const char name[],
|
|
const std::string& layerName,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
IMF_EXPORT
|
|
TiledRgbaInputFile (
|
|
OPENEXR_IMF_INTERNAL_NAMESPACE::IStream& is,
|
|
const std::string& layerName,
|
|
int numThreads = globalThreadCount ());
|
|
|
|
//-----------
|
|
// Destructor
|
|
//-----------
|
|
|
|
IMF_EXPORT
|
|
virtual ~TiledRgbaInputFile ();
|
|
|
|
//-----------------------------------------------------
|
|
// Define a frame buffer as the pixel data destination:
|
|
// Pixel (x, y) is at address
|
|
//
|
|
// base + x * xStride + y * yStride
|
|
//
|
|
//-----------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void setFrameBuffer (Rgba* base, size_t xStride, size_t yStride);
|
|
|
|
//-------------------------------------------------------------------
|
|
// Switch to a different layer -- subsequent calls to readTile()
|
|
// and readTiles() will read channels layerName.R, layerName.G, etc.
|
|
// After each call to setLayerName(), setFrameBuffer() must be called
|
|
// at least once before the next call to readTile() or readTiles().
|
|
//-------------------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void setLayerName (const std::string& layerName);
|
|
|
|
//--------------------------
|
|
// Access to the file header
|
|
//--------------------------
|
|
|
|
IMF_EXPORT
|
|
const Header& header () const;
|
|
IMF_EXPORT
|
|
const FrameBuffer& frameBuffer () const;
|
|
IMF_EXPORT
|
|
const IMATH_NAMESPACE::Box2i& displayWindow () const;
|
|
IMF_EXPORT
|
|
const IMATH_NAMESPACE::Box2i& dataWindow () const;
|
|
IMF_EXPORT
|
|
float pixelAspectRatio () const;
|
|
IMF_EXPORT
|
|
const IMATH_NAMESPACE::V2f screenWindowCenter () const;
|
|
IMF_EXPORT
|
|
float screenWindowWidth () const;
|
|
IMF_EXPORT
|
|
LineOrder lineOrder () const;
|
|
IMF_EXPORT
|
|
Compression compression () const;
|
|
IMF_EXPORT
|
|
RgbaChannels channels () const;
|
|
IMF_EXPORT
|
|
const char* fileName () const;
|
|
IMF_EXPORT
|
|
bool isComplete () const;
|
|
|
|
//----------------------------------
|
|
// Access to the file format version
|
|
//----------------------------------
|
|
|
|
IMF_EXPORT
|
|
int version () const;
|
|
|
|
//---------------------------------------------------
|
|
// Utility functions (same as in Imf::TiledInputFile)
|
|
//---------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
unsigned int tileXSize () const;
|
|
IMF_EXPORT
|
|
unsigned int tileYSize () const;
|
|
IMF_EXPORT
|
|
LevelMode levelMode () const;
|
|
IMF_EXPORT
|
|
LevelRoundingMode levelRoundingMode () const;
|
|
|
|
IMF_EXPORT
|
|
int numLevels () const;
|
|
IMF_EXPORT
|
|
int numXLevels () const;
|
|
IMF_EXPORT
|
|
int numYLevels () const;
|
|
IMF_EXPORT
|
|
bool isValidLevel (int lx, int ly) const;
|
|
|
|
IMF_EXPORT
|
|
int levelWidth (int lx) const;
|
|
IMF_EXPORT
|
|
int levelHeight (int ly) const;
|
|
|
|
IMF_EXPORT
|
|
int numXTiles (int lx = 0) const;
|
|
IMF_EXPORT
|
|
int numYTiles (int ly = 0) const;
|
|
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i dataWindowForLevel (int l = 0) const;
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i dataWindowForLevel (int lx, int ly) const;
|
|
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i dataWindowForTile (int dx, int dy, int l = 0) const;
|
|
|
|
IMF_EXPORT
|
|
IMATH_NAMESPACE::Box2i
|
|
dataWindowForTile (int dx, int dy, int lx, int ly) const;
|
|
|
|
//----------------------------------------------------------------
|
|
// Read pixel data:
|
|
//
|
|
// readTile(dx, dy, lx, ly) reads the tile with tile
|
|
// coordinates (dx, dy), and level number (lx, ly),
|
|
// and stores it in the current frame buffer.
|
|
//
|
|
// dx must lie in the interval [0, numXTiles(lx)-1]
|
|
// dy must lie in the interval [0, numYTiles(ly)-1]
|
|
//
|
|
// lx must lie in the interval [0, numXLevels()-1]
|
|
// ly must lie in the interval [0, numYLevels()-1]
|
|
//
|
|
// readTile(dx, dy, level) is a convenience function used
|
|
// for ONE_LEVEL and MIPMAP_LEVELS files. It calls
|
|
// readTile(dx, dy, level, level).
|
|
//
|
|
// The two readTiles(dx1, dx2, dy1, dy2, ...) functions allow
|
|
// reading multiple tiles at once. If multi-threading is used
|
|
// multiple tiles are read concurrently.
|
|
//
|
|
// Pixels that are outside the pixel coordinate range for the
|
|
// tile's level, are never accessed by readTile().
|
|
//
|
|
// Attempting to access a tile that is not present in the file
|
|
// throws an InputExc exception.
|
|
//
|
|
//----------------------------------------------------------------
|
|
|
|
IMF_EXPORT
|
|
void readTile (int dx, int dy, int l = 0);
|
|
IMF_EXPORT
|
|
void readTile (int dx, int dy, int lx, int ly);
|
|
|
|
IMF_EXPORT
|
|
void readTiles (int dxMin, int dxMax, int dyMin, int dyMax, int lx, int ly);
|
|
|
|
IMF_EXPORT
|
|
void readTiles (int dxMin, int dxMax, int dyMin, int dyMax, int l = 0);
|
|
|
|
private:
|
|
//
|
|
// Copy constructor and assignment are not implemented
|
|
//
|
|
|
|
TiledRgbaInputFile (const TiledRgbaInputFile&) = delete;
|
|
TiledRgbaInputFile& operator= (const TiledRgbaInputFile&) = delete;
|
|
TiledRgbaInputFile (TiledRgbaInputFile&&) = delete;
|
|
TiledRgbaInputFile& operator= (TiledRgbaInputFile&&) = delete;
|
|
|
|
class FromYa;
|
|
|
|
TiledInputFile* _inputFile;
|
|
FromYa* _fromYa;
|
|
std::string _channelNamePrefix;
|
|
};
|
|
|
|
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
|
|
|
|
#endif
|