text.c File Reference

#include <wand/magick_wand.h>
#include "capture_filter.h"
#include "debug.h"
#include "lib_common.h"
#include "video.h"
#include "video_display.h"
#include "vo_postprocess.h"
#include "utils/color_out.h"
#include "utils/macros.h"
#include "utils/string.h"
#include "utils/text.h"

Include dependency graph for text.c:

Go to the source code of this file.

Classes
struct	state_text

Macros
#define	MARGIN_X_DIV   60
#define	MARGIN_Y_DIV   60
#define	TEXT_H_DIV   30

Functions
static struct video_frame *	cf_text_filter (void *state, struct video_frame *f)
static int	cf_text_init (struct module *parent, const char *cfg, void **state)
static void	init_text ()
	REGISTER_MODULE (text, &capture_filter_text_info, LIBRARY_CLASS_CAPTURE_FILTER, CAPTURE_FILTER_ABI_VERSION)
	REGISTER_MODULE (text, &vo_pp_text_info, LIBRARY_CLASS_VIDEO_POSTPROCESS, VO_PP_ABI_VERSION)
static void	text_done (void *state)
static void	text_get_out_desc (void *state, struct video_desc *out, int *in_display_mode, int *out_frames)
static bool	text_get_property (void *state, int property, void *val, size_t *len)
static struct video_frame *	text_getf (void *state)
static void *	text_init (const char *config)
static bool	text_postprocess (void *state, struct video_frame *in, struct video_frame *out, int req_pitch)
static bool	text_postprocess_reconfigure (void *state, struct video_desc desc)

Variables
static const struct capture_filter_info	capture_filter_text_info
static pthread_once_t	vo_postprocess_text_initialized = PTHREAD_ONCE_INIT
static const struct vo_postprocess_info	vo_pp_text_info

Detailed Description

Author

Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

Todo

Add more options - eg. text position and size. Add support for more pixel formats.

Definition in file text.c.

Macro Definition Documentation

MARGIN_X_DIV

#define MARGIN_X_DIV   60

Definition at line 107 of file text.c.

Referenced by text_postprocess_reconfigure().

MARGIN_Y_DIV

#define MARGIN_Y_DIV   60

Definition at line 108 of file text.c.

Referenced by text_postprocess_reconfigure().

TEXT_H_DIV

#define TEXT_H_DIV   30

Definition at line 106 of file text.c.

Referenced by text_postprocess_reconfigure().

Function Documentation

cf_text_filter()

static struct video_frame * cf_text_filter ( void * state, struct video_frame * f )

static

Definition at line 399 of file text.c.

{
        struct state_text *s = (struct state_text *) state;
 
        if (!video_desc_eq(s->saved_desc, video_desc_from_frame(f))) {
                if (text_postprocess_reconfigure(state, video_desc_from_frame(f))) {
                        s->saved_desc = video_desc_from_frame(f);
                } else {
                        log_msg(LOG_LEVEL_WARNING, "[text] Cannot reinitialize!\n");
                        return NULL;
                }
        }
 
        struct video_frame *out = vf_alloc_desc_data(s->saved_desc);
        out->callbacks.dispose = vf_free;
        if (text_postprocess(state, f, out, vc_get_linesize(f->tiles[0].width, f->color_spec))) {
                VIDEO_FRAME_DISPOSE(f);
                return out;
        } else {
                VIDEO_FRAME_DISPOSE(f);
                vf_free(out);
                return NULL;
        }
}

References video_frame::callbacks, video_frame::color_spec, video_frame_callbacks::dispose, LOG_LEVEL_WARNING, log_msg(), state_text::saved_desc, state, text_postprocess(), text_postprocess_reconfigure(), video_frame::tiles, vc_get_linesize(), vf_alloc_desc_data(), vf_free(), video_desc_eq(), video_desc_from_frame(), VIDEO_FRAME_DISPOSE, and tile::width.

Here is the call graph for this function:

cf_text_init()

static int cf_text_init ( struct module * parent, const char * cfg, void ** state )

static

Definition at line 178 of file text.c.

{
        (void) parent;
        void *s = text_init(cfg);
        if (!s) {
                return 1;
        } else {
                *state = s;
                return 0;
        }
}

References parent, state, and text_init().

Here is the call graph for this function:

init_text()

static void init_text ( )

static

Definition at line 112 of file text.c.

                        {
        MagickWandGenesis();
        atexit(MagickWandTerminus);
}

Referenced by text_init().

REGISTER_MODULE() [1/2]

REGISTER_MODULE	(	text	,
		&	capture_filter_text_info,
		LIBRARY_CLASS_CAPTURE_FILTER	,
		CAPTURE_FILTER_ABI_VERSION	)

REGISTER_MODULE() [2/2]

