dc1394/vendor/avt.h File Reference

Definition of AVT-specific features. More...

#include <stdint.h>
#include <dc1394/types.h>
#include <dc1394/log.h>

Data Structures

struct  __dc1394_avt_smart_feature_info_struct
struct  __dc1394_avt_adv_feature_info_struct
struct  __dc1394_avt_sis_data_struct

Typedefs

typedef struct
__dc1394_avt_smart_feature_info_struct 
dc1394_avt_smart_feature_info_t
typedef struct
__dc1394_avt_adv_feature_info_struct 
dc1394_avt_adv_feature_info_t
typedef struct
__dc1394_avt_sis_data_struct 
dc1394_avt_sis_data

Enumerations

enum  dc1394_avt_family_t
enum  dc1394_avt_camera_id_t

Functions

dc1394error_t dc1394_avt_get_version (dc1394camera_t *camera, uint32_t *UCType, uint32_t *Version, uint32_t *Camera_ID, uint32_t *FPGA_Version)
dc1394error_t dc1394_avt_adjust_frames (uint32_t Camera_ID, dc1394video_frame_t *frame)
dc1394error_t dc1394_avt_get_advanced_feature_inquiry (dc1394camera_t *camera, dc1394_avt_adv_feature_info_t *adv_feature)
dc1394error_t dc1394_avt_get_smart_feature_inquiry (dc1394camera_t *camera, dc1394_avt_smart_feature_info_t *smart_feature, int size)
dc1394error_t dc1394_avt_print_advanced_feature (dc1394_avt_adv_feature_info_t *adv_feature)
dc1394error_t dc1394_avt_print_smart_features (dc1394_avt_smart_feature_info_t *adv_feature)
dc1394error_t dc1394_avt_get_shading (dc1394camera_t *camera, dc1394bool_t *on_off, dc1394bool_t *compute, dc1394bool_t *show, uint32_t *frame_nb)
dc1394error_t dc1394_avt_get_shading_correction (dc1394camera_t *camera, dc1394switch_t *on_off, dc1394bool_t *build_err, dc1394switch_t *show, uint32_t *frame_nb, uint32_t *mem_channel, uint32_t *mem_channel_err)
dc1394error_t dc1394_avt_set_shading (dc1394camera_t *camera, dc1394bool_t on_off, dc1394bool_t compute, dc1394bool_t show, uint32_t frame_nb)
dc1394error_t dc1394_avt_set_shading_correction (dc1394camera_t *camera, dc1394switch_t on_off, dc1394switch_t compute, dc1394switch_t show, uint32_t frame_nb, uint32_t mem_channel, dc1394switch_t mem_clear, dc1394switch_t mem_load, dc1394switch_t mem_save)
dc1394error_t dc1394_avt_get_shading_mem_ctrl (dc1394camera_t *camera, dc1394bool_t *en_write, dc1394bool_t *en_read, uint32_t *addroffset)
dc1394error_t dc1394_avt_set_shading_mem_ctrl (dc1394camera_t *camera, dc1394bool_t en_write, dc1394bool_t en_read, uint32_t addroffset)
dc1394error_t dc1394_avt_get_shading_info (dc1394camera_t *camera, uint32_t *MaxImageSize)
dc1394error_t dc1394_avt_get_shading_correction_info (dc1394camera_t *camera, uint32_t *MaxImageSize, uint32_t *MemChannelCount)
dc1394error_t dc1394_avt_get_multiple_slope (dc1394camera_t *camera, dc1394bool_t *on_off, uint32_t *points_nb, uint32_t *kneepoint1, uint32_t *kneepoint2, uint32_t *kneepoint3)
dc1394error_t dc1394_avt_set_multiple_slope (dc1394camera_t *camera, dc1394bool_t on_off, uint32_t points_nb, uint32_t kneepoint1, uint32_t kneepoint2, uint32_t kneepoint3)
dc1394error_t dc1394_avt_get_timebase (dc1394camera_t *camera, uint32_t *timebase_id)
dc1394error_t dc1394_avt_set_timebase (dc1394camera_t *camera, uint32_t timebase_id)
dc1394error_t dc1394_avt_get_extented_shutter (dc1394camera_t *camera, uint32_t *timebase_id)
dc1394error_t dc1394_avt_set_extented_shutter (dc1394camera_t *camera, uint32_t timebase_id)
dc1394error_t dc1394_avt_get_MaxResolution (dc1394camera_t *camera, uint32_t *MaxHeight, uint32_t *MaxWidth)
dc1394error_t dc1394_avt_get_auto_shutter (dc1394camera_t *camera, uint32_t *MinValue, uint32_t *MaxValue)
dc1394error_t dc1394_avt_set_auto_shutter (dc1394camera_t *camera, uint32_t MinValue, uint32_t MaxValue)
dc1394error_t dc1394_avt_get_auto_gain (dc1394camera_t *camera, uint32_t *MinValue, uint32_t *MaxValue)
dc1394error_t dc1394_avt_set_auto_gain (dc1394camera_t *camera, uint32_t MinValue, uint32_t MaxValue)
dc1394error_t dc1394_avt_get_trigger_delay (dc1394camera_t *camera, dc1394bool_t *on_off, uint32_t *DelayTime)
dc1394error_t dc1394_avt_set_trigger_delay (dc1394camera_t *camera, dc1394bool_t on_off, uint32_t DelayTime)
dc1394error_t dc1394_avt_get_mirror (dc1394camera_t *camera, dc1394bool_t *on_off)
dc1394error_t dc1394_avt_set_mirror (dc1394camera_t *camera, dc1394bool_t on_off)
dc1394error_t dc1394_avt_get_dsnu (dc1394camera_t *camera, dc1394bool_t *on_off, uint32_t *frame_nb)
dc1394error_t dc1394_avt_get_dsnu_correction (dc1394camera_t *camera, dc1394switch_t *on_off, dc1394bool_t *build_error, uint32_t *frame_nb, dc1394switch_t *show_image)
dc1394error_t dc1394_avt_set_dsnu (dc1394camera_t *camera, dc1394bool_t on_off, dc1394bool_t compute, uint32_t frame_nb)
dc1394error_t dc1394_avt_set_dsnu_correction (dc1394camera_t *camera, dc1394switch_t on_off, dc1394switch_t compute_image, uint32_t frame_nb, dc1394switch_t show_image, dc1394switch_t load_image, dc1394switch_t save_image)
dc1394error_t dc1394_avt_get_blemish (dc1394camera_t *camera, dc1394bool_t *on_off, uint32_t *frame_nb)
dc1394error_t dc1394_avt_get_blemish_correction (dc1394camera_t *camera, dc1394switch_t *on_off, dc1394bool_t *build_error, uint32_t *frame_nb, dc1394switch_t *show_image)
dc1394error_t dc1394_avt_set_blemish (dc1394camera_t *camera, dc1394bool_t on_off, dc1394bool_t compute, uint32_t frame_nb)
dc1394error_t dc1394_avt_set_blemish_correction (dc1394camera_t *camera, dc1394switch_t on_off, dc1394switch_t compute_image, uint32_t frame_nb, dc1394switch_t show_image, dc1394switch_t load_image, dc1394switch_t save_image)
dc1394error_t dc1394_avt_get_io (dc1394camera_t *camera, uint32_t IO, dc1394bool_t *polarity, uint32_t *mode, dc1394bool_t *pinstate)
dc1394error_t dc1394_avt_set_io (dc1394camera_t *camera, uint32_t IO, dc1394bool_t polarity, uint32_t mode, dc1394bool_t pinstate)
dc1394error_t dc1394_avt_get_io_pwmout_info (dc1394camera_t *camera, uint32_t pwm_output_pin, uint32_t *min_period)
dc1394error_t dc1394_avt_get_io_pwmout (dc1394camera_t *camera, uint32_t pwm_output_pin, uint32_t *period, uint32_t *pulse_width)
dc1394error_t dc1394_avt_set_io_pwmout (dc1394camera_t *camera, uint32_t pwm_output_pin, uint32_t period, uint32_t pulse_width)
dc1394error_t dc1394_avt_get_io_inp_debounce_info (dc1394camera_t *camera, uint32_t debounce_inp_pin, uint32_t *min_debounce_time, uint32_t *max_debounce_time)
dc1394error_t dc1394_avt_get_io_inp_debounce (dc1394camera_t *camera, uint32_t debounce_inp_pin, uint32_t *debounce_time)
dc1394error_t dc1394_avt_set_io_inp_debounce (dc1394camera_t *camera, uint32_t debounce_inp_pin, uint32_t debounce_time)
dc1394error_t dc1394_avt_reset (dc1394camera_t *camera)
dc1394error_t dc1394_avt_get_lut (dc1394camera_t *camera, dc1394bool_t *on_off, uint32_t *lutnb)
dc1394error_t dc1394_avt_set_lut (dc1394camera_t *camera, dc1394bool_t on_off, uint32_t lutnb)
dc1394error_t dc1394_avt_get_lut_mem_ctrl (dc1394camera_t *camera, dc1394bool_t *en_write, uint32_t *AccessLutNo, uint32_t *addroffset)
dc1394error_t dc1394_avt_set_lut_mem_ctrl (dc1394camera_t *camera, dc1394bool_t en_write, uint32_t AccessLutNo, uint32_t addroffset)
dc1394error_t dc1394_avt_get_lut_info (dc1394camera_t *camera, uint32_t *NumOfLuts, uint32_t *MaxLutSize)
dc1394error_t dc1394_avt_get_lut_extd_info (dc1394camera_t *camera, uint32_t *NumOfLuts, uint32_t *MaxValue, uint32_t *NumOfValues, uint32_t *MaxLutSize)
dc1394error_t dc1394_avt_get_autofunc_aoi_info (dc1394camera_t *camera, uint32_t *unit_x, uint32_t *unit_y)
dc1394error_t dc1394_avt_get_aoi (dc1394camera_t *camera, dc1394bool_t *on_off, int *left, int *top, int *width, int *height)
dc1394error_t dc1394_avt_get_autofunc_aoi (dc1394camera_t *camera, dc1394switch_t *on_off, dc1394switch_t *show_area, uint32_t *left, uint32_t *top, uint32_t *width, uint32_t *height)
dc1394error_t dc1394_avt_set_aoi (dc1394camera_t *camera, dc1394bool_t on_off, int left, int top, int width, int height)
dc1394error_t dc1394_avt_set_autofunc_aoi (dc1394camera_t *camera, dc1394switch_t on_off, dc1394switch_t show_area, uint32_t left, uint32_t top, uint32_t width, uint32_t height)
dc1394error_t dc1394_avt_get_test_images_info (dc1394camera_t *camera, dc1394bool_t *TestImage1, dc1394bool_t *TestImage2, dc1394bool_t *TestImage3, dc1394bool_t *TestImage4, dc1394bool_t *TestImage5, dc1394bool_t *TestImage6, dc1394bool_t *TestImage7)
dc1394error_t dc1394_avt_get_test_images (dc1394camera_t *camera, uint32_t *image_no)
dc1394error_t dc1394_avt_set_test_images (dc1394camera_t *camera, uint32_t image_no)
dc1394error_t dc1394_avt_get_frame_info (dc1394camera_t *camera, uint32_t *framecounter)
dc1394error_t dc1394_avt_get_frame_counter (dc1394camera_t *camera, const dc1394_avt_smart_feature_info_t *feature_info, uint32_t *framecounter)
dc1394error_t dc1394_avt_reset_frame_info (dc1394camera_t *camera)
dc1394error_t dc1394_avt_reset_frame_counter (dc1394camera_t *camera, const dc1394_avt_smart_feature_info_t *feature_info)
dc1394error_t dc1394_avt_get_trigger_counter (dc1394camera_t *camera, uint32_t *triggercounter)
dc1394error_t dc1394_avt_reset_trigger_counter (dc1394camera_t *camera)
dc1394error_t dc1394_avt_get_gpdata_info (dc1394camera_t *camera, uint32_t *BufferSize)
dc1394error_t dc1394_avt_get_deferred_trans (dc1394camera_t *camera, dc1394bool_t *HoldImage, dc1394bool_t *FastCapture, uint32_t *FifoSize, uint32_t *NumOfImages)
dc1394error_t dc1394_avt_set_deferred_trans (dc1394camera_t *camera, dc1394bool_t HoldImage, dc1394bool_t FastCapture, uint32_t FifoSize, uint32_t NumOfImages, dc1394bool_t SendImage)
dc1394error_t dc1394_avt_read_gpdata (dc1394camera_t *camera, unsigned char *buf, uint32_t size)
dc1394error_t dc1394_avt_write_gpdata (dc1394camera_t *camera, unsigned char *buf, uint32_t size)
dc1394error_t dc1394_avt_read_shading_img (dc1394camera_t *camera, unsigned char *buf, uint32_t size)
dc1394error_t dc1394_avt_write_shading_img (dc1394camera_t *camera, unsigned char *buf, uint32_t size)
dc1394error_t dc1394_avt_write_lut (dc1394camera_t *camera, uint32_t LutNo, unsigned char *buf, uint32_t size)
dc1394error_t dc1394_avt_get_channel_adjust (dc1394camera_t *camera, int16_t *channel_adjust)
dc1394error_t dc1394_avt_set_channel_adjust (dc1394camera_t *camera, int16_t channel_adjust)
dc1394error_t dc1394_avt_get_channel_adjust_offset (dc1394camera_t *camera, int16_t *channel_adjust)
dc1394error_t dc1394_avt_set_channel_adjust_offset (dc1394camera_t *camera, int16_t channel_adjust)
dc1394error_t dc1394_avt_set_color_corr (dc1394camera_t *camera, dc1394bool_t on_off, dc1394bool_t reset, int32_t Crr, int32_t Cgr, int32_t Cbr, int32_t Crg, int32_t Cgg, int32_t Cbg, int32_t Crb, int32_t Cgb, int32_t Cbb)
dc1394error_t dc1394_avt_get_color_corr (dc1394camera_t *camera, dc1394bool_t *on_off, int32_t *Crr, int32_t *Cgr, int32_t *Cbr, int32_t *Crg, int32_t *Cgg, int32_t *Cbg, int32_t *Crb, int32_t *Cgb, int32_t *Cbb)
dc1394error_t dc1394_avt_get_hsnr (dc1394camera_t *camera, dc1394bool_t *on_off, uint32_t *grabCount)
dc1394error_t dc1394_avt_set_hsnr (dc1394camera_t *camera, dc1394bool_t on_off, uint32_t grabCount)
dc1394error_t dc1394_avt_get_sis (dc1394camera_t *camera, const dc1394_avt_smart_feature_info_t *feature_info, dc1394switch_t *on_off, int16_t *linePos, uint32_t *userVal)
dc1394error_t dc1394_avt_set_sis (dc1394camera_t *camera, const dc1394_avt_smart_feature_info_t *feature_info, dc1394switch_t on_off, int16_t linePos, uint32_t userVal)
dc1394error_t dc1394_avt_get_sis_data_inquiry (const dc1394_avt_smart_feature_info_t *feature_info, dc1394_avt_sis_data *sis_data_inquiry)
dc1394error_t dc1394_avt_get_sis_data (const dc1394_avt_smart_feature_info_t *feature_info, dc1394video_frame_t *frame, int16_t linePos, dc1394_avt_sis_data *sis_data)
dc1394error_t dc1394_avt_get_max_iso_size (dc1394camera_t *camera, uint32_t speed_mode, dc1394switch_t *on_off, uint32_t *max_size)
dc1394error_t dc1394_avt_set_max_iso_size (dc1394camera_t *camera, uint32_t speed_mode, dc1394switch_t on_off, dc1394switch_t set_to_max, uint32_t max_size)
dc1394error_t dc1394_avt_get_param_upd_timing (dc1394camera_t *camera, uint32_t *update_timing_mode)
dc1394error_t dc1394_avt_set_param_upd_timing (dc1394camera_t *camera, uint32_t update_timing_mode)
dc1394error_t dc1394_avt_get_low_smear (dc1394camera_t *camera, dc1394switch_t *on_off)
dc1394error_t dc1394_avt_set_low_smear (dc1394camera_t *camera, dc1394switch_t on_off)
dc1394error_t dc1394_avt_get_low_noise_binning (dc1394camera_t *camera, dc1394switch_t *on_off)
dc1394error_t dc1394_avt_set_low_noise_binning (dc1394camera_t *camera, dc1394switch_t on_off)
dc1394error_t dc1394_avt_get_global_res_rel_shutter (dc1394camera_t *camera, dc1394switch_t *on_off)
dc1394error_t dc1394_avt_set_global_res_rel_shutter (dc1394camera_t *camera, dc1394switch_t on_off)
dc1394error_t dc1394_avt_get_user_profile (dc1394camera_t *camera, uint32_t *profile_id, dc1394bool_t *error, uint32_t *err_code)
dc1394error_t dc1394_avt_set_user_profile (dc1394camera_t *camera, uint32_t profile_id, dc1394switch_t load_profile, dc1394switch_t save_profile, dc1394switch_t set_default)
dc1394error_t dc1394_avt_get_led (dc1394camera_t *camera, dc1394switch_t *on_off)
dc1394error_t dc1394_avt_set_led (dc1394camera_t *camera, dc1394switch_t on_off)
dc1394error_t dc1394_avt_get_dpc_info (dc1394camera_t *camera, uint32_t *MinThreshold, uint32_t *MaxThreshold, uint32_t *MaxSize)
dc1394error_t dc1394_avt_get_dpc (dc1394camera_t *camera, dc1394switch_t *on_off, uint32_t *threshold, uint32_t *mean_value, uint32_t *data_size)
dc1394error_t dc1394_avt_set_dpc (dc1394camera_t *camera, dc1394switch_t on_off, dc1394switch_t build_data, dc1394switch_t zero_data, dc1394switch_t mem_save, dc1394switch_t mem_load, uint32_t threshold)
dc1394error_t dc1394_avt_read_dpc_data (dc1394camera_t *camera, dc1394_avt_dpc_pixel_position *DestBuffer, uint32_t *PixelCount, uint32_t BufferSize)
dc1394error_t dc1394_avt_write_dpc_data (dc1394camera_t *camera, dc1394_avt_dpc_pixel_position *SourceBuffer, uint32_t PixelCount)

