video_frame.h

Ce fichier contient la définition du type d'une image vidéo ainsi que plusieurs déclarations de fonctions utiles pour les manipuler.

Structures de données : otc_video_frame_planar_memory_callbacks

Comprend : unistd.h, base.h, config.h

typedef otc_video_frame

Définition du type d'image vidéo.

typedef struct otc_video_frame otc_video_frame;

typedef otc_video_frame_memory_release_callback

Définition de type pour la fonction de rappel de libération de la mémoire des images vidéo.

Il s'agit d'un pointeur de fonction vers la fonction de rappel qui est appelée lorsque l'application doit libérer la mémoire occupée par une image vidéo.

typedef void(*) otc_video_frame_memory_release_callback(const uint8_t *buffer, void *arg)(const uint8_t *buffer, void *arg);

typedef video_transform_callback

Remarque : Cette fonctionnalité ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas avec le SDK Linux de la Video API Vonage.

typedef void(*) video_transform_callback(void *user_data, struct otc_video_frame *frame)(void *user_data, struct otc_video_frame *frame);

énumération otc_video_frame_format

Énumération des formats vidéo par trame.

Cette énumération regroupe plusieurs formats d'images vidéo.

Nom Valeur Description
OTC_VIDEO_FRAME_FORMAT_UNKNOWN 0 Valeur inconnue de l'énumération du format d'image vidéo.
OTC_VIDEO_FRAME_FORMAT_YUV420P 1 Valeur d'énumération du format d'image vidéo YUV420P.
OTC_VIDEO_FRAME_FORMAT_NV12 2 Valeur de l'énumération du format d'image vidéo NV12.
OTC_VIDEO_FRAME_FORMAT_NV21 3 Valeur d'énumération du format d'image vidéo NV21.
OTC_VIDEO_FRAME_FORMAT_YUY2 4 Valeur d'énumération du format d'image vidéo YUY2.
OTC_VIDEO_FRAME_FORMAT_UYVY 5 Valeur de l'énumération du format d'image vidéo UYVY.
OTC_VIDEO_FRAME_FORMAT_ARGB32 6 Valeur d'énumération du format de trame vidéo ARGB32.
OTC_VIDEO_FRAME_FORMAT_BGRA32 7 Valeur de l'énumération du format d'image vidéo BGRA32.
OTC_VIDEO_FRAME_FORMAT_RGB24 8 Valeur d'énumération du format d'image vidéo RGB24.
OTC_VIDEO_FRAME_FORMAT_ABGR32 9 Valeur d'énumération du format d'image vidéo ABGR32.
OTC_VIDEO_FRAME_FORMAT_MJPEG 10 Valeur d'énumération du format d'image vidéo MJPEG.
OTC_VIDEO_FRAME_FORMAT_RGBA32 11 Valeur d'énumération du format d'image vidéo RGBA.
OTC_VIDEO_FRAME_FORMAT_MAX Valeur maximale.
OTC_VIDEO_FRAME_FORMAT_COMPRESSED 255 Valeur d'énumération du format d'image vidéo compressée.

énumération otc_video_frame_plane

Énumération des plans vidéo d'une image vidéo.

Nom Valeur Description
OTC_VIDEO_FRAME_PLANE_Y 0 Valeur de l'énumération du plan Y d'une image vidéo.
OTC_VIDEO_FRAME_PLANE_U 1 Valeur de l'énumération « U » du plan d'image vidéo.
OTC_VIDEO_FRAME_PLANE_V 2 Valeur de l'énumération « V » du plan d'image vidéo.
OTC_VIDEO_FRAME_PLANE_PACKED 0 Valeur d'énumération du plan d'image vidéo.
OTC_VIDEO_FRAME_PLANE_UV_INTERLEAVED 1 Valeur d'énumération entrelacée UV du plan d'image vidéo.
OTC_VIDEO_FRAME_PLANE_VU_INTERLEAVED 1 Valeur d'énumération du plan de trame vidéo VU entrelacé.

Fonctions

