qtrleenc.c 13.9 KB
Newer Older
Alexis Ballier's avatar
Alexis Ballier committed
1 2 3 4 5
/*
 * Quicktime Animation (RLE) Video Encoder
 * Copyright (C) 2007 Clemens Fruhwirth
 * Copyright (C) 2007 Alexis Ballier
 *
6
 * This file is based on flashsvenc.c.
Alexis Ballier's avatar
Alexis Ballier committed
7
 *
8
 * This file is part of FFmpeg.
Alexis Ballier's avatar
Alexis Ballier committed
9 10 11
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
12 13
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
Alexis Ballier's avatar
Alexis Ballier committed
14 15 16 17 18 19 20 21 22 23 24
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

25
#include "libavutil/imgutils.h"
Alexis Ballier's avatar
Alexis Ballier committed
26 27
#include "avcodec.h"
#include "bytestream.h"
28
#include "internal.h"
Alexis Ballier's avatar
Alexis Ballier committed
29 30 31 32 33 34 35 36 37 38 39 40 41

/** Maximum RLE code for bulk copy */
#define MAX_RLE_BULK   127
/** Maximum RLE code for repeat */
#define MAX_RLE_REPEAT 128
/** Maximum RLE code for skip */
#define MAX_RLE_SKIP   254

typedef struct QtrleEncContext {
    AVCodecContext *avctx;
    int pixel_size;
    AVPicture previous_frame;
    unsigned int max_buf_size;
42
    int logical_width;
Alexis Ballier's avatar
Alexis Ballier committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
    /**
     * This array will contain at ith position the value of the best RLE code
     * if the line started at pixel i
     * There can be 3 values :
     * skip (0)     : skip as much as possible pixels because they are equal to the
     *                previous frame ones
     * repeat (<-1) : repeat that pixel -rle_code times, still as much as
     *                possible
     * copy (>0)    : copy the raw next rle_code pixels */
    signed char *rlecode_table;
    /**
     * This array will contain the length of the best rle encoding of the line
     * starting at ith pixel */
    int *length_table;
    /**
     * Will contain at ith position the number of consecutive pixels equal to the previous
     * frame starting from pixel i */
    uint8_t* skip_table;
} QtrleEncContext;

63 64 65 66 67 68 69 70 71 72 73 74 75
static av_cold int qtrle_encode_end(AVCodecContext *avctx)
{
    QtrleEncContext *s = avctx->priv_data;

    av_frame_free(&avctx->coded_frame);

    avpicture_free(&s->previous_frame);
    av_free(s->rlecode_table);
    av_free(s->length_table);
    av_free(s->skip_table);
    return 0;
}

76
static av_cold int qtrle_encode_init(AVCodecContext *avctx)
Alexis Ballier's avatar
Alexis Ballier committed
77 78
{
    QtrleEncContext *s = avctx->priv_data;
79
    int ret;
Alexis Ballier's avatar
Alexis Ballier committed
80

81
    if (av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
82
        return AVERROR(EINVAL);
Alexis Ballier's avatar
Alexis Ballier committed
83 84
    }
    s->avctx=avctx;
85
    s->logical_width=avctx->width;
Alexis Ballier's avatar
Alexis Ballier committed
86 87

    switch (avctx->pix_fmt) {
88
    case AV_PIX_FMT_GRAY8:
89 90 91
        s->logical_width = avctx->width / 4;
        s->pixel_size = 4;
        break;
92
    case AV_PIX_FMT_RGB555BE:
Alexis Ballier's avatar
Alexis Ballier committed
93
        s->pixel_size = 2;
94
        break;
95
    case AV_PIX_FMT_RGB24:
Alexis Ballier's avatar
Alexis Ballier committed
96 97
        s->pixel_size = 3;
        break;
98
    case AV_PIX_FMT_ARGB:
99 100
        s->pixel_size = 4;
        break;
Alexis Ballier's avatar
Alexis Ballier committed
101 102 103 104
    default:
        av_log(avctx, AV_LOG_ERROR, "Unsupported colorspace.\n");
        break;
    }
105
    avctx->bits_per_coded_sample = avctx->pix_fmt == AV_PIX_FMT_GRAY8 ? 40 : s->pixel_size*8;
Alexis Ballier's avatar
Alexis Ballier committed
106

107 108 109
    s->rlecode_table = av_mallocz(s->logical_width);
    s->skip_table    = av_mallocz(s->logical_width);
    s->length_table  = av_mallocz((s->logical_width + 1)*sizeof(int));
Alexis Ballier's avatar
Alexis Ballier committed
110 111
    if (!s->skip_table || !s->length_table || !s->rlecode_table) {
        av_log(avctx, AV_LOG_ERROR, "Error allocating memory.\n");
112
        return AVERROR(ENOMEM);
Alexis Ballier's avatar
Alexis Ballier committed
113
    }
114
    if ((ret = avpicture_alloc(&s->previous_frame, avctx->pix_fmt, avctx->width, avctx->height)) < 0) {
Alexis Ballier's avatar
Alexis Ballier committed
115
        av_log(avctx, AV_LOG_ERROR, "Error allocating picture\n");
116
        return ret;
Alexis Ballier's avatar
Alexis Ballier committed
117 118
    }

119
    s->max_buf_size = s->logical_width*s->avctx->height*s->pixel_size*2 /* image base material */
120 121 122
                      + 15                                            /* header + footer */
                      + s->avctx->height*2                            /* skip code+rle end */
                      + s->logical_width/MAX_RLE_BULK + 1             /* rle codes */;
123 124 125 126 127 128 129

    avctx->coded_frame = av_frame_alloc();
    if (!avctx->coded_frame) {
        qtrle_encode_end(avctx);
        return AVERROR(ENOMEM);
    }

Alexis Ballier's avatar
Alexis Ballier committed
130 131 132 133
    return 0;
}

