ScCamera.h

Go to the documentation of this file.

#ifndef SC_CAMERA_H_
#define SC_CAMERA_H_

#include <Scandit/ScConfig.h>
#include <Scandit/ScCommon.h>
#include <Scandit/ScImageDescription.h>

#if defined(__cplusplus)
extern "C" {
#endif

typedef struct ScOpaqueCamera ScCamera;

typedef struct {
    uint32_t min_width;   
    uint32_t max_width;   
    uint32_t step_width;  
    uint32_t min_height;  
    uint32_t max_height;  
    uint32_t step_height; 
} ScStepwiseResolution;

typedef struct {
    uint32_t numerator;   
    uint32_t denominator; 
} ScFramerate;

SC_EXPORT
float sc_framerate_get_frame_interval(ScFramerate const *frame_rate);

SC_EXPORT
float sc_framerate_get_fps(ScFramerate const *frame_rate);

typedef struct {
    ScFramerate min;
    ScFramerate max;
    ScFramerate step;
} ScStepwiseFramerate;

typedef enum {
    SC_CAMERA_MODE_UNKNOWN = 0,  
    SC_CAMERA_MODE_DISCRETE = 1, 
    SC_CAMERA_MODE_STEPWISE =
            2 
} ScCameraMode;

SC_EXPORT
ScCamera *sc_camera_new(void);

SC_EXPORT
ScCamera *sc_camera_new_with_buffer_count(uint32_t buffer_count);

SC_EXPORT
ScCamera *sc_camera_new_from_path(char const *device_path, uint32_t buffer_count);

SC_EXPORT
void sc_camera_release(ScCamera *camera);

SC_EXPORT
void sc_camera_retain(ScCamera *camera);

SC_EXPORT
ScSize sc_camera_get_resolution(ScCamera const *camera);

SC_EXPORT
ScImageLayout sc_camera_get_image_layout(ScCamera const *camera);

SC_EXPORT
ScCameraMode sc_camera_get_resolution_mode(ScCamera const *camera);

SC_EXPORT
ScCameraMode sc_camera_get_framerate_mode(ScCamera const *camera);

SC_EXPORT
int32_t sc_camera_query_supported_resolutions(ScCamera const *camera,
                                              ScSize *resolution_array,
                                              uint32_t resolution_array_length);

SC_EXPORT
ScBool sc_camera_query_supported_resolutions_stepwise(ScCamera const *camera,
                                                      ScStepwiseResolution *resolutions);

SC_EXPORT
int32_t sc_camera_query_supported_framerates(ScCamera const *camera,
                                             ScSize resolution,
                                             ScFramerate *framerate_array,
                                             uint32_t framerate_array_length);

SC_EXPORT
ScBool sc_camera_query_supported_framerates_stepwise(ScCamera const *camera,
                                                     ScSize resolution,
                                                     ScStepwiseFramerate *framerates);

SC_EXPORT
ScBool sc_camera_request_resolution(ScCamera *camera, ScSize resolution);

SC_EXPORT
ScBool sc_camera_request_framerate(ScCamera *camera, ScFramerate framerate);

SC_EXPORT
ScBool sc_camera_set_focus_mode(ScCamera *camera, ScCameraFocusMode mode);

SC_EXPORT
ScBool sc_camera_set_manual_auto_focus_distance(ScCamera *camera, int32_t distance);

SC_EXPORT
uint8_t const *sc_camera_get_frame(ScCamera *camera, ScImageDescription *image_description);

SC_EXPORT
ScBool sc_camera_start_stream(ScCamera *camera);

SC_EXPORT
ScBool sc_camera_stop_stream(ScCamera *camera);

SC_EXPORT
ScBool sc_camera_enqueue_frame_data(ScCamera *camera, uint8_t const *frame_data);

#if defined(__cplusplus)
}
#endif

#endif // SC_CAMERA_H_