Detailed Description

Definition of AVT-specific features.

More details soon


Typedef Documentation

Inquiry of available advanced features - This struct is provided for backwards compatibility. New code should use dc1394_avt_adv_function_inquiry_t instead.

SIS data structure See also dc1394_avt_set_sis, dc1394_avt_get_sis_data_inquiry and dc1394_avt_get_sis_data.

Inquiry of available advanced features - This struct is intended to be used as a replacement for dc1394_avt_adv_feature_info_t. For initialization see dc1394_avt_get_smart_feature_inquiry().


Enumeration Type Documentation

Enumeration of AVT camera IDs, as returned by dc1394_avt_get_version.

Enumeration of AVT camera family IDs. Value is stored in bits 24-31 of the cameras serial number.


Function Documentation

dc1394error_t dc1394_avt_adjust_frames ( uint32_t  Camera_ID,
dc1394video_frame_t frame 
)

Adjust the frame's color code (in some situations where raw is declared as mono). It is safe to call this function for any received frame.

dc1394error_t dc1394_avt_get_advanced_feature_inquiry ( dc1394camera_t camera,
dc1394_avt_adv_feature_info_t adv_feature 
)

Retrieve a list with supported features This function is provided for backwards compatibility. New code should call dc1394_avt_get_smart_feature_inquiry instead.

