ndi.c

Go to the documentation of this file.

 
/*
 * Copyright (c) 2019-2024 CESNET
 * 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.
 */
#include <assert.h>           // for assert
#include <limits.h>           // for INT_MAX
#include <stdbool.h>          // for true, false, bool
#include <stdint.h>           // for uint16_t, uintptr_t, uint8_t, int16_t
#include <stdio.h>            // for printf, snprintf
#include <stdlib.h>           // for NULL, free, size_t, calloc, malloc, strtol
#include <string.h>           // for memcpy, strlen, strncpy, strstr, strcmp
#include <strings.h>          // for strcasecmp
 
#include "audio/types.h"
#include "audio/utils.h"
#include "debug.h"
#include "host.h"
#include "lib_common.h"
#include "ndi_common.h"
#include "types.h"
#include "utils/color_out.h"
#include "utils/macros.h" // OPTIMIZED_FOR
#include "utils/misc.h"
#include "video.h"
#include "video_display.h"
 
#define DEFAULT_AUDIO_LEVEL 0
#define MOD_NAME "[NDI disp.] "
 
typedef void ndi_disp_convert_t(const struct video_frame *f, char *out);
static void ndi_disp_convert_Y216_to_P216(const struct video_frame *f, char *out);
static void ndi_disp_convert_Y416_to_PA16(const struct video_frame *f, char *out);
 
struct display_ndi {
        LIB_HANDLE lib;
        const NDIlib_t *NDIlib;
        int audio_level; 
        NDIlib_send_instance_t pNDI_send;
        NDIlib_video_frame_v2_t NDI_video_frame;
        char *video_metadata;
        struct video_desc desc;
        struct audio_desc audio_desc;
        struct video_frame *send_frame; 
 
        ndi_disp_convert_t *convert;
        char *convert_buffer; 
};
 
static void display_ndi_probe(struct device_info **available_cards, int *count, void (**deleter)(void *))
{
        *count = 1;
        *available_cards = calloc(1, sizeof(struct device_info));
        strncpy((*available_cards)[0].dev, "", sizeof (*available_cards)[0].dev - 1);
        strncpy((*available_cards)[0].name, "NDI", sizeof (*available_cards)[0].name - 1);
        strncpy((*available_cards)[0].extra, "\"embeddedAudioAvailable\":\"t\"", sizeof (*available_cards)[0].extra - 1);
        (*available_cards)[0].repeatable = true;
        *deleter = free;
}
 
static const struct {
        codec_t ug_codec;
        NDIlib_FourCC_video_type_e ndi_fourcc;
        ndi_disp_convert_t *convert;
} codec_mapping[] = {
        { RGBA, NDIlib_FourCC_type_RGBA, NULL },
        { UYVY, NDIlib_FourCC_type_UYVY, NULL },
        { I420, NDIlib_FourCC_video_type_I420, NULL },
        { Y216, NDIlib_FourCC_type_P216, ndi_disp_convert_Y216_to_P216 },
        { Y416, NDIlib_FourCC_type_PA16, ndi_disp_convert_Y416_to_PA16 },
};
 
static bool display_ndi_reconfigure(void *state, struct video_desc desc)
{
        struct display_ndi *s = (struct display_ndi *) state;
 
        s->desc = desc;
        free(s->convert_buffer);
        s->convert_buffer = malloc(MAX_BPS * desc.width * desc.height + MAX_PADDING);
 
        s->NDI_video_frame.xres = s->desc.width;
        s->NDI_video_frame.yres = s->desc.height;
        for (size_t i = 0; i < sizeof codec_mapping / sizeof codec_mapping[0]; ++i) {
                if (codec_mapping[i].ug_codec == desc.color_spec) {
                        s->NDI_video_frame.FourCC = codec_mapping[i].ndi_fourcc;
                        s->convert = codec_mapping[i].convert;
                }
        }
        assert(s->NDI_video_frame.FourCC != 0);
        s->NDI_video_frame.frame_rate_N = get_framerate_n(desc.fps);
        s->NDI_video_frame.frame_rate_D = get_framerate_d(desc.fps);
        s->NDI_video_frame.frame_format_type = desc.interlacing == PROGRESSIVE ? NDIlib_frame_format_type_progressive : NDIlib_frame_format_type_interleaved;
        s->NDI_video_frame.timecode = NDIlib_send_timecode_synthesize;
 
        return true;
}
 
