vlc_video.h

/*****************************************************************************
 * vlc_video.h: common video definitions
 * This header is required by all modules which have to handle pictures. It
 * includes all common video types and constants.
 *****************************************************************************
 * Copyright (C) 1999 - 2005 the VideoLAN team
 * $Id: vlc_video.h 12412 2005-08-27 16:40:23Z jpsaman $
 *
 * Authors: Vincent Seguin <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/
#ifndef _VLC_VIDEO_H
#define _VLC_VIDEO_H 1

#include "vlc_es.h"

typedef struct plane_t
{
    uint8_t *p_pixels;                        
    /* Variables used for fast memcpy operations */
    int i_lines;           
    int i_pitch;           
    int i_pixel_pitch;

    /* Variables used for pictures with margins */
    int i_visible_lines;            
    int i_visible_pitch;            
} plane_t;

struct picture_t
{
    video_frame_format_t format;

    uint8_t        *p_data;
    void           *p_data_orig;                
    plane_t         p[ VOUT_MAX_PLANES ];     
    int             i_planes;                
    int             i_status;                             
    int             i_type;                
    vlc_bool_t      b_slow;                 
    int             i_matrix_coefficients;   
    int             i_refcount;                  
    mtime_t         date;                                  
    vlc_bool_t      b_force;
    vlc_bool_t      b_progressive;          
    unsigned int    i_nb_fields;                  
    vlc_bool_t      b_top_field_first;             
    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 * );

    picture_sys_t * p_sys;

    void (*pf_release)( picture_t * );

    struct picture_t *p_next;
};

struct picture_heap_t
{
    int i_pictures;                                   
    /* \name Picture static properties
     * Those properties are fixed at initialization and should NOT be modified
     * @{
     */
    unsigned int i_width;                                 
    unsigned int i_height;                               
    vlc_fourcc_t i_chroma;                               
    unsigned int i_aspect;                                 
    /* Real pictures */
    picture_t*      pp_picture[VOUT_MAX_PICTURES];             
    int             i_last_used_pic;              
    vlc_bool_t      b_allow_modify_pics;

    /* Stuff used for truecolor RGB planes */
    int i_rmask, i_rrshift, i_lrshift;
    int i_gmask, i_rgshift, i_lgshift;
    int i_bmask, i_rbshift, i_lbshift;

    void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
};

/*****************************************************************************
 * Flags used to describe the status of a picture
 *****************************************************************************/

/* Picture type */
#define EMPTY_PICTURE           0                            /* empty buffer */
#define MEMORY_PICTURE          100                 /* heap-allocated buffer */
#define DIRECT_PICTURE          200                         /* direct buffer */

/* Picture status */
#define FREE_PICTURE            0                  /* free and not allocated */
#define RESERVED_PICTURE        1                  /* allocated and reserved */
#define RESERVED_DATED_PICTURE  2              /* waiting for DisplayPicture */
#define RESERVED_DISP_PICTURE   3               /* waiting for a DatePicture */
#define READY_PICTURE           4                       /* ready for display */
#define DISPLAYED_PICTURE       5            /* been displayed but is linked */
#define DESTROYED_PICTURE       6              /* allocated but no more used */

/*****************************************************************************
 * Shortcuts to access image components
 *****************************************************************************/

/* Plane indices */
#define Y_PLANE      0
#define U_PLANE      1
#define V_PLANE      2
#define A_PLANE      3

/* Shortcuts */
#define Y_PIXELS     p[Y_PLANE].p_pixels
#define Y_PITCH      p[Y_PLANE].i_pitch
#define U_PIXELS     p[U_PLANE].p_pixels
#define U_PITCH      p[U_PLANE].i_pitch
#define V_PIXELS     p[V_PLANE].p_pixels
#define V_PITCH      p[V_PLANE].i_pitch
#define A_PIXELS     p[A_PLANE].p_pixels
#define A_PITCH      p[A_PLANE].i_pitch

struct subpicture_region_t
{
    video_format_t  fmt;                          
    picture_t       picture;             
    int             i_x;                             
    int             i_y;                             
    char            *psz_text;       
    int             i_text_color;     
    int             i_text_alpha;                     
    int             i_text_size;                              
    int             i_text_align;         
    subpicture_region_t *p_next;                
    subpicture_region_t *p_cache;       
};

struct subpicture_t
{
    int             i_channel;                    
    int             i_type;                                        
    int             i_status;                                     
    subpicture_t *  p_next;               
    mtime_t         i_start;                  
    mtime_t         i_stop;                         
    vlc_bool_t      b_ephemer;    
    vlc_bool_t      b_fade;                               
    subpicture_region_t *p_region;  
    int          i_x;                    
    int          i_y;                    
    int          i_width;                                 
    int          i_height;                               
    int          i_alpha;                                  
    int          i_original_picture_width;  
    int          i_original_picture_height;
    vlc_bool_t   b_absolute;                       
    int          i_flags;                                
    void ( *pf_render )  ( vout_thread_t *, picture_t *, const subpicture_t * );
    void ( *pf_destroy ) ( subpicture_t * );

    subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
                                                  video_format_t * );
    subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
                                                video_format_t *, picture_t * );
    void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );

    subpicture_sys_t *p_sys;                              /* subpicture data */
};

/* Subpicture type */
#define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
#define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */

/* Default subpicture channel ID */
#define DEFAULT_CHAN           1

/* Subpicture status */
#define FREE_SUBPICTURE        0                   /* free and not allocated */
#define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
#define READY_SUBPICTURE       2                        /* ready for display */

/* Subpicture position flags */
#define SUBPICTURE_ALIGN_LEFT 0x1
#define SUBPICTURE_ALIGN_RIGHT 0x2
#define SUBPICTURE_ALIGN_TOP 0x4
#define SUBPICTURE_ALIGN_BOTTOM 0x8

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
#define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );

#define vout_InitPicture(a,b,c,d,e,f) \
        __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
VLC_EXPORT( int, __vout_InitPicture, ( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_aspect ) );

#define vout_AllocatePicture(a,b,c,d,e,f) \
        __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
VLC_EXPORT( int, __vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_aspect ) );

VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );

VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );

VLC_EXPORT( void,  __vout_OSDMessage, ( vlc_object_t *, int, char *, ... ) );

#if defined(HAVE_VARIADIC_MACROS)
#    define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args )
#else
#    define vout_OSDMessage __vout_OSDMessage
#endif

VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );

VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );

#endif /* _VLC_VIDEO_H */

---