dc1394error_t dc1394_avt_get_aoi ( dc1394camera_t camera,
dc1394bool_t on_off,
int *  left,
int *  top,
int *  width,
int *  height 
)

Get Autofunction AOI configuration (on/off and area). This function is provided for backwards compatibility - new code should call dc1394_avt_get_autofunc_aoi instead.

dc1394error_t dc1394_avt_get_auto_gain ( dc1394camera_t camera,
uint32_t *  MinValue,
uint32_t *  MaxValue 
)

Get min and max gain values for Autogain

dc1394error_t dc1394_avt_get_auto_shutter ( dc1394camera_t camera,
uint32_t *  MinValue,
uint32_t *  MaxValue 
)

Get min and max shutter values for Autoshutter

dc1394error_t dc1394_avt_get_autofunc_aoi ( dc1394camera_t camera,
dc1394switch_t on_off,
dc1394switch_t show_area,
uint32_t *  left,
uint32_t *  top,
uint32_t *  width,
uint32_t *  height 
)

Get Autofunction AOI configuration (on/off state, show area mode and area)

dc1394error_t dc1394_avt_get_autofunc_aoi_info ( dc1394camera_t camera,
uint32_t *  unit_x,
uint32_t *  unit_y 
)

Get Autofunction AOI unit sizes. Only multiples of these units are allowed for area position and size.

