fftools/sync_queue.h

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef FFTOOLS_SYNC_QUEUE_H
  20 #define FFTOOLS_SYNC_QUEUE_H
  21
  22 #include <stdint.h>
  23
  24 #include "libavcodec/packet.h"
  25
  26 #include "libavutil/frame.h"
  27
  28 enum SyncQueueType {
  29     SYNC_QUEUE_PACKETS,
  30     SYNC_QUEUE_FRAMES,
  31 };
  32
  33 typedef union SyncQueueFrame {
  34     AVFrame  *f;
  35     AVPacket *p;
  36 } SyncQueueFrame;
  37
  38 #define SQFRAME(frame) ((SyncQueueFrame){ .f = (frame) })
  39 #define SQPKT(pkt)     ((SyncQueueFrame){ .p = (pkt) })
  40
  41 /**
  42  * A sync queue provides timestamp synchronization between multiple streams.
  43  * Some of these streams are marked as "limiting", then the queue ensures no
  44  * stream gets ahead of any of the limiting streams.
  45  */
  46 typedef struct SyncQueue SyncQueue;
  47
  48 /**
  49  * Allocate a sync queue of the given type.
  50  *
  51  * @param buf_size_us maximum duration that will be buffered in microseconds
  52  */
  53 SyncQueue *sq_alloc(enum SyncQueueType type, int64_t buf_size_us, void *logctx);
  54 void       sq_free(SyncQueue **sq);
  55
  56 /**
  57  * Add a new stream to the sync queue.
  58  *
  59  * @param limiting whether the stream is limiting, i.e. no other stream can be
  60  *                 longer than this one
  61  * @return
  62  * - a non-negative stream index on success
  63  * - a negative error code on error
  64  */
  65 int sq_add_stream(SyncQueue *sq, int limiting);
  66
  67 /**
  68  * Limit the number of output frames for stream with index stream_idx
  69  * to max_frames.
  70  */
  71 void sq_limit_frames(SyncQueue *sq, unsigned int stream_idx,
  72                      uint64_t max_frames);
  73
  74 /**
  75  * Set a constant output audio frame size, in samples. Can only be used with
  76  * SYNC_QUEUE_FRAMES queues and audio streams.
  77  *
  78  * All output frames will have exactly frame_samples audio samples, except
  79  * possibly for the last one, which may have fewer.
  80  */
  81 void sq_frame_samples(SyncQueue *sq, unsigned int stream_idx,
  82                       int frame_samples);
  83
  84 /**
  85  * Submit a frame for the stream with index stream_idx.
  86  *
  87  * On success, the sync queue takes ownership of the frame and will reset the
  88  * contents of the supplied frame. On failure, the frame remains owned by the
  89  * caller.
  90  *
  91  * Sending a frame with NULL contents marks the stream as finished.
  92  *
  93  * @return
  94  * - 0 on success
  95  * - AVERROR_EOF when no more frames should be submitted for this stream
  96  * - another a negative error code on failure
  97  */
  98 int sq_send(SyncQueue *sq, unsigned int stream_idx, SyncQueueFrame frame);
  99
 100 /**
 101  * Read a frame from the queue.
 102  *
 103  * @param stream_idx index of the stream to read a frame for. May be -1, then
 104  *                   try to read a frame from any stream that is ready for
 105  *                   output.
 106  * @param frame output frame will be written here on success. The frame is owned
 107  *              by the caller.
 108  *
 109  * @return
 110  * - a non-negative index of the stream to which the returned frame belongs
 111  * - AVERROR(EAGAIN) when more frames need to be submitted to the queue
 112  * - AVERROR_EOF when no more frames will be available for this stream (for any
 113  *               stream if stream_idx is -1)
 114  * - another negative error code on failure
 115  */
 116 int sq_receive(SyncQueue *sq, int stream_idx, SyncQueueFrame frame);
 117
 118 #endif // FFTOOLS_SYNC_QUEUE_H