FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kCamera.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_CAMERA_H
9 #define K_FIRESYNC_CAMERA_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kCamera; --forward-declared in kFsDef.x.h
20 
32 kFsFx(kCameraModel) kCamera_Model(kCamera camera);
33 
44 kFsFx(kSize) kCamera_Id(kCamera camera);
45 
53 kFsFx(k32u) kCamera_MaxWidth(kCamera camera);
54 
62 kFsFx(k32u) kCamera_MaxHeight(kCamera camera);
63 
72 
81 kFsFx(kStatus) kCamera_Clear(kCamera camera, kSize stateCount);
82 
91 kFsFx(kStatus) kCamera_ClearAll(kCamera camera, kSize stateCount);
92 
100 kFsFx(kSize) kCamera_VideoBufferSize(kCamera camera);
101 
114 
123 
132 
145 
154 
166 kFsFx(kStatus) kCamera_Enable(kCamera camera, kBool enable);
167 
175 kFsFx(kBool) kCamera_IsEnabled(kCamera camera);
176 
191 kFsFx(kBool) kCamera_IsConnected(kCamera camera);
192 
204 kFsFx(kStatus) kCamera_SetControl(kCamera camera, kCameraControl type);
205 
213 kFsFx(kCameraControl) kCamera_Control(kCamera camera);
214 
223 kFsFx(kStatus) kCamera_ControlInfo(kCamera camera, kInfoBits* info);
224 
236 kFsFx(kStatus) kCamera_SetControlId(kCamera camera, k32u id);
237 
245 kFsFx(k32u) kCamera_ControlId(kCamera camera);
246 
255 kFsFx(kStatus) kCamera_ControlIdInfo(kCamera camera, kInfo* info);
256 
294 kFsFx(kStatus) kCamera_EnableLeadOut(kCamera camera, kBool enable);
295 
303 kFsFx(kBool) kCamera_LeadOutEnabled(kCamera camera);
304 
314 
325 kFsFx(kStatus) kCamera_AddState(kCamera camera, kCameraState* state);
326 
335 kFsFx(kStatus) kCamera_DeleteState(kCamera camera, kCameraState state);
336 
346 kFsFx(kStatus) kCamera_SwapStates(kCamera camera, kSize index0, kSize index1);
347 
355 kFsFx(kSize) kCamera_StateCount(kCamera camera);
356 
365 kFsFx(kStatus) kCamera_StateCountInfo(kCamera camera, kInfoSize* info);
366 
375 kFsFx(kCameraState) kCamera_StateAt(kCamera camera, kSize index);
376 
388 kFsFx(kStatus) kCamera_AddExtension(kCamera camera, kType type, kCameraExt* extension);
389 
398 kFsFx(kStatus) kCamera_DeleteExtension(kCamera camera, kCameraExt extension);
399 
407 kFsFx(kSize) kCamera_ExtensionCount(kCamera camera);
408 
417 kFsFx(kCameraExt) kCamera_ExtensionAt(kCamera camera, kSize index);
418 
428 kFsFx(k64u) kCamera_MinimumPeriod(kCamera camera);
429 
442 kFsFx(kStatus) kCamera_SetReadout(kCamera camera, kCameraReadout readoutMode);
443 
455 kFsFx(kCameraReadout) kCamera_Readout(kCamera camera);
456 
469 kFsFx(kStatus) kCamera_ReadoutInfo(kCamera camera, kInfoBits* info);
470 
484 kFsFx(kStatus) kCamera_EnableRamImage(kCamera camera, kBool enabled);
485 
493 kFsFx(kBool) kCamera_RamImageEnabled(kCamera camera);
494 
503 kFsFx(kBool) kCamera_RamImageEnabledInfo(kCamera camera, kInfoBool* info);
504 
513 kFsFx(kStatus) kCamera_EnablePrnu(kCamera camera, kBool enabled);
514 
522 kFsFx(kBool) kCamera_PrnuEnabled(kCamera camera);
523 
532 kFsFx(kBool) kCamera_PrnuEnabledInfo(kCamera camera, kInfoBool* info);
533 
545 kFsFx(kStatus) kCamera_EnableFpn(kCamera camera, kBool enabled);
546 
554 kFsFx(kBool) kCamera_FpnEnabled(kCamera camera);
555 
564 kFsFx(kBool) kCamera_FpnEnabledInfo(kCamera camera, kInfoBool* info);
565 
575 kFsFx(kStatus) kCamera_WritePrnu(kCamera camera, kImage white, kImage black);
576 
585 kFsFx(kStatus) kCamera_WriteFpn(kCamera camera, kImage offsets);
586 
598 kFsFx(kStatus) kCamera_WriteRangeLut(kCamera camera, const kRangeLutParams* params, const kRangeLutArray* xArray,
599  const kRangeLutArray* zArray, const kRangeLutArray* validArray);
600 
609 kFsFx(kStatus) kCamera_EnableFpnCalibration(kCamera camera, kBool enabled);
610 
619 
629 
638 kFsFx(kStatus) kCamera_EnableTestPattern(kCamera camera, kBool enabled);
639 
648 
658 
667 kFsFx(kStatus) kCamera_Stats(kCamera camera, kCameraStats* stats);
668 
678 
687 
697 
710 
719 
729 
737 kFsFx(kStatus) kCamera_Trigger(kCamera camera);
738 
753 kFsFx(kStatus) kCamera_Override(kCamera camera, const kCameraOverrideItem* overrides, kSize count);
754 
768 
777 
785 kInlineFx(kBool) kCamera_VideoEnabled(kCamera camera);
786 
794 kInlineFx(kBool) kCamera_AlgorithmEnabled(kCamera camera);
795 
804 kFsFx(kStatus) kCamera_OutputModeInfo(kCamera camera, kInfoBits* info);
805 
825 
834 
843 kFsFx(kStatus) kCamera_PortModeInfo(kCamera camera, kInfoBits* info);
844 
853 kFsFx(kSize) kCamera_NominalVideoBufferSize(kCamera camera, kSize frameCount);
854 
867 kFsFx(kSize) kCamera_NominalAlgorithmBufferSizeEx(kCamera camera, kSize frameCount);
868 
886 kFsFx(kStatus) kCamera_SetReductionFactor(kCamera camera, k32u factor);
887 
895 kFsFx(k32u) kCamera_ReductionFactor(kCamera camera);
896 
906 
924 kFsFx(kStatus) kCamera_SetReductionWindow(kCamera camera, k32u window);
925 
933 kFsFx(k32u) kCamera_ReductionWindow(kCamera camera);
934 
944 
956 kFsFx(kStatus) kCamera_SetLvdsPower(kCamera camera, k32u power);
957 
965 kFsFx(k32u) kCamera_LvdsPower(kCamera camera);
966 
975 kFsFx(kStatus) kCamera_LvdsPowerInfo(kCamera camera, kInfo32u* info);
976 
985 
997 
1006 
1016 
1037 
1049 kFsFx(kStatus) kCamera_ReadAccelerationTestResult(kCamera camera, kObject* data, kAlloc allocator);
1050 
1051 #include <kFireSync/Client/kCamera.x.h>
1052 
1053 #endif
kStatus kCamera_EnableRamImage(kCamera camera, kBool enabled)
Specifies whether the FPGA RAM Image feature is enabled.
kStatus kCamera_SetReadout(kCamera camera, kCameraReadout readoutMode)
Sets the readout mode for the camera.
k32u kCamera_ReductionWindow(kCamera camera)
Reports the window size used for bandwidth reduction.
kStatus kCamera_SetReductionFactor(kCamera camera, k32u factor)
Specifies the bandwidth reduction factor.
kStatus kCamera_ReadoutInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Readout setting.
kBool kCamera_FpnEnabled(kCamera camera)
Reports whether FPN is currently enabled.
Represents a camera state configuration.
k32u kCamera_InputCounterSourceId(kCamera camera)
Gets the input counter source id for a camera.
kStatus kCamera_SetControlId(kCamera camera, k32u id)
Sets the control source id for a camera.
kStatus kCamera_WriteAccelerationTestData(kCamera camera, kObject data)
Writes acceleration test input data.
kStatus kCamera_Stats(kCamera camera, kCameraStats *stats)
Retrieve statistics.
kSize kCamera_ExtensionCount(kCamera camera)
Gets the number of control extensions that have been configured.
kSize kCamera_StateCount(kCamera camera)
Gets the number of states belonging to the camera.
Represents camera run-time statistics.
Definition: kNodeDef.h:695
kStatus kCamera_SetLvdsPower(kCamera camera, k32u power)
Specifies the imager LVDS power setting.
kBool kCamera_PrnuEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the PrnuEnabled setting.
Represents camera port modes.
kCameraExt kCamera_ExtensionAt(kCamera camera, kSize index)
Gets the control extension at the specified index.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kStatus kCamera_StateCountInfo(kCamera camera, kInfoSize *info)
Reports constraint and validity information for the StateCount setting.
kCameraPortMode kCamera_PortMode(kCamera camera)
Gets the port mode of the camera.
kStatus kCamera_EnableTestPattern(kCamera camera, kBool enabled)
Specifies whether Test pattern is enabled.
Represents camera control modes.
k32u kCamera_ControlId(kCamera camera)
Gets the control source id for a camera.
Represents camera configuration.
kBool kCamera_PrnuEnabled(kCamera camera)
Reports whether PRNU is currently enabled.
kBool kCamera_AlgorithmEnabled(kCamera camera)
Reports whether algorithm output is enabled, based on the current OutputMode setting.
k32u kCamera_LvdsPower(kCamera camera)
Reports the imager LVDS power setting.
kStatus kCamera_ReadAccelerationTestResult(kCamera camera, kObject *data, kAlloc allocator)
Retrieves algorithm (e.g.
kStatus kCamera_SetInputCounterSource(kCamera camera, kCameraInputCounterSource source)
Sets the input counter source for a camera.
Represents the acceleration test mode.
kStatus kCamera_EnableFpnCalibration(kCamera camera, kBool enabled)
Specifies whether FPN calibration is enabled.
kStatus kCamera_DeleteExtension(kCamera camera, kCameraExt extension)
Destroys the specified camera control extension and removes it from the camera's extension list...
Essential declarations related to FireSync nodes.
kStatus kCamera_Enable(kCamera camera, kBool enable)
Enables or disables the camera.
Represents the input counter source.
kStatus kCamera_AddExtension(kCamera camera, kType type, kCameraExt *extension)
Creates and adds a new camera control extension of the specified type.
kBool kCamera_IsConnected(kCamera camera)
Reports whether a camera device is connected and communicating.
kSize kCamera_NominalAlgorithmBufferSizeEx(kCamera camera, kSize frameCount)
Gets required algorithm buffer size that is enough to buffer the desired number of frames...
kStatus kCamera_EnablePrnu(kCamera camera, kBool enabled)
Specifies whether PRNU is enabled.
kStatus kCamera_ReductionWindowInfo(kCamera camera, kInfo32u *info)
Reports constraint and validity information for the bandwidth reduction window setting.
kStatus kCamera_PortModeInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the PortMode setting.
kBool kCamera_LeadOutEnabled(kCamera camera)
Reports whether camera lead-out is enabled.
Represents camera override item.
Definition: kNodeDef.h:351
kStatus kCamera_WriteRangeLut(kCamera camera, const kRangeLutParams *params, const kRangeLutArray *xArray, const kRangeLutArray *zArray, const kRangeLutArray *validArray)
Writes FPGA Range LUT.
kStatus kCamera_ControlIdInfo(kCamera camera, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kStatus kCamera_DeleteState(kCamera camera, kCameraState state)
Destroys the specified state and removes it from the camera's state list.
Abstract base class for camera control extension parameters.
kCameraReadout kCamera_Readout(kCamera camera)
Gets the readout mode for the camera.
kBool kCamera_FpnCalibrationEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the FpnCalibrationEnabled setting.
kStatus kCamera_ClearAll(kCamera camera, kSize stateCount)
Resets camera mode and device settings to defaults.
kCameraInputCounterSource kCamera_InputCounterSource(kCamera camera)
Retrieves the input counter source.
kStatus kCamera_EnableFpn(kCamera camera, kBool enabled)
Specifies whether FPN is enabled.
kStatus kCamera_AccelerationTestModeInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Acceleration test mode setting.
kStatus kCamera_SetOutputMode(kCamera camera, kCameraOutputMode mode)
Sets the output mode of the camera.
kStatus kCamera_Trigger(kCamera camera)
Provides a software trigger to a camera.
kStatus kCamera_SetControl(kCamera camera, kCameraControl type)
Sets the control mode of the camera.
kBool kCamera_FpnEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the FpnEnabled setting.
kStatus kCamera_LeadOutEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the LeadOutEnabled setting.
kBool kCamera_RamImageEnabled(kCamera camera)
Reports whether the FPGA RAM Image feature is currently enabled.
kStatus kCamera_SetNextAlgorithmBufferSize(kCamera camera, kSize size)
Sets the algorithm buffer size that will take effect after reset.
k32u kCamera_MaxWidth(kCamera camera)
Gets the absolute maximum width of the camera.
kCameraState kCamera_StateAt(kCamera camera, kSize index)
Gets the state at the specified index.
kStatus kCamera_SetInputCounterSourceId(kCamera camera, k32u id)
Sets the input counter source id for a camera.
kCameraOutputMode kCamera_OutputMode(kCamera camera)
Gets the output mode of the camera.
kStatus kCamera_AddState(kCamera camera, kCameraState *state)
Creates and adds a new state with default values.
kCameraAccelerationTestMode kCamera_AccelerationTestMode(kCamera camera)
Reports acceleration test mode of the camera.
kStatus kCamera_ControlInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Control setting.
kStatus kCamera_SetAccelerationTestMode(kCamera camera, kCameraAccelerationTestMode mode)
Sets the acceleration test mode of the camera.
kStatus kCamera_OutputModeInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the OutputMode setting.
kStatus kCamera_SetReductionWindow(kCamera camera, k32u window)
Specifies the window size to be used for bandwidth reduction.
k32u kCamera_MaxHeight(kCamera camera)
Gets the absolute maximum height of the camera.
Represents camera readout mode.
kStatus kCamera_InputCounterSourceIdInfo(kCamera camera, kInfo *info)
Reports constraint and validity information for the InputCounterSourceId setting. ...
kBool kCamera_TestPatternEnabled(kCamera camera)
Reports whether test pattern is currently enabled.
kStatus kCamera_ReductionFactorInfo(kCamera camera, kInfo32u *info)
Reports constraint and validity information for the bandwidth reduction factor setting.
kBool kCamera_FpnCalibrationEnabled(kCamera camera)
Reports whether FPN calibration is currently enabled.
kCameraAlgorithm kCamera_Algorithm(kCamera camera)
Gets the hardware-accelerated algorithm supported by this camera.
kStatus kCamera_LvdsPowerInfo(kCamera camera, kInfo32u *info)
Reports constraint and validity information for imager LVDS power setting.
kSize kCamera_Id(kCamera camera)
Gets the id of the camera module.
Represents camera hardware-accelerated algorithm types.
kStatus kCamera_WritePrnu(kCamera camera, kImage white, kImage black)
Writes PRNU table.
kStatus kCamera_InputCounterSourceInfo(kCamera camera, kInfoBits *info)
Reports constraint and validity information for the Input Counter Source setting. ...
kStatus kCamera_SwapStates(kCamera camera, kSize index0, kSize index1)
Swaps the order of two states in the camera's state list.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:98
kStatus kCamera_WriteFpn(kCamera camera, kImage offsets)
Writes FPN table.
kStatus kCamera_EnableLeadOut(kCamera camera, kBool enable)
Determines whether estimated imager post-exposure is incorporated into nominal exposure.
kStatus kCamera_Clear(kCamera camera, kSize stateCount)
Resets camera mode settings to defaults.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
kStatus kCamera_SetNextVideoBufferSize(kCamera camera, kSize size)
Sets the video buffer size that will take effect after reset.
kStatus kCamera_SetFactoryLvdsPower(kCamera camera)
Set the imager LVDS power using kFactory default setting.
kCameraControl kCamera_Control(kCamera camera)
Reports the control mode of the camera.
Represents supported camera device types.
kSize kCamera_NextAlgorithmBufferSize(kCamera camera)
Reports the algorithm buffer size that will take effect after reset.
kBool kCamera_IsEnabled(kCamera camera)
Reports whether the camera is currently enabled.
kSize kCamera_NominalVideoBufferSize(kCamera camera, kSize frameCount)
Gets required video buffer size that is enough to buffer the desired number of frames.
kSize kCamera_VideoBufferSize(kCamera camera)
Reports the current camera video buffer size.
kStatus kCamera_Override(kCamera camera, const kCameraOverrideItem *overrides, kSize count)
Provides a list of configuration overrides to modify live camera behaviour.
kCameraModel kCamera_Model(kCamera camera)
Gets the model of the camera.
k64u kCamera_MinimumPeriod(kCamera camera)
Reports the time required by this camera to respond to an event.
kSize kCamera_NextVideoBufferSize(kCamera camera)
Reports the video buffer size that will take effect after reset.
k32u kCamera_ReductionFactor(kCamera camera)
Reports the bandwidth reduction factor.
kBool kCamera_TestPatternEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the TestPatternEnabled setting.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64
kStatus kCamera_SetPortMode(kCamera camera, kCameraPortMode mode)
Sets the port mode of the camera.
kSize kCamera_AlgorithmBufferSize(kCamera camera)
Reports the current camera algorithm buffer size.
kBool kCamera_RamImageEnabledInfo(kCamera camera, kInfoBool *info)
Reports constraint and validity information for the RamImageEnabled setting.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
kBool kCamera_VideoEnabled(kCamera camera)
Reports whether video output is enabled, based on the current OutputMode setting. ...
Represents camera output modes.