dc1394error_t dc1394_avt_get_blemish ( dc1394camera_t camera,
dc1394bool_t on_off,
uint32_t *  frame_nb 
)

Get Blemish mode and num of frames used for correction data computation This function is provided for backwards compatibility - new code should call dc1394_avt_get_blemish_correction instead.

dc1394error_t dc1394_avt_get_blemish_correction ( dc1394camera_t camera,
dc1394switch_t on_off,
dc1394bool_t build_error,
uint32_t *  frame_nb,
dc1394switch_t show_image 
)

Get Blemish Correction configuration and error status of the last correction data computation

dc1394error_t dc1394_avt_get_channel_adjust ( dc1394camera_t camera,
int16_t *  channel_adjust 
)

Channel Balance: Read channel (gain) adjust (AVT Pike)

dc1394error_t dc1394_avt_get_channel_adjust_offset ( dc1394camera_t camera,
int16_t *  channel_adjust 
)

Channel Balance: Read channel (offset) adjust (AVT Pike)

dc1394error_t dc1394_avt_get_color_corr ( dc1394camera_t camera,
dc1394bool_t on_off,
int32_t *  Crr,
int32_t *  Cgr,
int32_t *  Cbr,
int32_t *  Crg,
int32_t *  Cgg,
int32_t *  Cbg,
int32_t *  Crb,
int32_t *  Cgb,
int32_t *  Cbb 
)

Get Color Correction + Coefficients

dc1394error_t dc1394_avt_get_deferred_trans ( dc1394camera_t camera,
dc1394bool_t HoldImage,
dc1394bool_t FastCapture,
uint32_t *  FifoSize,
uint32_t *  NumOfImages 
)

Get the fifo control mode

dc1394error_t dc1394_avt_get_dpc ( dc1394camera_t camera,
dc1394switch_t on_off,
uint32_t *  threshold,
uint32_t *  mean_value,
uint32_t *  data_size 
)

Get configuration for Defect Pixel Correction: on/off, threshold for computation, mean value and size of computed data

dc1394error_t dc1394_avt_get_dpc_info ( dc1394camera_t camera,
uint32_t *  MinThreshold,
uint32_t *  MaxThreshold,
uint32_t *  MaxSize 
)

Get info for feature Defect Pixel Correction: valid range for threshold, maximum size of defect pixel data

dc1394error_t dc1394_avt_get_dsnu ( dc1394camera_t camera,
dc1394bool_t on_off,
uint32_t *  frame_nb 
)

Get DSNU mode and num of frames used for correction data computation. This function is provided for backwards compatibility - new code should call dc1394_avt_get_dsnu_correction instead.

dc1394error_t dc1394_avt_get_dsnu_correction ( dc1394camera_t camera,
dc1394switch_t on_off,
dc1394bool_t build_error,
uint32_t *  frame_nb,
dc1394switch_t show_image 
)

Get DSNU correction configuration and error status of the last correction data computation.

dc1394error_t dc1394_avt_get_extented_shutter ( dc1394camera_t camera,
uint32_t *  timebase_id 
)

Get the Extented Shutter value in us

dc1394error_t dc1394_avt_get_frame_counter ( dc1394camera_t camera,
const dc1394_avt_smart_feature_info_t feature_info,
uint32_t *  framecounter 
)

Frame Counter: Get the number of captured frames feature_info is needed to point to a properly filled info struct - see dc1394_avt_get_smart_feature_inquiry

dc1394error_t dc1394_avt_get_frame_info ( dc1394camera_t camera,
uint32_t *  framecounter 
)

