display.c

Go to the documentation of this file.

 
/*
 * Copyright (c) 2022-2023 CESNET z.s.p.o.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of CESNET nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifdef HAVE_CONFIG_H
#include "config.h"
#include "config_unix.h"
#include "config_win32.h"
#endif /* HAVE_CONFIG_H */
 
#include "capture_filter.h"
#include "compat/strings.h"      // strdupa
#include "debug.h"
#include "lib_common.h"
#include "utils/color_out.h"
#include "utils/list.h"
#include "utils/text.h"
#include "video.h"
#include "video_codec.h"
#include "video_display.h"
#include "video_frame.h"
 
#define MAX_QUEUE_LEN 3
#define MOD_NAME "[display cap. f.] "
 
struct module;
 
static int init(struct module *parent, const char *cfg, void **state);
static void done(void *state);
static struct video_frame *filter(void *state, struct video_frame *in);
 
struct capture_filter_display {
        struct display *d;
 
        struct simple_linked_list *frame_queue;
 
        pthread_mutex_t lock;
        pthread_cond_t cv;
        pthread_t thread_id;
};
 
static codec_t select_display_codec(codec_t *display_codecs, codec_t recv_codec) {
        if (codec_is_in_set(recv_codec, display_codecs)) {
                return recv_codec;
        }
        codec_t out = VIDEO_CODEC_NONE;
        get_best_decoder_from(recv_codec, display_codecs, &out);
        return out;
}
 
static void *worker(void *arg) {
        struct capture_filter_display *s = arg;
        struct video_desc configured_desc = { 0 };
        codec_t display_codecs[VIDEO_CODEC_COUNT + 1];
        size_t len = sizeof display_codecs;
        if (!display_ctl_property(s->d, DISPLAY_PROPERTY_CODECS, display_codecs, &len)) {
                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Cannot query display supported codecs!\n");
                exit_uv(1);
                return NULL;
        }
        display_codecs[len / sizeof display_codecs[0]] = VIDEO_CODEC_NONE;
        int rgb_shift[] = { DEFAULT_R_SHIFT, DEFAULT_G_SHIFT, DEFAULT_B_SHIFT };
        len = sizeof rgb_shift;
        if (!display_ctl_property(s->d, DISPLAY_PROPERTY_RGB_SHIFT, rgb_shift, &len)) {
                log_msg(LOG_LEVEL_WARNING, MOD_NAME "Cannot query display RGB shift!\n");
        }
        decoder_t dec = NULL;
        int src_linesize = 0;
        int dst_linesize = 0;
 
        while (1) {
                pthread_mutex_lock(&s->lock);
                while (simple_linked_list_size(s->frame_queue) == 0) {
                        pthread_cond_wait(&s->cv, &s->lock);
                }
                struct video_frame *f = simple_linked_list_pop(s->frame_queue);
                pthread_mutex_unlock(&s->lock);
                if (!f) {
                        display_put_frame(s->d, NULL, PUTF_BLOCKING); // pass poison pill
                        break;
                }
 
                struct video_desc new_desc = video_desc_from_frame(f);
                if (!video_desc_eq(configured_desc, new_desc)) {
                        struct video_desc display_desc = new_desc;
                        display_desc.color_spec = select_display_codec(display_codecs, new_desc.color_spec);
                        if (!display_desc.color_spec || !display_reconfigure(s->d, display_desc, VIDEO_NORMAL)) {
                                log_msg(LOG_LEVEL_ERROR, "Unable to reconfigure to %s!\n", video_desc_to_string(display_desc));
                                continue;
                        }
                        log_msg(LOG_LEVEL_NOTICE, MOD_NAME "Reconfigured display to %s\n", video_desc_to_string(display_desc));
                        dec = get_decoder_from_to(new_desc.color_spec, display_desc.color_spec);
                        src_linesize = vc_get_linesize(f->tiles[0].width, f->color_spec);
                        dst_linesize = vc_get_linesize(f->tiles[0].width, display_desc.color_spec);
                        configured_desc = new_desc;
                }
                struct video_frame *df = display_get_frame(s->d);
                for (size_t i = 0; i < f->tiles[0].height; ++i) {
                        dec((unsigned char *) df->tiles[0].data + i * dst_linesize, (unsigned char *) f->tiles[0].data + i * src_linesize, dst_linesize, rgb_shift[0], rgb_shift[1], rgb_shift[2]);
                }
                display_put_frame(s->d, df, PUTF_BLOCKING);
                vf_free(f);
        }
 
        return NULL;
}
 
static int init(struct module *parent, const char *cfg, void **state)
{
        char warn[] = MOD_NAME "Capture filter \"display\" is experimental and may not "
                "always work as expected, especially if the same SW display "
                "type (eg. GL) is given as both preview display and a regular one.";
        log_msg(LOG_LEVEL_WARNING, "%s\n", wrap_paragraph(warn));
 
        if (strlen(cfg) == 0 || strcmp(cfg, "help") == 0) {
                color_printf("Previews captured frame with specified dispay.\n"
                          "Usage:\n"
                          "\t" TBOLD("--capture-filter display:<display_cfg>") "\n");
                return 1;
        }
 
        char *requested_display = strdupa(cfg);
        char *delim = strchr(requested_display, ':');
        const char *fmt = "";
        if (delim) {
                *delim = '\0';
                fmt = delim + 1;
        }
        struct display *d;
        int ret = initialize_video_display(parent, requested_display,
                fmt, 0, NULL, &d);
        if (ret != 0) {
                return ret;
        }
 
        struct capture_filter_display *s = calloc(1, sizeof *s);
        s->d = d;
        s->frame_queue = simple_linked_list_init();
        pthread_mutex_init(&s->lock, NULL);
        pthread_cond_init(&s->cv, NULL);
 
        display_run_new_thread(s->d);
        pthread_create(&s->thread_id, NULL, worker, s);
 
        *state = s;
        return 0;
}
 
static struct video_frame *filter(void *state, struct video_frame *in)
{
        struct capture_filter_display *s = state;
        struct video_frame *f = in ? vf_get_copy(in) : NULL;
        pthread_mutex_lock(&s->lock);
        if (simple_linked_list_size(s->frame_queue) == MAX_QUEUE_LEN) {
                pthread_mutex_unlock(&s->lock);
                log_msg(LOG_LEVEL_WARNING, MOD_NAME "Queue full, frame not displayed.\n");
                vf_free(f);
                return in;
        }
        simple_linked_list_append(s->frame_queue, f);
        pthread_mutex_unlock(&s->lock);
        pthread_cond_signal(&s->cv);
 
        return in;
}
 
static void done(void *state)
{
        struct capture_filter_display *s = state;
        filter(s, NULL);
        pthread_join(s->thread_id, NULL);
        display_join(s->d);
        display_done(s->d);
        pthread_mutex_destroy(&s->lock);
        pthread_cond_destroy(&s->cv);
        simple_linked_list_destroy(s->frame_queue);
        free(s);
}
 
static const struct capture_filter_info capture_filter_display = {
        .init = init,
        .done = done,
        .filter = filter,
};
 
REGISTER_HIDDEN_MODULE(display, &capture_filter_display, LIBRARY_CLASS_CAPTURE_FILTER, CAPTURE_FILTER_ABI_VERSION);