/src/FreeImage/Source/LibOpenJPEG/event.h

 1/*
 2 * Copyright (c) 2005, Herve Drolon, FreeImage Team
 3 * All rights reserved.
 4 *
 5 * Redistribution and use in source and binary forms, with or without
 6 * modification, are permitted provided that the following conditions
 7 * are met:
 8 * 1. Redistributions of source code must retain the above copyright
 9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
15 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 * POSSIBILITY OF SUCH DAMAGE.
25 */
26#ifndef __EVENT_H
27#define __EVENT_H
28/**
29@file event.h
30@brief Implementation of a event callback system
31
32The functions in EVENT.C have for goal to send output messages (errors, warnings, debug) to the user.
33*/
34
35#define EVT_ERROR	1	/**< Error event type */
36#define EVT_WARNING	2	/**< Warning event type */
37#define EVT_INFO	4	/**< Debug event type */
38
39/** @defgroup EVENT EVENT - Implementation of a event callback system */
40/*@{*/
41
42/** @name Exported functions (see also openjpeg.h) */
43/*@{*/
44/* ----------------------------------------------------------------------- */
45/**
46Write formatted data to a string and send the string to a user callback. 
47@param cinfo Codec context info
48@param event_type Event type or callback to use to send the message
49@param fmt Format-control string (plus optionnal arguments)
50@return Returns true if successful, returns false otherwise
51*/
52opj_bool opj_event_msg(opj_common_ptr cinfo, int event_type, const char *fmt, ...);
53/* ----------------------------------------------------------------------- */
54/*@}*/
55
56/*@}*/
57
58#endif /* __EVENT_H */