/**
134
 * Compute the best RLE sequence for a line
Alexis Ballier's avatar
Alexis Ballier committed
135
 */
136
static void qtrle_encode_line(QtrleEncContext *s, const AVFrame *p, int line, uint8_t **buf)
Alexis Ballier's avatar
Alexis Ballier committed
137
{
138
    int width=s->logical_width;
Alexis Ballier's avatar
Alexis Ballier committed
139 140 141 142 143 144 145 146
    int i;
    signed char rlecode;

    /* This will be the number of pixels equal to the preivous frame one's
     * starting from the ith pixel */
    unsigned int skipcount;
    /* This will be the number of consecutive equal pixels in the current
     * frame, starting from the ith one also */
147
    unsigned int av_uninit(repeatcount);
Alexis Ballier's avatar
Alexis Ballier committed
148 149 150 151 152

    /* The cost of the three different possibilities */
    int total_skip_cost;
    int total_repeat_cost;

153 154 155 156 157
    int base_bulk_cost;
    int lowest_bulk_cost;
    int lowest_bulk_cost_index;
    int sec_lowest_bulk_cost;
    int sec_lowest_bulk_cost_index;
Alexis Ballier's avatar
Alexis Ballier committed
158

159 160 161 162
    uint8_t *this_line = p->               data[0] + line*p->               linesize[0] +
        (width - 1)*s->pixel_size;
    uint8_t *prev_line = s->previous_frame.data[0] + line*s->previous_frame.linesize[0] +
        (width - 1)*s->pixel_size;
Alexis Ballier's avatar
Alexis Ballier committed
163 164 165 166

    s->length_table[width] = 0;
    skipcount = 0;

167 168 169 170 171 172 173 174
    /* Initial values */
    lowest_bulk_cost = INT_MAX / 2;
    lowest_bulk_cost_index = width;
    sec_lowest_bulk_cost = INT_MAX / 2;
    sec_lowest_bulk_cost_index = width;

    base_bulk_cost = 1 + s->pixel_size;

Alexis Ballier's avatar
Alexis Ballier committed
175 176
    for (i = width - 1; i >= 0; i--) {

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
        int prev_bulk_cost;

        /* If our lowest bulk cost index is too far away, replace it
         * with the next lowest bulk cost */
        if (FFMIN(width, i + MAX_RLE_BULK) < lowest_bulk_cost_index) {
            lowest_bulk_cost = sec_lowest_bulk_cost;
            lowest_bulk_cost_index = sec_lowest_bulk_cost_index;

            sec_lowest_bulk_cost = INT_MAX / 2;
            sec_lowest_bulk_cost_index = width;
        }

        /* Deal with the first pixel's bulk cost */
        if (!i) {
            base_bulk_cost++;
            lowest_bulk_cost++;
            sec_lowest_bulk_cost++;
        }

        /* Look at the bulk cost of the previous loop and see if it is
         * a new lower bulk cost */
        prev_bulk_cost = s->length_table[i + 1] + base_bulk_cost;
        if (prev_bulk_cost <= sec_lowest_bulk_cost) {
            /* If it's lower than the 2nd lowest, then it may be lower
             * than the lowest */
            if (prev_bulk_cost <= lowest_bulk_cost) {

                /* If we have found a new lowest bulk cost,
                 * then the 2nd lowest bulk cost is now farther than the
                 * lowest bulk cost, and will never be used */
                sec_lowest_bulk_cost = INT_MAX / 2;

                lowest_bulk_cost = prev_bulk_cost;
                lowest_bulk_cost_index = i + 1;
            } else {
                /* Then it must be the 2nd lowest bulk cost */
                sec_lowest_bulk_cost = prev_bulk_cost;
                sec_lowest_bulk_cost_index = i + 1;
            }
        }

218
        if (!s->avctx->coded_frame->key_frame && !memcmp(this_line, prev_line, s->pixel_size))
Alexis Ballier's avatar
Alexis Ballier committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
            skipcount = FFMIN(skipcount + 1, MAX_RLE_SKIP);
        else
            skipcount = 0;

        total_skip_cost  = s->length_table[i + skipcount] + 2;
        s->skip_table[i] = skipcount;


        if (i < width - 1 && !memcmp(this_line, this_line + s->pixel_size, s->pixel_size))
            repeatcount = FFMIN(repeatcount + 1, MAX_RLE_REPEAT);
        else
            repeatcount = 1;

        total_repeat_cost = s->length_table[i + repeatcount] + 1 + s->pixel_size;

        /* skip code is free for the first pixel, it costs one byte for repeat and bulk copy
         * so let's make it aware */
        if (i == 0) {
            total_skip_cost--;
            total_repeat_cost++;
        }

        if (repeatcount > 1 && (skipcount == 0 || total_repeat_cost < total_skip_cost)) {
            /* repeat is the best */
            s->length_table[i]  = total_repeat_cost;
            s->rlecode_table[i] = -repeatcount;
        }
        else if (skipcount > 0) {
            /* skip is the best choice here */
            s->length_table[i]  = total_skip_cost;
            s->rlecode_table[i] = 0;
        }
        else {
            /* We cannot do neither skip nor repeat
253
             * thus we use the best bulk copy  */
Alexis Ballier's avatar
Alexis Ballier committed
254

255 256
            s->length_table[i]  = lowest_bulk_cost;
            s->rlecode_table[i] = lowest_bulk_cost_index - i;
Alexis Ballier's avatar
Alexis Ballier committed
257 258 259

        }

260 261 262 263
        /* These bulk costs increase every iteration */
        lowest_bulk_cost += s->pixel_size;
        sec_lowest_bulk_cost += s->pixel_size;

Alexis Ballier's avatar
Alexis Ballier committed
264 265 266 267
        this_line -= s->pixel_size;
        prev_line -= s->pixel_size;
    }

268
    /* Good ! Now we have the best sequence for this line, let's output it */
Alexis Ballier's avatar
Alexis Ballier committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

    /* We do a special case for the first pixel so that we avoid testing it in
     * the whole loop */

    i=0;
    this_line = p->               data[0] + line*p->linesize[0];

    if (s->rlecode_table[0] == 0) {
        bytestream_put_byte(buf, s->skip_table[0] + 1);
        i += s->skip_table[0];
    }
    else bytestream_put_byte(buf, 1);


    while (i < width) {
        rlecode = s->rlecode_table[i];
        bytestream_put_byte(buf, rlecode);
        if (rlecode == 0) {
            /* Write a skip sequence */
            bytestream_put_byte(buf, s->skip_table[i] + 1);
            i += s->skip_table[i];
        }
        else if (rlecode > 0) {
            /* bulk copy */
293
            if (s->avctx->pix_fmt == AV_PIX_FMT_GRAY8) {
294
                int j;
295 296
                // QT grayscale colorspace has 0=white and 255=black, we will
                // ignore the palette that is included in the AVFrame because
297
                // AV_PIX_FMT_GRAY8 has defined color mapping
298
                for (j = 0; j < rlecode*s->pixel_size; ++j)
299 300 301 302
                    bytestream_put_byte(buf, *(this_line + i*s->pixel_size + j) ^ 0xff);
            } else {
                bytestream_put_buffer(buf, this_line + i*s->pixel_size, rlecode*s->pixel_size);
            }
Alexis Ballier's avatar
Alexis Ballier committed
303 304 305 306
            i += rlecode;
        }
        else {
            /* repeat the bits */
307
            if (s->avctx->pix_fmt == AV_PIX_FMT_GRAY8) {
308
                int j;
309
                // QT grayscale colorspace has 0=white and 255=black, ...
310
                for (j = 0; j < s->pixel_size; ++j)
311 312 313 314
                    bytestream_put_byte(buf, *(this_line + i*s->pixel_size + j) ^ 0xff);
            } else {
                bytestream_put_buffer(buf, this_line + i*s->pixel_size, s->pixel_size);
            }
Alexis Ballier's avatar
Alexis Ballier committed
315 316 317 318 319 320
            i -= rlecode;
        }
    }
    bytestream_put_byte(buf, -1); // end RLE line
}

