FFmpeg
Data Structures | Macros | Enumerations | Functions
sync_queue.h File Reference
#include <stdint.h>
#include "libavcodec/packet.h"
#include "libavutil/frame.h"

Go to the source code of this file.

Data Structures

union  SyncQueueFrame
 

Macros

#define SQFRAME(frame)   ((SyncQueueFrame){ .f = (frame) })
 
#define SQPKT(pkt)   ((SyncQueueFrame){ .p = (pkt) })
 

Enumerations

enum  SyncQueueType { SYNC_QUEUE_PACKETS, SYNC_QUEUE_FRAMES }
 

Functions

SyncQueuesq_alloc (enum SyncQueueType type, int64_t buf_size_us)
 Allocate a sync queue of the given type. More...
 
void sq_free (SyncQueue **sq)
 
int sq_add_stream (SyncQueue *sq, int limiting)
 Add a new stream to the sync queue. More...
 
void sq_set_tb (SyncQueue *sq, unsigned int stream_idx, AVRational tb)
 Set the timebase for the stream with index stream_idx. More...
 
void sq_limit_frames (SyncQueue *sq, unsigned int stream_idx, uint64_t max_frames)
 Limit the number of output frames for stream with index stream_idx to max_frames. More...
 
int sq_send (SyncQueue *sq, unsigned int stream_idx, SyncQueueFrame frame)
 Submit a frame for the stream with index stream_idx. More...
 
int sq_receive (SyncQueue *sq, int stream_idx, SyncQueueFrame frame)
 Read a frame from the queue. More...
 

Macro Definition Documentation

◆ SQFRAME

#define SQFRAME (   frame)    ((SyncQueueFrame){ .f = (frame) })

Definition at line 38 of file sync_queue.h.

◆ SQPKT

#define SQPKT (   pkt)    ((SyncQueueFrame){ .p = (pkt) })

Definition at line 39 of file sync_queue.h.

Enumeration Type Documentation

◆ SyncQueueType

Enumerator
SYNC_QUEUE_PACKETS 
SYNC_QUEUE_FRAMES 

Definition at line 28 of file sync_queue.h.

Function Documentation

◆ sq_alloc()

SyncQueue* sq_alloc ( enum SyncQueueType  type,
int64_t  buf_size_us 
)

Allocate a sync queue of the given type.

Parameters
buf_size_usmaximum duration that will be buffered in microseconds

Definition at line 405 of file sync_queue.c.

Referenced by setup_sync_queues().

◆ sq_free()

void sq_free ( SyncQueue **  sq)

Definition at line 428 of file sync_queue.c.

Referenced by of_close().

◆ sq_add_stream()

int sq_add_stream ( SyncQueue sq,
int  limiting 
)

Add a new stream to the sync queue.

Parameters
limitingwhether the stream is limiting, i.e. no other stream can be longer than this one
Returns
  • a non-negative stream index on success
  • a negative error code on error

Definition at line 351 of file sync_queue.c.

Referenced by setup_sync_queues().

◆ sq_set_tb()

void sq_set_tb ( SyncQueue sq,
unsigned int  stream_idx,
AVRational  tb 
)

Set the timebase for the stream with index stream_idx.

Should be called before sending any frames for this stream.

Definition at line 378 of file sync_queue.c.

Referenced by init_output_stream(), and init_output_stream_encode().

◆ sq_limit_frames()

void sq_limit_frames ( SyncQueue sq,
unsigned int  stream_idx,
uint64_t  max_frames 
)

Limit the number of output frames for stream with index stream_idx to max_frames.

Definition at line 393 of file sync_queue.c.

Referenced by setup_sync_queues().

◆ sq_send()

int sq_send ( SyncQueue sq,
unsigned int  stream_idx,
SyncQueueFrame  frame 
)

Submit a frame for the stream with index stream_idx.

On success, the sync queue takes ownership of the frame and will reset the contents of the supplied frame. On failure, the frame remains owned by the caller.

Sending a frame with NULL contents marks the stream as finished.

Returns
  • 0 on success
  • AVERROR_EOF when no more frames should be submitted for this stream
  • another a negative error code on failure

Definition at line 234 of file sync_queue.c.

Referenced by close_output_stream(), flush_encoders(), submit_encode_frame(), and sync_queue_process().

◆ sq_receive()

int sq_receive ( SyncQueue sq,
int  stream_idx,
SyncQueueFrame  frame 
)

Read a frame from the queue.

Parameters
stream_idxindex of the stream to read a frame for. May be -1, then try to read a frame from any stream that is ready for output.
frameoutput frame will be written here on success. The frame is owned by the caller.
Returns
  • a non-negative index of the stream to which the returned frame belongs
  • AVERROR(EAGAIN) when more frames need to be submitted to the queue
  • AVERROR_EOF when no more frames will be available for this stream (for any stream if stream_idx is -1)
  • another negative error code on failure

Definition at line 339 of file sync_queue.c.

Referenced by submit_encode_frame(), and sync_queue_process().