Function

CMVideoFormatDescriptionCreateForImageBuffer

Creates a format description for a video media stream contained in CVImageBuffers of the type provided.

Declaration

OSStatus CMVideoFormatDescriptionCreateForImageBuffer(CFAllocatorRef allocator, CVImageBufferRef imageBuffer, CMVideoFormatDescriptionRef  _Nullable *formatDescriptionOut);

Parameters

allocator

CFAllocator to be used when creating the CMFormatDescription. Pass NULL to use the default allocator.

imageBuffer

Image buffer for which we are creating the format description.

outDesc

On output, returns newly-created video CMFormatDescription

Return Value

A result code. Returns noErr if successful.

Discussion

This convenience function is equivalent to:

CMVideoFormatDescriptionCreate ( allocator, ( CVPixelBufferGetTypeID() == CFGetTypeID( imageBuffer ) ? CVPixelBufferGetPixelFormatType( imageBuffer ) : 0,  width of image,  height of image, extensions );
                                                

* where extensions is a CFDictionary of attachments to image buffer with keys specified by CMVideoFormatDescriptionGetExtensionKeysCommonWithImageBuffers, and also kCMFormatDescriptionExtension_BytesPerRow if applicable.

See Also

Video-Specific Functions

CMVideoFormatDescriptionCreate

Creates a format description for a video media stream.

CMVideoFormatDescriptionGetCleanAperture

Returns the clean aperture.

CMVideoFormatDescriptionGetDimensions

Returns the video dimensions (in encoded pixels).

CMVideoFormatDescriptionGetExtensionKeysCommonWithImageBuffers

Returns an array of the keys that are used both as CMVideoFormatDescription extensions and CVImageBuffer attachments and attributes.

CMVideoFormatDescriptionGetPresentationDimensions

Returns the dimensions, adjusted to take pixel aspect ratio and/or clean aperture into account.

CMVideoFormatDescriptionMatchesImageBuffer

Checks to see if a given format description matches an image buffer.

CMVideoFormatDescriptionCreateFromH264ParameterSets

Creates a format description for a video media stream described by H.264 parameter set NAL units.

CMVideoFormatDescriptionGetH264ParameterSetAtIndex

Returns a parameter set contained in a H.264 format description.

CMVideoFormatDescriptionCopyAsBigEndianImageDescriptionBlockBuffer

Copies the contents of a CMVideoFormatDescription to a CMBlockBuffer in big-endian byte ordering.

CMVideoFormatDescriptionCreateFromBigEndianImageDescriptionBlockBuffer

Creates a CMVideoFormatDescription from a big-endian ImageDescription data structure in a CMBlockBuffer.

CMVideoFormatDescriptionCreateFromBigEndianImageDescriptionData

Creates a CMVideoFormatDescription from a big-endian ImageDescription data structure.

CMSwapBigEndianImageDescriptionToHost

Converts an ImageDescription data structure from big-endian to host-endian in place.

CMSwapHostEndianImageDescriptionToBig

Converts an ImageDescription data structure from host-endian to big-endian in place.