FFmpeg
vf_transpose_opencl.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 #include <float.h>
19 
20 #include "libavutil/common.h"
21 #include "libavutil/imgutils.h"
22 #include "libavutil/opt.h"
23 #include "libavutil/pixdesc.h"
24 
25 #include "avfilter.h"
26 #include "internal.h"
27 #include "opencl.h"
28 #include "opencl_source.h"
29 #include "video.h"
30 #include "transpose.h"
31 
32 typedef struct TransposeOpenCLContext {
35  int passthrough; ///< PassthroughType, landscape passthrough mode enabled
36  int dir; ///< TransposeDir
37  cl_kernel kernel;
38  cl_command_queue command_queue;
40 
42 {
44  cl_int cle;
45  int err;
46 
48  if (err < 0)
49  goto fail;
50 
51  ctx->command_queue = clCreateCommandQueue(ctx->ocf.hwctx->context,
52  ctx->ocf.hwctx->device_id,
53  0, &cle);
54  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create OpenCL "
55  "command queue %d.\n", cle);
56 
57  ctx->kernel = clCreateKernel(ctx->ocf.program, "transpose", &cle);
58  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create kernel %d.\n", cle);
59 
60 
61  ctx->initialised = 1;
62  return 0;
63 
64 fail:
65  if (ctx->command_queue)
66  clReleaseCommandQueue(ctx->command_queue);
67  if (ctx->kernel)
68  clReleaseKernel(ctx->kernel);
69  return err;
70 }
71 
73 {
74  AVFilterContext *avctx = outlink->src;
75  TransposeOpenCLContext *s = avctx->priv;
76  AVFilterLink *inlink = avctx->inputs[0];
77  const AVPixFmtDescriptor *desc_in = av_pix_fmt_desc_get(inlink->format);
78  int ret;
79 
80  if ((inlink->w >= inlink->h &&
81  s->passthrough == TRANSPOSE_PT_TYPE_LANDSCAPE) ||
82  (inlink->w <= inlink->h &&
83  s->passthrough == TRANSPOSE_PT_TYPE_PORTRAIT)) {
84  if (inlink->hw_frames_ctx) {
85  outlink->hw_frames_ctx = av_buffer_ref(inlink->hw_frames_ctx);
86  if (!outlink->hw_frames_ctx)
87  return AVERROR(ENOMEM);
88  }
89  av_log(avctx, AV_LOG_VERBOSE,
90  "w:%d h:%d -> w:%d h:%d (passthrough mode)\n",
91  inlink->w, inlink->h, inlink->w, inlink->h);
92 
93  return 0;
94  } else {
95  s->passthrough = TRANSPOSE_PT_TYPE_NONE;
96  }
97 
98  if (desc_in->log2_chroma_w != desc_in->log2_chroma_h) {
99  av_log(avctx, AV_LOG_ERROR, "Input format %s not supported.\n",
100  desc_in->name);
101  return AVERROR(EINVAL);
102  }
103 
104  s->ocf.output_width = inlink->h;
105  s->ocf.output_height = inlink->w;
107  if (ret < 0)
108  return ret;
109 
110  if (inlink->sample_aspect_ratio.num)
111  outlink->sample_aspect_ratio = av_div_q((AVRational) { 1, 1 },
112  inlink->sample_aspect_ratio);
113  else
114  outlink->sample_aspect_ratio = inlink->sample_aspect_ratio;
115 
116  av_log(avctx, AV_LOG_VERBOSE,
117  "w:%d h:%d dir:%d -> w:%d h:%d rotation:%s vflip:%d\n",
118  inlink->w, inlink->h, s->dir, outlink->w, outlink->h,
119  s->dir == 1 || s->dir == 3 ? "clockwise" : "counterclockwise",
120  s->dir == 0 || s->dir == 3);
121  return 0;
122 }
123 
125 {
126  TransposeOpenCLContext *s = inlink->dst->priv;
127 
128  return s->passthrough ?
131 }
132 
134 {
135  AVFilterContext *avctx = inlink->dst;
136  AVFilterLink *outlink = avctx->outputs[0];
137  TransposeOpenCLContext *ctx = avctx->priv;
138  AVFrame *output = NULL;
139  size_t global_work[2];
140  cl_mem src, dst;
141  cl_int cle;
142  int err, p;
143 
144  av_log(ctx, AV_LOG_DEBUG, "Filter input: %s, %ux%u (%"PRId64").\n",
145  av_get_pix_fmt_name(input->format),
146  input->width, input->height, input->pts);
147 
148  if (!input->hw_frames_ctx)
149  return AVERROR(EINVAL);
150 
151  if (ctx->passthrough)
152  return ff_filter_frame(outlink, input);
153 
154  output = ff_get_video_buffer(outlink, outlink->w, outlink->h);
155  if (!output) {
156  err = AVERROR(ENOMEM);
157  goto fail;
158  }
159 
161  if (err < 0)
162  goto fail;
163 
164  if (input->sample_aspect_ratio.num == 0) {
165  output->sample_aspect_ratio = input->sample_aspect_ratio;
166  } else {
167  output->sample_aspect_ratio.num = input->sample_aspect_ratio.den;
168  output->sample_aspect_ratio.den = input->sample_aspect_ratio.num;
169  }
170 
171  if (!ctx->initialised) {
172  err = transpose_opencl_init(avctx);
173  if (err < 0)
174  goto fail;
175  }
176 
177  for (p = 0; p < FF_ARRAY_ELEMS(output->data); p++) {
178  src = (cl_mem) input->data[p];
179  dst = (cl_mem) output->data[p];
180 
181  if (!dst)
182  break;
183  CL_SET_KERNEL_ARG(ctx->kernel, 0, cl_mem, &dst);
184  CL_SET_KERNEL_ARG(ctx->kernel, 1, cl_mem, &src);
185  CL_SET_KERNEL_ARG(ctx->kernel, 2, cl_int, &ctx->dir);
186 
187  err = ff_opencl_filter_work_size_from_image(avctx, global_work, output,
188  p, 16);
189 
190  cle = clEnqueueNDRangeKernel(ctx->command_queue, ctx->kernel, 2, NULL,
191  global_work, NULL,
192  0, NULL, NULL);
193  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue kernel: %d.\n", cle);
194  }
195  cle = clFinish(ctx->command_queue);
196  CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to finish command queue: %d.\n", cle);
197 
199 
200  av_log(ctx, AV_LOG_DEBUG, "Filter output: %s, %ux%u (%"PRId64").\n",
201  av_get_pix_fmt_name(output->format),
202  output->width, output->height, output->pts);
203 
204  return ff_filter_frame(outlink, output);
205 
206 fail:
207  clFinish(ctx->command_queue);
210  return err;
211 }
212 
214 {
215  TransposeOpenCLContext *ctx = avctx->priv;
216  cl_int cle;
217 
218  if (ctx->kernel) {
219  cle = clReleaseKernel(ctx->kernel);
220  if (cle != CL_SUCCESS)
221  av_log(avctx, AV_LOG_ERROR, "Failed to release "
222  "kernel: %d.\n", cle);
223  }
224 
225  if (ctx->command_queue) {
226  cle = clReleaseCommandQueue(ctx->command_queue);
227  if (cle != CL_SUCCESS)
228  av_log(avctx, AV_LOG_ERROR, "Failed to release "
229  "command queue: %d.\n", cle);
230  }
231 
233 }
234 
235 #define OFFSET(x) offsetof(TransposeOpenCLContext, x)
236 #define FLAGS (AV_OPT_FLAG_FILTERING_PARAM | AV_OPT_FLAG_VIDEO_PARAM)
238  { "dir", "set transpose direction", OFFSET(dir), AV_OPT_TYPE_INT, { .i64 = TRANSPOSE_CCLOCK_FLIP }, 0, 3, FLAGS, "dir" },
239  { "cclock_flip", "rotate counter-clockwise with vertical flip", 0, AV_OPT_TYPE_CONST, { .i64 = TRANSPOSE_CCLOCK_FLIP }, .flags=FLAGS, .unit = "dir" },
240  { "clock", "rotate clockwise", 0, AV_OPT_TYPE_CONST, { .i64 = TRANSPOSE_CLOCK }, .flags=FLAGS, .unit = "dir" },
241  { "cclock", "rotate counter-clockwise", 0, AV_OPT_TYPE_CONST, { .i64 = TRANSPOSE_CCLOCK }, .flags=FLAGS, .unit = "dir" },
242  { "clock_flip", "rotate clockwise with vertical flip", 0, AV_OPT_TYPE_CONST, { .i64 = TRANSPOSE_CLOCK_FLIP }, .flags=FLAGS, .unit = "dir" },
243 
244  { "passthrough", "do not apply transposition if the input matches the specified geometry",
245  OFFSET(passthrough), AV_OPT_TYPE_INT, {.i64=TRANSPOSE_PT_TYPE_NONE}, 0, INT_MAX, FLAGS, "passthrough" },
246  { "none", "always apply transposition", 0, AV_OPT_TYPE_CONST, {.i64=TRANSPOSE_PT_TYPE_NONE}, INT_MIN, INT_MAX, FLAGS, "passthrough" },
247  { "portrait", "preserve portrait geometry", 0, AV_OPT_TYPE_CONST, {.i64=TRANSPOSE_PT_TYPE_PORTRAIT}, INT_MIN, INT_MAX, FLAGS, "passthrough" },
248  { "landscape", "preserve landscape geometry", 0, AV_OPT_TYPE_CONST, {.i64=TRANSPOSE_PT_TYPE_LANDSCAPE}, INT_MIN, INT_MAX, FLAGS, "passthrough" },
249 
250  { NULL }
251 };
252 
253 AVFILTER_DEFINE_CLASS(transpose_opencl);
254 
256  {
257  .name = "default",
258  .type = AVMEDIA_TYPE_VIDEO,
259  .get_buffer.video = get_video_buffer,
260  .filter_frame = &transpose_opencl_filter_frame,
261  .config_props = &ff_opencl_filter_config_input,
262  },
263 };
264 
266  {
267  .name = "default",
268  .type = AVMEDIA_TYPE_VIDEO,
269  .config_props = &transpose_opencl_config_output,
270  },
271 };
272 
274  .name = "transpose_opencl",
275  .description = NULL_IF_CONFIG_SMALL("Transpose input video"),
276  .priv_size = sizeof(TransposeOpenCLContext),
277  .priv_class = &transpose_opencl_class,
283  .flags_internal = FF_FILTER_FLAG_HWFRAME_AWARE,
284 };
ff_get_video_buffer
AVFrame * ff_get_video_buffer(AVFilterLink *link, int w, int h)
Request a picture buffer with a specific set of permissions.
Definition: video.c:98
TransposeOpenCLContext::ocf
OpenCLFilterContext ocf
Definition: vf_transpose_opencl.c:33
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:31
AVERROR
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 all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
opt.h
CL_SET_KERNEL_ARG
#define CL_SET_KERNEL_ARG(kernel, arg_num, type, arg)
set argument to specific Kernel.
Definition: opencl.h:61
FF_FILTER_FLAG_HWFRAME_AWARE
#define FF_FILTER_FLAG_HWFRAME_AWARE
The filter is aware of hardware frames, and any hardware frame context should not be automatically pr...
Definition: internal.h:371
ff_filter_frame
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1018
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2564
transpose_opencl_outputs
static const AVFilterPad transpose_opencl_outputs[]
Definition: vf_transpose_opencl.c:265
av_div_q
AVRational av_div_q(AVRational b, AVRational c)
Divide one rational by another.
Definition: rational.c:88
transpose_opencl_init
static int transpose_opencl_init(AVFilterContext *avctx)
Definition: vf_transpose_opencl.c:41
output
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 output
Definition: filter_design.txt:225
inlink
The exact code depends on how similar the blocks are and how related they are to the and needs to apply these operations to the correct inlink or outlink if there are several Macros are available to factor that when no extra processing is inlink
Definition: filter_design.txt:212
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
FLAGS
#define FLAGS
Definition: vf_transpose_opencl.c:236
w
uint8_t w
Definition: llviddspenc.c:38
AVPixFmtDescriptor::name
const char * name
Definition: pixdesc.h:70
opencl.h
AVOption
AVOption.
Definition: opt.h:247
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:196
float.h
TRANSPOSE_CLOCK_FLIP
@ TRANSPOSE_CLOCK_FLIP
Definition: transpose.h:34
ff_opencl_filter_load_program
int ff_opencl_filter_load_program(AVFilterContext *avctx, const char **program_source_array, int nb_strings)
Load a new OpenCL program from strings in memory.
Definition: opencl.c:156
av_buffer_ref
AVBufferRef * av_buffer_ref(const AVBufferRef *buf)
Create a new reference to an AVBuffer.
Definition: buffer.c:103
AVFilter::name
const char * name
Filter name.
Definition: avfilter.h:153
video.h
transpose_opencl_config_output
static int transpose_opencl_config_output(AVFilterLink *outlink)
Definition: vf_transpose_opencl.c:72
TRANSPOSE_CCLOCK
@ TRANSPOSE_CCLOCK
Definition: transpose.h:33
ff_default_get_video_buffer
AVFrame * ff_default_get_video_buffer(AVFilterLink *link, int w, int h)
Definition: video.c:43
ff_opencl_filter_work_size_from_image
int ff_opencl_filter_work_size_from_image(AVFilterContext *avctx, size_t *work_size, AVFrame *frame, int plane, int block_alignment)
Find the work size needed needed for a given plane of an image.
Definition: opencl.c:263
AVFilterContext::priv
void * priv
private data for use by the filter
Definition: avfilter.h:401
get_video_buffer
static AVFrame * get_video_buffer(AVFilterLink *inlink, int w, int h)
Definition: vf_transpose_opencl.c:124
fail
#define fail()
Definition: checkasm.h:127
ff_opencl_filter_config_output
int ff_opencl_filter_config_output(AVFilterLink *outlink)
Create a suitable hardware frames context for the output.
Definition: opencl.c:81
AVFilterPad
A filter pad used for either input or output.
Definition: internal.h:50
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
FF_ARRAY_ELEMS
#define FF_ARRAY_ELEMS(a)
Definition: sinewin_tablegen.c:29
av_cold
#define av_cold
Definition: attributes.h:90
TransposeOpenCLContext
Definition: vf_transpose_opencl.c:32
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVPixFmtDescriptor::log2_chroma_w
uint8_t log2_chroma_w
Amount to shift the luma width right to find the chroma width.
Definition: pixdesc.h:80
FILTER_INPUTS
#define FILTER_INPUTS(array)
Definition: internal.h:191
TransposeOpenCLContext::initialised
int initialised
Definition: vf_transpose_opencl.c:34
NULL
#define NULL
Definition: coverity.c:32
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:537
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVFilterContext::inputs
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:394
src
#define src
Definition: vp8dsp.c:255
ff_vf_transpose_opencl
const AVFilter ff_vf_transpose_opencl
Definition: vf_transpose_opencl.c:273
AV_PIX_FMT_OPENCL
@ AV_PIX_FMT_OPENCL
Hardware surfaces for OpenCL.
Definition: pixfmt.h:325
TRANSPOSE_PT_TYPE_PORTRAIT
@ TRANSPOSE_PT_TYPE_PORTRAIT
Definition: transpose.h:27
transpose_opencl_inputs
static const AVFilterPad transpose_opencl_inputs[]
Definition: vf_transpose_opencl.c:255
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
TRANSPOSE_PT_TYPE_NONE
@ TRANSPOSE_PT_TYPE_NONE
Definition: transpose.h:25
TransposeOpenCLContext::kernel
cl_kernel kernel
Definition: vf_transpose_opencl.c:37
opencl_source.h
input
and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some input
Definition: filter_design.txt:172
ff_opencl_filter_config_input
int ff_opencl_filter_config_input(AVFilterLink *inlink)
Check that the input link contains a suitable hardware frames context and extract the device from it.
Definition: opencl.c:45
ff_null_get_video_buffer
AVFrame * ff_null_get_video_buffer(AVFilterLink *link, int w, int h)
Definition: video.c:38
internal.h
FILTER_SINGLE_PIXFMT
#define FILTER_SINGLE_PIXFMT(pix_fmt_)
Definition: internal.h:181
TransposeOpenCLContext::command_queue
cl_command_queue command_queue
Definition: vf_transpose_opencl.c:38
common.h
transpose_opencl_filter_frame
static int transpose_opencl_filter_frame(AVFilterLink *inlink, AVFrame *input)
Definition: vf_transpose_opencl.c:133
TRANSPOSE_CLOCK
@ TRANSPOSE_CLOCK
Definition: transpose.h:32
AVFilterPad::name
const char * name
Pad name.
Definition: internal.h:56
TransposeOpenCLContext::dir
int dir
TransposeDir.
Definition: vf_transpose_opencl.c:36
AVFilter
Filter definition.
Definition: avfilter.h:149
ff_opencl_filter_init
int ff_opencl_filter_init(AVFilterContext *avctx)
Initialise an OpenCL filter context.
Definition: opencl.c:132
ret
ret
Definition: filter_design.txt:187
TransposeOpenCLContext::passthrough
int passthrough
PassthroughType, landscape passthrough mode enabled.
Definition: vf_transpose_opencl.c:35
TRANSPOSE_CCLOCK_FLIP
@ TRANSPOSE_CCLOCK_FLIP
Definition: transpose.h:31
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:224
avfilter.h
transpose.h
OpenCLFilterContext
Definition: opencl.h:36
ff_opencl_filter_uninit
void ff_opencl_filter_uninit(AVFilterContext *avctx)
Uninitialise an OpenCL filter context.
Definition: opencl.c:141
AVFilterContext
An instance of a filter.
Definition: avfilter.h:386
TRANSPOSE_PT_TYPE_LANDSCAPE
@ TRANSPOSE_PT_TYPE_LANDSCAPE
Definition: transpose.h:26
OFFSET
#define OFFSET(x)
Definition: vf_transpose_opencl.c:235
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
AVFILTER_DEFINE_CLASS
AVFILTER_DEFINE_CLASS(transpose_opencl)
FILTER_OUTPUTS
#define FILTER_OUTPUTS(array)
Definition: internal.h:192
imgutils.h
ff_opencl_source_transpose
const char * ff_opencl_source_transpose
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
CL_FAIL_ON_ERROR
#define CL_FAIL_ON_ERROR(errcode,...)
A helper macro to handle OpenCL errors.
Definition: opencl.h:74
uninit
static av_cold int uninit(AVCodecContext *avctx)
Definition: crystalhd.c:279
h
h
Definition: vp9dsp_template.c:2038
transpose_opencl_uninit
static av_cold void transpose_opencl_uninit(AVFilterContext *avctx)
Definition: vf_transpose_opencl.c:213
transpose_opencl_options
static const AVOption transpose_opencl_options[]
Definition: vf_transpose_opencl.c:237
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:233
AVPixFmtDescriptor::log2_chroma_h
uint8_t log2_chroma_h
Amount to shift the luma height right to find the chroma height.
Definition: pixdesc.h:89
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:2484
AVFilterContext::outputs
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:398