jp3d/libjp3dvm/event.h

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