jas_init.h

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2002 Michael David Adams.
 * All rights reserved.
 */
 
/* __START_OF_JASPER_LICENSE__
 * 
 * JasPer License Version 2.0
 * 
 * Copyright (c) 2001-2006 Michael David Adams
 * Copyright (c) 1999-2000 Image Power, Inc.
 * Copyright (c) 1999-2000 The University of British Columbia
 * 
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person (the
 * "User") obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, and/or sell copies of the Software, and to permit
 * persons to whom the Software is furnished to do so, subject to the
 * following conditions:
 * 
 * 1.  The above copyright notices and this permission notice (which
 * includes the disclaimer below) shall be included in all copies or
 * substantial portions of the Software.
 * 
 * 2.  The name of a copyright holder shall not be used to endorse or
 * promote products derived from the Software without specific prior
 * written permission.
 * 
 * THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
 * LICENSE.  NO USE OF THE SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER
 * THIS DISCLAIMER.  THE SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS
 * "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.  IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  NO ASSURANCES ARE
 * PROVIDED BY THE COPYRIGHT HOLDERS THAT THE SOFTWARE DOES NOT INFRINGE
 * THE PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF ANY OTHER ENTITY.
 * EACH COPYRIGHT HOLDER DISCLAIMS ANY LIABILITY TO THE USER FOR CLAIMS
 * BROUGHT BY ANY OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL
 * PROPERTY RIGHTS OR OTHERWISE.  AS A CONDITION TO EXERCISING THE RIGHTS
 * GRANTED HEREUNDER, EACH USER HEREBY ASSUMES SOLE RESPONSIBILITY TO SECURE
 * ANY OTHER INTELLECTUAL PROPERTY RIGHTS NEEDED, IF ANY.  THE SOFTWARE
 * IS NOT FAULT-TOLERANT AND IS NOT INTENDED FOR USE IN MISSION-CRITICAL
 * SYSTEMS, SUCH AS THOSE USED IN THE OPERATION OF NUCLEAR FACILITIES,
 * AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL
 * SYSTEMS, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH
 * THE FAILURE OF THE SOFTWARE OR SYSTEM COULD LEAD DIRECTLY TO DEATH,
 * PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH
 * RISK ACTIVITIES").  THE COPYRIGHT HOLDERS SPECIFICALLY DISCLAIM ANY
 * EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES.
 * 
 * __END_OF_JASPER_LICENSE__
 */
 
#ifndef JAS_INIT_H
#define JAS_INIT_H
 
/* The configuration header file should be included first. */
#include <jasper/jas_config.h>
 
#include "jasper/jas_malloc.h"
#include "jasper/jas_image.h"
#include "jasper/jas_log.h"
 
#include <stdarg.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(JAS_FOR_INTERNAL_USE_ONLY)
/*
Per-thread library context.
*/
typedef struct {
 
        /*
        The level of debugging checks/output enabled by the library.
        A larger value corresponds to a greater level of debugging checks/output.
        */
        int debug_level;
 
        /*
        The function used to output error/warning/informational messages.
        int (*vlogmsgf)(jas_logtype_t type, const char *format, va_list ap);
        */
        jas_vlogmsgf_t *vlogmsgf;
 
        /*
        The image format information to be used to populate the image format
        table.
        */
        size_t image_numfmts;
        jas_image_fmtinfo_t image_fmtinfos[JAS_IMAGE_MAXFMTS];
 
        /* The maximum number of samples allowable in an image to be decoded. */
        size_t dec_default_max_samples;
 
} jas_ctx_t;
#endif
 
typedef void *jas_context_t;
 
/******************************************************************************\
* Library Run-Time Configuration.
\******************************************************************************/
 
JAS_EXPORT
void jas_conf_clear(void);
 
JAS_EXPORT
void jas_conf_set_multithread(int multithread);
 
JAS_EXPORT
void jas_conf_set_allocator(jas_allocator_t *allocator);
 