static void usage()
{
        printf("Usage:\n");
        color_printf(TERM_BOLD TERM_FG_RED "\t-d ndi" TERM_FG_RESET "[:help][:name=<n>][:audio_level=<x>]\n" TERM_RESET);
        printf("\twhere\n");
        color_printf(TERM_BOLD "\t\tname\n" TERM_RESET "\t\t\tthe name of the server\n");
        color_printf(TERM_BOLD "\t\taudio_level\n" TERM_RESET "\t\t\taudio headroom above reference level (in dB, or mic/line, default %d)\n", DEFAULT_AUDIO_LEVEL);
        color_printf("\n");
}
 
static char *ndi_disp_format_video_metadata(void)
{
        const char *param = get_commandline_param("color");
        if (param == NULL || strlen(param) != 2) {
                return NULL;
        }
        int eotf = strtol(param + 1, NULL, 16);
        const char *space = NULL;
        switch (eotf) {
                case 0: return NULL;
                case 1: space = "Default"; break;
                case 2: space = "HLG"; break;
                case 3: space = "PQ"; break;
                default:
                        log_msg(LOG_LEVEL_ERROR, "Wrong/unsupported HDR EOTF value %d!\n", eotf);
                        return NULL;
        }
        size_t metadata_len = 128;
        char *out = malloc(metadata_len);
        snprintf(out, metadata_len, "<HDR_PROFILE>%s</HDR_PROFILE>", space);
        return out;
}
 
#define BEGIN_TRY int ret = 0; do
#define END_TRY while(0);
#define THROW(x) ret = (x); break;
#define COMMON
#define CATCH(x) if (ret == (x))
#define FAIL (-1)
#define HELP_SHOWN 1
static void *display_ndi_init(struct module *parent, const char *fmt, unsigned int flags)
{
        UNUSED(flags);
        UNUSED(parent);
        NDI_PRINT_COPYRIGHT();
 
        char *fmt_copy = NULL;
        struct display_ndi *s = calloc(1, sizeof(struct display_ndi));
        s->audio_level = DEFAULT_AUDIO_LEVEL;
 
        BEGIN_TRY {
                fmt_copy = strdup(fmt);
                assert(fmt_copy != NULL);
 
                const char *ndi_name = NULL;
                char *tmp = fmt_copy, *item, *save_ptr;
                while ((item = strtok_r(tmp, ":", &save_ptr)) != NULL) {
                        if (strcmp(item, "help") == 0) {
                                usage();
                                THROW(HELP_SHOWN);
                        }
                        if (strstr(item, "audio_level=") != NULL) {
                                char *val = item + strlen("audio_level=");
                                if (strcasecmp(val, "mic") == 0) {
                                        s->audio_level = 0;
                                } else if (strcasecmp(val, "line") == 0) {
                                        s->audio_level = 20; // NOLINT
                                } else {
                                        char *endptr = NULL;
                                        long val_num = strtol(val, &endptr, 0);
                                        if (val_num < 0 || val_num >= INT_MAX || *val == '\0' || *endptr != '\0') {
                                                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Wrong value: %s!\n", val);
                                                THROW(FAIL);
                                        }
                                        s->audio_level = val_num; // NOLINT
                                }
                        } else if (strstr(item, "name=") != NULL) {
                                ndi_name = item + strlen("name=");
                        } else {
                                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Unknown option: %s!\n", item);
                                THROW(FAIL);
                        }
                        tmp = NULL;
                }
 
                s->NDIlib = NDIlib_load(&s->lib);
                if (s->NDIlib == NULL) {
                        log_msg(LOG_LEVEL_ERROR, MOD_NAME "Cannot open NDI library!\n");
                        THROW(FAIL);
                }
 
                printf("%s\n", s->NDIlib->version());
 
                if (!s->NDIlib->initialize()) {
                        log_msg(LOG_LEVEL_ERROR, MOD_NAME "Cannot initialize NDI library!\n");
                        THROW(FAIL);
                }
 
                NDIlib_send_create_t NDI_send_create_desc = { .p_ndi_name = ndi_name, .p_groups = NULL, .clock_video = false, .clock_audio = false };
                s->pNDI_send = s->NDIlib->send_create(&NDI_send_create_desc);
                if (s->pNDI_send == NULL) {
                        THROW(FAIL);
                }
        } END_TRY
        COMMON {
                free(fmt_copy);
        }
        CATCH(HELP_SHOWN) {
                free(s);
                return INIT_NOERR;
        }
        CATCH(FAIL) {
                free(s);
                return NULL;
        }
 
        s->NDI_video_frame.p_metadata = s->video_metadata = ndi_disp_format_video_metadata();
 
        return s;
}
 