Nom Description
otc_video_frame_get_native_handle(frame) → {void *}
otc_video_frame_new(format, width, height, buffer) → {otc_video_frame *} Crée une nouvelle image vidéo au format spécifié.
otc_video_frame_delete(frame) → {otc_status} Ressources gratuites liées à ce cadre.
otc_video_frame_new_I420(width, height, y_plane, y_stride, u_plane, u_stride, v_plane, v_stride) → {otc_video_frame *} Crée une nouvelle image vidéo au format I420.
otc_video_frame_new_MJPEG(width, height, buffer, size) → {otc_video_frame *} Crée une nouvelle image vidéo au format MJPEG.
otc_video_frame_new_compressed(width, height, buffer, size) → {otc_video_frame *} Crée une nouvelle image vidéo compressée.
otc_video_frame_new_from_planes(format, width, height, planes, strides) → {otc_video_frame *} Crée une nouvelle image vidéo au format spécifié à partir de ses plans.
otc_video_frame_new_I420_from_planes_with_format(input_format, width, height, planes, strides) → {otc_video_frame *} Crée une nouvelle image vidéo au format I420 à partir d'une liste de plans.
otc_video_frame_new_contiguous_memory_wrapper(format, width, height, is_shallow_copyable, buffer, size, callback, arg) → {otc_video_frame *} Crée une nouvelle image vidéo à partir des données contenues dans un tampon mémoire contigu.
otc_video_frame_new_planar_memory_wrapper(format, width, height, is_shallow_copyable, callbacks) → {otc_video_frame *} Crée une nouvelle image vidéo à partir d'un wrapper de mémoire planaire.
otc_video_frame_new_I420_wrapper(width, height, y_plane, y_stride, u_plane, u_stride, v_plane, v_stride) → {otc_video_frame *} Crée une nouvelle image vidéo au format I420 à partir de données YUV.
otc_video_frame_new_NV21_wrapper(width, height, y_plane, y_stride, uv_plane, uv_stride) → {otc_video_frame *} Crée une nouvelle image vidéo avec un conteneur NV21.
otc_video_frame_new_NV12_wrapper(width, height, y_plane, y_stride, uv_plane, uv_stride) → {otc_video_frame *} Crée une nouvelle image vidéo avec un conteneur NV12.
otc_video_frame_get_buffer(frame) → {const uint8_t *} Récupère un pointeur vers le tampon contenant les données d'une image vidéo.
otc_video_frame_get_buffer_size(frame) → {size_t} Récupère la taille du tampon contenant les données d'une image vidéo.
otc_video_frame_get_timestamp(frame) → {int64_t} Récupère l'horodatage d'une image vidéo en millisecondes depuis l'époque.
otc_video_frame_set_timestamp(frame, timestamp) Définit l'horodatage d'une image vidéo en millisecondes depuis l'époque.
otc_video_frame_get_width(frame) → {int} Récupère la largeur d'une image vidéo, en pixels.
otc_video_frame_get_height(frame) → {int} Récupère la hauteur d'une image vidéo, en pixels.
otc_video_frame_get_number_of_planes(frame) → {size_t} Récupère le nombre de plans d'une image vidéo.
otc_video_frame_get_format(frame) → {enum otc_video_frame_format} Récupère le format vidéo d'une image vidéo.
otc_video_frame_set_format(frame, format) Définit le format vidéo d'une image vidéo.
otc_video_frame_get_plane_binary_data(frame, plane) → {const uint8_t *} Récupère les données binaires provenant de l'un des plans d'une image vidéo.
otc_video_frame_get_plane_size(frame, plane) → {size_t} Récupère la taille d'un avion dans une image vidéo.
otc_video_frame_get_plane_stride(frame, plane) → {int} Récupère la largeur d'un plan donné dans une image vidéo.
otc_video_frame_get_plane_width(frame, plane) → {int} Récupère la largeur d'un plan dans une image vidéo.
otc_video_frame_get_plane_height(frame, plane) → {int} Récupère la hauteur d'un plan dans une image vidéo.
otc_video_frame_copy(frame) → {otc_video_frame *} Copie une image vidéo donnée.
otc_video_frame_mutable_copy(frame) → {otc_video_frame *} Crée une copie modifiable d'une image vidéo donnée.
otc_video_frame_convert(format, frame) → {otc_video_frame *} Convertit une image donnée.
otc_video_frame_convert_inplace(format, planes, strides, input_frame) → {otc_status} Convertit une image donnée sur place.
otc_video_frame_is_packed(frame) → {otc_bool} Vérifie si une image vidéo est compressée ou non.
otc_video_frame_is_contiguous(frame) → {otc_bool} Vérifie si une image vidéo est contiguë ou non.

