openslide.h

Go to the documentation of this file.

/*
 *  OpenSlide, a library for reading whole slide image files
 *
 *  Copyright (c) 2007-2010 Carnegie Mellon University
 *  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/>.
 *
 */

#ifndef OPENSLIDE_OPENSLIDE_H_
#define OPENSLIDE_OPENSLIDE_H_

#include <openslide-features.h>

#include <stdio.h>
#include <stdint.h>

typedef struct _openslide openslide_t;



OPENSLIDE_PUBLIC()
bool openslide_can_open(const char *filename);


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


OPENSLIDE_PUBLIC()
int32_t openslide_get_layer_count(openslide_t *osr);


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


OPENSLIDE_PUBLIC()
void openslide_get_layer_dimensions(openslide_t *osr, int32_t layer,
                                    int64_t *w, int64_t *h);


OPENSLIDE_PUBLIC()
double openslide_get_layer_downsample(openslide_t *osr, int32_t layer);


OPENSLIDE_PUBLIC()
int32_t openslide_get_best_layer_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 layer,
                           int64_t w, int64_t h);


OPENSLIDE_PUBLIC()
void openslide_close(openslide_t *osr);

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


#define OPENSLIDE_PROPERTY_NAME_COMMENT "openslide.comment"

#define OPENSLIDE_PROPERTY_NAME_VENDOR "openslide.vendor"

#define OPENSLIDE_PROPERTY_NAME_QUICKHASH1 "openslide.quickhash-1"

#define OPENSLIDE_PROPERTY_NAME_BACKGROUND_COLOR "openslide.background-color"



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 *openslide_get_comment(openslide_t *osr);



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);


// these are meant to throw compile- and link-time errors,
// since the functions they replace were never implemented
int _openslide_give_prefetch_hint_UNIMPLEMENTED(void);
void _openslide_cancel_prefetch_hint_UNIMPLEMENTED(void);
#define openslide_give_prefetch_hint(osr, x, y, layer, w, h)    \
  _openslide_give_prefetch_hint_UNIMPLEMENTED(-1);
#define openslide_cancel_prefetch_hint(osr, prefetch_id)        \
  _openslide_cancel_prefetch_hint_UNIMPLEMENTED(-1)


#endif