static void display_ndi_done(void *state)
{
        struct display_ndi *s = (struct display_ndi *) state;
 
        s->NDIlib->send_destroy(s->pNDI_send);
        free(s->convert_buffer);
        s->NDIlib->destroy();
        close_ndi_library(s->lib);
        vf_free(s->send_frame);
        free(s->video_metadata);
        free(s);
}
 
static struct video_frame *display_ndi_getf(void *state)
{
        struct display_ndi *s = (struct display_ndi *) state;
 
        return vf_alloc_desc_data(s->desc);
}
 
static void ndi_disp_convert_Y216_to_P216(const struct video_frame *f, char *out)
{
        assert((uintptr_t) out % 2 == 0);
 
        uint16_t *in = (uint16_t *)(void *) f->tiles[0].data;
        uint16_t *out_y = (uint16_t *)(void *) out;
        uint16_t *out_cb_cr = (uint16_t *)(void *) out + f->tiles[0].width * f->tiles[0].height;
 
        for (unsigned int i = 0; i < f->tiles[0].height; ++i) {
                unsigned int width = f->tiles[0].width;
                OPTIMIZED_FOR (unsigned int j = 0; j < (width + 1) / 2; j += 1) {
                        *out_y++ = *in++;
                        *out_cb_cr++ = *in++;
                        *out_y++ = *in++;
                        *out_cb_cr++ = *in++;
                }
        }
}
 
static void ndi_disp_convert_Y416_to_PA16(const struct video_frame *f, char *out)
{
        assert((uintptr_t) out % 2 == 0);
 
        uint16_t *in = (uint16_t *)(void *) f->tiles[0].data;
        uint16_t *out_y = (uint16_t *)(void *) out;
        uint16_t *out_cb_cr = out_y + (size_t) f->tiles[0].width * f->tiles[0].height;
        uint16_t *out_a = out_cb_cr + (size_t) (f->tiles[0].width + 1) / 2 * f->tiles[0].height;
 
        for (unsigned int i = 0; i < f->tiles[0].height; ++i) {
                unsigned int width = f->tiles[0].width;
                OPTIMIZED_FOR (unsigned int j = 0; j < (width + 1) / 2; j += 1) {
                        *out_a++ = in[0];
                        *out_y++ = in[1];
                        *out_cb_cr++ = (in[2] + in[6]) / 2;
                        *out_a++ = in[4];
                        *out_y++ = in[5];
                        *out_cb_cr++ = (in[3] + in[7]) / 2;
                        in += 8;
                }
        }
}
 
static bool display_ndi_putf(void *state, struct video_frame *frame, long long flag)
{
        struct display_ndi *s = (struct display_ndi *) state;
 
        if (frame == NULL) {
                return true;
        }
 
        if (flag == PUTF_DISCARD) {
                vf_free(frame);
                return true;
        }
 
        s->NDIlib->send_send_video_v2(s->pNDI_send, NULL); // wait for the async frame to be processed
        vf_free(s->send_frame);
        s->send_frame = NULL;
 
        if (s->convert != NULL) {
                s->convert(frame, s->convert_buffer);
                s->NDI_video_frame.p_data = (uint8_t *) s->convert_buffer;
                vf_free(frame);
        } else {
                s->NDI_video_frame.p_data = (uint8_t *) frame->tiles[0].data;
                s->send_frame = frame;
        }
 
        s->NDIlib->send_send_video_async_v2(s->pNDI_send, &s->NDI_video_frame);
 
        return true;
}
 
