FFmpeg
codec_par.c
Go to the documentation of this file.
1 /*
2  * AVCodecParameters functions for libavcodec
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  * AVCodecParameters functions for libavcodec.
24  */
25 
26 #include <string.h>
27 #include "libavutil/mem.h"
28 #include "avcodec.h"
29 #include "codec_par.h"
30 
31 static void codec_parameters_reset(AVCodecParameters *par)
32 {
33  av_freep(&par->extradata);
34  av_channel_layout_uninit(&par->ch_layout);
35 
36  memset(par, 0, sizeof(*par));
37 
38  par->codec_type = AVMEDIA_TYPE_UNKNOWN;
39  par->codec_id = AV_CODEC_ID_NONE;
40  par->format = -1;
41  par->ch_layout.order = AV_CHANNEL_ORDER_UNSPEC;
42  par->field_order = AV_FIELD_UNKNOWN;
43  par->color_range = AVCOL_RANGE_UNSPECIFIED;
44  par->color_primaries = AVCOL_PRI_UNSPECIFIED;
45  par->color_trc = AVCOL_TRC_UNSPECIFIED;
46  par->color_space = AVCOL_SPC_UNSPECIFIED;
47  par->chroma_location = AVCHROMA_LOC_UNSPECIFIED;
48  par->sample_aspect_ratio = (AVRational){ 0, 1 };
49  par->profile = FF_PROFILE_UNKNOWN;
50  par->level = FF_LEVEL_UNKNOWN;
51 }
52 
53 AVCodecParameters *avcodec_parameters_alloc(void)
54 {
55  AVCodecParameters *par = av_mallocz(sizeof(*par));
56 
57  if (!par)
58  return NULL;
59  codec_parameters_reset(par);
60  return par;
61 }
62 
63 void avcodec_parameters_free(AVCodecParameters **ppar)
64 {
65  AVCodecParameters *par = *ppar;
66 
67  if (!par)
68  return;
69  codec_parameters_reset(par);
70 
71  av_freep(ppar);
72 }
73 
74 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
75 {
76  int ret;
77 
78  codec_parameters_reset(dst);
79  memcpy(dst, src, sizeof(*dst));
80 
81  dst->ch_layout = (AVChannelLayout){0};
82  dst->extradata = NULL;
83  dst->extradata_size = 0;
84  if (src->extradata) {
85  dst->extradata = av_mallocz(src->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
86  if (!dst->extradata)
87  return AVERROR(ENOMEM);
88  memcpy(dst->extradata, src->extradata, src->extradata_size);
89  dst->extradata_size = src->extradata_size;
90  }
91 
92  ret = av_channel_layout_copy(&dst->ch_layout, &src->ch_layout);
93  if (ret < 0)
94  return ret;
95 
96  return 0;
97 }
98 
99 int avcodec_parameters_from_context(AVCodecParameters *par,
100  const AVCodecContext *codec)
101 {
102  int ret;
103 
104  codec_parameters_reset(par);
105 
106  par->codec_type = codec->codec_type;
107  par->codec_id = codec->codec_id;
108  par->codec_tag = codec->codec_tag;
109 
110  par->bit_rate = codec->bit_rate;
111  par->bits_per_coded_sample = codec->bits_per_coded_sample;
112  par->bits_per_raw_sample = codec->bits_per_raw_sample;
113  par->profile = codec->profile;
114  par->level = codec->level;
115 
116  switch (par->codec_type) {
117  case AVMEDIA_TYPE_VIDEO:
118  par->format = codec->pix_fmt;
119  par->width = codec->width;
120  par->height = codec->height;
121  par->field_order = codec->field_order;
122  par->color_range = codec->color_range;
123  par->color_primaries = codec->color_primaries;
124  par->color_trc = codec->color_trc;
125  par->color_space = codec->colorspace;
126  par->chroma_location = codec->chroma_sample_location;
127  par->sample_aspect_ratio = codec->sample_aspect_ratio;
128  par->video_delay = codec->has_b_frames;
129  break;
130  case AVMEDIA_TYPE_AUDIO:
131  par->format = codec->sample_fmt;
132 #if FF_API_OLD_CHANNEL_LAYOUT
133 FF_DISABLE_DEPRECATION_WARNINGS
134  // if the old/new fields are set inconsistently, prefer the old ones
135  if ((codec->channels && codec->channels != codec->ch_layout.nb_channels) ||
136  (codec->channel_layout && (codec->ch_layout.order != AV_CHANNEL_ORDER_NATIVE ||
137  codec->ch_layout.u.mask != codec->channel_layout))) {
138  if (codec->channel_layout)
139  av_channel_layout_from_mask(&par->ch_layout, codec->channel_layout);
140  else {
141  par->ch_layout.order = AV_CHANNEL_ORDER_UNSPEC;
142  par->ch_layout.nb_channels = codec->channels;
143  }
144 FF_ENABLE_DEPRECATION_WARNINGS
145  } else {
146 #endif
147  ret = av_channel_layout_copy(&par->ch_layout, &codec->ch_layout);
148  if (ret < 0)
149  return ret;
150 #if FF_API_OLD_CHANNEL_LAYOUT
151 FF_DISABLE_DEPRECATION_WARNINGS
152  }
153  par->channel_layout = par->ch_layout.order == AV_CHANNEL_ORDER_NATIVE ?
154  par->ch_layout.u.mask : 0;
155  par->channels = par->ch_layout.nb_channels;
156 FF_ENABLE_DEPRECATION_WARNINGS
157 #endif
158  par->sample_rate = codec->sample_rate;
159  par->block_align = codec->block_align;
160  par->frame_size = codec->frame_size;
161  par->initial_padding = codec->initial_padding;
162  par->trailing_padding = codec->trailing_padding;
163  par->seek_preroll = codec->seek_preroll;
164  break;
165  case AVMEDIA_TYPE_SUBTITLE:
166  par->width = codec->width;
167  par->height = codec->height;
168  break;
169  }
170 
171  if (codec->extradata) {
172  par->extradata = av_mallocz(codec->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
173  if (!par->extradata)
174  return AVERROR(ENOMEM);
175  memcpy(par->extradata, codec->extradata, codec->extradata_size);
176  par->extradata_size = codec->extradata_size;
177  }
178 
179  return 0;
180 }
181 
182 int avcodec_parameters_to_context(AVCodecContext *codec,
183  const AVCodecParameters *par)
184 {
185  int ret;
186 
187  codec->codec_type = par->codec_type;
188  codec->codec_id = par->codec_id;
189  codec->codec_tag = par->codec_tag;
190 
191  codec->bit_rate = par->bit_rate;
192  codec->bits_per_coded_sample = par->bits_per_coded_sample;
193  codec->bits_per_raw_sample = par->bits_per_raw_sample;
194  codec->profile = par->profile;
195  codec->level = par->level;
196 
197  switch (par->codec_type) {
198  case AVMEDIA_TYPE_VIDEO:
199  codec->pix_fmt = par->format;
200  codec->width = par->width;
201  codec->height = par->height;
202  codec->field_order = par->field_order;
203  codec->color_range = par->color_range;
204  codec->color_primaries = par->color_primaries;
205  codec->color_trc = par->color_trc;
206  codec->colorspace = par->color_space;
207  codec->chroma_sample_location = par->chroma_location;
208  codec->sample_aspect_ratio = par->sample_aspect_ratio;
209  codec->has_b_frames = par->video_delay;
210  break;
211  case AVMEDIA_TYPE_AUDIO:
212  codec->sample_fmt = par->format;
213 #if FF_API_OLD_CHANNEL_LAYOUT
214 FF_DISABLE_DEPRECATION_WARNINGS
215  // if the old/new fields are set inconsistently, prefer the old ones
216  if ((par->channels && par->channels != par->ch_layout.nb_channels) ||
217  (par->channel_layout && (par->ch_layout.order != AV_CHANNEL_ORDER_NATIVE ||
218  par->ch_layout.u.mask != par->channel_layout))) {
219  if (par->channel_layout)
220  av_channel_layout_from_mask(&codec->ch_layout, par->channel_layout);
221  else {
222  codec->ch_layout.order = AV_CHANNEL_ORDER_UNSPEC;
223  codec->ch_layout.nb_channels = par->channels;
224  }
225 FF_ENABLE_DEPRECATION_WARNINGS
226  } else {
227 #endif
228  ret = av_channel_layout_copy(&codec->ch_layout, &par->ch_layout);
229  if (ret < 0)
230  return ret;
231 #if FF_API_OLD_CHANNEL_LAYOUT
232 FF_DISABLE_DEPRECATION_WARNINGS
233  }
234  codec->channel_layout = codec->ch_layout.order == AV_CHANNEL_ORDER_NATIVE ?
235  codec->ch_layout.u.mask : 0;
236  codec->channels = codec->ch_layout.nb_channels;
237 FF_ENABLE_DEPRECATION_WARNINGS
238 #endif
239  codec->sample_rate = par->sample_rate;
240  codec->block_align = par->block_align;
241  codec->frame_size = par->frame_size;
242  codec->delay =
243  codec->initial_padding = par->initial_padding;
244  codec->trailing_padding = par->trailing_padding;
245  codec->seek_preroll = par->seek_preroll;
246  break;
247  case AVMEDIA_TYPE_SUBTITLE:
248  codec->width = par->width;
249  codec->height = par->height;
250  break;
251  }
252 
253  if (par->extradata) {
254  av_freep(&codec->extradata);
255  codec->extradata = av_mallocz(par->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
256  if (!codec->extradata)
257  return AVERROR(ENOMEM);
258  memcpy(codec->extradata, par->extradata, par->extradata_size);
259  codec->extradata_size = par->extradata_size;
260  }
261 
262  return 0;
263 }
AVCodecContext::frame_size
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1062
FF_ENABLE_DEPRECATION_WARNINGS
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:82
AVMEDIA_TYPE_SUBTITLE
@ AVMEDIA_TYPE_SUBTITLE
Definition: avutil.h:204
AVCodecParameters::extradata
uint8_t * extradata
Extra binary data needed for initializing the decoder, codec-dependent.
Definition: codec_par.h:76
AVERROR
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
AVCodecParameters::codec_type
enum AVMediaType codec_type
General type of the encoded data.
Definition: codec_par.h:58
AVCodecContext::colorspace
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:1002
AVCodecContext::sample_rate
int sample_rate
samples per second
Definition: avcodec.h:1034
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:54
AVCodecParameters::color_space
enum AVColorSpace color_space
Definition: codec_par.h:151
avcodec_parameters_from_context
int avcodec_parameters_from_context(AVCodecParameters *par, const AVCodecContext *codec)
Fill the parameters struct based on the values from the supplied codec context.
Definition: codec_par.c:99
AVCodecContext::color_trc
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:995
AVCodecContext::field_order
enum AVFieldOrder field_order
Field order.
Definition: avcodec.h:1031
AVCodecParameters::seek_preroll
int seek_preroll
Audio only.
Definition: codec_par.h:208
AVCOL_TRC_UNSPECIFIED
@ AVCOL_TRC_UNSPECIFIED
Definition: pixfmt.h:561
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:66
FF_LEVEL_UNKNOWN
#define FF_LEVEL_UNKNOWN
Definition: avcodec.h:1692
AVChannelLayout::order
enum AVChannelOrder order
Channel order used in this layout.
Definition: channel_layout.h:306
AVChannelLayout::mask
uint64_t mask
This member must be used for AV_CHANNEL_ORDER_NATIVE, and may be used for AV_CHANNEL_ORDER_AMBISONIC ...
Definition: channel_layout.h:333
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:311
AVCodecContext::delay
int delay
Codec delay.
Definition: avcodec.h:581
AVCodecParameters::color_primaries
enum AVColorPrimaries color_primaries
Definition: codec_par.h:149
AVCodecContext::ch_layout
AVChannelLayout ch_layout
Audio channel layout.
Definition: avcodec.h:2054
AVCodecParameters::bits_per_raw_sample
int bits_per_raw_sample
This is the number of valid bits in each output sample.
Definition: codec_par.h:117
AVCodecContext::initial_padding
int initial_padding
Audio only.
Definition: avcodec.h:1741
AV_FIELD_UNKNOWN
@ AV_FIELD_UNKNOWN
Definition: codec_par.h:39
AVCodecParameters::color_trc
enum AVColorTransferCharacteristic color_trc
Definition: codec_par.h:150
AVCodecContext::color_primaries
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition: avcodec.h:988
AVCodecParameters::frame_size
int frame_size
Audio only.
Definition: codec_par.h:189
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:528
AVCodecContext::has_b_frames
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition: avcodec.h:721
AVCodecParameters::sample_aspect_ratio
AVRational sample_aspect_ratio
Video only.
Definition: codec_par.h:138
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AVCodecParameters::width
int width
Video only.
Definition: codec_par.h:128
AV_CHANNEL_ORDER_UNSPEC
@ AV_CHANNEL_ORDER_UNSPEC
Only the channel count is specified, without any further information about the channel order.
Definition: channel_layout.h:112
av_channel_layout_from_mask
FF_ENABLE_DEPRECATION_WARNINGS int av_channel_layout_from_mask(AVChannelLayout *channel_layout, uint64_t mask)
Initialize a native channel layout from a bitmask indicating which channels are present.
Definition: channel_layout.c:391
FF_PROFILE_UNKNOWN
#define FF_PROFILE_UNKNOWN
Definition: avcodec.h:1566
AVCodecContext::bits_per_raw_sample
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition: avcodec.h:1487
AVCOL_PRI_UNSPECIFIED
@ AVCOL_PRI_UNSPECIFIED
Definition: pixfmt.h:536
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:436
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:1009
avcodec_parameters_free
void avcodec_parameters_free(AVCodecParameters **ppar)
Free an AVCodecParameters instance and everything associated with it and write NULL to the supplied p...
Definition: codec_par.c:63
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVCodecContext::bit_rate
int64_t bit_rate
the average bitrate
Definition: avcodec.h:476
AVCodecContext::trailing_padding
int trailing_padding
Audio only.
Definition: avcodec.h:1898
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:213
AVCodecContext::level
int level
level
Definition: avcodec.h:1691
AVCOL_RANGE_UNSPECIFIED
@ AVCOL_RANGE_UNSPECIFIED
Definition: pixfmt.h:627
AVCodecParameters::level
int level
Definition: codec_par.h:123
AVCodecParameters::sample_rate
int sample_rate
Audio only.
Definition: codec_par.h:178
AVCodecParameters::extradata_size
int extradata_size
Size of the extradata content in bytes.
Definition: codec_par.h:80
AVChannelLayout
An AVChannelLayout holds information about the channel layout of audio data.
Definition: channel_layout.h:301
AVCodecContext::sample_fmt
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1050
AVCodecParameters::profile
int profile
Codec-specific bitstream restrictions that the stream conforms to.
Definition: codec_par.h:122
AVCHROMA_LOC_UNSPECIFIED
@ AVCHROMA_LOC_UNSPECIFIED
Definition: pixfmt.h:681
AVMEDIA_TYPE_UNKNOWN
@ AVMEDIA_TYPE_UNKNOWN
Usually treated as AVMEDIA_TYPE_DATA.
Definition: avutil.h:200
AV_CHANNEL_ORDER_NATIVE
@ AV_CHANNEL_ORDER_NATIVE
The native channel order, i.e.
Definition: channel_layout.h:118
codec_parameters_reset
static void codec_parameters_reset(AVCodecParameters *par)
Definition: codec_par.c:31
avcodec_parameters_alloc
AVCodecParameters * avcodec_parameters_alloc(void)
Allocate a new AVCodecParameters and set its fields to default values (unknown/invalid/0).
Definition: codec_par.c:53
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1480
AV_CODEC_ID_NONE
@ AV_CODEC_ID_NONE
Definition: codec_id.h:50
AVCodecContext::extradata
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:527
AVCodecParameters::height
int height
Definition: codec_par.h:129
avcodec_parameters_to_context
int avcodec_parameters_to_context(AVCodecContext *codec, const AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
Definition: codec_par.c:182
AVCodecParameters::block_align
int block_align
Audio only.
Definition: codec_par.h:185
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:254
AVCodecContext::chroma_sample_location
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition: avcodec.h:1016
AVCodecParameters::color_range
enum AVColorRange color_range
Video only.
Definition: codec_par.h:148
AVCOL_SPC_UNSPECIFIED
@ AVCOL_SPC_UNSPECIFIED
Definition: pixfmt.h:590
AVCodecContext::height
int height
Definition: avcodec.h:598
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:635
AVCodecParameters::field_order
enum AVFieldOrder field_order
Video only.
Definition: codec_par.h:143
avcodec.h
ret
ret
Definition: filter_design.txt:187
AVCodecContext::block_align
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs.
Definition: avcodec.h:1083
AV_INPUT_BUFFER_PADDING_SIZE
#define AV_INPUT_BUFFER_PADDING_SIZE
Definition: defs.h:40
AVCodecParameters::chroma_location
enum AVChromaLocation chroma_location
Definition: codec_par.h:152
AVCodecParameters::trailing_padding
int trailing_padding
Audio only.
Definition: codec_par.h:204
AVCodecContext
main external API structure.
Definition: avcodec.h:426
AVCodecContext::profile
int profile
profile
Definition: avcodec.h:1565
av_channel_layout_uninit
void av_channel_layout_uninit(AVChannelLayout *channel_layout)
Free any allocated data in the channel layout and reset the channel count to 0.
Definition: channel_layout.c:632
av_channel_layout_copy
int av_channel_layout_copy(AVChannelLayout *dst, const AVChannelLayout *src)
Make a copy of a channel layout.
Definition: channel_layout.c:639
FF_DISABLE_DEPRECATION_WARNINGS
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:81
AVCodecContext::codec_type
enum AVMediaType codec_type
Definition: avcodec.h:434
AVCodecContext::seek_preroll
int seek_preroll
Number of samples to skip after a discontinuity.
Definition: avcodec.h:1821
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AVCodecParameters::bits_per_coded_sample
int bits_per_coded_sample
The number of bits per sample in the codedwords.
Definition: codec_par.h:104
mem.h
AVCodecParameters::video_delay
int video_delay
Video only.
Definition: codec_par.h:157
AVCodecParameters::format
int format
Definition: codec_par.h:86
AVCodecContext::codec_tag
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition: avcodec.h:451
codec_par.h
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:62
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:598
AVChannelLayout::u
union AVChannelLayout::@314 u
Details about which channels are present in this layout.
AVCodecParameters::bit_rate
int64_t bit_rate
The average bitrate of the encoded data (in bits per second).
Definition: codec_par.h:91
AVCodecParameters::initial_padding
int initial_padding
Audio only.
Definition: codec_par.h:197
AVCodecContext::sample_aspect_ratio
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel.
Definition: avcodec.h:795
avcodec_parameters_copy
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
Definition: codec_par.c:74
Generated on Tue Feb 28 2023 21:33:11 for FFmpeg by   doxygen 1.8.17