You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

774 lines
27KB

  1. /*
  2. * filter layer
  3. * Copyright (c) 2007 Bobby Bingham
  4. *
  5. * This file is part of Libav.
  6. *
  7. * Libav is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * Libav is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with Libav; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. */
  21. #ifndef AVFILTER_AVFILTER_H
  22. #define AVFILTER_AVFILTER_H
  23. #include "libavutil/avutil.h"
  24. #include "libavutil/log.h"
  25. #include "libavutil/samplefmt.h"
  26. #include "libavutil/pixfmt.h"
  27. #include "libavutil/rational.h"
  28. #include "libavcodec/avcodec.h"
  29. #include <stddef.h>
  30. #include "libavfilter/version.h"
  31. /**
  32. * Return the LIBAVFILTER_VERSION_INT constant.
  33. */
  34. unsigned avfilter_version(void);
  35. /**
  36. * Return the libavfilter build-time configuration.
  37. */
  38. const char *avfilter_configuration(void);
  39. /**
  40. * Return the libavfilter license.
  41. */
  42. const char *avfilter_license(void);
  43. typedef struct AVFilterContext AVFilterContext;
  44. typedef struct AVFilterLink AVFilterLink;
  45. typedef struct AVFilterPad AVFilterPad;
  46. typedef struct AVFilterFormats AVFilterFormats;
  47. /**
  48. * A reference-counted buffer data type used by the filter system. Filters
  49. * should not store pointers to this structure directly, but instead use the
  50. * AVFilterBufferRef structure below.
  51. */
  52. typedef struct AVFilterBuffer {
  53. uint8_t *data[8]; ///< buffer data for each plane/channel
  54. int linesize[8]; ///< number of bytes per line
  55. unsigned refcount; ///< number of references to this buffer
  56. /** private data to be used by a custom free function */
  57. void *priv;
  58. /**
  59. * A pointer to the function to deallocate this buffer if the default
  60. * function is not sufficient. This could, for example, add the memory
  61. * back into a memory pool to be reused later without the overhead of
  62. * reallocating it from scratch.
  63. */
  64. void (*free)(struct AVFilterBuffer *buf);
  65. int format; ///< media format
  66. int w, h; ///< width and height of the allocated buffer
  67. /**
  68. * pointers to the data planes/channels.
  69. *
  70. * For video, this should simply point to data[].
  71. *
  72. * For planar audio, each channel has a separate data pointer, and
  73. * linesize[0] contains the size of each channel buffer.
  74. * For packed audio, there is just one data pointer, and linesize[0]
  75. * contains the total size of the buffer for all channels.
  76. *
  77. * Note: Both data and extended_data will always be set, but for planar
  78. * audio with more channels that can fit in data, extended_data must be used
  79. * in order to access all channels.
  80. */
  81. uint8_t **extended_data;
  82. } AVFilterBuffer;
  83. #define AV_PERM_READ 0x01 ///< can read from the buffer
  84. #define AV_PERM_WRITE 0x02 ///< can write to the buffer
  85. #define AV_PERM_PRESERVE 0x04 ///< nobody else can overwrite the buffer
  86. #define AV_PERM_REUSE 0x08 ///< can output the buffer multiple times, with the same contents each time
  87. #define AV_PERM_REUSE2 0x10 ///< can output the buffer multiple times, modified each time
  88. #define AV_PERM_NEG_LINESIZES 0x20 ///< the buffer requested can have negative linesizes
  89. /**
  90. * Audio specific properties in a reference to an AVFilterBuffer. Since
  91. * AVFilterBufferRef is common to different media formats, audio specific
  92. * per reference properties must be separated out.
  93. */
  94. typedef struct AVFilterBufferRefAudioProps {
  95. uint64_t channel_layout; ///< channel layout of audio buffer
  96. int nb_samples; ///< number of audio samples
  97. int sample_rate; ///< audio buffer sample rate
  98. int planar; ///< audio buffer - planar or packed
  99. } AVFilterBufferRefAudioProps;
  100. /**
  101. * Video specific properties in a reference to an AVFilterBuffer. Since
  102. * AVFilterBufferRef is common to different media formats, video specific
  103. * per reference properties must be separated out.
  104. */
  105. typedef struct AVFilterBufferRefVideoProps {
  106. int w; ///< image width
  107. int h; ///< image height
  108. AVRational pixel_aspect; ///< pixel aspect ratio
  109. int interlaced; ///< is frame interlaced
  110. int top_field_first; ///< field order
  111. enum AVPictureType pict_type; ///< picture type of the frame
  112. int key_frame; ///< 1 -> keyframe, 0-> not
  113. } AVFilterBufferRefVideoProps;
  114. /**
  115. * A reference to an AVFilterBuffer. Since filters can manipulate the origin of
  116. * a buffer to, for example, crop image without any memcpy, the buffer origin
  117. * and dimensions are per-reference properties. Linesize is also useful for
  118. * image flipping, frame to field filters, etc, and so is also per-reference.
  119. *
  120. * TODO: add anything necessary for frame reordering
  121. */
  122. typedef struct AVFilterBufferRef {
  123. AVFilterBuffer *buf; ///< the buffer that this is a reference to
  124. uint8_t *data[8]; ///< picture/audio data for each plane
  125. int linesize[8]; ///< number of bytes per line
  126. int format; ///< media format
  127. /**
  128. * presentation timestamp. The time unit may change during
  129. * filtering, as it is specified in the link and the filter code
  130. * may need to rescale the PTS accordingly.
  131. */
  132. int64_t pts;
  133. int64_t pos; ///< byte position in stream, -1 if unknown
  134. int perms; ///< permissions, see the AV_PERM_* flags
  135. enum AVMediaType type; ///< media type of buffer data
  136. AVFilterBufferRefVideoProps *video; ///< video buffer specific properties
  137. AVFilterBufferRefAudioProps *audio; ///< audio buffer specific properties
  138. /**
  139. * pointers to the data planes/channels.
  140. *
  141. * For video, this should simply point to data[].
  142. *
  143. * For planar audio, each channel has a separate data pointer, and
  144. * linesize[0] contains the size of each channel buffer.
  145. * For packed audio, there is just one data pointer, and linesize[0]
  146. * contains the total size of the buffer for all channels.
  147. *
  148. * Note: Both data and extended_data will always be set, but for planar
  149. * audio with more channels that can fit in data, extended_data must be used
  150. * in order to access all channels.
  151. */
  152. uint8_t **extended_data;
  153. } AVFilterBufferRef;
  154. /**
  155. * Copy properties of src to dst, without copying the actual data
  156. */
  157. void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilterBufferRef *src);
  158. /**
  159. * Add a new reference to a buffer.
  160. *
  161. * @param ref an existing reference to the buffer
  162. * @param pmask a bitmask containing the allowable permissions in the new
  163. * reference
  164. * @return a new reference to the buffer with the same properties as the
  165. * old, excluding any permissions denied by pmask
  166. */
  167. AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask);
  168. /**
  169. * Remove a reference to a buffer. If this is the last reference to the
  170. * buffer, the buffer itself is also automatically freed.
  171. *
  172. * @param ref reference to the buffer, may be NULL
  173. */
  174. void avfilter_unref_buffer(AVFilterBufferRef *ref);
  175. #if FF_API_FILTERS_PUBLIC
  176. /**
  177. * @addtogroup lavfi_deprecated
  178. * @deprecated Those functions are only useful inside filters and
  179. * user filters are not supported at this point.
  180. * @{
  181. */
  182. struct AVFilterFormats {
  183. unsigned format_count; ///< number of formats
  184. int *formats; ///< list of media formats
  185. unsigned refcount; ///< number of references to this list
  186. struct AVFilterFormats ***refs; ///< references to this list
  187. };
  188. attribute_deprecated
  189. AVFilterFormats *avfilter_make_format_list(const int *fmts);
  190. attribute_deprecated
  191. int avfilter_add_format(AVFilterFormats **avff, int fmt);
  192. attribute_deprecated
  193. AVFilterFormats *avfilter_all_formats(enum AVMediaType type);
  194. attribute_deprecated
  195. AVFilterFormats *avfilter_merge_formats(AVFilterFormats *a, AVFilterFormats *b);
  196. attribute_deprecated
  197. void avfilter_formats_ref(AVFilterFormats *formats, AVFilterFormats **ref);
  198. attribute_deprecated
  199. void avfilter_formats_unref(AVFilterFormats **ref);
  200. attribute_deprecated
  201. void avfilter_formats_changeref(AVFilterFormats **oldref,
  202. AVFilterFormats **newref);
  203. attribute_deprecated
  204. void avfilter_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats);
  205. /**
  206. * @}
  207. */
  208. #endif
  209. #if FF_API_AVFILTERPAD_PUBLIC
  210. /**
  211. * A filter pad used for either input or output.
  212. *
  213. * @warning this struct will be removed from public API.
  214. * users should call avfilter_pad_get_name() and avfilter_pad_get_type()
  215. * to access the name and type fields; there should be no need to access
  216. * any other fields from outside of libavfilter.
  217. */
  218. struct AVFilterPad {
  219. /**
  220. * Pad name. The name is unique among inputs and among outputs, but an
  221. * input may have the same name as an output. This may be NULL if this
  222. * pad has no need to ever be referenced by name.
  223. */
  224. const char *name;
  225. /**
  226. * AVFilterPad type.
  227. */
  228. enum AVMediaType type;
  229. /**
  230. * Minimum required permissions on incoming buffers. Any buffer with
  231. * insufficient permissions will be automatically copied by the filter
  232. * system to a new buffer which provides the needed access permissions.
  233. *
  234. * Input pads only.
  235. */
  236. int min_perms;
  237. /**
  238. * Permissions which are not accepted on incoming buffers. Any buffer
  239. * which has any of these permissions set will be automatically copied
  240. * by the filter system to a new buffer which does not have those
  241. * permissions. This can be used to easily disallow buffers with
  242. * AV_PERM_REUSE.
  243. *
  244. * Input pads only.
  245. */
  246. int rej_perms;
  247. /**
  248. * Callback called before passing the first slice of a new frame. If
  249. * NULL, the filter layer will default to storing a reference to the
  250. * picture inside the link structure.
  251. *
  252. * Input video pads only.
  253. */
  254. void (*start_frame)(AVFilterLink *link, AVFilterBufferRef *picref);
  255. /**
  256. * Callback function to get a video buffer. If NULL, the filter system will
  257. * use avfilter_default_get_video_buffer().
  258. *
  259. * Input video pads only.
  260. */
  261. AVFilterBufferRef *(*get_video_buffer)(AVFilterLink *link, int perms, int w, int h);
  262. /**
  263. * Callback function to get an audio buffer. If NULL, the filter system will
  264. * use avfilter_default_get_audio_buffer().
  265. *
  266. * Input audio pads only.
  267. */
  268. AVFilterBufferRef *(*get_audio_buffer)(AVFilterLink *link, int perms,
  269. int nb_samples);
  270. /**
  271. * Callback called after the slices of a frame are completely sent. If
  272. * NULL, the filter layer will default to releasing the reference stored
  273. * in the link structure during start_frame().
  274. *
  275. * Input video pads only.
  276. */
  277. void (*end_frame)(AVFilterLink *link);
  278. /**
  279. * Slice drawing callback. This is where a filter receives video data
  280. * and should do its processing.
  281. *
  282. * Input video pads only.
  283. */
  284. void (*draw_slice)(AVFilterLink *link, int y, int height, int slice_dir);
  285. /**
  286. * Samples filtering callback. This is where a filter receives audio data
  287. * and should do its processing.
  288. *
  289. * Input audio pads only.
  290. */
  291. void (*filter_samples)(AVFilterLink *link, AVFilterBufferRef *samplesref);
  292. /**
  293. * Frame poll callback. This returns the number of immediately available
  294. * samples. It should return a positive value if the next request_frame()
  295. * is guaranteed to return one frame (with no delay).
  296. *
  297. * Defaults to just calling the source poll_frame() method.
  298. *
  299. * Output pads only.
  300. */
  301. int (*poll_frame)(AVFilterLink *link);
  302. /**
  303. * Frame request callback. A call to this should result in at least one
  304. * frame being output over the given link. This should return zero on
  305. * success, and another value on error.
  306. *
  307. * Output pads only.
  308. */
  309. int (*request_frame)(AVFilterLink *link);
  310. /**
  311. * Link configuration callback.
  312. *
  313. * For output pads, this should set the link properties such as
  314. * width/height. This should NOT set the format property - that is
  315. * negotiated between filters by the filter system using the
  316. * query_formats() callback before this function is called.
  317. *
  318. * For input pads, this should check the properties of the link, and update
  319. * the filter's internal state as necessary.
  320. *
  321. * For both input and output filters, this should return zero on success,
  322. * and another value on error.
  323. */
  324. int (*config_props)(AVFilterLink *link);
  325. };
  326. #endif
  327. /**
  328. * Get the name of an AVFilterPad.
  329. *
  330. * @param pads an array of AVFilterPads
  331. * @param pad_idx index of the pad in the array it; is the caller's
  332. * responsibility to ensure the index is valid
  333. *
  334. * @return name of the pad_idx'th pad in pads
  335. */
  336. const char *avfilter_pad_get_name(AVFilterPad *pads, int pad_idx);
  337. /**
  338. * Get the type of an AVFilterPad.
  339. *
  340. * @param pads an array of AVFilterPads
  341. * @param pad_idx index of the pad in the array; it is the caller's
  342. * responsibility to ensure the index is valid
  343. *
  344. * @return type of the pad_idx'th pad in pads
  345. */
  346. enum AVMediaType avfilter_pad_get_type(AVFilterPad *pads, int pad_idx);
  347. #if FF_API_FILTERS_PUBLIC
  348. /** default handler for start_frame() for video inputs */
  349. attribute_deprecated
  350. void avfilter_default_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  351. /** default handler for draw_slice() for video inputs */
  352. attribute_deprecated
  353. void avfilter_default_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  354. /** default handler for end_frame() for video inputs */
  355. attribute_deprecated
  356. void avfilter_default_end_frame(AVFilterLink *link);
  357. #if FF_API_DEFAULT_CONFIG_OUTPUT_LINK
  358. /** default handler for config_props() for audio/video outputs */
  359. attribute_deprecated
  360. int avfilter_default_config_output_link(AVFilterLink *link);
  361. #endif
  362. /** default handler for get_video_buffer() for video inputs */
  363. attribute_deprecated
  364. AVFilterBufferRef *avfilter_default_get_video_buffer(AVFilterLink *link,
  365. int perms, int w, int h);
  366. /** Default handler for query_formats() */
  367. attribute_deprecated
  368. int avfilter_default_query_formats(AVFilterContext *ctx);
  369. #endif
  370. #if FF_API_FILTERS_PUBLIC
  371. /** start_frame() handler for filters which simply pass video along */
  372. attribute_deprecated
  373. void avfilter_null_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  374. /** draw_slice() handler for filters which simply pass video along */
  375. attribute_deprecated
  376. void avfilter_null_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  377. /** end_frame() handler for filters which simply pass video along */
  378. attribute_deprecated
  379. void avfilter_null_end_frame(AVFilterLink *link);
  380. /** get_video_buffer() handler for filters which simply pass video along */
  381. attribute_deprecated
  382. AVFilterBufferRef *avfilter_null_get_video_buffer(AVFilterLink *link,
  383. int perms, int w, int h);
  384. #endif
  385. /**
  386. * Filter definition. This defines the pads a filter contains, and all the
  387. * callback functions used to interact with the filter.
  388. */
  389. typedef struct AVFilter {
  390. const char *name; ///< filter name
  391. int priv_size; ///< size of private data to allocate for the filter
  392. /**
  393. * Filter initialization function. Args contains the user-supplied
  394. * parameters. FIXME: maybe an AVOption-based system would be better?
  395. * opaque is data provided by the code requesting creation of the filter,
  396. * and is used to pass data to the filter.
  397. */
  398. int (*init)(AVFilterContext *ctx, const char *args, void *opaque);
  399. /**
  400. * Filter uninitialization function. Should deallocate any memory held
  401. * by the filter, release any buffer references, etc. This does not need
  402. * to deallocate the AVFilterContext->priv memory itself.
  403. */
  404. void (*uninit)(AVFilterContext *ctx);
  405. /**
  406. * Queries formats supported by the filter and its pads, and sets the
  407. * in_formats for links connected to its output pads, and out_formats
  408. * for links connected to its input pads.
  409. *
  410. * @return zero on success, a negative value corresponding to an
  411. * AVERROR code otherwise
  412. */
  413. int (*query_formats)(AVFilterContext *);
  414. const AVFilterPad *inputs; ///< NULL terminated list of inputs. NULL if none
  415. const AVFilterPad *outputs; ///< NULL terminated list of outputs. NULL if none
  416. /**
  417. * A description for the filter. You should use the
  418. * NULL_IF_CONFIG_SMALL() macro to define it.
  419. */
  420. const char *description;
  421. } AVFilter;
  422. /** An instance of a filter */
  423. struct AVFilterContext {
  424. const AVClass *av_class; ///< needed for av_log()
  425. AVFilter *filter; ///< the AVFilter of which this is an instance
  426. char *name; ///< name of this filter instance
  427. #if FF_API_FOO_COUNT
  428. unsigned input_count; ///< @deprecated use nb_inputs
  429. #endif
  430. AVFilterPad *input_pads; ///< array of input pads
  431. AVFilterLink **inputs; ///< array of pointers to input links
  432. #if FF_API_FOO_COUNT
  433. unsigned output_count; ///< @deprecated use nb_outputs
  434. #endif
  435. AVFilterPad *output_pads; ///< array of output pads
  436. AVFilterLink **outputs; ///< array of pointers to output links
  437. void *priv; ///< private data for use by the filter
  438. unsigned nb_inputs; ///< number of input pads
  439. unsigned nb_outputs; ///< number of output pads
  440. };
  441. /**
  442. * A link between two filters. This contains pointers to the source and
  443. * destination filters between which this link exists, and the indexes of
  444. * the pads involved. In addition, this link also contains the parameters
  445. * which have been negotiated and agreed upon between the filter, such as
  446. * image dimensions, format, etc.
  447. */
  448. struct AVFilterLink {
  449. AVFilterContext *src; ///< source filter
  450. AVFilterPad *srcpad; ///< output pad on the source filter
  451. AVFilterContext *dst; ///< dest filter
  452. AVFilterPad *dstpad; ///< input pad on the dest filter
  453. /** stage of the initialization of the link properties (dimensions, etc) */
  454. enum {
  455. AVLINK_UNINIT = 0, ///< not started
  456. AVLINK_STARTINIT, ///< started, but incomplete
  457. AVLINK_INIT ///< complete
  458. } init_state;
  459. enum AVMediaType type; ///< filter media type
  460. /* These parameters apply only to video */
  461. int w; ///< agreed upon image width
  462. int h; ///< agreed upon image height
  463. AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
  464. /* These two parameters apply only to audio */
  465. uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/audioconvert.h)
  466. #if FF_API_SAMPLERATE64
  467. int64_t sample_rate; ///< samples per second
  468. #else
  469. int sample_rate; ///< samples per second
  470. #endif
  471. int format; ///< agreed upon media format
  472. /**
  473. * Lists of formats supported by the input and output filters respectively.
  474. * These lists are used for negotiating the format to actually be used,
  475. * which will be loaded into the format member, above, when chosen.
  476. */
  477. AVFilterFormats *in_formats;
  478. AVFilterFormats *out_formats;
  479. /**
  480. * The buffer reference currently being sent across the link by the source
  481. * filter. This is used internally by the filter system to allow
  482. * automatic copying of buffers which do not have sufficient permissions
  483. * for the destination. This should not be accessed directly by the
  484. * filters.
  485. */
  486. AVFilterBufferRef *src_buf;
  487. AVFilterBufferRef *cur_buf;
  488. AVFilterBufferRef *out_buf;
  489. /**
  490. * Define the time base used by the PTS of the frames/samples
  491. * which will pass through this link.
  492. * During the configuration stage, each filter is supposed to
  493. * change only the output timebase, while the timebase of the
  494. * input link is assumed to be an unchangeable property.
  495. */
  496. AVRational time_base;
  497. /*****************************************************************
  498. * All fields below this line are not part of the public API. They
  499. * may not be used outside of libavfilter and can be changed and
  500. * removed at will.
  501. * New public fields should be added right above.
  502. *****************************************************************
  503. */
  504. /**
  505. * Lists of channel layouts and sample rates used for automatic
  506. * negotiation.
  507. */
  508. AVFilterFormats *in_samplerates;
  509. AVFilterFormats *out_samplerates;
  510. struct AVFilterChannelLayouts *in_channel_layouts;
  511. struct AVFilterChannelLayouts *out_channel_layouts;
  512. };
  513. /**
  514. * Link two filters together.
  515. *
  516. * @param src the source filter
  517. * @param srcpad index of the output pad on the source filter
  518. * @param dst the destination filter
  519. * @param dstpad index of the input pad on the destination filter
  520. * @return zero on success
  521. */
  522. int avfilter_link(AVFilterContext *src, unsigned srcpad,
  523. AVFilterContext *dst, unsigned dstpad);
  524. /**
  525. * Negotiate the media format, dimensions, etc of all inputs to a filter.
  526. *
  527. * @param filter the filter to negotiate the properties for its inputs
  528. * @return zero on successful negotiation
  529. */
  530. int avfilter_config_links(AVFilterContext *filter);
  531. #if FF_API_FILTERS_PUBLIC
  532. attribute_deprecated
  533. AVFilterBufferRef *avfilter_get_video_buffer(AVFilterLink *link, int perms,
  534. int w, int h);
  535. #endif
  536. /**
  537. * Create a buffer reference wrapped around an already allocated image
  538. * buffer.
  539. *
  540. * @param data pointers to the planes of the image to reference
  541. * @param linesize linesizes for the planes of the image to reference
  542. * @param perms the required access permissions
  543. * @param w the width of the image specified by the data and linesize arrays
  544. * @param h the height of the image specified by the data and linesize arrays
  545. * @param format the pixel format of the image specified by the data and linesize arrays
  546. */
  547. AVFilterBufferRef *
  548. avfilter_get_video_buffer_ref_from_arrays(uint8_t *data[4], int linesize[4], int perms,
  549. int w, int h, enum PixelFormat format);
  550. /**
  551. * Create an audio buffer reference wrapped around an already
  552. * allocated samples buffer.
  553. *
  554. * @param data pointers to the samples plane buffers
  555. * @param linesize linesize for the samples plane buffers
  556. * @param perms the required access permissions
  557. * @param nb_samples number of samples per channel
  558. * @param sample_fmt the format of each sample in the buffer to allocate
  559. * @param channel_layout the channel layout of the buffer
  560. */
  561. AVFilterBufferRef *avfilter_get_audio_buffer_ref_from_arrays(uint8_t **data,
  562. int linesize,
  563. int perms,
  564. int nb_samples,
  565. enum AVSampleFormat sample_fmt,
  566. uint64_t channel_layout);
  567. #if FF_API_FILTERS_PUBLIC
  568. attribute_deprecated
  569. int avfilter_request_frame(AVFilterLink *link);
  570. attribute_deprecated
  571. int avfilter_poll_frame(AVFilterLink *link);
  572. attribute_deprecated
  573. void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref);
  574. attribute_deprecated
  575. void avfilter_end_frame(AVFilterLink *link);
  576. attribute_deprecated
  577. void avfilter_draw_slice(AVFilterLink *link, int y, int h, int slice_dir);
  578. #endif
  579. /** Initialize the filter system. Register all builtin filters. */
  580. void avfilter_register_all(void);
  581. /** Uninitialize the filter system. Unregister all filters. */
  582. void avfilter_uninit(void);
  583. /**
  584. * Register a filter. This is only needed if you plan to use
  585. * avfilter_get_by_name later to lookup the AVFilter structure by name. A
  586. * filter can still by instantiated with avfilter_open even if it is not
  587. * registered.
  588. *
  589. * @param filter the filter to register
  590. * @return 0 if the registration was succesfull, a negative value
  591. * otherwise
  592. */
  593. int avfilter_register(AVFilter *filter);
  594. /**
  595. * Get a filter definition matching the given name.
  596. *
  597. * @param name the filter name to find
  598. * @return the filter definition, if any matching one is registered.
  599. * NULL if none found.
  600. */
  601. AVFilter *avfilter_get_by_name(const char *name);
  602. /**
  603. * If filter is NULL, returns a pointer to the first registered filter pointer,
  604. * if filter is non-NULL, returns the next pointer after filter.
  605. * If the returned pointer points to NULL, the last registered filter
  606. * was already reached.
  607. */
  608. AVFilter **av_filter_next(AVFilter **filter);
  609. /**
  610. * Create a filter instance.
  611. *
  612. * @param filter_ctx put here a pointer to the created filter context
  613. * on success, NULL on failure
  614. * @param filter the filter to create an instance of
  615. * @param inst_name Name to give to the new instance. Can be NULL for none.
  616. * @return >= 0 in case of success, a negative error code otherwise
  617. */
  618. int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *inst_name);
  619. /**
  620. * Initialize a filter.
  621. *
  622. * @param filter the filter to initialize
  623. * @param args A string of parameters to use when initializing the filter.
  624. * The format and meaning of this string varies by filter.
  625. * @param opaque Any extra non-string data needed by the filter. The meaning
  626. * of this parameter varies by filter.
  627. * @return zero on success
  628. */
  629. int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque);
  630. /**
  631. * Free a filter context.
  632. *
  633. * @param filter the filter to free
  634. */
  635. void avfilter_free(AVFilterContext *filter);
  636. /**
  637. * Insert a filter in the middle of an existing link.
  638. *
  639. * @param link the link into which the filter should be inserted
  640. * @param filt the filter to be inserted
  641. * @param filt_srcpad_idx the input pad on the filter to connect
  642. * @param filt_dstpad_idx the output pad on the filter to connect
  643. * @return zero on success
  644. */
  645. int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
  646. unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
  647. #if FF_API_FILTERS_PUBLIC
  648. attribute_deprecated
  649. void avfilter_insert_pad(unsigned idx, unsigned *count, size_t padidx_off,
  650. AVFilterPad **pads, AVFilterLink ***links,
  651. AVFilterPad *newpad);
  652. attribute_deprecated
  653. void avfilter_insert_inpad(AVFilterContext *f, unsigned index,
  654. AVFilterPad *p);
  655. attribute_deprecated
  656. void avfilter_insert_outpad(AVFilterContext *f, unsigned index,
  657. AVFilterPad *p);
  658. #endif
  659. /**
  660. * Copy the frame properties of src to dst, without copying the actual
  661. * image data.
  662. *
  663. * @return 0 on success, a negative number on error.
  664. */
  665. int avfilter_copy_frame_props(AVFilterBufferRef *dst, const AVFrame *src);
  666. /**
  667. * Copy the frame properties and data pointers of src to dst, without copying
  668. * the actual data.
  669. *
  670. * @return 0 on success, a negative number on error.
  671. */
  672. int avfilter_copy_buf_props(AVFrame *dst, const AVFilterBufferRef *src);
  673. #endif /* AVFILTER_AVFILTER_H */