REGISTER_MODULE	(	text	,
		&	vo_pp_text_info,
		LIBRARY_CLASS_VIDEO_POSTPROCESS	,
		VO_PP_ABI_VERSION	)

text_done()

static void text_done ( void * state )

static

Definition at line 424 of file text.c.

{
        struct state_text *s = (struct state_text *) state;
 
        vf_free(s->in);
 
        DestroyMagickWand(s->wand_bg);
        DestroyMagickWand(s->wand_text);
        DestroyDrawingWand(s->dw);
 
        free(s->data);
        free(s->text);
        free(s);
}

References state_text::data, state_text::dw, state_text::in, state, state_text::text, vf_free(), state_text::wand_bg, and state_text::wand_text.

Here is the call graph for this function:

text_get_out_desc()

static void text_get_out_desc ( void * state, struct video_desc * out, int * in_display_mode, int * out_frames )

static

Definition at line 439 of file text.c.

{
        struct state_text *s = (struct state_text *) state;
 
        *out = video_desc_from_frame(s->in);
 
        *in_display_mode = DISPLAY_PROPERTY_VIDEO_MERGED;
        *out_frames = 1;
}

References DISPLAY_PROPERTY_VIDEO_MERGED, state_text::in, state, and video_desc_from_frame().

Here is the call graph for this function:

text_get_property()

static bool text_get_property ( void * state, int property, void * val, size_t * len )

static

Definition at line 95 of file text.c.

{
        UNUSED(state);
        UNUSED(property);
        UNUSED(val);
        UNUSED(len);
 
        return false;
}

References len, property, state, UNUSED, and val.

text_getf()

static struct video_frame * text_getf ( void * state )

static

Definition at line 306 of file text.c.

{
        struct state_text *s = (struct state_text *) state;
 
        return s->in;
}

References state_text::in, and state.

text_init()

static void * text_init ( const char * config )

static

Definition at line 118 of file text.c.

                                            {
        pthread_once(&vo_postprocess_text_initialized, init_text);
 
        struct state_text *s;
 
        if (strlen(config) == 0 || strcmp(config, "help") == 0) {
                char desc[] = TBOLD("text") " video postprocess takes as a parameter text to be drawed. "
                         "Colons in text must be escaped with a backslash (see Examples). Spaces may be escaped or the whole argument should be enclosed by quotation marks.\n";
                color_printf("%s", wrap_paragraph(desc));
                color_printf("\nUsage:\n");
                color_printf("\t" TBOLD("-p text:<text>") "\n");
                color_printf("\t" TBOLD("-p text:x=<x>:y=<y>:h=<text_height>:t=<text>") "\n");
                color_printf("\nExamples:\n");
                color_printf(TBOLD("\t-p text:stream1\n"
                                        "\t-p text:x=100:y=100:h=20:t=text\n"
                                        "\t-p \"text:Video stream from location XY\"\n"
                                        "\t-p \"text:Text can also contains escaped colons - \\:\"\n")
                                "\n");
                return NULL;
        }
 
        s = calloc(1, sizeof *s);
        s->req_x = s->req_y = s->req_h = -1;
 
        char *config_copy = strdup(config);
        replace_all(config_copy, ESCAPED_COLON, DELDEL);
        char *tmp = config_copy, *item, *save_ptr;
        while ((item = strtok_r(tmp, ":", &save_ptr))) {
                if (strstr(item, "x=") != NULL) {
                        s->req_x = atoi(item + 2);
                } else if (strstr(item, "y=") != NULL) {
                        s->req_y = atoi(item + 2);
                } else if (strstr(item, "h=") != NULL) {
                        s->req_h = atoi(item + 2);
                } else if (strstr(item, "t=") != NULL) {
                        replace_all(item + 2, DELDEL, ":");
                        s->text = strdup(item + 2);
                } else {
                        replace_all(item, DELDEL, ":");
                        s->text = strdup(item);
                }
                tmp = NULL;
        }
        free(config_copy);
 
        if(!s->text || strlen(s->text) == 0){
                log_msg(LOG_LEVEL_ERROR, "[text] Text can not be empty!\n");
                free(s);
                return NULL;
        }
 
        if (s->req_h < -1) {
                log_msg(LOG_LEVEL_ERROR, "[text] Text height cannot be negative!\n");
                free(s);
                return NULL;
        }
 
        return s;
}

References color_printf(), DELDEL, desc, ESCAPED_COLON, init_text(), LOG_LEVEL_ERROR, log_msg(), replace_all(), state_text::req_h, state_text::req_x, state_text::req_y, TBOLD, state_text::text, vo_postprocess_text_initialized, and wrap_paragraph().

Referenced by cf_text_init().

Here is the call graph for this function:

text_postprocess()

static bool text_postprocess ( void * state, struct video_frame * in, struct video_frame * out, int req_pitch )

static

Definition at line 313 of file text.c.

