libavfilter/fifo.c

   1 /*
   2  * Copyright (c) 2007 Bobby Bingham
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * Libav is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with Libav; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 /**
  22  * @file
  23  * FIFO buffering filter
  24  */
  25
  26 #include "libavutil/avassert.h"
  27 #include "libavutil/channel_layout.h"
  28 #include "libavutil/common.h"
  29 #include "libavutil/mathematics.h"
  30 #include "libavutil/samplefmt.h"
  31
  32 #include "audio.h"
  33 #include "avfilter.h"
  34 #include "internal.h"
  35 #include "video.h"
  36
  37 typedef struct Buf {
  38     AVFilterBufferRef *buf;
  39     struct Buf        *next;
  40 } Buf;
  41
  42 typedef struct {
  43     Buf  root;
  44     Buf *last;   ///< last buffered frame
  45
  46     /**
  47      * When a specific number of output samples is requested, the partial
  48      * buffer is stored here
  49      */
  50     AVFilterBufferRef *buf_out;
  51     int allocated_samples;      ///< number of samples buf_out was allocated for
  52 } FifoContext;
  53
  54 static av_cold int init(AVFilterContext *ctx, const char *args)
  55 {
  56     FifoContext *fifo = ctx->priv;
  57     fifo->last = &fifo->root;
  58
  59     return 0;
  60 }
  61
  62 static av_cold void uninit(AVFilterContext *ctx)
  63 {
  64     FifoContext *fifo = ctx->priv;
  65     Buf *buf, *tmp;
  66
  67     for (buf = fifo->root.next; buf; buf = tmp) {
  68         tmp = buf->next;
  69         avfilter_unref_bufferp(&buf->buf);
  70         av_free(buf);
  71     }
  72
  73     avfilter_unref_bufferp(&fifo->buf_out);
  74 }
  75
  76 static int add_to_queue(AVFilterLink *inlink, AVFilterBufferRef *buf)
  77 {
  78     FifoContext *fifo = inlink->dst->priv;
  79
  80     fifo->last->next = av_mallocz(sizeof(Buf));
  81     if (!fifo->last->next) {
  82         avfilter_unref_buffer(buf);
  83         return AVERROR(ENOMEM);
  84     }
  85
  86     fifo->last = fifo->last->next;
  87     fifo->last->buf = buf;
  88
  89     return 0;
  90 }
  91
  92 static void queue_pop(FifoContext *s)
  93 {
  94     Buf *tmp = s->root.next->next;
  95     if (s->last == s->root.next)
  96         s->last = &s->root;
  97     av_freep(&s->root.next);
  98     s->root.next = tmp;
  99 }
 100
 101 /**
 102  * Move data pointers and pts offset samples forward.
 103  */
 104 static void buffer_offset(AVFilterLink *link, AVFilterBufferRef *buf,
 105                           int offset)
 106 {
 107     int nb_channels = av_get_channel_layout_nb_channels(link->channel_layout);
 108     int planar = av_sample_fmt_is_planar(link->format);
 109     int planes = planar ? nb_channels : 1;
 110     int block_align = av_get_bytes_per_sample(link->format) * (planar ? 1 : nb_channels);
 111     int i;
 112
 113     av_assert0(buf->audio->nb_samples > offset);
 114
 115     for (i = 0; i < planes; i++)
 116         buf->extended_data[i] += block_align*offset;
 117     if (buf->data != buf->extended_data)
 118         memcpy(buf->data, buf->extended_data,
 119                FFMIN(planes, FF_ARRAY_ELEMS(buf->data)) * sizeof(*buf->data));
 120     buf->linesize[0] -= block_align*offset;
 121     buf->audio->nb_samples -= offset;
 122
 123     if (buf->pts != AV_NOPTS_VALUE) {
 124         buf->pts += av_rescale_q(offset, (AVRational){1, link->sample_rate},
 125                                  link->time_base);
 126     }
 127 }
 128
 129 static int calc_ptr_alignment(AVFilterBufferRef *buf)
 130 {
 131     int planes = av_sample_fmt_is_planar(buf->format) ?
 132                  av_get_channel_layout_nb_channels(buf->audio->channel_layout) : 1;
 133     int min_align = 128;
 134     int p;
 135
 136     for (p = 0; p < planes; p++) {
 137         int cur_align = 128;
 138         while ((intptr_t)buf->extended_data[p] % cur_align)
 139             cur_align >>= 1;
 140         if (cur_align < min_align)
 141             min_align = cur_align;
 142     }
 143     return min_align;
 144 }
 145
 146 static int return_audio_frame(AVFilterContext *ctx)
 147 {
 148     AVFilterLink *link = ctx->outputs[0];
 149     FifoContext *s = ctx->priv;
 150     AVFilterBufferRef *head = s->root.next->buf;
 151     AVFilterBufferRef *buf_out;
 152     int ret;
 153
 154     if (!s->buf_out &&
 155         head->audio->nb_samples >= link->request_samples &&
 156         calc_ptr_alignment(head) >= 32) {
 157         if (head->audio->nb_samples == link->request_samples) {
 158             buf_out = head;
 159             queue_pop(s);
 160         } else {
 161             buf_out = avfilter_ref_buffer(head, AV_PERM_READ);
 162             if (!buf_out)
 163                 return AVERROR(ENOMEM);
 164
 165             buf_out->audio->nb_samples = link->request_samples;
 166             buffer_offset(link, head, link->request_samples);
 167         }
 168     } else {
 169         int nb_channels = av_get_channel_layout_nb_channels(link->channel_layout);
 170
 171         if (!s->buf_out) {
 172             s->buf_out = ff_get_audio_buffer(link, AV_PERM_WRITE,
 173                                              link->request_samples);
 174             if (!s->buf_out)
 175                 return AVERROR(ENOMEM);
 176
 177             s->buf_out->audio->nb_samples = 0;
 178             s->buf_out->pts               = head->pts;
 179             s->allocated_samples          = link->request_samples;
 180         } else if (link->request_samples != s->allocated_samples) {
 181             av_log(ctx, AV_LOG_ERROR, "request_samples changed before the "
 182                    "buffer was returned.\n");
 183             return AVERROR(EINVAL);
 184         }
 185
 186         while (s->buf_out->audio->nb_samples < s->allocated_samples) {
 187             int len = FFMIN(s->allocated_samples - s->buf_out->audio->nb_samples,
 188                             head->audio->nb_samples);
 189
 190             av_samples_copy(s->buf_out->extended_data, head->extended_data,
 191                             s->buf_out->audio->nb_samples, 0, len, nb_channels,
 192                             link->format);
 193             s->buf_out->audio->nb_samples += len;
 194
 195             if (len == head->audio->nb_samples) {
 196                 avfilter_unref_buffer(head);
 197                 queue_pop(s);
 198
 199                 if (!s->root.next &&
 200                     (ret = ff_request_frame(ctx->inputs[0])) < 0) {
 201                     if (ret == AVERROR_EOF) {
 202                         av_samples_set_silence(s->buf_out->extended_data,
 203                                                s->buf_out->audio->nb_samples,
 204                                                s->allocated_samples -
 205                                                s->buf_out->audio->nb_samples,
 206                                                nb_channels, link->format);
 207                         s->buf_out->audio->nb_samples = s->allocated_samples;
 208                         break;
 209                     }
 210                     return ret;
 211                 }
 212                 head = s->root.next->buf;
 213             } else {
 214                 buffer_offset(link, head, len);
 215             }
 216         }
 217         buf_out = s->buf_out;
 218         s->buf_out = NULL;
 219     }
 220     return ff_filter_frame(link, buf_out);
 221 }
 222
 223 static int request_frame(AVFilterLink *outlink)
 224 {
 225     FifoContext *fifo = outlink->src->priv;
 226     int ret = 0;
 227
 228     if (!fifo->root.next) {
 229         if ((ret = ff_request_frame(outlink->src->inputs[0])) < 0)
 230             return ret;
 231     }
 232
 233     if (outlink->request_samples) {
 234         return return_audio_frame(outlink->src);
 235     } else {
 236         ret = ff_filter_frame(outlink, fifo->root.next->buf);
 237         queue_pop(fifo);
 238     }
 239
 240     return ret;
 241 }
 242
 243 static const AVFilterPad avfilter_vf_fifo_inputs[] = {
 244     {
 245         .name             = "default",
 246         .type             = AVMEDIA_TYPE_VIDEO,
 247         .get_video_buffer = ff_null_get_video_buffer,
 248         .filter_frame     = add_to_queue,
 249         .rej_perms        = AV_PERM_REUSE2,
 250     },
 251     { NULL }
 252 };
 253
 254 static const AVFilterPad avfilter_vf_fifo_outputs[] = {
 255     {
 256         .name          = "default",
 257         .type          = AVMEDIA_TYPE_VIDEO,
 258         .request_frame = request_frame,
 259     },
 260     { NULL }
 261 };
 262
 263 AVFilter avfilter_vf_fifo = {
 264     .name      = "fifo",
 265     .description = NULL_IF_CONFIG_SMALL("Buffer input images and send them when they are requested."),
 266
 267     .init      = init,
 268     .uninit    = uninit,
 269
 270     .priv_size = sizeof(FifoContext),
 271
 272     .inputs    = avfilter_vf_fifo_inputs,
 273     .outputs   = avfilter_vf_fifo_outputs,
 274 };
 275
 276 static const AVFilterPad avfilter_af_afifo_inputs[] = {
 277     {
 278         .name             = "default",
 279         .type             = AVMEDIA_TYPE_AUDIO,
 280         .get_audio_buffer = ff_null_get_audio_buffer,
 281         .filter_frame     = add_to_queue,
 282         .rej_perms        = AV_PERM_REUSE2,
 283     },
 284     { NULL }
 285 };
 286
 287 static const AVFilterPad avfilter_af_afifo_outputs[] = {
 288     {
 289         .name          = "default",
 290         .type          = AVMEDIA_TYPE_AUDIO,
 291         .request_frame = request_frame,
 292     },
 293     { NULL }
 294 };
 295
 296 AVFilter avfilter_af_afifo = {
 297     .name        = "afifo",
 298     .description = NULL_IF_CONFIG_SMALL("Buffer input frames and send them when they are requested."),
 299
 300     .init      = init,
 301     .uninit    = uninit,
 302
 303     .priv_size = sizeof(FifoContext),
 304
 305     .inputs    = avfilter_af_afifo_inputs,
 306     .outputs   = avfilter_af_afifo_outputs,
 307 };