otc_video_frame_get_native_handle(frame) → {void *}

Paramètres :
Nom Type Description
frame const otc_video_frame *
Retours :

void *

otc_video_frame_new(format, largeur, hauteur, tampon) → {otc_video_frame *}

Crée une nouvelle image vidéo au format spécifié.

Paramètres :
Nom Type Description
format énumération otc_video_frame_format Le format souhaité.
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
buffer const uint8_t * Un pointeur vers un tampon contenant les données d'une image vidéo.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_delete(frame) → {otc_status}

Ressources gratuites liées à ce cadre.

Paramètres :
Nom Type Description
frame otc_video_frame * Un pointeur vers une instance d'image vidéo.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_video_frame_new_I420(largeur, hauteur, plan_y, pas_y, plan_u, pas_u, plan_v, pas_v) → {otc_video_frame *}

Crée une nouvelle image vidéo au format I420.

Paramètres :
Nom Type Description
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
y_plane const uint8_t * Un pointeur vers un tampon contenant les données du plan Y.
y_stride int Pas Y.
u_plane const uint8_t * Un pointeur vers un tampon contenant les données du plan U.
u_stride int U stride.
v_plane const uint8_t * Un pointeur vers un tampon contenant les données du plan V.
v_stride int Foulée V.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_MJPEG(largeur, hauteur, tampon, taille) → {otc_video_frame *}

Crée une nouvelle image vidéo au format MJPEG.

Paramètres :
Nom Type Description
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
buffer const uint8_t * Un pointeur vers un tampon contenant les données d'une image vidéo.
size size_t La taille de l'image vidéo en mémoire.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_compressed(largeur, hauteur, tampon, taille) → {otc_video_frame *}

Crée une nouvelle image vidéo compressée.

Paramètres :
Nom Type Description
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
buffer const uint8_t * Un pointeur vers un tampon contenant les données d'une image vidéo.
size size_t La taille de l'image vidéo en mémoire.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_from_planes(format, largeur, hauteur, plans, pas) → {otc_video_frame *}

Crée une nouvelle image vidéo au format spécifié à partir de ses plans.

