libavcodec/vp9_superframe_bsf.c
2e6636aa
 /*
  * Vp9 invisible (alt-ref) frame to superframe merge bitstream filter
  * Copyright (c) 2016 Ronald S. Bultje <rsbultje@gmail.com>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * 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
  */
 
 #include "libavutil/avassert.h"
 #include "avcodec.h"
af9cac1b
 #include "bsf.h"
2e6636aa
 #include "get_bits.h"
 
 #define MAX_CACHE 8
 typedef struct VP9BSFContext {
     int n_cache;
3fb6b98b
     AVPacket *cache[MAX_CACHE];
2e6636aa
 } VP9BSFContext;
 
3fb6b98b
 static void stats(AVPacket * const *in, int n_in,
2e6636aa
                   unsigned *_max, unsigned *_sum)
 {
     int n;
     unsigned max = 0, sum = 0;
 
     for (n = 0; n < n_in; n++) {
3fb6b98b
         unsigned sz = in[n]->size;
2e6636aa
 
         if (sz > max)
             max = sz;
         sum += sz;
     }
 
     *_max = max;
     *_sum = sum;
 }
 
3fb6b98b
 static int merge_superframe(AVPacket * const *in, int n_in, AVPacket *out)
2e6636aa
 {
     unsigned max, sum, mag, marker, n, sz;
     uint8_t *ptr;
af9cac1b
     int res;
2e6636aa
 
     stats(in, n_in, &max, &sum);
     mag = av_log2(max) >> 3;
     marker = 0xC0 + (mag << 3) + (n_in - 1);
af9cac1b
     sz = sum + 2 + (mag + 1) * n_in;
     res = av_new_packet(out, sz);
     if (res < 0)
         return res;
     ptr = out->data;
2e6636aa
     for (n = 0; n < n_in; n++) {
3fb6b98b
         memcpy(ptr, in[n]->data, in[n]->size);
         ptr += in[n]->size;
2e6636aa
     }
 
 #define wloop(mag, wr) \
4c0426c4
     do { \
0cf949a0
         for (n = 0; n < n_in; n++) { \
             wr; \
             ptr += mag + 1; \
         } \
     } while (0)
2e6636aa
 
     // write superframe with marker 110[mag:2][nframes:3]
     *ptr++ = marker;
     switch (mag) {
     case 0:
3fb6b98b
         wloop(mag, *ptr = in[n]->size);
2e6636aa
         break;
     case 1:
3fb6b98b
         wloop(mag, AV_WL16(ptr, in[n]->size));
2e6636aa
         break;
     case 2:
3fb6b98b
         wloop(mag, AV_WL24(ptr, in[n]->size));
2e6636aa
         break;
     case 3:
3fb6b98b
         wloop(mag, AV_WL32(ptr, in[n]->size));
2e6636aa
         break;
     }
     *ptr++ = marker;
af9cac1b
     av_assert0(ptr == &out->data[out->size]);
2e6636aa
 
     return 0;
 }
 
af9cac1b
 static int vp9_superframe_filter(AVBSFContext *ctx, AVPacket *out)
2e6636aa
 {
     GetBitContext gb;
af9cac1b
     VP9BSFContext *s = ctx->priv_data;
     AVPacket *in;
2e6636aa
     int res, invisible, profile, marker, uses_superframe_syntax = 0, n;
 
af9cac1b
     res = ff_bsf_get_packet(ctx, &in);
     if (res < 0)
         return res;
 
     marker = in->data[in->size - 1];
2e6636aa
     if ((marker & 0xe0) == 0xc0) {
         int nbytes = 1 + ((marker >> 3) & 0x3);
         int n_frames = 1 + (marker & 0x7), idx_sz = 2 + n_frames * nbytes;
 
af9cac1b
         uses_superframe_syntax = in->size >= idx_sz && in->data[in->size - idx_sz] == marker;
2e6636aa
     }
 
af9cac1b
     if ((res = init_get_bits8(&gb, in->data, in->size)) < 0)
         goto done;
2e6636aa
 
     get_bits(&gb, 2); // frame marker
     profile  = get_bits1(&gb);
     profile |= get_bits1(&gb) << 1;
     if (profile == 3) profile += get_bits1(&gb);
 
     if (get_bits1(&gb)) {
         invisible = 0;
     } else {
         get_bits1(&gb); // keyframe
         invisible = !get_bits1(&gb);
     }
 
af9cac1b
     if (uses_superframe_syntax && s->n_cache > 0) {
         av_log(ctx, AV_LOG_ERROR,
2e6636aa
                "Mixing of superframe syntax and naked VP9 frames not supported");
0cf949a0
         res = AVERROR(ENOSYS);
af9cac1b
         goto done;
     } else if ((!invisible || uses_superframe_syntax) && !s->n_cache) {
2e6636aa
         // passthrough
af9cac1b
         av_packet_move_ref(out, in);
         goto done;
     } else if (s->n_cache + 1 >= MAX_CACHE) {
         av_log(ctx, AV_LOG_ERROR,
2e6636aa
                "Too many invisible frames");
af9cac1b
         res = AVERROR_INVALIDDATA;
         goto done;
2e6636aa
     }
 
82336278
     av_packet_move_ref(s->cache[s->n_cache++], in);
37f4a093
 
0cf949a0
     if (invisible) {
af9cac1b
         res = AVERROR(EAGAIN);
         goto done;
2e6636aa
     }
af9cac1b
     av_assert0(s->n_cache > 0);
2e6636aa
 
     // build superframe
3fb6b98b
     if ((res = merge_superframe(s->cache, s->n_cache, out)) < 0)
af9cac1b
         goto done;
 
3fb6b98b
     res = av_packet_copy_props(out, s->cache[s->n_cache - 1]);
af9cac1b
     if (res < 0)
         goto done;
 
3fb6b98b
     for (n = 0; n < s->n_cache; n++)
37f4a093
         av_packet_unref(s->cache[n]);
3fb6b98b
     s->n_cache = 0;
 
af9cac1b
 done:
     if (res < 0)
         av_packet_unref(out);
     av_packet_free(&in);
     return res;
2e6636aa
 }
 
37f4a093
 static int vp9_superframe_init(AVBSFContext *ctx)
 {
     VP9BSFContext *s = ctx->priv_data;
     int n;
 
5c22c90c
     // alloc cache packets
37f4a093
     for (n = 0; n < MAX_CACHE; n++) {
         s->cache[n] = av_packet_alloc();
         if (!s->cache[n])
             return AVERROR(ENOMEM);
     }
 
     return 0;
 }
 
af9cac1b
 static void vp9_superframe_close(AVBSFContext *ctx)
2e6636aa
 {
af9cac1b
     VP9BSFContext *s = ctx->priv_data;
2e6636aa
     int n;
 
     // free cached data
37f4a093
     for (n = 0; n < MAX_CACHE; n++)
3fb6b98b
         av_packet_free(&s->cache[n]);
2e6636aa
 }
 
af9cac1b
 static const enum AVCodecID codec_ids[] = {
     AV_CODEC_ID_VP9, AV_CODEC_ID_NONE,
 };
 
 const AVBitStreamFilter ff_vp9_superframe_bsf = {
2e6636aa
     .name           = "vp9_superframe",
     .priv_data_size = sizeof(VP9BSFContext),
     .filter         = vp9_superframe_filter,
37f4a093
     .init           = vp9_superframe_init,
2e6636aa
     .close          = vp9_superframe_close,
af9cac1b
     .codec_ids      = codec_ids,
2e6636aa
 };