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