Libpiv API documentation

 Search for 

gpiv-cam.h

Go to the documentation of this file.

/* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 c-style: "K&R" -*- */

/*-----------------------------------------------------------------------------
   libgpiv - library for Particle Image Velocimetry

   Copyright (C) 2002, 2003, 2004, 2005
   Gerber van der Graaf <gerber_graaf@users.sourceforge.net>

   This file is part of libgpiv.

   Libgpiv is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  




-------------------------------------------------------------------------------
LIBRARY:                libgpiv
FILENAME:               cam.h
SOURCE:                 cam.c
EXTERNAL FUNCTIONS:
                        gpiv_cam_get_camvar
                        gpiv_cam_free_camvar
                        gpiv_cam_default_parameters
                        gpiv_cam_read_parameters
                        gpiv_cam_check_parameters_read
                        gpiv_cam_parameters_set
                        gpiv_cam_test_parameter
                        gpiv_cam_fprint_parameters

---------------------------------------------------------------------------- */

#ifndef __LIBGPIV_CAM_H__
#define __LIBGPIV_CAM_H__



/*
 * Default values of CamPar
 */
#define GPIV_CAMPAR_DEFAULT__MODE 1             
#define GPIV_CAMPAR_DEFAULT__CYCLES 1           
#define GPIV_CAMPAR_DEFAULT__FNAME "gpiv_img"   
#define GPIV_CAMPAR_CYCLES_MIN 1 
#define GPIV_CAMPAR_CYCLES_MAX 1 
/*
 * Keys of CamPar to read values from configuration files
 */
#define GPIV_CAMPAR_KEY "CAM"            
#define GPIV_CAMPAR_KEY__MODE "Mode"     
#define GPIV_CAMPAR_KEY__CYCLES "Cycles" 
#define GPIV_CAMPAR_KEY__FNAME "Fname"   
#define GPIV_CAMPAR_CYCLES_MIN 1
#define GPIV_CAMPAR_CYCLES_MAX 1

enum GpivCamMode {
    GPIV_CAM_MODE__PERIODIC = 1,
    GPIV_CAM_MODE__DURATION,    
    GPIV_CAM_MODE__ONE_SHOT_IRQ,
    GPIV_CAM_MODE__TRIGGER_IRQ, 
    GPIV_CAM_MODE__INCREMENT,   
    GPIV_CAM_MODE__DOUBLE,      
};

typedef struct __GpivCamPar GpivCamPar;
struct __GpivCamPar {
    enum GpivCamMode mode;      
    guint cycles;               
    gchar fname[GPIV_MAX_CHARS];
    gboolean mode__set;         
    gboolean cycles__set;       
    gboolean fname__set;        
};



typedef struct __GpivCamVar GpivCamVar;
struct __GpivCamVar {
    guint numNodes;             
    guint numCameras;           
    guint maxspeed;             
    guint port;                 
    raw1394handle_t handle;     
    nodeid_t *camera_nodes;     
    dc1394_cameracapture *capture;
    dc1394_camerainfo *camera;
    dc1394_feature_info *feature_info;
    dc1394_feature_set *feature_set;
    dc1394_miscinfo *misc_info;
};




GpivCamVar *
gpiv_cam_get_camvar                     (const gboolean         verbose
                                        );



gchar *
gpiv_cam_free_camvar                    (GpivCamVar             *cam_var
                                        );



void
gpiv_cam_default_parameters             (GpivCamPar             *cam_par_default,
                                        const gboolean          force
                                        );



void 
gpiv_cam_read_parameters                (FILE                   *fp_par, 
                                        GpivCamPar              *cam_par, 
                                        const gboolean          verbose
                                        );



gchar *
gpiv_cam_check_parameters_read          (GpivCamPar             *cam_par,
                                        const GpivCamPar        *cam_par_default
                                        );



void
gpiv_cam_parameters__set                (GpivCamPar             *cam_par,
                                        const gboolean          flag
                                        );



gchar *
gpiv_cam_test_parameter                 (const GpivCamPar       *cam_par
                                        );



void 
gpiv_cam_print_parameters               (FILE                   *fp_par_out, 
                                        const GpivCamPar        *cam_par
                                        );



#endif /*__LIBGPIV_CAM_H__ */

---