VipsForeign

VipsForeign — load and save images in a variety of formats

Stability Level

Stable, unless otherwise indicated

Synopsis

#include <vips/vips.h>

                    VipsForeign;
                    VipsForeignClass;
void *              vips_foreign_map                    (const char *base,
                                                         VipsSListMap2Fn fn,
                                                         void *a,
                                                         void *b);
enum                VipsForeignFlags;
                    VipsForeignLoad;
                    VipsForeignLoadClass;
const char *        vips_foreign_find_load              (const char *filename);
const char *        vips_foreign_find_load_options      (const char *filename);
VipsForeignFlags    vips_foreign_flags                  (const char *loader,
                                                         const char *filename);
gboolean            vips_foreign_is_a                   (const char *loader,
                                                         const char *filename);
enum                VipsSaveable;
                    VipsForeignSave;
                    VipsForeignSaveClass;
const char *        vips_foreign_find_save              (const char *filename);
const char *        vips_foreign_find_save_options      (const char *filename);
int                 vips_foreign_load                   (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_foreign_save                   (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_foreign_load_options           (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_foreign_save_options           (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_openslideload                  (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_jpegload                       (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_jpegload_buffer                (void *buf,
                                                         size_t len,
                                                         VipsImage **out,
                                                         ...);
int                 vips_jpegsave                       (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_jpegsave_buffer                (VipsImage *in,
                                                         void **buf,
                                                         size_t *len,
                                                         ...);
int                 vips_jpegsave_mime                  (VipsImage *in,
                                                         ...);
int                 vips_webpload                       (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_webpload_buffer                (void *buf,
                                                         size_t len,
                                                         VipsImage **out,
                                                         ...);
int                 vips_webpsave                       (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_webpsave_buffer                (VipsImage *in,
                                                         void **buf,
                                                         size_t *len,
                                                         ...);
int                 vips_webpsave_mime                  (VipsImage *in,
                                                         ...);
enum                VipsForeignTiffCompression;
enum                VipsForeignTiffPredictor;
enum                VipsForeignTiffResunit;
int                 vips_tiffload                       (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_tiffsave                       (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_openexrload                    (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_fitsload                       (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_fitssave                       (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_analyzeload                    (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_rawload                        (const char *filename,
                                                         VipsImage **out,
                                                         int width,
                                                         int height,
                                                         int bands,
                                                         ...);
int                 vips_rawsave                        (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_rawsave_fd                     (VipsImage *in,
                                                         int fd,
                                                         ...);
int                 vips_csvload                        (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_csvsave                        (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_matrixload                     (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_matrixsave                     (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_magickload                     (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_pngload                        (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_pngload_buffer                 (void *buf,
                                                         size_t len,
                                                         VipsImage **out,
                                                         ...);
int                 vips_pngsave                        (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_pngsave_buffer                 (VipsImage *in,
                                                         void **buf,
                                                         size_t *len,
                                                         ...);
int                 vips_ppmload                        (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_ppmsave                        (VipsImage *in,
                                                         const char *filename,
                                                         ...);
int                 vips_matload                        (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_radload                        (const char *filename,
                                                         VipsImage **out,
                                                         ...);
int                 vips_radsave                        (VipsImage *in,
                                                         const char *filename,
                                                         ...);
enum                VipsForeignDzLayout;
enum                VipsForeignDzDepth;
int                 vips_dzsave                         (VipsImage *in,
                                                         const char *basename,
                                                         ...);

Object Hierarchy

  GObject
   +----VipsObject
         +----VipsOperation
               +----VipsForeign
                     +----VipsForeignLoad
                     +----VipsForeignSave

  GObject
   +----VipsObject
         +----VipsOperation
               +----VipsForeign
                     +----VipsForeignLoad

  GObject
   +----VipsObject
         +----VipsOperation
               +----VipsForeign
                     +----VipsForeignSave

Properties

  "access"                   VipsAccess            : Read / Write
  "disc"                     gboolean              : Read / Write
  "flags"                    VipsForeignFlags      : Read / Write
  "out"                      VipsImage*            : Read / Write
  "sequential"               gboolean              : Read / Write
  "in"                       VipsImage*            : Read / Write

Description

This set of operations load and save images in a variety of formats.

The operations share a base class that offers a simple way to search for a subclass of VipsForeign which can load a certain file (see vips_foreign_find_load()) or which could be used to save an image to a certain file type (see vips_foreign_find_save()). You can then run these operations using vips_call() and friends to perform the load or save.

A pair of convenience functions, vips_foreign_load() and vips_foreign_save(), automate the process, loading an image from a file or saving an image to a file. These functions let you give load or save options as name - value pairs in the C argument list. You can use vips_foreign_load_options() and vips_foreign_save_options() to include options in the file name.

For example: 

1
2
3
4
5
6