static bool display_ndi_get_property(void *state, int property, void *val, size_t *len)
{
        UNUSED(state);
        codec_t codecs[sizeof codec_mapping / sizeof codec_mapping[0]];
        int rgb_shift[] = {0, 8, 16};
        enum interlacing_t supported_il_modes[] = {PROGRESSIVE, INTERLACED_MERGED};
 
        for (size_t i = 0; i < sizeof codec_mapping / sizeof codec_mapping[0]; ++i) {
                codecs[i] = codec_mapping[i].ug_codec;
        }
 
        switch (property) {
                case DISPLAY_PROPERTY_CODECS:
                        if (sizeof codecs <= *len) {
                                memcpy(val, codecs, sizeof codecs);
                                *len = sizeof codecs;
                        } else {
                                return false;
                        }
                        break;
                case DISPLAY_PROPERTY_RGB_SHIFT:
                        if (sizeof rgb_shift > *len) {
                                return false;
                        }
                        memcpy(val, rgb_shift, sizeof rgb_shift);
                        *len = sizeof rgb_shift;
                        break;
                case DISPLAY_PROPERTY_BUF_PITCH:
                        *(int *) val = PITCH_DEFAULT;
                        *len = sizeof(int);
                        break;
                case DISPLAY_PROPERTY_VIDEO_MODE:
                        *(int *) val = DISPLAY_PROPERTY_VIDEO_MERGED;
                        *len = sizeof(int);
                        break;
                case DISPLAY_PROPERTY_SUPPORTED_IL_MODES:
                        if (sizeof(supported_il_modes) <= *len) {
                                memcpy(val, supported_il_modes, sizeof(supported_il_modes));
                        } else {
                                return false;
                        }
                        *len = sizeof(supported_il_modes);
                        break;
                case DISPLAY_PROPERTY_AUDIO_FORMAT:
                        {
                                assert(*len == sizeof(struct audio_desc));
                                struct audio_desc *desc = (struct audio_desc *) val;
                                desc->bps = desc->bps <= 2 ? 2 : 4;
                                desc->codec = AC_PCM;
                        }
                        break;
                default:
                        return false;
        }
        return true;
}
 
#define NDI_SEND_AUDIO(frame, bit_depth) do { \
                assert((frame)->bps * 8 == (bit_depth)); \
                NDIlib_audio_frame_interleaved_ ## bit_depth ## s_t NDI_audio_frame = { 0 }; \
                NDI_audio_frame.sample_rate = (frame)->sample_rate; \
                NDI_audio_frame.no_channels = (frame)->ch_count; \
                NDI_audio_frame.reference_level = s->audio_level; \
                NDI_audio_frame.timecode = NDIlib_send_timecode_synthesize; \
                NDI_audio_frame.p_data = (int ## bit_depth ## _t *)(void *) (frame)->data; \
                NDI_audio_frame.no_samples = (frame)->data_len / (frame)->ch_count / ((bit_depth) / 8); \
                \
                s->NDIlib->util_send_send_audio_interleaved_ ## bit_depth ## s(s->pNDI_send, &NDI_audio_frame); \
        } while(0)
 
static void display_ndi_put_audio_frame(void *state, const struct audio_frame *frame)
{
        struct display_ndi *s = (struct display_ndi *) state;
        switch (frame->bps * 8) {
#define HANDLE_CASE(b) case b: NDI_SEND_AUDIO(frame, b); break;
        HANDLE_CASE(16)
        HANDLE_CASE(32)
        default:
                abort();
        }
}
 
static bool display_ndi_reconfigure_audio(void *state, int quant_samples, int channels,
                int sample_rate)
{
        struct display_ndi *s = (struct display_ndi *) state;
        s->audio_desc.bps = quant_samples / 8;
        s->audio_desc.ch_count = channels;
        s->audio_desc.sample_rate = sample_rate;
 
        return true;
}
 
static const struct video_display_info display_ndi_info = {
        display_ndi_probe,
        display_ndi_init,
        NULL, // _run
        display_ndi_done,
        display_ndi_getf,
        display_ndi_putf,
        display_ndi_reconfigure,
        display_ndi_get_property,
        display_ndi_put_audio_frame,
        display_ndi_reconfigure_audio,
        MOD_NAME,
};
 
REGISTER_MODULE(ndi, &display_ndi_info, LIBRARY_CLASS_VIDEO_DISPLAY, VIDEO_DISPLAY_ABI_VERSION);
 
/* vim: set expandtab sw=8: */