aboutsummaryrefslogtreecommitdiffstats
path: root/libavfilter/internal.h
diff options
context:
space:
mode:
authorAnton Khirnov <anton@khirnov.net>2012-06-12 20:12:42 +0200
committerAnton Khirnov <anton@khirnov.net>2012-06-13 11:11:33 +0200
commit9d0bfc5052fa73ac8df89ec9992d77b07840fdf0 (patch)
tree95435f6e28872a5e859dd3e0f468dacf7815ef60 /libavfilter/internal.h
parent84b9fbe05578c8b4058e72bb0b203665a446a95a (diff)
downloadffmpeg-9d0bfc5052fa73ac8df89ec9992d77b07840fdf0.tar.gz
lavfi: make AVFilterPad opaque after two major bumps.
It will allow adding new fields to it without ABI breaks.
Diffstat (limited to 'libavfilter/internal.h')
-rw-r--r--libavfilter/internal.h126
1 files changed, 126 insertions, 0 deletions
diff --git a/libavfilter/internal.h b/libavfilter/internal.h
index 4b53831063..f6dc74b082 100644
--- a/libavfilter/internal.h
+++ b/libavfilter/internal.h
@@ -26,6 +26,132 @@
#include "avfilter.h"
+#if !FF_API_AVFILTERPAD_PUBLIC
+/**
+ * A filter pad used for either input or output.
+ */
+struct AVFilterPad {
+ /**
+ * Pad name. The name is unique among inputs and among outputs, but an
+ * input may have the same name as an output. This may be NULL if this
+ * pad has no need to ever be referenced by name.
+ */
+ const char *name;
+
+ /**
+ * AVFilterPad type.
+ */
+ enum AVMediaType type;
+
+ /**
+ * Minimum required permissions on incoming buffers. Any buffer with
+ * insufficient permissions will be automatically copied by the filter
+ * system to a new buffer which provides the needed access permissions.
+ *
+ * Input pads only.
+ */
+ int min_perms;
+
+ /**
+ * Permissions which are not accepted on incoming buffers. Any buffer
+ * which has any of these permissions set will be automatically copied
+ * by the filter system to a new buffer which does not have those
+ * permissions. This can be used to easily disallow buffers with
+ * AV_PERM_REUSE.
+ *
+ * Input pads only.
+ */
+ int rej_perms;
+
+ /**
+ * Callback called before passing the first slice of a new frame. If
+ * NULL, the filter layer will default to storing a reference to the
+ * picture inside the link structure.
+ *
+ * Input video pads only.
+ */
+ void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
+
+ /**
+ * Callback function to get a video buffer. If NULL, the filter system will
+ * use avfilter_default_get_video_buffer().
+ *
+ * Input video pads only.
+ */
+ AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
+
+ /**
+ * Callback function to get an audio buffer. If NULL, the filter system will
+ * use avfilter_default_get_audio_buffer().
+ *
+ * Input audio pads only.
+ */
+ AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
+ int nb_samples);
+
+ /**
+ * Callback called after the slices of a frame are completely sent. If
+ * NULL, the filter layer will default to releasing the reference stored
+ * in the link structure during start_frame().
+ *
+ * Input video pads only.
+ */
+ void (*end_frame)(AVFilterLink *link);
+
+ /**
+ * Slice drawing callback. This is where a filter receives video data
+ * and should do its processing.
+ *
+ * Input video pads only.
+ */
+ void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
+
+ /**
+ * Samples filtering callback. This is where a filter receives audio data
+ * and should do its processing.
+ *
+ * Input audio pads only.
+ */
+ void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
+ /**
+ * Frame poll callback. This returns the number of immediately available
+ * samples. It should return a positive value if the next request_frame()
+ * is guaranteed to return one frame (with no delay).
+ *
+ * Defaults to just calling the source poll_frame() method.
+ *
+ * Output pads only.
+ */
+ int (*poll_frame)(AVFilterLink *link);
+
+ /**
+ * Frame request callback. A call to this should result in at least one
+ * frame being output over the given link. This should return zero on
+ * success, and another value on error.
+ *
+ * Output pads only.
+ */
+ int (*request_frame)(AVFilterLink *link);
+
+ /**
+ * Link configuration callback.
+ *
+ * For output pads, this should set the link properties such as
+ * width/height. This should NOT set the format property - that is
+ * negotiated between filters by the filter system using the
+ * query_formats() callback before this function is called.
+ *
+ * For input pads, this should check the properties of the link, and update
+ * the filter's internal state as necessary.
+ *
+ * For both input and output filters, this should return zero on success,
+ * and another value on error.
+ */
+ int (*config_props)(AVFilterLink *link);
+};
+#endif
+
/** default handler for freeing audio/video buffer when there are no references left */
void ff_avfilter_default_free_buffer(AVFilterBuffer *buf);