Home | History | Annotate | Download | only in highgui
      1 /*M///////////////////////////////////////////////////////////////////////////////////////
      2 //
      3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
      4 //
      5 //  By downloading, copying, installing or using the software you agree to this license.
      6 //  If you do not agree to this license, do not download, install,
      7 //  copy or use the software.
      8 //
      9 //
     10 //                        Intel License Agreement
     11 //                For Open Source Computer Vision Library
     12 //
     13 // Copyright (C) 2000, Intel Corporation, all rights reserved.
     14 // Third party copyrights are property of their respective owners.
     15 //
     16 // Redistribution and use in source and binary forms, with or without modification,
     17 // are permitted provided that the following conditions are met:
     18 //
     19 //   * Redistribution's of source code must retain the above copyright notice,
     20 //     this list of conditions and the following disclaimer.
     21 //
     22 //   * Redistribution's in binary form must reproduce the above copyright notice,
     23 //     this list of conditions and the following disclaimer in the documentation
     24 //     and/or other materials provided with the distribution.
     25 //
     26 //   * The name of Intel Corporation may not be used to endorse or promote products
     27 //     derived from this software without specific prior written permission.
     28 //
     29 // This software is provided by the copyright holders and contributors "as is" and
     30 // any express or implied warranties, including, but not limited to, the implied
     31 // warranties of merchantability and fitness for a particular purpose are disclaimed.
     32 // In no event shall the Intel Corporation or contributors be liable for any direct,
     33 // indirect, incidental, special, exemplary, or consequential damages
     34 // (including, but not limited to, procurement of substitute goods or services;
     35 // loss of use, data, or profits; or business interruption) however caused
     36 // and on any theory of liability, whether in contract, strict liability,
     37 // or tort (including negligence or otherwise) arising in any way out of
     38 // the use of this software, even if advised of the possibility of such damage.
     39 //
     40 //M*/
     41 
     42 #ifndef __OPENCV_HIGHGUI_H__
     43 #define __OPENCV_HIGHGUI_H__
     44 
     45 #include "opencv2/core/core_c.h"
     46 #include "opencv2/imgproc/imgproc_c.h"
     47 #include "opencv2/imgcodecs/imgcodecs_c.h"
     48 #include "opencv2/videoio/videoio_c.h"
     49 
     50 #ifdef __cplusplus
     51 extern "C" {
     52 #endif /* __cplusplus */
     53 
     54 /** @addtogroup highgui_c
     55   @{
     56   */
     57 
     58 /****************************************************************************************\
     59 *                                  Basic GUI functions                                   *
     60 \****************************************************************************************/
     61 //YV
     62 //-----------New for Qt
     63 /* For font */
     64 enum {  CV_FONT_LIGHT           = 25,//QFont::Light,
     65         CV_FONT_NORMAL          = 50,//QFont::Normal,
     66         CV_FONT_DEMIBOLD        = 63,//QFont::DemiBold,
     67         CV_FONT_BOLD            = 75,//QFont::Bold,
     68         CV_FONT_BLACK           = 87 //QFont::Black
     69 };
     70 
     71 enum {  CV_STYLE_NORMAL         = 0,//QFont::StyleNormal,
     72         CV_STYLE_ITALIC         = 1,//QFont::StyleItalic,
     73         CV_STYLE_OBLIQUE        = 2 //QFont::StyleOblique
     74 };
     75 /* ---------*/
     76 
     77 //for color cvScalar(blue_component, green_component, red_component[, alpha_component])
     78 //and alpha= 0 <-> 0xFF (not transparent <-> transparent)
     79 CVAPI(CvFont) cvFontQt(const char* nameFont, int pointSize CV_DEFAULT(-1), CvScalar color CV_DEFAULT(cvScalarAll(0)), int weight CV_DEFAULT(CV_FONT_NORMAL),  int style CV_DEFAULT(CV_STYLE_NORMAL), int spacing CV_DEFAULT(0));
     80 
     81 CVAPI(void) cvAddText(const CvArr* img, const char* text, CvPoint org, CvFont *arg2);
     82 
     83 CVAPI(void) cvDisplayOverlay(const char* name, const char* text, int delayms CV_DEFAULT(0));
     84 CVAPI(void) cvDisplayStatusBar(const char* name, const char* text, int delayms CV_DEFAULT(0));
     85 
     86 CVAPI(void) cvSaveWindowParameters(const char* name);
     87 CVAPI(void) cvLoadWindowParameters(const char* name);
     88 CVAPI(int) cvStartLoop(int (*pt2Func)(int argc, char *argv[]), int argc, char* argv[]);
     89 CVAPI(void) cvStopLoop( void );
     90 
     91 typedef void (CV_CDECL *CvButtonCallback)(int state, void* userdata);
     92 enum {CV_PUSH_BUTTON = 0, CV_CHECKBOX = 1, CV_RADIOBOX = 2};
     93 CVAPI(int) cvCreateButton( const char* button_name CV_DEFAULT(NULL),CvButtonCallback on_change CV_DEFAULT(NULL), void* userdata CV_DEFAULT(NULL) , int button_type CV_DEFAULT(CV_PUSH_BUTTON), int initial_button_state CV_DEFAULT(0));
     94 //----------------------
     95 
     96 
     97 /* this function is used to set some external parameters in case of X Window */
     98 CVAPI(int) cvInitSystem( int argc, char** argv );
     99 
    100 CVAPI(int) cvStartWindowThread( void );
    101 
    102 // ---------  YV ---------
    103 enum
    104 {
    105     //These 3 flags are used by cvSet/GetWindowProperty
    106     CV_WND_PROP_FULLSCREEN = 0, //to change/get window's fullscreen property
    107     CV_WND_PROP_AUTOSIZE   = 1, //to change/get window's autosize property
    108     CV_WND_PROP_ASPECTRATIO= 2, //to change/get window's aspectratio property
    109     CV_WND_PROP_OPENGL     = 3, //to change/get window's opengl support
    110 
    111     //These 2 flags are used by cvNamedWindow and cvSet/GetWindowProperty
    112     CV_WINDOW_NORMAL       = 0x00000000, //the user can resize the window (no constraint)  / also use to switch a fullscreen window to a normal size
    113     CV_WINDOW_AUTOSIZE     = 0x00000001, //the user cannot resize the window, the size is constrainted by the image displayed
    114     CV_WINDOW_OPENGL       = 0x00001000, //window with opengl support
    115 
    116     //Those flags are only for Qt
    117     CV_GUI_EXPANDED         = 0x00000000, //status bar and tool bar
    118     CV_GUI_NORMAL           = 0x00000010, //old fashious way
    119 
    120     //These 3 flags are used by cvNamedWindow and cvSet/GetWindowProperty
    121     CV_WINDOW_FULLSCREEN   = 1,//change the window to fullscreen
    122     CV_WINDOW_FREERATIO    = 0x00000100,//the image expends as much as it can (no ratio constraint)
    123     CV_WINDOW_KEEPRATIO    = 0x00000000//the ration image is respected.
    124 };
    125 
    126 /* create window */
    127 CVAPI(int) cvNamedWindow( const char* name, int flags CV_DEFAULT(CV_WINDOW_AUTOSIZE) );
    128 
    129 /* Set and Get Property of the window */
    130 CVAPI(void) cvSetWindowProperty(const char* name, int prop_id, double prop_value);
    131 CVAPI(double) cvGetWindowProperty(const char* name, int prop_id);
    132 
    133 /* display image within window (highgui windows remember their content) */
    134 CVAPI(void) cvShowImage( const char* name, const CvArr* image );
    135 
    136 /* resize/move window */
    137 CVAPI(void) cvResizeWindow( const char* name, int width, int height );
    138 CVAPI(void) cvMoveWindow( const char* name, int x, int y );
    139 
    140 
    141 /* destroy window and all the trackers associated with it */
    142 CVAPI(void) cvDestroyWindow( const char* name );
    143 
    144 CVAPI(void) cvDestroyAllWindows(void);
    145 
    146 /* get native window handle (HWND in case of Win32 and Widget in case of X Window) */
    147 CVAPI(void*) cvGetWindowHandle( const char* name );
    148 
    149 /* get name of highgui window given its native handle */
    150 CVAPI(const char*) cvGetWindowName( void* window_handle );
    151 
    152 
    153 typedef void (CV_CDECL *CvTrackbarCallback)(int pos);
    154 
    155 /* create trackbar and display it on top of given window, set callback */
    156 CVAPI(int) cvCreateTrackbar( const char* trackbar_name, const char* window_name,
    157                              int* value, int count, CvTrackbarCallback on_change CV_DEFAULT(NULL));
    158 
    159 typedef void (CV_CDECL *CvTrackbarCallback2)(int pos, void* userdata);
    160 
    161 CVAPI(int) cvCreateTrackbar2( const char* trackbar_name, const char* window_name,
    162                               int* value, int count, CvTrackbarCallback2 on_change,
    163                               void* userdata CV_DEFAULT(0));
    164 
    165 /* retrieve or set trackbar position */
    166 CVAPI(int) cvGetTrackbarPos( const char* trackbar_name, const char* window_name );
    167 CVAPI(void) cvSetTrackbarPos( const char* trackbar_name, const char* window_name, int pos );
    168 CVAPI(void) cvSetTrackbarMax(const char* trackbar_name, const char* window_name, int maxval);
    169 
    170 enum
    171 {
    172     CV_EVENT_MOUSEMOVE      =0,
    173     CV_EVENT_LBUTTONDOWN    =1,
    174     CV_EVENT_RBUTTONDOWN    =2,
    175     CV_EVENT_MBUTTONDOWN    =3,
    176     CV_EVENT_LBUTTONUP      =4,
    177     CV_EVENT_RBUTTONUP      =5,
    178     CV_EVENT_MBUTTONUP      =6,
    179     CV_EVENT_LBUTTONDBLCLK  =7,
    180     CV_EVENT_RBUTTONDBLCLK  =8,
    181     CV_EVENT_MBUTTONDBLCLK  =9,
    182     CV_EVENT_MOUSEWHEEL     =10,
    183     CV_EVENT_MOUSEHWHEEL    =11
    184 };
    185 
    186 enum
    187 {
    188     CV_EVENT_FLAG_LBUTTON   =1,
    189     CV_EVENT_FLAG_RBUTTON   =2,
    190     CV_EVENT_FLAG_MBUTTON   =4,
    191     CV_EVENT_FLAG_CTRLKEY   =8,
    192     CV_EVENT_FLAG_SHIFTKEY  =16,
    193     CV_EVENT_FLAG_ALTKEY    =32
    194 };
    195 
    196 
    197 #define CV_GET_WHEEL_DELTA(flags) ((short)((flags >> 16) & 0xffff)) // upper 16 bits
    198 
    199 typedef void (CV_CDECL *CvMouseCallback )(int event, int x, int y, int flags, void* param);
    200 
    201 /* assign callback for mouse events */
    202 CVAPI(void) cvSetMouseCallback( const char* window_name, CvMouseCallback on_mouse,
    203                                 void* param CV_DEFAULT(NULL));
    204 
    205 /* wait for key event infinitely (delay<=0) or for "delay" milliseconds */
    206 CVAPI(int) cvWaitKey(int delay CV_DEFAULT(0));
    207 
    208 // OpenGL support
    209 
    210 typedef void (CV_CDECL *CvOpenGlDrawCallback)(void* userdata);
    211 CVAPI(void) cvSetOpenGlDrawCallback(const char* window_name, CvOpenGlDrawCallback callback, void* userdata CV_DEFAULT(NULL));
    212 
    213 CVAPI(void) cvSetOpenGlContext(const char* window_name);
    214 CVAPI(void) cvUpdateWindow(const char* window_name);
    215 
    216 
    217 /****************************************************************************************\
    218 
    219 *                              Obsolete functions/synonyms                               *
    220 \****************************************************************************************/
    221 
    222 #define cvAddSearchPath(path)
    223 #define cvvInitSystem cvInitSystem
    224 #define cvvNamedWindow cvNamedWindow
    225 #define cvvShowImage cvShowImage
    226 #define cvvResizeWindow cvResizeWindow
    227 #define cvvDestroyWindow cvDestroyWindow
    228 #define cvvCreateTrackbar cvCreateTrackbar
    229 #define cvvAddSearchPath cvAddSearchPath
    230 #define cvvWaitKey(name) cvWaitKey(0)
    231 #define cvvWaitKeyEx(name,delay) cvWaitKey(delay)
    232 #define HG_AUTOSIZE CV_WINDOW_AUTOSIZE
    233 #define set_preprocess_func cvSetPreprocessFuncWin32
    234 #define set_postprocess_func cvSetPostprocessFuncWin32
    235 
    236 #if defined WIN32 || defined _WIN32
    237 
    238 CVAPI(void) cvSetPreprocessFuncWin32_(const void* callback);
    239 CVAPI(void) cvSetPostprocessFuncWin32_(const void* callback);
    240 #define cvSetPreprocessFuncWin32(callback) cvSetPreprocessFuncWin32_((const void*)(callback))
    241 #define cvSetPostprocessFuncWin32(callback) cvSetPostprocessFuncWin32_((const void*)(callback))
    242 
    243 #endif
    244 
    245 /** @} highgui_c */
    246 
    247 #ifdef __cplusplus
    248 }
    249 #endif
    250 
    251 #endif
    252