]> git.sesse.net Git - ffmpeg/blob - libavformat/rtpdec_jpeg.c
rtpdec_jpeg: Disallow using the reserved q values
[ffmpeg] / libavformat / rtpdec_jpeg.c
1 /*
2  * RTP JPEG-compressed Video Depacketizer, RFC 2435
3  * Copyright (c) 2012 Samuel Pitoiset
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include "avformat.h"
23 #include "rtpdec_formats.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavcodec/mjpeg.h"
26 #include "libavcodec/bytestream.h"
27
28 /**
29  * RTP/JPEG specific private data.
30  */
31 struct PayloadContext {
32     AVIOContext *frame;         ///< current frame buffer
33     uint32_t    timestamp;      ///< current frame timestamp
34     int         hdr_size;       ///< size of the current frame header
35     uint8_t     qtables[128][128];
36     uint8_t     qtables_len[128];
37 };
38
39 static const uint8_t default_quantizers[128] = {
40     /* luma table */
41     16,  11,  12,  14,  12,  10,  16,  14,
42     13,  14,  18,  17,  16,  19,  24,  40,
43     26,  24,  22,  22,  24,  49,  35,  37,
44     29,  40,  58,  51,  61,  60,  57,  51,
45     56,  55,  64,  72,  92,  78,  64,  68,
46     87,  69,  55,  56,  80,  109, 81,  87,
47     95,  98,  103, 104, 103, 62,  77,  113,
48     121, 112, 100, 120, 92,  101, 103, 99,
49
50     /* chroma table */
51     17,  18,  18,  24,  21,  24,  47,  26,
52     26,  47,  99,  66,  56,  66,  99,  99,
53     99,  99,  99,  99,  99,  99,  99,  99,
54     99,  99,  99,  99,  99,  99,  99,  99,
55     99,  99,  99,  99,  99,  99,  99,  99,
56     99,  99,  99,  99,  99,  99,  99,  99,
57     99,  99,  99,  99,  99,  99,  99,  99,
58     99,  99,  99,  99,  99,  99,  99,  99
59 };
60
61 static PayloadContext *jpeg_new_context(void)
62 {
63     return av_mallocz(sizeof(PayloadContext));
64 }
65
66 static inline void free_frame_if_needed(PayloadContext *jpeg)
67 {
68     if (jpeg->frame) {
69         uint8_t *p;
70         avio_close_dyn_buf(jpeg->frame, &p);
71         av_free(p);
72         jpeg->frame = NULL;
73     }
74 }
75
76 static void jpeg_free_context(PayloadContext *jpeg)
77 {
78     free_frame_if_needed(jpeg);
79     av_free(jpeg);
80 }
81
82 static int jpeg_create_huffman_table(PutByteContext *p, int table_class,
83                                      int table_id, const uint8_t *bits_table,
84                                      const uint8_t *value_table)
85 {
86     int i, n = 0;
87
88     bytestream2_put_byte(p, table_class << 4 | table_id);
89
90     for (i = 1; i <= 16; i++) {
91         n += bits_table[i];
92         bytestream2_put_byte(p, bits_table[i]);
93     }
94
95     for (i = 0; i < n; i++) {
96         bytestream2_put_byte(p, value_table[i]);
97     }
98     return n + 17;
99 }
100
101 static void jpeg_put_marker(PutByteContext *pbc, int code)
102 {
103     bytestream2_put_byte(pbc, 0xff);
104     bytestream2_put_byte(pbc, code);
105 }
106
107 static int jpeg_create_header(uint8_t *buf, int size, uint32_t type, uint32_t w,
108                               uint32_t h, const uint8_t *qtable, int nb_qtable)
109 {
110     PutByteContext pbc;
111     uint8_t *dht_size_ptr;
112     int dht_size, i;
113
114     bytestream2_init_writer(&pbc, buf, size);
115
116     /* Convert from blocks to pixels. */
117     w <<= 3;
118     h <<= 3;
119
120     /* SOI */
121     jpeg_put_marker(&pbc, SOI);
122
123     /* JFIF header */
124     jpeg_put_marker(&pbc, APP0);
125     bytestream2_put_be16(&pbc, 16);
126     bytestream2_put_buffer(&pbc, "JFIF", 5);
127     bytestream2_put_be16(&pbc, 0x0201);
128     bytestream2_put_byte(&pbc, 0);
129     bytestream2_put_be16(&pbc, 1);
130     bytestream2_put_be16(&pbc, 1);
131     bytestream2_put_byte(&pbc, 0);
132     bytestream2_put_byte(&pbc, 0);
133
134     /* DQT */
135     jpeg_put_marker(&pbc, DQT);
136     bytestream2_put_be16(&pbc, 2 + nb_qtable * (1 + 64));
137
138     for (i = 0; i < nb_qtable; i++) {
139         bytestream2_put_byte(&pbc, i);
140
141         /* Each table is an array of 64 values given in zig-zag
142          * order, identical to the format used in a JFIF DQT
143          * marker segment. */
144         bytestream2_put_buffer(&pbc, qtable + 64 * i, 64);
145     }
146
147     /* DHT */
148     jpeg_put_marker(&pbc, DHT);
149     dht_size_ptr = pbc.buffer;
150     bytestream2_put_be16(&pbc, 0);
151
152     dht_size  = 2;
153     dht_size += jpeg_create_huffman_table(&pbc, 0, 0,avpriv_mjpeg_bits_dc_luminance,
154                                           avpriv_mjpeg_val_dc);
155     dht_size += jpeg_create_huffman_table(&pbc, 0, 1, avpriv_mjpeg_bits_dc_chrominance,
156                                           avpriv_mjpeg_val_dc);
157     dht_size += jpeg_create_huffman_table(&pbc, 1, 0, avpriv_mjpeg_bits_ac_luminance,
158                                           avpriv_mjpeg_val_ac_luminance);
159     dht_size += jpeg_create_huffman_table(&pbc, 1, 1, avpriv_mjpeg_bits_ac_chrominance,
160                                           avpriv_mjpeg_val_ac_chrominance);
161     AV_WB16(dht_size_ptr, dht_size);
162
163     /* SOF0 */
164     jpeg_put_marker(&pbc, SOF0);
165     bytestream2_put_be16(&pbc, 17); /* size */
166     bytestream2_put_byte(&pbc, 8); /* bits per component */
167     bytestream2_put_be16(&pbc, h);
168     bytestream2_put_be16(&pbc, w);
169     bytestream2_put_byte(&pbc, 3); /* number of components */
170     bytestream2_put_byte(&pbc, 1); /* component number */
171     bytestream2_put_byte(&pbc, (2 << 4) | (type ? 2 : 1)); /* hsample/vsample */
172     bytestream2_put_byte(&pbc, 0); /* matrix number */
173     bytestream2_put_byte(&pbc, 2); /* component number */
174     bytestream2_put_byte(&pbc, 1 << 4 | 1); /* hsample/vsample */
175     bytestream2_put_byte(&pbc, nb_qtable == 2 ? 1 : 0); /* matrix number */
176     bytestream2_put_byte(&pbc, 3); /* component number */
177     bytestream2_put_byte(&pbc, 1 << 4 | 1); /* hsample/vsample */
178     bytestream2_put_byte(&pbc, nb_qtable == 2 ? 1 : 0); /* matrix number */
179
180     /* SOS */
181     jpeg_put_marker(&pbc, SOS);
182     bytestream2_put_be16(&pbc, 12);
183     bytestream2_put_byte(&pbc, 3);
184     bytestream2_put_byte(&pbc, 1);
185     bytestream2_put_byte(&pbc, 0);
186     bytestream2_put_byte(&pbc, 2);
187     bytestream2_put_byte(&pbc, 17);
188     bytestream2_put_byte(&pbc, 3);
189     bytestream2_put_byte(&pbc, 17);
190     bytestream2_put_byte(&pbc, 0);
191     bytestream2_put_byte(&pbc, 63);
192     bytestream2_put_byte(&pbc, 0);
193
194     /* Return the length in bytes of the JPEG header. */
195     return bytestream2_tell_p(&pbc);
196 }
197
198 static void create_default_qtables(uint8_t *qtables, uint8_t q)
199 {
200     int factor = q;
201     int i;
202
203     factor = av_clip(q, 1, 99);
204
205     if (q < 50)
206         q = 5000 / factor;
207     else
208         q = 200 - factor * 2;
209
210     for (i = 0; i < 128; i++) {
211         int val = (default_quantizers[i] * q + 50) / 100;
212
213         /* Limit the quantizers to 1 <= q <= 255. */
214         val = av_clip(val, 1, 255);
215         qtables[i] = val;
216     }
217 }
218
219 static int jpeg_parse_packet(AVFormatContext *ctx, PayloadContext *jpeg,
220                              AVStream *st, AVPacket *pkt, uint32_t *timestamp,
221                              const uint8_t *buf, int len, int flags)
222 {
223     uint8_t type, q, width, height;
224     const uint8_t *qtables = NULL;
225     uint16_t qtable_len;
226     uint32_t off;
227     int ret;
228
229     if (len < 8) {
230         av_log(ctx, AV_LOG_ERROR, "Too short RTP/JPEG packet.\n");
231         return AVERROR_INVALIDDATA;
232     }
233
234     /* Parse the main JPEG header. */
235     off    = AV_RB24(buf + 1);  /* fragment byte offset */
236     type   = AV_RB8(buf + 4);   /* id of jpeg decoder params */
237     q      = AV_RB8(buf + 5);   /* quantization factor (or table id) */
238     width  = AV_RB8(buf + 6);   /* frame width in 8 pixel blocks */
239     height = AV_RB8(buf + 7);   /* frame height in 8 pixel blocks */
240     buf += 8;
241     len -= 8;
242
243     /* Parse the restart marker header. */
244     if (type > 63) {
245         av_log(ctx, AV_LOG_ERROR,
246                "Unimplemented RTP/JPEG restart marker header.\n");
247         return AVERROR_PATCHWELCOME;
248     }
249
250     /* Parse the quantization table header. */
251     if (off == 0) {
252         /* Start of JPEG data packet. */
253         uint8_t new_qtables[128];
254         uint8_t hdr[1024];
255
256         if (q > 127) {
257             uint8_t precision;
258             if (len < 4) {
259                 av_log(ctx, AV_LOG_ERROR, "Too short RTP/JPEG packet.\n");
260                 return AVERROR_INVALIDDATA;
261             }
262
263             /* The first byte is reserved for future use. */
264             precision  = AV_RB8(buf + 1);    /* size of coefficients */
265             qtable_len = AV_RB16(buf + 2);   /* length in bytes */
266             buf += 4;
267             len -= 4;
268
269             if (precision)
270                 av_log(ctx, AV_LOG_WARNING, "Only 8-bit precision is supported.\n");
271
272             if (qtable_len > 0) {
273                 if (len < qtable_len) {
274                     av_log(ctx, AV_LOG_ERROR, "Too short RTP/JPEG packet.\n");
275                     return AVERROR_INVALIDDATA;
276                 }
277                 qtables = buf;
278                 buf += qtable_len;
279                 len -= qtable_len;
280                 if (q < 255) {
281                     if (jpeg->qtables_len[q - 128] &&
282                         (jpeg->qtables_len[q - 128] != qtable_len ||
283                          memcmp(qtables, &jpeg->qtables[q - 128][0], qtable_len))) {
284                         av_log(ctx, AV_LOG_WARNING,
285                                "Quantization tables for q=%d changed\n", q);
286                     } else if (!jpeg->qtables_len[q - 128] && qtable_len <= 128) {
287                         memcpy(&jpeg->qtables[q - 128][0], qtables,
288                                qtable_len);
289                         jpeg->qtables_len[q - 128] = qtable_len;
290                     }
291                 }
292             } else {
293                 if (q == 255) {
294                     av_log(ctx, AV_LOG_ERROR,
295                            "Invalid RTP/JPEG packet. Quantization tables not found.\n");
296                     return AVERROR_INVALIDDATA;
297                 }
298                 if (!jpeg->qtables_len[q - 128]) {
299                     av_log(ctx, AV_LOG_ERROR,
300                            "No quantization tables known for q=%d yet.\n", q);
301                     return AVERROR_INVALIDDATA;
302                 }
303                 qtables    = &jpeg->qtables[q - 128][0];
304                 qtable_len =  jpeg->qtables_len[q - 128];
305             }
306         } else { /* q <= 127 */
307             if (q == 0 || q > 99) {
308                 av_log(ctx, AV_LOG_ERROR, "Reserved q value %d\n", q);
309                 return AVERROR_INVALIDDATA;
310             }
311             create_default_qtables(new_qtables, q);
312             qtables    = new_qtables;
313             qtable_len = sizeof(new_qtables);
314         }
315
316         /* Skip the current frame in case of the end packet
317          * has been lost somewhere. */
318         free_frame_if_needed(jpeg);
319
320         if ((ret = avio_open_dyn_buf(&jpeg->frame)) < 0)
321             return ret;
322         jpeg->timestamp = *timestamp;
323
324         /* Generate a frame and scan headers that can be prepended to the
325          * RTP/JPEG data payload to produce a JPEG compressed image in
326          * interchange format. */
327         jpeg->hdr_size = jpeg_create_header(hdr, sizeof(hdr), type, width,
328                                             height, qtables,
329                                             qtable_len / 64);
330
331         /* Copy JPEG header to frame buffer. */
332         avio_write(jpeg->frame, hdr, jpeg->hdr_size);
333     }
334
335     if (!jpeg->frame) {
336         av_log(ctx, AV_LOG_ERROR,
337                "Received packet without a start chunk; dropping frame.\n");
338         return AVERROR(EAGAIN);
339     }
340
341     if (jpeg->timestamp != *timestamp) {
342         /* Skip the current frame if timestamp is incorrect.
343          * A start packet has been lost somewhere. */
344         free_frame_if_needed(jpeg);
345         av_log(ctx, AV_LOG_ERROR, "RTP timestamps don't match.\n");
346         return AVERROR_INVALIDDATA;
347     }
348
349     if (off != avio_tell(jpeg->frame) - jpeg->hdr_size) {
350         av_log(ctx, AV_LOG_ERROR,
351                "Missing packets; dropping frame.\n");
352         return AVERROR(EAGAIN);
353     }
354
355     /* Copy data to frame buffer. */
356     avio_write(jpeg->frame, buf, len);
357
358     if (flags & RTP_FLAG_MARKER) {
359         /* End of JPEG data packet. */
360         uint8_t buf[2] = { 0xff, EOI };
361
362         /* Put EOI marker. */
363         avio_write(jpeg->frame, buf, sizeof(buf));
364
365         /* Prepare the JPEG packet. */
366         av_init_packet(pkt);
367         pkt->size = avio_close_dyn_buf(jpeg->frame, &pkt->data);
368         if (pkt->size < 0) {
369             av_log(ctx, AV_LOG_ERROR,
370                    "Error occured when getting frame buffer.\n");
371             jpeg->frame = NULL;
372             return pkt->size;
373         }
374         pkt->stream_index = st->index;
375         pkt->destruct     = av_destruct_packet;
376
377         /* Re-init the frame buffer. */
378         jpeg->frame = NULL;
379
380         return 0;
381     }
382
383     return AVERROR(EAGAIN);
384 }
385
386 RTPDynamicProtocolHandler ff_jpeg_dynamic_handler = {
387     .enc_name          = "JPEG",
388     .codec_type        = AVMEDIA_TYPE_VIDEO,
389     .codec_id          = AV_CODEC_ID_MJPEG,
390     .alloc             = jpeg_new_context,
391     .free              = jpeg_free_context,
392     .parse_packet      = jpeg_parse_packet,
393     .static_payload_id = 26,
394 };