FFmpeg
yuv4mpegenc.c
Go to the documentation of this file.
1 /*
2  * YUV4MPEG muxer
3  * Copyright (c) 2001, 2002, 2003 Fabrice Bellard
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 "libavutil/frame.h"
23 #include "libavutil/pixdesc.h"
24 #include "avformat.h"
25 #include "internal.h"
26 #include "mux.h"
27 #include "yuv4mpeg.h"
28 
30 {
31  AVStream *st;
32  AVIOContext *pb = s->pb;
33  int width, height;
34  int raten, rated, aspectn, aspectd, ret;
35  char inter;
36  const char *colorspace = "";
37  const char *colorrange = "";
38  int field_order;
39 
40  st = s->streams[0];
41  width = st->codecpar->width;
42  height = st->codecpar->height;
43  field_order = st->codecpar->field_order;
44 
45  // TODO: should be avg_frame_rate
46  av_reduce(&raten, &rated, st->time_base.den,
47  st->time_base.num, (1UL << 31) - 1);
48 
49  aspectn = st->sample_aspect_ratio.num;
50  aspectd = st->sample_aspect_ratio.den;
51 
52  if (aspectn == 0 && aspectd == 1)
53  aspectd = 0; // 0:0 means unknown
54 
55  switch(st->codecpar->color_range) {
56  case AVCOL_RANGE_MPEG:
57  colorrange = " XCOLORRANGE=LIMITED";
58  break;
59  case AVCOL_RANGE_JPEG:
60  colorrange = " XCOLORRANGE=FULL";
61  break;
62  default:
63  break;
64  }
65 
66  switch (field_order) {
67  case AV_FIELD_TB:
68  case AV_FIELD_TT: inter = 't'; break;
69  case AV_FIELD_BT:
70  case AV_FIELD_BB: inter = 'b'; break;
71  default: inter = 'p'; break;
72  }
73 
74  switch (st->codecpar->format) {
75  case AV_PIX_FMT_GRAY8:
76  colorspace = " Cmono";
77  break;
78  case AV_PIX_FMT_GRAY9:
79  colorspace = " Cmono9";
80  break;
81  case AV_PIX_FMT_GRAY10:
82  colorspace = " Cmono10";
83  break;
84  case AV_PIX_FMT_GRAY12:
85  colorspace = " Cmono12";
86  break;
87  case AV_PIX_FMT_GRAY16:
88  colorspace = " Cmono16";
89  break;
90  case AV_PIX_FMT_YUV411P:
91  colorspace = " C411 XYSCSS=411";
92  break;
94  colorspace = " C420jpeg XYSCSS=420JPEG";
95  colorrange = " XCOLORRANGE=FULL";
96  break;
98  colorspace = " C422 XYSCSS=422";
99  colorrange = " XCOLORRANGE=FULL";
100  break;
101  case AV_PIX_FMT_YUVJ444P:
102  colorspace = " C444 XYSCSS=444";
103  colorrange = " XCOLORRANGE=FULL";
104  break;
105  case AV_PIX_FMT_YUV420P:
106  switch (st->codecpar->chroma_location) {
107  case AVCHROMA_LOC_TOPLEFT: colorspace = " C420paldv XYSCSS=420PALDV"; break;
108  case AVCHROMA_LOC_LEFT: colorspace = " C420mpeg2 XYSCSS=420MPEG2"; break;
109  default: colorspace = " C420jpeg XYSCSS=420JPEG"; break;
110  }
111  break;
112  case AV_PIX_FMT_YUV422P:
113  colorspace = " C422 XYSCSS=422";
114  break;
115  case AV_PIX_FMT_YUV444P:
116  colorspace = " C444 XYSCSS=444";
117  break;
118  case AV_PIX_FMT_YUVA444P:
119  colorspace = " C444alpha XYSCSS=444";
120  break;
121  case AV_PIX_FMT_YUV420P9:
122  colorspace = " C420p9 XYSCSS=420P9";
123  break;
124  case AV_PIX_FMT_YUV422P9:
125  colorspace = " C422p9 XYSCSS=422P9";
126  break;
127  case AV_PIX_FMT_YUV444P9:
128  colorspace = " C444p9 XYSCSS=444P9";
129  break;
131  colorspace = " C420p10 XYSCSS=420P10";
132  break;
134  colorspace = " C422p10 XYSCSS=422P10";
135  break;
137  colorspace = " C444p10 XYSCSS=444P10";
138  break;
140  colorspace = " C420p12 XYSCSS=420P12";
141  break;
143  colorspace = " C422p12 XYSCSS=422P12";
144  break;
146  colorspace = " C444p12 XYSCSS=444P12";
147  break;
149  colorspace = " C420p14 XYSCSS=420P14";
150  break;
152  colorspace = " C422p14 XYSCSS=422P14";
153  break;
155  colorspace = " C444p14 XYSCSS=444P14";
156  break;
158  colorspace = " C420p16 XYSCSS=420P16";
159  break;
161  colorspace = " C422p16 XYSCSS=422P16";
162  break;
164  colorspace = " C444p16 XYSCSS=444P16";
165  break;
166  }
167 
168  ret = avio_printf(pb, Y4M_MAGIC " W%d H%d F%d:%d I%c A%d:%d%s%s\n",
169  width, height, raten, rated, inter,
170  aspectn, aspectd, colorspace, colorrange);
171  if (ret < 0) {
173  "Error. YUV4MPEG stream header write failed.\n");
174  return ret;
175  }
176 
177  return 0;
178 }
179 
180 
182 {
183  AVStream *st = s->streams[pkt->stream_index];
184  AVIOContext *pb = s->pb;
185  const AVFrame *frame = (const AVFrame *)pkt->data;
186  int width, height;
187  const AVPixFmtDescriptor *desc;
188 
189  /* construct frame header */
190 
191  avio_printf(s->pb, Y4M_FRAME_MAGIC "\n");
192 
193  if (st->codecpar->codec_id == AV_CODEC_ID_RAWVIDEO) {
194  avio_write(pb, pkt->data, pkt->size);
195  return 0;
196  }
197 
198  width = st->codecpar->width;
199  height = st->codecpar->height;
201 
202  /* The following code presumes all planes to be non-interleaved. */
203  for (int k = 0; k < desc->nb_components; k++) {
204  int plane_height = height, plane_width = width;
205  const uint8_t *ptr = frame->data[k];
206 
207  if (desc->nb_components >= 3 && (k == 1 || k == 2)) { /* chroma? */
208  plane_width = AV_CEIL_RSHIFT(plane_width, desc->log2_chroma_w);
209  plane_height = AV_CEIL_RSHIFT(plane_height, desc->log2_chroma_h);
210  }
211  plane_width *= desc->comp[k].step;
212 
213  for (int i = 0; i < plane_height; i++) {
214  avio_write(pb, ptr, plane_width);
215  ptr += frame->linesize[k];
216  }
217  }
218 
219  return 0;
220 }
221 
223 {
224  if (s->streams[0]->codecpar->codec_id != AV_CODEC_ID_WRAPPED_AVFRAME &&
225  s->streams[0]->codecpar->codec_id != AV_CODEC_ID_RAWVIDEO) {
226  av_log(s, AV_LOG_ERROR, "ERROR: Codec not supported.\n");
227  return AVERROR_INVALIDDATA;
228  }
229 
230  switch (s->streams[0]->codecpar->format) {
231  case AV_PIX_FMT_YUV411P:
232  av_log(s, AV_LOG_WARNING, "Warning: generating rarely used 4:1:1 YUV "
233  "stream, some mjpegtools might not work.\n");
234  break;
235  case AV_PIX_FMT_GRAY8:
236  case AV_PIX_FMT_YUV420P:
237  case AV_PIX_FMT_YUV422P:
238  case AV_PIX_FMT_YUV444P:
239  // TODO: remove YUVJ pixel formats when they are completely removed from the codebase.
240  case AV_PIX_FMT_YUVJ420P:
241  case AV_PIX_FMT_YUVJ422P:
242  case AV_PIX_FMT_YUVJ444P:
243  break;
244  case AV_PIX_FMT_GRAY9:
245  case AV_PIX_FMT_GRAY10:
246  case AV_PIX_FMT_GRAY12:
247  case AV_PIX_FMT_GRAY16:
248  case AV_PIX_FMT_YUV420P9:
249  case AV_PIX_FMT_YUV422P9:
250  case AV_PIX_FMT_YUV444P9:
263  case AV_PIX_FMT_YUVA444P:
264  if (s->strict_std_compliance >= FF_COMPLIANCE_NORMAL) {
265  av_log(s, AV_LOG_ERROR, "'%s' is not an official yuv4mpegpipe pixel format. "
266  "Use '-strict -1' to encode to this pixel format.\n",
267  av_get_pix_fmt_name(s->streams[0]->codecpar->format));
268  return AVERROR(EINVAL);
269  }
270  av_log(s, AV_LOG_WARNING, "Warning: generating non standard YUV stream. "
271  "Mjpegtools will not work.\n");
272  break;
273  default:
274  av_log(s, AV_LOG_ERROR, "ERROR: yuv4mpeg can only handle "
275  "yuv444p, yuv422p, yuv420p, yuv411p and gray8 pixel formats. "
276  "And using 'strict -1' also yuv444p9, yuv422p9, yuv420p9, "
277  "yuv444p10, yuv422p10, yuv420p10, "
278  "yuv444p12, yuv422p12, yuv420p12, "
279  "yuv444p14, yuv422p14, yuv420p14, "
280  "yuv444p16, yuv422p16, yuv420p16, "
281  "yuva444p, "
282  "gray9, gray10, gray12 "
283  "and gray16 pixel formats. "
284  "Use -pix_fmt to select one.\n");
285  return AVERROR(EIO);
286  }
287 
288  return 0;
289 }
290 
292  .p.name = "yuv4mpegpipe",
293  .p.long_name = NULL_IF_CONFIG_SMALL("YUV4MPEG pipe"),
294  .p.extensions = "y4m",
295  .p.audio_codec = AV_CODEC_ID_NONE,
296  .p.video_codec = AV_CODEC_ID_WRAPPED_AVFRAME,
297  .p.subtitle_codec = AV_CODEC_ID_NONE,
298  .init = yuv4_init,
299  .write_header = yuv4_write_header,
300  .write_packet = yuv4_write_packet,
301  .flags_internal = FF_OFMT_FLAG_MAX_ONE_OF_EACH,
302 };
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
yuv4_init
static int yuv4_init(AVFormatContext *s)
Definition: yuv4mpegenc.c:222
AVOutputFormat::name
const char * name
Definition: avformat.h:510
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
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2962
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:65
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:344
pixdesc.h
AVCOL_RANGE_JPEG
@ AVCOL_RANGE_JPEG
Full range content.
Definition: pixfmt.h:683
AVPacket::data
uint8_t * data
Definition: packet.h:522
Y4M_MAGIC
#define Y4M_MAGIC
Definition: yuv4mpeg.h:24
AV_PIX_FMT_YUV420P10
#define AV_PIX_FMT_YUV420P10
Definition: pixfmt.h:478
AV_PIX_FMT_GRAY9
#define AV_PIX_FMT_GRAY9
Definition: pixfmt.h:458
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:365
FFOutputFormat::p
AVOutputFormat p
The public AVOutputFormat.
Definition: mux.h:65
AV_FIELD_BT
@ AV_FIELD_BT
Bottom coded first, top displayed first.
Definition: defs.h:204
ff_yuv4mpegpipe_muxer
const FFOutputFormat ff_yuv4mpegpipe_muxer
Definition: yuv4mpegenc.c:291
AV_FIELD_TT
@ AV_FIELD_TT
Top coded_first, top displayed first.
Definition: defs.h:201
AV_PIX_FMT_YUV422P9
#define AV_PIX_FMT_YUV422P9
Definition: pixfmt.h:476
AV_PIX_FMT_GRAY16
#define AV_PIX_FMT_GRAY16
Definition: pixfmt.h:462
av_reduce
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
Y4M_FRAME_MAGIC
#define Y4M_FRAME_MAGIC
Definition: yuv4mpeg.h:25
AVRational::num
int num
Numerator.
Definition: rational.h:59
AV_FIELD_TB
@ AV_FIELD_TB
Top coded first, bottom displayed first.
Definition: defs.h:203
AV_PIX_FMT_YUV444P10
#define AV_PIX_FMT_YUV444P10
Definition: pixfmt.h:481
yuv4_write_packet
static int yuv4_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: yuv4mpegenc.c:181
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
AV_PIX_FMT_YUV422P16
#define AV_PIX_FMT_YUV422P16
Definition: pixfmt.h:490
AV_PIX_FMT_YUVJ422P
@ AV_PIX_FMT_YUVJ422P
planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting col...
Definition: pixfmt.h:86
width
#define width
s
#define s(width, name)
Definition: cbs_vp9.c:198
AV_PIX_FMT_YUV444P16
#define AV_PIX_FMT_YUV444P16
Definition: pixfmt.h:491
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:58
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:134
AV_PIX_FMT_YUV420P9
#define AV_PIX_FMT_YUV420P9
Definition: pixfmt.h:475
AV_PIX_FMT_YUV420P16
#define AV_PIX_FMT_YUV420P16
Definition: pixfmt.h:489
AV_PIX_FMT_YUV420P
@ AV_PIX_FMT_YUV420P
planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
Definition: pixfmt.h:73
AV_CODEC_ID_WRAPPED_AVFRAME
@ AV_CODEC_ID_WRAPPED_AVFRAME
Passthrough codec, AVFrames wrapped in AVPacket.
Definition: codec_id.h:600
AV_PIX_FMT_YUVJ444P
@ AV_PIX_FMT_YUVJ444P
planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting col...
Definition: pixfmt.h:87
frame
static AVFrame * frame
Definition: demux_decode.c:54
AV_PIX_FMT_GRAY10
#define AV_PIX_FMT_GRAY10
Definition: pixfmt.h:459
AVFormatContext
Format I/O context.
Definition: avformat.h:1255
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:766
AVStream::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avformat.h:782
AVCHROMA_LOC_LEFT
@ AVCHROMA_LOC_LEFT
MPEG-2/4 4:2:0, H.264 default for 4:2:0.
Definition: pixfmt.h:704
AVCHROMA_LOC_TOPLEFT
@ AVCHROMA_LOC_TOPLEFT
ITU-R 601, SMPTE 274M 296M S314M(DV 4:1:1), mpeg2 4:2:2.
Definition: pixfmt.h:706
AV_PIX_FMT_YUVJ420P
@ AV_PIX_FMT_YUVJ420P
planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting col...
Definition: pixfmt.h:85
FFOutputFormat
Definition: mux.h:61
AV_PIX_FMT_YUV422P10
#define AV_PIX_FMT_YUV422P10
Definition: pixfmt.h:479
AV_PIX_FMT_GRAY8
@ AV_PIX_FMT_GRAY8
Y , 8bpp.
Definition: pixfmt.h:81
AVIOContext
Bytestream IO Context.
Definition: avio.h:160
AVPacket::size
int size
Definition: packet.h:523
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:106
AV_PIX_FMT_YUV422P12
#define AV_PIX_FMT_YUV422P12
Definition: pixfmt.h:483
AV_PIX_FMT_YUV444P12
#define AV_PIX_FMT_YUV444P12
Definition: pixfmt.h:485
AVStream::sample_aspect_ratio
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown)
Definition: avformat.h:821
frame.h
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:200
FF_COMPLIANCE_NORMAL
#define FF_COMPLIANCE_NORMAL
Definition: defs.h:60
height
#define height
AV_PIX_FMT_YUVA444P
@ AV_PIX_FMT_YUVA444P
planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
Definition: pixfmt.h:174
yuv4_write_header
static int yuv4_write_header(AVFormatContext *s)
Definition: yuv4mpegenc.c:29
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:255
AVCodecParameters::height
int height
Definition: codec_par.h:135
AV_FIELD_BB
@ AV_FIELD_BB
Bottom coded first, bottom displayed first.
Definition: defs.h:202
FF_OFMT_FLAG_MAX_ONE_OF_EACH
#define FF_OFMT_FLAG_MAX_ONE_OF_EACH
If this flag is set, it indicates that for each codec type whose corresponding default codec (i....
Definition: mux.h:50
AVCodecParameters::color_range
enum AVColorRange color_range
Video only.
Definition: codec_par.h:166
yuv4mpeg.h
AVCOL_RANGE_MPEG
@ AVCOL_RANGE_MPEG
Narrow or limited range content.
Definition: pixfmt.h:666
AV_PIX_FMT_YUV444P9
#define AV_PIX_FMT_YUV444P9
Definition: pixfmt.h:477
AVCodecParameters::field_order
enum AVFieldOrder field_order
Video only.
Definition: codec_par.h:161
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:743
avformat.h
AV_PIX_FMT_YUV420P12
#define AV_PIX_FMT_YUV420P12
Definition: pixfmt.h:482
AVCodecParameters::chroma_location
enum AVChromaLocation chroma_location
Definition: codec_par.h:170
AV_PIX_FMT_YUV422P14
#define AV_PIX_FMT_YUV422P14
Definition: pixfmt.h:487
avio_printf
int avio_printf(AVIOContext *s, const char *fmt,...) av_printf_format(2
Writes a formatted string to the context.
AVRational::den
int den
Denominator.
Definition: rational.h:60
AVPacket::stream_index
int stream_index
Definition: packet.h:524
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:78
desc
const char * desc
Definition: libsvtav1.c:75
AV_PIX_FMT_YUV422P
@ AV_PIX_FMT_YUV422P
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:77
AVCodecParameters::format
int format
Definition: codec_par.h:92
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:69
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
AVPacket
This structure stores compressed data.
Definition: packet.h:499
AV_PIX_FMT_YUV411P
@ AV_PIX_FMT_YUV411P
planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
Definition: pixfmt.h:80
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, a positive or negative value, which is typically indicating the size in bytes of each pict...
Definition: frame.h:389
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
AV_PIX_FMT_YUV444P14
#define AV_PIX_FMT_YUV444P14
Definition: pixfmt.h:488
AV_PIX_FMT_GRAY12
#define AV_PIX_FMT_GRAY12
Definition: pixfmt.h:460
AV_PIX_FMT_YUV420P14
#define AV_PIX_FMT_YUV420P14
Definition: pixfmt.h:486
av_get_pix_fmt_name
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:2882
mux.h