FFmpeg  4.0
libndi_newtek_dec.c
Go to the documentation of this file.
1 /*
2  * Newtek NDI input
3  * Copyright (c) 2017 Maksym Veremeyenko
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include "libavformat/avformat.h"
23 #include "libavformat/internal.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/imgutils.h"
26 
27 #include "libndi_newtek_common.h"
28 
29 struct NDIContext {
30  const AVClass *cclass;
31 
32  /* Options */
34  int64_t wait_sources;
36 
37  /* Runtime */
38  NDIlib_recv_create_t *recv;
39  NDIlib_find_instance_t ndi_find;
40 
41  /* Streams */
43 };
44 
45 static int ndi_set_video_packet(AVFormatContext *avctx, NDIlib_video_frame_t *v, AVPacket *pkt)
46 {
47  int ret;
48  struct NDIContext *ctx = avctx->priv_data;
49 
50  ret = av_new_packet(pkt, v->yres * v->line_stride_in_bytes);
51  if (ret < 0)
52  return ret;
53 
54  pkt->dts = pkt->pts = av_rescale_q(v->timecode, NDI_TIME_BASE_Q, ctx->video_st->time_base);
55  pkt->duration = av_rescale_q(1, (AVRational){v->frame_rate_D, v->frame_rate_N}, ctx->video_st->time_base);
56 
57  av_log(avctx, AV_LOG_DEBUG, "%s: pkt->dts = pkt->pts = %"PRId64", duration=%"PRId64", timecode=%"PRId64"\n",
58  __func__, pkt->dts, pkt->duration, v->timecode);
59 
60  pkt->flags |= AV_PKT_FLAG_KEY;
61  pkt->stream_index = ctx->video_st->index;
62 
63  memcpy(pkt->data, v->p_data, pkt->size);
64 
65  return 0;
66 }
67 
68 static int ndi_set_audio_packet(AVFormatContext *avctx, NDIlib_audio_frame_t *a, AVPacket *pkt)
69 {
70  int ret;
71  struct NDIContext *ctx = avctx->priv_data;
72 
73  NDIlib_audio_frame_interleaved_16s_t dst;
74 
75  ret = av_new_packet(pkt, 2 * a->no_samples * a->no_channels);
76  if (ret < 0)
77  return ret;
78 
79  pkt->dts = pkt->pts = av_rescale_q(a->timecode, NDI_TIME_BASE_Q, ctx->audio_st->time_base);
80  pkt->duration = av_rescale_q(1, (AVRational){a->no_samples, a->sample_rate}, ctx->audio_st->time_base);
81 
82  av_log(avctx, AV_LOG_DEBUG, "%s: pkt->dts = pkt->pts = %"PRId64", duration=%"PRId64", timecode=%"PRId64"\n",
83  __func__, pkt->dts, pkt->duration, a->timecode);
84 
85  pkt->flags |= AV_PKT_FLAG_KEY;
86  pkt->stream_index = ctx->audio_st->index;
87 
88  dst.reference_level = 0;
89  dst.p_data = (short *)pkt->data;
90  NDIlib_util_audio_to_interleaved_16s(a, &dst);
91 
92  return 0;
93 }
94 
95 static int ndi_find_sources(AVFormatContext *avctx, const char *name, NDIlib_source_t *source_to_connect_to)
96 {
97  int j = AVERROR(ENODEV);
98  unsigned int n, i;
99  struct NDIContext *ctx = avctx->priv_data;
100  const NDIlib_source_t *ndi_srcs = NULL;
101  const NDIlib_find_create_t find_create_desc = { .show_local_sources = true,
102  .p_groups = NULL, .p_extra_ips = NULL };
103 
104  if (!ctx->ndi_find)
105  ctx->ndi_find = NDIlib_find_create2(&find_create_desc);
106  if (!ctx->ndi_find) {
107  av_log(avctx, AV_LOG_ERROR, "NDIlib_find_create failed.\n");
108  return AVERROR(EIO);
109  }
110 
111  while (1)
112  {
113  int f, t = ctx->wait_sources / 1000;
114  av_log(avctx, AV_LOG_DEBUG, "Waiting for sources %d miliseconds\n", t);
115  f = NDIlib_find_wait_for_sources(ctx->ndi_find, t);
116  av_log(avctx, AV_LOG_DEBUG, "NDIlib_find_wait_for_sources returns %d\n", f);
117  if (!f)
118  break;
119  };
120 
121  ndi_srcs = NDIlib_find_get_current_sources(ctx->ndi_find, &n);
122 
123  if (ctx->find_sources)
124  av_log(avctx, AV_LOG_INFO, "Found %d NDI sources:\n", n);
125 
126  for (i = 0; i < n; i++) {
127  if (ctx->find_sources)
128  av_log(avctx, AV_LOG_INFO, "\t'%s'\t'%s'\n", ndi_srcs[i].p_ndi_name, ndi_srcs[i].p_ip_address);
129 
130  if (!strcmp(name, ndi_srcs[i].p_ndi_name)) {
131  *source_to_connect_to = ndi_srcs[i];
132  j = i;
133  }
134  }
135 
136  return j;
137 }
138 
140 {
141  int ret;
142  NDIlib_recv_create_t recv_create_desc;
143  const NDIlib_tally_t tally_state = { .on_program = true, .on_preview = false };
144  struct NDIContext *ctx = avctx->priv_data;
145 
146  if (!NDIlib_initialize()) {
147  av_log(avctx, AV_LOG_ERROR, "NDIlib_initialize failed.\n");
148  return AVERROR_EXTERNAL;
149  }
150 
151  /* Find available sources. */
152  ret = ndi_find_sources(avctx, avctx->url, &recv_create_desc.source_to_connect_to);
153  if (ctx->find_sources) {
154  return AVERROR_EXIT;
155  }
156  if (ret < 0)
157  return ret;
158 
159  /* Create receiver description */
160  recv_create_desc.color_format = NDIlib_recv_color_format_e_UYVY_RGBA;
161  recv_create_desc.bandwidth = NDIlib_recv_bandwidth_highest;
162  recv_create_desc.allow_video_fields = ctx->allow_video_fields;
163 
164  /* Create the receiver */
165  ctx->recv = NDIlib_recv_create(&recv_create_desc);
166  if (!ctx->recv) {
167  av_log(avctx, AV_LOG_ERROR, "NDIlib_recv_create2 failed.\n");
168  return AVERROR(EIO);
169  }
170 
171  /* Set tally */
172  NDIlib_recv_set_tally(ctx->recv, &tally_state);
173 
174  avctx->ctx_flags |= AVFMTCTX_NOHEADER;
175 
176  return 0;
177 }
178 
179 static int ndi_create_video_stream(AVFormatContext *avctx, NDIlib_video_frame_t *v)
180 {
181  AVStream *st;
182  AVRational tmp;
183  struct NDIContext *ctx = avctx->priv_data;
184 
185  st = avformat_new_stream(avctx, NULL);
186  if (!st) {
187  av_log(avctx, AV_LOG_ERROR, "Cannot add video stream\n");
188  return AVERROR(ENOMEM);
189  }
190 
192  st->r_frame_rate = av_make_q(v->frame_rate_N, v->frame_rate_D);
193 
194  tmp = av_mul_q(av_d2q(v->picture_aspect_ratio, INT_MAX), (AVRational){v->yres, v->xres});
195  av_reduce(&st->sample_aspect_ratio.num, &st->sample_aspect_ratio.den, tmp.num, tmp.den, 1000);
197 
199  st->codecpar->width = v->xres;
200  st->codecpar->height = v->yres;
202  st->codecpar->bit_rate = av_rescale(v->xres * v->yres * 16, v->frame_rate_N, v->frame_rate_D);
203  st->codecpar->field_order = v->frame_format_type == NDIlib_frame_format_type_progressive
205 
206  if (NDIlib_FourCC_type_UYVY == v->FourCC || NDIlib_FourCC_type_UYVA == v->FourCC) {
208  st->codecpar->codec_tag = MKTAG('U', 'Y', 'V', 'Y');
209  if (NDIlib_FourCC_type_UYVA == v->FourCC)
210  av_log(avctx, AV_LOG_WARNING, "Alpha channel ignored\n");
211  } else if (NDIlib_FourCC_type_BGRA == v->FourCC) {
213  st->codecpar->codec_tag = MKTAG('B', 'G', 'R', 'A');
214  } else if (NDIlib_FourCC_type_BGRX == v->FourCC) {
216  st->codecpar->codec_tag = MKTAG('B', 'G', 'R', '0');
217  } else if (NDIlib_FourCC_type_RGBA == v->FourCC) {
219  st->codecpar->codec_tag = MKTAG('R', 'G', 'B', 'A');
220  } else if (NDIlib_FourCC_type_RGBX == v->FourCC) {
222  st->codecpar->codec_tag = MKTAG('R', 'G', 'B', '0');
223  } else {
224  av_log(avctx, AV_LOG_ERROR, "Unsupported video stream format, v->FourCC=%d\n", v->FourCC);
225  return AVERROR(EINVAL);
226  }
227 
229 
230  ctx->video_st = st;
231 
232  return 0;
233 }
234 
235 static int ndi_create_audio_stream(AVFormatContext *avctx, NDIlib_audio_frame_t *a)
236 {
237  AVStream *st;
238  struct NDIContext *ctx = avctx->priv_data;
239 
240  st = avformat_new_stream(avctx, NULL);
241  if (!st) {
242  av_log(avctx, AV_LOG_ERROR, "Cannot add audio stream\n");
243  return AVERROR(ENOMEM);
244  }
245 
248  st->codecpar->sample_rate = a->sample_rate;
249  st->codecpar->channels = a->no_channels;
250 
252 
253  ctx->audio_st = st;
254 
255  return 0;
256 }
257 
259 {
260  int ret = 0;
261  struct NDIContext *ctx = avctx->priv_data;
262 
263  while (!ret) {
264  NDIlib_video_frame_t v;
265  NDIlib_audio_frame_t a;
266  NDIlib_metadata_frame_t m;
267  NDIlib_frame_type_e t;
268 
269  av_log(avctx, AV_LOG_DEBUG, "NDIlib_recv_capture...\n");
270  t = NDIlib_recv_capture(ctx->recv, &v, &a, &m, 40);
271  av_log(avctx, AV_LOG_DEBUG, "NDIlib_recv_capture=%d\n", t);
272 
273  if (t == NDIlib_frame_type_video) {
274  if (!ctx->video_st)
275  ret = ndi_create_video_stream(avctx, &v);
276  if (!ret)
277  ret = ndi_set_video_packet(avctx, &v, pkt);
278  NDIlib_recv_free_video(ctx->recv, &v);
279  break;
280  }
281  else if (t == NDIlib_frame_type_audio) {
282  if (!ctx->audio_st)
283  ret = ndi_create_audio_stream(avctx, &a);
284  if (!ret)
285  ret = ndi_set_audio_packet(avctx, &a, pkt);
286  NDIlib_recv_free_audio(ctx->recv, &a);
287  break;
288  }
289  else if (t == NDIlib_frame_type_metadata)
290  NDIlib_recv_free_metadata(ctx->recv, &m);
291  else if (t == NDIlib_frame_type_error){
292  av_log(avctx, AV_LOG_ERROR, "NDIlib_recv_capture failed with error\n");
293  ret = AVERROR(EIO);
294  }
295  };
296 
297  return ret;
298 }
299 
300 static int ndi_read_close(AVFormatContext *avctx)
301 {
302  struct NDIContext *ctx = (struct NDIContext *)avctx->priv_data;
303 
304  if (ctx->recv)
305  NDIlib_recv_destroy(ctx->recv);
306 
307  if (ctx->ndi_find)
308  NDIlib_find_destroy(ctx->ndi_find);
309 
310  return 0;
311 }
312 
313 #define OFFSET(x) offsetof(struct NDIContext, x)
314 #define DEC AV_OPT_FLAG_DECODING_PARAM
315 
316 static const AVOption options[] = {
317  { "find_sources", "Find available sources" , OFFSET(find_sources), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, DEC },
318  { "wait_sources", "Time to wait until the number of online sources have changed" , OFFSET(wait_sources), AV_OPT_TYPE_DURATION, { .i64 = 1000000 }, 100000, 20000000, DEC },
319  { "allow_video_fields", "When this flag is FALSE, all video that you receive will be progressive" , OFFSET(allow_video_fields), AV_OPT_TYPE_BOOL, { .i64 = 1 }, 0, 1, DEC },
320  { NULL },
321 };
322 
324  .class_name = "NDI demuxer",
325  .item_name = av_default_item_name,
326  .option = options,
327  .version = LIBAVUTIL_VERSION_INT,
329 };
330 
332  .name = "libndi_newtek",
333  .long_name = NULL_IF_CONFIG_SMALL("Network Device Interface (NDI) input using NewTek library"),
334  .flags = AVFMT_NOFILE,
335  .priv_class = &libndi_newtek_demuxer_class,
336  .priv_data_size = sizeof(struct NDIContext),
337  .read_header = ndi_read_header,
338  .read_packet = ndi_read_packet,
339  .read_close = ndi_read_close,
340 };
const char * name
Definition: avisynth_c.h:775
packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1
Definition: pixfmt.h:77
#define NULL
Definition: coverity.c:32
enum AVFieldOrder field_order
Video only.
Definition: avcodec.h:3965
AVOption.
Definition: opt.h:246
misc image utilities
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:4811
AVRational sample_aspect_ratio
Video only.
Definition: avcodec.h:3960
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3884
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown)
Definition: avformat.h:935
int num
Numerator.
Definition: rational.h:59
int index
stream index in AVFormatContext
Definition: avformat.h:874
int size
Definition: avcodec.h:1431
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
static AVPacket pkt
static const AVOption options[]
int ctx_flags
Flags signalling stream properties.
Definition: avformat.h:1391
static int ndi_read_packet(AVFormatContext *avctx, AVPacket *pkt)
AVInputFormat ff_libndi_newtek_demuxer
Format I/O context.
Definition: avformat.h:1342
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
static int ndi_read_header(AVFormatContext *avctx)
NDIlib_recv_create_t * recv
int width
Video only.
Definition: avcodec.h:3950
packed RGB 8:8:8, 32bpp, RGBXRGBX... X=unused/undefined
Definition: pixfmt.h:234
#define AVFMTCTX_NOHEADER
signal that no header is present (streams are added dynamically)
Definition: avformat.h:1286
AVOptions.
#define NDI_TIME_BASE_Q
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1448
AVStream * audio_st
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:4441
uint8_t * data
Definition: avcodec.h:1430
int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max)
Reduce a fraction.
Definition: rational.c:35
#define av_log(a,...)
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: avcodec.h:3913
#define AV_PKT_FLAG_KEY
The packet contains a keyframe.
Definition: avcodec.h:1462
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:142
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:86
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:91
char * url
input or output URL.
Definition: avformat.h:1438
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:197
enum AVMediaType codec_type
General type of the encoded data.
Definition: avcodec.h:3880
static int ndi_create_video_stream(AVFormatContext *avctx, NDIlib_video_frame_t *v)
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:89
int flags
A combination of AV_PKT_FLAG values.
Definition: avcodec.h:1436
static int ndi_read_close(AVFormatContext *avctx)
NDIlib_find_instance_t ndi_find
int64_t av_rescale(int64_t a, int64_t b, int64_t c)
Rescale a 64-bit integer with rounding to nearest.
Definition: mathematics.c:129
static const AVClass libndi_newtek_demuxer_class
AVFormatContext * ctx
Definition: movenc.c:48
int n
Definition: avisynth_c.h:684
static int ndi_find_sources(AVFormatContext *avctx, const char *name, NDIlib_source_t *source_to_connect_to)
#define AVERROR_EXIT
Immediate exit was requested; the called function should not be restarted.
Definition: error.h:56
if(ret< 0)
Definition: vf_mcdeint.c:279
Stream structure.
Definition: avformat.h:873
#define AV_LOG_INFO
Standard information.
Definition: log.h:187
static AVRational av_make_q(int num, int den)
Create an AVRational.
Definition: rational.h:71
Describe the class of an AVClass context structure.
Definition: log.h:67
static int ndi_create_audio_stream(AVFormatContext *avctx, NDIlib_audio_frame_t *a)
Rational number (pair of numerator and denominator).
Definition: rational.h:58
packed BGR 8:8:8, 32bpp, BGRXBGRX... X=unused/undefined
Definition: pixfmt.h:236
static int ndi_set_video_packet(AVFormatContext *avctx, NDIlib_video_frame_t *v, AVPacket *pkt)
static int ndi_set_audio_packet(AVFormatContext *avctx, NDIlib_audio_frame_t *a, AVPacket *pkt)
AVRational av_d2q(double d, int max)
Convert a double precision floating point number to a rational.
Definition: rational.c:106
AVStream * video_st
int sample_rate
Audio only.
Definition: avcodec.h:3994
Main libavformat public API header.
#define DEC
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:465
int64_t wait_sources
int den
Denominator.
Definition: rational.h:60
const AVClass * cclass
void * priv_data
Format private data.
Definition: avformat.h:1370
int channels
Audio only.
Definition: avcodec.h:3990
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed...
Definition: avcodec.h:1429
AVRational av_mul_q(AVRational b, AVRational c)
Multiply two rationals.
Definition: rational.c:80
#define OFFSET(x)
#define NDI_TIME_BASE
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:647
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1020
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: avcodec.h:3888
int stream_index
Definition: avcodec.h:1432
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avformat.h:902
#define MKTAG(a, b, c, d)
Definition: common.h:366
AVRational r_frame_rate
Real base framerate of the stream.
Definition: avformat.h:997
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:57
This structure stores compressed data.
Definition: avcodec.h:1407
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1423
static uint8_t tmp[11]
Definition: aes_ctr.c:26