{
        MagickBooleanType status;
        struct state_text *s = (struct state_text *) state;
 
        int dst_linesize = vc_get_linesize(s->width, in->color_spec);
        int src_linesize = vc_get_linesize(in->tiles[0].width, in->color_spec);
 
        int im_height_px = in->tiles[0].height;
 
        // copy over just the relevant "stripe"
        // cannot copy just the rectangle because pixel formats
        // are not necessarily byte aligned
        char *stripe = malloc((size_t) s->text_height_px * dst_linesize);
        assert(stripe != NULL && "Malloc failed");
        for (ptrdiff_t y = 0; y < s->text_height_px; y++) {
                // skip what is out-of-bounds
                if (y + s->margin_y < 0) {
                        y += -s->margin_y - 1;
                        continue;
                }
                if (y + s->margin_y >= im_height_px)
                        break;
 
                // copy what isn't
                memcpy(stripe + (y) * dst_linesize,
                       in->tiles[0].data + (y + s->margin_y) * src_linesize, 
                       dst_linesize);
        }
 
        // read image stripe into ImageMagick
        MagickRemoveImage(s->wand_bg);
 
        status = MagickSetSize(s->wand_bg, s->width, s->text_height_px);
        assert(status == MagickTrue && "[text vo_pp.] MagickSetSize failed -- ");
 
        status = MagickReadImageBlob(s->wand_bg, stripe, s->text_height_px * dst_linesize);
        if (status != MagickTrue) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] MagickReadImageBlob failed!\n");
                return false;
        }
 
        // compose it with text
#ifdef WAND7
        status = MagickCompositeImage(s->wand_bg, s->wand_text, OverCompositeOp, true, s->margin_x, 0);
#else
        status = MagickCompositeImage(s->wand_bg, s->wand_text, OverCompositeOp, s->margin_x, 0);
#endif
        if (status != MagickTrue) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] MagickCompositeImage failed!\n");
                return false;
        }
 
        // extract the composed data
        unsigned char *data;
        size_t data_len;
        data = MagickGetImageBlob(s->wand_bg, &data_len);
        assert(data != NULL && "[text vo_pp.] MagickGetImageBlob failed!");
 
        // send the input stream...
        memcpy(out->tiles[0].data, in->tiles[0].data, in->tiles[0].data_len);
 
        // ...and the text stripe on top of it
        // if ((int) data_len == s->text_height_pt * dstlinesize) {
                for (int y = 0; y < s->text_height_px; y++) {
                        // again, skip what is oob
                        if (y + s->margin_y < 0) {
                                y += - s->margin_y - 1; // 1 == don't y++ on continue
                                continue;
                        }
                        if (y + s->margin_y >= im_height_px) {
                                break;
                        }
 
                        memcpy(out->tiles[0].data + (y + s->margin_y) * req_pitch,
                               data + y * dst_linesize,
                               dst_linesize);
                }
        // }
 
        free(data);
 
        free(stripe);
        return true;
}

References video_frame::color_spec, state_text::data, tile::data, tile::data_len, tile::height, state_text::in, LOG_LEVEL_WARNING, log_msg(), state_text::margin_x, state_text::margin_y, state, state_text::text_height_px, video_frame::tiles, vc_get_linesize(), state_text::wand_bg, state_text::wand_text, state_text::width, and tile::width.

Referenced by cf_text_filter().

Here is the call graph for this function:

text_postprocess_reconfigure()

static bool text_postprocess_reconfigure ( void * state, struct video_desc desc )

static

Definition at line 191 of file text.c.

