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.

778 lines
28KB

  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. /**
  24. * @file
  25. * @ingroup lavfi
  26. * Main libavfilter public API header
  27. */
  28. /**
  29. * @defgroup lavfi Libavfilter - graph-based frame editing library
  30. * @{
  31. */
  32. #include "libavutil/attributes.h"
  33. #include "libavutil/avutil.h"
  34. #include "libavutil/buffer.h"
  35. #include "libavutil/frame.h"
  36. #include "libavutil/log.h"
  37. #include "libavutil/samplefmt.h"
  38. #include "libavutil/pixfmt.h"
  39. #include "libavutil/rational.h"
  40. #include <stddef.h>
  41. #include "libavfilter/version.h"
  42. /**
  43. * Return the LIBAVFILTER_VERSION_INT constant.
  44. */
  45. unsigned avfilter_version(void);
  46. /**
  47. * Return the libavfilter build-time configuration.
  48. */
  49. const char *avfilter_configuration(void);
  50. /**
  51. * Return the libavfilter license.
  52. */
  53. const char *avfilter_license(void);
  54. typedef struct AVFilterContext AVFilterContext;
  55. typedef struct AVFilterLink AVFilterLink;
  56. typedef struct AVFilterPad AVFilterPad;
  57. typedef struct AVFilterFormats AVFilterFormats;
  58. /**
  59. * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g.
  60. * AVFilter.inputs/outputs).
  61. */
  62. int avfilter_pad_count(const AVFilterPad *pads);
  63. /**
  64. * Get the name of an AVFilterPad.
  65. *
  66. * @param pads an array of AVFilterPads
  67. * @param pad_idx index of the pad in the array it; is the caller's
  68. * responsibility to ensure the index is valid
  69. *
  70. * @return name of the pad_idx'th pad in pads
  71. */
  72. const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx);
  73. /**
  74. * Get the type of an AVFilterPad.
  75. *
  76. * @param pads an array of AVFilterPads
  77. * @param pad_idx index of the pad in the array; it is the caller's
  78. * responsibility to ensure the index is valid
  79. *
  80. * @return type of the pad_idx'th pad in pads
  81. */
  82. enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx);
  83. /**
  84. * The number of the filter inputs is not determined just by AVFilter.inputs.
  85. * The filter might add additional inputs during initialization depending on the
  86. * options supplied to it.
  87. */
  88. #define AVFILTER_FLAG_DYNAMIC_INPUTS (1 << 0)
  89. /**
  90. * The number of the filter outputs is not determined just by AVFilter.outputs.
  91. * The filter might add additional outputs during initialization depending on
  92. * the options supplied to it.
  93. */
  94. #define AVFILTER_FLAG_DYNAMIC_OUTPUTS (1 << 1)
  95. /**
  96. * The filter supports multithreading by splitting frames into multiple parts
  97. * and processing them concurrently.
  98. */
  99. #define AVFILTER_FLAG_SLICE_THREADS (1 << 2)
  100. /**
  101. * Filter definition. This defines the pads a filter contains, and all the
  102. * callback functions used to interact with the filter.
  103. */
  104. typedef struct AVFilter {
  105. /**
  106. * Filter name. Must be non-NULL and unique among filters.
  107. */
  108. const char *name;
  109. /**
  110. * A description of the filter. May be NULL.
  111. *
  112. * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
  113. */
  114. const char *description;
  115. /**
  116. * List of inputs, terminated by a zeroed element.
  117. *
  118. * NULL if there are no (static) inputs. Instances of filters with
  119. * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in
  120. * this list.
  121. */
  122. const AVFilterPad *inputs;
  123. /**
  124. * List of outputs, terminated by a zeroed element.
  125. *
  126. * NULL if there are no (static) outputs. Instances of filters with
  127. * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in
  128. * this list.
  129. */
  130. const AVFilterPad *outputs;
  131. /**
  132. * A class for the private data, used to declare filter private AVOptions.
  133. * This field is NULL for filters that do not declare any options.
  134. *
  135. * If this field is non-NULL, the first member of the filter private data
  136. * must be a pointer to AVClass, which will be set by libavfilter generic
  137. * code to this class.
  138. */
  139. const AVClass *priv_class;
  140. /**
  141. * A combination of AVFILTER_FLAG_*
  142. */
  143. int flags;
  144. /*****************************************************************
  145. * All fields below this line are not part of the public API. They
  146. * may not be used outside of libavfilter and can be changed and
  147. * removed at will.
  148. * New public fields should be added right above.
  149. *****************************************************************
  150. */
  151. /**
  152. * Filter initialization function.
  153. *
  154. * This callback will be called only once during the filter lifetime, after
  155. * all the options have been set, but before links between filters are
  156. * established and format negotiation is done.
  157. *
  158. * Basic filter initialization should be done here. Filters with dynamic
  159. * inputs and/or outputs should create those inputs/outputs here based on
  160. * provided options. No more changes to this filter's inputs/outputs can be
  161. * done after this callback.
  162. *
  163. * This callback must not assume that the filter links exist or frame
  164. * parameters are known.
  165. *
  166. * @ref AVFilter.uninit "uninit" is guaranteed to be called even if
  167. * initialization fails, so this callback does not have to clean up on
  168. * failure.
  169. *
  170. * @return 0 on success, a negative AVERROR on failure
  171. */
  172. int (*init)(AVFilterContext *ctx);
  173. /**
  174. * Should be set instead of @ref AVFilter.init "init" by the filters that
  175. * want to pass a dictionary of AVOptions to nested contexts that are
  176. * allocated during init.
  177. *
  178. * On return, the options dict should be freed and replaced with one that
  179. * contains all the options which could not be processed by this filter (or
  180. * with NULL if all the options were processed).
  181. *
  182. * Otherwise the semantics is the same as for @ref AVFilter.init "init".
  183. */
  184. int (*init_dict)(AVFilterContext *ctx, AVDictionary **options);
  185. /**
  186. * Filter uninitialization function.
  187. *
  188. * Called only once right before the filter is freed. Should deallocate any
  189. * memory held by the filter, release any buffer references, etc. It does
  190. * not need to deallocate the AVFilterContext.priv memory itself.
  191. *
  192. * This callback may be called even if @ref AVFilter.init "init" was not
  193. * called or failed, so it must be prepared to handle such a situation.
  194. */
  195. void (*uninit)(AVFilterContext *ctx);
  196. /**
  197. * Query formats supported by the filter on its inputs and outputs.
  198. *
  199. * This callback is called after the filter is initialized (so the inputs
  200. * and outputs are fixed), shortly before the format negotiation. This
  201. * callback may be called more than once.
  202. *
  203. * This callback must set AVFilterLink.out_formats on every input link and
  204. * AVFilterLink.in_formats on every output link to a list of pixel/sample
  205. * formats that the filter supports on that link. For audio links, this
  206. * filter must also set @ref AVFilterLink.in_samplerates "in_samplerates" /
  207. * @ref AVFilterLink.out_samplerates "out_samplerates" and
  208. * @ref AVFilterLink.in_channel_layouts "in_channel_layouts" /
  209. * @ref AVFilterLink.out_channel_layouts "out_channel_layouts" analogously.
  210. *
  211. * This callback may be NULL for filters with one input, in which case
  212. * libavfilter assumes that it supports all input formats and preserves
  213. * them on output.
  214. *
  215. * @return zero on success, a negative value corresponding to an
  216. * AVERROR code otherwise
  217. */
  218. int (*query_formats)(AVFilterContext *);
  219. int priv_size; ///< size of private data to allocate for the filter
  220. int flags_internal; ///< Additional flags for avfilter internal use only.
  221. /**
  222. * Used by the filter registration system. Must not be touched by any other
  223. * code.
  224. */
  225. struct AVFilter *next;
  226. } AVFilter;
  227. /**
  228. * Process multiple parts of the frame concurrently.
  229. */
  230. #define AVFILTER_THREAD_SLICE (1 << 0)
  231. typedef struct AVFilterInternal AVFilterInternal;
  232. /** An instance of a filter */
  233. struct AVFilterContext {
  234. const AVClass *av_class; ///< needed for av_log()
  235. const AVFilter *filter; ///< the AVFilter of which this is an instance
  236. char *name; ///< name of this filter instance
  237. AVFilterPad *input_pads; ///< array of input pads
  238. AVFilterLink **inputs; ///< array of pointers to input links
  239. unsigned nb_inputs; ///< number of input pads
  240. AVFilterPad *output_pads; ///< array of output pads
  241. AVFilterLink **outputs; ///< array of pointers to output links
  242. unsigned nb_outputs; ///< number of output pads
  243. void *priv; ///< private data for use by the filter
  244. struct AVFilterGraph *graph; ///< filtergraph this filter belongs to
  245. /**
  246. * Type of multithreading being allowed/used. A combination of
  247. * AVFILTER_THREAD_* flags.
  248. *
  249. * May be set by the caller before initializing the filter to forbid some
  250. * or all kinds of multithreading for this filter. The default is allowing
  251. * everything.
  252. *
  253. * When the filter is initialized, this field is combined using bit AND with
  254. * AVFilterGraph.thread_type to get the final mask used for determining
  255. * allowed threading types. I.e. a threading type needs to be set in both
  256. * to be allowed.
  257. *
  258. * After the filter is initialzed, libavfilter sets this field to the
  259. * threading type that is actually used (0 for no multithreading).
  260. */
  261. int thread_type;
  262. /**
  263. * An opaque struct for libavfilter internal use.
  264. */
  265. AVFilterInternal *internal;
  266. /**
  267. * For filters which will create hardware frames, sets the device the
  268. * filter should create them in. All other filters will ignore this field:
  269. * in particular, a filter which consumes or processes hardware frames will
  270. * instead use the hw_frames_ctx field in AVFilterLink to carry the
  271. * hardware context information.
  272. */
  273. AVBufferRef *hw_device_ctx;
  274. /**
  275. * Sets the number of extra hardware frames which the filter will
  276. * allocate on its output links for use in following filters or by
  277. * the caller.
  278. *
  279. * Some hardware filters require all frames that they will use for
  280. * output to be defined in advance before filtering starts. For such
  281. * filters, any hardware frame pools used for output must therefore be
  282. * of fixed size. The extra frames set here are on top of any number
  283. * that the filter needs internally in order to operate normally.
  284. *
  285. * This field must be set before the graph containing this filter is
  286. * configured.
  287. */
  288. int extra_hw_frames;
  289. };
  290. /**
  291. * A link between two filters. This contains pointers to the source and
  292. * destination filters between which this link exists, and the indexes of
  293. * the pads involved. In addition, this link also contains the parameters
  294. * which have been negotiated and agreed upon between the filter, such as
  295. * image dimensions, format, etc.
  296. */
  297. struct AVFilterLink {
  298. AVFilterContext *src; ///< source filter
  299. AVFilterPad *srcpad; ///< output pad on the source filter
  300. AVFilterContext *dst; ///< dest filter
  301. AVFilterPad *dstpad; ///< input pad on the dest filter
  302. enum AVMediaType type; ///< filter media type
  303. /* These parameters apply only to video */
  304. int w; ///< agreed upon image width
  305. int h; ///< agreed upon image height
  306. AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio
  307. /* These two parameters apply only to audio */
  308. uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/channel_layout.h)
  309. int sample_rate; ///< samples per second
  310. int format; ///< agreed upon media format
  311. /**
  312. * Define the time base used by the PTS of the frames/samples
  313. * which will pass through this link.
  314. * During the configuration stage, each filter is supposed to
  315. * change only the output timebase, while the timebase of the
  316. * input link is assumed to be an unchangeable property.
  317. */
  318. AVRational time_base;
  319. /*****************************************************************
  320. * All fields below this line are not part of the public API. They
  321. * may not be used outside of libavfilter and can be changed and
  322. * removed at will.
  323. * New public fields should be added right above.
  324. *****************************************************************
  325. */
  326. /**
  327. * Lists of formats supported by the input and output filters respectively.
  328. * These lists are used for negotiating the format to actually be used,
  329. * which will be loaded into the format member, above, when chosen.
  330. */
  331. AVFilterFormats *in_formats;
  332. AVFilterFormats *out_formats;
  333. /**
  334. * Lists of channel layouts and sample rates used for automatic
  335. * negotiation.
  336. */
  337. AVFilterFormats *in_samplerates;
  338. AVFilterFormats *out_samplerates;
  339. struct AVFilterChannelLayouts *in_channel_layouts;
  340. struct AVFilterChannelLayouts *out_channel_layouts;
  341. /**
  342. * Audio only, the destination filter sets this to a non-zero value to
  343. * request that buffers with the given number of samples should be sent to
  344. * it. AVFilterPad.needs_fifo must also be set on the corresponding input
  345. * pad.
  346. * Last buffer before EOF will be padded with silence.
  347. */
  348. int request_samples;
  349. /** stage of the initialization of the link properties (dimensions, etc) */
  350. enum {
  351. AVLINK_UNINIT = 0, ///< not started
  352. AVLINK_STARTINIT, ///< started, but incomplete
  353. AVLINK_INIT ///< complete
  354. } init_state;
  355. /**
  356. * Frame rate of the stream on the link, or 1/0 if unknown or variable;
  357. * if left to 0/0, will be automatically copied from the first input
  358. * of the source filter if it exists.
  359. *
  360. * Sources should set it to the real constant frame rate.
  361. * If the source frame rate is unknown or variable, set this to 1/0.
  362. * Filters should update it if necessary depending on their function.
  363. * Sinks can use it to set a default output frame rate.
  364. */
  365. AVRational frame_rate;
  366. /**
  367. * For hwaccel pixel formats, this should be a reference to the
  368. * AVHWFramesContext describing the frames.
  369. */
  370. AVBufferRef *hw_frames_ctx;
  371. };
  372. /**
  373. * Link two filters together.
  374. *
  375. * @param src the source filter
  376. * @param srcpad index of the output pad on the source filter
  377. * @param dst the destination filter
  378. * @param dstpad index of the input pad on the destination filter
  379. * @return zero on success
  380. */
  381. int avfilter_link(AVFilterContext *src, unsigned srcpad,
  382. AVFilterContext *dst, unsigned dstpad);
  383. /**
  384. * Negotiate the media format, dimensions, etc of all inputs to a filter.
  385. *
  386. * @param filter the filter to negotiate the properties for its inputs
  387. * @return zero on successful negotiation
  388. */
  389. int avfilter_config_links(AVFilterContext *filter);
  390. /** Initialize the filter system. Register all builtin filters. */
  391. void avfilter_register_all(void);
  392. /**
  393. * Register a filter. This is only needed if you plan to use
  394. * avfilter_get_by_name later to lookup the AVFilter structure by name. A
  395. * filter can still by instantiated with avfilter_graph_alloc_filter even if it
  396. * is not registered.
  397. *
  398. * @param filter the filter to register
  399. * @return 0 if the registration was successful, a negative value
  400. * otherwise
  401. */
  402. int avfilter_register(AVFilter *filter);
  403. /**
  404. * Get a filter definition matching the given name.
  405. *
  406. * @param name the filter name to find
  407. * @return the filter definition, if any matching one is registered.
  408. * NULL if none found.
  409. */
  410. const AVFilter *avfilter_get_by_name(const char *name);
  411. /**
  412. * Iterate over all registered filters.
  413. * @return If prev is non-NULL, next registered filter after prev or NULL if
  414. * prev is the last filter. If prev is NULL, return the first registered filter.
  415. */
  416. const AVFilter *avfilter_next(const AVFilter *prev);
  417. /**
  418. * Initialize a filter with the supplied parameters.
  419. *
  420. * @param ctx uninitialized filter context to initialize
  421. * @param args Options to initialize the filter with. This must be a
  422. * ':'-separated list of options in the 'key=value' form.
  423. * May be NULL if the options have been set directly using the
  424. * AVOptions API or there are no options that need to be set.
  425. * @return 0 on success, a negative AVERROR on failure
  426. */
  427. int avfilter_init_str(AVFilterContext *ctx, const char *args);
  428. /**
  429. * Initialize a filter with the supplied dictionary of options.
  430. *
  431. * @param ctx uninitialized filter context to initialize
  432. * @param options An AVDictionary filled with options for this filter. On
  433. * return this parameter will be destroyed and replaced with
  434. * a dict containing options that were not found. This dictionary
  435. * must be freed by the caller.
  436. * May be NULL, then this function is equivalent to
  437. * avfilter_init_str() with the second parameter set to NULL.
  438. * @return 0 on success, a negative AVERROR on failure
  439. *
  440. * @note This function and avfilter_init_str() do essentially the same thing,
  441. * the difference is in manner in which the options are passed. It is up to the
  442. * calling code to choose whichever is more preferable. The two functions also
  443. * behave differently when some of the provided options are not declared as
  444. * supported by the filter. In such a case, avfilter_init_str() will fail, but
  445. * this function will leave those extra options in the options AVDictionary and
  446. * continue as usual.
  447. */
  448. int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options);
  449. /**
  450. * Free a filter context. This will also remove the filter from its
  451. * filtergraph's list of filters.
  452. *
  453. * @param filter the filter to free
  454. */
  455. void avfilter_free(AVFilterContext *filter);
  456. /**
  457. * Insert a filter in the middle of an existing link.
  458. *
  459. * @param link the link into which the filter should be inserted
  460. * @param filt the filter to be inserted
  461. * @param filt_srcpad_idx the input pad on the filter to connect
  462. * @param filt_dstpad_idx the output pad on the filter to connect
  463. * @return zero on success
  464. */
  465. int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt,
  466. unsigned filt_srcpad_idx, unsigned filt_dstpad_idx);
  467. /**
  468. * @return AVClass for AVFilterContext.
  469. *
  470. * @see av_opt_find().
  471. */
  472. const AVClass *avfilter_get_class(void);
  473. typedef struct AVFilterGraphInternal AVFilterGraphInternal;
  474. /**
  475. * A function pointer passed to the @ref AVFilterGraph.execute callback to be
  476. * executed multiple times, possibly in parallel.
  477. *
  478. * @param ctx the filter context the job belongs to
  479. * @param arg an opaque parameter passed through from @ref
  480. * AVFilterGraph.execute
  481. * @param jobnr the index of the job being executed
  482. * @param nb_jobs the total number of jobs
  483. *
  484. * @return 0 on success, a negative AVERROR on error
  485. */
  486. typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs);
  487. /**
  488. * A function executing multiple jobs, possibly in parallel.
  489. *
  490. * @param ctx the filter context to which the jobs belong
  491. * @param func the function to be called multiple times
  492. * @param arg the argument to be passed to func
  493. * @param ret a nb_jobs-sized array to be filled with return values from each
  494. * invocation of func
  495. * @param nb_jobs the number of jobs to execute
  496. *
  497. * @return 0 on success, a negative AVERROR on error
  498. */
  499. typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func,
  500. void *arg, int *ret, int nb_jobs);
  501. typedef struct AVFilterGraph {
  502. const AVClass *av_class;
  503. AVFilterContext **filters;
  504. unsigned nb_filters;
  505. char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
  506. char *resample_lavr_opts; ///< libavresample options to use for the auto-inserted resample filters
  507. /**
  508. * Type of multithreading allowed for filters in this graph. A combination
  509. * of AVFILTER_THREAD_* flags.
  510. *
  511. * May be set by the caller at any point, the setting will apply to all
  512. * filters initialized after that. The default is allowing everything.
  513. *
  514. * When a filter in this graph is initialized, this field is combined using
  515. * bit AND with AVFilterContext.thread_type to get the final mask used for
  516. * determining allowed threading types. I.e. a threading type needs to be
  517. * set in both to be allowed.
  518. */
  519. int thread_type;
  520. /**
  521. * Maximum number of threads used by filters in this graph. May be set by
  522. * the caller before adding any filters to the filtergraph. Zero (the
  523. * default) means that the number of threads is determined automatically.
  524. */
  525. int nb_threads;
  526. /**
  527. * Opaque object for libavfilter internal use.
  528. */
  529. AVFilterGraphInternal *internal;
  530. /**
  531. * Opaque user data. May be set by the caller to an arbitrary value, e.g. to
  532. * be used from callbacks like @ref AVFilterGraph.execute.
  533. * Libavfilter will not touch this field in any way.
  534. */
  535. void *opaque;
  536. /**
  537. * This callback may be set by the caller immediately after allocating the
  538. * graph and before adding any filters to it, to provide a custom
  539. * multithreading implementation.
  540. *
  541. * If set, filters with slice threading capability will call this callback
  542. * to execute multiple jobs in parallel.
  543. *
  544. * If this field is left unset, libavfilter will use its internal
  545. * implementation, which may or may not be multithreaded depending on the
  546. * platform and build options.
  547. */
  548. avfilter_execute_func *execute;
  549. } AVFilterGraph;
  550. /**
  551. * Allocate a filter graph.
  552. *
  553. * @return the allocated filter graph on success or NULL.
  554. */
  555. AVFilterGraph *avfilter_graph_alloc(void);
  556. /**
  557. * Create a new filter instance in a filter graph.
  558. *
  559. * @param graph graph in which the new filter will be used
  560. * @param filter the filter to create an instance of
  561. * @param name Name to give to the new instance (will be copied to
  562. * AVFilterContext.name). This may be used by the caller to identify
  563. * different filters, libavfilter itself assigns no semantics to
  564. * this parameter. May be NULL.
  565. *
  566. * @return the context of the newly created filter instance (note that it is
  567. * also retrievable directly through AVFilterGraph.filters or with
  568. * avfilter_graph_get_filter()) on success or NULL or failure.
  569. */
  570. AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph,
  571. const AVFilter *filter,
  572. const char *name);
  573. /**
  574. * Get a filter instance with name name from graph.
  575. *
  576. * @return the pointer to the found filter instance or NULL if it
  577. * cannot be found.
  578. */
  579. AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
  580. /**
  581. * Create and add a filter instance into an existing graph.
  582. * The filter instance is created from the filter filt and inited
  583. * with the parameters args and opaque.
  584. *
  585. * In case of success put in *filt_ctx the pointer to the created
  586. * filter instance, otherwise set *filt_ctx to NULL.
  587. *
  588. * @param name the instance name to give to the created filter instance
  589. * @param graph_ctx the filter graph
  590. * @return a negative AVERROR error code in case of failure, a non
  591. * negative value otherwise
  592. */
  593. int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt,
  594. const char *name, const char *args, void *opaque,
  595. AVFilterGraph *graph_ctx);
  596. /**
  597. * Check validity and configure all the links and formats in the graph.
  598. *
  599. * @param graphctx the filter graph
  600. * @param log_ctx context used for logging
  601. * @return 0 in case of success, a negative AVERROR code otherwise
  602. */
  603. int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
  604. /**
  605. * Free a graph, destroy its links, and set *graph to NULL.
  606. * If *graph is NULL, do nothing.
  607. */
  608. void avfilter_graph_free(AVFilterGraph **graph);
  609. /**
  610. * A linked-list of the inputs/outputs of the filter chain.
  611. *
  612. * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(),
  613. * where it is used to communicate open (unlinked) inputs and outputs from and
  614. * to the caller.
  615. * This struct specifies, per each not connected pad contained in the graph, the
  616. * filter context and the pad index required for establishing a link.
  617. */
  618. typedef struct AVFilterInOut {
  619. /** unique name for this input/output in the list */
  620. char *name;
  621. /** filter context associated to this input/output */
  622. AVFilterContext *filter_ctx;
  623. /** index of the filt_ctx pad to use for linking */
  624. int pad_idx;
  625. /** next input/input in the list, NULL if this is the last */
  626. struct AVFilterInOut *next;
  627. } AVFilterInOut;
  628. /**
  629. * Allocate a single AVFilterInOut entry.
  630. * Must be freed with avfilter_inout_free().
  631. * @return allocated AVFilterInOut on success, NULL on failure.
  632. */
  633. AVFilterInOut *avfilter_inout_alloc(void);
  634. /**
  635. * Free the supplied list of AVFilterInOut and set *inout to NULL.
  636. * If *inout is NULL, do nothing.
  637. */
  638. void avfilter_inout_free(AVFilterInOut **inout);
  639. /**
  640. * Add a graph described by a string to a graph.
  641. *
  642. * @param graph the filter graph where to link the parsed graph context
  643. * @param filters string to be parsed
  644. * @param inputs linked list to the inputs of the graph
  645. * @param outputs linked list to the outputs of the graph
  646. * @return zero on success, a negative AVERROR code on error
  647. */
  648. int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
  649. AVFilterInOut *inputs, AVFilterInOut *outputs,
  650. void *log_ctx);
  651. /**
  652. * Add a graph described by a string to a graph.
  653. *
  654. * @param[in] graph the filter graph where to link the parsed graph context
  655. * @param[in] filters string to be parsed
  656. * @param[out] inputs a linked list of all free (unlinked) inputs of the
  657. * parsed graph will be returned here. It is to be freed
  658. * by the caller using avfilter_inout_free().
  659. * @param[out] outputs a linked list of all free (unlinked) outputs of the
  660. * parsed graph will be returned here. It is to be freed by the
  661. * caller using avfilter_inout_free().
  662. * @return zero on success, a negative AVERROR code on error
  663. *
  664. * @note the difference between avfilter_graph_parse2() and
  665. * avfilter_graph_parse() is that in avfilter_graph_parse(), the caller provides
  666. * the lists of inputs and outputs, which therefore must be known before calling
  667. * the function. On the other hand, avfilter_graph_parse2() \em returns the
  668. * inputs and outputs that are left unlinked after parsing the graph and the
  669. * caller then deals with them. Another difference is that in
  670. * avfilter_graph_parse(), the inputs parameter describes inputs of the
  671. * <em>already existing</em> part of the graph; i.e. from the point of view of
  672. * the newly created part, they are outputs. Similarly the outputs parameter
  673. * describes outputs of the already existing filters, which are provided as
  674. * inputs to the parsed filters.
  675. * avfilter_graph_parse2() takes the opposite approach -- it makes no reference
  676. * whatsoever to already existing parts of the graph and the inputs parameter
  677. * will on return contain inputs of the newly parsed part of the graph.
  678. * Analogously the outputs parameter will contain outputs of the newly created
  679. * filters.
  680. */
  681. int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters,
  682. AVFilterInOut **inputs,
  683. AVFilterInOut **outputs);
  684. /**
  685. * @}
  686. */
  687. #endif /* AVFILTER_AVFILTER_H */