git.sesse.net Git - ffmpeg/blob - libavfilter/internal.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 AVFILTER_INTERNAL_H
  20 #define AVFILTER_INTERNAL_H
  21
  22 /**
  23  * @file
  24  * internal API functions
  25  */
  26
  27 #include "avfilter.h"
  28 #include "avfiltergraph.h"
  29 #include "formats.h"
  30
  31 #define POOL_SIZE 32
  32 typedef struct AVFilterPool {
  33     AVFilterBufferRef *pic[POOL_SIZE];
  34     int count;
  35     int refcount;
  36     int draining;
  37 } AVFilterPool;
  38
  39 typedef struct AVFilterCommand {
  40     double time;                ///< time expressed in seconds
  41     char *command;              ///< command
  42     char *arg;                  ///< optional argument for the command
  43     int flags;
  44     struct AVFilterCommand *next;
  45 } AVFilterCommand;
  46
  47 /**
  48  * Update the position of a link in the age heap.
  49  */
  50 void ff_avfilter_graph_update_heap(AVFilterGraph *graph, AVFilterLink *link);
  51
  52 /** default handler for freeing audio/video buffer when there are no references left */
  53 void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);
  54
  55 /** Tell is a format is contained in the provided list terminated by -1. */
  56 int ff_fmt_is_in(int fmt, const int *fmts);
  57
  58 /**
  59  * Return a copy of a list of integers terminated by -1, or NULL in
  60  * case of copy failure.
  61  */
  62 int *ff_copy_int_list(const int * const list);
  63
  64 /**
  65  * Return a copy of a list of 64-bit integers, or NULL in case of
  66  * copy failure.
  67  */
  68 int64_t *ff_copy_int64_list(const int64_t * const list);
  69
  70 /* Functions to parse audio format arguments */
  71
  72 /**
  73  * Parse a pixel format.
  74  *
  75  * @param ret pixel format pointer to where the value should be written
  76  * @param arg string to parse
  77  * @param log_ctx log context
  78  * @return 0 in case of success, a negative AVERROR code on error
  79  */
  80 int ff_parse_pixel_format(enum PixelFormat *ret, const char *arg, void *log_ctx);
  81
  82 /**
  83  * Parse a sample rate.
  84  *
  85  * @param ret unsigned integer pointer to where the value should be written
  86  * @param arg string to parse
  87  * @param log_ctx log context
  88  * @return 0 in case of success, a negative AVERROR code on error
  89  */
  90 int ff_parse_sample_rate(int *ret, const char *arg, void *log_ctx);
  91
  92 /**
  93  * Parse a time base.
  94  *
  95  * @param ret unsigned AVRational pointer to where the value should be written
  96  * @param arg string to parse
  97  * @param log_ctx log context
  98  * @return 0 in case of success, a negative AVERROR code on error
  99  */
 100 int ff_parse_time_base(AVRational *ret, const char *arg, void *log_ctx);
 101
 102 /**
 103  * Parse a sample format name or a corresponding integer representation.
 104  *
 105  * @param ret integer pointer to where the value should be written
 106  * @param arg string to parse
 107  * @param log_ctx log context
 108  * @return 0 in case of success, a negative AVERROR code on error
 109  */
 110 int ff_parse_sample_format(int *ret, const char *arg, void *log_ctx);
 111
 112 /**
 113  * Parse a channel layout or a corresponding integer representation.
 114  *
 115  * @param ret 64bit integer pointer to where the value should be written.
 116  * @param arg string to parse
 117  * @param log_ctx log context
 118  * @return 0 in case of success, a negative AVERROR code on error
 119  */
 120 int ff_parse_channel_layout(int64_t *ret, const char *arg, void *log_ctx);
 121
 122 /**
 123  * Pass video frame along and keep an internal reference for later use.
 124  */
 125 static inline void ff_null_start_frame_keep_ref(AVFilterLink *inlink,
 126                                                 AVFilterBufferRef *picref)
 127 {
 128     avfilter_start_frame(inlink->dst->outputs[0], avfilter_ref_buffer(picref, ~0));
 129 }
 130
 131 void ff_update_link_current_pts(AVFilterLink *link, int64_t pts);
 132
 133 void ff_free_pool(AVFilterPool *pool);
 134
 135 void ff_command_queue_pop(AVFilterContext *filter);
 136
 137 /* misc debug functions */
 138
 139 #define FF_DPRINTF_START(ctx, func) av_dlog(NULL, "%-16s: ", #func)
 140
 141 char *ff_get_ref_perms_string(char *buf, size_t buf_size, int perms);
 142
 143 void ff_dlog_ref(void *ctx, AVFilterBufferRef *ref, int end);
 144
 145 void ff_dlog_link(void *ctx, AVFilterLink *link, int end);
 146
 147 /**
 148  * Insert a new pad.
 149  *
 150  * @param idx Insertion point. Pad is inserted at the end if this point
 151  *            is beyond the end of the list of pads.
 152  * @param count Pointer to the number of pads in the list
 153  * @param padidx_off Offset within an AVFilterLink structure to the element
 154  *                   to increment when inserting a new pad causes link
 155  *                   numbering to change
 156  * @param pads Pointer to the pointer to the beginning of the list of pads
 157  * @param links Pointer to the pointer to the beginning of the list of links
 158  * @param newpad The new pad to add. A copy is made when adding.
 159  */
 160 void ff_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
 161                    AVFilterPad **pads, AVFilterLink ***links,
 162                    AVFilterPad *newpad);
 163
 164 /** Insert a new input pad for the filter. */
 165 static inline void ff_insert_inpad(AVFilterContext *f, unsigned index,
 166                                    AVFilterPad *p)
 167 {
 168     ff_insert_pad(index, &f->input_count, offsetof(AVFilterLink, dstpad),
 169                   &f->input_pads, &f->inputs, p);
 170 }
 171
 172 /** Insert a new output pad for the filter. */
 173 static inline void ff_insert_outpad(AVFilterContext *f, unsigned index,
 174                                     AVFilterPad *p)
 175 {
 176     ff_insert_pad(index, &f->output_count, offsetof(AVFilterLink, srcpad),
 177                   &f->output_pads, &f->outputs, p);
 178 }
 179
 180 /**
 181  * Poll a frame from the filter chain.
 182  *
 183  * @param  link the input link
 184  * @return the number of immediately available frames, a negative
 185  * number in case of error
 186  */
 187 int ff_poll_frame(AVFilterLink *link);
 188
 189 /**
 190  * Request an input frame from the filter at the other end of the link.
 191  *
 192  * @param link the input link
 193  * @return     zero on success
 194  */
 195 int ff_request_frame(AVFilterLink *link);
 196
 197 #endif /* AVFILTER_INTERNAL_H */