ArvCamera: Aravis Reference Manual

ArvCamera

ArvCamera — Class for generic camera control

Functions

ArvAuto	arv_auto_from_string ()
const char *	arv_auto_to_string ()
ArvCamera *	arv_camera_new ()
ArvStream *	arv_camera_create_stream ()
ArvDevice *	arv_camera_get_device ()
const char *	arv_camera_get_vendor_name ()
const char *	arv_camera_get_model_name ()
const char *	arv_camera_get_device_id ()
void	arv_camera_get_sensor_size ()
void	arv_camera_set_region ()
void	arv_camera_get_region ()
void	arv_camera_get_height_bounds ()
void	arv_camera_get_width_bounds ()
void	arv_camera_set_binning ()
void	arv_camera_get_binning ()
void	arv_camera_set_pixel_format ()
ArvPixelFormat	arv_camera_get_pixel_format ()
const char *	arv_camera_get_pixel_format_as_string ()
void	arv_camera_set_pixel_format_from_string ()
gint64 *	arv_camera_get_available_pixel_formats ()
const char **	arv_camera_get_available_pixel_formats_as_display_names ()
const char **	arv_camera_get_available_pixel_formats_as_strings ()
void	arv_camera_start_acquisition ()
void	arv_camera_stop_acquisition ()
void	arv_camera_abort_acquisition ()
void	arv_camera_set_acquisition_mode ()
ArvAcquisitionMode	arv_camera_get_acquisition_mode ()
gboolean	arv_camera_is_frame_rate_available ()
void	arv_camera_set_frame_rate ()
double	arv_camera_get_frame_rate ()
void	arv_camera_get_frame_rate_bounds ()
void	arv_camera_set_trigger ()
void	arv_camera_set_trigger_source ()
const char *	arv_camera_get_trigger_source ()
void	arv_camera_software_trigger ()
gboolean	arv_camera_is_exposure_time_available ()
gboolean	arv_camera_is_exposure_auto_available ()
void	arv_camera_set_exposure_time ()
double	arv_camera_get_exposure_time ()
void	arv_camera_get_exposure_time_bounds ()
void	arv_camera_set_exposure_time_auto ()
ArvAuto	arv_camera_get_exposure_time_auto ()
gboolean	arv_camera_is_gain_available ()
gboolean	arv_camera_is_gain_auto_available ()
void	arv_camera_set_gain ()
double	arv_camera_get_gain ()
void	arv_camera_get_gain_bounds ()
void	arv_camera_set_gain_auto ()
ArvAuto	arv_camera_get_gain_auto ()
guint	arv_camera_get_payload ()
gboolean	arv_camera_is_gv_device ()
gint	arv_camera_gv_get_n_stream_channels ()
void	arv_camera_gv_select_stream_channel ()
int	arv_camera_gv_get_current_stream_channel ()
gint64	arv_camera_gv_get_packet_delay ()
void	arv_camera_gv_set_packet_delay ()
gint	arv_camera_gv_get_packet_size ()
void	arv_camera_gv_set_packet_size ()
gboolean	arv_camera_get_chunk_mode ()
gboolean	arv_camera_get_chunk_state ()
void	arv_camera_set_chunk_mode ()
void	arv_camera_set_chunk_state ()
void	arv_camera_set_chunks ()
ArvChunkParser *	arv_camera_create_chunk_parser ()
const char *	arv_acquisition_mode_to_string ()
ArvAcquisitionMode	arv_acquisition_mode_from_string ()

Properties

ArvDevice *

device

Read / Write / Construct Only

Types and Values

enum	ArvAuto
	ArvCamera
enum	ArvAcquisitionMode

Object Hierarchy

    GObject
    ╰── ArvCamera

Description

ArvCamera is a class for the generic control of cameras. It hides the complexity of the genicam interface by providing a simple API, with the drawback of not exposing all the available features. See ArvDevice and ArvGc for a more advanced use of the Aravis library.

Example 1. Example use of the ArvCamera API

