FFmpeg
graphdump.c
Go to the documentation of this file.
1 /*
2  * Filter graphs to bad ASCII-art
3  * Copyright (c) 2012 Nicolas George
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 
22 #include <string.h>
23 
25 #include "libavutil/bprint.h"
26 #include "libavutil/mem.h"
27 #include "libavutil/pixdesc.h"
28 #include "avfilter.h"
29 #include "internal.h"
30 
31 static int print_link_prop(AVBPrint *buf, AVFilterLink *link)
32 {
33  const char *format;
34  AVBPrint dummy_buffer;
35 
36  if (!buf) {
37  buf = &dummy_buffer;
39  }
40  switch (link->type) {
41  case AVMEDIA_TYPE_VIDEO:
43  av_bprintf(buf, "[%dx%d %d:%d %s]", link->w, link->h,
46  format);
47  break;
48 
49  case AVMEDIA_TYPE_AUDIO:
51  av_bprintf(buf, "[%dHz %s:",
52  (int)link->sample_rate, format);
54  av_bprint_chars(buf, ']', 1);
55  break;
56 
57  default:
58  av_bprintf(buf, "?");
59  break;
60  }
61  return buf->len;
62 }
63 
64 static void avfilter_graph_dump_to_buf(AVBPrint *buf, AVFilterGraph *graph)
65 {
66  unsigned i, j, x, e;
67 
68  for (i = 0; i < graph->nb_filters; i++) {
69  AVFilterContext *filter = graph->filters[i];
70  unsigned max_src_name = 0, max_dst_name = 0;
71  unsigned max_in_name = 0, max_out_name = 0;
72  unsigned max_in_fmt = 0, max_out_fmt = 0;
73  unsigned width, height, in_indent;
74  unsigned lname = strlen(filter->name);
75  unsigned ltype = strlen(filter->filter->name);
76 
77  for (j = 0; j < filter->nb_inputs; j++) {
78  AVFilterLink *l = filter->inputs[j];
79  unsigned ln = strlen(l->src->name) + 1 + strlen(l->srcpad->name);
80  max_src_name = FFMAX(max_src_name, ln);
81  max_in_name = FFMAX(max_in_name, strlen(l->dstpad->name));
82  max_in_fmt = FFMAX(max_in_fmt, print_link_prop(NULL, l));
83  }
84  for (j = 0; j < filter->nb_outputs; j++) {
85  AVFilterLink *l = filter->outputs[j];
86  unsigned ln = strlen(l->dst->name) + 1 + strlen(l->dstpad->name);
87  max_dst_name = FFMAX(max_dst_name, ln);
88  max_out_name = FFMAX(max_out_name, strlen(l->srcpad->name));
89  max_out_fmt = FFMAX(max_out_fmt, print_link_prop(NULL, l));
90  }
91  in_indent = max_src_name + max_in_name + max_in_fmt;
92  in_indent += in_indent ? 4 : 0;
93  width = FFMAX(lname + 2, ltype + 4);
94  height = FFMAX3(2, filter->nb_inputs, filter->nb_outputs);
95  av_bprint_chars(buf, ' ', in_indent);
96  av_bprintf(buf, "+");
97  av_bprint_chars(buf, '-', width);
98  av_bprintf(buf, "+\n");
99  for (j = 0; j < height; j++) {
100  unsigned in_no = j - (height - filter->nb_inputs ) / 2;
101  unsigned out_no = j - (height - filter->nb_outputs) / 2;
102 
103  /* Input link */
104  if (in_no < filter->nb_inputs) {
105  AVFilterLink *l = filter->inputs[in_no];
106  e = buf->len + max_src_name + 2;
107  av_bprintf(buf, "%s:%s", l->src->name, l->srcpad->name);
108  av_bprint_chars(buf, '-', e - buf->len);
109  e = buf->len + max_in_fmt + 2 +
110  max_in_name - strlen(l->dstpad->name);
111  print_link_prop(buf, l);
112  av_bprint_chars(buf, '-', e - buf->len);
113  av_bprintf(buf, "%s", l->dstpad->name);
114  } else {
115  av_bprint_chars(buf, ' ', in_indent);
116  }
117 
118  /* Filter */
119  av_bprintf(buf, "|");
120  if (j == (height - 2) / 2) {
121  x = (width - lname) / 2;
122  av_bprintf(buf, "%*s%-*s", x, "", width - x, filter->name);
123  } else if (j == (height - 2) / 2 + 1) {
124  x = (width - ltype - 2) / 2;
125  av_bprintf(buf, "%*s(%s)%*s", x, "", filter->filter->name,
126  width - ltype - 2 - x, "");
127  } else {
128  av_bprint_chars(buf, ' ', width);
129  }
130  av_bprintf(buf, "|");
131 
132  /* Output link */
133  if (out_no < filter->nb_outputs) {
134  AVFilterLink *l = filter->outputs[out_no];
135  unsigned ln = strlen(l->dst->name) + 1 +
136  strlen(l->dstpad->name);
137  e = buf->len + max_out_name + 2;
138  av_bprintf(buf, "%s", l->srcpad->name);
139  av_bprint_chars(buf, '-', e - buf->len);
140  e = buf->len + max_out_fmt + 2 +
141  max_dst_name - ln;
142  print_link_prop(buf, l);
143  av_bprint_chars(buf, '-', e - buf->len);
144  av_bprintf(buf, "%s:%s", l->dst->name, l->dstpad->name);
145  }
146  av_bprintf(buf, "\n");
147  }
148  av_bprint_chars(buf, ' ', in_indent);
149  av_bprintf(buf, "+");
150  av_bprint_chars(buf, '-', width);
151  av_bprintf(buf, "+\n");
152  av_bprintf(buf, "\n");
153  }
154 }
155 
156 char *avfilter_graph_dump(AVFilterGraph *graph, const char *options)
157 {
158  AVBPrint buf;
159  char *dump = NULL;
160 
162  avfilter_graph_dump_to_buf(&buf, graph);
163  dump = av_malloc(buf.len + 1);
164  if (!dump)
165  return NULL;
166  av_bprint_init_for_buffer(&buf, dump, buf.len + 1);
167  avfilter_graph_dump_to_buf(&buf, graph);
168  return dump;
169 }
av_bprint_init
void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max)
Definition: bprint.c:69
pixdesc.h
avfilter_graph_dump_to_buf
static void avfilter_graph_dump_to_buf(AVBPrint *buf, AVFilterGraph *graph)
Definition: graphdump.c:64
filter
filter_frame For filters that do not use the this method is called when a frame is pushed to the filter s input It can be called at any time except in a reentrant way If the input frame is enough to produce then the filter should push the output frames on the output link immediately As an exception to the previous rule if the input frame is enough to produce several output frames then the filter needs output only at least one per link The additional frames can be left buffered in the filter
Definition: filter_design.txt:228
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
av_channel_layout_describe_bprint
int av_channel_layout_describe_bprint(const AVChannelLayout *channel_layout, AVBPrint *bp)
bprint variant of av_channel_layout_describe().
Definition: channel_layout.c:590
av_malloc
#define av_malloc(s)
Definition: tableprint_vlc.h:30
av_bprint_init_for_buffer
void av_bprint_init_for_buffer(AVBPrint *buf, char *buffer, unsigned size)
Init a print buffer using a pre-existing buffer.
Definition: bprint.c:85
AV_BPRINT_SIZE_COUNT_ONLY
#define AV_BPRINT_SIZE_COUNT_ONLY
AVFrame::ch_layout
AVChannelLayout ch_layout
Channel layout of the audio data.
Definition: frame.h:775
AVRational::num
int num
Numerator.
Definition: rational.h:59
width
#define width
format
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample format(the sample packing is implied by the sample format) and sample rate. The lists are not just lists
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
av_get_sample_fmt_name
const char * av_get_sample_fmt_name(enum AVSampleFormat sample_fmt)
Return the name of sample_fmt, or NULL if sample_fmt is not recognized.
Definition: samplefmt.c:51
link
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a link
Definition: filter_design.txt:23
NULL
#define NULL
Definition: coverity.c:32
AVFilterGraph::filters
AVFilterContext ** filters
Definition: avfilter.h:815
AVFilterContext::name
char * name
name of this filter instance
Definition: avfilter.h:412
AVFilterGraph
Definition: avfilter.h:813
options
const OptionDef options[]
AVFrame::sample_rate
int sample_rate
Sample rate of the audio data.
Definition: frame.h:573
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:461
height
#define height
internal.h
bprint.h
print_link_prop
static int print_link_prop(AVBPrint *buf, AVFilterLink *link)
Definition: graphdump.c:31
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:39
avfilter_graph_dump
char * avfilter_graph_dump(AVFilterGraph *graph, const char *options)
Dump a graph into a human-readable string representation.
Definition: graphdump.c:156
av_bprintf
void av_bprintf(AVBPrint *buf, const char *fmt,...)
Definition: bprint.c:99
AVFrame::sample_aspect_ratio
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
Definition: frame.h:481
channel_layout.h
AVRational::den
int den
Denominator.
Definition: rational.h:60
avfilter.h
AVFilterContext
An instance of a filter.
Definition: avfilter.h:407
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
mem.h
FFMAX3
#define FFMAX3(a, b, c)
Definition: macros.h:48
av_bprint_chars
void av_bprint_chars(AVBPrint *buf, char c, unsigned n)
Append char c n times to a print buffer.
Definition: bprint.c:145
AVFilterGraph::nb_filters
unsigned nb_filters
Definition: avfilter.h:816
av_x_if_null
static void * av_x_if_null(const void *p, const void *x)
Return x default pointer in case p is NULL.
Definition: avutil.h:312
av_get_pix_fmt_name
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:2885