openslide.h

Go to the documentation of this file.

/*
 *  OpenSlide, a library for reading whole slide image files
 *
 *  Copyright (c) 2007-2014 Carnegie Mellon University
 *  Copyright (c) 2021      Benjamin Gilbert
 *  All rights reserved.
 *
 *  OpenSlide is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as
 *  published by the Free Software Foundation, version 2.1.
 *
 *  OpenSlide 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with OpenSlide. If not, see
 *  <http://www.gnu.org/licenses/>.
 *
 */

 
#pragma once
 
#include "openslide-features.h"
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct _openslide openslide_t;

typedef struct _openslide_cache openslide_cache_t;
 


OPENSLIDE_PUBLIC()
const char *openslide_detect_vendor(const char *filename);
 

OPENSLIDE_PUBLIC()
openslide_t *openslide_open(const char *filename);
 

OPENSLIDE_PUBLIC()
int32_t openslide_get_level_count(openslide_t *osr);
 

OPENSLIDE_PUBLIC()
void openslide_get_level0_dimensions(openslide_t *osr, int64_t *w, int64_t *h);
 

OPENSLIDE_PUBLIC()
void openslide_get_level_dimensions(openslide_t *osr, int32_t level,
                                    int64_t *w, int64_t *h);
 

OPENSLIDE_PUBLIC()
double openslide_get_level_downsample(openslide_t *osr, int32_t level);
 

OPENSLIDE_PUBLIC()
int32_t openslide_get_best_level_for_downsample(openslide_t *osr,
                                                double downsample);

OPENSLIDE_PUBLIC()
void openslide_read_region(openslide_t *osr,
                           uint32_t *dest,
                           int64_t x, int64_t y,
                           int32_t level,
                           int64_t w, int64_t h);
 

OPENSLIDE_PUBLIC()
int64_t openslide_get_icc_profile_size(openslide_t *osr);
 

OPENSLIDE_PUBLIC()
void openslide_read_icc_profile(openslide_t *osr, void *dest);
 

OPENSLIDE_PUBLIC()
void openslide_close(openslide_t *osr);


OPENSLIDE_PUBLIC()
const char *openslide_get_error(openslide_t *osr);


#define OPENSLIDE_PROPERTY_NAME_BACKGROUND_COLOR "openslide.background-color"

#define OPENSLIDE_PROPERTY_NAME_BARCODE "openslide.barcode"

#define OPENSLIDE_PROPERTY_NAME_BOUNDS_HEIGHT "openslide.bounds-height"

#define OPENSLIDE_PROPERTY_NAME_BOUNDS_WIDTH "openslide.bounds-width"

#define OPENSLIDE_PROPERTY_NAME_BOUNDS_X "openslide.bounds-x"

#define OPENSLIDE_PROPERTY_NAME_BOUNDS_Y "openslide.bounds-y"

#define OPENSLIDE_PROPERTY_NAME_COMMENT "openslide.comment"

#define OPENSLIDE_PROPERTY_NAME_ICC_SIZE "openslide.icc-size"

#define OPENSLIDE_PROPERTY_NAME_MPP_X "openslide.mpp-x"

#define OPENSLIDE_PROPERTY_NAME_MPP_Y "openslide.mpp-y"

#define OPENSLIDE_PROPERTY_NAME_OBJECTIVE_POWER "openslide.objective-power"

#define OPENSLIDE_PROPERTY_NAME_QUICKHASH1 "openslide.quickhash-1"

#define OPENSLIDE_PROPERTY_NAME_VENDOR "openslide.vendor"



OPENSLIDE_PUBLIC()
const char * const *openslide_get_property_names(openslide_t *osr);

OPENSLIDE_PUBLIC()
const char *openslide_get_property_value(openslide_t *osr, const char *name);



OPENSLIDE_PUBLIC()
const char * const *openslide_get_associated_image_names(openslide_t *osr);

OPENSLIDE_PUBLIC()
void openslide_get_associated_image_dimensions(openslide_t *osr,
                                               const char *name,
                                               int64_t *w, int64_t *h);
 

OPENSLIDE_PUBLIC()
void openslide_read_associated_image(openslide_t *osr,
                                     const char *name,
                                     uint32_t *dest);
 

OPENSLIDE_PUBLIC()
int64_t openslide_get_associated_image_icc_profile_size(openslide_t *osr,
                                                        const char *name);
 

OPENSLIDE_PUBLIC()
void openslide_read_associated_image_icc_profile(openslide_t *osr,
                                                 const char *name,
                                                 void *dest);



OPENSLIDE_PUBLIC()
openslide_cache_t *openslide_cache_create(size_t capacity);

OPENSLIDE_PUBLIC()
void openslide_set_cache(openslide_t *osr, openslide_cache_t *cache);

OPENSLIDE_PUBLIC()
void openslide_cache_release(openslide_cache_t *cache);



OPENSLIDE_PUBLIC()
const char *openslide_get_version(void);


 
#ifdef __cplusplus
}
#endif