#include <arv.h>
#include <stdlib.h>
#include <signal.h>
#include <stdio.h>

typedef struct {
    GMainLoop *main_loop;
    int buffer_count;
} ApplicationData;

static gboolean cancel = FALSE;

static void
set_cancel (int signal)
{
    cancel = TRUE;
}

static void
new_buffer_cb (ArvStream *stream, ApplicationData *data)
{
    ArvBuffer *buffer;

    buffer = arv_stream_try_pop_buffer (stream);
    if (buffer != NULL) {
        if (arv_buffer_get_status (buffer) == ARV_BUFFER_STATUS_SUCCESS)
            data->buffer_count++;
        /* Image processing here */
        arv_stream_push_buffer (stream, buffer);
    }
}

static gboolean
periodic_task_cb (void *abstract_data)
{
    ApplicationData *data = abstract_data;

    printf ("Frame rate = %d Hz\n", data->buffer_count);
    data->buffer_count = 0;

    if (cancel) {
        g_main_loop_quit (data->main_loop);
        return FALSE;
    }

    return TRUE;
}

static void
control_lost_cb (ArvGvDevice *gv_device)
{
    /* Control of the device is lost. Display a message and force application exit */
    printf ("Control lost\n");

    cancel = TRUE;
}

int
main (int argc, char **argv)
{
    ApplicationData data;
    ArvCamera *camera;
    ArvStream *stream;
    int i;

    data.buffer_count = 0;

    /* Mandatory glib type system initialization */
    arv_g_type_init ();

    /* Instantiation of the first available camera */
    camera = arv_camera_new (NULL);

    if (camera != NULL) {
        void (*old_sigint_handler)(int);
        gint payload;

        /* Set region of interrest to a 200x200 pixel area */
        arv_camera_set_region (camera, 0, 0, 200, 200);
        /* Set frame rate to 10 Hz */
        arv_camera_set_frame_rate (camera, 10.0);
        /* retrieve image payload (number of bytes per image) */
        payload = arv_camera_get_payload (camera);

        /* Create a new stream object */
        stream = arv_camera_create_stream (camera, NULL, NULL);
        if (stream != NULL) {
            /* Push 50 buffer in the stream input buffer queue */
            for (i = 0; i < 50; i++)
                arv_stream_push_buffer (stream, arv_buffer_new (payload, NULL));

            /* Start the video stream */
            arv_camera_start_acquisition (camera);

            /* Connect the new-buffer signal */
            g_signal_connect (stream, "new-buffer", G_CALLBACK (new_buffer_cb), &data);
            /* And enable emission of this signal (it's disabled by default for performance reason) */
            arv_stream_set_emit_signals (stream, TRUE);

            /* Connect the control-lost signal */
            g_signal_connect (arv_camera_get_device (camera), "control-lost",
                      G_CALLBACK (control_lost_cb), NULL);

            /* Install the callback for frame rate display */
            g_timeout_add_seconds (1, periodic_task_cb, &data);

            /* Create a new glib main loop */
            data.main_loop = g_main_loop_new (NULL, FALSE);

            old_sigint_handler = signal (SIGINT, set_cancel);

            /* Run the main loop */
            g_main_loop_run (data.main_loop);

            signal (SIGINT, old_sigint_handler);

            g_main_loop_unref (data.main_loop);

            /* Stop the video stream */
            arv_camera_stop_acquisition (camera);

            g_object_unref (stream);
        } else
            printf ("Can't create stream thread (check if the device is not already used)\n");

        g_object_unref (camera);
    } else
        printf ("No camera found\n");

    return 0;
}

Functions

arv_auto_from_string ()

ArvAuto
arv_auto_from_string (const char *string);

arv_auto_to_string ()

const char *
arv_auto_to_string (ArvAuto value);

arv_camera_new ()

ArvCamera *
arv_camera_new (const char *name);

Creates a new ArvCamera. If name is null, it will instantiate the first available camera.

Parameters

name

name of the camera.

[allow-none]

Returns

a new ArvCamera.

Since: 0.2.0

arv_camera_create_stream ()

