]> git.sesse.net Git - ffmpeg/blobdiff - libavfilter/avfilter.h
Rename avfilter_graph_destroy() to avfilter_graph_free().
[ffmpeg] / libavfilter / avfilter.h
index cd274c39e2aed0164538d8ba93b7877cb9306cbd..7cda6fc06d25a1e34252e4028dce50715d4af960 100644 (file)
@@ -25,7 +25,7 @@
 #include "libavutil/avutil.h"
 
 #define LIBAVFILTER_VERSION_MAJOR  1
-#define LIBAVFILTER_VERSION_MINOR 34
+#define LIBAVFILTER_VERSION_MINOR 56
 #define LIBAVFILTER_VERSION_MICRO  0
 
 #define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \
@@ -64,8 +64,7 @@ typedef struct AVFilterPad     AVFilterPad;
  * should not store pointers to this structure directly, but instead use the
  * AVFilterBufferRef structure below.
  */
-typedef struct AVFilterBuffer
-{
+typedef struct AVFilterBuffer {
     uint8_t *data[8];           ///< buffer data for each plane/channel
     int linesize[8];            ///< number of bytes per line
 
@@ -88,13 +87,25 @@ typedef struct AVFilterBuffer
 #define AV_PERM_REUSE    0x08   ///< can output the buffer multiple times, with the same contents each time
 #define AV_PERM_REUSE2   0x10   ///< can output the buffer multiple times, modified each time
 
+/**
+ * Audio specific properties in a reference to an AVFilterBuffer. Since
+ * AVFilterBufferRef is common to different media formats, audio specific
+ * per reference properties must be separated out.
+ */
+typedef struct AVFilterBufferRefAudioProps {
+    int64_t channel_layout;     ///< channel layout of audio buffer
+    int samples_nb;             ///< number of audio samples
+    int size;                   ///< audio buffer size
+    uint32_t sample_rate;       ///< audio buffer sample rate
+    int planar;                 ///< audio buffer - planar or packed
+} AVFilterBufferRefAudioProps;
+
 /**
  * Video specific properties in a reference to an AVFilterBuffer. Since
  * AVFilterBufferRef is common to different media formats, video specific
  * per reference properties must be separated out.
  */
-typedef struct AVFilterBufferRefVideoProps
-{
+typedef struct AVFilterBufferRefVideoProps {
     int w;                      ///< image width
     int h;                      ///< image height
     AVRational pixel_aspect;    ///< pixel aspect ratio
@@ -110,25 +121,29 @@ typedef struct AVFilterBufferRefVideoProps
  *
  * TODO: add anything necessary for frame reordering
  */
-typedef struct AVFilterBufferRef
-{
+typedef struct AVFilterBufferRef {
     AVFilterBuffer *buf;        ///< the buffer that this is a reference to
-    uint8_t *data[8];           ///< picture data for each plane
+    uint8_t *data[8];           ///< picture/audio data for each plane
     int linesize[8];            ///< number of bytes per line
     int format;                 ///< media format
 
-    int64_t pts;                ///< presentation timestamp in units of 1/AV_TIME_BASE
+    /**
+     * presentation timestamp. The time unit may change during
+     * filtering, as it is specified in the link and the filter code
+     * may need to rescale the PTS accordingly.
+     */
+    int64_t pts;
     int64_t pos;                ///< byte position in stream, -1 if unknown
 
     int perms;                  ///< permissions, see the AV_PERM_* flags
 
     enum AVMediaType type;      ///< media type of buffer data
     AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
+    AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
 } AVFilterBufferRef;
 
 /**
- * Copy properties of src to dst, without copying the actual video
- * data.
+ * Copy properties of src to dst, without copying the actual data
  */
 static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src)
 {
@@ -138,11 +153,13 @@ static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilt
 
     switch (src->type) {
     case AVMEDIA_TYPE_VIDEO: *dst->video = *src->video; break;
+    case AVMEDIA_TYPE_AUDIO: *dst->audio = *src->audio; break;
     }
 }
 
 /**
  * Add a new reference to a buffer.
+ *
  * @param ref   an existing reference to the buffer
  * @param pmask a bitmask containing the allowable permissions in the new
  *              reference
@@ -154,6 +171,7 @@ AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
 /**
  * Remove a reference to a buffer. If this is the last reference to the
  * buffer, the buffer itself is also automatically freed.
+ *
  * @param ref reference to the buffer
  */
 void avfilter_unref_buffer(AVFilterBufferRef *ref);
@@ -198,19 +216,18 @@ void avfilter_unref_buffer(AVFilterBufferRef *ref);
  * get updated as well. Therefore, we have the format list structure store a
  * pointer to each of the pointers to itself.
  */
-typedef struct AVFilterFormats AVFilterFormats;
-struct AVFilterFormats
-{
+typedef struct AVFilterFormats {
     unsigned format_count;      ///< number of formats
     int *formats;               ///< list of media formats
 
     unsigned refcount;          ///< number of references to this list
-    AVFilterFormats ***refs;    ///< references to this list
-};
+    struct AVFilterFormats ***refs; ///< references to this list
+}  AVFilterFormats;;
 
 /**
  * Create a list of supported formats. This is intended for use in
  * AVFilter->query_formats().
+ *
  * @param fmts list of media formats, terminated by -1
  * @return the format list, with no existing references
  */
@@ -291,8 +308,7 @@ void avfilter_formats_changeref(AVFilterFormats **oldref,
 /**
  * A filter pad used for either input or output.
  */
-struct AVFilterPad
-{
+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
@@ -336,13 +352,23 @@ struct AVFilterPad
     void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
 
     /**
-     * Callback function to get a buffer. If NULL, the filter system will
+     * 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,
+                                           enum SampleFormat sample_fmt, int size,
+                                           int64_t channel_layout, int planar);
+
     /**
      * Callback called after the slices of a frame are completely sent. If
      * NULL, the filter layer will default to releasing the reference stored
@@ -360,9 +386,17 @@ struct AVFilterPad
      */
     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
-     * frames. It should return a positive value if the next request_frame()
+     * 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.
@@ -406,15 +440,24 @@ void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir
 /** default handler for end_frame() for video inputs */
 void avfilter_default_end_frame(AVFilterLink *link);
 
-/** default handler for config_props() for video outputs */
+/** default handler for filter_samples() for audio inputs */
+void avfilter_default_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
+/** default handler for config_props() for audio/video outputs */
 int avfilter_default_config_output_link(AVFilterLink *link);
 
-/** default handler for config_props() for video inputs */
+/** default handler for config_props() for audio/video inputs */
 int avfilter_default_config_input_link (AVFilterLink *link);
 
 /** default handler for get_video_buffer() for video inputs */
 AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
                                                      int perms, int w, int h);
+
+/** default handler for get_audio_buffer() for audio inputs */
+AVFilterBufferRef *avfilter_default_get_audio_buffer(AVFilterLink *link, int perms,
+                                                     enum SampleFormat sample_fmt, int size,
+                                                     int64_t channel_layout, int planar);
+
 /**
  * A helper for query_formats() which sets all links to the same list of
  * formats. If there are no links hooked to this filter, the list of formats is
@@ -434,16 +477,23 @@ void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
 /** end_frame() handler for filters which simply pass video along */
 void avfilter_null_end_frame(AVFilterLink *link);
 
+/** filter_samples() handler for filters which simply pass audio along */
+void avfilter_null_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
 /** get_video_buffer() handler for filters which simply pass video along */
 AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
                                                   int perms, int w, int h);
 
+/** get_audio_buffer() handler for filters which simply pass audio along */
+AVFilterBufferRef *avfilter_null_get_audio_buffer(AVFilterLink *link, int perms,
+                                                  enum SampleFormat sample_fmt, int size,
+                                                  int64_t channel_layout, int planar);
+
 /**
  * Filter definition. This defines the pads a filter contains, and all the
  * callback functions used to interact with the filter.
  */
-typedef struct AVFilter
-{
+typedef struct AVFilter {
     const char *name;         ///< filter name
 
     int priv_size;      ///< size of private data to allocate for the filter
@@ -484,8 +534,7 @@ typedef struct AVFilter
 } AVFilter;
 
 /** An instance of a filter */
-struct AVFilterContext
-{
+struct AVFilterContext {
     const AVClass *av_class;              ///< needed for av_log()
 
     AVFilter *filter;               ///< the AVFilter of which this is an instance
@@ -510,13 +559,12 @@ struct AVFilterContext
  * which have been negotiated and agreed upon between the filter, such as
  * image dimensions, format, etc.
  */
-struct AVFilterLink
-{
+struct AVFilterLink {
     AVFilterContext *src;       ///< source filter
-    unsigned int srcpad;        ///< index of the output pad on the source filter
+    AVFilterPad *srcpad;        ///< output pad on the source filter
 
     AVFilterContext *dst;       ///< dest filter
-    unsigned int dstpad;        ///< index of the input pad on the dest filter
+    AVFilterPad *dstpad;        ///< input pad on the dest filter
 
     /** stage of the initialization of the link properties (dimensions, etc) */
     enum {
@@ -527,8 +575,13 @@ struct AVFilterLink
 
     enum AVMediaType type;      ///< filter media type
 
+    /* These two parameters apply only to video */
     int w;                      ///< agreed upon image width
     int h;                      ///< agreed upon image height
+    /* These two parameters apply only to audio */
+    int64_t channel_layout;     ///< channel layout of current buffer (see avcodec.h)
+    int64_t sample_rate;        ///< samples per second
+
     int format;                 ///< agreed upon media format
 
     /**
@@ -550,10 +603,20 @@ struct AVFilterLink
 
     AVFilterBufferRef *cur_buf;
     AVFilterBufferRef *out_buf;
+
+    /**
+     * Define the time base used by the PTS of the frames/samples
+     * which will pass through this link.
+     * During the configuration stage, each filter is supposed to
+     * change only the output timebase, while the timebase of the
+     * input link is assumed to be an unchangeable property.
+     */
+    AVRational time_base;
 };
 
 /**
  * Link two filters together.
+ *
  * @param src    the source filter
  * @param srcpad index of the output pad on the source filter
  * @param dst    the destination filter
@@ -565,6 +628,7 @@ int avfilter_link(AVFilterContext *src, unsigned srcpad,
 
 /**
  * Negotiate the media format, dimensions, etc of all inputs to a filter.
+ *
  * @param filter the filter to negotiate the properties for its inputs
  * @return       zero on successful negotiation
  */
@@ -572,6 +636,7 @@ int avfilter_config_links(AVFilterContext *filter);
 
 /**
  * Request a picture buffer with a specific set of permissions.
+ *
  * @param link  the output link to the filter from which the buffer will
  *              be requested
  * @param perms the required access permissions
@@ -583,8 +648,26 @@ int avfilter_config_links(AVFilterContext *filter);
 AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
                                           int w, int h);
 
+/**
+ * Request an audio samples buffer with a specific set of permissions.
+ *
+ * @param link           the output link to the filter from which the buffer will
+ *                       be requested
+ * @param perms          the required access permissions
+ * @param sample_fmt     the format of each sample in the buffer to allocate
+ * @param size           the buffer size in bytes
+ * @param channel_layout the number and type of channels per sample in the buffer to allocate
+ * @param planar         audio data layout - planar or packed
+ * @return               A reference to the samples. This must be unreferenced with
+ *                       avfilter_unref_buffer when you are finished with it.
+ */
+AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms,
+                                             enum SampleFormat sample_fmt, int size,
+                                             int64_t channel_layout, int planar);
+
 /**
  * Request an input frame from the filter at the other end of the link.
+ *
  * @param link the input link
  * @return     zero on success
  */
@@ -592,6 +675,7 @@ int avfilter_request_frame(AVFilterLink *link);
 
 /**
  * Poll a frame from the filter chain.
+ *
  * @param  link the input link
  * @return the number of immediately available frames, a negative
  * number in case of error
@@ -600,6 +684,7 @@ int avfilter_poll_frame(AVFilterLink *link);
 
 /**
  * Notifie the next filter of the start of a frame.
+ *
  * @param link   the output link the frame will be sent over
  * @param picref A reference to the frame about to be sent. The data for this
  *               frame need only be valid once draw_slice() is called for that
@@ -610,6 +695,7 @@ void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
 
 /**
  * Notifie the next filter that the current frame has finished.
+ *
  * @param link the output link the frame was sent over
  */
 void avfilter_end_frame(AVFilterLink *link);
@@ -631,6 +717,16 @@ void avfilter_end_frame(AVFilterLink *link);
  */
 void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
 
+/**
+ * Send a buffer of audio samples to the next filter.
+ *
+ * @param link       the output link over which the audio samples are being sent
+ * @param samplesref a reference to the buffer of audio samples being sent. The
+ *                   receiving filter will free this reference when it no longer
+ *                   needs it or pass it on to the next filter.
+ */
+void avfilter_filter_samples(AVFilterLink *link, AVFilterBufferRef *samplesref);
+
 /** Initialize the filter system. Register all builtin filters. */
 void avfilter_register_all(void);
 
@@ -642,6 +738,7 @@ void avfilter_uninit(void);
  * avfilter_get_by_name later to lookup the AVFilter structure by name. A
  * filter can still by instantiated with avfilter_open even if it is not
  * registered.
+ *
  * @param filter the filter to register
  * @return 0 if the registration was succesfull, a negative value
  * otherwise
@@ -650,6 +747,7 @@ int avfilter_register(AVFilter *filter);
 
 /**
  * Get a filter definition matching the given name.
+ *
  * @param name the filter name to find
  * @return     the filter definition, if any matching one is registered.
  *             NULL if none found.
@@ -677,6 +775,7 @@ int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *in
 
 /**
  * Initialize a filter.
+ *
  * @param filter the filter to initialize
  * @param args   A string of parameters to use when initializing the filter.
  *               The format and meaning of this string varies by filter.
@@ -688,23 +787,26 @@ int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque
 
 /**
  * Destroy a filter.
+ *
  * @param filter the filter to destroy
  */
 void avfilter_destroy(AVFilterContext *filter);
 
 /**
  * Insert a filter in the middle of an existing link.
+ *
  * @param link the link into which the filter should be inserted
  * @param filt the filter to be inserted
- * @param in   the input pad on the filter to connect
- * @param out  the output pad on the filter to connect
+ * @param filt_srcpad_idx the input pad on the filter to connect
+ * @param filt_dstpad_idx the output pad on the filter to connect
  * @return     zero on success
  */
 int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
-                           unsigned in, unsigned out);
+                           unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
 
 /**
  * Insert a new pad.
+ *
  * @param idx Insertion point. Pad is inserted at the end if this point
  *            is beyond the end of the list of pads.
  * @param count Pointer to the number of pads in the list