History

lavfi/buffersink: add a summary documentation of the API.

Nicolas George committed 6 years ago

Commit f1037311 parent 1f12b7b1 file · +36 −0Browse files

Unified · Split

libavfilter/buffersink.h+36−0
@@ -31,6 +31,42 @@ · 30 unmodified lines
3131 * @defgroup lavfi_buffersink Buffer sink API
3232 * @ingroup lavfi
3333 * @{
34+ *
35+ * The buffersink and abuffersink filters are there to connect filter graphs
36+ * to applications. They have a single input, connected to the graph, and no
37+ * output. Frames must be extracted using av_buffersink_get_frame() or
38+ * av_buffersink_get_samples().
39+ *
40+ * The format negotiated by the graph during configuration can be obtained
41+ * using the accessor functions:
42+ * - av_buffersink_get_time_base(),
43+ * - av_buffersink_get_format(),
44+ * - av_buffersink_get_frame_rate(),
45+ * - av_buffersink_get_w(),
46+ * - av_buffersink_get_h(),
47+ * - av_buffersink_get_sample_aspect_ratio(),
48+ * - av_buffersink_get_channels(),
49+ * - av_buffersink_get_channel_layout(),
50+ * - av_buffersink_get_sample_rate().
51+ *
52+ * The format can be constrained by setting options, using av_opt_set() and
53+ * related functions with the AV_OPT_SEARCH_CHILDREN flag.
54+ * - pix_fmts (int list),
55+ * - sample_fmts (int list),
56+ * - sample_rates (int list),
57+ * - channel_layouts (int64_t),
58+ * - channel_counts (int list),
59+ * - all_channel_counts (bool).
60+ * Most of these options are of type binary, and should be set using
61+ * av_opt_set_int_list() or av_opt_set_bin(). If they are not set, all
62+ * corresponding formats are accepted.
63+ *
64+ * As a special case, if neither channel_layouts nor channel_counts is set,
65+ * all valid channel layouts are accepted, but channel counts without a
66+ * layout are not, unless all_channel_counts is set.
67+ * Also, channel_layouts must not contain a channel layout already accepted
68+ * by a value in channel_counts; for example, if channel_counts contains 2,
69+ * then channel_layouts must not contain stereo.
3470 */
3571
3672 /**

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t