FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
af_channelmap.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 Google, Inc.
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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  * audio channel mapping filter
24  */
25 
26 #include <ctype.h>
27 
28 #include "libavutil/avstring.h"
30 #include "libavutil/common.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/samplefmt.h"
34 
35 #include "audio.h"
36 #include "avfilter.h"
37 #include "formats.h"
38 #include "internal.h"
39 
40 struct ChannelMap {
41  uint64_t in_channel;
42  uint64_t out_channel;
45 };
46 
55 };
56 
57 #define MAX_CH 64
58 typedef struct ChannelMapContext {
59  const AVClass *class;
60  char *mapping_str;
62  uint64_t output_layout;
64  int nch;
67 
68 #define OFFSET(x) offsetof(ChannelMapContext, x)
69 #define A AV_OPT_FLAG_AUDIO_PARAM
70 #define F AV_OPT_FLAG_FILTERING_PARAM
71 static const AVOption channelmap_options[] = {
72  { "map", "A comma-separated list of input channel numbers in output order.",
73  OFFSET(mapping_str), AV_OPT_TYPE_STRING, .flags = A|F },
74  { "channel_layout", "Output channel layout.",
75  OFFSET(channel_layout_str), AV_OPT_TYPE_STRING, .flags = A|F },
76  { NULL }
77 };
78 
79 AVFILTER_DEFINE_CLASS(channelmap);
80 
81 static char* split(char *message, char delim) {
82  char *next = strchr(message, delim);
83  if (next)
84  *next++ = '\0';
85  return next;
86 }
87 
88 static int get_channel_idx(char **map, int *ch, char delim, int max_ch)
89 {
90  char *next;
91  int len;
92  int n = 0;
93  if (!*map)
94  return AVERROR(EINVAL);
95  next = split(*map, delim);
96  if (!next && delim == '-')
97  return AVERROR(EINVAL);
98  len = strlen(*map);
99  sscanf(*map, "%d%n", ch, &n);
100  if (n != len)
101  return AVERROR(EINVAL);
102  if (*ch < 0 || *ch > max_ch)
103  return AVERROR(EINVAL);
104  *map = next;
105  return 0;
106 }
107 
108 static int get_channel(char **map, uint64_t *ch, char delim)
109 {
110  char *next = split(*map, delim);
111  if (!next && delim == '-')
112  return AVERROR(EINVAL);
113  *ch = av_get_channel_layout(*map);
114  if (av_get_channel_layout_nb_channels(*ch) != 1)
115  return AVERROR(EINVAL);
116  *map = next;
117  return 0;
118 }
119 
121 {
122  ChannelMapContext *s = ctx->priv;
123  char *mapping, separator = '|';
124  int map_entries = 0;
125  char buf[256];
126  enum MappingMode mode;
127  uint64_t out_ch_mask = 0;
128  int i;
129 
130  mapping = s->mapping_str;
131 
132  if (!mapping) {
133  mode = MAP_NONE;
134  } else {
135  char *dash = strchr(mapping, '-');
136  if (!dash) { // short mapping
137  if (av_isdigit(*mapping))
138  mode = MAP_ONE_INT;
139  else
140  mode = MAP_ONE_STR;
141  } else if (av_isdigit(*mapping)) {
142  if (av_isdigit(*(dash+1)))
143  mode = MAP_PAIR_INT_INT;
144  else
145  mode = MAP_PAIR_INT_STR;
146  } else {
147  if (av_isdigit(*(dash+1)))
148  mode = MAP_PAIR_STR_INT;
149  else
150  mode = MAP_PAIR_STR_STR;
151  }
152 #if FF_API_OLD_FILTER_OPTS
153  if (strchr(mapping, ',')) {
154  av_log(ctx, AV_LOG_WARNING, "This syntax is deprecated, use "
155  "'|' to separate the mappings.\n");
156  separator = ',';
157  }
158 #endif
159  }
160 
161  if (mode != MAP_NONE) {
162  char *sep = mapping;
163  map_entries = 1;
164  while ((sep = strchr(sep, separator))) {
165  if (*++sep) // Allow trailing comma
166  map_entries++;
167  }
168  }
169 
170  if (map_entries > MAX_CH) {
171  av_log(ctx, AV_LOG_ERROR, "Too many channels mapped: '%d'.\n", map_entries);
172  return AVERROR(EINVAL);
173  }
174 
175  for (i = 0; i < map_entries; i++) {
176  int in_ch_idx = -1, out_ch_idx = -1;
177  uint64_t in_ch = 0, out_ch = 0;
178  static const char err[] = "Failed to parse channel map\n";
179  switch (mode) {
180  case MAP_ONE_INT:
181  if (get_channel_idx(&mapping, &in_ch_idx, separator, MAX_CH) < 0) {
182  av_log(ctx, AV_LOG_ERROR, err);
183  return AVERROR(EINVAL);
184  }
185  s->map[i].in_channel_idx = in_ch_idx;
186  s->map[i].out_channel_idx = i;
187  break;
188  case MAP_ONE_STR:
189  if (get_channel(&mapping, &in_ch, separator) < 0) {
190  av_log(ctx, AV_LOG_ERROR, err);
191  return AVERROR(EINVAL);
192  }
193  s->map[i].in_channel = in_ch;
194  s->map[i].out_channel_idx = i;
195  break;
196  case MAP_PAIR_INT_INT:
197  if (get_channel_idx(&mapping, &in_ch_idx, '-', MAX_CH) < 0 ||
198  get_channel_idx(&mapping, &out_ch_idx, separator, MAX_CH) < 0) {
199  av_log(ctx, AV_LOG_ERROR, err);
200  return AVERROR(EINVAL);
201  }
202  s->map[i].in_channel_idx = in_ch_idx;
203  s->map[i].out_channel_idx = out_ch_idx;
204  break;
205  case MAP_PAIR_INT_STR:
206  if (get_channel_idx(&mapping, &in_ch_idx, '-', MAX_CH) < 0 ||
207  get_channel(&mapping, &out_ch, separator) < 0 ||
208  out_ch & out_ch_mask) {
209  av_log(ctx, AV_LOG_ERROR, err);
210  return AVERROR(EINVAL);
211  }
212  s->map[i].in_channel_idx = in_ch_idx;
213  s->map[i].out_channel = out_ch;
214  out_ch_mask |= out_ch;
215  break;
216  case MAP_PAIR_STR_INT:
217  if (get_channel(&mapping, &in_ch, '-') < 0 ||
218  get_channel_idx(&mapping, &out_ch_idx, separator, MAX_CH) < 0) {
219  av_log(ctx, AV_LOG_ERROR, err);
220  return AVERROR(EINVAL);
221  }
222  s->map[i].in_channel = in_ch;
223  s->map[i].out_channel_idx = out_ch_idx;
224  break;
225  case MAP_PAIR_STR_STR:
226  if (get_channel(&mapping, &in_ch, '-') < 0 ||
227  get_channel(&mapping, &out_ch, separator) < 0 ||
228  out_ch & out_ch_mask) {
229  av_log(ctx, AV_LOG_ERROR, err);
230  return AVERROR(EINVAL);
231  }
232  s->map[i].in_channel = in_ch;
233  s->map[i].out_channel = out_ch;
234  out_ch_mask |= out_ch;
235  break;
236  }
237  }
238  s->mode = mode;
239  s->nch = map_entries;
240  s->output_layout = out_ch_mask ? out_ch_mask :
241  av_get_default_channel_layout(map_entries);
242 
243  if (s->channel_layout_str) {
244  uint64_t fmt;
245  if ((fmt = av_get_channel_layout(s->channel_layout_str)) == 0) {
246  av_log(ctx, AV_LOG_ERROR, "Error parsing channel layout: '%s'.\n",
247  s->channel_layout_str);
248  return AVERROR(EINVAL);
249  }
250  if (mode == MAP_NONE) {
251  int i;
253  for (i = 0; i < s->nch; i++) {
254  s->map[i].in_channel_idx = i;
255  s->map[i].out_channel_idx = i;
256  }
257  } else if (out_ch_mask && out_ch_mask != fmt) {
258  av_get_channel_layout_string(buf, sizeof(buf), 0, out_ch_mask);
259  av_log(ctx, AV_LOG_ERROR,
260  "Output channel layout '%s' does not match the list of channel mapped: '%s'.\n",
261  s->channel_layout_str, buf);
262  return AVERROR(EINVAL);
263  } else if (s->nch != av_get_channel_layout_nb_channels(fmt)) {
264  av_log(ctx, AV_LOG_ERROR,
265  "Output channel layout %s does not match the number of channels mapped %d.\n",
266  s->channel_layout_str, s->nch);
267  return AVERROR(EINVAL);
268  }
269  s->output_layout = fmt;
270  }
271  if (!s->output_layout) {
272  av_log(ctx, AV_LOG_ERROR, "Output channel layout is not set and "
273  "cannot be guessed from the maps.\n");
274  return AVERROR(EINVAL);
275  }
276 
277  if (mode == MAP_PAIR_INT_STR || mode == MAP_PAIR_STR_STR) {
278  for (i = 0; i < s->nch; i++) {
280  s->output_layout, s->map[i].out_channel);
281  }
282  }
283 
284  return 0;
285 }
286 
288 {
289  ChannelMapContext *s = ctx->priv;
292  int ret;
293 
294  layouts = ff_all_channel_layouts();
295  if (!layouts) {
296  ret = AVERROR(ENOMEM);
297  goto fail;
298  }
299  if ((ret = ff_add_channel_layout (&channel_layouts, s->output_layout )) < 0 ||
300  (ret = ff_set_common_formats (ctx , ff_planar_sample_fmts() )) < 0 ||
301  (ret = ff_set_common_samplerates (ctx , ff_all_samplerates() )) < 0 ||
302  (ret = ff_channel_layouts_ref (layouts , &ctx->inputs[0]->out_channel_layouts)) < 0 ||
303  (ret = ff_channel_layouts_ref (channel_layouts , &ctx->outputs[0]->in_channel_layouts)) < 0)
304  goto fail;
305 
306  return 0;
307 fail:
308  if (layouts)
309  av_freep(&layouts->channel_layouts);
310  av_freep(&layouts);
311  return ret;
312 }
313 
315 {
316  AVFilterContext *ctx = inlink->dst;
317  AVFilterLink *outlink = ctx->outputs[0];
318  const ChannelMapContext *s = ctx->priv;
319  const int nch_in = av_get_channel_layout_nb_channels(inlink->channel_layout);
320  const int nch_out = s->nch;
321  int ch;
322  uint8_t *source_planes[MAX_CH];
323 
324  memcpy(source_planes, buf->extended_data,
325  nch_in * sizeof(source_planes[0]));
326 
327  if (nch_out > nch_in) {
328  if (nch_out > FF_ARRAY_ELEMS(buf->data)) {
329  uint8_t **new_extended_data =
330  av_mallocz_array(nch_out, sizeof(*buf->extended_data));
331  if (!new_extended_data) {
332  av_frame_free(&buf);
333  return AVERROR(ENOMEM);
334  }
335  if (buf->extended_data == buf->data) {
336  buf->extended_data = new_extended_data;
337  } else {
338  av_free(buf->extended_data);
339  buf->extended_data = new_extended_data;
340  }
341  } else if (buf->extended_data != buf->data) {
342  av_free(buf->extended_data);
343  buf->extended_data = buf->data;
344  }
345  }
346 
347  for (ch = 0; ch < nch_out; ch++) {
348  buf->extended_data[s->map[ch].out_channel_idx] =
349  source_planes[s->map[ch].in_channel_idx];
350  }
351 
352  if (buf->data != buf->extended_data)
353  memcpy(buf->data, buf->extended_data,
354  FFMIN(FF_ARRAY_ELEMS(buf->data), nch_out) * sizeof(buf->data[0]));
355 
356  buf->channel_layout = outlink->channel_layout;
357  av_frame_set_channels(buf, outlink->channels);
358 
359  return ff_filter_frame(outlink, buf);
360 }
361 
363 {
364  AVFilterContext *ctx = inlink->dst;
365  ChannelMapContext *s = ctx->priv;
367  int i, err = 0;
368  const char *channel_name;
369  char layout_name[256];
370 
371  for (i = 0; i < s->nch; i++) {
372  struct ChannelMap *m = &s->map[i];
373 
374  if (s->mode == MAP_PAIR_STR_INT || s->mode == MAP_PAIR_STR_STR) {
376  inlink->channel_layout, m->in_channel);
377  }
378 
379  if (m->in_channel_idx < 0 || m->in_channel_idx >= nb_channels) {
380  av_get_channel_layout_string(layout_name, sizeof(layout_name),
381  0, inlink->channel_layout);
382  if (m->in_channel) {
383  channel_name = av_get_channel_name(m->in_channel);
384  av_log(ctx, AV_LOG_ERROR,
385  "input channel '%s' not available from input layout '%s'\n",
386  channel_name, layout_name);
387  } else {
388  av_log(ctx, AV_LOG_ERROR,
389  "input channel #%d not available from input layout '%s'\n",
390  m->in_channel_idx, layout_name);
391  }
392  err = AVERROR(EINVAL);
393  }
394  }
395 
396  return err;
397 }
398 
400  {
401  .name = "default",
402  .type = AVMEDIA_TYPE_AUDIO,
403  .filter_frame = channelmap_filter_frame,
404  .config_props = channelmap_config_input,
405  .needs_writable = 1,
406  },
407  { NULL }
408 };
409 
411  {
412  .name = "default",
413  .type = AVMEDIA_TYPE_AUDIO
414  },
415  { NULL }
416 };
417 
419  .name = "channelmap",
420  .description = NULL_IF_CONFIG_SMALL("Remap audio channels."),
421  .init = channelmap_init,
422  .query_formats = channelmap_query_formats,
423  .priv_size = sizeof(ChannelMapContext),
424  .priv_class = &channelmap_class,
425  .inputs = avfilter_af_channelmap_inputs,
426  .outputs = avfilter_af_channelmap_outputs,
427 };
void av_frame_set_channels(AVFrame *frame, int val)
#define NULL
Definition: coverity.c:32
AVFILTER_DEFINE_CLASS(channelmap)
const char * s
Definition: avisynth_c.h:631
static av_const int av_isdigit(int c)
Locale-independent conversion of ASCII isdigit.
Definition: avstring.h:206
uint64_t in_channel
layout describing the input channel
Definition: af_channelmap.c:41
This structure describes decoded (raw) audio or video data.
Definition: frame.h:180
AVOption.
Definition: opt.h:245
AVFormatContext * ctx
Definition: movenc-test.c:48
const char * fmt
Definition: avisynth_c.h:632
#define OFFSET(x)
Definition: af_channelmap.c:68
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
Main libavfilter public API header.
AVFilter ff_af_channelmap
uint64_t output_layout
Definition: af_channelmap.c:62
static const AVOption channelmap_options[]
Definition: af_channelmap.c:71
int av_get_channel_layout_nb_channels(uint64_t channel_layout)
Return the number of channels in the channel layout.
const char * name
Pad name.
Definition: internal.h:59
uint64_t av_get_channel_layout(const char *name)
Return a channel layout id that matches name, or 0 if no match is found.
AVFilterLink ** inputs
array of pointers to input links
Definition: avfilter.h:313
int ff_channel_layouts_ref(AVFilterChannelLayouts *f, AVFilterChannelLayouts **ref)
Add *ref as a new reference to f.
Definition: formats.c:435
int ff_filter_frame(AVFilterLink *link, AVFrame *frame)
Send a frame of data to the next filter.
Definition: avfilter.c:1180
uint8_t
#define av_cold
Definition: attributes.h:82
mode
Definition: f_perms.c:27
AVOptions.
enum MappingMode mode
Definition: af_channelmap.c:65
static int channelmap_filter_frame(AVFilterLink *inlink, AVFrame *buf)
char * channel_layout_str
Definition: af_channelmap.c:61
static int channelmap_query_formats(AVFilterContext *ctx)
#define av_log(a,...)
unsigned m
Definition: audioconvert.c:187
A filter pad used for either input or output.
Definition: internal.h:53
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
int ff_set_common_formats(AVFilterContext *ctx, AVFilterFormats *formats)
A helper for query_formats() which sets all links to the same list of formats.
Definition: formats.c:568
int ff_add_channel_layout(AVFilterChannelLayouts **l, uint64_t channel_layout)
Definition: formats.c:343
#define AVERROR(e)
Definition: error.h:43
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:153
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
void * priv
private data for use by the filter
Definition: avfilter.h:320
uint64_t * channel_layouts
list of channel layouts
Definition: formats.h:86
#define fail()
Definition: checkasm.h:81
#define A
Definition: af_channelmap.c:69
static char * split(char *message, char delim)
Definition: af_channelmap.c:81
MappingMode
Definition: af_channelmap.c:47
uint64_t channel_layout
Channel layout of the audio data.
Definition: frame.h:345
audio channel layout utility functions
#define FFMIN(a, b)
Definition: common.h:96
int n
Definition: avisynth_c.h:547
AVFilterFormats * ff_planar_sample_fmts(void)
Construct a formats list containing all planar sample formats.
Definition: formats.c:382
static const AVFilterPad outputs[]
Definition: af_afftfilt.c:386
AVFilterChannelLayouts * ff_all_channel_layouts(void)
Construct an empty AVFilterChannelLayouts/AVFilterFormats struct – representing any channel layout (w...
Definition: formats.c:401
#define FF_ARRAY_ELEMS(a)
int in_channel_idx
index of in_channel in the input stream data
Definition: af_channelmap.c:43
A list of supported channel layouts.
Definition: formats.h:85
void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout)
Return a description of a channel layout.
static const AVFilterPad inputs[]
Definition: af_afftfilt.c:376
void * buf
Definition: avisynth_c.h:553
struct ChannelMap map[MAX_CH]
Definition: af_channelmap.c:63
static const uint16_t channel_layouts[7]
Definition: dca_lbr.c:119
Describe the class of an AVClass context structure.
Definition: log.h:67
Filter definition.
Definition: avfilter.h:142
uint64_t out_channel
layout describing the output channel
Definition: af_channelmap.c:42
const char * name
Filter name.
Definition: avfilter.h:146
const VDPAUPixFmtMap * map
AVFilterLink ** outputs
array of pointers to output links
Definition: avfilter.h:317
enum MovChannelLayoutTag * layouts
Definition: mov_chan.c:434
int av_get_channel_layout_channel_index(uint64_t channel_layout, uint64_t channel)
Get the index of a channel in channel_layout.
AVFilterFormats * ff_all_samplerates(void)
Definition: formats.c:395
static int channelmap_config_input(AVFilterLink *inlink)
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:194
static const AVFilterPad avfilter_af_channelmap_inputs[]
static int get_channel_idx(char **map, int *ch, char delim, int max_ch)
Definition: af_channelmap.c:88
#define MAX_CH
Definition: af_channelmap.c:57
common internal and external API header
#define F
Definition: af_channelmap.c:70
#define av_free(p)
const char * av_get_channel_name(uint64_t channel)
Get the name of a given channel.
int len
static int get_channel(char **map, uint64_t *ch, char delim)
An instance of a filter.
Definition: avfilter.h:305
int64_t av_get_default_channel_layout(int nb_channels)
Return default channel layout for a given number of channels.
static void * av_mallocz_array(size_t nmemb, size_t size)
Definition: mem.h:229
#define av_freep(p)
static av_cold int channelmap_init(AVFilterContext *ctx)
static const AVFilterPad avfilter_af_channelmap_outputs[]
int nb_channels
int out_channel_idx
Definition: af_channelmap.c:44
internal API functions
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:227
int ff_set_common_samplerates(AVFilterContext *ctx, AVFilterFormats *samplerates)
Definition: formats.c:556