OFImage.h

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#import "OFObject.h"
#import "OFString.h"

OF_ASSUME_NONNULL_BEGIN

@class OFColor;
@class OFColorSpace;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFMutableImage;
@class OFSeekableStream;

typedef enum {
    /* Private */
    _OFPixelFormatInt8  = 0x10000,
    _OFPixelFormatInt16 = 0x20000,
    _OFPixelFormatInt32 = 0x30000,
    _OFPixelFormatFP16  = 0x50000,
    _OFPixelFormatFP32  = 0x60000,

    OFPixelFormatUnknown = 0,
    OFPixelFormatRGB888 = _OFPixelFormatInt8,
    OFPixelFormatBGR888,
    OFPixelFormatRGB565 = _OFPixelFormatInt16,
    OFPixelFormatRGBA8888 = _OFPixelFormatInt32,
    OFPixelFormatARGB8888,
    OFPixelFormatABGR8888,
    OFPixelFormatBGRA8888,
    OFPixelFormatRGBA16161616FP = _OFPixelFormatFP16 + 2,
    OFPixelFormatRGBA32323232FP = _OFPixelFormatFP32 + 2
} OFPixelFormat;

typedef OFConstantString *OFImageFormat;

#ifdef __cplusplus
extern "C" {
#endif

extern const OFImageFormat OFImageFormatBMP;

extern const OFImageFormat OFImageFormatGIF;

extern const OFImageFormat OFImageFormatJPEG;

extern const OFImageFormat OFImageFormatPNG;

extern const OFImageFormat OFImageFormatQOI;
#ifdef __cplusplus
}
#endif

@interface OFImage: OFObject <OFCopying, OFMutableCopying>
{
    void *_pixels;
    OFPixelFormat _pixelFormat;
    OFSize _size;
    OFColorSpace *_colorSpace;
    bool _freeWhenDone;
    OFSize _dotsPerInch;
    OF_RESERVE_IVARS(OFImage, 4)
}

@property (readonly, nonatomic) const void *pixels OF_RETURNS_INNER_POINTER;

@property (readonly, nonatomic) OFPixelFormat pixelFormat;

@property (readonly, nonatomic) OFSize size;

@property (readonly, retain, nonatomic) OFColorSpace *colorSpace;

@property (readonly, nonatomic) unsigned int bitsPerPixel;

@property (readonly, nonatomic) OFSize dotsPerInch;

+ (OFMutableImage *)imageWithStream: (OFSeekableStream *)stream
            imageFormat: (OFImageFormat)format;

+ (instancetype)imageWithPixels: (const void *)pixels
            pixelFormat: (OFPixelFormat)pixelFormat
               size: (OFSize)size;

+ (instancetype)imageWithPixels: (const void *)pixels
            pixelFormat: (OFPixelFormat)pixelFormat
               size: (OFSize)size
             colorSpace: (OFColorSpace *)colorSpace;

+ (instancetype)imageWithPixelsNoCopy: (const void *)pixels
              pixelFormat: (OFPixelFormat)pixelFormat
                 size: (OFSize)size
             freeWhenDone: (bool)freeWhenDone;

+ (instancetype)imageWithPixelsNoCopy: (const void *)pixels
              pixelFormat: (OFPixelFormat)pixelFormat
                 size: (OFSize)size
               colorSpace: (OFColorSpace *)colorSpace
             freeWhenDone: (bool)freeWhenDone;

- (instancetype)init OF_UNAVAILABLE;

- (instancetype)initWithPixels: (const void *)pixels
           pixelFormat: (OFPixelFormat)pixelFormat
              size: (OFSize)size;

- (instancetype)initWithPixels: (const void *)pixels
           pixelFormat: (OFPixelFormat)pixelFormat
              size: (OFSize)size
            colorSpace: (OFColorSpace *)colorSpace;

- (instancetype)initWithPixelsNoCopy: (const void *)pixels
             pixelFormat: (OFPixelFormat)pixelFormat
                size: (OFSize)size
            freeWhenDone: (bool)freeWhenDone;

- (instancetype)initWithPixelsNoCopy: (const void *)pixels
             pixelFormat: (OFPixelFormat)pixelFormat
                size: (OFSize)size
              colorSpace: (OFColorSpace *)colorSpace
            freeWhenDone: (bool)freeWhenDone;

- (OFColor *)colorAtPoint: (OFPoint)point;

- (OFImage *)imageUsingPixelFormat: (OFPixelFormat)pixelFormat
            colorSpace: (OFColorSpace *)colorSpace;

- (void)
    writeToStream: (OFSeekableStream *)stream
      imageFormat: (OFImageFormat)format
      options: (nullable OFDictionary OF_GENERIC(OFString *, id) *)options;
@end

OF_ASSUME_NONNULL_END

#import "OFMutableImage.h"