321
/** Encode frame including header */
322
static int encode_frame(QtrleEncContext *s, const AVFrame *p, uint8_t *buf)
Alexis Ballier's avatar
Alexis Ballier committed
323 324 325 326 327 328
{
    int i;
    int start_line = 0;
    int end_line = s->avctx->height;
    uint8_t *orig_buf = buf;

329
    if (!s->avctx->coded_frame->key_frame) {
330
        unsigned line_size = s->logical_width * s->pixel_size;
Alexis Ballier's avatar
Alexis Ballier committed
331 332
        for (start_line = 0; start_line < s->avctx->height; start_line++)
            if (memcmp(p->data[0] + start_line*p->linesize[0],
333 334
                       s->previous_frame.data[0] + start_line*s->previous_frame.linesize[0],
                       line_size))
Alexis Ballier's avatar
Alexis Ballier committed
335 336 337 338
                break;

        for (end_line=s->avctx->height; end_line > start_line; end_line--)
            if (memcmp(p->data[0] + (end_line - 1)*p->linesize[0],
339 340
                       s->previous_frame.data[0] + (end_line - 1)*s->previous_frame.linesize[0],
                       line_size))
Alexis Ballier's avatar
Alexis Ballier committed
341 342 343 344 345
                break;
    }

    bytestream_put_be32(&buf, 0);                         // CHUNK SIZE, patched later

346
    if ((start_line == 0 && end_line == s->avctx->height) || start_line == s->avctx->height)
Alexis Ballier's avatar
Alexis Ballier committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
        bytestream_put_be16(&buf, 0);                     // header
    else {
        bytestream_put_be16(&buf, 8);                     // header
        bytestream_put_be16(&buf, start_line);            // starting line
        bytestream_put_be16(&buf, 0);                     // unknown
        bytestream_put_be16(&buf, end_line - start_line); // lines to update
        bytestream_put_be16(&buf, 0);                     // unknown
    }
    for (i = start_line; i < end_line; i++)
        qtrle_encode_line(s, p, i, &buf);

    bytestream_put_byte(&buf, 0);                         // zero skip code = frame finished
    AV_WB32(orig_buf, buf - orig_buf);                    // patch the chunk size
    return buf - orig_buf;
}

