2 * Copyright (C) 2020 Sebastian Dröge <sebastian@centricular.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 /* Implementation of SMPTE 436M - MXF Mappings for VBI Lines
21 * and Ancillary Data Packets
29 #include <gst/base/base.h>
30 #include <gst/video/video.h>
34 #include "mxfessence.h"
36 GST_DEBUG_CATEGORY_EXTERN (mxf_debug);
37 #define GST_CAT_DEFAULT mxf_debug
40 #define MXF_TYPE_METADATA_VANC_DESCRIPTOR \
41 (mxf_metadata_vanc_descriptor_get_type())
42 #define MXF_METADATA_VANC_DESCRIPTOR(obj) \
43 (G_TYPE_CHECK_INSTANCE_CAST((obj),MXF_TYPE_METADATA_VANC_DESCRIPTOR, MXFMetadataVANCDescriptor))
44 #define MXF_IS_METADATA_VANC_DESCRIPTOR(obj) \
45 (G_TYPE_CHECK_INSTANCE_TYPE((obj),MXF_TYPE_METADATA_VANC_DESCRIPTOR))
46 typedef struct _MXFMetadataVANCDescriptor MXFMetadataVANCDescriptor;
47 typedef MXFMetadataClass MXFMetadataVANCDescriptorClass;
48 GType mxf_metadata_vanc_descriptor_get_type (void);
50 struct _MXFMetadataVANCDescriptor
52 MXFMetadataGenericDataEssenceDescriptor parent;
55 G_DEFINE_TYPE (MXFMetadataVANCDescriptor,
56 mxf_metadata_vanc_descriptor,
57 MXF_TYPE_METADATA_GENERIC_DATA_ESSENCE_DESCRIPTOR);
60 mxf_metadata_vanc_descriptor_init (MXFMetadataVANCDescriptor * self)
65 mxf_metadata_vanc_descriptor_class_init
66 (MXFMetadataVANCDescriptorClass * klass)
68 MXFMetadataClass *metadata_class = (MXFMetadataClass *) klass;
70 metadata_class->type = 0x015c;
74 mxf_is_vanc_essence_track (const MXFMetadataTimelineTrack * track)
78 g_return_val_if_fail (track != NULL, FALSE);
80 if (track->parent.descriptor == NULL)
83 for (i = 0; i < track->parent.n_descriptor; i++) {
84 MXFMetadataFileDescriptor *d = track->parent.descriptor[i];
90 key = &d->essence_container;
92 if (mxf_is_generic_container_essence_container_label (key) &&
93 key->u[12] == 0x02 && key->u[13] == 0x0e &&
94 key->u[14] == 0x00 && key->u[15] == 0x00)
102 mxf_vanc_handle_essence_element (const MXFUL * key, GstBuffer * buffer,
104 MXFMetadataTimelineTrack * track,
105 gpointer mapping_data, GstBuffer ** outbuf)
108 GstByteReader reader;
109 GstFlowReturn ret = GST_FLOW_ERROR;
110 guint16 num_packets, i;
113 if (key->u[12] != 0x17 || key->u[14] != 0x02) {
114 GST_ERROR ("Invalid VANC essence element");
115 gst_buffer_unref (buffer);
116 return GST_FLOW_ERROR;
119 if (gst_buffer_get_size (buffer) < 2) {
120 GST_ERROR ("Invalid VANC essence element size");
121 gst_buffer_unref (buffer);
122 return GST_FLOW_ERROR;
125 gst_buffer_map (buffer, &map, GST_MAP_READ);
126 gst_byte_reader_init (&reader, map.data, map.size);
128 num_packets = gst_byte_reader_get_uint16_be_unchecked (&reader);
129 if (num_packets == 0) {
130 /* SMPTE 436-1:2013 5.5 The Number of VI Lines or ANC Packets Property
132 * One of the properties in the VI Element is the “Number of Lines” which is
133 * the number of the VI lines contained in this VI Element. This number can
134 * be zero if the current VI Element does not have any VI lines in the
135 * payload space. This capability can be used so every Content Package in a
136 * file can have a VI Element even if the video stream does not have VI
137 * lines with every frame (or field.)
139 * The same scheme can be used for ANC packets.
142 *outbuf = gst_buffer_new ();
143 GST_BUFFER_FLAG_SET (*outbuf, GST_BUFFER_FLAG_GAP);
147 for (i = 0; i < num_packets; i++) {
148 G_GNUC_UNUSED guint16 line_num;
149 G_GNUC_UNUSED guint8 wrapping_type;
150 guint8 payload_sample_coding;
151 guint16 payload_sample_count;
153 guint32 array_item_size;
157 if (gst_byte_reader_get_remaining (&reader) < 16)
160 line_num = gst_byte_reader_get_uint16_be_unchecked (&reader);
161 wrapping_type = gst_byte_reader_get_uint8_unchecked (&reader);
162 payload_sample_coding = gst_byte_reader_get_uint8_unchecked (&reader);
163 payload_sample_count = gst_byte_reader_get_uint16_be_unchecked (&reader);
165 array_count = gst_byte_reader_get_uint32_be_unchecked (&reader);
166 array_item_size = gst_byte_reader_get_uint32_be_unchecked (&reader);
168 /* Skip over anything that is not 8 bit VANC */
169 if (payload_sample_coding != 4 && payload_sample_coding != 5
170 && payload_sample_coding != 6) {
171 if (!gst_byte_reader_skip (&reader, array_count * array_item_size))
176 if (gst_byte_reader_get_remaining (&reader) < array_count * array_item_size)
179 if (gst_byte_reader_get_remaining (&reader) < payload_sample_count)
182 if (payload_sample_count < 2) {
183 if (!gst_byte_reader_skip (&reader, array_count * array_item_size))
188 did = gst_byte_reader_get_uint8_unchecked (&reader);
189 sdid = gst_byte_reader_get_uint8_unchecked (&reader);
191 /* Not S334 EIA-708 */
192 if (did != 0x61 && sdid != 0x01) {
193 if (!gst_byte_reader_skip (&reader, array_count * array_item_size - 2))
198 if (payload_sample_count < 2) {
199 if (!gst_byte_reader_skip (&reader, array_count * array_item_size - 2))
204 cdp_size = gst_byte_reader_get_uint8_unchecked (&reader);
205 if (payload_sample_count - 3 < cdp_size) {
206 if (!gst_byte_reader_skip (&reader, array_count * array_item_size - 3))
211 gst_buffer_unmap (buffer, &map);
213 gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL,
214 gst_byte_reader_get_pos (&reader), cdp_size);
215 gst_buffer_unref (buffer);
219 gst_buffer_unmap (buffer, &map);
220 gst_buffer_unref (buffer);
225 static MXFEssenceWrapping
226 mxf_vanc_get_track_wrapping (const MXFMetadataTimelineTrack * track)
228 g_return_val_if_fail (track != NULL, MXF_ESSENCE_WRAPPING_CUSTOM_WRAPPING);
230 if (track->parent.descriptor == NULL) {
231 GST_ERROR ("No descriptor found for this track");
232 return MXF_ESSENCE_WRAPPING_CUSTOM_WRAPPING;
235 return MXF_ESSENCE_WRAPPING_FRAME_WRAPPING;
239 mxf_vanc_create_caps (MXFMetadataTimelineTrack * track, GstTagList ** tags,
240 gboolean * intra_only, MXFEssenceElementHandleFunc * handler,
241 gpointer * mapping_data)
243 GstCaps *caps = NULL;
245 MXFMetadataFileDescriptor *f = NULL;
246 MXFMetadataVANCDescriptor *p = NULL;
248 g_return_val_if_fail (track != NULL, NULL);
250 if (track->parent.descriptor == NULL) {
251 GST_ERROR ("No descriptor found for this track");
255 for (i = 0; i < track->parent.n_descriptor; i++) {
256 if (!track->parent.descriptor[i])
259 if (MXF_IS_METADATA_VANC_DESCRIPTOR (track->parent.descriptor[i])) {
260 p = (MXFMetadataVANCDescriptor *) track->parent.descriptor[i];
261 f = track->parent.descriptor[i];
263 } else if (MXF_IS_METADATA_FILE_DESCRIPTOR (track->parent.descriptor[i]) &&
264 !MXF_IS_METADATA_MULTIPLE_DESCRIPTOR (track->parent.descriptor[i])) {
265 f = track->parent.descriptor[i];
270 GST_ERROR ("No descriptor found for this track");
274 *handler = mxf_vanc_handle_essence_element;
277 gst_caps_new_simple ("closedcaption/x-cea-708", "format",
278 G_TYPE_STRING, "cdp", NULL);
280 if (p && p->parent.parent.sample_rate.d != 0) {
281 gst_caps_set_simple (caps, "framerate", GST_TYPE_FRACTION,
282 p->parent.parent.sample_rate.n, p->parent.parent.sample_rate.d, NULL);
290 static const MXFEssenceElementHandler mxf_vanc_essence_element_handler = {
291 mxf_is_vanc_essence_track,
292 mxf_vanc_get_track_wrapping,
297 mxf_vanc_write_func (GstBuffer * buffer,
298 gpointer mapping_data, GstAdapter * adapter, GstBuffer ** outbuf,
302 GstByteWriter writer;
308 gst_buffer_map (buffer, &map, GST_MAP_READ);
310 size = GST_ROUND_UP_4 (map.size) + 20;
312 gst_byte_writer_init_with_size (&writer, size, TRUE);
314 gst_byte_writer_put_uint16_be_unchecked (&writer, 1);
315 gst_byte_writer_put_uint16_be_unchecked (&writer, 9);
316 gst_byte_writer_put_uint8_unchecked (&writer, 1);
317 gst_byte_writer_put_uint8_unchecked (&writer, 4);
318 gst_byte_writer_put_uint16_be_unchecked (&writer, map.size + 4);
319 gst_byte_writer_put_uint32_be_unchecked (&writer,
320 GST_ROUND_UP_4 (map.size + 4));
321 gst_byte_writer_put_uint32_be_unchecked (&writer, 1);
323 gst_byte_writer_put_uint16_be_unchecked (&writer, 0x6101);
324 gst_byte_writer_put_uint8_unchecked (&writer, map.size);
326 gst_byte_writer_put_data_unchecked (&writer, map.data, map.size);
328 checksum = 0x61 + 0x01 + map.size;
329 for (i = 0; i < map.size; i++)
330 checksum += map.data[i];
331 gst_byte_writer_put_uint8_unchecked (&writer, checksum & 0xff);
333 if (GST_ROUND_UP_4 (map.size) != map.size) {
334 gst_byte_writer_fill_unchecked (&writer, 0,
335 GST_ROUND_UP_4 (map.size) - map.size);
338 data = gst_byte_writer_reset_and_get_data (&writer);
340 gst_buffer_unmap (buffer, &map);
341 gst_buffer_unref (buffer);
343 *outbuf = gst_buffer_new_wrapped (data, size);
348 static const guint8 vanc_essence_container_ul[] = {
349 0x06, 0x0e, 0x2b, 0x34, 0x04, 0x01, 0x01, 0x09,
350 0x0d, 0x01, 0x03, 0x01, 0x02, 0x0e, 0x00, 0x00
353 static MXFMetadataFileDescriptor *
354 mxf_vanc_get_descriptor (GstPadTemplate * tmpl, GstCaps * caps,
355 MXFEssenceElementWriteFunc * handler, gpointer * mapping_data)
357 MXFMetadataVANCDescriptor *ret;
362 s = gst_caps_get_structure (caps, 0);
363 if (strcmp (gst_structure_get_name (s), "closedcaption/x-cea-708") != 0 ||
364 !(format = gst_structure_get_string (s, "format")) ||
365 strcmp (format, "cdp") != 0 ||
366 !gst_structure_get_value (s, "framerate")) {
367 GST_ERROR ("Invalid caps %" GST_PTR_FORMAT, caps);
371 gst_structure_get_fraction (s, "framerate", &fps_n, &fps_d);
373 ret = (MXFMetadataVANCDescriptor *)
374 g_object_new (MXF_TYPE_METADATA_VANC_DESCRIPTOR, NULL);
376 memcpy (&ret->parent.parent.essence_container, &vanc_essence_container_ul,
379 *handler = mxf_vanc_write_func;
381 return (MXFMetadataFileDescriptor *) ret;
385 mxf_vanc_update_descriptor (MXFMetadataFileDescriptor * d, GstCaps * caps,
386 gpointer mapping_data, GstBuffer * buf)
392 mxf_vanc_get_edit_rate (MXFMetadataFileDescriptor * a, GstCaps * caps,
393 gpointer mapping_data, GstBuffer * buf, MXFMetadataSourcePackage * package,
394 MXFMetadataTimelineTrack * track, MXFFraction * edit_rate)
396 const GstStructure *s;
399 s = gst_caps_get_structure (caps, 0);
400 if (!gst_structure_get_fraction (s, "framerate", &fps_n, &fps_d))
403 edit_rate->n = fps_n;
404 edit_rate->d = fps_d;
408 mxf_vanc_get_track_number_template (MXFMetadataFileDescriptor * a,
409 GstCaps * caps, gpointer mapping_data)
411 return (0x17 << 24) | (0x02 << 8);
414 static MXFEssenceElementWriter mxf_vanc_essence_element_writer = {
415 mxf_vanc_get_descriptor,
416 mxf_vanc_update_descriptor,
417 mxf_vanc_get_edit_rate,
418 mxf_vanc_get_track_number_template,
424 * GstMXFMux!vanc_sink_%u:
432 mxf_metadata_register (MXF_TYPE_METADATA_VANC_DESCRIPTOR);
433 mxf_essence_element_handler_register (&mxf_vanc_essence_element_handler);
435 mxf_vanc_essence_element_writer.pad_template =
436 gst_pad_template_new ("vanc_sink_%u", GST_PAD_SINK,
439 ("closedcaption/x-cea-708, format = (string) cdp, framerate = "
440 GST_VIDEO_FPS_RANGE));
441 memcpy (&mxf_vanc_essence_element_writer.data_definition,
442 mxf_metadata_track_identifier_get (MXF_METADATA_TRACK_DATA_ESSENCE), 16);
443 mxf_essence_element_writer_register (&mxf_vanc_essence_element_writer);