FFmpeg
filter_units_bsf.c
Go to the documentation of this file.
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 #include <stdlib.h>
20 
21 #include "libavutil/common.h"
22 #include "libavutil/opt.h"
23 
24 #include "bsf.h"
25 #include "cbs.h"
26 
27 
28 typedef struct FilterUnitsContext {
29  const AVClass *class;
30 
33 
34  const char *pass_types;
35  const char *remove_types;
36 
37  enum {
41  } mode;
43  int nb_types;
45 
46 
47 static int filter_units_make_type_list(const char *list_string,
49  int *nb_types)
50 {
52  int pass, count;
53 
54  for (pass = 1; pass <= 2; pass++) {
55  long value, range_start, range_end;
56  const char *str;
57  char *value_end;
58 
59  count = 0;
60  for (str = list_string; *str;) {
61  value = strtol(str, &value_end, 0);
62  if (str == value_end)
63  goto invalid;
64  str = (const char *)value_end;
65  if (*str == '-') {
66  ++str;
67  range_start = value;
68  range_end = strtol(str, &value_end, 0);
69  if (str == value_end)
70  goto invalid;
71 
72  for (value = range_start; value < range_end; value++) {
73  if (pass == 2)
74  list[count] = value;
75  ++count;
76  }
77  } else {
78  if (pass == 2)
79  list[count] = value;
80  ++count;
81  }
82  if (*str == '|')
83  ++str;
84  }
85  if (pass == 1) {
86  list = av_malloc_array(count, sizeof(*list));
87  if (!list)
88  return AVERROR(ENOMEM);
89  }
90  }
91 
92  *type_list = list;
93  *nb_types = count;
94  return 0;
95 
96 invalid:
97  av_freep(&list);
98  return AVERROR(EINVAL);
99 }
100 
102 {
104  CodedBitstreamFragment *frag = &ctx->fragment;
105  int err, i, j;
106 
107  err = ff_bsf_get_packet_ref(bsf, pkt);
108  if (err < 0)
109  return err;
110 
111  if (ctx->mode == NOOP)
112  return 0;
113 
114  err = ff_cbs_read_packet(ctx->cbc, frag, pkt);
115  if (err < 0) {
116  av_log(bsf, AV_LOG_ERROR, "Failed to read packet.\n");
117  goto fail;
118  }
119 
120  for (i = frag->nb_units - 1; i >= 0; i--) {
121  for (j = 0; j < ctx->nb_types; j++) {
122  if (frag->units[i].type == ctx->type_list[j])
123  break;
124  }
125  if (ctx->mode == REMOVE ? j < ctx->nb_types
126  : j >= ctx->nb_types)
127  ff_cbs_delete_unit(ctx->cbc, frag, i);
128  }
129 
130  if (frag->nb_units == 0) {
131  // Don't return packets with nothing in them.
132  err = AVERROR(EAGAIN);
133  goto fail;
134  }
135 
136  err = ff_cbs_write_packet(ctx->cbc, pkt, frag);
137  if (err < 0) {
138  av_log(bsf, AV_LOG_ERROR, "Failed to write packet.\n");
139  goto fail;
140  }
141 
142 fail:
143  if (err < 0)
144  av_packet_unref(pkt);
145  ff_cbs_fragment_reset(ctx->cbc, frag);
146 
147  return err;
148 }
149 
151 {
153  int err;
154 
155  if (ctx->pass_types && ctx->remove_types) {
156  av_log(bsf, AV_LOG_ERROR, "Exactly one of pass_types or "
157  "remove_types is required.\n");
158  return AVERROR(EINVAL);
159  }
160 
161  if (ctx->pass_types) {
162  ctx->mode = PASS;
164  &ctx->type_list, &ctx->nb_types);
165  if (err < 0) {
166  av_log(bsf, AV_LOG_ERROR, "Failed to parse pass_types.\n");
167  return err;
168  }
169  } else if (ctx->remove_types) {
170  ctx->mode = REMOVE;
172  &ctx->type_list, &ctx->nb_types);
173  if (err < 0) {
174  av_log(bsf, AV_LOG_ERROR, "Failed to parse remove_types.\n");
175  return err;
176  }
177  } else {
178  return 0;
179  }
180 
181  err = ff_cbs_init(&ctx->cbc, bsf->par_in->codec_id, bsf);
182  if (err < 0)
183  return err;
184 
185  // Don't actually decompose anything, we only want the unit data.
186  ctx->cbc->decompose_unit_types = ctx->type_list;
187  ctx->cbc->nb_decompose_unit_types = 0;
188 
189  if (bsf->par_in->extradata) {
190  CodedBitstreamFragment *frag = &ctx->fragment;
191 
192  err = ff_cbs_read_extradata(ctx->cbc, frag, bsf->par_in);
193  if (err < 0) {
194  av_log(bsf, AV_LOG_ERROR, "Failed to read extradata.\n");
195  } else {
196  err = ff_cbs_write_extradata(ctx->cbc, bsf->par_out, frag);
197  if (err < 0)
198  av_log(bsf, AV_LOG_ERROR, "Failed to write extradata.\n");
199  }
200 
201  ff_cbs_fragment_reset(ctx->cbc, frag);
202  }
203 
204  return err;
205 }
206 
208 {
210 
211  av_freep(&ctx->type_list);
212 
213  ff_cbs_fragment_free(ctx->cbc, &ctx->fragment);
214  ff_cbs_close(&ctx->cbc);
215 }
216 
217 #define OFFSET(x) offsetof(FilterUnitsContext, x)
218 #define FLAGS (AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_BSF_PARAM)
219 static const AVOption filter_units_options[] = {
220  { "pass_types", "List of unit types to pass through the filter.",
222  { .str = NULL }, .flags = FLAGS },
223  { "remove_types", "List of unit types to remove in the filter.",
225  { .str = NULL }, .flags = FLAGS },
226 
227  { NULL }
228 };
229 
230 static const AVClass filter_units_class = {
231  .class_name = "filter_units",
232  .item_name = av_default_item_name,
233  .option = filter_units_options,
234  .version = LIBAVUTIL_VERSION_INT,
235 };
236 
238  .name = "filter_units",
239  .priv_data_size = sizeof(FilterUnitsContext),
240  .priv_class = &filter_units_class,
242  .close = &filter_units_close,
245 };
#define NULL
Definition: coverity.c:32
int nb_units
Number of units in this fragment.
Definition: cbs.h:147
AVCodecParameters * par_out
Parameters of the output stream.
Definition: avcodec.h:5808
static const AVClass filter_units_class
AVOption.
Definition: opt.h:246
const char * pass_types
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
int ff_cbs_write_packet(CodedBitstreamContext *ctx, AVPacket *pkt, CodedBitstreamFragment *frag)
Write the bitstream of a fragment to a packet.
Definition: cbs.c:345
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int ff_cbs_init(CodedBitstreamContext **ctx_ptr, enum AVCodecID codec_id, void *log_ctx)
Create and initialise a new context for the given codec.
Definition: cbs.c:74
void ff_cbs_delete_unit(CodedBitstreamContext *ctx, CodedBitstreamFragment *frag, int position)
Delete a unit from a fragment and free all memory it uses.
Definition: cbs.c:740
CodedBitstreamUnitType type
Codec-specific type of this unit.
Definition: cbs.h:68
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: avcodec.h:3968
The bitstream filter state.
Definition: avcodec.h:5774
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
CodedBitstreamContext * cbc
static AVPacket pkt
void * priv_data
Opaque filter-specific private data.
Definition: avcodec.h:5795
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
AVOptions.
uint32_t CodedBitstreamUnitType
The codec-specific type of a bitstream unit.
Definition: cbs.h:43
GLsizei GLboolean const GLfloat * value
Definition: opengl_enc.c:108
int ff_cbs_read_packet(CodedBitstreamContext *ctx, CodedBitstreamFragment *frag, const AVPacket *pkt)
Read the data bitstream from a packet into a fragment, then split into units and decompose.
Definition: cbs.c:239
const char * name
Definition: avcodec.h:5824
CodedBitstreamUnit * units
Pointer to an array of units of length nb_units_allocated.
Definition: cbs.h:162
#define av_log(a,...)
void ff_cbs_fragment_free(CodedBitstreamContext *ctx, CodedBitstreamFragment *frag)
Free the units array of a fragment in addition to what ff_cbs_fragment_reset does.
Definition: cbs.c:154
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:259
static int filter_units_init(AVBSFContext *bsf)
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
filter_frame For filters that do not use the this method is called when a frame is pushed to the filter s input It can be called at any time except in a reentrant way If the input frame is enough to produce then the filter should push the output frames on the output link immediately As an exception to the previous rule if the input frame is enough to produce several output frames then the filter needs output only at least one per link The additional frames can be left buffered in the filter
GLsizei count
Definition: opengl_enc.c:108
static void filter_units_close(AVBSFContext *bsf)
#define fail()
Definition: checkasm.h:122
#define pass
Definition: fft_template.c:619
static int filter_units_filter(AVBSFContext *bsf, AVPacket *pkt)
int ff_cbs_write_extradata(CodedBitstreamContext *ctx, AVCodecParameters *par, CodedBitstreamFragment *frag)
Write the bitstream of a fragment to the extradata in codec parameters.
Definition: cbs.c:320
const char * remove_types
AVFormatContext * ctx
Definition: movenc.c:48
enum FilterUnitsContext::@80 mode
int nb_decompose_unit_types
Length of the decompose_unit_types array.
Definition: cbs.h:201
Coded bitstream fragment structure, combining one or more units.
Definition: cbs.h:116
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: avpacket.c:599
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining list
CodedBitstreamUnitType * type_list
const AVBitStreamFilter ff_filter_units_bsf
Describe the class of an AVClass context structure.
Definition: log.h:67
void ff_cbs_fragment_reset(CodedBitstreamContext *ctx, CodedBitstreamFragment *frag)
Free the units contained in a fragment as well as the fragment&#39;s own data buffer, but not the units a...
Definition: cbs.c:139
Context structure for coded bitstream operations.
Definition: cbs.h:168
void ff_cbs_close(CodedBitstreamContext **ctx_ptr)
Close a context and free all internal state.
Definition: cbs.c:113
#define FLAGS
int ff_cbs_read_extradata(CodedBitstreamContext *ctx, CodedBitstreamFragment *frag, const AVCodecParameters *par)
Read the extradata bitstream found in codec parameters into a fragment, then split into units and dec...
Definition: cbs.c:221
CodedBitstreamFragment fragment
common internal and external API header
static enum AVCodecID codec_ids[]
CodedBitstreamUnitType * decompose_unit_types
Array of unit types which should be decomposed when reading.
Definition: cbs.h:197
enum AVCodecID ff_cbs_all_codec_ids[]
Table of all supported codec IDs.
Definition: cbs.c:52
static const AVOption filter_units_options[]
#define OFFSET(x)
static int filter_units_make_type_list(const char *list_string, CodedBitstreamUnitType **type_list, int *nb_types)
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: avcodec.h:3982
#define av_freep(p)
#define av_malloc_array(a, b)
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
This structure stores compressed data.
Definition: avcodec.h:1457
AVCodecParameters * par_in
Parameters of the input stream.
Definition: avcodec.h:5802
int ff_bsf_get_packet_ref(AVBSFContext *ctx, AVPacket *pkt)
Called by bitstream filters to get packet for filtering.
Definition: bsf.c:239