3 * Copyright (c) 2002 Philip Gladstone
5 * This module implements a text overlay for a video image. Currently it
6 * supports a fixed overlay or reading the text from a file. The string
7 * is passed through strftime so that it is easy to imprint the date and
10 * You may also overlay an image (even semi-transparent) like TV stations do.
11 * You may move either the text or the image around your video to create
12 * scrolling credits, for example.
14 * Text fonts are being looked for in FONTPATH
18 * -C <rgb.txt> The filename to read RGB color names from
19 * Defaults if none specified:
20 * /usr/share/X11/rgb.txt
21 * /usr/lib/X11/rgb.txt
22 * -c <color> The color of the text
23 * -F <fontname> The font face and size
25 * -f <filename> The filename to read text from
26 * -x <expression> X coordinate of text or image
27 * -y <expression> Y coordinate of text or image
28 * -i <filename> The filename to read a image from
29 * -R <expression> Value for R color
30 * -G <expression> Value for G color
31 * -B <expression> Value for B color
32 * -A <expression> Value for Alpha channel
34 * Expressions are functions of:
35 * N // frame number (starting at zero)
46 FONTPATH="/cygdrive/c/WINDOWS/Fonts/"
47 FONTPATH="$FONTPATH:/usr/share/imlib2/data/fonts/"
48 FONTPATH="$FONTPATH:/usr/X11R6/lib/X11/fonts/TTF/"
51 ffmpeg -i input.avi -vhook \
52 'vhook/imlib2.dll -x W*(0.5+0.25*sin(N/47*PI))-w/2 -y H*(0.5+0.50*cos(N/97*PI))-h/2 -i /usr/share/imlib2/data/images/bulb.png'
53 -acodec copy -sameq output.avi
55 ffmpeg -i input.avi -vhook \
56 'vhook/imlib2.dll -c red -F Vera.ttf/20 -x 150+0.5*N -y 70+0.25*N -t Hello'
57 -acodec copy -sameq output.avi
59 * This module is very much intended as an example of what could be done.
61 * One caution is that this is an expensive process -- in particular the
62 * conversion of the image into RGB and back is time consuming. For some
63 * special cases -- e.g. painting black text -- it would be faster to paint
64 * the text into a bitmap and then combine it directly into the YUV
65 * image. However, this code is fast enough to handle 10 fps of 320x240 on a
66 * 900MHz Duron in maybe 15% of the CPU.
68 * See further statistics on Pentium4, 3GHz, FFMpeg is SVN-r6798
69 * Input movie is 20.2 seconds of PAL DV on AVI
70 * Output movie is DVD compliant VOB.
72 ffmpeg -i input.avi -target pal-dvd out.vob
73 # 13.516s just transcode
74 ffmpeg -i input.avi -vhook /usr/local/bin/vhook/null.dll -target pal-dvd out.vob
75 # 23.546s transcode and img_convert
76 ffmpeg -i input.avi -vhook \
77 'vhook/imlib2.dll -c red -F Vera/20 -x 150-0.5*N -y 70+0.25*N -t Hello_person' \
78 -target pal-dvd out.vob
79 # 21.454s transcode, img_convert and move text around
80 ffmpeg -i input.avi -vhook \
81 'vhook/imlib2.dll -x 150-0.5*N -y 70+0.25*N -i /usr/share/imlib2/data/images/bulb.png' \
82 -target pal-dvd out.vob
83 # 20.828s transcode, img_convert and move image around
85 * This file is part of FFmpeg.
87 * FFmpeg is free software; you can redistribute it and/or
88 * modify it under the terms of the GNU Lesser General Public
89 * License as published by the Free Software Foundation; either
90 * version 2.1 of the License, or (at your option) any later version.
92 * FFmpeg is distributed in the hope that it will be useful,
93 * but WITHOUT ANY WARRANTY; without even the implied warranty of
94 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
95 * Lesser General Public License for more details.
97 * You should have received a copy of the GNU Lesser General Public
98 * License along with FFmpeg; if not, write to the Free Software
99 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
102 #include "framehook.h"
112 #include <sys/time.h>
117 const char *const_names
[]={
120 "N", // frame number (starting at zero)
130 static int sws_flags
= SWS_BICUBIC
;
138 AVEvalExpr
*eval_r
, *eval_g
, *eval_b
, *eval_a
;
139 char *expr_R
, *expr_G
, *expr_B
, *expr_A
;
143 struct _CachedImage
*cache
;
144 Imlib_Image imageOverlaid
;
145 AVEvalExpr
*eval_x
, *eval_y
;
146 char *expr_x
, *expr_y
;
148 int imageOverlaid_width
, imageOverlaid_height
;
150 // This vhook first converts frame to RGB ...
151 struct SwsContext
*toRGB_convert_ctx
;
152 // ... and then converts back frame from RGB to initial format
153 struct SwsContext
*fromRGB_convert_ctx
;
156 typedef struct _CachedImage
{
157 struct _CachedImage
*next
;
163 void Release(void *ctx
)
166 ci
= (ContextInfo
*) ctx
;
169 imlib_context_set_image(ci
->cache
->image
);
174 if (ci
->imageOverlaid
) {
175 imlib_context_set_image(ci
->imageOverlaid
);
178 ff_eval_free(ci
->eval_x
);
179 ff_eval_free(ci
->eval_y
);
180 ff_eval_free(ci
->eval_r
);
181 ff_eval_free(ci
->eval_g
);
182 ff_eval_free(ci
->eval_b
);
183 ff_eval_free(ci
->eval_a
);
191 sws_freeContext(ci
->toRGB_convert_ctx
);
192 sws_freeContext(ci
->fromRGB_convert_ctx
);
197 int Configure(void **ctxp
, int argc
, char *argv
[])
202 char *font
= "LucidaSansDemiBold/16";
203 char *fp
= getenv("FONTPATH");
208 *ctxp
= av_mallocz(sizeof(ContextInfo
));
209 ci
= (ContextInfo
*) *ctxp
;
218 /* Use ':' to split FONTPATH */
220 while (p
= strchr(fp
, ':')) {
222 imlib_add_path_to_font_path(fp
);
226 imlib_add_path_to_font_path(fp
);
229 while ((c
= getopt(argc
, argv
, "R:G:B:A:C:c:f:F:t:x:y:i:")) > 0) {
232 ci
->expr_R
= av_strdup(optarg
);
236 ci
->expr_G
= av_strdup(optarg
);
240 ci
->expr_B
= av_strdup(optarg
);
244 ci
->expr_A
= av_strdup(optarg
);
256 ci
->text
= av_strdup(optarg
);
259 ci
->file
= av_strdup(optarg
);
262 ci
->expr_x
= av_strdup(optarg
);
265 ci
->expr_y
= av_strdup(optarg
);
268 ci
->fileImage
= av_strdup(optarg
);
271 fprintf(stderr
, "Unrecognized argument '%s'\n", argv
[optind
]);
276 if (ci
->eval_colors
&& !(ci
->expr_R
&& ci
->expr_G
&& ci
->expr_B
))
278 fprintf(stderr
, "You must specify expressions for all or no colors.\n");
282 if (ci
->text
|| ci
->file
) {
283 ci
->fn
= imlib_load_font(font
);
285 fprintf(stderr
, "Failed to load font '%s'\n", font
);
288 imlib_context_set_font(ci
->fn
);
289 imlib_context_set_direction(IMLIB_TEXT_TO_RIGHT
);
298 fprintf(stderr
, "You must not specify both a color name and expressions for the colors.\n");
303 f
= fopen(rgbtxt
, "r");
306 f
= fopen("/usr/share/X11/rgb.txt", "r");
308 f
= fopen("/usr/lib/X11/rgb.txt", "r");
311 fprintf(stderr
, "Failed to find RGB color names file\n");
314 while (fgets(buff
, sizeof(buff
), f
)) {
318 if (sscanf(buff
, "%d %d %d %64s", &r
, &g
, &b
, colname
) == 4 &&
319 strcasecmp(colname
, color
) == 0) {
323 /* fprintf(stderr, "%s -> %d,%d,%d\n", colname, r, g, b); */
330 fprintf(stderr
, "Unable to find color '%s' in rgb.txt\n", color
);
333 } else if (ci
->eval_colors
) {
334 if (!(ci
->eval_r
= ff_parse(ci
->expr_R
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
))){
335 av_log(NULL
, AV_LOG_ERROR
, "Couldn't parse R expression '%s'\n", ci
->expr_R
);
338 if (!(ci
->eval_g
= ff_parse(ci
->expr_G
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
))){
339 av_log(NULL
, AV_LOG_ERROR
, "Couldn't parse G expression '%s'\n", ci
->expr_G
);
342 if (!(ci
->eval_b
= ff_parse(ci
->expr_B
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
))){
343 av_log(NULL
, AV_LOG_ERROR
, "Couldn't parse B expression '%s'\n", ci
->expr_B
);
349 if (!(ci
->eval_a
= ff_parse(ci
->expr_A
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
))){
350 av_log(NULL
, AV_LOG_ERROR
, "Couldn't parse A expression '%s'\n", ci
->expr_A
);
357 if (!(ci
->eval_colors
|| ci
->eval_a
))
358 imlib_context_set_color(ci
->r
, ci
->g
, ci
->b
, ci
->a
);
360 /* load the image (for example, credits for a movie) */
362 ci
->imageOverlaid
= imlib_load_image_immediately(ci
->fileImage
);
363 if (!(ci
->imageOverlaid
)){
364 av_log(NULL
, AV_LOG_ERROR
, "Couldn't load image '%s'\n", ci
->fileImage
);
367 imlib_context_set_image(ci
->imageOverlaid
);
368 ci
->imageOverlaid_width
= imlib_image_get_width();
369 ci
->imageOverlaid_height
= imlib_image_get_height();
372 if (!(ci
->eval_x
= ff_parse(ci
->expr_x
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
))){
373 av_log(NULL
, AV_LOG_ERROR
, "Couldn't parse x expression '%s'\n", ci
->expr_x
);
377 if (!(ci
->eval_y
= ff_parse(ci
->expr_y
, const_names
, NULL
, NULL
, NULL
, NULL
, NULL
))){
378 av_log(NULL
, AV_LOG_ERROR
, "Couldn't parse y expression '%s'\n", ci
->expr_y
);
385 static Imlib_Image
get_cached_image(ContextInfo
*ci
, int width
, int height
)
389 for (cache
= ci
->cache
; cache
; cache
= cache
->next
) {
390 if (width
== cache
->width
&& height
== cache
->height
)
397 static void put_cached_image(ContextInfo
*ci
, Imlib_Image image
, int width
, int height
)
399 CachedImage
*cache
= av_mallocz(sizeof(*cache
));
401 cache
->image
= image
;
402 cache
->width
= width
;
403 cache
->height
= height
;
404 cache
->next
= ci
->cache
;
408 void Process(void *ctx
, AVPicture
*picture
, enum PixelFormat pix_fmt
, int width
, int height
, int64_t pts
)
410 ContextInfo
*ci
= (ContextInfo
*) ctx
;
415 image
= get_cached_image(ci
, width
, height
);
418 image
= imlib_create_image(width
, height
);
419 put_cached_image(ci
, image
, width
, height
);
422 imlib_context_set_image(image
);
423 data
= imlib_image_get_data();
425 avpicture_fill(&picture1
, (uint8_t *) data
, PIX_FMT_RGB32
, width
, height
);
427 // if we already got a SWS context, let's realloc if is not re-useable
428 ci
->toRGB_convert_ctx
= sws_getCachedContext(ci
->toRGB_convert_ctx
,
429 width
, height
, pix_fmt
,
430 width
, height
, PIX_FMT_RGB32
,
431 sws_flags
, NULL
, NULL
, NULL
);
432 if (ci
->toRGB_convert_ctx
== NULL
) {
433 av_log(NULL
, AV_LOG_ERROR
,
434 "Cannot initialize the toRGB conversion context\n");
438 // img_convert parameters are 2 first destination, then 4 source
439 // sws_scale parameters are context, 4 first source, then 2 destination
440 sws_scale(ci
->toRGB_convert_ctx
,
441 picture
->data
, picture
->linesize
, 0, height
,
442 picture1
.data
, picture1
.linesize
);
444 imlib_image_set_has_alpha(0);
447 int wid
, hig
, h_a
, v_a
;
450 char *tbp
= ci
->text
;
451 time_t now
= time(0);
455 double const_values
[]={
458 ci
->frame_number
, // frame number (starting at zero)
459 height
, // frame height
460 width
, // frame width
461 ci
->imageOverlaid_height
, // image height
462 ci
->imageOverlaid_width
, // image width
469 int fd
= open(ci
->file
, O_RDONLY
);
472 tbp
= "[File not found]";
474 int l
= read(fd
, tbuff
, sizeof(tbuff
) - 1);
487 strftime(buff
, sizeof(buff
), tbp
, localtime(&now
));
488 else if (!(ci
->imageOverlaid
))
489 strftime(buff
, sizeof(buff
), "[No data]", localtime(&now
));
491 ci
->x
= ff_parse_eval(ci
->eval_x
, const_values
, ci
);
492 ci
->y
= ff_parse_eval(ci
->eval_y
, const_values
, ci
);
496 ci
->a
= ff_parse_eval(ci
->eval_a
, const_values
, ci
);
499 if (ci
->eval_colors
) {
500 ci
->r
= ff_parse_eval(ci
->eval_r
, const_values
, ci
);
501 ci
->g
= ff_parse_eval(ci
->eval_g
, const_values
, ci
);
502 ci
->b
= ff_parse_eval(ci
->eval_b
, const_values
, ci
);
505 if (ci
->eval_colors
|| ci
->eval_a
) {
506 imlib_context_set_color(ci
->r
, ci
->g
, ci
->b
, ci
->a
);
509 if (!(ci
->imageOverlaid
))
510 for (p
= buff
; p
; p
= q
) {
515 imlib_text_draw_with_return_metrics(ci
->x
, y
, p
, &wid
, &hig
, &h_a
, &v_a
);
519 if (ci
->imageOverlaid
) {
520 imlib_context_set_image(image
);
521 imlib_blend_image_onto_image(ci
->imageOverlaid
, 0,
522 0, 0, ci
->imageOverlaid_width
, ci
->imageOverlaid_height
,
523 ci
->x
, ci
->y
, ci
->imageOverlaid_width
, ci
->imageOverlaid_height
);
528 ci
->fromRGB_convert_ctx
= sws_getCachedContext(ci
->fromRGB_convert_ctx
,
529 width
, height
, PIX_FMT_RGB32
,
530 width
, height
, pix_fmt
,
531 sws_flags
, NULL
, NULL
, NULL
);
532 if (ci
->fromRGB_convert_ctx
== NULL
) {
533 av_log(NULL
, AV_LOG_ERROR
,
534 "Cannot initialize the fromRGB conversion context\n");
537 // img_convert parameters are 2 first destination, then 4 source
538 // sws_scale parameters are context, 4 first source, then 2 destination
539 sws_scale(ci
->fromRGB_convert_ctx
,
540 picture1
.data
, picture1
.linesize
, 0, height
,
541 picture
->data
, picture
->linesize
);