avfiltergraph.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. /*
  2. * Filter graphs
  3. * copyright (c) 2007 Bobby Bingham
  4. *
  5. * This file is part of FFmpeg.
  6. *
  7. * FFmpeg 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. * FFmpeg 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 FFmpeg; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. */
  21. #ifndef AVFILTER_AVFILTERGRAPH_H
  22. #define AVFILTER_AVFILTERGRAPH_H
  23. #include "avfilter.h"
  24. typedef struct AVFilterGraph {
  25. unsigned filter_count;
  26. AVFilterContext **filters;
  27. char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters
  28. } AVFilterGraph;
  29. /**
  30. * Allocate a filter graph.
  31. */
  32. AVFilterGraph *avfilter_graph_alloc(void);
  33. /**
  34. * Get a filter instance with name name from graph.
  35. *
  36. * @return the pointer to the found filter instance or NULL if it
  37. * cannot be found.
  38. */
  39. AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, char *name);
  40. /**
  41. * Add an existing filter instance to a filter graph.
  42. *
  43. * @param graphctx the filter graph
  44. * @param filter the filter to be added
  45. */
  46. int avfilter_graph_add_filter(AVFilterGraph *graphctx, AVFilterContext *filter);
  47. /**
  48. * Create and add a filter instance into an existing graph.
  49. * The filter instance is created from the filter filt and inited
  50. * with the parameters args and opaque.
  51. *
  52. * In case of success put in *filt_ctx the pointer to the created
  53. * filter instance, otherwise set *filt_ctx to NULL.
  54. *
  55. * @param name the instance name to give to the created filter instance
  56. * @param graph_ctx the filter graph
  57. * @return a negative AVERROR error code in case of failure, a non
  58. * negative value otherwise
  59. */
  60. int avfilter_graph_create_filter(AVFilterContext **filt_ctx, AVFilter *filt,
  61. const char *name, const char *args, void *opaque,
  62. AVFilterGraph *graph_ctx);
  63. /**
  64. * Check validity and configure all the links and formats in the graph.
  65. *
  66. * @param graphctx the filter graph
  67. * @param log_ctx context used for logging
  68. * @return 0 in case of success, a negative AVERROR code otherwise
  69. */
  70. int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx);
  71. /**
  72. * Free a graph, destroy its links, and set *graph to NULL.
  73. * If *graph is NULL, do nothing.
  74. */
  75. void avfilter_graph_free(AVFilterGraph **graph);
  76. /**
  77. * A linked-list of the inputs/outputs of the filter chain.
  78. *
  79. * This is mainly useful for avfilter_graph_parse(), since this
  80. * function may accept a description of a graph with not connected
  81. * input/output pads. This struct specifies, per each not connected
  82. * pad contained in the graph, the filter context and the pad index
  83. * required for establishing a link.
  84. */
  85. typedef struct AVFilterInOut {
  86. /** unique name for this input/output in the list */
  87. char *name;
  88. /** filter context associated to this input/output */
  89. AVFilterContext *filter_ctx;
  90. /** index of the filt_ctx pad to use for linking */
  91. int pad_idx;
  92. /** next input/input in the list, NULL if this is the last */
  93. struct AVFilterInOut *next;
  94. } AVFilterInOut;
  95. /**
  96. * Create an AVFilterInOut.
  97. * Must be free with avfilter_inout_free().
  98. */
  99. AVFilterInOut *avfilter_inout_alloc(void);
  100. /**
  101. * Free the AVFilterInOut in *inout, and set its pointer to NULL.
  102. * If *inout is NULL, do nothing.
  103. */
  104. void avfilter_inout_free(AVFilterInOut **inout);
  105. /**
  106. * Add a graph described by a string to a graph.
  107. *
  108. * @param graph the filter graph where to link the parsed graph context
  109. * @param filters string to be parsed
  110. * @param inputs pointer to a linked list to the inputs of the graph, may be NULL.
  111. * If non-NULL, *inputs is updated to contain the list of open inputs
  112. * after the parsing, should be freed with avfilter_inout_free().
  113. * @param outputs pointer to a linked list to the outputs of the graph, may be NULL.
  114. * If non-NULL, *outputs is updated to contain the list of open outputs
  115. * after the parsing, should be freed with avfilter_inout_free().
  116. * @return non negative on success, a negative AVERROR code on error
  117. */
  118. int avfilter_graph_parse(AVFilterGraph *graph, const char *filters,
  119. AVFilterInOut **inputs, AVFilterInOut **outputs,
  120. void *log_ctx);
  121. /**
  122. * Send a command to one or more filter instances.
  123. *
  124. * @param graph the filter graph
  125. * @param target the filter(s) to which the command should be sent
  126. * "all" sends to all filters
  127. * otherwise it can be a filter or filter instance name
  128. * which will send the command to all matching filters.
  129. * @param cmd the command to sent, for handling simplicity all commands must be alphanumeric only
  130. * @param arg the argument for the command
  131. * @param res a buffer with size res_size where the filter(s) can return a response.
  132. *
  133. * @returns >=0 on success otherwise an error code.
  134. * AVERROR(ENOSYS) on unsupported commands
  135. */
  136. int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags);
  137. /**
  138. * Queue a command for one or more filter instances.
  139. *
  140. * @param graph the filter graph
  141. * @param target the filter(s) to which the command should be sent
  142. * "all" sends to all filters
  143. * otherwise it can be a filter or filter instance name
  144. * which will send the command to all matching filters.
  145. * @param cmd the command to sent, for handling simplicity all commands must be alphanummeric only
  146. * @param arg the argument for the command
  147. * @param ts time at which the command should be sent to the filter
  148. *
  149. * @note As this executes commands after this function returns, no return code
  150. * from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported.
  151. */
  152. int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts);
  153. /**
  154. * Dump a graph into a human-readable string representation.
  155. *
  156. * @param graph the graph to dump
  157. * @param options formatting options; currently ignored
  158. * @return a string, or NULL in case of memory allocation failure;
  159. * the string must be freed using av_free
  160. */
  161. char *avfilter_graph_dump(AVFilterGraph *graph, const char *options);
  162. #endif /* AVFILTER_AVFILTERGRAPH_H */