JAS_EXPORT
void jas_conf_set_debug_level(int debug_level);
 
JAS_EXPORT
void jas_conf_set_max_mem_usage(size_t max_mem);
 
JAS_EXPORT
void jas_conf_set_dec_default_max_samples(size_t max_samples);
 
JAS_EXPORT
void jas_conf_set_vlogmsgf(jas_vlogmsgf_t *func);
 
/******************************************************************************\
* Library Initialization and Cleanup.
\******************************************************************************/
 
JAS_EXPORT
int jas_init_library(void);
 
JAS_EXPORT
int jas_cleanup_library(void);
 
/******************************************************************************\
* Thread Initialization and Cleanup.
\******************************************************************************/
 
JAS_EXPORT
int jas_init_thread(void);
 
JAS_EXPORT
int jas_cleanup_thread(void);
 
/******************************************************************************\
* Legacy Initialization and Cleanup Functions.
\******************************************************************************/
 
JAS_EXPORT
int jas_init(void);
 
JAS_EXPORT
void jas_cleanup(void);
 
/******************************************************************************\
* Context Management
\******************************************************************************/
 
JAS_EXPORT
jas_context_t jas_context_create(void);
 
JAS_EXPORT
void jas_context_destroy(jas_context_t context);
 
JAS_EXPORT
jas_context_t jas_get_default_context(void);
 
JAS_EXPORT
jas_context_t jas_get_context(void);
 
JAS_EXPORT
void jas_set_context(jas_context_t context);
 
/******************************************************************************\
* Getting/Setting Context Properties
\******************************************************************************/
 
/* This function is only for internal use by the library. */
JAS_EXPORT
int jas_get_debug_level_internal(void);
 
/* This function is only for internal use by the library. */
JAS_EXPORT
size_t jas_get_dec_default_max_samples_internal(void);
 
/* This function is only for internal use by the library. */
JAS_EXPORT
jas_vlogmsgf_t *jas_get_vlogmsgf_internal(void);
 
#if defined(JAS_FOR_INTERNAL_USE_ONLY)
#if defined(JAS_HAVE_THREAD_LOCAL)
extern _Thread_local jas_ctx_t *jas_cur_ctx;
#endif
 
/* This function is only for internal use by the library. */
jas_ctx_t *jas_get_ctx_internal(void);
 
/* This function is only for internal use by the library. */
static inline jas_ctx_t *jas_get_ctx(void)
{
#if defined(JAS_HAVE_THREAD_LOCAL)
        return jas_cur_ctx ? jas_cur_ctx : jas_get_ctx_internal();
#else
        return JAS_CAST(jas_ctx_t *, jas_get_ctx_internal());
#endif
}
#endif
 
JAS_EXPORT
void jas_set_debug_level(int debug_level);
 
static inline int jas_get_debug_level(void)
{
#if defined(JAS_FOR_INTERNAL_USE_ONLY)
        jas_ctx_t *ctx = jas_get_ctx();
        return ctx->debug_level;
#else
        return jas_get_debug_level_internal();
#endif
}
 
JAS_EXPORT
void jas_set_dec_default_max_samples(size_t max_samples);
 
static inline size_t jas_get_dec_default_max_samples(void)
{
#if defined(JAS_FOR_INTERNAL_USE_ONLY)
        jas_ctx_t *ctx = jas_get_ctx();
        return ctx->dec_default_max_samples;
#else
        return jas_get_dec_default_max_samples_internal();
#endif
}
 
JAS_EXPORT
void jas_set_vlogmsgf(jas_vlogmsgf_t *func);
 
static inline
jas_vlogmsgf_t *jas_get_vlogmsgf(void)
{
#if defined(JAS_FOR_INTERNAL_USE_ONLY)
        jas_ctx_t *ctx = jas_get_ctx();
        return ctx->vlogmsgf;
#else
        return jas_get_vlogmsgf_internal();
#endif
}
 
#ifdef __cplusplus
}
#endif
 
#endif