libvdo
vdo-buffer.h
Go to the documentation of this file.
1 
10 #ifndef __VDO_BUFFER_H__
11 #define __VDO_BUFFER_H__
12 
13 #include "vdo-frame.h"
14 
15 G_BEGIN_DECLS
16 
17 typedef VdoFrame VdoBuffer;
18 G_DEFINE_AUTOPTR_CLEANUP_FUNC(VdoBuffer, g_object_unref)
19 
20 typedef void(*VdoBufferFinalizer)(VdoBuffer *self);
21 
35 VdoBuffer *vdo_buffer_new(gint fd, gsize capacity, guint64 offset, gpointer opaque);
36 
58 VdoBuffer *vdo_buffer_new_full(gint fd, gsize capacity, guint64 offset, gpointer opaque,
59  VdoMap *settings);
60 
70 guint32 vdo_buffer_get_id(VdoBuffer *self);
71 
79 gint vdo_buffer_get_fd(VdoBuffer *self);
80 
88 gint64 vdo_buffer_get_offset(VdoBuffer *self);
89 
99 gsize vdo_buffer_get_capacity(VdoBuffer *self);
100 
110 gboolean vdo_buffer_is_complete(VdoBuffer *self);
111 
128 gboolean vdo_buffer_is_contiguous(VdoBuffer *self);
129 
163 gpointer vdo_buffer_get_opaque(VdoBuffer *self);
164 
182 gpointer vdo_buffer_get_data(VdoBuffer *self);
183 
212 VdoFrame *vdo_buffer_get_frame(VdoBuffer *self);
213 
214 G_END_DECLS
215 
216 #endif
A video frame.
A class representing a dictionary mapping keys to values.
gint64 vdo_buffer_get_offset(VdoBuffer *self)
Return file offset to the VdoBuffer.
VdoBuffer * vdo_buffer_new_full(gint fd, gsize capacity, guint64 offset, gpointer opaque, VdoMap *settings)
Create a buffer with custom buffer properties.
gpointer vdo_buffer_get_opaque(VdoBuffer *self)
Get a pointer to an opaque, containing user provided custom information.
gpointer vdo_buffer_get_data(VdoBuffer *self)
Return a pointer to the underlying buffer.
VdoFrame * vdo_buffer_get_frame(VdoBuffer *self)
Return a pointer to the underlying frame.
guint32 vdo_buffer_get_id(VdoBuffer *self)
Return an id representing the VdoBuffer.
gsize vdo_buffer_get_capacity(VdoBuffer *self)
Returns the entire buffer capacity of the VdoBuffer.
gboolean vdo_buffer_is_complete(VdoBuffer *self)
Indicates whether the TemporalUnit is complete after this frame.
gboolean vdo_buffer_is_contiguous(VdoBuffer *self)
Indicates whether the buffer is contiguous or sparse.
VdoBuffer * vdo_buffer_new(gint fd, gsize capacity, guint64 offset, gpointer opaque)
Create a buffer which is owned by an external framework.
gint vdo_buffer_get_fd(VdoBuffer *self)
Return a file descriptor representing the VdoBuffer.
A video frame.