Get the number of captured frames This function is provided for backwards compatibility - new code should call dc1394_avt_get_frame_counter instead.

dc1394error_t dc1394_avt_get_global_res_rel_shutter ( dc1394camera_t camera,
dc1394switch_t on_off 
)

Get Global Reset Release Shutter

dc1394error_t dc1394_avt_get_gpdata_info ( dc1394camera_t camera,
uint32_t *  BufferSize 
)

Get the size of the GP Data buffer

dc1394error_t dc1394_avt_get_hsnr ( dc1394camera_t camera,
dc1394bool_t on_off,
uint32_t *  grabCount 
)

Get HSNR configuration ( on/off, num of frames used for averaging )

dc1394error_t dc1394_avt_get_io ( dc1394camera_t camera,
uint32_t  IO,
dc1394bool_t polarity,
uint32_t *  mode,
dc1394bool_t pinstate 
)

Get the polarity, the mode, the state of the IO. Parameter 'IO' specifies the Input-/Output Pin and should be set to DC1394_AVT_IO_INP_CTRLx or DC1394_AVT_IO_OUTP_CTRLx

dc1394error_t dc1394_avt_get_io_inp_debounce ( dc1394camera_t camera,
uint32_t  debounce_inp_pin,
uint32_t *  debounce_time 
)

Get Debounce time for a certain input pin. debounce_inp_pin should be set to DC1394_AVT_IO_INP_DEBOUNCE_CTRLx

dc1394error_t dc1394_avt_get_io_inp_debounce_info ( dc1394camera_t camera,
uint32_t  debounce_inp_pin,
uint32_t *  min_debounce_time,
uint32_t *  max_debounce_time 
)

Get valid Debounce time range for a certain input pin. debounce_inp_pin should be set to DC1394_AVT_IO_INP_DEBOUNCE_CTRLx

dc1394error_t dc1394_avt_get_io_pwmout ( dc1394camera_t camera,
uint32_t  pwm_output_pin,
uint32_t *  period,
uint32_t *  pulse_width 
)

Get timebase period and pulse width for PWM (Pulse-Width Modulation) output output_pin should be set to DC1394_AVT_IO_OUTP_PWM_CTRLx

dc1394error_t dc1394_avt_get_io_pwmout_info ( dc1394camera_t camera,
uint32_t  pwm_output_pin,
uint32_t *  min_period 
)

Get minimum PWM (Pulse-Width Modulation) period in us. output_pin should be set to DC1394_AVT_IO_OUTP_PWM_CTRLx

dc1394error_t dc1394_avt_get_led ( dc1394camera_t camera,
dc1394switch_t on_off 
)

Get LED configuration - controls 'SW Feature - LED' functionality to blank the camera's status LEDs

dc1394error_t dc1394_avt_get_low_noise_binning ( dc1394camera_t camera,
dc1394switch_t on_off 
)

Get Low Noise Binning

dc1394error_t dc1394_avt_get_low_smear ( dc1394camera_t camera,
dc1394switch_t on_off 
)

Get Low Smear configuration

dc1394error_t dc1394_avt_get_lut ( dc1394camera_t camera,
dc1394bool_t on_off,
uint32_t *  lutnb 
)

Get LUT (look-up table) configuration (on/off and the index of the current LUT)

dc1394error_t dc1394_avt_get_lut_extd_info ( dc1394camera_t camera,
uint32_t *  NumOfLuts,
uint32_t *  MaxValue,
uint32_t *  NumOfValues,
uint32_t *  MaxLutSize 
)

Get num of LUTs (look-up tables) present, the maximum value for lut entries, the number of values per lut and the lut size in bytes.

dc1394error_t dc1394_avt_get_lut_info ( dc1394camera_t camera,
uint32_t *  NumOfLuts,
uint32_t *  MaxLutSize 
)

Get num of LUTs (look-up tables) present and the max size This function is provided for backwards compatibility - new code should call dc1394_avt_get_lut_extd_info instead.

dc1394error_t dc1394_avt_get_lut_mem_ctrl ( dc1394camera_t camera,
dc1394bool_t en_write,
uint32_t *  AccessLutNo,
uint32_t *  addroffset 
)

Get memory access mode of LUT (look-up table) data

dc1394error_t dc1394_avt_get_max_iso_size ( dc1394camera_t camera,
uint32_t  speed_mode,
dc1394switch_t on_off,
uint32_t *  max_size 
)

Get 'Max Iso Size' settings. This feature overrides the maximum packet size for isochronuos transfers for a certain FireWire speed mode. The following speed modes are supported: 2: S400 setting 3: S800 setting 4: S1600 setting (future use) 5: S3200 setting (future use)

dc1394error_t dc1394_avt_get_MaxResolution ( dc1394camera_t camera,
uint32_t *  MaxHeight,
uint32_t *  MaxWidth 
)

Get the Max achievable resolution

dc1394error_t dc1394_avt_get_mirror ( dc1394camera_t camera,
dc1394bool_t on_off 
)

Get 'Mirror Image' configuration (horizontal)

dc1394error_t dc1394_avt_get_multiple_slope ( dc1394camera_t camera,
dc1394bool_t on_off,
uint32_t *  points_nb,
uint32_t *  kneepoint1,
uint32_t *  kneepoint2,
uint32_t *  kneepoint3 
)

Get HDR mode (multiple slope) configuration (on/off, the nb of kneepoints used and kneepoints values)

dc1394error_t dc1394_avt_get_param_upd_timing ( dc1394camera_t camera,
uint32_t *  update_timing_mode 
)

Get Parameter Update Timing. The following modes are supported: 0: Standard Parameter Update Timing 2: Quick Format Change Mode - A running image integration will be stopped when new settings have to be applied

dc1394error_t dc1394_avt_get_shading ( dc1394camera_t camera,
dc1394bool_t on_off,
dc1394bool_t compute,
dc1394bool_t show,
uint32_t *  frame_nb 
)

Get Shading Correction settings. This function is provided for backwards compatibility - new code should call dc1394_avt_get_shading_correction instead.