363 364
static int qtrle_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
                              const AVFrame *pict, int *got_packet)
Alexis Ballier's avatar
Alexis Ballier committed
365 366
{
    QtrleEncContext * const s = avctx->priv_data;
367
    AVFrame * const p = avctx->coded_frame;
368
    int ret;
Alexis Ballier's avatar
Alexis Ballier committed
369

370
    if ((ret = ff_alloc_packet2(avctx, pkt, s->max_buf_size)) < 0)
371
        return ret;
Alexis Ballier's avatar
Alexis Ballier committed
372 373 374

    if (avctx->gop_size == 0 || (s->avctx->frame_number % avctx->gop_size) == 0) {
        /* I-Frame */
375
        p->pict_type = AV_PICTURE_TYPE_I;
Alexis Ballier's avatar
Alexis Ballier committed
376 377 378
        p->key_frame = 1;
    } else {
        /* P-Frame */
379
        p->pict_type = AV_PICTURE_TYPE_P;
Alexis Ballier's avatar
Alexis Ballier committed
380 381 382
        p->key_frame = 0;
    }

383
    pkt->size = encode_frame(s, pict, pkt->data);
Alexis Ballier's avatar
Alexis Ballier committed
384 385

    /* save the current frame */
386 387
    av_picture_copy(&s->previous_frame, (const AVPicture *)pict,
                    avctx->pix_fmt, avctx->width, avctx->height);
388 389 390 391 392 393

    if (p->key_frame)
        pkt->flags |= AV_PKT_FLAG_KEY;
    *got_packet = 1;

    return 0;
Alexis Ballier's avatar
Alexis Ballier committed
394 395
}

396
AVCodec ff_qtrle_encoder = {
397
    .name           = "qtrle",
398
    .long_name      = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
399
    .type           = AVMEDIA_TYPE_VIDEO,
400
    .id             = AV_CODEC_ID_QTRLE,
401 402
    .priv_data_size = sizeof(QtrleEncContext),
    .init           = qtrle_encode_init,
403
    .encode2        = qtrle_encode_frame,
404
    .close          = qtrle_encode_end,
405
    .pix_fmts       = (const enum AVPixelFormat[]){
406
        AV_PIX_FMT_RGB24, AV_PIX_FMT_RGB555BE, AV_PIX_FMT_ARGB, AV_PIX_FMT_GRAY8, AV_PIX_FMT_NONE
407
    },
Alexis Ballier's avatar
Alexis Ballier committed
408
};