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