FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 #include "avformat.h"
30 
31 typedef struct {
32  int offset;
33  int size;
34  unsigned char width;
35  unsigned char height;
36  short bits;
37 } IcoImage;
38 
39 typedef struct {
41  int nb_images;
44 
46 {
47  if (p->codec_id == AV_CODEC_ID_BMP) {
49  av_log(s, AV_LOG_ERROR, "Wrong endianness for bmp pixel format\n");
50  return AVERROR(EINVAL);
51  } else if (p->format != AV_PIX_FMT_PAL8 &&
53  p->format != AV_PIX_FMT_BGR24 &&
54  p->format != AV_PIX_FMT_BGRA) {
55  av_log(s, AV_LOG_ERROR, "BMP must be 1bit, 4bit, 8bit, 16bit, 24bit, or 32bit\n");
56  return AVERROR(EINVAL);
57  }
58  } else if (p->codec_id == AV_CODEC_ID_PNG) {
59  if (p->format != AV_PIX_FMT_RGBA) {
60  av_log(s, AV_LOG_ERROR, "PNG in ico requires pixel format to be rgba\n");
61  return AVERROR(EINVAL);
62  }
63  } else {
65  av_log(s, AV_LOG_ERROR, "Unsupported codec %s\n", codesc ? codesc->name : "");
66  return AVERROR(EINVAL);
67  }
68 
69  if (p->width > 256 ||
70  p->height > 256) {
71  av_log(s, AV_LOG_ERROR, "Unsupported dimensions %dx%d (dimensions cannot exceed 256x256)\n", p->width, p->height);
72  return AVERROR(EINVAL);
73  }
74 
75  return 0;
76 }
77 
79 {
80  IcoMuxContext *ico = s->priv_data;
81  AVIOContext *pb = s->pb;
82  int ret;
83  int i;
84 
85  if (!pb->seekable) {
86  av_log(s, AV_LOG_ERROR, "Output is not seekable\n");
87  return AVERROR(EINVAL);
88  }
89 
90  ico->current_image = 0;
91  ico->nb_images = s->nb_streams;
92 
93  avio_wl16(pb, 0); // reserved
94  avio_wl16(pb, 1); // 1 == icon
95  avio_skip(pb, 2); // skip the number of images
96 
97  for (i = 0; i < s->nb_streams; i++) {
98  if (ret = ico_check_attributes(s, s->streams[i]->codecpar))
99  return ret;
100 
101  // Fill in later when writing trailer...
102  avio_skip(pb, 16);
103  }
104 
105  ico->images = av_mallocz_array(ico->nb_images, sizeof(IcoMuxContext));
106  if (!ico->images)
107  return AVERROR(ENOMEM);
108 
109  avio_flush(pb);
110 
111  return 0;
112 }
113 
115 {
116  IcoMuxContext *ico = s->priv_data;
117  IcoImage *image;
118  AVIOContext *pb = s->pb;
120  int i;
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  for (i = 0; i < par->height * (par->width + 7) / 8; ++i)
152  avio_w8(pb, 0x00); // Write bitmask (opaque)
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  av_freep(&ico->images);
187 
188  return 0;
189 }
190 
192  .name = "ico",
193  .long_name = NULL_IF_CONFIG_SMALL("Microsoft Windows ICO"),
194  .priv_data_size = sizeof(IcoMuxContext),
195  .mime_type = "image/vnd.microsoft.icon",
196  .extensions = "ico",
197  .audio_codec = AV_CODEC_ID_NONE,
198  .video_codec = AV_CODEC_ID_BMP,
203 };
void avio_wl16(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:446
const char * s
Definition: avisynth_c.h:631
Bytestream IO Context.
Definition: avio.h:147
AVOutputFormat ff_ico_muxer
Definition: icoenc.c:191
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3939
packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined ...
Definition: pixfmt.h:116
int size
Definition: avcodec.h:1589
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
fseek() equivalent for AVIOContext.
Definition: aviobuf.c:230
int64_t avio_skip(AVIOContext *s, int64_t offset)
Skip given number of bytes forward.
Definition: aviobuf.c:304
static AVPacket pkt
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:87
int offset
Definition: icodec.c:35
This struct describes the properties of an encoded stream.
Definition: avcodec.h:3931
Format I/O context.
Definition: avformat.h:1325
unsigned char height
Definition: icoenc.c:35
void avio_wl32(AVIOContext *s, unsigned int val)
Definition: aviobuf.c:346
int width
Video only.
Definition: avcodec.h:4005
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:73
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1393
uint8_t * data
Definition: avcodec.h:1588
ptrdiff_t size
Definition: opengl_enc.c:101
static av_always_inline int64_t avio_tell(AVIOContext *s)
ftell() equivalent for AVIOContext.
Definition: avio.h:511
static int ico_write_header(AVFormatContext *s)
Definition: icoenc.c:78
void avio_write(AVIOContext *s, const unsigned char *buf, int size)
Definition: aviobuf.c:204
#define av_log(a,...)
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:96
static const uint8_t offset[127][2]
Definition: vf_spp.c:92
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:94
const AVCodecDescriptor * avcodec_descriptor_get(enum AVCodecID id)
Definition: codec_desc.c:2957
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1381
int seekable
A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
Definition: avio.h:243
int void avio_flush(AVIOContext *s)
Force flushing of buffered data.
Definition: aviobuf.c:224
unsigned char width
Definition: icoenc.c:34
static int write_trailer(AVFormatContext *s1)
Definition: v4l2enc.c:94
const char * name
Definition: avformat.h:522
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:65
#define AVFMT_NOTIMESTAMPS
Format does not need / have any timestamps.
Definition: avformat.h:484
AVIOContext * pb
I/O context.
Definition: avformat.h:1367
void avio_w8(AVIOContext *s, int b)
Definition: aviobuf.c:182
#define AV_PIX_FMT_RGB32
Definition: pixfmt.h:320
static int ico_check_attributes(AVFormatContext *s, const AVCodecParameters *p)
Definition: icoenc.c:45
static int ico_write_trailer(AVFormatContext *s)
Definition: icoenc.c:158
IcoImage * images
Definition: icoenc.c:42
const char * name
Name of the codec described by this descriptor.
Definition: avcodec.h:665
int nb_images
Definition: icoenc.c:41
This struct describes the properties of a single codec described by an AVCodecID. ...
Definition: avcodec.h:657
static int flags
Definition: cpu.c:47
int current_image
Definition: icoenc.c:40
Main libavformat public API header.
int size
Definition: icodec.c:36
void * priv_data
Format private data.
Definition: avformat.h:1353
static void write_header(FFV1Context *f)
Definition: ffv1enc.c:498
short bits
Definition: icoenc.c:36
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: avcodec.h:3981
static void * av_mallocz_array(size_t nmemb, size_t size)
Definition: mem.h:229
#define av_freep(p)
AVCodecParameters * codecpar
Definition: avformat.h:1228
int stream_index
Definition: avcodec.h:1590
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
This structure stores compressed data.
Definition: avcodec.h:1565
static int ico_write_packet(AVFormatContext *s, AVPacket *pkt)
Definition: icoenc.c:114
static int write_packet(AVFormatContext *s1, AVPacket *pkt)
Definition: v4l2enc.c:86