![]() |
![]() |
![]() |
Aravis Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
void (*ArvFrameCallback) (ArvBuffer *buffer
); enum ArvBufferStatus; ArvBuffer; typedef ArvPixelFormat; ArvBuffer * arv_buffer_new (size_t size
,void *preallocated
); ArvBuffer * arv_buffer_new_full (size_t size
,void *preallocated
,void *user_data
,GDestroyNotify user_data_destroy_func
); ArvBuffer * arv_buffer_new_allocate (size_t size
); #define ARV_PIXEL_FORMAT_BIT_PER_PIXEL (pixel_format) #define ARV_PIXEL_FORMAT_BAYER_BG_10 #define ARV_PIXEL_FORMAT_BAYER_BG_12 #define ARV_PIXEL_FORMAT_BAYER_GR_12_PACKED #define ARV_PIXEL_FORMAT_BAYER_GB_12_PACKED #define ARV_PIXEL_FORMAT_BAYER_RG_12_PACKED #define ARV_PIXEL_FORMAT_BAYER_BG_12_PACKED #define ARV_PIXEL_FORMAT_BAYER_BG_8 #define ARV_PIXEL_FORMAT_BAYER_GB_10 #define ARV_PIXEL_FORMAT_BAYER_GB_12 #define ARV_PIXEL_FORMAT_BAYER_GB_8 #define ARV_PIXEL_FORMAT_BAYER_GR_10 #define ARV_PIXEL_FORMAT_BAYER_GR_12 #define ARV_PIXEL_FORMAT_BAYER_GR_8 #define ARV_PIXEL_FORMAT_BAYER_RG_10 #define ARV_PIXEL_FORMAT_BAYER_RG_12 #define ARV_PIXEL_FORMAT_BAYER_RG_8 #define ARV_PIXEL_FORMAT_BAYER_BG_16 #define ARV_PIXEL_FORMAT_BAYER_GB_16 #define ARV_PIXEL_FORMAT_BAYER_GR_16 #define ARV_PIXEL_FORMAT_BAYER_RG_16 #define ARV_PIXEL_FORMAT_BGRA_8_PACKED #define ARV_PIXEL_FORMAT_BGR_10_PACKED #define ARV_PIXEL_FORMAT_BGR_12_PACKED #define ARV_PIXEL_FORMAT_BGR_8_PACKED #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_BG_12_PACKED #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_BG_16 #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_GB_12_PACKED #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_GB_16 #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_GR_12_PACKED #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_GR_16 #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_RG_12_PACKED #define ARV_PIXEL_FORMAT_CUSTOM_BAYER_RG_16 #define ARV_PIXEL_FORMAT_CUSTOM_YUV_422_YUYV_PACKED #define ARV_PIXEL_FORMAT_MONO_10 #define ARV_PIXEL_FORMAT_MONO_10_PACKED #define ARV_PIXEL_FORMAT_MONO_12 #define ARV_PIXEL_FORMAT_MONO_12_PACKED #define ARV_PIXEL_FORMAT_MONO_14 #define ARV_PIXEL_FORMAT_MONO_16 #define ARV_PIXEL_FORMAT_MONO_8 #define ARV_PIXEL_FORMAT_MONO_8_SIGNED #define ARV_PIXEL_FORMAT_RGBA_8_PACKED #define ARV_PIXEL_FORMAT_RGB_10_PACKED #define ARV_PIXEL_FORMAT_RGB_10_PLANAR #define ARV_PIXEL_FORMAT_RGB_12_PACKED #define ARV_PIXEL_FORMAT_RGB_12_PLANAR #define ARV_PIXEL_FORMAT_RGB_16_PLANAR #define ARV_PIXEL_FORMAT_RGB_8_PACKED #define ARV_PIXEL_FORMAT_RGB_8_PLANAR #define ARV_PIXEL_FORMAT_YUV_411_PACKED #define ARV_PIXEL_FORMAT_YUV_422_PACKED #define ARV_PIXEL_FORMAT_YUV_422_YUYV_PACKED #define ARV_PIXEL_FORMAT_YUV_444_PACKED
ArvBuffer provides a class for the instantiation of buffers used for the storage of the separate images of the video stream. The actual data space may either be allocated by ArvBuffer during an object instatiation, of preallocated. ArvBuffer also allows the transmission of image metadata, such as offsets and size of the transmitted region of interrest, pixel format and time stamp.
typedef enum { ARV_BUFFER_STATUS_SUCCESS, ARV_BUFFER_STATUS_CLEARED, ARV_BUFFER_STATUS_TIMEOUT, ARV_BUFFER_STATUS_MISSING_PACKETS, ARV_BUFFER_STATUS_WRONG_PACKET_ID, ARV_BUFFER_STATUS_SIZE_MISMATCH, ARV_BUFFER_STATUS_FILLING, ARV_BUFFER_STATUS_ABORTED } ArvBufferStatus;
the buffer contains a valid image | |
the buffer is cleared | |
timeout was reached before all packets are received | |
stream has missing packets | |
stream has packet with wrong id | |
the received image didn't fit in the buffer data space | |
the image is currently being filled | |
the filling was aborted before completion |
ArvBuffer * arv_buffer_new (size_t size
,void *preallocated
);
Creates a new buffer for the storage of the video stream images. The data space can be either preallocated, and the caller is responsible for it's deallocation, or allocated by this function. If it is the case, data memory will be freed when the buffer is destroyed.
|
payload size |
|
preallocated memory buffer. [transfer none] |
Returns : |
a new ArvBuffer object |
Since 0.2.0
ArvBuffer * arv_buffer_new_full (size_t size
,void *preallocated
,void *user_data
,GDestroyNotify user_data_destroy_func
);
Creates a new buffer for the storage of the video stream images. The data space can be either preallocated, and the caller is responsible for it's deallocation, or allocated by this function. If it is the case, data memory will be freed when the buffer is destroyed.
If user_data_destroy_func
is non NULL, it will be called in order to destroy
user_data when the buffer is destroyed.
|
payload size |
|
preallocated memory buffer. [transfer none] |
|
a pointer to user data associated to this buffer. [transfer none] |
|
an optional user data destroy callback |
Returns : |
a new ArvBuffer object |
Since 0.2.0
ArvBuffer * arv_buffer_new_allocate (size_t size
);
Creates a new buffer for the storage of the video stream images. The data space is allocated by this function, and will be freed when the buffer is destroyed.
|
payload size |
Returns : |
a new ArvBuffer object |
Since 0.2.3
#define ARV_PIXEL_FORMAT_BIT_PER_PIXEL(pixel_format) (((pixel_format) >> 16) & 0xff)
#define ARV_PIXEL_FORMAT_CUSTOM_BAYER_BG_12_PACKED 0x810c0004
#define ARV_PIXEL_FORMAT_CUSTOM_BAYER_GB_12_PACKED 0x810c0003
#define ARV_PIXEL_FORMAT_CUSTOM_BAYER_GR_12_PACKED 0x810c0001
#define ARV_PIXEL_FORMAT_CUSTOM_BAYER_RG_12_PACKED 0x810c0002
#define ARV_PIXEL_FORMAT_CUSTOM_YUV_422_YUYV_PACKED 0x82100005
#define ARV_PIXEL_FORMAT_MONO_14 0x01100025 /* https://bugzilla.gnome.org/show_bug.cgi?id=655131 */