FFmpeg
prores_metadata.c
Go to the documentation of this file.
1 /*
2  * Prores Metadata bitstream filter
3  * Copyright (c) 2018 Jokyo Images
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 /**
23  * @file
24  * Prores Metadata bitstream filter
25  * set frame colorspace property
26  */
27 
28 #include "libavutil/common.h"
29 #include "libavutil/intreadwrite.h"
30 #include "libavutil/opt.h"
31 
32 #include "bsf.h"
33 #include "bsf_internal.h"
34 
35 typedef struct ProresMetadataContext {
36  const AVClass *class;
37 
38  int color_primaries;
39  int transfer_characteristics;
40  int matrix_coefficients;
41 } ProresMetadataContext;
42 
43 static int prores_metadata(AVBSFContext *bsf, AVPacket *pkt)
44 {
45  ProresMetadataContext *ctx = bsf->priv_data;
46  int ret = 0;
47  int buf_size;
48  uint8_t *buf;
49 
50  ret = ff_bsf_get_packet_ref(bsf, pkt);
51  if (ret < 0)
52  return ret;
53 
54  ret = av_packet_make_writable(pkt);
55  if (ret < 0)
56  goto fail;
57 
58  buf = pkt->data;
59  buf_size = pkt->size;
60 
61  /* check start of the prores frame */
62  if (buf_size < 28) {
63  av_log(bsf, AV_LOG_ERROR, "not enough data in prores frame\n");
64  ret = AVERROR_INVALIDDATA;
65  goto fail;
66  }
67 
68  if (AV_RL32(buf + 4) != AV_RL32("icpf")) {
69  av_log(bsf, AV_LOG_ERROR, "invalid frame header\n");
70  ret = AVERROR_INVALIDDATA;
71  goto fail;
72  }
73 
74  if (AV_RB16(buf + 8) < 28) {
75  av_log(bsf, AV_LOG_ERROR, "invalid frame header size\n");
76  ret = AVERROR_INVALIDDATA;
77  goto fail;
78  }
79 
80  /* set the new values */
81  if (ctx->color_primaries != -1)
82  buf[8+14] = ctx->color_primaries;
83  if (ctx->transfer_characteristics != -1)
84  buf[8+15] = ctx->transfer_characteristics;
85  if (ctx->matrix_coefficients != -1)
86  buf[8+16] = ctx->matrix_coefficients;
87 
88 fail:
89  if (ret < 0)
90  av_packet_unref(pkt);
91  return ret;
92 }
93 
94 static const enum AVCodecID codec_ids[] = {
95  AV_CODEC_ID_PRORES, AV_CODEC_ID_NONE,
96 };
97 
98 static int prores_metadata_init(AVBSFContext *bsf)
99 {
100  ProresMetadataContext *ctx = bsf->priv_data;
101  /*! check options */
102  switch (ctx->color_primaries) {
103  case -1:
104  case 0:
105  case AVCOL_PRI_BT709:
106  case AVCOL_PRI_BT470BG:
107  case AVCOL_PRI_SMPTE170M:
108  case AVCOL_PRI_BT2020:
109  case AVCOL_PRI_SMPTE431:
110  case AVCOL_PRI_SMPTE432:
111  break;
112  default:
113  av_log(bsf, AV_LOG_ERROR, "Color primaries %d is not a valid value\n", ctx->color_primaries);
114  return AVERROR(EINVAL);
115  }
116 
117  switch (ctx->matrix_coefficients) {
118  case -1:
119  case 0:
120  case AVCOL_SPC_BT709:
121  case AVCOL_SPC_SMPTE170M:
122  case AVCOL_SPC_BT2020_NCL:
123  break;
124  default:
125  av_log(bsf, AV_LOG_ERROR, "Colorspace %d is not a valid value\n", ctx->matrix_coefficients);
126  return AVERROR(EINVAL);
127  }
128 
129  return 0;
130 }
131 
132 #define OFFSET(x) offsetof(ProresMetadataContext, x)
133 #define FLAGS (AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_BSF_PARAM)
134 static const AVOption options[] = {
135  {"color_primaries", "select color primaries", OFFSET(color_primaries), AV_OPT_TYPE_INT, {.i64=-1}, -1, AVCOL_PRI_SMPTE432, FLAGS, .unit = "color_primaries"},
136  {"auto", "keep the same color primaries", 0, AV_OPT_TYPE_CONST, {.i64=-1}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
137  {"unknown", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
138  {"bt709", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_PRI_BT709}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
139  {"bt470bg", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_PRI_BT470BG}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
140  {"smpte170m", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_PRI_SMPTE170M}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
141  {"bt2020", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_PRI_BT2020}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
142  {"smpte431", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_PRI_SMPTE431}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
143  {"smpte432", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_PRI_SMPTE432}, INT_MIN, INT_MAX, FLAGS, .unit = "color_primaries"},
144 
145  {"color_trc", "select color transfer", OFFSET(transfer_characteristics), AV_OPT_TYPE_INT, {.i64=-1}, -1, AVCOL_TRC_NB - 1, FLAGS, .unit = "color_trc"},
146  {"auto", "keep the same color transfer", 0, AV_OPT_TYPE_CONST, {.i64=-1}, INT_MIN, INT_MAX, FLAGS, .unit = "color_trc"},
147  {"unknown", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, INT_MIN, INT_MAX, FLAGS, .unit = "color_trc"},
148  {"bt709", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_TRC_BT709}, INT_MIN, INT_MAX, FLAGS, .unit = "color_trc"},
149  {"smpte2084", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_TRC_SMPTE2084}, INT_MIN, INT_MAX, FLAGS, .unit = "color_trc"},
150  {"arib-std-b67", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_TRC_ARIB_STD_B67}, INT_MIN, INT_MAX, FLAGS, .unit = "color_trc"},
151 
152  {"colorspace", "select colorspace", OFFSET(matrix_coefficients), AV_OPT_TYPE_INT, {.i64=-1}, -1, AVCOL_SPC_BT2020_NCL, FLAGS, .unit = "colorspace"},
153  {"auto", "keep the same colorspace", 0, AV_OPT_TYPE_CONST, {.i64=-1}, INT_MIN, INT_MAX, FLAGS, .unit = "colorspace"},
154  {"unknown", NULL, 0, AV_OPT_TYPE_CONST, {.i64=0}, INT_MIN, INT_MAX, FLAGS, .unit = "colorspace"},
155  {"bt709", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_SPC_BT709}, INT_MIN, INT_MAX, FLAGS, .unit = "colorspace"},
156  {"smpte170m", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_SPC_SMPTE170M}, INT_MIN, INT_MAX, FLAGS, .unit = "colorspace"},
157  {"bt2020nc", NULL, 0, AV_OPT_TYPE_CONST, {.i64=AVCOL_SPC_BT2020_NCL}, INT_MIN, INT_MAX, FLAGS, .unit = "colorspace"},
158 
159  { NULL },
160 };
161 
162 static const AVClass prores_metadata_class = {
163  .class_name = "prores_metadata_bsf",
164  .item_name = av_default_item_name,
165  .option = options,
166  .version = LIBAVUTIL_VERSION_INT,
167 };
168 
169 const FFBitStreamFilter ff_prores_metadata_bsf = {
170  .p.name = "prores_metadata",
171  .p.codec_ids = codec_ids,
172  .p.priv_class = &prores_metadata_class,
173  .priv_data_size = sizeof(ProresMetadataContext),
174  .init = prores_metadata_init,
175  .filter = prores_metadata,
176 };
ProresMetadataContext::matrix_coefficients
int matrix_coefficients
Definition: prores_metadata.c:40
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:427
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
bsf_internal.h
opt.h
prores_metadata_init
static int prores_metadata_init(AVBSFContext *bsf)
Definition: prores_metadata.c:98
AVBitStreamFilter::name
const char * name
Definition: bsf.h:112
prores_metadata_class
static const AVClass prores_metadata_class
Definition: prores_metadata.c:162
codec_ids
static enum AVCodecID codec_ids[]
Definition: prores_metadata.c:94
AVCOL_TRC_NB
@ AVCOL_TRC_NB
Not part of ABI.
Definition: pixfmt.h:602
AVPacket::data
uint8_t * data
Definition: packet.h:522
AVOption
AVOption.
Definition: opt.h:346
prores_metadata
static int prores_metadata(AVBSFContext *bsf, AVPacket *pkt)
Definition: prores_metadata.c:43
filter
filter_frame For filters that do not use the this method is called when a frame is pushed to the filter s input It can be called at any time except in a reentrant way If the input frame is enough to produce then the filter should push the output frames on the output link immediately As an exception to the previous rule if the input frame is enough to produce several output frames then the filter needs output only at least one per link The additional frames can be left buffered in the filter
Definition: filter_design.txt:228
AVBSFContext
The bitstream filter state.
Definition: bsf.h:68
bsf.h
fail
#define fail()
Definition: checkasm.h:179
ProresMetadataContext::transfer_characteristics
int transfer_characteristics
Definition: prores_metadata.c:39
ProresMetadataContext
Definition: prores_metadata.c:35
pkt
AVPacket * pkt
Definition: movenc.c:59
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
intreadwrite.h
AVCOL_SPC_SMPTE170M
@ AVCOL_SPC_SMPTE170M
also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
Definition: pixfmt.h:616
ctx
AVFormatContext * ctx
Definition: movenc.c:48
AVCOL_PRI_BT470BG
@ AVCOL_PRI_BT470BG
also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
Definition: pixfmt.h:562
AVCOL_PRI_SMPTE170M
@ AVCOL_PRI_SMPTE170M
also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
Definition: pixfmt.h:563
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
NULL
#define NULL
Definition: coverity.c:32
FFBitStreamFilter
Definition: bsf_internal.h:27
FLAGS
#define FLAGS
Definition: prores_metadata.c:133
AVCOL_PRI_BT709
@ AVCOL_PRI_BT709
also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP 177 Annex B
Definition: pixfmt.h:557
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
ff_prores_metadata_bsf
const FFBitStreamFilter ff_prores_metadata_bsf
Definition: prores_metadata.c:169
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:49
AVCOL_PRI_BT2020
@ AVCOL_PRI_BT2020
ITU-R BT2020.
Definition: pixfmt.h:566
color_primaries
static const AVColorPrimariesDesc color_primaries[AVCOL_PRI_NB]
Definition: csp.c:76
FFBitStreamFilter::p
AVBitStreamFilter p
The public AVBitStreamFilter.
Definition: bsf_internal.h:31
AVCOL_TRC_SMPTE2084
@ AVCOL_TRC_SMPTE2084
SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems.
Definition: pixfmt.h:597
AVCOL_PRI_SMPTE431
@ AVCOL_PRI_SMPTE431
SMPTE ST 431-2 (2011) / DCI P3.
Definition: pixfmt.h:569
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:365
AVPacket::size
int size
Definition: packet.h:523
transfer_characteristics
static const struct TransferCharacteristics transfer_characteristics[AVCOL_TRC_NB]
Definition: vf_colorspace.c:165
AVCOL_TRC_BT709
@ AVCOL_TRC_BT709
also ITU-R BT1361
Definition: pixfmt.h:582
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
AVCOL_SPC_BT2020_NCL
@ AVCOL_SPC_BT2020_NCL
ITU-R BT2020 non-constant luminance system.
Definition: pixfmt.h:620
common.h
AVBSFContext::priv_data
void * priv_data
Opaque filter-specific private data.
Definition: bsf.h:83
ret
ret
Definition: filter_design.txt:187
AVClass::class_name
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:71
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
AVCOL_TRC_ARIB_STD_B67
@ AVCOL_TRC_ARIB_STD_B67
ARIB STD-B67, known as "Hybrid log-gamma".
Definition: pixfmt.h:601
OFFSET
#define OFFSET(x)
Definition: prores_metadata.c:132
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:235
av_packet_make_writable
int av_packet_make_writable(AVPacket *pkt)
Create a writable reference for the data described by a given packet, avoiding data copy if possible.
Definition: avpacket.c:509
options
static const AVOption options[]
Definition: prores_metadata.c:134
AVCOL_PRI_SMPTE432
@ AVCOL_PRI_SMPTE432
SMPTE ST 432-1 (2010) / P3 D65 / Display P3.
Definition: pixfmt.h:570
AVPacket
This structure stores compressed data.
Definition: packet.h:499
ProresMetadataContext::color_primaries
int color_primaries
Definition: prores_metadata.c:38
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ff_bsf_get_packet_ref
int ff_bsf_get_packet_ref(AVBSFContext *ctx, AVPacket *pkt)
Called by bitstream filters to get packet for filtering.
Definition: bsf.c:256
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AVCOL_SPC_BT709
@ AVCOL_SPC_BT709
also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / derived in SMPTE RP 177 Annex B
Definition: pixfmt.h:611
AV_OPT_TYPE_CONST
@ AV_OPT_TYPE_CONST
Definition: opt.h:244
AV_CODEC_ID_PRORES
@ AV_CODEC_ID_PRORES
Definition: codec_id.h:200
AV_RB16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_WB32 unsigned int_TMPL AV_WB24 unsigned int_TMPL AV_RB16
Definition: bytestream.h:98
Generated on Thu Sep 26 2024 23:14:51 for FFmpeg by   doxygen 1.8.17