git.sesse.net Git - ffmpeg/blob - libavfilter/filters.h

   1 /*
   2  * Filters implementation helper functions
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public License
   8  * as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with FFmpeg; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVFILTER_FILTERS_H
  22 #define AVFILTER_FILTERS_H
  23
  24 /**
  25  * Filters implementation helper functions
  26  */
  27
  28 #include "avfilter.h"
  29 #include "internal.h"
  30
  31 /**
  32  * Special return code when activate() did not do anything.
  33  */
  34 #define FFERROR_NOT_READY FFERRTAG('N','R','D','Y')
  35
  36 /**
  37  * Mark a filter ready and schedule it for activation.
  38  *
  39  * This is automatically done when something happens to the filter (queued
  40  * frame, status change, request on output).
  41  * Filters implementing the activate callback can call it directly to
  42  * perform one more round of processing later.
  43  * It is also useful for filters reacting to external or asynchronous
  44  * events.
  45  */
  46 void ff_filter_set_ready(AVFilterContext *filter, unsigned priority);
  47
  48 /**
  49  * Process the commands queued in the link up to the time of the frame.
  50  * Commands will trigger the process_command() callback.
  51  * @return  >= 0 or AVERROR code.
  52  */
  53 int ff_inlink_process_commands(AVFilterLink *link, const AVFrame *frame);
  54
  55 /**
  56  * Evaluate the timeline expression of the link for the time and properties
  57  * of the frame.
  58  * @return  >0 if enabled, 0 if disabled
  59  * @note  It does not update link->dst->is_disabled.
  60  */
  61 int ff_inlink_evaluate_timeline_at_frame(AVFilterLink *link, const AVFrame *frame);
  62
  63 /**
  64  * Get the number of frames available on the link.
  65  * @return the number of frames available in the link fifo.
  66  */
  67 size_t ff_inlink_queued_frames(AVFilterLink *link);
  68
  69 /**
  70  * Test if a frame is available on the link.
  71  * @return  >0 if a frame is available
  72  */
  73 int ff_inlink_check_available_frame(AVFilterLink *link);
  74
  75 /**
  76  * Test if enough samples are available on the link.
  77  * @return  >0 if enough samples are available
  78  * @note  on EOF and error, min becomes 1
  79  */
  80 int ff_inlink_check_available_samples(AVFilterLink *link, unsigned min);
  81
  82 /**
  83  * Take a frame from the link's FIFO and update the link's stats.
  84  *
  85  * If ff_inlink_check_available_frame() was previously called, the
  86  * preferred way of expressing it is "av_assert1(ret);" immediately after
  87  * ff_inlink_consume_frame(). Negative error codes must still be checked.
  88  *
  89  * @note  May trigger process_command() and/or update is_disabled.
  90  * @return  >0 if a frame is available,
  91  *          0 and set rframe to NULL if no frame available,
  92  *          or AVERROR code
  93  */
  94 int ff_inlink_consume_frame(AVFilterLink *link, AVFrame **rframe);
  95
  96 /**
  97  * Take samples from the link's FIFO and update the link's stats.
  98  *
  99  * If ff_inlink_check_available_samples() was previously called, the
 100  * preferred way of expressing it is "av_assert1(ret);" immediately after
 101  * ff_inlink_consume_samples(). Negative error codes must still be checked.
 102  *
 103  * @note  May trigger process_command() and/or update is_disabled.
 104  * @return  >0 if a frame is available,
 105  *          0 and set rframe to NULL if no frame available,
 106  *          or AVERROR code
 107  */
 108 int ff_inlink_consume_samples(AVFilterLink *link, unsigned min, unsigned max,
 109                             AVFrame **rframe);
 110
 111 /**
 112  * Access a frame in the link fifo without consuming it.
 113  * The first frame is numbered 0; the designated frame must exist.
 114  * @return the frame at idx position in the link fifo.
 115  */
 116 AVFrame *ff_inlink_peek_frame(AVFilterLink *link, size_t idx);
 117
 118 /**
 119  * Make sure a frame is writable.
 120  * This is similar to av_frame_make_writable() except it uses the link's
 121  * buffer allocation callback, and therefore allows direct rendering.
 122  */
 123 int ff_inlink_make_frame_writable(AVFilterLink *link, AVFrame **rframe);
 124
 125 /**
 126  * Test and acknowledge the change of status on the link.
 127  *
 128  * Status means EOF or an error condition; a change from the normal (0)
 129  * status to a non-zero status can be queued in a filter's input link, it
 130  * becomes relevant after the frames queued in the link's FIFO are
 131  * processed. This function tests if frames are still queued and if a queued
 132  * status change has not yet been processed. In that case it performs basic
 133  * treatment (updating the link's timestamp) and returns a positive value to
 134  * let the filter do its own treatments (flushing...).
 135  *
 136  * Filters implementing the activate callback should call this function when
 137  * they think it might succeed (usually after checking unsuccessfully for a
 138  * queued frame).
 139  * Filters implementing the filter_frame and request_frame callbacks do not
 140  * need to call that since the same treatment happens in ff_filter_frame().
 141  *
 142  * @param[out] rstatus  new or current status
 143  * @param[out] rpts     current timestamp of the link in link time base
 144  * @return  >0 if status changed, <0 if status already acked, 0 otherwise
 145  */
 146 int ff_inlink_acknowledge_status(AVFilterLink *link, int *rstatus, int64_t *rpts);
 147
 148 /**
 149  * Mark that a frame is wanted on the link.
 150  * Unlike ff_filter_frame(), it must not be called when the link has a
 151  * non-zero status, and thus does not acknowledge it.
 152  * Also it cannot fail.
 153  */
 154 void ff_inlink_request_frame(AVFilterLink *link);
 155
 156 /**
 157  * Set the status on an input link.
 158  * Also discard all frames in the link's FIFO.
 159  */
 160 void ff_inlink_set_status(AVFilterLink *link, int status);
 161
 162 /**
 163  * Test if a frame is wanted on an output link.
 164  */
 165 static inline int ff_outlink_frame_wanted(AVFilterLink *link)
 166 {
 167     return link->frame_wanted_out;
 168 }
 169
 170 /**
 171  * Get the status on an output link.
 172  */
 173 int ff_outlink_get_status(AVFilterLink *link);
 174
 175 /**
 176  * Set the status field of a link from the source filter.
 177  * The pts should reflect the timestamp of the status change,
 178  * in link time base and relative to the frames timeline.
 179  * In particular, for AVERROR_EOF, it should reflect the
 180  * end time of the last frame.
 181  */
 182 static inline void ff_outlink_set_status(AVFilterLink *link, int status, int64_t pts)
 183 {
 184     ff_avfilter_link_set_in_status(link, status, pts);
 185 }
 186
 187 /**
 188  * Forward the status on an output link to an input link.
 189  * If the status is set, it will discard all queued frames and this macro
 190  * will return immediately.
 191  */
 192 #define FF_FILTER_FORWARD_STATUS_BACK(outlink, inlink) do { \
 193     int ret = ff_outlink_get_status(outlink); \
 194     if (ret) { \
 195         ff_inlink_set_status(inlink, ret); \
 196         return 0; \
 197     } \
 198 } while (0)
 199
 200 /**
 201  * Forward the status on an output link to all input links.
 202  * If the status is set, it will discard all queued frames and this macro
 203  * will return immediately.
 204  */
 205 #define FF_FILTER_FORWARD_STATUS_BACK_ALL(outlink, filter) do { \
 206     int ret = ff_outlink_get_status(outlink); \
 207     if (ret) { \
 208         unsigned i; \
 209         for (i = 0; i < filter->nb_inputs; i++) \
 210             ff_inlink_set_status(filter->inputs[i], ret); \
 211         return 0; \
 212     } \
 213 } while (0)
 214
 215 /**
 216  * Acknowledge the status on an input link and forward it to an output link.
 217  * If the status is set, this macro will return immediately.
 218  */
 219 #define FF_FILTER_FORWARD_STATUS(inlink, outlink) do { \
 220     int status; \
 221     int64_t pts; \
 222     if (ff_inlink_acknowledge_status(inlink, &status, &pts)) { \
 223         ff_outlink_set_status(outlink, status, pts); \
 224         return 0; \
 225     } \
 226 } while (0)
 227
 228 /**
 229  * Acknowledge the status on an input link and forward it to an output link.
 230  * If the status is set, this macro will return immediately.
 231  */
 232 #define FF_FILTER_FORWARD_STATUS_ALL(inlink, filter) do { \
 233     int status; \
 234     int64_t pts; \
 235     if (ff_inlink_acknowledge_status(inlink, &status, &pts)) { \
 236         unsigned i; \
 237         for (i = 0; i < filter->nb_outputs; i++) \
 238             ff_outlink_set_status(filter->outputs[i], status, pts); \
 239         return 0; \
 240     } \
 241 } while (0)
 242
 243 /**
 244  * Forward the frame_wanted_out flag from an output link to an input link.
 245  * If the flag is set, this macro will return immediately.
 246  */
 247 #define FF_FILTER_FORWARD_WANTED(outlink, inlink) do { \
 248     if (ff_outlink_frame_wanted(outlink)) { \
 249         ff_inlink_request_frame(inlink); \
 250         return 0; \
 251     } \
 252 } while (0)
 253
 254 #endif /* AVFILTER_FILTERS_H */