{
        struct state_text *s = (struct state_text *) state;
 
        vf_free(s->in);
        if (s->wand_text)
                DestroyMagickWand(s->wand_text);
        if (s->wand_bg)
                DestroyMagickWand(s->wand_bg);
        if (s->dw)
                DestroyDrawingWand(s->dw);
        s->in = 0;
        s->wand_bg = 0;
        s->wand_text = 0;
        s->dw = 0;
 
        s->in = vf_alloc_desc_data(desc);
 
        s->margin_x = s->req_x == -1 ? (int) desc.width / MARGIN_X_DIV : s->req_x;
        s->margin_y = s->req_y == -1 ? (int) desc.height / MARGIN_Y_DIV : s->req_y;
        s->text_height_pt = s->req_h == -1 ? (int) desc.height / TEXT_H_DIV : s->req_h;
        s->width = MIN(s->margin_x + strlen(s->text) * s->text_height_pt, desc.width);
        s->text_base_y = MIN(s->margin_y + s->text_height_pt, (int) desc.height);
 
 
        const char *color;
        const char *color_outline;
        const char *colorspace;
        if (desc.color_spec == RGBA) {
                color = "#333333FF";
                color_outline = "#FFFFFFFF";
                colorspace = "rgba";
        } else if (desc.color_spec == RGB) {
                color = "#333333FF";
                color_outline = "#FFFFFFFF";
                colorspace = "rgb";
        } else if (desc.color_spec == UYVY) {
                color = "#228080FF";
                color_outline = "#EB8080FF";
                colorspace = "UYVY";
        } else {
                bug_msg(LOG_LEVEL_ERROR, "[text vo_pp.] Codec not supported! ");
                return false;
        }
 
        s->dw = NewDrawingWand();
        DrawSetFontSize(s->dw, s->text_height_pt);
        MagickBooleanType status = DrawSetFont(s->dw, "helvetica");
        if(status != MagickTrue) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] DraweSetFont failed!\n");
                return false;
        }
        {
               PixelWand *pw = NewPixelWand();
               PixelSetColor(pw, color);
               DrawSetFillColor(s->dw, pw);
               PixelSetColor(pw, color_outline);
               DrawSetStrokeColor(s->dw, pw);
               DestroyPixelWand(pw);
        }
 
        s->wand_bg = NewMagickWand();
        status = MagickSetFormat(s->wand_bg, colorspace);
        s->wand_text = NewMagickWand();
        status &= MagickSetFormat(s->wand_text, colorspace);
        if(status != MagickTrue) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] MagickSetFormat failed!\n");
                return false;
        }
 
 
        status = MagickSetDepth(s->wand_bg, 8);
        status &= MagickSetDepth(s->wand_text, 8);
        assert(status == MagickTrue && "[text vo_pp.] MagickSetDepth failed");
        
        PixelWand *transparent_bg = NewPixelWand();
        // PixelSetColor(transparent_bg, "#cccccc80");  // for debugging
        PixelSetColor(transparent_bg, "#00000000");
 
        // still need a dummy canvas to query font metrics
        MagickNewImage(s->wand_text, 1, 1, transparent_bg);
 
        // glyph w, glyph h, ascender, descender, txt w, txt h
        double *metrics = MagickQueryFontMetrics(s->wand_text, s->dw, s->text);
        if(!metrics) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] MagickQueryFontMetrics failed!\n");
                return false;
        }
        double descender =  metrics[3];  // has negative value
        s->text_width_px =  metrics[4];
        s->text_height_px = metrics[5];  // whole height, including the descender
        free(metrics);
 
        MagickRemoveImage(s->wand_text);
        status = MagickNewImage(s->wand_text, s->text_width_px, s->text_height_px, transparent_bg);
        if (!status) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] MagickNewImage failed!\n");
                return false;
        }
 
        double x_off = 0;
        double y_off_baseline = s->text_height_px - (-descender) + 1;
        double rot = 0;
        status = MagickAnnotateImage(s->wand_text, s->dw, x_off, y_off_baseline, rot, s->text);
        if (!status) {
                log_msg(LOG_LEVEL_WARNING, "[text vo_pp.] MagickAnnotateImage failed!\n\n"
                "Perhaps the text contains invalid characters?\n");
                return false;
        }
 
        DestroyPixelWand(transparent_bg);
 
        return true;
}

References bug_msg(), video_desc::color_spec, desc, state_text::dw, video_desc::height, state_text::in, LOG_LEVEL_ERROR, LOG_LEVEL_WARNING, log_msg(), state_text::margin_x, MARGIN_X_DIV, state_text::margin_y, MARGIN_Y_DIV, MIN, state_text::req_h, state_text::req_x, state_text::req_y, RGB, RGBA, state, state_text::text, state_text::text_base_y, TEXT_H_DIV, state_text::text_height_pt, state_text::text_height_px, state_text::text_width_px, UYVY, vf_alloc_desc_data(), vf_free(), state_text::wand_bg, state_text::wand_text, state_text::width, and video_desc::width.

Referenced by cf_text_filter().

Here is the call graph for this function:

Variable Documentation

capture_filter_text_info

const struct capture_filter_info capture_filter_text_info

static

Initial value:

= {
        cf_text_init,
        text_done,
        cf_text_filter
}

Definition at line 459 of file text.c.

                                                                   {
        cf_text_init,
        text_done,
        cf_text_filter
};

vo_postprocess_text_initialized

pthread_once_t vo_postprocess_text_initialized = PTHREAD_ONCE_INIT

static

Definition at line 110 of file text.c.

Referenced by text_init().

vo_pp_text_info

const struct vo_postprocess_info vo_pp_text_info

static

Initial value:

= {
        text_init,
        text_postprocess_reconfigure,
        text_getf,
        text_get_out_desc,
        text_get_property,
        text_postprocess,
        text_done,
}

Definition at line 449 of file text.c.

                                                          {
        text_init,
        text_postprocess_reconfigure,
        text_getf,
        text_get_out_desc,
        text_get_property,
        text_postprocess,
        text_done,
};