Avoid "reloading" code by using a 64 bit type for the flags and loading all at once.
[ffmpeg.git] / libavcodec / interplayvideo.c
1 /*
2  * Interplay MVE Video Decoder
3  * Copyright (C) 2003 the ffmpeg project
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 libavcodec/interplayvideo.c
24  * Interplay MVE Video Decoder by Mike Melanson (melanson@pcisys.net)
25  * For more information about the Interplay MVE format, visit:
26  *   http://www.pcisys.net/~melanson/codecs/interplay-mve.txt
27  * This code is written in such a way that the identifiers match up
28  * with the encoding descriptions in the document.
29  *
30  * This decoder presently only supports a PAL8 output colorspace.
31  *
32  * An Interplay video frame consists of 2 parts: The decoding map and
33  * the video data. A demuxer must load these 2 parts together in a single
34  * buffer before sending it through the stream to this decoder.
35  */
36
37 #include <stdio.h>
38 #include <stdlib.h>
39 #include <string.h>
40 #include <unistd.h>
41
42 #include "avcodec.h"
43 #include "bytestream.h"
44 #include "dsputil.h"
45
46 #define PALETTE_COUNT 256
47
48 /* debugging support */
49 #define DEBUG_INTERPLAY 0
50 #if DEBUG_INTERPLAY
51 #define debug_interplay(x,...) av_log(NULL, AV_LOG_DEBUG, x, __VA_ARGS__)
52 #else
53 static inline void debug_interplay(const char *format, ...) { }
54 #endif
55
56 typedef struct IpvideoContext {
57
58     AVCodecContext *avctx;
59     DSPContext dsp;
60     AVFrame second_last_frame;
61     AVFrame last_frame;
62     AVFrame current_frame;
63     const unsigned char *decoding_map;
64     int decoding_map_size;
65
66     const unsigned char *buf;
67     int size;
68
69     const unsigned char *stream_ptr;
70     const unsigned char *stream_end;
71     unsigned char *pixel_ptr;
72     int line_inc;
73     int stride;
74     int upper_motion_limit_offset;
75
76 } IpvideoContext;
77
78 #define CHECK_STREAM_PTR(n) \
79   if (s->stream_end - s->stream_ptr < n) { \
80     av_log(s->avctx, AV_LOG_ERROR, "Interplay video warning: stream_ptr out of bounds (%p >= %p)\n", \
81       s->stream_ptr + n, s->stream_end); \
82     return -1; \
83   }
84
85 static int copy_from(IpvideoContext *s, AVFrame *src, int delta_x, int delta_y)
86 {
87     int current_offset = s->pixel_ptr - s->current_frame.data[0];
88     int motion_offset = current_offset + delta_y * s->stride + delta_x;
89     if (motion_offset < 0) {
90         av_log(s->avctx, AV_LOG_ERROR, " Interplay video: motion offset < 0 (%d)\n", motion_offset);
91         return -1;
92     } else if (motion_offset > s->upper_motion_limit_offset) {
93         av_log(s->avctx, AV_LOG_ERROR, " Interplay video: motion offset above limit (%d >= %d)\n",
94             motion_offset, s->upper_motion_limit_offset);
95         return -1;
96     }
97     s->dsp.put_pixels_tab[1][0](s->pixel_ptr, src->data[0] + motion_offset, s->stride, 8);
98     return 0;
99 }
100
101 static int ipvideo_decode_block_opcode_0x0(IpvideoContext *s)
102 {
103     return copy_from(s, &s->last_frame, 0, 0);
104 }
105
106 static int ipvideo_decode_block_opcode_0x1(IpvideoContext *s)
107 {
108     return copy_from(s, &s->second_last_frame, 0, 0);
109 }
110
111 static int ipvideo_decode_block_opcode_0x2(IpvideoContext *s)
112 {
113     unsigned char B;
114     int x, y;
115
116     /* copy block from 2 frames ago using a motion vector; need 1 more byte */
117     CHECK_STREAM_PTR(1);
118     B = *s->stream_ptr++;
119
120     if (B < 56) {
121         x = 8 + (B % 7);
122         y = B / 7;
123     } else {
124         x = -14 + ((B - 56) % 29);
125         y =   8 + ((B - 56) / 29);
126     }
127
128     debug_interplay ("    motion byte = %d, (x, y) = (%d, %d)\n", B, x, y);
129     return copy_from(s, &s->second_last_frame, x, y);
130 }
131
132 static int ipvideo_decode_block_opcode_0x3(IpvideoContext *s)
133 {
134     unsigned char B;
135     int x, y;
136
137     /* copy 8x8 block from current frame from an up/left block */
138
139     /* need 1 more byte for motion */
140     CHECK_STREAM_PTR(1);
141     B = *s->stream_ptr++;
142
143     if (B < 56) {
144         x = -(8 + (B % 7));
145         y = -(B / 7);
146     } else {
147         x = -(-14 + ((B - 56) % 29));
148         y = -(  8 + ((B - 56) / 29));
149     }
150
151     debug_interplay ("    motion byte = %d, (x, y) = (%d, %d)\n", B, x, y);
152     return copy_from(s, &s->current_frame, x, y);
153 }
154
155 static int ipvideo_decode_block_opcode_0x4(IpvideoContext *s)
156 {
157     int x, y;
158     unsigned char B, BL, BH;
159
160     /* copy a block from the previous frame; need 1 more byte */
161     CHECK_STREAM_PTR(1);
162
163     B = *s->stream_ptr++;
164     BL = B & 0x0F;
165     BH = (B >> 4) & 0x0F;
166     x = -8 + BL;
167     y = -8 + BH;
168
169     debug_interplay ("    motion byte = %d, (x, y) = (%d, %d)\n", B, x, y);
170     return copy_from(s, &s->last_frame, x, y);
171 }
172
173 static int ipvideo_decode_block_opcode_0x5(IpvideoContext *s)
174 {
175     signed char x, y;
176
177     /* copy a block from the previous frame using an expanded range;
178      * need 2 more bytes */
179     CHECK_STREAM_PTR(2);
180
181     x = *s->stream_ptr++;
182     y = *s->stream_ptr++;
183
184     debug_interplay ("    motion bytes = %d, %d\n", x, y);
185     return copy_from(s, &s->last_frame, x, y);
186 }
187
188 static int ipvideo_decode_block_opcode_0x6(IpvideoContext *s)
189 {
190     /* mystery opcode? skip multiple blocks? */
191     av_log(s->avctx, AV_LOG_ERROR, "  Interplay video: Help! Mystery opcode 0x6 seen\n");
192
193     /* report success */
194     return 0;
195 }
196
197 static int ipvideo_decode_block_opcode_0x7(IpvideoContext *s)
198 {
199     int x, y;
200     unsigned char P[2];
201     unsigned int flags;
202
203     /* 2-color encoding */
204     CHECK_STREAM_PTR(2);
205
206     P[0] = *s->stream_ptr++;
207     P[1] = *s->stream_ptr++;
208
209     if (P[0] <= P[1]) {
210
211         /* need 8 more bytes from the stream */
212         CHECK_STREAM_PTR(8);
213
214         for (y = 0; y < 8; y++) {
215             flags = *s->stream_ptr++;
216             for (x = 0x01; x <= 0x80; x <<= 1) {
217                 *s->pixel_ptr++ = P[!!(flags & x)];
218             }
219             s->pixel_ptr += s->line_inc;
220         }
221
222     } else {
223
224         /* need 2 more bytes from the stream */
225         CHECK_STREAM_PTR(2);
226
227         flags = bytestream_get_le16(&s->stream_ptr);
228         for (y = 0; y < 8; y += 2) {
229             for (x = 0; x < 8; x += 2, flags >>= 1) {
230                 s->pixel_ptr[x                ] =
231                 s->pixel_ptr[x + 1            ] =
232                 s->pixel_ptr[x +     s->stride] =
233                 s->pixel_ptr[x + 1 + s->stride] = P[flags & 1];
234             }
235             s->pixel_ptr += s->stride * 2;
236         }
237     }
238
239     /* report success */
240     return 0;
241 }
242
243 static int ipvideo_decode_block_opcode_0x8(IpvideoContext *s)
244 {
245     int x, y;
246     unsigned char P[8];
247     unsigned char B[8];
248     unsigned int flags = 0;
249     unsigned char P0 = 0, P1 = 0;
250     int lower_half = 0;
251
252     /* 2-color encoding for each 4x4 quadrant, or 2-color encoding on
253      * either top and bottom or left and right halves */
254     CHECK_STREAM_PTR(2);
255
256     P[0] = *s->stream_ptr++;
257     P[1] = *s->stream_ptr++;
258
259     if (P[0] <= P[1]) {
260
261         /* need 12 more bytes */
262         CHECK_STREAM_PTR(12);
263         B[0] = *s->stream_ptr++;  B[1] = *s->stream_ptr++;
264         P[2] = *s->stream_ptr++;  P[3] = *s->stream_ptr++;
265         B[2] = *s->stream_ptr++;  B[3] = *s->stream_ptr++;
266         P[4] = *s->stream_ptr++;  P[5] = *s->stream_ptr++;
267         B[4] = *s->stream_ptr++;  B[5] = *s->stream_ptr++;
268         P[6] = *s->stream_ptr++;  P[7] = *s->stream_ptr++;
269         B[6] = *s->stream_ptr++;  B[7] = *s->stream_ptr++;
270
271         for (y = 0; y < 8; y++) {
272
273             /* time to reload flags? */
274             if (y == 0) {
275                 flags =
276                     ((B[0] & 0xF0) <<  4) | ((B[4] & 0xF0) <<  8) |
277                     ((B[0] & 0x0F)      ) | ((B[4] & 0x0F) <<  4) |
278                     ((B[1] & 0xF0) << 20) | ((B[5] & 0xF0) << 24) |
279                     ((B[1] & 0x0F) << 16) | ((B[5] & 0x0F) << 20);
280                 lower_half = 0;  /* still on top half */
281             } else if (y == 4) {
282                 flags =
283                     ((B[2] & 0xF0) <<  4) | ((B[6] & 0xF0) <<  8) |
284                     ((B[2] & 0x0F)      ) | ((B[6] & 0x0F) <<  4) |
285                     ((B[3] & 0xF0) << 20) | ((B[7] & 0xF0) << 24) |
286                     ((B[3] & 0x0F) << 16) | ((B[7] & 0x0F) << 20);
287                 lower_half = 2;
288             }
289
290             for (x = 0; x < 8; x++, flags >>= 1) {
291                 /* get the pixel values ready for this quadrant */
292                 if (x == 0) {
293                     P0 = P[lower_half + 0];
294                     P1 = P[lower_half + 1];
295                 } else if (x == 4) {
296                     P0 = P[lower_half + 4];
297                     P1 = P[lower_half + 5];
298                 }
299
300                 *s->pixel_ptr++ = flags & 1 ? P1 : P0;
301             }
302             s->pixel_ptr += s->line_inc;
303         }
304
305     } else {
306
307         /* need 10 more bytes */
308         CHECK_STREAM_PTR(10);
309
310         if (P[2] <= P[3]) {
311
312             B[0] = *s->stream_ptr++;  B[1] = *s->stream_ptr++;
313             B[2] = *s->stream_ptr++;  B[3] = *s->stream_ptr++;
314             P[2] = *s->stream_ptr++;  P[3] = *s->stream_ptr++;
315             B[4] = *s->stream_ptr++;  B[5] = *s->stream_ptr++;
316             B[6] = *s->stream_ptr++;  B[7] = *s->stream_ptr++;
317
318             /* vertical split; left & right halves are 2-color encoded */
319
320             for (y = 0; y < 8; y++) {
321
322                 /* time to reload flags? */
323                 if (y == 0) {
324                     flags =
325                         ((B[0] & 0xF0) <<  4) | ((B[4] & 0xF0) <<  8) |
326                         ((B[0] & 0x0F)      ) | ((B[4] & 0x0F) <<  4) |
327                         ((B[1] & 0xF0) << 20) | ((B[5] & 0xF0) << 24) |
328                         ((B[1] & 0x0F) << 16) | ((B[5] & 0x0F) << 20);
329                 } else if (y == 4) {
330                     flags =
331                         ((B[2] & 0xF0) <<  4) | ((B[6] & 0xF0) <<  8) |
332                         ((B[2] & 0x0F)      ) | ((B[6] & 0x0F) <<  4) |
333                         ((B[3] & 0xF0) << 20) | ((B[7] & 0xF0) << 24) |
334                         ((B[3] & 0x0F) << 16) | ((B[7] & 0x0F) << 20);
335                 }
336
337                 for (x = 0; x < 8; x++, flags >>= 1) {
338                     /* get the pixel values ready for this half */
339                     if (x == 0) {
340                         P0 = P[0];
341                         P1 = P[1];
342                     } else if (x == 4) {
343                         P0 = P[2];
344                         P1 = P[3];
345                     }
346
347                     *s->pixel_ptr++ = flags & 1 ? P1 : P0;
348                 }
349                 s->pixel_ptr += s->line_inc;
350             }
351
352         } else {
353
354             /* horizontal split; top & bottom halves are 2-color encoded */
355
356             for (y = 0; y < 8; y++) {
357                 int bitmask;
358
359                 if (y == 4) {
360                     P[0] = *s->stream_ptr++;
361                     P[1] = *s->stream_ptr++;
362                 }
363                 flags = *s->stream_ptr++;
364
365                 for (bitmask = 0x01; bitmask <= 0x80; bitmask <<= 1) {
366
367                     *s->pixel_ptr++ = P[!!(flags & bitmask)];
368                 }
369                 s->pixel_ptr += s->line_inc;
370             }
371         }
372     }
373
374     /* report success */
375     return 0;
376 }
377
378 static int ipvideo_decode_block_opcode_0x9(IpvideoContext *s)
379 {
380     int x, y;
381     unsigned char P[4];
382
383     /* 4-color encoding */
384     CHECK_STREAM_PTR(4);
385
386     memcpy(P, s->stream_ptr, 4);
387     s->stream_ptr += 4;
388
389     if ((P[0] <= P[1]) && (P[2] <= P[3])) {
390
391         /* 1 of 4 colors for each pixel, need 16 more bytes */
392         CHECK_STREAM_PTR(16);
393
394         for (y = 0; y < 8; y++) {
395             /* get the next set of 8 2-bit flags */
396             int flags = bytestream_get_le16(&s->stream_ptr);
397             for (x = 0; x < 8; x++, flags >>= 2) {
398                 *s->pixel_ptr++ = P[flags & 0x03];
399             }
400             s->pixel_ptr += s->line_inc;
401         }
402
403     } else if ((P[0] <= P[1]) && (P[2] > P[3])) {
404         uint32_t flags;
405
406         /* 1 of 4 colors for each 2x2 block, need 4 more bytes */
407         CHECK_STREAM_PTR(4);
408
409         flags = bytestream_get_le32(&s->stream_ptr);
410
411         for (y = 0; y < 8; y += 2) {
412             for (x = 0; x < 8; x += 2, flags >>= 2) {
413                 s->pixel_ptr[x                ] =
414                 s->pixel_ptr[x + 1            ] =
415                 s->pixel_ptr[x +     s->stride] =
416                 s->pixel_ptr[x + 1 + s->stride] = P[flags & 0x03];
417             }
418             s->pixel_ptr += s->stride * 2;
419         }
420
421     } else if ((P[0] > P[1]) && (P[2] <= P[3])) {
422         uint64_t flags;
423
424         /* 1 of 4 colors for each 2x1 block, need 8 more bytes */
425         CHECK_STREAM_PTR(8);
426
427         flags = bytestream_get_le64(&s->stream_ptr);
428         for (y = 0; y < 8; y++) {
429             for (x = 0; x < 8; x += 2, flags >>= 2) {
430                 s->pixel_ptr[x    ] =
431                 s->pixel_ptr[x + 1] = P[flags & 0x03];
432             }
433             s->pixel_ptr += s->stride;
434         }
435
436     } else {
437         uint64_t flags;
438
439         /* 1 of 4 colors for each 1x2 block, need 8 more bytes */
440         CHECK_STREAM_PTR(8);
441
442         flags = bytestream_get_le64(&s->stream_ptr);
443         for (y = 0; y < 8; y += 2) {
444             for (x = 0; x < 8; x++, flags >>= 2) {
445                 s->pixel_ptr[x            ] =
446                 s->pixel_ptr[x + s->stride] = P[flags & 0x03];
447             }
448             s->pixel_ptr += s->stride * 2;
449         }
450     }
451
452     /* report success */
453     return 0;
454 }
455
456 static int ipvideo_decode_block_opcode_0xA(IpvideoContext *s)
457 {
458     int x, y;
459     unsigned char P[16];
460     unsigned char B[16];
461     int flags = 0;
462     int index;
463     int split;
464     int lower_half;
465
466     /* 4-color encoding for each 4x4 quadrant, or 4-color encoding on
467      * either top and bottom or left and right halves */
468     CHECK_STREAM_PTR(4);
469
470     memcpy(P, s->stream_ptr, 4);
471     s->stream_ptr += 4;
472
473     if (P[0] <= P[1]) {
474
475         /* 4-color encoding for each quadrant; need 28 more bytes */
476         CHECK_STREAM_PTR(28);
477
478         memcpy(B, s->stream_ptr, 4);
479         s->stream_ptr += 4;
480         for (y = 4; y < 16; y += 4) {
481             memcpy(P + y, s->stream_ptr, 4);
482             s->stream_ptr += 4;
483             memcpy(B + y, s->stream_ptr, 4);
484             s->stream_ptr += 4;
485         }
486
487         for (y = 0; y < 8; y++) {
488
489             lower_half = (y >= 4) ? 4 : 0;
490             flags = (B[y + 8] << 8) | B[y];
491
492             for (x = 0; x < 8; x++, flags >>= 2) {
493                 split = (x >= 4) ? 8 : 0;
494                 index = split + lower_half + (flags & 0x03);
495                 *s->pixel_ptr++ = P[index];
496             }
497
498             s->pixel_ptr += s->line_inc;
499         }
500
501     } else {
502
503         /* 4-color encoding for either left and right or top and bottom
504          * halves; need 20 more bytes */
505         CHECK_STREAM_PTR(20);
506
507         memcpy(B, s->stream_ptr, 8);
508         s->stream_ptr += 8;
509         memcpy(P + 4, s->stream_ptr, 4);
510         s->stream_ptr += 4;
511         memcpy(B + 8, s->stream_ptr, 8);
512         s->stream_ptr += 8;
513
514         if (P[4] <= P[5]) {
515
516             /* block is divided into left and right halves */
517             for (y = 0; y < 8; y++) {
518
519                 flags = (B[y + 8] << 8) | B[y];
520                 split = 0;
521
522                 for (x = 0; x < 8; x++, flags >>= 2) {
523                     if (x == 4)
524                         split = 4;
525                     *s->pixel_ptr++ = P[split + (flags & 0x03)];
526                 }
527
528                 s->pixel_ptr += s->line_inc;
529             }
530
531         } else {
532
533             /* block is divided into top and bottom halves */
534             split = 0;
535             for (y = 0; y < 8; y++) {
536
537                 flags = (B[y * 2 + 1] << 8) | B[y * 2];
538                 if (y == 4)
539                     split = 4;
540
541                 for (x = 0; x < 8; x++, flags >>= 2)
542                     *s->pixel_ptr++ = P[split + (flags & 0x03)];
543
544                 s->pixel_ptr += s->line_inc;
545             }
546         }
547     }
548
549     /* report success */
550     return 0;
551 }
552
553 static int ipvideo_decode_block_opcode_0xB(IpvideoContext *s)
554 {
555     int y;
556
557     /* 64-color encoding (each pixel in block is a different color) */
558     CHECK_STREAM_PTR(64);
559
560     for (y = 0; y < 8; y++) {
561         memcpy(s->pixel_ptr, s->stream_ptr, 8);
562         s->stream_ptr += 8;
563         s->pixel_ptr  += s->stride;
564     }
565
566     /* report success */
567     return 0;
568 }
569
570 static int ipvideo_decode_block_opcode_0xC(IpvideoContext *s)
571 {
572     int x, y;
573
574     /* 16-color block encoding: each 2x2 block is a different color */
575     CHECK_STREAM_PTR(16);
576
577     for (y = 0; y < 8; y += 2) {
578         for (x = 0; x < 8; x += 2) {
579             s->pixel_ptr[x                ] =
580             s->pixel_ptr[x + 1            ] =
581             s->pixel_ptr[x +     s->stride] =
582             s->pixel_ptr[x + 1 + s->stride] = *s->stream_ptr++;
583         }
584         s->pixel_ptr += s->stride * 2;
585     }
586
587     /* report success */
588     return 0;
589 }
590
591 static int ipvideo_decode_block_opcode_0xD(IpvideoContext *s)
592 {
593     int y;
594     unsigned char P[4];
595     unsigned char index = 0;
596
597     /* 4-color block encoding: each 4x4 block is a different color */
598     CHECK_STREAM_PTR(4);
599
600     memcpy(P, s->stream_ptr, 4);
601     s->stream_ptr += 4;
602
603     for (y = 0; y < 8; y++) {
604         if (y < 4)
605             index = 0;
606         else
607             index = 2;
608
609         memset(s->pixel_ptr    , P[index    ], 4);
610         memset(s->pixel_ptr + 4, P[index + 1], 4);
611         s->pixel_ptr += s->stride;
612     }
613
614     /* report success */
615     return 0;
616 }
617
618 static int ipvideo_decode_block_opcode_0xE(IpvideoContext *s)
619 {
620     int y;
621     unsigned char pix;
622
623     /* 1-color encoding: the whole block is 1 solid color */
624     CHECK_STREAM_PTR(1);
625     pix = *s->stream_ptr++;
626
627     for (y = 0; y < 8; y++) {
628         memset(s->pixel_ptr, pix, 8);
629         s->pixel_ptr += s->stride;
630     }
631
632     /* report success */
633     return 0;
634 }
635
636 static int ipvideo_decode_block_opcode_0xF(IpvideoContext *s)
637 {
638     int x, y;
639     unsigned char sample[2];
640
641     /* dithered encoding */
642     CHECK_STREAM_PTR(2);
643     sample[0] = *s->stream_ptr++;
644     sample[1] = *s->stream_ptr++;
645
646     for (y = 0; y < 8; y++) {
647         for (x = 0; x < 8; x += 2) {
648             *s->pixel_ptr++ = sample[  y & 1 ];
649             *s->pixel_ptr++ = sample[!(y & 1)];
650         }
651         s->pixel_ptr += s->line_inc;
652     }
653
654     /* report success */
655     return 0;
656 }
657
658 static int (* const ipvideo_decode_block[])(IpvideoContext *s) = {
659     ipvideo_decode_block_opcode_0x0, ipvideo_decode_block_opcode_0x1,
660     ipvideo_decode_block_opcode_0x2, ipvideo_decode_block_opcode_0x3,
661     ipvideo_decode_block_opcode_0x4, ipvideo_decode_block_opcode_0x5,
662     ipvideo_decode_block_opcode_0x6, ipvideo_decode_block_opcode_0x7,
663     ipvideo_decode_block_opcode_0x8, ipvideo_decode_block_opcode_0x9,
664     ipvideo_decode_block_opcode_0xA, ipvideo_decode_block_opcode_0xB,
665     ipvideo_decode_block_opcode_0xC, ipvideo_decode_block_opcode_0xD,
666     ipvideo_decode_block_opcode_0xE, ipvideo_decode_block_opcode_0xF,
667 };
668
669 static void ipvideo_decode_opcodes(IpvideoContext *s)
670 {
671     int x, y;
672     int index = 0;
673     unsigned char opcode;
674     int ret;
675     int code_counts[16] = {0};
676     static int frame = 0;
677
678     debug_interplay("------------------ frame %d\n", frame);
679     frame++;
680
681     /* this is PAL8, so make the palette available */
682     memcpy(s->current_frame.data[1], s->avctx->palctrl->palette, PALETTE_COUNT * 4);
683
684     s->stride = s->current_frame.linesize[0];
685     s->stream_ptr = s->buf + 14;  /* data starts 14 bytes in */
686     s->stream_end = s->buf + s->size;
687     s->line_inc = s->stride - 8;
688     s->upper_motion_limit_offset = (s->avctx->height - 8) * s->stride
689         + s->avctx->width - 8;
690
691     for (y = 0; y < (s->stride * s->avctx->height); y += s->stride * 8) {
692         for (x = y; x < y + s->avctx->width; x += 8) {
693             /* bottom nibble first, then top nibble (which makes it
694              * hard to use a GetBitcontext) */
695             if (index & 1)
696                 opcode = s->decoding_map[index >> 1] >> 4;
697             else
698                 opcode = s->decoding_map[index >> 1] & 0xF;
699             index++;
700
701             debug_interplay("  block @ (%3d, %3d): encoding 0x%X, data ptr @ %p\n",
702                 x - y, y / s->stride, opcode, s->stream_ptr);
703             code_counts[opcode]++;
704
705             s->pixel_ptr = s->current_frame.data[0] + x;
706             ret = ipvideo_decode_block[opcode](s);
707             if (ret != 0) {
708                 av_log(s->avctx, AV_LOG_ERROR, " Interplay video: decode problem on frame %d, @ block (%d, %d)\n",
709                     frame, x - y, y / s->stride);
710                 return;
711             }
712         }
713     }
714     if (s->stream_end - s->stream_ptr > 1) {
715         av_log(s->avctx, AV_LOG_ERROR, " Interplay video: decode finished with %td bytes left over\n",
716             s->stream_end - s->stream_ptr);
717     }
718 }
719
720 static av_cold int ipvideo_decode_init(AVCodecContext *avctx)
721 {
722     IpvideoContext *s = avctx->priv_data;
723
724     s->avctx = avctx;
725
726     if (s->avctx->palctrl == NULL) {
727         av_log(avctx, AV_LOG_ERROR, " Interplay video: palette expected.\n");
728         return -1;
729     }
730
731     avctx->pix_fmt = PIX_FMT_PAL8;
732     dsputil_init(&s->dsp, avctx);
733
734     /* decoding map contains 4 bits of information per 8x8 block */
735     s->decoding_map_size = avctx->width * avctx->height / (8 * 8 * 2);
736
737     s->current_frame.data[0] = s->last_frame.data[0] =
738     s->second_last_frame.data[0] = NULL;
739
740     return 0;
741 }
742
743 static int ipvideo_decode_frame(AVCodecContext *avctx,
744                                 void *data, int *data_size,
745                                 const uint8_t *buf, int buf_size)
746 {
747     IpvideoContext *s = avctx->priv_data;
748     AVPaletteControl *palette_control = avctx->palctrl;
749
750     /* compressed buffer needs to be large enough to at least hold an entire
751      * decoding map */
752     if (buf_size < s->decoding_map_size)
753         return buf_size;
754
755     s->decoding_map = buf;
756     s->buf = buf + s->decoding_map_size;
757     s->size = buf_size - s->decoding_map_size;
758
759     s->current_frame.reference = 3;
760     if (avctx->get_buffer(avctx, &s->current_frame)) {
761         av_log(avctx, AV_LOG_ERROR, "  Interplay Video: get_buffer() failed\n");
762         return -1;
763     }
764
765     ipvideo_decode_opcodes(s);
766
767     if (palette_control->palette_changed) {
768         palette_control->palette_changed = 0;
769         s->current_frame.palette_has_changed = 1;
770     }
771
772     *data_size = sizeof(AVFrame);
773     *(AVFrame*)data = s->current_frame;
774
775     /* shuffle frames */
776     if (s->second_last_frame.data[0])
777         avctx->release_buffer(avctx, &s->second_last_frame);
778     s->second_last_frame = s->last_frame;
779     s->last_frame = s->current_frame;
780     s->current_frame.data[0] = NULL;  /* catch any access attempts */
781
782     /* report that the buffer was completely consumed */
783     return buf_size;
784 }
785
786 static av_cold int ipvideo_decode_end(AVCodecContext *avctx)
787 {
788     IpvideoContext *s = avctx->priv_data;
789
790     /* release the last frame */
791     if (s->last_frame.data[0])
792         avctx->release_buffer(avctx, &s->last_frame);
793     if (s->second_last_frame.data[0])
794         avctx->release_buffer(avctx, &s->second_last_frame);
795
796     return 0;
797 }
798
799 AVCodec interplay_video_decoder = {
800     "interplayvideo",
801     CODEC_TYPE_VIDEO,
802     CODEC_ID_INTERPLAY_VIDEO,
803     sizeof(IpvideoContext),
804     ipvideo_decode_init,
805     NULL,
806     ipvideo_decode_end,
807     ipvideo_decode_frame,
808     CODEC_CAP_DR1,
809     .long_name = NULL_IF_CONFIG_SMALL("Interplay MVE video"),
810 };