FFmpeg
hwcontext_videotoolbox.h
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 #ifndef AVUTIL_HWCONTEXT_VIDEOTOOLBOX_H
20 #define AVUTIL_HWCONTEXT_VIDEOTOOLBOX_H
21 
22 #include <stdint.h>
23 
24 #include <VideoToolbox/VideoToolbox.h>
25 
26 #include "frame.h"
27 #include "pixfmt.h"
28 
29 /**
30  * @file
31  * An API-specific header for AV_HWDEVICE_TYPE_VIDEOTOOLBOX.
32  *
33  * This API supports frame allocation using a native CVPixelBufferPool
34  * instead of an AVBufferPool.
35  *
36  * If the API user sets a custom pool, AVHWFramesContext.pool must return
37  * AVBufferRefs whose data pointer is a CVImageBufferRef or CVPixelBufferRef.
38  * Note that the underlying CVPixelBuffer could be retained by OS frameworks
39  * depending on application usage, so it is preferable to let CoreVideo manage
40  * the pool using the default implementation.
41  *
42  * Currently AVHWDeviceContext.hwctx are always NULL.
43  */
44 
45 typedef struct AVVTFramesContext {
48 
49 /**
50  * Convert a VideoToolbox (actually CoreVideo) format to AVPixelFormat.
51  * Returns AV_PIX_FMT_NONE if no known equivalent was found.
52  */
54 
55 /**
56  * Convert an AVPixelFormat to a VideoToolbox (actually CoreVideo) format.
57  * Returns 0 if no known equivalent was found.
58  */
60 
61 /**
62  * Same as av_map_videotoolbox_format_from_pixfmt function, but can map and
63  * return full range pixel formats via a flag.
64  */
66 
67 /**
68  * Convert an AVChromaLocation to a VideoToolbox/CoreVideo chroma location string.
69  * Returns 0 if no known equivalent was found.
70  */
72 
73 /**
74  * Convert an AVColorSpace to a VideoToolbox/CoreVideo color matrix string.
75  * Returns 0 if no known equivalent was found.
76  */
78 
79 /**
80  * Convert an AVColorPrimaries to a VideoToolbox/CoreVideo color primaries string.
81  * Returns 0 if no known equivalent was found.
82  */
84 
85 /**
86  * Convert an AVColorTransferCharacteristic to a VideoToolbox/CoreVideo color transfer
87  * function string.
88  * Returns 0 if no known equivalent was found.
89  */
91 
92 /**
93  * Update a CVPixelBufferRef's metadata to based on an AVFrame.
94  * Returns 0 if no known equivalent was found.
95  */
96 int av_vt_pixbuf_set_attachments(void *log_ctx,
97  CVPixelBufferRef pixbuf, const struct AVFrame *src);
98 
99 #endif /* AVUTIL_HWCONTEXT_VIDEOTOOLBOX_H */
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
space
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated space
Definition: undefined.txt:4
av_map_videotoolbox_format_from_pixfmt
uint32_t av_map_videotoolbox_format_from_pixfmt(enum AVPixelFormat pix_fmt)
Convert an AVPixelFormat to a VideoToolbox (actually CoreVideo) format.
Definition: hwcontext_videotoolbox.c:167
AVColorTransferCharacteristic
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:584
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
AVColorPrimaries
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:559
full_range
bool full_range
Definition: hwcontext_videotoolbox.c:42
pix_fmt
static enum AVPixelFormat pix_fmt
Definition: demux_decode.c:41
av_map_videotoolbox_format_to_pixfmt
enum AVPixelFormat av_map_videotoolbox_format_to_pixfmt(uint32_t cv_fmt)
Convert a VideoToolbox (actually CoreVideo) format to AVPixelFormat.
Definition: hwcontext_videotoolbox.c:138
AVVTFramesContext
Definition: hwcontext_videotoolbox.h:45
av_map_videotoolbox_color_trc_from_av
CFStringRef av_map_videotoolbox_color_trc_from_av(enum AVColorTransferCharacteristic trc)
Convert an AVColorTransferCharacteristic to a VideoToolbox/CoreVideo color transfer function string.
Definition: hwcontext_videotoolbox.c:479
av_map_videotoolbox_chroma_loc_from_av
CFStringRef av_map_videotoolbox_chroma_loc_from_av(enum AVChromaLocation loc)
Convert an AVChromaLocation to a VideoToolbox/CoreVideo chroma location string.
Definition: hwcontext_videotoolbox.c:391
cv_fmt
uint32_t cv_fmt
Definition: hwcontext_videotoolbox.c:41
AVVTFramesContext::color_range
enum AVColorRange color_range
Definition: hwcontext_videotoolbox.h:46
av_map_videotoolbox_color_matrix_from_av
CFStringRef av_map_videotoolbox_color_matrix_from_av(enum AVColorSpace space)
Convert an AVColorSpace to a VideoToolbox/CoreVideo color matrix string.
Definition: hwcontext_videotoolbox.c:427
av_map_videotoolbox_format_from_pixfmt2
uint32_t av_map_videotoolbox_format_from_pixfmt2(enum AVPixelFormat pix_fmt, bool full_range)
Same as av_map_videotoolbox_format_from_pixfmt function, but can map and return full range pixel form...
Definition: hwcontext_videotoolbox.c:172
av_vt_pixbuf_set_attachments
int av_vt_pixbuf_set_attachments(void *log_ctx, CVPixelBufferRef pixbuf, const struct AVFrame *src)
Update a CVPixelBufferRef's metadata to based on an AVFrame.
av_map_videotoolbox_color_primaries_from_av
CFStringRef av_map_videotoolbox_color_primaries_from_av(enum AVColorPrimaries pri)
Convert an AVColorPrimaries to a VideoToolbox/CoreVideo color primaries string.
Definition: hwcontext_videotoolbox.c:454
frame.h
AVChromaLocation
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:706
AVColorSpace
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:613
pixfmt.h
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
AVColorRange
AVColorRange
Visual content value range.
Definition: pixfmt.h:652