ArvStream *
arv_camera_create_stream (ArvCamera *camera,
                          ArvStreamCallback callback,
                          void *user_data);

Creates a new ArvStream for video stream handling. See ArvStreamCallback for details regarding the callback function.

Parameters

camera	a ArvCamera
callback	a frame processing callback.	[scope call][allow-none]
user_data	user data for `callback` .	[closure][allow-none]

Returns

a new ArvStream.

[transfer full]

Since: 0.2.0

arv_camera_get_device ()

ArvDevice *
arv_camera_get_device (ArvCamera *camera);

Retrieves the ArvDevice object for more complete access to camera features.

Parameters

camera

camera	a ArvCamera
width	camera sensor width.	[out]
height	camera sensor height.	[out]

camera	a ArvCamera
x	x offset
y	y_offset
width	region width
height	region height

camera	a ArvCamera
x	x offset.	[out]
y	y_offset.	[out]
width	region width.	[out]
height	region height.	[out]

camera	a ArvCamera
min	minimum height.	[out]
max	maximum height.	[out]

camera	a ArvCamera
min	minimum width.	[out]
max	maximum width.	[out]

camera	a ArvCamera
dx	horizontal binning placeholder.	[out]
dy	vertical binning placeholder.	[out]

camera	a ArvCamera
n_pixel_formats	number of different pixel formats.	[out]

camera	a ArvCamera
min	minimal possible framerate.	[out]
max	maximum possible framerate.	[out]

camera	a ArvCamera
min	minimum exposure time.	[out]
max	maximum exposure time.	[out]

camera	a ArvCamera
chunk	chunk data name
is_enabled	wether to enable this chunk

camera	a ArvCamera
source	trigger source as string

camera	a ArvCamera
chunk_list	chunk data names, as a comma or space separated list

ARV_AUTO_OFF	manual setting
ARV_AUTO_ONCE	automatic setting done once, then returns to manual
ARV_AUTO_CONTINUOUS	setting is adjusted continuously

ARV_ACQUISITION_MODE_CONTINUOUS	continuous acquisition
ARV_ACQUISITION_MODE_SINGLE_FRAME	only one frame will be acquired

ArvCamera

Functions

Properties

Types and Values

Object Hierarchy

Description

Functions

arv_auto_from_string ()

arv_auto_to_string ()

arv_camera_new ()

Parameters

Returns

arv_camera_create_stream ()

Parameters

Returns

arv_camera_get_device ()

Parameters

Returns

arv_camera_get_vendor_name ()

Parameters

Returns

arv_camera_get_model_name ()

Parameters

Returns

arv_camera_get_device_id ()

Parameters

Returns

arv_camera_get_sensor_size ()

Parameters

arv_camera_set_region ()

Parameters

arv_camera_get_region ()

Parameters

arv_camera_get_height_bounds ()

Parameters

arv_camera_get_width_bounds ()

Parameters

arv_camera_set_binning ()

Parameters

arv_camera_get_binning ()

Parameters

arv_camera_set_pixel_format ()

Parameters

arv_camera_get_pixel_format ()

Parameters

Returns

arv_camera_get_pixel_format_as_string ()

Parameters

arv_camera_set_pixel_format_from_string ()

Parameters

arv_camera_get_available_pixel_formats ()

Parameters

Returns

arv_camera_get_available_pixel_formats_as_display_names ()

Parameters

Returns

arv_camera_get_available_pixel_formats_as_strings ()

Parameters

Returns

arv_camera_start_acquisition ()

Parameters

arv_camera_stop_acquisition ()

Parameters

arv_camera_abort_acquisition ()

Parameters

arv_camera_set_acquisition_mode ()

arv_camera_get_acquisition_mode ()

Parameters

Returns

arv_camera_is_frame_rate_available ()

Parameters

Returns

arv_camera_set_frame_rate ()

Parameters

arv_camera_get_frame_rate ()

Parameters

Returns

arv_camera_get_frame_rate_bounds ()

Parameters

arv_camera_set_trigger ()