include/vlc_video_splitter.h

   1 /*****************************************************************************
   2  * vlc_video_splitter.h: "video splitter" related structures and functions
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  *
   6  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifndef VLC_VIDEO_SPLITTER_H
  24 #define VLC_VIDEO_SPLITTER_H 1
  25
  26 #include <vlc_es.h>
  27 #include <vlc_picture.h>
  28 #include <vlc_mouse.h>
  29 #include <vlc_vout_display.h>
  30
  31 /**
  32  * \file
  33  * This file defines the structure and types used by video splitter filters.
  34  */
  35
  36 typedef struct video_splitter_t video_splitter_t;
  37
  38 struct vout_window_mouse_event_t;
  39
  40 /** Structure describing a video splitter output properties
  41  */
  42 typedef struct
  43 {
  44     /* Video format of the output */
  45     video_format_t fmt;
  46
  47     /* Window hints */
  48     struct
  49     {
  50         /* Relative position.
  51          * (0,0) is equal to the default position.
  52          */
  53         int i_x;
  54         int i_y;
  55
  56         /* Alignment inside the window
  57          */
  58         vlc_video_align_t align;
  59     } window;
  60
  61     /* Video output module
  62      * Use NULL for default
  63      */
  64     char *psz_module;
  65
  66 } video_splitter_output_t;
  67
  68 /** Structure describing a video splitter
  69  */
  70 struct video_splitter_t
  71 {
  72     struct vlc_common_members obj;
  73
  74     /* Module properties */
  75     module_t        *p_module;
  76
  77     /* configuration */
  78     config_chain_t  *p_cfg;
  79
  80     /* Input format
  81      * It is filled by the creator and cannot be modified.
  82      */
  83     video_format_t  fmt;
  84
  85     /* Output formats
  86      *
  87      * It can only be set in the open() function and must remain
  88      * constant.
  89      * The module is responsible for the allocation and deallocation.
  90      */
  91     int                     i_output;
  92     video_splitter_output_t *p_output;
  93
  94     int             (*pf_filter)( video_splitter_t *, picture_t *pp_dst[],
  95                                   picture_t *p_src );
  96     int (*mouse)(video_splitter_t *, int idx,
  97                  struct vout_window_mouse_event_t *);
  98
  99     void *p_sys;
 100 };
 101
 102 /**
 103  * It will create an array of pictures suitable as output.
 104  *
 105  * You must either returned them through pf_filter or by calling
 106  * video_splitter_DeletePicture.
 107  *
 108  * If VLC_SUCCESS is not returned, pp_picture values are undefined.
 109  */
 110 static inline int video_splitter_NewPicture(video_splitter_t *splitter,
 111                                             picture_t *pics[])
 112 {
 113     for (int i = 0; i < splitter->i_output; i++) {
 114         pics[i] = picture_NewFromFormat(&splitter->p_output[i].fmt);
 115         if (pics[i] == NULL) {
 116             for (int j = 0; j < i; j++)
 117                 picture_Release(pics[j]);
 118
 119             msg_Warn(splitter, "can't get output pictures");
 120             return VLC_EGENERIC;
 121         }
 122     }
 123     return VLC_SUCCESS;
 124 }
 125
 126 /**
 127  * It will release an array of pictures created by video_splitter_NewPicture.
 128  * Provided for convenience.
 129  */
 130 static inline void video_splitter_DeletePicture( video_splitter_t *p_splitter,
 131                                                  picture_t *pp_picture[] )
 132 {
 133     for (int i = 0; i < p_splitter->i_output; i++)
 134         picture_Release(pp_picture[i]);
 135 }
 136
 137 /* */
 138 video_splitter_t * video_splitter_New( vlc_object_t *, const char *psz_name, const video_format_t * );
 139 void video_splitter_Delete( video_splitter_t * );
 140
 141 static inline int video_splitter_Filter( video_splitter_t *p_splitter,
 142                                          picture_t *pp_dst[], picture_t *p_src )
 143 {
 144     return p_splitter->pf_filter( p_splitter, pp_dst, p_src );
 145 }
 146
 147 static inline int video_splitter_Mouse(video_splitter_t *splitter, int index,
 148                                        struct vout_window_mouse_event_t *ev)
 149 {
 150     return (splitter->mouse != NULL)
 151         ? splitter->mouse(splitter, index, ev) : VLC_SUCCESS;
 152 }
 153
 154 #endif /* VLC_VIDEO_SPLITTER_H */
 155