FFmpeg
img2enc.c
Go to the documentation of this file.
1 /*
2  * Image format
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
4  * Copyright (c) 2004 Michael Niedermayer
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #include "config_components.h"
24 
25 #include "libavutil/intreadwrite.h"
26 #include "libavutil/avstring.h"
27 #include "libavutil/dict.h"
28 #include "libavutil/log.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/pixdesc.h"
32 #include "avformat.h"
33 #include "avio_internal.h"
34 #include "internal.h"
35 #include "img2.h"
36 
37 typedef struct VideoMuxData {
38  const AVClass *class; /**< Class for private options. */
41  int split_planes; /**< use independent file for each Y, U, V plane */
42  char tmp[4][1024];
43  char target[4][1024];
44  int update;
46  int frame_pts;
47  const char *muxer;
50 } VideoMuxData;
51 
53 {
54  VideoMuxData *img = s->priv_data;
55  AVStream *st = s->streams[0];
57 
58  if (st->codecpar->codec_id == AV_CODEC_ID_GIF) {
59  img->muxer = "gif";
60  } else if (st->codecpar->codec_id == AV_CODEC_ID_FITS) {
61  img->muxer = "fits";
62  } else if (st->codecpar->codec_id == AV_CODEC_ID_AV1) {
63  img->muxer = "avif";
64  } else if (st->codecpar->codec_id == AV_CODEC_ID_RAWVIDEO) {
65  const char *str = strrchr(s->url, '.');
66  img->split_planes = str
67  && !av_strcasecmp(str + 1, "y")
68  && s->nb_streams == 1
69  && desc
70  &&(desc->flags & AV_PIX_FMT_FLAG_PLANAR)
71  && desc->nb_components >= 3;
72  }
73  img->img_number = img->start_img_number;
74 
75  return 0;
76 }
77 
79 {
80  VideoMuxData *img = s->priv_data;
81  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
82  AVStream *st;
83  AVPacket *const pkt2 = ffformatcontext(s)->pkt;
84  AVFormatContext *fmt = NULL;
85  int ret;
86 
87  /* URL is not used directly as we are overriding the IO context later. */
88  ret = avformat_alloc_output_context2(&fmt, NULL, img->muxer, s->url);
89  if (ret < 0)
90  return ret;
91  st = avformat_new_stream(fmt, NULL);
92  if (!st) {
93  ret = AVERROR(ENOMEM);
94  goto out;
95  }
96  st->id = pkt->stream_index;
97 
98  fmt->pb = pb;
99 
100  ret = av_packet_ref(pkt2, pkt);
101  if (ret < 0)
102  goto out;
103  pkt2->stream_index = 0;
104 
105  if ((ret = avcodec_parameters_copy(st->codecpar, par)) < 0 ||
106  (ret = avformat_write_header(fmt, NULL)) < 0 ||
107  (ret = av_interleaved_write_frame(fmt, pkt2)) < 0 ||
108  (ret = av_write_trailer(fmt))) {}
109 
110  av_packet_unref(pkt2);
111 out:
113  return ret;
114 }
115 
117 {
118  VideoMuxData *img = s->priv_data;
119  if (img->muxer) {
120  int ret = write_muxed_file(s, s->pb, pkt);
121  if (ret < 0)
122  return ret;
123  } else {
124  avio_write(s->pb, pkt->data, pkt->size);
125  }
126  img->img_number++;
127  return 0;
128 }
129 
130 static int write_and_close(AVFormatContext *s, AVIOContext **pb, const unsigned char *buf, int size)
131 {
132  avio_write(*pb, buf, size);
133  avio_flush(*pb);
134  return ff_format_io_close(s, pb);
135 }
136 
138 {
139  VideoMuxData *img = s->priv_data;
140  AVIOContext *pb[4] = {0};
141  char filename[1024];
142  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
144  int ret, i;
145  int nb_renames = 0;
147 
148  if (img->update) {
149  av_strlcpy(filename, s->url, sizeof(filename));
150  } else if (img->use_strftime) {
151  time_t now0;
152  struct tm *tm, tmpbuf;
153  time(&now0);
154  tm = localtime_r(&now0, &tmpbuf);
155  if (!strftime(filename, sizeof(filename), s->url, tm)) {
156  av_log(s, AV_LOG_ERROR, "Could not get frame filename with strftime\n");
157  return AVERROR(EINVAL);
158  }
159  } else if (img->frame_pts) {
160  if (av_get_frame_filename2(filename, sizeof(filename), s->url, pkt->pts, AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
161  av_log(s, AV_LOG_ERROR, "Cannot write filename by pts of the frames.");
162  return AVERROR(EINVAL);
163  }
164  } else if (av_get_frame_filename2(filename, sizeof(filename), s->url,
165  img->img_number,
167  if (img->img_number == img->start_img_number) {
168  av_log(s, AV_LOG_WARNING, "The specified filename '%s' does not contain an image sequence pattern or a pattern is invalid.\n", s->url);
170  "Use a pattern such as %%03d for an image sequence or "
171  "use the -update option (with -frames:v 1 if needed) to write a single image.\n");
172  av_strlcpy(filename, s->url, sizeof(filename));
173  } else {
174  av_log(s, AV_LOG_ERROR, "Cannot write more than one file with the same name. Are you missing the -update option or a sequence pattern?\n");
175  return AVERROR(EINVAL);
176  }
177  }
178  for (i = 0; i < 4; i++) {
179  av_dict_copy(&options, img->protocol_opts, 0);
180  snprintf(img->tmp[i], sizeof(img->tmp[i]), "%s.tmp", filename);
181  av_strlcpy(img->target[i], filename, sizeof(img->target[i]));
182  if (s->io_open(s, &pb[i], img->use_rename ? img->tmp[i] : filename, AVIO_FLAG_WRITE, &options) < 0) {
183  av_log(s, AV_LOG_ERROR, "Could not open file : %s\n", img->use_rename ? img->tmp[i] : filename);
184  ret = AVERROR(EIO);
185  goto fail;
186  }
187  if (options) {
188  av_log(s, AV_LOG_ERROR, "Could not recognize some protocol options\n");
189  ret = AVERROR(EINVAL);
190  goto fail;
191  }
192 
193  if (!img->split_planes || i+1 >= desc->nb_components)
194  break;
195  filename[strlen(filename) - 1] = "UVAx"[i];
196  }
197  if (img->use_rename)
198  nb_renames = i + 1;
199 
200  if (img->split_planes) {
201  int ysize = par->width * par->height;
202  int usize = AV_CEIL_RSHIFT(par->width, desc->log2_chroma_w) * AV_CEIL_RSHIFT(par->height, desc->log2_chroma_h);
203  if (desc->comp[0].depth >= 9) {
204  ysize *= 2;
205  usize *= 2;
206  }
207  if ((ret = write_and_close(s, &pb[0], pkt->data , ysize)) < 0 ||
208  (ret = write_and_close(s, &pb[1], pkt->data + ysize , usize)) < 0 ||
209  (ret = write_and_close(s, &pb[2], pkt->data + ysize + usize, usize)) < 0)
210  goto fail;
211  if (desc->nb_components > 3)
212  ret = write_and_close(s, &pb[3], pkt->data + ysize + 2*usize, ysize);
213  } else if (img->muxer) {
214  if ((ret = write_muxed_file(s, pb[0], pkt)) < 0)
215  goto fail;
216  ret = ff_format_io_close(s, &pb[0]);
217  } else {
218  ret = write_and_close(s, &pb[0], pkt->data, pkt->size);
219  }
220  if (ret < 0)
221  goto fail;
222 
223  for (i = 0; i < nb_renames; i++) {
224  int ret = ff_rename(img->tmp[i], img->target[i], s);
225  if (ret < 0)
226  return ret;
227  }
228 
229  img->img_number++;
230  return 0;
231 
232 fail:
234  for (i = 0; i < FF_ARRAY_ELEMS(pb); i++)
235  if (pb[i])
236  ff_format_io_close(s, &pb[i]);
237  return ret;
238 }
239 
240 static int query_codec(enum AVCodecID id, int std_compliance)
241 {
242  int i;
243  for (i = 0; ff_img_tags[i].id != AV_CODEC_ID_NONE; i++)
244  if (ff_img_tags[i].id == id)
245  return 1;
246 
247  // Anything really can be stored in img2
248  return std_compliance < FF_COMPLIANCE_NORMAL;
249 }
250 
251 #define OFFSET(x) offsetof(VideoMuxData, x)
252 #define ENC AV_OPT_FLAG_ENCODING_PARAM
253 static const AVOption muxoptions[] = {
254  { "update", "continuously overwrite one file", OFFSET(update), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
255  { "start_number", "set first number in the sequence", OFFSET(start_img_number), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, INT_MAX, ENC },
256  { "strftime", "use strftime for filename", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
257  { "frame_pts", "use current frame pts for filename", OFFSET(frame_pts), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
258  { "atomic_writing", "write files atomically (using temporary files and renames)", OFFSET(use_rename), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
259  { "protocol_opts", "specify protocol options for the opened files", OFFSET(protocol_opts), AV_OPT_TYPE_DICT, {0}, 0, 0, ENC },
260  { NULL },
261 };
262 
263 #if CONFIG_IMAGE2_MUXER
264 static const AVClass img2mux_class = {
265  .class_name = "image2 muxer",
266  .item_name = av_default_item_name,
267  .option = muxoptions,
268  .version = LIBAVUTIL_VERSION_INT,
269 };
270 
272  .name = "image2",
273  .long_name = NULL_IF_CONFIG_SMALL("image2 sequence"),
274  .extensions = "bmp,dpx,exr,jls,jpeg,jpg,jxl,ljpg,pam,pbm,pcx,pfm,pgm,pgmyuv,phm,"
275  "png,ppm,sgi,tga,tif,tiff,jp2,j2c,j2k,xwd,sun,ras,rs,im1,im8,"
276  "im24,sunras,vbn,xbm,xface,pix,y,avif,qoi,hdr,wbmp",
277  .priv_data_size = sizeof(VideoMuxData),
278  .video_codec = AV_CODEC_ID_MJPEG,
283  .priv_class = &img2mux_class,
284 };
285 #endif
286 #if CONFIG_IMAGE2PIPE_MUXER
288  .name = "image2pipe",
289  .long_name = NULL_IF_CONFIG_SMALL("piped image2 sequence"),
290  .priv_data_size = sizeof(VideoMuxData),
291  .video_codec = AV_CODEC_ID_MJPEG,
296 };
297 #endif
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:422
VideoMuxData::img_number
int img_number
Definition: img2enc.c:40
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
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
opt.h
avformat_new_stream
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: options.c:237
write_packet_pipe
static int write_packet_pipe(AVFormatContext *s, AVPacket *pkt)
Definition: img2enc.c:116
AVFMT_NODIMENSIONS
#define AVFMT_NODIMENSIONS
Format does not need width/height.
Definition: avformat.h:485
out
FILE * out
Definition: movenc.c:54
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:54
ffformatcontext
static av_always_inline FFFormatContext * ffformatcontext(AVFormatContext *s)
Definition: internal.h:191
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2858
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:481
av_strcasecmp
int av_strcasecmp(const char *a, const char *b)
Locale-independent case-insensitive compare.
Definition: avstring.c:218
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:65
pixdesc.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
av_get_frame_filename2
int av_get_frame_filename2(char *buf, int buf_size, const char *path, int number, int flags)
Return in 'buf' the path with 'd' replaced by a number.
Definition: utils.c:294
AVOption
AVOption.
Definition: opt.h:251
VideoMuxData::muxer
const char * muxer
Definition: img2enc.c:47
write_and_close
static int write_and_close(AVFormatContext *s, AVIOContext **pb, const unsigned char *buf, int size)
Definition: img2enc.c:130
VideoMuxData::target
char target[4][1024]
Definition: img2enc.c:43
OFFSET
#define OFFSET(x)
Definition: img2enc.c:251
AVDictionary
Definition: dict.c:32
ff_image2_muxer
const AVOutputFormat ff_image2_muxer
write_header
static int write_header(AVFormatContext *s)
Definition: img2enc.c:52
fail
#define fail()
Definition: checkasm.h:134
query_codec
static int query_codec(enum AVCodecID id, int std_compliance)
Definition: img2enc.c:240
update
static av_always_inline void update(SilenceDetectContext *s, AVFrame *insamples, int is_silence, int current_sample, int64_t nb_samples_notify, AVRational time_base)
Definition: af_silencedetect.c:78
ff_rename
int ff_rename(const char *url_src, const char *url_dst, void *logctx)
Wrap ffurl_move() and log if error happens.
Definition: avio.c:671
write_packet
static int write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: img2enc.c:137
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
FF_ARRAY_ELEMS
#define FF_ARRAY_ELEMS(a)
Definition: sinewin_tablegen.c:29
muxoptions
static const AVOption muxoptions[]
Definition: img2enc.c:253
ff_img_tags
const IdStrMap ff_img_tags[]
Definition: img2.c:27
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:256
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:50
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:128
AVIO_FLAG_WRITE
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:634
avformat_write_header
av_warn_unused_result int avformat_write_header(AVFormatContext *s, AVDictionary **options)
Allocate the stream private data and write the stream header to an output media file.
Definition: mux.c:450
time_internal.h
avio_flush
void avio_flush(AVIOContext *s)
Force flushing of buffered data.
Definition: aviobuf.c:254
AVFormatContext
Format I/O context.
Definition: avformat.h:1216
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1108
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
VideoMuxData::use_strftime
int use_strftime
Definition: img2enc.c:45
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
VideoMuxData::update
int update
Definition: img2enc.c:44
NULL
#define NULL
Definition: coverity.c:32
AV_CODEC_ID_AV1
@ AV_CODEC_ID_AV1
Definition: codec_id.h:283
IdStrMap::id
enum AVCodecID id
Definition: img2.h:68
AV_CODEC_ID_FITS
@ AV_CODEC_ID_FITS
Definition: codec_id.h:289
AV_OPT_TYPE_DICT
@ AV_OPT_TYPE_DICT
Definition: opt.h:232
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
AVFormatContext::pb
AVIOContext * pb
I/O context.
Definition: avformat.h:1258
av_packet_ref
int av_packet_ref(AVPacket *dst, const AVPacket *src)
Setup a new reference to the data described by a given packet.
Definition: avpacket.c:430
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:49
options
const OptionDef options[]
AVIOContext
Bytestream IO Context.
Definition: avio.h:166
AVPacket::size
int size
Definition: packet.h:375
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:115
localtime_r
#define localtime_r
Definition: time_internal.h:46
VideoMuxData::split_planes
int split_planes
use independent file for each Y, U, V plane
Definition: img2enc.c:41
size
int size
Definition: twinvq_data.h:10344
VideoMuxData::tmp
char tmp[4][1024]
Definition: img2enc.c:42
AVFMT_NOFILE
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:470
ff_format_io_close
int ff_format_io_close(AVFormatContext *s, AVIOContext **pb)
Definition: avformat.c:845
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:232
FF_COMPLIANCE_NORMAL
#define FF_COMPLIANCE_NORMAL
Definition: defs.h:60
img
#define img
Definition: vf_colormatrix.c:116
av_dict_free
void av_dict_free(AVDictionary **pm)
Free all the memory allocated for an AVDictionary struct and all keys and values.
Definition: dict.c:223
VideoMuxData::use_rename
int use_rename
Definition: img2enc.c:48
VideoMuxData::frame_pts
int frame_pts
Definition: img2enc.c:46
AV_FRAME_FILENAME_FLAGS_MULTIPLE
#define AV_FRAME_FILENAME_FLAGS_MULTIPLE
Allow multiple d.
Definition: avformat.h:2750
AV_CODEC_ID_GIF
@ AV_CODEC_ID_GIF
Definition: codec_id.h:149
AV_CODEC_ID_MJPEG
@ AV_CODEC_ID_MJPEG
Definition: codec_id.h:59
av_write_trailer
int av_write_trailer(AVFormatContext *s)
Write the stream trailer to an output media file and free the file private data.
Definition: mux.c:1254
log.h
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
AVOutputFormat
Definition: avformat.h:509
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:367
avio_internal.h
AVCodecParameters::height
int height
Definition: codec_par.h:129
img2.h
ENC
#define ENC
Definition: img2enc.c:252
AVStream::id
int id
Format-specific stream ID.
Definition: avformat.h:962
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:948
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
avformat.h
dict.h
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:225
avformat_free_context
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: avformat.c:95
VideoMuxData
Definition: img2enc.c:37
AV_PIX_FMT_FLAG_PLANAR
#define AV_PIX_FMT_FLAG_PLANAR
At least one pixel component is not in the first data plane.
Definition: pixdesc.h:132
write_muxed_file
static int write_muxed_file(AVFormatContext *s, AVIOContext *pb, AVPacket *pkt)
Definition: img2enc.c:78
AVPacket::stream_index
int stream_index
Definition: packet.h:376
VideoMuxData::start_img_number
int start_img_number
Definition: img2enc.c:39
desc
const char * desc
Definition: libsvtav1.c:83
FFFormatContext::pkt
AVPacket * pkt
Used to hold temporary packets for the generic demuxing code.
Definition: internal.h:141
AVCodecParameters::format
int format
Definition: codec_par.h:86
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:62
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:244
av_interleaved_write_frame
int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt)
Write a packet to an output media file ensuring correct interleaving.
Definition: mux.c:1239
av_dict_copy
int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags)
Copy entries from one AVDictionary struct into another.
Definition: dict.c:237
convert_header.str
string str
Definition: convert_header.py:20
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
av_strlcpy
size_t av_strlcpy(char *dst, const char *src, size_t size)
Copy the string src to dst, but no more than size - 1 bytes, and null-terminate dst.
Definition: avstring.c:86
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
avstring.h
avformat_alloc_output_context2
int avformat_alloc_output_context2(AVFormatContext **ctx, const AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
Definition: mux.c:91
ff_image2pipe_muxer
const AVOutputFormat ff_image2pipe_muxer
snprintf
#define snprintf
Definition: snprintf.h:34
VideoMuxData::protocol_opts
AVDictionary * protocol_opts
Definition: img2enc.c:49
avcodec_parameters_copy
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
Definition: codec_par.c:74