libavfilter/f_sidedata.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 /**
  20  * @file
  21  * filter for manipulating frame side data
  22  */
  23
  24 #include "config_components.h"
  25
  26 #include "libavutil/avassert.h"
  27 #include "libavutil/internal.h"
  28 #include "libavutil/frame.h"
  29 #include "libavutil/opt.h"
  30 #include "audio.h"
  31 #include "avfilter.h"
  32 #include "internal.h"
  33 #include "video.h"
  34
  35 enum SideDataMode {
  36     SIDEDATA_SELECT,
  37     SIDEDATA_DELETE,
  38     SIDEDATA_NB
  39 };
  40
  41 typedef struct SideDataContext {
  42     const AVClass *class;
  43
  44     int mode;
  45     int type;   // enum AVFrameSideDataType or -1 for delete side data mode
  46 } SideDataContext;
  47
  48 #define OFFSET(x) offsetof(SideDataContext, x)
  49 #define DEFINE_OPTIONS(filt_name, FLAGS) \
  50 static const AVOption filt_name##_options[] = { \
  51     { "mode", "set a mode of operation", OFFSET(mode),   AV_OPT_TYPE_INT,    {.i64 = 0 }, 0, SIDEDATA_NB-1, FLAGS, "mode" }, \
  52     {   "select", "select frame",        0,              AV_OPT_TYPE_CONST,  {.i64 = SIDEDATA_SELECT }, 0, 0, FLAGS, "mode" }, \
  53     {   "delete", "delete side data",    0,              AV_OPT_TYPE_CONST,  {.i64 = SIDEDATA_DELETE }, 0, 0, FLAGS, "mode" }, \
  54     { "type",   "set side data type",    OFFSET(type),   AV_OPT_TYPE_INT,    {.i64 = -1 }, -1, INT_MAX, FLAGS, "type" }, \
  55     {   "PANSCAN",                    "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_PANSCAN                    }, 0, 0, FLAGS, "type" }, \
  56     {   "A53_CC",                     "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_A53_CC                     }, 0, 0, FLAGS, "type" }, \
  57     {   "STEREO3D",                   "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_STEREO3D                   }, 0, 0, FLAGS, "type" }, \
  58     {   "MATRIXENCODING",             "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_MATRIXENCODING             }, 0, 0, FLAGS, "type" }, \
  59     {   "DOWNMIX_INFO",               "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_DOWNMIX_INFO               }, 0, 0, FLAGS, "type" }, \
  60     {   "REPLAYGAIN",                 "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_REPLAYGAIN                 }, 0, 0, FLAGS, "type" }, \
  61     {   "DISPLAYMATRIX",              "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_DISPLAYMATRIX              }, 0, 0, FLAGS, "type" }, \
  62     {   "AFD",                        "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_AFD                        }, 0, 0, FLAGS, "type" }, \
  63     {   "MOTION_VECTORS",             "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_MOTION_VECTORS             }, 0, 0, FLAGS, "type" }, \
  64     {   "SKIP_SAMPLES",               "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_SKIP_SAMPLES               }, 0, 0, FLAGS, "type" }, \
  65     {   "AUDIO_SERVICE_TYPE",         "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_AUDIO_SERVICE_TYPE         }, 0, 0, FLAGS, "type" }, \
  66     {   "MASTERING_DISPLAY_METADATA", "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_MASTERING_DISPLAY_METADATA }, 0, 0, FLAGS, "type" }, \
  67     {   "GOP_TIMECODE",               "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_GOP_TIMECODE               }, 0, 0, FLAGS, "type" }, \
  68     {   "SPHERICAL",                  "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_SPHERICAL                  }, 0, 0, FLAGS, "type" }, \
  69     {   "CONTENT_LIGHT_LEVEL",        "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_CONTENT_LIGHT_LEVEL        }, 0, 0, FLAGS, "type" }, \
  70     {   "ICC_PROFILE",                "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_ICC_PROFILE                }, 0, 0, FLAGS, "type" }, \
  71     {   "S12M_TIMECOD",               "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_S12M_TIMECODE              }, 0, 0, FLAGS, "type" }, \
  72     {   "DYNAMIC_HDR_PLUS",           "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_DYNAMIC_HDR_PLUS           }, 0, 0, FLAGS, "type" }, \
  73     {   "REGIONS_OF_INTEREST",        "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_REGIONS_OF_INTEREST        }, 0, 0, FLAGS, "type" }, \
  74     {   "DETECTION_BOUNDING_BOXES",   "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_DETECTION_BBOXES           }, 0, 0, FLAGS, "type" }, \
  75     {   "SEI_UNREGISTERED",           "", 0,             AV_OPT_TYPE_CONST,  {.i64 = AV_FRAME_DATA_SEI_UNREGISTERED           }, 0, 0, FLAGS, "type" }, \
  76     { NULL } \
  77 }
  78
  79 static av_cold int init(AVFilterContext *ctx)
  80 {
  81     SideDataContext *s = ctx->priv;
  82
  83     if (s->type == -1 && s->mode != SIDEDATA_DELETE) {
  84         av_log(ctx, AV_LOG_ERROR, "Side data type must be set\n");
  85         return AVERROR(EINVAL);
  86     }
  87
  88     return 0;
  89 }
  90
  91 static int filter_frame(AVFilterLink *inlink, AVFrame *frame)
  92 {
  93     AVFilterContext *ctx = inlink->dst;
  94     AVFilterLink *outlink = ctx->outputs[0];
  95     SideDataContext *s = ctx->priv;
  96     AVFrameSideData *sd = NULL;
  97
  98     if (s->type != -1)
  99        sd = av_frame_get_side_data(frame, s->type);
 100
 101     switch (s->mode) {
 102     case SIDEDATA_SELECT:
 103         if (sd) {
 104             return ff_filter_frame(outlink, frame);
 105         }
 106         break;
 107     case SIDEDATA_DELETE:
 108         if (s->type == -1) {
 109             while (frame->nb_side_data)
 110                 av_frame_remove_side_data(frame, frame->side_data[0]->type);
 111         } else if (sd) {
 112             av_frame_remove_side_data(frame, s->type);
 113         }
 114         return ff_filter_frame(outlink, frame);
 115         break;
 116     default:
 117         av_assert0(0);
 118     };
 119
 120     av_frame_free(&frame);
 121
 122     return 0;
 123 }
 124
 125 #if CONFIG_ASIDEDATA_FILTER
 126
 127 DEFINE_OPTIONS(asidedata, AV_OPT_FLAG_AUDIO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
 128 AVFILTER_DEFINE_CLASS(asidedata);
 129
 130 static const AVFilterPad ainputs[] = {
 131     {
 132         .name         = "default",
 133         .type         = AVMEDIA_TYPE_AUDIO,
 134         .filter_frame = filter_frame,
 135     },
 136 };
 137
 138 const AVFilter ff_af_asidedata = {
 139     .name          = "asidedata",
 140     .description   = NULL_IF_CONFIG_SMALL("Manipulate audio frame side data."),
 141     .priv_size     = sizeof(SideDataContext),
 142     .priv_class    = &asidedata_class,
 143     .init          = init,
 144     FILTER_INPUTS(ainputs),
 145     FILTER_OUTPUTS(ff_audio_default_filterpad),
 146     .flags         = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
 147                      AVFILTER_FLAG_METADATA_ONLY,
 148 };
 149 #endif /* CONFIG_ASIDEDATA_FILTER */
 150
 151 #if CONFIG_SIDEDATA_FILTER
 152
 153 DEFINE_OPTIONS(sidedata, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_FILTERING_PARAM);
 154 AVFILTER_DEFINE_CLASS(sidedata);
 155
 156 static const AVFilterPad inputs[] = {
 157     {
 158         .name         = "default",
 159         .type         = AVMEDIA_TYPE_VIDEO,
 160         .filter_frame = filter_frame,
 161     },
 162 };
 163
 164 const AVFilter ff_vf_sidedata = {
 165     .name        = "sidedata",
 166     .description = NULL_IF_CONFIG_SMALL("Manipulate video frame side data."),
 167     .priv_size   = sizeof(SideDataContext),
 168     .priv_class  = &sidedata_class,
 169     .init        = init,
 170     FILTER_INPUTS(inputs),
 171     FILTER_OUTPUTS(ff_video_default_filterpad),
 172     .flags       = AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC |
 173                    AVFILTER_FLAG_METADATA_ONLY,
 174 };
 175 #endif /* CONFIG_SIDEDATA_FILTER */