libopenjpeg/event.h

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