dc1394error_t dc1394_avt_get_shading_correction ( dc1394camera_t camera,
dc1394switch_t on_off,
dc1394bool_t build_err,
dc1394switch_t show,
uint32_t *  frame_nb,
uint32_t *  mem_channel,
uint32_t *  mem_channel_err 
)

Get Shading Correction settings

dc1394error_t dc1394_avt_get_shading_correction_info ( dc1394camera_t camera,
uint32_t *  MaxImageSize,
uint32_t *  MemChannelCount 
)

Retrieve the max size of a Shading Correction image and the number of supported memory channels to store shading images inside the camera.

dc1394error_t dc1394_avt_get_shading_info ( dc1394camera_t camera,
uint32_t *  MaxImageSize 
)

Retrieve the max size of a Shading Correction image This function is provided for backwards compatibility - new code should call dc1394_avt_get_shading_correction_info instead.

dc1394error_t dc1394_avt_get_shading_mem_ctrl ( dc1394camera_t camera,
dc1394bool_t en_write,
dc1394bool_t en_read,
uint32_t *  addroffset 
)

Get the current access mode (none/read/write) for Shading Correction image

dc1394error_t dc1394_avt_get_sis ( dc1394camera_t camera,
const dc1394_avt_smart_feature_info_t feature_info,
dc1394switch_t on_off,
int16_t *  linePos,
uint32_t *  userVal 
)

Get SIS configuration feature_info is needed to point to a properly filled info struct - see dc1394_avt_get_smart_feature_inquiry. Parameter userVal is only supported for newer camera families like Pike and Stingray and may be set to NULL.

dc1394error_t dc1394_avt_get_sis_data ( const dc1394_avt_smart_feature_info_t feature_info,
dc1394video_frame_t frame,
int16_t  linePos,
dc1394_avt_sis_data sis_data 
)

Retrieve SIS data from image data. 'linePos' needs to reflect the setting of the corresponding SIS parameter at the time the image was aquired. Not all elements of sis_data are necessarily filled with valid data, depending on the camera model. See dc1394_avt_get_sis_data_inquiry for supported elements. feature_info is needed to point to a properly filled info struct - see dc1394_avt_get_smart_feature_inquiry

dc1394error_t dc1394_avt_get_sis_data_inquiry ( const dc1394_avt_smart_feature_info_t feature_info,
dc1394_avt_sis_data sis_data_inquiry 
)

Get supported SIS elements for a certain camera. Supported elements of sis_data_inquiry will be set to '1', '0' otherwise. Elements marked as 'reserved' are generally unsupported. feature_info is needed to point to a properly filled info struct - see dc1394_avt_get_smart_feature_inquiry

dc1394error_t dc1394_avt_get_smart_feature_inquiry ( dc1394camera_t camera,
dc1394_avt_smart_feature_info_t smart_feature,
int  size 
)

Retrieve a list with supported features Parameter 'size' is expected to reflect the size of struct smart_feature in bytes. It is recommended to pass 'sizeof(dc1394_avt_smart_feature_inquiry_t)' as size.

dc1394error_t dc1394_avt_get_test_images ( dc1394camera_t camera,
uint32_t *  image_no 
)

Get Test Image configuration (Index 0 disables the feature)

dc1394error_t dc1394_avt_get_test_images_info ( dc1394camera_t camera,
dc1394bool_t TestImage1,
dc1394bool_t TestImage2,
dc1394bool_t TestImage3,
dc1394bool_t TestImage4,
dc1394bool_t TestImage5,
dc1394bool_t TestImage6,
dc1394bool_t TestImage7 
)

Get supported Test Images

dc1394error_t dc1394_avt_get_timebase ( dc1394camera_t camera,
uint32_t *  timebase_id 
)

Get the timebase used for 'shutter' feature. Possible values: 0: 1us 1: 2us 2: 5us 3: 10us 4: 20us 5: 50us 6: 100us 7: 200us 8: 500us 9: 1000us

dc1394error_t dc1394_avt_get_trigger_counter ( dc1394camera_t camera,
uint32_t *  triggercounter 
)

Trigger Counter: Get the number detected trigger events

dc1394error_t dc1394_avt_get_trigger_delay ( dc1394camera_t camera,
dc1394bool_t on_off,
uint32_t *  DelayTime 
)

Get Trigger Delay configuration (on/off and the actual delay)

dc1394error_t dc1394_avt_get_user_profile ( dc1394camera_t camera,
uint32_t *  profile_id,
dc1394bool_t error,
uint32_t *  err_code 
)

Get User Profile settings. This feature is an AVT-specific extension of the standard IIDC memory feature.

dc1394error_t dc1394_avt_get_version ( dc1394camera_t camera,
uint32_t *  UCType,
uint32_t *  Version,
uint32_t *  Camera_ID,
uint32_t *  FPGA_Version 
)

Retrieve the firmware version, FPGA version and the camera ID

dc1394error_t dc1394_avt_print_advanced_feature ( dc1394_avt_adv_feature_info_t adv_feature  ) 

Print the list of supported features See also dc1394_avt_get_advanced_feature_inquiry

dc1394error_t dc1394_avt_print_smart_features ( dc1394_avt_smart_feature_info_t adv_feature  ) 

Print the list of supported features See also dc1394_avt_get_smart_feature_inquiry

dc1394error_t dc1394_avt_read_dpc_data ( dc1394camera_t camera,
dc1394_avt_dpc_pixel_position *  DestBuffer,
uint32_t *  PixelCount,
uint32_t  BufferSize 
)

Download Defect Pixel Correction data to PC. PixelCount will return the number of pixels that have been read. BufferSize indicates the size of DestBuffer in Pixels

dc1394error_t dc1394_avt_read_gpdata ( dc1394camera_t camera,
unsigned char *  buf,
uint32_t  size 
)

Read size number of bytes from GPData buffer

dc1394error_t dc1394_avt_read_shading_img ( dc1394camera_t camera,
unsigned char *  buf,
uint32_t  size 
)

Read Shading Correction image from camera into buffer

dc1394error_t dc1394_avt_reset ( dc1394camera_t camera  ) 

Reset the bus and the fpga

dc1394error_t dc1394_avt_reset_frame_counter ( dc1394camera_t camera,
const dc1394_avt_smart_feature_info_t feature_info 
)

