X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_picture.h;h=b0fe6e4d7ac397c37af6417af73d78de80e6a59c;hb=c60652e38ac6afd74bd8225e9dae5406f13aaa4f;hp=696bc7cba2e35717d0c3d677021ea2459856c9ea;hpb=b110c3878d8966c3dda47be9978a836f3dcbf8cc;p=vlc diff --git a/include/vlc_picture.h b/include/vlc_picture.h index 696bc7cba2..b0fe6e4d7a 100644 --- a/include/vlc_picture.h +++ b/include/vlc_picture.h @@ -51,13 +51,18 @@ typedef struct plane_t } plane_t; +/** + * Maximum number of plane for a picture + */ +#define PICTURE_PLANE_MAX (VOUT_MAX_PLANES) + +/** + * A private definition to help overloading picture release + */ +typedef struct picture_release_sys_t picture_release_sys_t; + /** * Video picture - * - * Any picture destined to be displayed by a video output thread should be - * stored in this structure from it's creation to it's effective display. - * Picture type and flags should only be modified by the output thread. Note - * that an empty picture MUST have its flags set to 0. */ struct picture_t { @@ -66,22 +71,10 @@ struct picture_t */ video_frame_format_t format; - /** Picture data - data can always be freely modified, but p_data may - * NEVER be modified. A direct buffer can be handled as the plugin - * wishes, it can even swap p_pixels buffers. */ - uint8_t *p_data; void *p_data_orig; /**< pointer before memalign */ - plane_t p[ VOUT_MAX_PLANES ]; /**< description of the planes */ + plane_t p[PICTURE_PLANE_MAX]; /**< description of the planes */ int i_planes; /**< number of allocated planes */ - /** \name Type and flags - * Should NOT be modified except by the vout thread - * @{*/ - int i_status; /**< picture flags */ - int i_type; /**< is picture a direct buffer ? */ - bool b_slow; /**< is picture in slow memory ? */ - /**@}*/ - /** \name Picture management properties * These properties can be modified using the video output thread API, * but should never be written directly */ @@ -96,26 +89,20 @@ struct picture_t * @{ */ bool b_progressive; /**< is it a progressive frame ? */ - unsigned int i_nb_fields; /**< # of displayed fields */ bool b_top_field_first; /**< which field is first */ - uint8_t *p_q; /**< quantification table */ + unsigned int i_nb_fields; /**< # of displayed fields */ + int8_t *p_q; /**< quantification table */ int i_qstride; /**< quantification stride */ int i_qtype; /**< quantification style */ /**@}*/ - /** The picture heap we are attached to */ - picture_heap_t* p_heap; - - /* Some vouts require the picture to be locked before it can be modified */ - int (* pf_lock) ( vout_thread_t *, picture_t * ); - int (* pf_unlock) ( vout_thread_t *, picture_t * ); - /** Private data - the video output plugin might want to put stuff here to * keep track of the picture */ picture_sys_t * p_sys; /** This way the picture_Release can be overloaded */ void (*pf_release)( picture_t * ); + picture_release_sys_t *p_release_sys; /** Next picture in a FIFO a pictures */ struct picture_t *p_next; @@ -125,9 +112,43 @@ struct picture_t * This function will create a new picture. * The picture created will implement a default release management compatible * with picture_Hold and picture_Release. This default management will release - * picture_sys_t *p_sys field if non NULL. + * p_sys, p_q, p_data_orig fields if non NULL. + */ +VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) LIBVLC_USED ); + +/** + * This function will create a new picture using the given format. + * + * When possible, it is preferred to use this function over picture_New + * as more information about the format is kept. + */ +VLC_EXPORT( picture_t *, picture_NewFromFormat, ( const video_format_t *p_fmt ) LIBVLC_USED ); + +/** + * Resource for a picture. + */ +typedef struct +{ + picture_sys_t *p_sys; + + /* Plane resources + * XXX all fields MUST be set to the right value. + */ + struct + { + uint8_t *p_pixels; /**< Start of the plane's data */ + int i_lines; /**< Number of lines, including margins */ + int i_pitch; /**< Number of bytes in a line, including margins */ + } p[PICTURE_PLANE_MAX]; + +} picture_resource_t; + +/** + * This function will create a new picture using the provided resource. + * + * If the resource is NULL then a plain picture_NewFromFormat is returned. */ -VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) ); +VLC_EXPORT( picture_t *, picture_NewFromResource, ( const video_format_t *, const picture_resource_t * ) LIBVLC_USED ); /** * This function will force the destruction a picture. @@ -141,11 +162,14 @@ VLC_EXPORT( void, picture_Delete, ( picture_t * ) ); /** * This function will increase the picture reference count. * It will not have any effect on picture obtained from vout + * + * It returns the given picture for convenience. */ -static inline void picture_Hold( picture_t *p_picture ) +static inline picture_t *picture_Hold( picture_t *p_picture ) { if( p_picture->pf_release ) p_picture->i_refcount++; + return p_picture; } /** * This function will release a picture. @@ -158,6 +182,17 @@ static inline void picture_Release( picture_t *p_picture ) p_picture->pf_release( p_picture ); } +/** + * This function will return true if you are not the only owner of the + * picture. + * + * It is only valid if it is created using picture_New. + */ +static inline bool picture_IsReferenced( picture_t *p_picture ) +{ + return p_picture->i_refcount > 1; +} + /** * Cleanup quantization matrix data and set to 0 */ @@ -184,6 +219,12 @@ static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_ /* FIXME: copy ->p_q and ->p_qstride */ } +/** + * This function will reset a picture information (properties and quantizers). + * It is sometimes useful for reusing pictures (like from a pool). + */ +VLC_EXPORT( void, picture_Reset, ( picture_t * ) ); + /** * This function will copy the picture pixels. * You can safely copy between pictures that do not have the same size, @@ -216,8 +257,12 @@ static inline void picture_Copy( picture_t *p_dst, const picture_t *p_src ) * picture before encoding. * * i_override_width/height allow to override the width and/or the height of the - * picture to be encoded. If at most one of them is > 0 then the picture aspect - * ratio will be kept. + * picture to be encoded: + * - if strictly lower than 0, the original dimension will be used. + * - if equal to 0, it will be deduced from the other dimension which must be + * different to 0. + * - if strictly higher than 0, it will override the dimension. + * If at most one of them is > 0 then the picture aspect ratio will be kept. */ VLC_EXPORT( int, picture_Export, ( vlc_object_t *p_obj, block_t **pp_image, video_format_t *p_fmt, picture_t *p_picture, vlc_fourcc_t i_format, int i_override_width, int i_override_height ) ); @@ -230,33 +275,14 @@ VLC_EXPORT( int, picture_Export, ( vlc_object_t *p_obj, block_t **pp_image, vide * It will return VLC_EGENERIC if the core does not understand the requested * format. * - * It can be usefull to get the properties of planes. + * It can be useful to get the properties of planes. */ -VLC_EXPORT( int, picture_Setup, ( picture_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) ); +VLC_EXPORT( int, picture_Setup, ( picture_t *, vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) ); /***************************************************************************** * Flags used to describe the status of a picture *****************************************************************************/ -/* Picture type - * FIXME are the values meaningfull ? */ -enum -{ - EMPTY_PICTURE = 0, /* empty buffer */ - MEMORY_PICTURE = 100, /* heap-allocated buffer */ - DIRECT_PICTURE = 200, /* direct buffer */ -}; - -/* Picture status */ -enum -{ - FREE_PICTURE, /* free and not allocated */ - RESERVED_PICTURE, /* allocated and reserved */ - READY_PICTURE, /* ready for display */ - DISPLAYED_PICTURE, /* been displayed but is linked */ - DESTROYED_PICTURE, /* allocated but no more used */ -}; - /* Quantification type */ enum {