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 "libavutil/intreadwrite.h"
24 #include "libavutil/avstring.h"
25 #include "libavutil/dict.h"
26 #include "libavutil/log.h"
27 #include "libavutil/opt.h"
28 #include "libavutil/pixdesc.h"
30 #include "avformat.h"
31 #include "avio_internal.h"
32 #include "internal.h"
33 #include "img2.h"
34 
35 typedef struct VideoMuxData {
36  const AVClass *class; /**< Class for private options. */
38  int split_planes; /**< use independent file for each Y, U, V plane */
39  char tmp[4][1024];
40  char target[4][1024];
41  int update;
43  int frame_pts;
44  const char *muxer;
47 } VideoMuxData;
48 
50 {
51  VideoMuxData *img = s->priv_data;
52  AVStream *st = s->streams[0];
54 
55  if (st->codecpar->codec_id == AV_CODEC_ID_GIF) {
56  img->muxer = "gif";
57  } else if (st->codecpar->codec_id == AV_CODEC_ID_FITS) {
58  img->muxer = "fits";
59  } else if (st->codecpar->codec_id == AV_CODEC_ID_RAWVIDEO) {
60  const char *str = strrchr(s->url, '.');
61  img->split_planes = str
62  && !av_strcasecmp(str + 1, "y")
63  && s->nb_streams == 1
64  && desc
65  &&(desc->flags & AV_PIX_FMT_FLAG_PLANAR)
66  && desc->nb_components >= 3;
67  }
68 
69  return 0;
70 }
71 
73 {
74  VideoMuxData *img = s->priv_data;
75  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
76  AVStream *st;
77  AVPacket *const pkt2 = ffformatcontext(s)->pkt;
78  AVFormatContext *fmt = NULL;
79  int ret;
80 
81  /* URL is not used directly as we are overriding the IO context later. */
82  ret = avformat_alloc_output_context2(&fmt, NULL, img->muxer, s->url);
83  if (ret < 0)
84  return ret;
85  st = avformat_new_stream(fmt, NULL);
86  if (!st) {
87  ret = AVERROR(ENOMEM);
88  goto out;
89  }
90  st->id = pkt->stream_index;
91 
92  fmt->pb = pb;
93 
94  ret = av_packet_ref(pkt2, pkt);
95  if (ret < 0)
96  goto out;
97  pkt2->stream_index = 0;
98 
99  if ((ret = avcodec_parameters_copy(st->codecpar, par)) < 0 ||
100  (ret = avformat_write_header(fmt, NULL)) < 0 ||
101  (ret = av_interleaved_write_frame(fmt, pkt2)) < 0 ||
102  (ret = av_write_trailer(fmt))) {}
103 
104  av_packet_unref(pkt2);
105 out:
107  return ret;
108 }
109 
111 {
112  VideoMuxData *img = s->priv_data;
113  if (img->muxer) {
114  int ret = write_muxed_file(s, s->pb, pkt);
115  if (ret < 0)
116  return ret;
117  } else {
118  avio_write(s->pb, pkt->data, pkt->size);
119  }
120  img->img_number++;
121  return 0;
122 }
123 
125 {
126  VideoMuxData *img = s->priv_data;
127  AVIOContext *pb[4] = {0};
128  char filename[1024];
129  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
131  int ret, i;
132  int nb_renames = 0;
134 
135  if (img->update) {
136  av_strlcpy(filename, s->url, sizeof(filename));
137  } else if (img->use_strftime) {
138  time_t now0;
139  struct tm *tm, tmpbuf;
140  time(&now0);
141  tm = localtime_r(&now0, &tmpbuf);
142  if (!strftime(filename, sizeof(filename), s->url, tm)) {
143  av_log(s, AV_LOG_ERROR, "Could not get frame filename with strftime\n");
144  return AVERROR(EINVAL);
145  }
146  } else if (img->frame_pts) {
147  if (av_get_frame_filename2(filename, sizeof(filename), s->url, pkt->pts, AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
148  av_log(s, AV_LOG_ERROR, "Cannot write filename by pts of the frames.");
149  return AVERROR(EINVAL);
150  }
151  } else if (av_get_frame_filename2(filename, sizeof(filename), s->url,
152  img->img_number,
154  img->img_number > 1) {
156  "Could not get frame filename number %d from pattern '%s'. "
157  "Use '-frames:v 1' for a single image, or '-update' option, or use a pattern such as %%03d within the filename.\n",
158  img->img_number, s->url);
159  return AVERROR(EINVAL);
160  }
161  for (i = 0; i < 4; i++) {
162  av_dict_copy(&options, img->protocol_opts, 0);
163  snprintf(img->tmp[i], sizeof(img->tmp[i]), "%s.tmp", filename);
164  av_strlcpy(img->target[i], filename, sizeof(img->target[i]));
165  if (s->io_open(s, &pb[i], img->use_rename ? img->tmp[i] : filename, AVIO_FLAG_WRITE, &options) < 0) {
166  av_log(s, AV_LOG_ERROR, "Could not open file : %s\n", img->use_rename ? img->tmp[i] : filename);
167  ret = AVERROR(EIO);
168  goto fail;
169  }
170  if (options) {
171  av_log(s, AV_LOG_ERROR, "Could not recognize some protocol options\n");
172  ret = AVERROR(EINVAL);
173  goto fail;
174  }
175 
176  if (!img->split_planes || i+1 >= desc->nb_components)
177  break;
178  filename[strlen(filename) - 1] = "UVAx"[i];
179  }
180  if (img->use_rename)
181  nb_renames = i + 1;
182 
183  if (img->split_planes) {
184  int ysize = par->width * par->height;
185  int usize = AV_CEIL_RSHIFT(par->width, desc->log2_chroma_w) * AV_CEIL_RSHIFT(par->height, desc->log2_chroma_h);
186  if (desc->comp[0].depth >= 9) {
187  ysize *= 2;
188  usize *= 2;
189  }
190  avio_write(pb[0], pkt->data , ysize);
191  avio_write(pb[1], pkt->data + ysize , usize);
192  avio_write(pb[2], pkt->data + ysize + usize, usize);
193  ff_format_io_close(s, &pb[1]);
194  ff_format_io_close(s, &pb[2]);
195  if (desc->nb_components > 3) {
196  avio_write(pb[3], pkt->data + ysize + 2*usize, ysize);
197  ff_format_io_close(s, &pb[3]);
198  }
199  } else if (img->muxer) {
200  ret = write_muxed_file(s, pb[0], pkt);
201  if (ret < 0)
202  goto fail;
203  } else {
204  avio_write(pb[0], pkt->data, pkt->size);
205  }
206  avio_flush(pb[0]);
207  ff_format_io_close(s, &pb[0]);
208  for (i = 0; i < nb_renames; i++) {
209  int ret = ff_rename(img->tmp[i], img->target[i], s);
210  if (ret < 0)
211  return ret;
212  }
213 
214  img->img_number++;
215  return 0;
216 
217 fail:
219  for (i = 0; i < FF_ARRAY_ELEMS(pb); i++)
220  if (pb[i])
221  ff_format_io_close(s, &pb[i]);
222  return ret;
223 }
224 
225 static int query_codec(enum AVCodecID id, int std_compliance)
226 {
227  int i;
228  for (i = 0; ff_img_tags[i].id != AV_CODEC_ID_NONE; i++)
229  if (ff_img_tags[i].id == id)
230  return 1;
231 
232  // Anything really can be stored in img2
233  return std_compliance < FF_COMPLIANCE_NORMAL;
234 }
235 
236 #define OFFSET(x) offsetof(VideoMuxData, x)
237 #define ENC AV_OPT_FLAG_ENCODING_PARAM
238 static const AVOption muxoptions[] = {
239  { "update", "continuously overwrite one file", OFFSET(update), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
240  { "start_number", "set first number in the sequence", OFFSET(img_number), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, INT_MAX, ENC },
241  { "strftime", "use strftime for filename", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
242  { "frame_pts", "use current frame pts for filename", OFFSET(frame_pts), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
243  { "atomic_writing", "write files atomically (using temporary files and renames)", OFFSET(use_rename), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
244  { "protocol_opts", "specify protocol options for the opened files", OFFSET(protocol_opts), AV_OPT_TYPE_DICT, {0}, 0, 0, ENC },
245  { NULL },
246 };
247 
248 #if CONFIG_IMAGE2_MUXER
249 static const AVClass img2mux_class = {
250  .class_name = "image2 muxer",
251  .item_name = av_default_item_name,
252  .option = muxoptions,
253  .version = LIBAVUTIL_VERSION_INT,
254 };
255 
257  .name = "image2",
258  .long_name = NULL_IF_CONFIG_SMALL("image2 sequence"),
259  .extensions = "bmp,dpx,exr,jls,jpeg,jpg,ljpg,pam,pbm,pcx,pfm,pgm,pgmyuv,png,"
260  "ppm,sgi,tga,tif,tiff,jp2,j2c,j2k,xwd,sun,ras,rs,im1,im8,im24,"
261  "sunras,xbm,xface,pix,y",
262  .priv_data_size = sizeof(VideoMuxData),
263  .video_codec = AV_CODEC_ID_MJPEG,
268  .priv_class = &img2mux_class,
269 };
270 #endif
271 #if CONFIG_IMAGE2PIPE_MUXER
273  .name = "image2pipe",
274  .long_name = NULL_IF_CONFIG_SMALL("piped image2 sequence"),
275  .priv_data_size = sizeof(VideoMuxData),
276  .video_codec = AV_CODEC_ID_MJPEG,
281 };
282 #endif
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:424
VideoMuxData::img_number
int img_number
Definition: img2enc.c:37
AVOutputFormat::name
const char * name
Definition: avformat.h:497
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: utils.c:760
write_packet_pipe
static int write_packet_pipe(AVFormatContext *s, AVPacket *pkt)
Definition: img2enc.c:110
AVFMT_NODIMENSIONS
#define AVFMT_NODIMENSIONS
Format does not need width/height.
Definition: avformat.h:472
out
FILE * out
Definition: movenc.c:54
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
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:2660
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:468
av_strcasecmp
int av_strcasecmp(const char *a, const char *b)
Locale-independent case-insensitive compare.
Definition: avstring.c:215
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: codec_id.h:63
pixdesc.h
AVPacket::data
uint8_t * data
Definition: packet.h:373
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:978
AVOption
AVOption.
Definition: opt.h:247
VideoMuxData::muxer
const char * muxer
Definition: img2enc.c:44
VideoMuxData::target
char target[4][1024]
Definition: img2enc.c:40
OFFSET
#define OFFSET(x)
Definition: img2enc.c:236
AVDictionary
Definition: dict.c:30
ff_image2_muxer
const AVOutputFormat ff_image2_muxer
write_header
static int write_header(AVFormatContext *s)
Definition: img2enc.c:49
fail
#define fail()
Definition: checkasm.h:127
query_codec
static int query_codec(enum AVCodecID id, int std_compliance)
Definition: img2enc.c:225
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:665
write_packet
static int write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: img2enc.c:124
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:238
ff_img_tags
const IdStrMap ff_img_tags[]
Definition: img2.c:27
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_CEIL_RSHIFT
#define AV_CEIL_RSHIFT(a, b)
Definition: common.h:51
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:126
AVIO_FLAG_WRITE
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:622
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:472
time_internal.h
avio_flush
void avio_flush(AVIOContext *s)
Force flushing of buffered data.
Definition: aviobuf.c:252
AVFormatContext
Format I/O context.
Definition: avformat.h:1193
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1088
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
VideoMuxData::use_strftime
int use_strftime
Definition: img2enc.c:42
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
VideoMuxData::update
int update
Definition: img2enc.c:41
NULL
#define NULL
Definition: coverity.c:32
IdStrMap::id
enum AVCodecID id
Definition: img2.h:68
AV_CODEC_ID_FITS
@ AV_CODEC_ID_FITS
Definition: codec_id.h:285
AV_OPT_TYPE_DICT
@ AV_OPT_TYPE_DICT
Definition: opt.h:231
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:235
AVFormatContext::pb
AVIOContext * pb
I/O context.
Definition: avformat.h:1235
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:432
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:47
options
const OptionDef options[]
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVPacket::size
int size
Definition: packet.h:374
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:117
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:38
VideoMuxData::tmp
char tmp[4][1024]
Definition: img2enc.c:39
AVFMT_NOFILE
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:464
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:232
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:203
VideoMuxData::use_rename
int use_rename
Definition: img2enc.c:45
VideoMuxData::frame_pts
int frame_pts
Definition: img2enc.c:43
FF_COMPLIANCE_NORMAL
#define FF_COMPLIANCE_NORMAL
Definition: avcodec.h:1283
AV_FRAME_FILENAME_FLAGS_MULTIPLE
#define AV_FRAME_FILENAME_FLAGS_MULTIPLE
Allow multiple d.
Definition: avformat.h:2687
avcodec_parameters_copy
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
Definition: codec_par.c:72
AV_CODEC_ID_GIF
@ AV_CODEC_ID_GIF
Definition: codec_id.h:147
AV_CODEC_ID_MJPEG
@ AV_CODEC_ID_MJPEG
Definition: codec_id.h:57
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:1249
log.h
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:48
AVOutputFormat
Definition: avformat.h:496
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:366
avio_internal.h
AVCodecParameters::height
int height
Definition: codec_par.h:127
img2.h
ENC
#define ENC
Definition: img2enc.c:237
AVStream::id
int id
Format-specific stream ID.
Definition: avformat.h:942
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:928
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:224
avformat_free_context
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: utils.c:680
VideoMuxData
Definition: img2enc.c:35
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:72
AVPacket::stream_index
int stream_index
Definition: packet.h:375
ff_format_io_close
void ff_format_io_close(AVFormatContext *s, AVIOContext **pb)
Definition: utils.c:1832
desc
const char * desc
Definition: libsvtav1.c:79
FFFormatContext::pkt
AVPacket * pkt
Used to hold temporary packets for the generic demuxing code.
Definition: internal.h:134
AVCodecParameters::format
int format
Definition: codec_par.h:84
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:60
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:241
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:1234
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:217
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:83
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
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:136
ff_image2pipe_muxer
const AVOutputFormat ff_image2pipe_muxer
snprintf
#define snprintf
Definition: snprintf.h:34
VideoMuxData::protocol_opts
AVDictionary * protocol_opts
Definition: img2enc.c:46