Reset Frame Counter feature_info is needed to point to a properly filled info struct - see dc1394_avt_get_smart_feature_inquiry

dc1394error_t dc1394_avt_reset_frame_info ( dc1394camera_t camera  ) 

Reset Frame Counter This function is provided for backwards compatibility - new code should call dc1394_avt_reset_frame_counter instead.

dc1394error_t dc1394_avt_reset_trigger_counter ( dc1394camera_t camera  ) 

Reset trigger counter

dc1394error_t dc1394_avt_set_aoi ( dc1394camera_t camera,
dc1394bool_t  on_off,
int  left,
int  top,
int  width,
int  height 
)

Set Autofunction AOI configuration (on/off and area). This function is provided for backwards compatibility - new code should call dc1394_avt_set_autofunc_aoi instead.

dc1394error_t dc1394_avt_set_auto_gain ( dc1394camera_t camera,
uint32_t  MinValue,
uint32_t  MaxValue 
)

Set min and max gain values for Autogain

dc1394error_t dc1394_avt_set_auto_shutter ( dc1394camera_t camera,
uint32_t  MinValue,
uint32_t  MaxValue 
)

Set min and max shutter values for Autoshutter

dc1394error_t dc1394_avt_set_autofunc_aoi ( dc1394camera_t camera,
dc1394switch_t  on_off,
dc1394switch_t  show_area,
uint32_t  left,
uint32_t  top,
uint32_t  width,
uint32_t  height 
)

Set Autofunction AOI configuration (on/off state, show area mode and area)

dc1394error_t dc1394_avt_set_blemish ( dc1394camera_t camera,
dc1394bool_t  on_off,
dc1394bool_t  compute,
uint32_t  frame_nb 
)

Set Blemish mode, num of frames used for correction data computation and launch the the computation of correction data. This function is provided for backwards compatibility - new code should call dc1394_avt_set_blemish_correction instead.

dc1394error_t dc1394_avt_set_blemish_correction ( dc1394camera_t camera,
dc1394switch_t  on_off,
dc1394switch_t  compute_image,
uint32_t  frame_nb,
dc1394switch_t  show_image,
dc1394switch_t  load_image,
dc1394switch_t  save_image 
)

Configure Blemish Correction. ( On/Off, number of frames used for computation, launch computation, enable show_image to receive correction data instead of images, load or save data from/to flash)

dc1394error_t dc1394_avt_set_channel_adjust ( dc1394camera_t camera,
int16_t  channel_adjust 
)

Channel Balance: Write channel (gain) adjust (AVT Pike)

dc1394error_t dc1394_avt_set_channel_adjust_offset ( dc1394camera_t camera,
int16_t  channel_adjust 
)

Channel Balance: Write channel (offset) adjust (AVT Pike)

dc1394error_t dc1394_avt_set_color_corr ( dc1394camera_t camera,
dc1394bool_t  on_off,
dc1394bool_t  reset,
int32_t  Crr,
int32_t  Cgr,
int32_t  Cbr,
int32_t  Crg,
int32_t  Cgg,
int32_t  Cbg,
int32_t  Crb,
int32_t  Cgb,
int32_t  Cbb 
)

Set Color Correction + Coefficients

dc1394error_t dc1394_avt_set_deferred_trans ( dc1394camera_t camera,
dc1394bool_t  HoldImage,
dc1394bool_t  FastCapture,
uint32_t  FifoSize,
uint32_t  NumOfImages,
dc1394bool_t  SendImage 
)

Set the fifo control mode

dc1394error_t dc1394_avt_set_dpc ( dc1394camera_t camera,
dc1394switch_t  on_off,
dc1394switch_t  build_data,
dc1394switch_t  zero_data,
dc1394switch_t  mem_save,
dc1394switch_t  mem_load,
uint32_t  threshold 
)

Set configuration for Defect Pixel Correction: on/off, threshold for computation, mean value and size of computed data

dc1394error_t dc1394_avt_set_dsnu ( dc1394camera_t camera,
dc1394bool_t  on_off,
dc1394bool_t  compute,
uint32_t  frame_nb 
)

Set DSNU mode, number of frames used for correction data computation and launch the the computation of the dsnu frame This function is provided for backwards compatibility - new code should call dc1394_avt_set_dsnu_correction instead.

dc1394error_t dc1394_avt_set_dsnu_correction ( dc1394camera_t camera,
dc1394switch_t  on_off,
dc1394switch_t  compute_image,
uint32_t  frame_nb,
dc1394switch_t  show_image,
dc1394switch_t  load_image,
dc1394switch_t  save_image 
)

Configure DSNU correction. ( Enable/Disable, number of frames used for correction data computation, launch the computation of correction data, enable show_image to receive correction data instead of images, load or save data from/to flash )

dc1394error_t dc1394_avt_set_extented_shutter ( dc1394camera_t camera,
uint32_t  timebase_id 
)

Set the Extented Shutter value in us

dc1394error_t dc1394_avt_set_global_res_rel_shutter ( dc1394camera_t camera,
dc1394switch_t  on_off 
)

Set Global Reset Release Shutter

dc1394error_t dc1394_avt_set_hsnr ( dc1394camera_t camera,
dc1394bool_t  on_off,
uint32_t  grabCount 
)

Set HSNR configuration ( on/off, num of frames used for averaging )

dc1394error_t dc1394_avt_set_io ( dc1394camera_t camera,
uint32_t  IO,
dc1394bool_t  polarity,
uint32_t  mode,
dc1394bool_t  pinstate 
)

Set the polarity, the mode and the state of the IO Parameter 'IO' specifies the Input-/Output Pin and should be set to DC1394_AVT_IO_INP_CTRLx or DC1394_AVT_IO_OUTP_CTRLx

dc1394error_t dc1394_avt_set_io_inp_debounce ( dc1394camera_t camera,
uint32_t  debounce_inp_pin,
uint32_t  debounce_time 
)

Set Debounce time for a certain input pin. debounce_inp_pin should be set to DC1394_AVT_IO_INP_DEBOUNCE_CTRLx

dc1394error_t dc1394_avt_set_io_pwmout ( dc1394camera_t camera,
uint32_t  pwm_output_pin,
uint32_t  period,
uint32_t  pulse_width 
)

