FFmpeg
icoenc.c
Go to the documentation of this file.
1 /*
2  * Microsoft Windows ICO muxer
3  * Copyright (c) 2012 Michael Bradshaw <mjbshaw gmail com>
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  * Microsoft Windows ICO muxer
25  */
26 
27 #include "libavutil/intreadwrite.h"
28 #include "libavutil/pixdesc.h"
29 
30 #include "libavcodec/codec_id.h"
31 
32 #include "avformat.h"
33 #include "avio_internal.h"
34 
35 typedef struct {
36  int offset;
37  int size;
38  unsigned char width;
39  unsigned char height;
40  short bits;
41 } IcoImage;
42 
43 typedef struct {
45  int nb_images;
48 
50 {
51  if (p->codec_id == AV_CODEC_ID_BMP) {
53  av_log(s, AV_LOG_ERROR, "Wrong endianness for bmp pixel format\n");
54  return AVERROR(EINVAL);
55  } else if (p->format != AV_PIX_FMT_PAL8 &&
57  p->format != AV_PIX_FMT_BGR24 &&
58  p->format != AV_PIX_FMT_BGRA) {
59  av_log(s, AV_LOG_ERROR, "BMP must be 1bit, 4bit, 8bit, 16bit, 24bit, or 32bit\n");
60  return AVERROR(EINVAL);
61  }
62  } else if (p->codec_id == AV_CODEC_ID_PNG) {
63  if (p->format != AV_PIX_FMT_RGBA) {
64  av_log(s, AV_LOG_ERROR, "PNG in ico requires pixel format to be rgba\n");
65  return AVERROR(EINVAL);
66  }
67  } else {
68  av_log(s, AV_LOG_ERROR, "Unsupported codec %s\n", avcodec_get_name(p->codec_id));
69  return AVERROR(EINVAL);
70  }
71 
72  if (p->width > 256 ||
73  p->height > 256) {
74  av_log(s, AV_LOG_ERROR, "Unsupported dimensions %dx%d (dimensions cannot exceed 256x256)\n", p->width, p->height);
75  return AVERROR(EINVAL);
76  }
77 
78  return 0;
79 }
80 
82 {
83  IcoMuxContext *ico = s->priv_data;
84  AVIOContext *pb = s->pb;
85  int ret;
86  int i;
87 
88  if (!(pb->seekable & AVIO_SEEKABLE_NORMAL)) {
89  av_log(s, AV_LOG_ERROR, "Output is not seekable\n");
90  return AVERROR(EINVAL);
91  }
92 
93  ico->current_image = 0;
94  ico->nb_images = s->nb_streams;
95 
96  avio_wl16(pb, 0); // reserved
97  avio_wl16(pb, 1); // 1 == icon
98  avio_skip(pb, 2); // skip the number of images
99 
100  for (i = 0; i < s->nb_streams; i++) {
101  if (ret = ico_check_attributes(s, s->streams[i]->codecpar))
102  return ret;
103 
104  // Fill in later when writing trailer...
105  avio_skip(pb, 16);
106  }
107 
108  ico->images = av_calloc(ico->nb_images, sizeof(*ico->images));
109  if (!ico->images)
110  return AVERROR(ENOMEM);
111 
112  return 0;
113 }
114 
116 {
117  IcoMuxContext *ico = s->priv_data;
118  IcoImage *image;
119  AVIOContext *pb = s->pb;
120  AVCodecParameters *par = s->streams[pkt->stream_index]->codecpar;
121 
122  if (ico->current_image >= ico->nb_images) {
123  av_log(s, AV_LOG_ERROR, "ICO already contains %d images\n", ico->current_image);
124  return AVERROR(EIO);
125  }
126 
127  image = &ico->images[ico->current_image++];
128 
129  image->offset = avio_tell(pb);
130  image->width = (par->width == 256) ? 0 : par->width;
131  image->height = (par->height == 256) ? 0 : par->height;
132 
133  if (par->codec_id == AV_CODEC_ID_PNG) {
134  image->bits = par->bits_per_coded_sample;
135  image->size = pkt->size;
136 
137  avio_write(pb, pkt->data, pkt->size);
138  } else { // BMP
139  if (AV_RL32(pkt->data + 14) != 40) { // must be BITMAPINFOHEADER
140  av_log(s, AV_LOG_ERROR, "Invalid BMP\n");
141  return AVERROR(EINVAL);
142  }
143 
144  image->bits = AV_RL16(pkt->data + 28); // allows things like 1bit and 4bit images to be preserved
145  image->size = pkt->size - 14 + par->height * (par->width + 7) / 8;
146 
147  avio_write(pb, pkt->data + 14, 8); // Skip the BITMAPFILEHEADER header
148  avio_wl32(pb, AV_RL32(pkt->data + 22) * 2); // rewrite height as 2 * height
149  avio_write(pb, pkt->data + 26, pkt->size - 26);
150 
151  // Write bitmask (opaque)
152  ffio_fill(pb, 0x00, par->height * (par->width + 7) / 8);
153  }
154 
155  return 0;
156 }
157 
159 {
160  IcoMuxContext *ico = s->priv_data;
161  AVIOContext *pb = s->pb;
162  int i;
163 
164  avio_seek(pb, 4, SEEK_SET);
165 
166  avio_wl16(pb, ico->current_image);
167 
168  for (i = 0; i < ico->nb_images; i++) {
169  avio_w8(pb, ico->images[i].width);
170  avio_w8(pb, ico->images[i].height);
171 
172  if (s->streams[i]->codecpar->codec_id == AV_CODEC_ID_BMP &&
173  s->streams[i]->codecpar->format == AV_PIX_FMT_PAL8) {
174  avio_w8(pb, (ico->images[i].bits >= 8) ? 0 : 1 << ico->images[i].bits);
175  } else {
176  avio_w8(pb, 0);
177  }
178 
179  avio_w8(pb, 0); // reserved
180  avio_wl16(pb, 1); // color planes
181  avio_wl16(pb, ico->images[i].bits);
182  avio_wl32(pb, ico->images[i].size);
183  avio_wl32(pb, ico->images[i].offset);
184  }
185 
186  return 0;
187 }
188 
190 {
191  IcoMuxContext *ico = s->priv_data;
192 
193  av_freep(&ico->images);
194 }
195 
197  .name = "ico",
198  .long_name = NULL_IF_CONFIG_SMALL("Microsoft Windows ICO"),
199  .priv_data_size = sizeof(IcoMuxContext),
200  .mime_type = "image/vnd.microsoft.icon",
201  .extensions = "ico",
202  .audio_codec = AV_CODEC_ID_NONE,
203  .video_codec = AV_CODEC_ID_BMP,
207  .deinit = ico_deinit,
209 };
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
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
AVFMT_NOTIMESTAMPS
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:468
IcoImage::width
unsigned char width
Definition: icoenc.c:38
pixdesc.h
deinit
static void deinit(AVFormatContext *s)
Definition: chromaprint.c:50
AVPacket::data
uint8_t * data
Definition: packet.h:373
IcoMuxContext::current_image
int current_image
Definition: icoenc.c:44
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:95
avio_wl16
void avio_wl16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:466
ico_deinit
static void ico_deinit(AVFormatContext *s)
Definition: icoenc.c:189
ff_ico_muxer
const AVOutputFormat ff_ico_muxer
Definition: icoenc.c:196
avio_tell
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:504
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
codec_id.h
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_CODEC_ID_BMP
@ AV_CODEC_ID_BMP
Definition: codec_id.h:128
ico_write_trailer
static int ico_write_trailer(AVFormatContext *s)
Definition: icoenc.c:158
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:126
AV_RL16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:94
AV_PIX_FMT_RGBA
@ AV_PIX_FMT_RGBA
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:93
AV_CODEC_ID_PNG
@ AV_CODEC_ID_PNG
Definition: codec_id.h:111
AVFormatContext
Format I/O context.
Definition: avformat.h:1193
write_trailer
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:98
avio_w8
void avio_w8(AVIOContext *s, int b)
Definition: aviobuf.c:210
ffio_fill
void ffio_fill(AVIOContext *s, int b, int64_t count)
Definition: aviobuf.c:218
IcoMuxContext
Definition: icoenc.c:43
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
AVIOContext::seekable
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:262
size
int size
Definition: twinvq_data.h:10344
ico_write_packet
static int ico_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: icoenc.c:115
avio_write
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:232
AV_PIX_FMT_RGB32
#define AV_PIX_FMT_RGB32
Definition: pixfmt.h:377
avio_wl32
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:386
offset
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
Definition: writing_filters.txt:86
write_packet
static void write_packet(OutputFile *of, AVPacket *pkt, OutputStream *ost, int unqueue)
Definition: ffmpeg.c:727
avcodec_get_name
const char * avcodec_get_name(enum AVCodecID id)
Get the name of a codec.
Definition: utils.c:454
AV_PIX_FMT_RGB555LE
@ AV_PIX_FMT_RGB555LE
packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined
Definition: pixfmt.h:108
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
avio_internal.h
AVCodecParameters::height
int height
Definition: codec_par.h:127
IcoImage
Definition: icodec.c:34
IcoMuxContext::images
IcoImage * images
Definition: icoenc.c:46
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:271
AV_PIX_FMT_PAL8
@ AV_PIX_FMT_PAL8
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
ret
ret
Definition: filter_design.txt:187
avio_seek
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:260
avformat.h
IcoImage::offset
int offset
Definition: icodec.c:35
IcoImage::size
int size
Definition: icodec.c:36
AV_RL32
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:92
AVIO_SEEKABLE_NORMAL
#define AVIO_SEEKABLE_NORMAL
Seeking works like for a local file.
Definition: avio.h:40
IcoImage::height
unsigned char height
Definition: icoenc.c:39
AVPacket::stream_index
int stream_index
Definition: packet.h:375
avio_skip
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:347
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:102
AVCodecParameters::format
int format
Definition: codec_par.h:84
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_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
ico_check_attributes
static int ico_check_attributes(AVFormatContext *s, const AVCodecParameters *p)
Definition: icoenc.c:49
IcoImage::bits
short bits
Definition: icoenc.c:40
write_header
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:347
IcoMuxContext::nb_images
int nb_images
Definition: icoenc.c:45
ico_write_header
static int ico_write_header(AVFormatContext *s)
Definition: icoenc.c:81