IMB_filetype.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "IMB_imbuf.hh"
 
struct ImBuf;
struct ImFileColorSpace;
 
/* -------------------------------------------------------------------- */
 
#define IM_FTYPE_FLOAT 1
 
struct ImFileType {
  void (*init)();
  void (*exit)();

  bool (*is_a)(const unsigned char *buf, size_t size);

  ImBuf *(*load)(const unsigned char *mem, size_t size, int flags, ImFileColorSpace &r_colorspace);
  ImBuf *(*load_filepath)(const char *filepath, int flags, ImFileColorSpace &r_colorspace);
  ImBuf *(*load_filepath_thumbnail)(const char *filepath,
                                    int flags,
                                    size_t max_thumb_size,
                                    ImFileColorSpace &r_colorspace,
                                    size_t *r_width,
                                    size_t *r_height);
  bool (*save)(ImBuf *ibuf, const char *filepath, int flags);
 
  int flag;

  int filetype;
 
  int default_save_role;
};
 
/* Color space information provided by the file. */
struct ImFileColorSpace {
  /* Color space from metadata. */
  char metadata_colorspace[IM_MAX_SPACE] = "";
  /* Is image HDR with range potentially outside 0..1? */
  bool is_hdr_float = false;
};
 
extern const ImFileType IMB_FILE_TYPES[];
extern const ImFileType *IMB_FILE_TYPES_LAST;
 
const ImFileType *IMB_file_type_from_ftype(int ftype);
const ImFileType *IMB_file_type_from_ibuf(const ImBuf *ibuf);
 
void imb_filetypes_init();
void imb_filetypes_exit();

 
/* Type Specific Functions */
 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_png(const unsigned char *mem, size_t size);
ImBuf *imb_load_png(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
bool imb_save_png(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_tga(const unsigned char *mem, size_t size);
ImBuf *imb_load_tga(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
bool imb_save_tga(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_iris(const unsigned char *mem, size_t size);
ImBuf *imb_loadiris(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
bool imb_saveiris(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_jp2(const unsigned char *buf, size_t size);
ImBuf *imb_load_jp2(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
ImBuf *imb_load_jp2_filepath(const char *filepath, int flags, ImFileColorSpace &r_colorspace);
bool imb_save_jp2(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_jpeg(const unsigned char *mem, size_t size);
bool imb_savejpeg(ImBuf *ibuf, const char *filepath, int flags);
ImBuf *imb_load_jpeg(const unsigned char *buffer,
                     size_t size,
                     int flags,
                     ImFileColorSpace &r_colorspace);
ImBuf *imb_thumbnail_jpeg(const char *filepath,
                          int flags,
                          size_t max_thumb_size,
                          ImFileColorSpace &r_colorspace,
                          size_t *r_width,
                          size_t *r_height);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_bmp(const unsigned char *mem, size_t size);
ImBuf *imb_load_bmp(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
/* Found write info at http://users.ece.gatech.edu/~slabaugh/personal/c/bitmapUnix.c */
bool imb_save_bmp(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_cineon(const unsigned char *mem, size_t size);
bool imb_save_cineon(ImBuf *buf, const char *filepath, int flags);
ImBuf *imb_load_cineon(const unsigned char *mem,
                       size_t size,
                       int flags,
                       ImFileColorSpace &r_colorspace);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_dpx(const unsigned char *mem, size_t size);
bool imb_save_dpx(ImBuf *ibuf, const char *filepath, int flags);
ImBuf *imb_load_dpx(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_hdr(const unsigned char *mem, size_t size);
ImBuf *imb_load_hdr(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
bool imb_save_hdr(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_tiff(const unsigned char *mem, size_t size);
ImBuf *imb_load_tiff(const unsigned char *mem,
                     size_t size,
                     int flags,
                     ImFileColorSpace &r_colorspace);
bool imb_save_tiff(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_webp(const unsigned char *mem, size_t size);
ImBuf *imb_loadwebp(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);
ImBuf *imb_load_filepath_thumbnail_webp(const char *filepath,
                                        const int flags,
                                        const size_t max_thumb_size,
                                        ImFileColorSpace &r_colorspace,
                                        size_t *r_width,
                                        size_t *r_height);
bool imb_savewebp(ImBuf *ibuf, const char *filepath, int flags);

 
/* -------------------------------------------------------------------- */
 
void imb_init_dds();
 
bool imb_is_a_dds(const unsigned char *mem, size_t size);
 
ImBuf *imb_load_dds(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);

 
/* -------------------------------------------------------------------- */
 
bool imb_is_a_psd(const unsigned char *mem, size_t size);
 
ImBuf *imb_load_psd(const unsigned char *mem,
                    size_t size,
                    int flags,
                    ImFileColorSpace &r_colorspace);

 
/* -------------------------------------------------------------------- */
 
ImBuf *imb_load_filepath_thumbnail_svg(const char *filepath,
                                       const int flags,
                                       const size_t max_thumb_size,
                                       ImFileColorSpace &r_colorspace,
                                       size_t *r_width,
                                       size_t *r_height);