Paramètres :
Nom Type Description
format énumération otc_video_frame_format Le format souhaité.
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
planes const uint8_t * * Un pointeur vers un pointeur vers le tampon contenant les plans de l'image vidéo.
strides int * Pas de géant.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_I420_from_planes_with_format(format_d'entrée, largeur, hauteur, plans, pas) → {otc_video_frame *}

Crée une nouvelle image vidéo au format I420 à partir d'une liste de plans.

Paramètres :
Nom Type Description
input_format énumération otc_video_frame_format Le format de l'image vidéo transmise en entrée.
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
planes const uint8_t * * Un pointeur vers un pointeur vers le tampon contenant les plans de l'image vidéo.
strides int * Pas de géant.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_contiguous_memory_wrapper(format, largeur, hauteur, is_shallow_copyable, tampon, taille, callback, arg) → {otc_video_frame *}

Crée une nouvelle image vidéo à partir des données contenues dans un tampon mémoire contigu.

Paramètres :
Nom Type Description
format énumération otc_video_frame_format Le format de l'image vidéo transmise.
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
is_shallow_copyable otc_bool Savoir s'il est possible de créer une copie superficielle du cadre.
buffer const uint8_t * Un pointeur vers le tampon contenant les données de la trame.
size size_t La taille des données de trame.
callback otc_video_frame_memory_release_callback La fonction de rappel de libération de la mémoire des images vidéo.
arg void * Un pointeur vers des arguments supplémentaires.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_planar_memory_wrapper(format, largeur, hauteur, is_shallow_copyable, callbacks) → {otc_video_frame *}

Crée une nouvelle image vidéo à partir d'un wrapper de mémoire planaire. Le otc_video_frame_planar_memory_callbacks La structure, transmise en paramètre, définit les fonctions de rappel qui sont appelées lorsque des données relatives aux images vidéo et au pas sont demandées.

Paramètres :
Nom Type Description
format énumération otc_video_frame_format Le format de l'image vidéo transmise.
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
is_shallow_copyable otc_bool Savoir s'il est possible de créer une copie superficielle du cadre.
callbacks struct otc_video_frame_planar_memory_callbacks * Un pointeur vers la structure contenant les fonctions de rappel pour les images vidéo.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_I420_wrapper(largeur, hauteur, plan_y, pas_y, plan_u, pas_u, plan_v, pas_v) → {otc_video_frame *}

Crée une nouvelle image vidéo au format I420 à partir de données YUV.

Paramètres :
Nom Type Description
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
y_plane const uint8_t * Un pointeur dans le plan Y.
y_stride int La foulée en Y.
u_plane const uint8_t * Un pointeur dans le plan U.
u_stride int La foulée en « U ».
v_plane const uint8_t * Un pointeur dans le plan V.
v_stride int La foulée en V.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_NV21_wrapper(largeur, hauteur, plan_y, pas_y, plan_uv, pas_uv) → {otc_video_frame *}

Crée une nouvelle image vidéo avec un conteneur NV21.

Paramètres :
Nom Type Description
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
y_plane const uint8_t * Un pointeur dans le plan Y.
y_stride int La foulée en Y.
uv_plane const uint8_t * Un pointeur vers le plan UV.
uv_stride int La foulée UV.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_new_NV12_wrapper(largeur, hauteur, plan_y, pas_y, plan_uv, pas_uv) → {otc_video_frame *}

Crée une nouvelle image vidéo avec un conteneur NV12.

Paramètres :
Nom Type Description
width int La largeur de la vidéo, en pixels.
height int La hauteur de la vidéo, en pixels.
y_plane const uint8_t * Un pointeur dans le plan Y.
y_stride int La foulée en Y.
uv_plane const uint8_t * Un pointeur vers le plan UV.
uv_stride int La foulée UV.
Retours :

Un pointeur vers une instance d'image vidéo. Il peut être nul en cas d'erreur.

otc_video_frame_get_buffer(frame) → {const uint8_t *}

Récupère un pointeur vers le tampon contenant les données d'une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo à partir de laquelle récupérer le tampon.
Retours :

Un pointeur vers le tampon contenant les données d'une image vidéo.

otc_video_frame_get_buffer_size(frame) → {size_t}

Récupère la taille du tampon contenant les données d'une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo à partir de laquelle récupérer la taille du tampon.
Retours :

La taille de la mémoire tampon contenant les données des images vidéo.

otc_video_frame_get_timestamp(frame) → {int64_t}

Récupère l'horodatage d'une image vidéo en millisecondes depuis l'époque.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

L'horodatage de l'image vidéo.

otc_video_frame_set_timestamp(image, horodatage)

Définit l'horodatage d'une image vidéo en millisecondes depuis l'époque.

Paramètres :
Nom Type Description
frame otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
timestamp int64_t La valeur de l'horodatage.

otc_video_frame_get_width(frame) → {int}

Récupère la largeur d'une image vidéo, en pixels.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

La largeur du cadre indiqué, en pixels.

otc_video_frame_get_height(frame) → {int}

Récupère la hauteur d'une image vidéo, en pixels.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

La hauteur du cadre indiqué, en pixels.

otc_video_frame_get_number_of_planes(frame) → {size_t}

Récupère le nombre de plans d'une image vidéo. En général, cette fonction renvoie la valeur 3 pour une image YUV et 1 pour une image RGBA/BGRA.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

Le nombre d'avions.

otc_video_frame_get_format(frame) → {enum otc_video_frame_format}

Récupère le format vidéo d'une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.

Voir : : - otc_video_frame_format

Retours :

Le format d'image vidéo.

otc_video_frame_set_format(image, format)

Définit le format vidéo d'une image vidéo.

Paramètres :
Nom Type Description
frame otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
format énumération otc_video_frame_format Le format d'image vidéo.

Voir : : - otc_video_frame_format

otc_video_frame_get_plane_binary_data(frame, plane) → {const uint8_t *}

Récupère les données binaires provenant de l'un des plans d'une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
plane énumération otc_video_frame_plane Le plan vidéo à partir duquel extraire les données.
Retours :

Un pointeur vers un tampon contenant les données du plan. Il peut être nul en cas d'erreur.

otc_video_frame_get_plane_size(frame, plane) → {size_t}

Récupère la taille d'un avion dans une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
plane énumération otc_video_frame_plane Le plan vidéo à partir duquel extraire la taille.
Retours :

Taille de l'avion.

otc_video_frame_get_plane_stride(frame, plane) → {int}

Récupère la largeur d'un plan donné dans une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
plane énumération otc_video_frame_plane Le plan vidéo à partir duquel déterminer la longueur de foulée.
Retours :

Foulée.

otc_video_frame_get_plane_width(frame, plane) → {int}

Récupère la largeur d'un plan dans une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
plane énumération otc_video_frame_plane Le plan vidéo à partir duquel extraire la largeur.
Retours :

Avec.

otc_video_frame_get_plane_height(frame, plane) → {int}

Récupère la hauteur d'un plan dans une image vidéo.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
plane énumération otc_video_frame_plane Le plan vidéo à partir duquel déterminer la hauteur.
Retours :

Hauteur.

otc_video_frame_copy(frame) → {otc_video_frame *}

Copie une image vidéo donnée.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

Un pointeur vers la nouvelle instance d'image vidéo.

otc_video_frame_mutable_copy(frame) → {otc_video_frame *}

Crée une copie modifiable d'une image vidéo donnée.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

Un pointeur vers la nouvelle instance d'image vidéo.

otc_video_frame_convert(format, image) → {otc_video_frame *}

Convertit une image donnée. Toutes les images vidéo fournies par les fonctions de rappel du SDK sont associées à cette fonction. Si vous prévoyez d'enregistrer l'image pour l'utiliser ultérieurement, vous devrez la copier. De plus, si vous souhaitez convertir une image vidéo vers un autre format, vous utiliserez également cette fonction. Si le format de destination est identique à celui de la source, une copie superficielle (copie du tampon n) sera effectuée si possible.

Paramètres :
Nom Type Description
format énumération otc_video_frame_format Le format de l'image vidéo qui sera renvoyée. Cette fonction permet de convertir les images dans les formats suivants : OTC_VIDEO_FRAME_FORMAT_ARGB32, OTC_VIDEO_FRAME_FORMAT_BGRA32, OTC_VIDEO_FRAME_FORMAT_ABGR32, OTC_VIDEO_FRAME_FORMAT_RGBA32 et OTC_VIDEO_FRAME_FORMAT_YUV420P.
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.

Voir : : - otc_video_frame_format

Retours :

Une copie de l'image vidéo au format spécifié. Cette valeur peut être nulle en cas d'erreur. N'oubliez pas que vous devrez ensuite supprimer vous-même cette image.

otc_video_frame_convert_inplace(format, planes, strides, input_frame) → {otc_status}

Convertit une image donnée sur place. Cette opération modifie les données de l'image d'entrée.

Paramètres :
Nom Type Description
format énumération otc_video_frame_format Le format de l'image vidéo. Cette fonction permet de convertir les images aux formats suivants : OTC_VIDEO_FRAME_FORMAT_ARGB32, OTC_VIDEO_FRAME_FORMAT_BGRA32, OTC_VIDEO_FRAME_FORMAT_ABGR32et OTC_VIDEO_FRAME_FORMAT_YUV420P.
planes uint8_t * * Un pointeur vers un pointeur vers les plans d'image vidéo.
strides const int * Un pointeur vers un pointeur vers la longueur de trame vidéo.
input_frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.

Voir : : - otc_code_erreur - otc_video_frame_format

Retours :

Une valeur de retour indiquant soit une erreur, soit une réussite.

otc_video_frame_is_packed(frame) → {otc_bool}

Vérifie si une image vidéo est compressée ou non.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

Une valeur booléenne correspondant au résultat.

otc_video_frame_is_contiguous(frame) → {otc_bool}

Vérifie si une image vidéo est contiguë ou non.

Paramètres :
Nom Type Description
frame const otc_video_frame * Un pointeur vers l'instance de l'image vidéo.
Retours :

Une valeur booléenne correspondant au résultat.