vdo-stream.h

Go to the documentation of this file.

#ifndef __VDO_STREAM_H__
#define __VDO_STREAM_H__

#include "vdo-types.h"
#include "vdo-frame.h"
#include "vdo-buffer.h"
#include "vdo-map.h"

#include <glib-object.h>

G_BEGIN_DECLS

#define VDO_GETFRAME_NONBLOCK (0)

#define VDO_TYPE_STREAM (vdo_stream_get_type())
G_DECLARE_FINAL_TYPE(VdoStream, vdo_stream, VDO, STREAM, GObject)


VdoStream *vdo_stream_new(VdoMap *settings, VdoBufferFinalizer fin, GError **error);

VdoStream *vdo_stream_get(guint id, GError **error);

GList *vdo_stream_get_all(GError **error);

guint vdo_stream_get_id(VdoStream *self);

gint vdo_stream_get_fd(VdoStream *self, GError **error);

gint vdo_stream_get_event_fd(VdoStream *self, GError **error);

VdoMap *vdo_stream_get_info(VdoStream *self, GError **error);

VdoMap *vdo_stream_get_settings(VdoStream *self, GError **error);

gboolean vdo_stream_set_settings(VdoStream *self, VdoMap *settings,
                                 GError **error);

gboolean vdo_stream_set_framerate(VdoStream *self, gdouble framerate,
                                  GError **error);

gboolean vdo_stream_attach(VdoStream *self, VdoMap *intent, GError **error);

gboolean vdo_stream_start(VdoStream *self, GError **error);

void vdo_stream_stop(VdoStream *self);

gboolean vdo_stream_force_key_frame(VdoStream *self, GError **error);

/*
** The vdo-stream allocation API:s have the following limitations:
** 1. Buffer alloc/unref are fully synchronous and will BLOCK.
** 2. Buffer alloc/unref does not support encoded streams (vdo_format_is_encoded).
** Use the stream global setting "socket.timeout_ms" to control maximum blocking time.
*/

VdoBuffer *vdo_stream_buffer_alloc(VdoStream *self, gpointer opaque, GError **error);

gboolean vdo_stream_buffer_unref(VdoStream *self, VdoBuffer **buffer, GError **error);

gboolean vdo_stream_buffer_enqueue(VdoStream *self, VdoBuffer *buffer, GError **error);

VdoBuffer *vdo_stream_get_buffer(VdoStream *self, GError **error);

VdoStream *vdo_stream_to_fd(VdoMap *settings, int data_fd, int meta_fd, GError **error);

VdoBuffer *vdo_stream_snapshot(VdoMap *settings, GError **error);

gboolean vdo_stream_encode(VdoStream *self, VdoBuffer **in_buf, VdoMap *settings, GError **error);

VdoMap *vdo_stream_get_event(VdoStream *self, GError **error);

// Deprecated (See vdo_stream_buffer_enqueue) //
gboolean vdo_stream_enqueue_buffer(VdoStream *self,
                                   gint fd,
                                   guint64 offset,
                                   gsize max_size,
                                   gpointer opaque,
                                   GError **error);

G_END_DECLS

#endif