git.sesse.net Git - ffmpeg/blob - libavcodec/qtrleenc.c

   1 /*
   2  * Quicktime Animation (RLE) Video Encoder
   3  * Copyright (C) 2007 Clemens Fruhwirth
   4  * Copyright (C) 2007 Alexis Ballier
   5  *
   6  * This file is based on flashsvenc.c.
   7  *
   8  * This file is part of FFmpeg.
   9  *
  10  * FFmpeg is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * FFmpeg is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with FFmpeg; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23  */
  24
  25 #include "libavutil/imgutils.h"
  26 #include "avcodec.h"
  27 #include "bytestream.h"
  28
  29 /** Maximum RLE code for bulk copy */
  30 #define MAX_RLE_BULK   127
  31 /** Maximum RLE code for repeat */
  32 #define MAX_RLE_REPEAT 128
  33 /** Maximum RLE code for skip */
  34 #define MAX_RLE_SKIP   254
  35
  36 typedef struct QtrleEncContext {
  37     AVCodecContext *avctx;
  38     AVFrame frame;
  39     int pixel_size;
  40     AVPicture previous_frame;
  41     unsigned int max_buf_size;
  42     int logical_width;
  43     /**
  44      * This array will contain at ith position the value of the best RLE code
  45      * if the line started at pixel i
  46      * There can be 3 values :
  47      * skip (0)     : skip as much as possible pixels because they are equal to the
  48      *                previous frame ones
  49      * repeat (<-1) : repeat that pixel -rle_code times, still as much as
  50      *                possible
  51      * copy (>0)    : copy the raw next rle_code pixels */
  52     signed char *rlecode_table;
  53     /**
  54      * This array will contain the length of the best rle encoding of the line
  55      * starting at ith pixel */
  56     int *length_table;
  57     /**
  58      * Will contain at ith position the number of consecutive pixels equal to the previous
  59      * frame starting from pixel i */
  60     uint8_t* skip_table;
  61 } QtrleEncContext;
  62
  63 static av_cold int qtrle_encode_init(AVCodecContext *avctx)
  64 {
  65     QtrleEncContext *s = avctx->priv_data;
  66
  67     if (av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
  68         return -1;
  69     }
  70     s->avctx=avctx;
  71     s->logical_width=avctx->width;
  72
  73     switch (avctx->pix_fmt) {
  74     case PIX_FMT_GRAY8:
  75         s->logical_width = avctx->width / 4;
  76         s->pixel_size = 4;
  77         break;
  78     case PIX_FMT_RGB555BE:
  79         s->pixel_size = 2;
  80         break;
  81     case PIX_FMT_RGB24:
  82         s->pixel_size = 3;
  83         break;
  84     case PIX_FMT_ARGB:
  85         s->pixel_size = 4;
  86         break;
  87     default:
  88         av_log(avctx, AV_LOG_ERROR, "Unsupported colorspace.\n");
  89         break;
  90     }
  91     avctx->bits_per_coded_sample = avctx->pix_fmt == PIX_FMT_GRAY8 ? 40 : s->pixel_size*8;
  92
  93     s->rlecode_table = av_mallocz(s->logical_width);
  94     s->skip_table    = av_mallocz(s->logical_width);
  95     s->length_table  = av_mallocz((s->logical_width + 1)*sizeof(int));
  96     if (!s->skip_table || !s->length_table || !s->rlecode_table) {
  97         av_log(avctx, AV_LOG_ERROR, "Error allocating memory.\n");
  98         return -1;
  99     }
 100     if (avpicture_alloc(&s->previous_frame, avctx->pix_fmt, avctx->width, avctx->height) < 0) {
 101         av_log(avctx, AV_LOG_ERROR, "Error allocating picture\n");
 102         return -1;
 103     }
 104
 105     s->max_buf_size = s->logical_width*s->avctx->height*s->pixel_size /* image base material */
 106                       + 15                                            /* header + footer */
 107                       + s->avctx->height*2                            /* skip code+rle end */
 108                       + s->logical_width/MAX_RLE_BULK + 1             /* rle codes */;
 109     avctx->coded_frame = &s->frame;
 110     return 0;
 111 }
 112
 113 /**
 114  * Compute the best RLE sequence for a line
 115  */
 116 static void qtrle_encode_line(QtrleEncContext *s, AVFrame *p, int line, uint8_t **buf)
 117 {
 118     int width=s->logical_width;
 119     int i;
 120     signed char rlecode;
 121
 122     /* We will use it to compute the best bulk copy sequence */
 123     unsigned int bulkcount;
 124     /* This will be the number of pixels equal to the preivous frame one's
 125      * starting from the ith pixel */
 126     unsigned int skipcount;
 127     /* This will be the number of consecutive equal pixels in the current
 128      * frame, starting from the ith one also */
 129     unsigned int av_uninit(repeatcount);
 130
 131     /* The cost of the three different possibilities */
 132     int total_bulk_cost;
 133     int total_skip_cost;
 134     int total_repeat_cost;
 135
 136     int temp_cost;
 137     int j;
 138
 139     uint8_t *this_line = p->               data[0] + line*p->               linesize[0] +
 140         (width - 1)*s->pixel_size;
 141     uint8_t *prev_line = s->previous_frame.data[0] + line*s->previous_frame.linesize[0] +
 142         (width - 1)*s->pixel_size;
 143
 144     s->length_table[width] = 0;
 145     skipcount = 0;
 146
 147     for (i = width - 1; i >= 0; i--) {
 148
 149         if (!s->frame.key_frame && !memcmp(this_line, prev_line, s->pixel_size))
 150             skipcount = FFMIN(skipcount + 1, MAX_RLE_SKIP);
 151         else
 152             skipcount = 0;
 153
 154         total_skip_cost  = s->length_table[i + skipcount] + 2;
 155         s->skip_table[i] = skipcount;
 156
 157
 158         if (i < width - 1 && !memcmp(this_line, this_line + s->pixel_size, s->pixel_size))
 159             repeatcount = FFMIN(repeatcount + 1, MAX_RLE_REPEAT);
 160         else
 161             repeatcount = 1;
 162
 163         total_repeat_cost = s->length_table[i + repeatcount] + 1 + s->pixel_size;
 164
 165         /* skip code is free for the first pixel, it costs one byte for repeat and bulk copy
 166          * so let's make it aware */
 167         if (i == 0) {
 168             total_skip_cost--;
 169             total_repeat_cost++;
 170         }
 171
 172         if (repeatcount > 1 && (skipcount == 0 || total_repeat_cost < total_skip_cost)) {
 173             /* repeat is the best */
 174             s->length_table[i]  = total_repeat_cost;
 175             s->rlecode_table[i] = -repeatcount;
 176         }
 177         else if (skipcount > 0) {
 178             /* skip is the best choice here */
 179             s->length_table[i]  = total_skip_cost;
 180             s->rlecode_table[i] = 0;
 181         }
 182         else {
 183             /* We cannot do neither skip nor repeat
 184              * thus we search for the best bulk copy to do */
 185
 186             int limit = FFMIN(width - i, MAX_RLE_BULK);
 187
 188             temp_cost = 1 + s->pixel_size + !i;
 189             total_bulk_cost = INT_MAX;
 190
 191             for (j = 1; j <= limit; j++) {
 192                 if (s->length_table[i + j] + temp_cost < total_bulk_cost) {
 193                     /* We have found a better bulk copy ... */
 194                     total_bulk_cost = s->length_table[i + j] + temp_cost;
 195                     bulkcount = j;
 196                 }
 197                 temp_cost += s->pixel_size;
 198             }
 199
 200             s->length_table[i]  = total_bulk_cost;
 201             s->rlecode_table[i] = bulkcount;
 202         }
 203
 204         this_line -= s->pixel_size;
 205         prev_line -= s->pixel_size;
 206     }
 207
 208     /* Good ! Now we have the best sequence for this line, let's ouput it */
 209
 210     /* We do a special case for the first pixel so that we avoid testing it in
 211      * the whole loop */
 212
 213     i=0;
 214     this_line = p->               data[0] + line*p->linesize[0];
 215
 216     if (s->rlecode_table[0] == 0) {
 217         bytestream_put_byte(buf, s->skip_table[0] + 1);
 218         i += s->skip_table[0];
 219     }
 220     else bytestream_put_byte(buf, 1);
 221
 222
 223     while (i < width) {
 224         rlecode = s->rlecode_table[i];
 225         bytestream_put_byte(buf, rlecode);
 226         if (rlecode == 0) {
 227             /* Write a skip sequence */
 228             bytestream_put_byte(buf, s->skip_table[i] + 1);
 229             i += s->skip_table[i];
 230         }
 231         else if (rlecode > 0) {
 232             /* bulk copy */
 233             if (s->avctx->pix_fmt == PIX_FMT_GRAY8) {
 234                 // QT grayscale colorspace has 0=white and 255=black, we will
 235                 // ignore the palette that is included in the AVFrame because
 236                 // PIX_FMT_GRAY8 has defined color mapping
 237                 for (int j = 0; j < rlecode*s->pixel_size; ++j)
 238                     bytestream_put_byte(buf, *(this_line + i*s->pixel_size + j) ^ 0xff);
 239             } else {
 240                 bytestream_put_buffer(buf, this_line + i*s->pixel_size, rlecode*s->pixel_size);
 241             }
 242             i += rlecode;
 243         }
 244         else {
 245             /* repeat the bits */
 246             if (s->avctx->pix_fmt == PIX_FMT_GRAY8) {
 247                 // QT grayscale colorspace has 0=white and 255=black, ...
 248                 for (int j = 0; j < s->pixel_size; ++j)
 249                     bytestream_put_byte(buf, *(this_line + i*s->pixel_size + j) ^ 0xff);
 250             } else {
 251                 bytestream_put_buffer(buf, this_line + i*s->pixel_size, s->pixel_size);
 252             }
 253             i -= rlecode;
 254         }
 255     }
 256     bytestream_put_byte(buf, -1); // end RLE line
 257 }
 258
 259 /** Encode frame including header */
 260 static int encode_frame(QtrleEncContext *s, AVFrame *p, uint8_t *buf)
 261 {
 262     int i;
 263     int start_line = 0;
 264     int end_line = s->avctx->height;
 265     uint8_t *orig_buf = buf;
 266
 267     if (!s->frame.key_frame) {
 268         unsigned line_size = s->logical_width * s->pixel_size;
 269         for (start_line = 0; start_line < s->avctx->height; start_line++)
 270             if (memcmp(p->data[0] + start_line*p->linesize[0],
 271                        s->previous_frame.data[0] + start_line*s->previous_frame.linesize[0],
 272                        line_size))
 273                 break;
 274
 275         for (end_line=s->avctx->height; end_line > start_line; end_line--)
 276             if (memcmp(p->data[0] + (end_line - 1)*p->linesize[0],
 277                        s->previous_frame.data[0] + (end_line - 1)*s->previous_frame.linesize[0],
 278                        line_size))
 279                 break;
 280     }
 281
 282     bytestream_put_be32(&buf, 0);                         // CHUNK SIZE, patched later
 283
 284     if ((start_line == 0 && end_line == s->avctx->height) || start_line == s->avctx->height)
 285         bytestream_put_be16(&buf, 0);                     // header
 286     else {
 287         bytestream_put_be16(&buf, 8);                     // header
 288         bytestream_put_be16(&buf, start_line);            // starting line
 289         bytestream_put_be16(&buf, 0);                     // unknown
 290         bytestream_put_be16(&buf, end_line - start_line); // lines to update
 291         bytestream_put_be16(&buf, 0);                     // unknown
 292     }
 293     for (i = start_line; i < end_line; i++)
 294         qtrle_encode_line(s, p, i, &buf);
 295
 296     bytestream_put_byte(&buf, 0);                         // zero skip code = frame finished
 297     AV_WB32(orig_buf, buf - orig_buf);                    // patch the chunk size
 298     return buf - orig_buf;
 299 }
 300
 301 static int qtrle_encode_frame(AVCodecContext *avctx, uint8_t *buf, int buf_size, void *data)
 302 {
 303     QtrleEncContext * const s = avctx->priv_data;
 304     AVFrame *pict = data;
 305     AVFrame * const p = &s->frame;
 306     int chunksize;
 307
 308     *p = *pict;
 309
 310     if (buf_size < s->max_buf_size) {
 311         /* Upper bound check for compressed data */
 312         av_log(avctx, AV_LOG_ERROR, "buf_size %d <  %d\n", buf_size, s->max_buf_size);
 313         return -1;
 314     }
 315
 316     if (avctx->gop_size == 0 || (s->avctx->frame_number % avctx->gop_size) == 0) {
 317         /* I-Frame */
 318         p->pict_type = AV_PICTURE_TYPE_I;
 319         p->key_frame = 1;
 320     } else {
 321         /* P-Frame */
 322         p->pict_type = AV_PICTURE_TYPE_P;
 323         p->key_frame = 0;
 324     }
 325
 326     chunksize = encode_frame(s, pict, buf);
 327
 328     /* save the current frame */
 329     av_picture_copy(&s->previous_frame, (AVPicture *)p, avctx->pix_fmt, avctx->width, avctx->height);
 330     return chunksize;
 331 }
 332
 333 static av_cold int qtrle_encode_end(AVCodecContext *avctx)
 334 {
 335     QtrleEncContext *s = avctx->priv_data;
 336
 337     avpicture_free(&s->previous_frame);
 338     av_free(s->rlecode_table);
 339     av_free(s->length_table);
 340     av_free(s->skip_table);
 341     return 0;
 342 }
 343
 344 AVCodec ff_qtrle_encoder = {
 345     "qtrle",
 346     AVMEDIA_TYPE_VIDEO,
 347     CODEC_ID_QTRLE,
 348     sizeof(QtrleEncContext),
 349     qtrle_encode_init,
 350     qtrle_encode_frame,
 351     qtrle_encode_end,
 352     .pix_fmts = (const enum PixelFormat[]){PIX_FMT_RGB24, PIX_FMT_RGB555BE, PIX_FMT_ARGB, PIX_FMT_GRAY8, PIX_FMT_NONE},
 353     .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
 354 };