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->framerate = (AVRational){ 0, 1 };
50  par->profile = AV_PROFILE_UNKNOWN;
51  par->level = AV_LEVEL_UNKNOWN;
52 }
53 
54 AVCodecParameters *avcodec_parameters_alloc(void)
55 {
56  AVCodecParameters *par = av_mallocz(sizeof(*par));
57 
58  if (!par)
59  return NULL;
60  codec_parameters_reset(par);
61  return par;
62 }
63 
64 void avcodec_parameters_free(AVCodecParameters **ppar)
65 {
66  AVCodecParameters *par = *ppar;
67 
68  if (!par)
69  return;
70  codec_parameters_reset(par);
71 
72  av_freep(ppar);
73 }
74 
75 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
76 {
77  int ret;
78 
79  codec_parameters_reset(dst);
80  memcpy(dst, src, sizeof(*dst));
81 
82  dst->ch_layout = (AVChannelLayout){0};
83  dst->extradata = NULL;
84  dst->extradata_size = 0;
85  if (src->extradata) {
86  dst->extradata = av_mallocz(src->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
87  if (!dst->extradata)
88  return AVERROR(ENOMEM);
89  memcpy(dst->extradata, src->extradata, src->extradata_size);
90  dst->extradata_size = src->extradata_size;
91  }
92 
93  ret = av_channel_layout_copy(&dst->ch_layout, &src->ch_layout);
94  if (ret < 0)
95  return ret;
96 
97  return 0;
98 }
99 
100 int avcodec_parameters_from_context(AVCodecParameters *par,
101  const AVCodecContext *codec)
102 {
103  int ret;
104 
105  codec_parameters_reset(par);
106 
107  par->codec_type = codec->codec_type;
108  par->codec_id = codec->codec_id;
109  par->codec_tag = codec->codec_tag;
110 
111  par->bit_rate = codec->bit_rate;
112  par->bits_per_coded_sample = codec->bits_per_coded_sample;
113  par->bits_per_raw_sample = codec->bits_per_raw_sample;
114  par->profile = codec->profile;
115  par->level = codec->level;
116 
117  switch (par->codec_type) {
118  case AVMEDIA_TYPE_VIDEO:
119  par->format = codec->pix_fmt;
120  par->width = codec->width;
121  par->height = codec->height;
122  par->field_order = codec->field_order;
123  par->color_range = codec->color_range;
124  par->color_primaries = codec->color_primaries;
125  par->color_trc = codec->color_trc;
126  par->color_space = codec->colorspace;
127  par->chroma_location = codec->chroma_sample_location;
128  par->sample_aspect_ratio = codec->sample_aspect_ratio;
129  par->video_delay = codec->has_b_frames;
130  par->framerate = codec->framerate;
131  break;
132  case AVMEDIA_TYPE_AUDIO:
133  par->format = codec->sample_fmt;
134 #if FF_API_OLD_CHANNEL_LAYOUT
135 FF_DISABLE_DEPRECATION_WARNINGS
136  // if the old/new fields are set inconsistently, prefer the old ones
137  if ((codec->channels && codec->channels != codec->ch_layout.nb_channels) ||
138  (codec->channel_layout && (codec->ch_layout.order != AV_CHANNEL_ORDER_NATIVE ||
139  codec->ch_layout.u.mask != codec->channel_layout))) {
140  if (codec->channel_layout)
141  av_channel_layout_from_mask(&par->ch_layout, codec->channel_layout);
142  else {
143  par->ch_layout.order = AV_CHANNEL_ORDER_UNSPEC;
144  par->ch_layout.nb_channels = codec->channels;
145  }
146 FF_ENABLE_DEPRECATION_WARNINGS
147  } else {
148 #endif
149  ret = av_channel_layout_copy(&par->ch_layout, &codec->ch_layout);
150  if (ret < 0)
151  return ret;
152 #if FF_API_OLD_CHANNEL_LAYOUT
153 FF_DISABLE_DEPRECATION_WARNINGS
154  }
155  par->channel_layout = par->ch_layout.order == AV_CHANNEL_ORDER_NATIVE ?
156  par->ch_layout.u.mask : 0;
157  par->channels = par->ch_layout.nb_channels;
158 FF_ENABLE_DEPRECATION_WARNINGS
159 #endif
160  par->sample_rate = codec->sample_rate;
161  par->block_align = codec->block_align;
162  par->frame_size = codec->frame_size;
163  par->initial_padding = codec->initial_padding;
164  par->trailing_padding = codec->trailing_padding;
165  par->seek_preroll = codec->seek_preroll;
166  break;
167  case AVMEDIA_TYPE_SUBTITLE:
168  par->width = codec->width;
169  par->height = codec->height;
170  break;
171  }
172 
173  if (codec->extradata) {
174  par->extradata = av_mallocz(codec->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
175  if (!par->extradata)
176  return AVERROR(ENOMEM);
177  memcpy(par->extradata, codec->extradata, codec->extradata_size);
178  par->extradata_size = codec->extradata_size;
179  }
180 
181  return 0;
182 }
183 
184 int avcodec_parameters_to_context(AVCodecContext *codec,
185  const AVCodecParameters *par)
186 {
187  int ret;
188 
189  codec->codec_type = par->codec_type;
190  codec->codec_id = par->codec_id;
191  codec->codec_tag = par->codec_tag;
192 
193  codec->bit_rate = par->bit_rate;
194  codec->bits_per_coded_sample = par->bits_per_coded_sample;
195  codec->bits_per_raw_sample = par->bits_per_raw_sample;
196  codec->profile = par->profile;
197  codec->level = par->level;
198 
199  switch (par->codec_type) {
200  case AVMEDIA_TYPE_VIDEO:
201  codec->pix_fmt = par->format;
202  codec->width = par->width;
203  codec->height = par->height;
204  codec->field_order = par->field_order;
205  codec->color_range = par->color_range;
206  codec->color_primaries = par->color_primaries;
207  codec->color_trc = par->color_trc;
208  codec->colorspace = par->color_space;
209  codec->chroma_sample_location = par->chroma_location;
210  codec->sample_aspect_ratio = par->sample_aspect_ratio;
211  codec->has_b_frames = par->video_delay;
212  codec->framerate = par->framerate;
213  break;
214  case AVMEDIA_TYPE_AUDIO:
215  codec->sample_fmt = par->format;
216 #if FF_API_OLD_CHANNEL_LAYOUT
217 FF_DISABLE_DEPRECATION_WARNINGS
218  // if the old/new fields are set inconsistently, prefer the old ones
219  if ((par->channels && par->channels != par->ch_layout.nb_channels) ||
220  (par->channel_layout && (par->ch_layout.order != AV_CHANNEL_ORDER_NATIVE ||
221  par->ch_layout.u.mask != par->channel_layout))) {
222  if (par->channel_layout)
223  av_channel_layout_from_mask(&codec->ch_layout, par->channel_layout);
224  else {
225  codec->ch_layout.order = AV_CHANNEL_ORDER_UNSPEC;
226  codec->ch_layout.nb_channels = par->channels;
227  }
228 FF_ENABLE_DEPRECATION_WARNINGS
229  } else {
230 #endif
231  ret = av_channel_layout_copy(&codec->ch_layout, &par->ch_layout);
232  if (ret < 0)
233  return ret;
234 #if FF_API_OLD_CHANNEL_LAYOUT
235 FF_DISABLE_DEPRECATION_WARNINGS
236  }
237  codec->channel_layout = codec->ch_layout.order == AV_CHANNEL_ORDER_NATIVE ?
238  codec->ch_layout.u.mask : 0;
239  codec->channels = codec->ch_layout.nb_channels;
240 FF_ENABLE_DEPRECATION_WARNINGS
241 #endif
242  codec->sample_rate = par->sample_rate;
243  codec->block_align = par->block_align;
244  codec->frame_size = par->frame_size;
245  codec->delay =
246  codec->initial_padding = par->initial_padding;
247  codec->trailing_padding = par->trailing_padding;
248  codec->seek_preroll = par->seek_preroll;
249  break;
250  case AVMEDIA_TYPE_SUBTITLE:
251  codec->width = par->width;
252  codec->height = par->height;
253  break;
254  }
255 
256  av_freep(&codec->extradata);
257  if (par->extradata) {
258  codec->extradata = av_mallocz(par->extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
259  if (!codec->extradata)
260  return AVERROR(ENOMEM);
261  memcpy(codec->extradata, par->extradata, par->extradata_size);
262  codec->extradata_size = par->extradata_size;
263  }
264 
265  return 0;
266 }
AVCodecContext::frame_size
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1088
FF_ENABLE_DEPRECATION_WARNINGS
#define FF_ENABLE_DEPRECATION_WARNINGS
Definition: internal.h:73
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:1025
AVCodecContext::sample_rate
int sample_rate
samples per second
Definition: avcodec.h:1060
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:100
AVCodecContext::color_trc
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:1018
AVCodecContext::field_order
enum AVFieldOrder field_order
Field order.
Definition: avcodec.h:1057
AVCodecParameters::seek_preroll
int seek_preroll
Audio only.
Definition: codec_par.h:208
AVCOL_TRC_UNSPECIFIED
@ AVCOL_TRC_UNSPECIFIED
Definition: pixfmt.h:569
AVCodecParameters::framerate
AVRational framerate
Video only.
Definition: codec_par.h:225
AVCodecParameters::codec_tag
uint32_t codec_tag
Additional information about the codec (corresponds to the AVI FOURCC).
Definition: codec_par.h:66
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:600
AVChannelLayout::u
union AVChannelLayout::@331 u
Details about which channels are present in this layout.
AVCodecParameters::color_primaries
enum AVColorPrimaries color_primaries
Definition: codec_par.h:149
AVCodecContext::framerate
AVRational framerate
Definition: avcodec.h:1797
AVCodecContext::ch_layout
AVChannelLayout ch_layout
Audio channel layout.
Definition: avcodec.h:2101
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:1788
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:1011
AV_PROFILE_UNKNOWN
#define AV_PROFILE_UNKNOWN
Definition: defs.h:65
AVCodecParameters::frame_size
int frame_size
Audio only.
Definition: codec_par.h:189
AVCodecContext::extradata_size
int extradata_size
Definition: avcodec.h:539
AVCodecContext::has_b_frames
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition: avcodec.h:740
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:395
AVCodecContext::bits_per_raw_sample
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition: avcodec.h:1513
AVCOL_PRI_UNSPECIFIED
@ AVCOL_PRI_UNSPECIFIED
Definition: pixfmt.h:544
AVCodecContext::codec_id
enum AVCodecID codec_id
Definition: avcodec.h:447
NULL
#define NULL
Definition: coverity.c:32
AVCodecContext::color_range
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition: avcodec.h:1035
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:64
AV_LEVEL_UNKNOWN
#define AV_LEVEL_UNKNOWN
Definition: defs.h:196
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:487
AVCodecContext::trailing_padding
int trailing_padding
Audio only.
Definition: avcodec.h:1945
AVCodecParameters::ch_layout
AVChannelLayout ch_layout
Audio only.
Definition: codec_par.h:213
AVCodecContext::level
int level
level
Definition: avcodec.h:1734
AVCOL_RANGE_UNSPECIFIED
@ AVCOL_RANGE_UNSPECIFIED
Definition: pixfmt.h:635
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:1076
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:689
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:54
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1506
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:538
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:184
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:1042
AVCodecParameters::color_range
enum AVColorRange color_range
Video only.
Definition: codec_par.h:148
AVCOL_SPC_UNSPECIFIED
@ AVCOL_SPC_UNSPECIFIED
Definition: pixfmt.h:598
AVCodecContext::height
int height
Definition: avcodec.h:617
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:654
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:1109
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:437
AVCodecContext::profile
int profile
profile
Definition: avcodec.h:1592
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:636
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:643
FF_DISABLE_DEPRECATION_WARNINGS
#define FF_DISABLE_DEPRECATION_WARNINGS
Definition: internal.h:72
AVCodecContext::codec_type
enum AVMediaType codec_type
Definition: avcodec.h:445
AVCodecContext::seek_preroll
int seek_preroll
Number of samples to skip after a discontinuity.
Definition: avcodec.h:1868
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:462
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:617
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:818
avcodec_parameters_copy
int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src)
Copy the contents of src to dst.
Definition: codec_par.c:75
Generated on Sat Sep 23 2023 19:21:20 for FFmpeg by   doxygen 1.8.17