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/avassert.h"
25 #include "libavutil/avstring.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 is_pipe;
39  int split_planes; /**< use independent file for each Y, U, V plane */
40  char path[1024];
41  char tmp[4][1024];
42  char target[4][1024];
43  int update;
45  int frame_pts;
46  const char *muxer;
48 } VideoMuxData;
49 
51 {
52  VideoMuxData *img = s->priv_data;
53  AVStream *st = s->streams[0];
55 
56  av_strlcpy(img->path, s->url, sizeof(img->path));
57 
58  /* find format */
59  if (s->oformat->flags & AVFMT_NOFILE)
60  img->is_pipe = 0;
61  else
62  img->is_pipe = 1;
63 
64  if (st->codecpar->codec_id == AV_CODEC_ID_GIF) {
65  img->muxer = "gif";
66  } else if (st->codecpar->codec_id == AV_CODEC_ID_FITS) {
67  img->muxer = "fits";
68  } else if (st->codecpar->codec_id == AV_CODEC_ID_RAWVIDEO) {
69  const char *str = strrchr(img->path, '.');
70  img->split_planes = str
71  && !av_strcasecmp(str + 1, "y")
72  && s->nb_streams == 1
73  && desc
74  &&(desc->flags & AV_PIX_FMT_FLAG_PLANAR)
75  && desc->nb_components >= 3;
76  }
77 
78  return 0;
79 }
80 
82 {
83  VideoMuxData *img = s->priv_data;
84  AVIOContext *pb[4];
85  char filename[1024];
86  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
88  int i;
89  int nb_renames = 0;
90 
91  if (!img->is_pipe) {
92  if (img->update) {
93  av_strlcpy(filename, img->path, sizeof(filename));
94  } else if (img->use_strftime) {
95  time_t now0;
96  struct tm *tm, tmpbuf;
97  time(&now0);
98  tm = localtime_r(&now0, &tmpbuf);
99  if (!strftime(filename, sizeof(filename), img->path, tm)) {
100  av_log(s, AV_LOG_ERROR, "Could not get frame filename with strftime\n");
101  return AVERROR(EINVAL);
102  }
103  } else if (img->frame_pts) {
104  if (av_get_frame_filename2(filename, sizeof(filename), img->path, pkt->pts, AV_FRAME_FILENAME_FLAGS_MULTIPLE) < 0) {
105  av_log(s, AV_LOG_ERROR, "Cannot write filename by pts of the frames.");
106  return AVERROR(EINVAL);
107  }
108  } else if (av_get_frame_filename2(filename, sizeof(filename), img->path,
109  img->img_number,
111  img->img_number > 1) {
113  "Could not get frame filename number %d from pattern '%s'. "
114  "Use '-frames:v 1' for a single image, or '-update' option, or use a pattern such as %%03d within the filename.\n",
115  img->img_number, img->path);
116  return AVERROR(EINVAL);
117  }
118  for (i = 0; i < 4; i++) {
119  snprintf(img->tmp[i], sizeof(img->tmp[i]), "%s.tmp", filename);
120  av_strlcpy(img->target[i], filename, sizeof(img->target[i]));
121  if (s->io_open(s, &pb[i], img->use_rename ? img->tmp[i] : filename, AVIO_FLAG_WRITE, NULL) < 0) {
122  av_log(s, AV_LOG_ERROR, "Could not open file : %s\n", img->use_rename ? img->tmp[i] : filename);
123  return AVERROR(EIO);
124  }
125 
126  if (!img->split_planes || i+1 >= desc->nb_components)
127  break;
128  filename[strlen(filename) - 1] = "UVAx"[i];
129  }
130  if (img->use_rename)
131  nb_renames = i + 1;
132  } else {
133  pb[0] = s->pb;
134  }
135 
136  if (img->split_planes) {
137  int ysize = par->width * par->height;
138  int usize = AV_CEIL_RSHIFT(par->width, desc->log2_chroma_w) * AV_CEIL_RSHIFT(par->height, desc->log2_chroma_h);
139  if (desc->comp[0].depth >= 9) {
140  ysize *= 2;
141  usize *= 2;
142  }
143  avio_write(pb[0], pkt->data , ysize);
144  avio_write(pb[1], pkt->data + ysize , usize);
145  avio_write(pb[2], pkt->data + ysize + usize, usize);
146  ff_format_io_close(s, &pb[1]);
147  ff_format_io_close(s, &pb[2]);
148  if (desc->nb_components > 3) {
149  avio_write(pb[3], pkt->data + ysize + 2*usize, ysize);
150  ff_format_io_close(s, &pb[3]);
151  }
152  } else if (img->muxer) {
153  int ret;
154  AVStream *st;
155  AVPacket pkt2 = {0};
157 
158  av_assert0(!img->split_planes);
159 
160  ret = avformat_alloc_output_context2(&fmt, NULL, img->muxer, s->url);
161  if (ret < 0)
162  return ret;
164  if (!st) {
166  return AVERROR(ENOMEM);
167  }
168  st->id = pkt->stream_index;
169 
170  fmt->pb = pb[0];
171  if ((ret = av_packet_ref(&pkt2, pkt)) < 0 ||
172  (ret = avcodec_parameters_copy(st->codecpar, s->streams[0]->codecpar)) < 0 ||
173  (ret = avformat_write_header(fmt, NULL)) < 0 ||
174  (ret = av_interleaved_write_frame(fmt, &pkt2)) < 0 ||
175  (ret = av_write_trailer(fmt)) < 0) {
176  av_packet_unref(&pkt2);
178  return ret;
179  }
180  av_packet_unref(&pkt2);
182  } else {
183  avio_write(pb[0], pkt->data, pkt->size);
184  }
185  avio_flush(pb[0]);
186  if (!img->is_pipe) {
187  ff_format_io_close(s, &pb[0]);
188  for (i = 0; i < nb_renames; i++) {
189  int ret = ff_rename(img->tmp[i], img->target[i], s);
190  if (ret < 0)
191  return ret;
192  }
193  }
194 
195  img->img_number++;
196  return 0;
197 }
198 
199 static int query_codec(enum AVCodecID id, int std_compliance)
200 {
201  int i;
202  for (i = 0; ff_img_tags[i].id != AV_CODEC_ID_NONE; i++)
203  if (ff_img_tags[i].id == id)
204  return 1;
205 
206  // Anything really can be stored in img2
207  return std_compliance < FF_COMPLIANCE_NORMAL;
208 }
209 
210 #define OFFSET(x) offsetof(VideoMuxData, x)
211 #define ENC AV_OPT_FLAG_ENCODING_PARAM
212 static const AVOption muxoptions[] = {
213  { "update", "continuously overwrite one file", OFFSET(update), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
214  { "start_number", "set first number in the sequence", OFFSET(img_number), AV_OPT_TYPE_INT, { .i64 = 1 }, 0, INT_MAX, ENC },
215  { "strftime", "use strftime for filename", OFFSET(use_strftime), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
216  { "frame_pts", "use current frame pts for filename", OFFSET(frame_pts), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
217  { "atomic_writing", "write files atomically (using temporary files and renames)", OFFSET(use_rename), AV_OPT_TYPE_BOOL, { .i64 = 0 }, 0, 1, ENC },
218  { NULL },
219 };
220 
221 #if CONFIG_IMAGE2_MUXER
222 static const AVClass img2mux_class = {
223  .class_name = "image2 muxer",
224  .item_name = av_default_item_name,
225  .option = muxoptions,
226  .version = LIBAVUTIL_VERSION_INT,
227 };
228 
230  .name = "image2",
231  .long_name = NULL_IF_CONFIG_SMALL("image2 sequence"),
232  .extensions = "bmp,dpx,jls,jpeg,jpg,ljpg,pam,pbm,pcx,pgm,pgmyuv,png,"
233  "ppm,sgi,tga,tif,tiff,jp2,j2c,j2k,xwd,sun,ras,rs,im1,im8,im24,"
234  "sunras,xbm,xface,pix,y",
235  .priv_data_size = sizeof(VideoMuxData),
236  .video_codec = AV_CODEC_ID_MJPEG,
241  .priv_class = &img2mux_class,
242 };
243 #endif
244 #if CONFIG_IMAGE2PIPE_MUXER
246  .name = "image2pipe",
247  .long_name = NULL_IF_CONFIG_SMALL("piped image2 sequence"),
248  .priv_data_size = sizeof(VideoMuxData),
249  .video_codec = AV_CODEC_ID_MJPEG,
254 };
255 #endif
ff_rename
static int ff_rename(const char *oldpath, const char *newpath, void *logctx)
Wrap errno on rename() error.
Definition: internal.h:591
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:599
VideoMuxData::img_number
int img_number
Definition: img2enc.c:37
AVOutputFormat::name
const char * name
Definition: avformat.h:496
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:4480
AVFMT_NODIMENSIONS
#define AVFMT_NODIMENSIONS
Format does not need width/height.
Definition: avformat.h:471
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: avcodec.h:3949
av_pix_fmt_desc_get
const AVPixFmtDescriptor * av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt)
Definition: pixdesc.c:2522
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:467
av_strcasecmp
int av_strcasecmp(const char *a, const char *b)
Locale-independent case-insensitive compare.
Definition: avstring.c:213
AV_CODEC_ID_RAWVIDEO
@ AV_CODEC_ID_RAWVIDEO
Definition: avcodec.h:231
pixdesc.h
AVPacket::data
uint8_t * data
Definition: avcodec.h:1477
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:4693
AVOption
AVOption.
Definition: opt.h:246
VideoMuxData::muxer
const char * muxer
Definition: img2enc.c:46
VideoMuxData::target
char target[4][1024]
Definition: img2enc.c:42
OFFSET
#define OFFSET(x)
Definition: img2enc.c:210
fmt
const char * fmt
Definition: avisynth_c.h:861
write_header
static int write_header(AVFormatContext *s)
Definition: img2enc.c:50
query_codec
static int query_codec(enum AVCodecID id, int std_compliance)
Definition: img2enc.c:199
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:77
write_packet
static int write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: img2enc.c:81
avassert.h
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
muxoptions
static const AVOption muxoptions[]
Definition: img2enc.c:212
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:58
AVCodecParameters::width
int width
Video only.
Definition: avcodec.h:4023
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
AVIO_FLAG_WRITE
#define AVIO_FLAG_WRITE
write-only
Definition: avio.h:655
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:508
time_internal.h
AVFormatContext
Format I/O context.
Definition: avformat.h:1342
internal.h
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:1017
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
VideoMuxData::use_strftime
int use_strftime
Definition: img2enc.c:44
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:67
VideoMuxData::update
int update
Definition: img2enc.c:43
NULL
#define NULL
Definition: coverity.c:32
IdStrMap::id
enum AVCodecID id
Definition: img2.h:67
AV_CODEC_ID_FITS
@ AV_CODEC_ID_FITS
Definition: avcodec.h:449
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
VideoMuxData::path
char path[1024]
Definition: img2enc.c:40
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:608
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:215
desc
const char * desc
Definition: nvenc.c:68
AVIOContext
Bytestream IO Context.
Definition: avio.h:161
AVPacket::size
int size
Definition: avcodec.h:1478
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:188
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:39
ff_image2pipe_muxer
AVOutputFormat ff_image2pipe_muxer
VideoMuxData::tmp
char tmp[4][1024]
Definition: img2enc.c:41
AVFMT_NOFILE
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:463
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:218
img
#define img
Definition: vf_colormatrix.c:116
avformat_alloc_output_context2
int avformat_alloc_output_context2(AVFormatContext **ctx, ff_const59 AVOutputFormat *oformat, const char *format_name, const char *filename)
Allocate an AVFormatContext for an output format.
Definition: mux.c:148
VideoMuxData::use_rename
int use_rename
Definition: img2enc.c:47
VideoMuxData::frame_pts
int frame_pts
Definition: img2enc.c:45
FF_COMPLIANCE_NORMAL
#define FF_COMPLIANCE_NORMAL
Definition: avcodec.h:2631
AV_FRAME_FILENAME_FLAGS_MULTIPLE
#define AV_FRAME_FILENAME_FLAGS_MULTIPLE
Allow multiple d.
Definition: avformat.h:2889
AV_CODEC_ID_GIF
@ AV_CODEC_ID_GIF
Definition: avcodec.h:315
AV_CODEC_ID_MJPEG
@ AV_CODEC_ID_MJPEG
Definition: avcodec.h:225
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: avcodec.h:216
AVOutputFormat
Definition: avformat.h:495
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470
avio_internal.h
AVCodecParameters::height
int height
Definition: avcodec.h:4024
img2.h
ENC
#define ENC
Definition: img2enc.c:211
AVStream::id
int id
Format-specific stream ID.
Definition: avformat.h:877
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:870
ff_image2_muxer
AVOutputFormat ff_image2_muxer
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:72
avformat.h
pkt
static AVPacket pkt
Definition: demuxing_decoding.c:54
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Definition: opt.h:223
avformat_free_context
void avformat_free_context(AVFormatContext *s)
Free an AVFormatContext and all its streams.
Definition: utils.c:4414
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:144
AVPacket::stream_index
int stream_index
Definition: avcodec.h:1479
ff_format_io_close
void ff_format_io_close(AVFormatContext *s, AVIOContext **pb)
Definition: utils.c:5665
AVCodecParameters::format
int format
Definition: avcodec.h:3981
AVPixFmtDescriptor
Descriptor that unambiguously describes how the bits of a pixel are stored in the up to 4 data planes...
Definition: pixdesc.h:81
avio_flush
int void avio_flush(AVIOContext *s)
Force flushing of buffered data.
Definition: aviobuf.c:238
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3957
AVPacket
This structure stores compressed data.
Definition: avcodec.h:1454
AV_OPT_TYPE_BOOL
@ AV_OPT_TYPE_BOOL
Definition: opt.h:240
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:1192
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:565
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
VideoMuxData::is_pipe
int is_pipe
Definition: img2enc.c:38
avstring.h
snprintf
#define snprintf
Definition: snprintf.h:34
avcodec_parameters_copy
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
Definition: utils.c:2080