funnel.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef struct funnel_ctx funnel_ctx;

typedef struct funnel_stream funnel_stream;

typedef struct funnel_buffer funnel_buffer;

struct funnel_fraction {
    uint32_t num;
    uint32_t den;
};

static const struct funnel_fraction FUNNEL_RATE_VARIABLE = {0, 1};

static inline struct funnel_fraction FUNNEL_FRACTION(uint32_t num,
                                                     uint32_t den) {
    return (struct funnel_fraction){num, den};
}

typedef void (*funnel_buffer_callback)(void *opaque,
                                       struct funnel_stream *stream,
                                       struct funnel_buffer *buf);

enum funnel_mode {
    FUNNEL_ASYNC,
    FUNNEL_DOUBLE_BUFFERED,
    FUNNEL_SINGLE_BUFFERED,
    FUNNEL_SYNCHRONOUS,
};

enum funnel_sync {
    FUNNEL_SYNC_IMPLICIT,

    FUNNEL_SYNC_EXPLICIT,

    FUNNEL_SYNC_BOTH,
};

enum funnel_stream_state {
    FUNNEL_STREAM_STATE_UNCONNECTED = 0,
    FUNNEL_STREAM_STATE_CONNECTING = 1,
    FUNNEL_STREAM_STATE_PAUSED = 2,
    FUNNEL_STREAM_STATE_STREAMING = 3
};

int funnel_init(struct funnel_ctx **pctx);

int funnel_new(struct funnel_ctx **pctx);

int funnel_set_app_name(struct funnel_ctx *ctx, const char *app_name);

int funnel_set_app_id(struct funnel_ctx *ctx, const char *app_id);

int funnel_set_app_version(struct funnel_ctx *ctx, const char *app_version);

int funnel_connect(struct funnel_ctx *ctx);

void funnel_shutdown(struct funnel_ctx *ctx);

int funnel_stream_create(struct funnel_ctx *ctx, const char *name,
                         struct funnel_stream **pstream);

void funnel_stream_set_buffer_callbacks(struct funnel_stream *stream,
                                        funnel_buffer_callback alloc,
                                        funnel_buffer_callback free,
                                        void *opaque);

int funnel_stream_set_instance(struct funnel_stream *stream,
                               const char *instance, bool user_friendly);

int funnel_stream_set_unique_id(struct funnel_stream *stream,
                                const char *stream_id);

int funnel_stream_set_description(struct funnel_stream *stream,
                                  const char *description);

int funnel_stream_set_media_name(struct funnel_stream *stream,
                                 const char *media_name);

int funnel_stream_set_size(struct funnel_stream *stream, uint32_t width,
                           uint32_t height);

int funnel_stream_set_mode(struct funnel_stream *stream, enum funnel_mode mode);

int funnel_stream_set_sync(struct funnel_stream *stream,
                           enum funnel_sync frontend, enum funnel_sync backend);

int funnel_stream_set_rate(struct funnel_stream *stream,
                           struct funnel_fraction def,
                           struct funnel_fraction min,
                           struct funnel_fraction max);

int funnel_stream_get_rate(struct funnel_stream *stream,
                           struct funnel_fraction *prate);

void funnel_stream_clear_formats(struct funnel_stream *stream);

int funnel_stream_configure(struct funnel_stream *stream);

int funnel_stream_start(struct funnel_stream *stream);

int funnel_stream_stop(struct funnel_stream *stream);

int funnel_stream_get_state(struct funnel_stream *stream,
                            enum funnel_stream_state *pstate);

void funnel_stream_destroy(struct funnel_stream *stream);

int funnel_stream_dequeue(struct funnel_stream *stream,
                          struct funnel_buffer **pbuf);

int funnel_stream_enqueue(struct funnel_stream *stream,
                          struct funnel_buffer *buf);

int funnel_stream_return(struct funnel_stream *stream,
                         struct funnel_buffer *buf);

int funnel_stream_skip_frame(struct funnel_stream *stream);

void funnel_buffer_get_size(struct funnel_buffer *buf, uint32_t *pwidth,
                            uint32_t *pheight);

void funnel_buffer_set_user_data(struct funnel_buffer *buf, void *opaque);

void *funnel_buffer_get_user_data(struct funnel_buffer *buf);

bool funnel_buffer_has_sync(struct funnel_buffer *buf);

bool funnel_buffer_is_efficient_for_rendering(struct funnel_buffer *buf);
 
#ifdef __cplusplus
}
#endif