Set period and pulse width for PWM (Pulse-Width Modulation) output. output_pin should be set to DC1394_AVT_IO_OUTP_PWM_CTRLx

dc1394error_t dc1394_avt_set_led ( dc1394camera_t camera,
dc1394switch_t  on_off 
)

Set LED configuration - controls 'SW Feature - LED' functionality to blank the camera's status LEDs

dc1394error_t dc1394_avt_set_low_noise_binning ( dc1394camera_t camera,
dc1394switch_t  on_off 
)

Set Low Noise Binning

dc1394error_t dc1394_avt_set_low_smear ( dc1394camera_t camera,
dc1394switch_t  on_off 
)

Set Low Smear configuration

dc1394error_t dc1394_avt_set_lut ( dc1394camera_t camera,
dc1394bool_t  on_off,
uint32_t  lutnb 
)

Set LUT (look-up table) configuration (on/off and the index of the current LUT)

dc1394error_t dc1394_avt_set_lut_mem_ctrl ( dc1394camera_t camera,
dc1394bool_t  en_write,
uint32_t  AccessLutNo,
uint32_t  addroffset 
)

Set memory access mode of LUT (look-up table) data

dc1394error_t dc1394_avt_set_max_iso_size ( dc1394camera_t camera,
uint32_t  speed_mode,
dc1394switch_t  on_off,
dc1394switch_t  set_to_max,
uint32_t  max_size 
)

Set 'Max Iso Size' settings. This feature overrides the maximum packet size for isochronuos transfers for a certain FireWire speed mode. The following speed modes are supported: 2: S400 setting 3: S800 setting 4: S1600 setting (future use) 5: S3200 setting (future use) Parameter 'set_to_max' configures the maximum iso size possible.

Caution: Activating this feature leads to bus utilization beyond FireWire Spec. Higher framerates can be achieved, but asynchronuos transfers may be delayed.

dc1394error_t dc1394_avt_set_mirror ( dc1394camera_t camera,
dc1394bool_t  on_off 
)

Set 'Mirror Image' configuration (horizontal)

dc1394error_t dc1394_avt_set_multiple_slope ( dc1394camera_t camera,
dc1394bool_t  on_off,
uint32_t  points_nb,
uint32_t  kneepoint1,
uint32_t  kneepoint2,
uint32_t  kneepoint3 
)

Set HDR mode (multiple slope) configuration (on/off, the nb of kneepoints used and kneepoints values)

dc1394error_t dc1394_avt_set_param_upd_timing ( dc1394camera_t camera,
uint32_t  update_timing_mode 
)

Set Parameter Update Timing. The following modes are supported: 0: Standard Parameter Update Timing 2: Quick Format Change Mode - A running image integration will be stopped when new settings have to be applied

dc1394error_t dc1394_avt_set_shading ( dc1394camera_t camera,
dc1394bool_t  on_off,
dc1394bool_t  compute,
dc1394bool_t  show,
uint32_t  frame_nb 
)

Set Shading Correction feature This function is provided for backwards compatibility - new code should call dc1394_avt_set_shading_correction instead.

dc1394error_t dc1394_avt_set_shading_correction ( dc1394camera_t camera,
dc1394switch_t  on_off,
dc1394switch_t  compute,
dc1394switch_t  show,
uint32_t  frame_nb,
uint32_t  mem_channel,
dc1394switch_t  mem_clear,
dc1394switch_t  mem_load,
dc1394switch_t  mem_save 
)

Set Shading Correction feature

dc1394error_t dc1394_avt_set_shading_mem_ctrl ( dc1394camera_t camera,
dc1394bool_t  en_write,
dc1394bool_t  en_read,
uint32_t  addroffset 
)

Set access mode (none/read/write) for Shading Correction image

dc1394error_t dc1394_avt_set_sis ( dc1394camera_t camera,
const dc1394_avt_smart_feature_info_t feature_info,
dc1394switch_t  on_off,
int16_t  linePos,
uint32_t  userVal 
)

Set SIS configuration feature_info is needed to point to a properly filled info struct - see dc1394_avt_get_smart_feature_inquiry. Changing linePos during image acquisition may lead to synchronization issues with dc1394_avt_get_sis_data.

dc1394error_t dc1394_avt_set_test_images ( dc1394camera_t camera,
uint32_t  image_no 
)

Set Test Image configuration (Index 0 disables the feature)

dc1394error_t dc1394_avt_set_timebase ( dc1394camera_t camera,
uint32_t  timebase_id 
)

Set the timebase used for 'shutter' feature. See dc1394_avt_get_timebase for possible values.

dc1394error_t dc1394_avt_set_trigger_delay ( dc1394camera_t camera,
dc1394bool_t  on_off,
uint32_t  DelayTime 
)

Set Trigger Delay configuration (on/off and the actual delay)

dc1394error_t dc1394_avt_set_user_profile ( dc1394camera_t camera,
uint32_t  profile_id,
dc1394switch_t  load_profile,
dc1394switch_t  save_profile,
dc1394switch_t  set_default 
)

Set User Profile settings. This feature is an AVT-specific extension of the standard IIDC memory feature. The number of supported user profiles is indicated by the max_mem_channel member of dc1394camera_t.

dc1394error_t dc1394_avt_write_dpc_data ( dc1394camera_t camera,
dc1394_avt_dpc_pixel_position *  SourceBuffer,
uint32_t  PixelCount 
)

Upload Defect Pixel Correction data to camera. PixelCount indicates the number of pixels to be written.

dc1394error_t dc1394_avt_write_gpdata ( dc1394camera_t camera,
unsigned char *  buf,
uint32_t  size 
)

Write size number of bytes to GPData buffer

dc1394error_t dc1394_avt_write_lut ( dc1394camera_t camera,
uint32_t  LutNo,
unsigned char *  buf,
uint32_t  size 
)

Write LUT (look-up table) data from buffer to camera

dc1394error_t dc1394_avt_write_shading_img ( dc1394camera_t camera,
unsigned char *  buf,
uint32_t  size 
)

Write Shading Correction image from buffer to camera

Generated on Tue May 25 13:23:39 2010 for libdc1394 by  doxygen 1.6.3