fplayer/pump_8h_source.html

#ifndef FPLAYER_PUMP_H

#define FPLAYER_PUMP_H


#include <stdint.h>


struct FC;


struct tf_header_t;


struct frame_pump_s;


int FP_init(struct FC* fc,

            const struct tf_header_t* seq,

            struct frame_pump_s** pump);


int FP_checkPreload(struct frame_pump_s* pump, uint32_t frame);


int FP_nextFrame(struct frame_pump_s* pump, uint8_t** fd);


int FP_framesRemaining(struct frame_pump_s* pump);


void FP_free(struct frame_pump_s* pump);


#endif//FPLAYER_PUMP_H

FP_nextFrame
int FP_nextFrame(struct frame_pump_s *pump, uint8_t **fd)
Copies the next frame of data from the pump to the provided frame data buffer. If the pump's internal...
Definition pump.c:175

FP_framesRemaining
int FP_framesRemaining(struct frame_pump_s *pump)
Returns the number of frames remaining in the pump's internal buffer.
Definition pump.c:213

FP_checkPreload
int FP_checkPreload(struct frame_pump_s *pump, uint32_t frame)
Checks if the pump's internal buffer is low, and if so, preloads the next frame set from the file con...
Definition pump.c:142

FP_free
void FP_free(struct frame_pump_s *pump)
Frees the resources associated with the provided frame pump.
Definition pump.c:218

FP_init
int FP_init(struct FC *fc, const struct tf_header_t *seq, struct frame_pump_s **pump)
Initializes a frame pump with the provided file controller. The pump will read frames from the file c...
Definition pump.c:32

FC
File controller that wraps a stdlib file pointer and provides additional functionality for reading fi...
Definition fc.c:10

frame_pump_s
Frame pump state controller for loading/tracking frame data.
Definition pump.c:19

frame_pump_s::frame
uint32_t frame
Target frame index.
Definition pump.c:27

frame_pump_s::seq
const struct tf_header_t * seq
Sequence file metadata header.
Definition pump.c:21

frame_pump_s::fc
struct FC * fc
File controller to read from.
Definition pump.c:20