Libav
vf_hwdownload.c
Go to the documentation of this file.
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "libavutil/buffer.h"
20 #include "libavutil/hwcontext.h"
21 #include "libavutil/log.h"
22 #include "libavutil/mem.h"
23 #include "libavutil/opt.h"
24 #include "libavutil/pixdesc.h"
25 
26 #include "avfilter.h"
27 #include "formats.h"
28 #include "internal.h"
29 #include "video.h"
30 
31 typedef struct HWDownloadContext {
32  const AVClass *class;
33 
37 
39 {
40  AVFilterFormats *infmts = NULL;
41  AVFilterFormats *outfmts = NULL;
42  const AVPixFmtDescriptor *desc;
43  int err;
44 
45  for (desc = av_pix_fmt_desc_next(NULL); desc;
46  desc = av_pix_fmt_desc_next(desc)) {
47  if (desc->flags & AV_PIX_FMT_FLAG_HWACCEL)
48  err = ff_add_format(&infmts, av_pix_fmt_desc_get_id(desc));
49  else
50  err = ff_add_format(&outfmts, av_pix_fmt_desc_get_id(desc));
51  if (err) {
52  ff_formats_unref(&infmts);
53  ff_formats_unref(&outfmts);
54  return err;
55  }
56  }
57 
58  ff_formats_ref(infmts, &avctx->inputs[0]->out_formats);
59  ff_formats_ref(outfmts, &avctx->outputs[0]->in_formats);
60  return 0;
61 }
62 
64 {
65  AVFilterContext *avctx = inlink->dst;
66  HWDownloadContext *ctx = avctx->priv;
67 
69 
70  if (!inlink->hw_frames_ctx) {
71  av_log(ctx, AV_LOG_ERROR, "The input must have a hardware frame "
72  "reference.\n");
73  return AVERROR(EINVAL);
74  }
75 
77  if (!ctx->hwframes_ref)
78  return AVERROR(ENOMEM);
79 
81 
82  return 0;
83 }
84 
86 {
87  AVFilterContext *avctx = outlink->src;
88  AVFilterLink *inlink = avctx->inputs[0];
89  HWDownloadContext *ctx = avctx->priv;
90  enum AVPixelFormat *formats;
91  int err, i, found;
92 
93  if (!ctx->hwframes_ref)
94  return AVERROR(EINVAL);
95 
98  &formats, 0);
99  if (err < 0)
100  return err;
101 
102  found = 0;
103  for (i = 0; formats[i] != AV_PIX_FMT_NONE; i++) {
104  if (formats[i] == outlink->format) {
105  found = 1;
106  break;
107  }
108  }
109  av_freep(&formats);
110 
111  if (!found) {
112  av_log(ctx, AV_LOG_ERROR, "Invalid output format %s for hwframe "
113  "download.\n", av_get_pix_fmt_name(outlink->format));
114  return AVERROR(EINVAL);
115  }
116 
117  outlink->w = inlink->w;
118  outlink->h = inlink->h;
119 
120  return 0;
121 }
122 
124 {
125  AVFilterContext *avctx = link->dst;
126  AVFilterLink *outlink = avctx->outputs[0];
127  HWDownloadContext *ctx = avctx->priv;
128  AVFrame *output = NULL;
129  int err;
130 
131  if (!ctx->hwframes_ref || !input->hw_frames_ctx) {
132  av_log(ctx, AV_LOG_ERROR, "Input frames must have hardware context.\n");
133  err = AVERROR(EINVAL);
134  goto fail;
135  }
136  if ((void*)ctx->hwframes != input->hw_frames_ctx->data) {
137  av_log(ctx, AV_LOG_ERROR, "Input frame is not the in the configured "
138  "hwframe context.\n");
139  err = AVERROR(EINVAL);
140  goto fail;
141  }
142 
143  output = ff_get_video_buffer(outlink, ctx->hwframes->width,
144  ctx->hwframes->height);
145  if (!output) {
146  err = AVERROR(ENOMEM);
147  goto fail;
148  }
149 
150  err = av_hwframe_transfer_data(output, input, 0);
151  if (err < 0) {
152  av_log(ctx, AV_LOG_ERROR, "Failed to download frame: %d.\n", err);
153  goto fail;
154  }
155 
156  output->width = outlink->w;
157  output->height = outlink->h;
158 
159  err = av_frame_copy_props(output, input);
160  if (err < 0)
161  goto fail;
162 
163  av_frame_free(&input);
164 
165  return ff_filter_frame(avctx->outputs[0], output);
166 
167 fail:
168  av_frame_free(&input);
169  av_frame_free(&output);
170  return err;
171 }
172 
174 {
175  HWDownloadContext *ctx = avctx->priv;
176 
178 }
179 
180 static const AVClass hwdownload_class = {
181  .class_name = "hwdownload",
182  .item_name = av_default_item_name,
183  .option = NULL,
184  .version = LIBAVUTIL_VERSION_INT,
185 };
186 
187 static const AVFilterPad hwdownload_inputs[] = {
188  {
189  .name = "default",
190  .type = AVMEDIA_TYPE_VIDEO,
191  .config_props = hwdownload_config_input,
192  .filter_frame = hwdownload_filter_frame,
193  },
194  { NULL }
195 };
196 
197 static const AVFilterPad hwdownload_outputs[] = {
198  {
199  .name = "default",
200  .type = AVMEDIA_TYPE_VIDEO,
201  .config_props = hwdownload_config_output,
202  },
203  { NULL }
204 };
205 
207  .name = "hwdownload",
208  .description = NULL_IF_CONFIG_SMALL("Download a hardware frame to a normal frame"),
209  .uninit = hwdownload_uninit,
210  .query_formats = hwdownload_query_formats,
211  .priv_size = sizeof(HWDownloadContext),
212  .priv_class = &hwdownload_class,
213  .inputs = hwdownload_inputs,
214  .outputs = hwdownload_outputs,
215 };
static av_cold void hwdownload_uninit(AVFilterContext *avctx)
void av_buffer_unref(AVBufferRef **buf)
Free a given reference and automatically free the buffer if there are no more references to it...
Definition: buffer.c:106
This structure describes decoded (raw) audio or video data.
Definition: frame.h:140
static const AVFilterPad outputs[]
Definition: af_ashowinfo.c:259
Main libavfilter public API header.
memory handling functions
const char * desc
Definition: nvenc.c:101
av_log(ac->avr, AV_LOG_TRACE, "%d samples - audio_convert: %s to %s (%s)\, len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt), use_generic ? ac->func_descr_generic :ac->func_descr)
static enum AVSampleFormat formats[]
Definition: avresample.c:163
int width
The allocated dimensions of the frames in this pool.
Definition: hwcontext.h:222
static int hwdownload_filter_frame(AVFilterLink *link, AVFrame *input)
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:57
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:202
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame...
Definition: frame.h:365
const char * name
Pad name.
Definition: internal.h:41
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:39
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:270
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:747
static const AVFilterPad hwdownload_inputs[]
#define av_cold
Definition: attributes.h:66
AVOptions.
AVFilter ff_vf_hwdownload
static const AVClass hwdownload_class
A filter pad used for either input or output.
Definition: internal.h:35
int width
width and height of the video frame
Definition: frame.h:179
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:124
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:80
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:148
void * priv
private data for use by the filter
Definition: avfilter.h:277
#define AV_PIX_FMT_FLAG_HWACCEL
Pixel format is an HW accelerated format.
Definition: pixdesc.h:142
#define fail()
Definition: checkasm.h:80
int av_hwframe_transfer_data(AVFrame *dst, const AVFrame *src, int flags)
Copy data to or from a hw surface.
Definition: hwcontext.c:368
uint64_t flags
Combination of AV_PIX_FMT_FLAG_...
Definition: pixdesc.h:105
enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc)
Definition: pixdesc.c:1784
Transfer the data from the queried hw frame.
Definition: hwcontext.h:340
static int hwdownload_config_output(AVFilterLink *outlink)
Definition: vf_hwdownload.c:85
AVFormatContext * ctx
Definition: movenc.c:48
AVHWFramesContext * hwframes
Definition: vf_hwdownload.c:35
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
static int hwdownload_config_input(AVFilterLink *inlink)
Definition: vf_hwdownload.c:63
NULL
Definition: eval.c:55
void ff_formats_ref(AVFilterFormats *f, AVFilterFormats **ref)
Add *ref as a new reference to formats.
Definition: formats.c:276
av_default_item_name
Definition: dnxhdenc.c:55
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:80
uint8_t * data
The data buffer.
Definition: buffer.h:89
Describe the class of an AVClass context structure.
Definition: log.h:34
Filter definition.
Definition: avfilter.h:120
static const AVFilterPad inputs[]
Definition: af_ashowinfo.c:248
This struct describes a set or pool of "hardware" frames (i.e.
Definition: hwcontext.h:117
refcounted data buffer API
void ff_formats_unref(AVFilterFormats **ref)
If *ref is non-NULL, remove *ref as a reference to the format list it currently points to...
Definition: formats.c:312
const char * name
Filter name.
Definition: avfilter.h:124
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:274
static const AVFilterPad hwdownload_outputs[]
A reference to a data buffer.
Definition: buffer.h:81
AVBufferRef * av_buffer_ref(AVBufferRef *buf)
Create a new reference to an AVBuffer.
Definition: buffer.c:92
int ff_add_format(AVFilterFormats **avff, int fmt)
Add fmt to the list of media formats contained in *avff.
Definition: formats.c:208
static int hwdownload_query_formats(AVFilterContext *avctx)
Definition: vf_hwdownload.c:38
A list of supported formats for one end of a filter link.
Definition: formats.h:64
An instance of a filter.
Definition: avfilter.h:262
AVBufferRef * hwframes_ref
Definition: vf_hwdownload.c:34
int height
Definition: frame.h:179
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:1704
internal API functions
AVPixelFormat
Pixel format.
Definition: pixfmt.h:57
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:386
int av_hwframe_transfer_get_formats(AVBufferRef *hwframe_ref, enum AVHWFrameTransferDirection dir, enum AVPixelFormat **formats, int flags)
Get a list of possible source or target formats usable in av_hwframe_transfer_data().
Definition: hwcontext.c:310
const AVPixFmtDescriptor * av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev)
Iterate over all pixel format descriptors known to libavutil.
Definition: pixdesc.c:1775