modules/video_output/flaschen.c

   1 /*****************************************************************************
   2  * flaschentaschen.c: Flaschen-Taschen video output display for vlc
   3  * cf. https://github.com/hzeller/flaschen-taschen
   4  *****************************************************************************
   5  * Copyright (C) 2000-2009 VLC authors and VideoLAN
   6  * Copyright (C) 2016 François Revol <revol@free.fr>
   7  *
   8  * Includes code from vdummy.c and aa.c:
   9  * Authors: Samuel Hocevar <sam@zoy.org>
  10  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU Lesser General Public License as published by
  14  * the Free Software Foundation; either version 2.1 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20  * GNU Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30
  31 #ifdef HAVE_CONFIG_H
  32 # include "config.h"
  33 #endif
  34
  35 #include <errno.h>
  36 #ifdef HAVE_SYS_UIO_H
  37 # include <sys/uio.h>
  38 #endif
  39
  40 #include <vlc_common.h>
  41 #include <vlc_fs.h>
  42 #include <vlc_network.h>
  43 #include <vlc_plugin.h>
  44 #include <vlc_vout_display.h>
  45
  46 #define T_FLDISPLAY N_("Flaschen-Taschen display address")
  47 #define LT_FLDISPLAY N_( \
  48     "IP address or hostname of the Flaschen-Taschen display. " \
  49     "Something like ft.noise or ftkleine.noise")
  50
  51 #define T_WIDTH N_("Width")
  52 #define LT_WIDTH N_("Video width")
  53
  54 #define T_HEIGHT N_("Height")
  55 #define LT_HEIGHT N_("Video height")
  56
  57 static int Open( vlc_object_t * );
  58 static void Close( vlc_object_t * );
  59
  60 vlc_module_begin ()
  61     set_shortname( N_("Flaschen") )
  62     set_description( N_("Flaschen-Taschen video output") )
  63     set_capability( "vout display", 0 )
  64     set_callbacks( Open, Close )
  65     add_shortcut( "flaschen" )
  66
  67     set_category( CAT_VIDEO )
  68     set_subcategory( SUBCAT_VIDEO_VOUT )
  69     add_string( "flaschen-display", NULL, T_FLDISPLAY, LT_FLDISPLAY, true )
  70     add_integer("flaschen-width", 25, T_WIDTH, LT_WIDTH, false)
  71     add_integer("flaschen-height", 20, T_HEIGHT, LT_HEIGHT, false)
  72 vlc_module_end ()
  73
  74
  75 /*****************************************************************************
  76  * Local prototypes
  77  *****************************************************************************/
  78 struct vout_display_sys_t {
  79     int             fd;
  80
  81     picture_pool_t *pool;
  82 };
  83 static picture_pool_t *Pool(vout_display_t *, unsigned count);
  84 static void            Display(vout_display_t *, picture_t *, subpicture_t *);
  85 static int             Control(vout_display_t *, int, va_list);
  86
  87 /*****************************************************************************
  88  * Open: activates flaschen vout display method
  89  *****************************************************************************/
  90 static int Open(vlc_object_t *object)
  91 {
  92     vout_display_t *vd = (vout_display_t *)object;
  93     vout_display_sys_t *sys;
  94     int fd;
  95     unsigned port = 1337;
  96
  97     vd->sys = sys = calloc(1, sizeof(*sys));
  98     if (!sys)
  99         return VLC_ENOMEM;
 100     sys->pool = NULL;
 101     sys->fd = -1;
 102
 103     /* */
 104     video_format_t fmt = vd->fmt;
 105     fmt.i_chroma = VLC_CODEC_RGB24;
 106     /* TODO: check if this works on big-endian systems */
 107     fmt.i_rmask = 0xff0000;
 108     fmt.i_gmask = 0x00ff00;
 109     fmt.i_bmask = 0x0000ff;
 110     fmt.i_width  = var_InheritInteger(vd, "flaschen-width");
 111     fmt.i_height = var_InheritInteger(vd, "flaschen-height");
 112     fmt.i_visible_width = fmt.i_width;
 113     fmt.i_visible_height = fmt.i_height;
 114
 115     /* p_vd->info is not modified */
 116
 117     char *display = var_InheritString(vd, "flaschen-display");
 118     if (display == NULL) {
 119         msg_Err(vd, "missing flaschen-display");
 120         free(sys);
 121         return VLC_EGENERIC;
 122     }
 123     msg_Dbg(vd, "using display at %s (%dx%d)", display, fmt.i_width, fmt.i_height);
 124
 125     fd = net_ConnectDgram( vd, display, port, -1, IPPROTO_UDP );
 126
 127     if( fd == -1 )
 128     {
 129         msg_Err( vd,
 130                  "cannot create UDP socket for %s port %u",
 131                  display, port );
 132         free(display);
 133         free(sys);
 134         return VLC_EGENERIC;
 135     }
 136     free(display);
 137     sys->fd = fd;
 138
 139     /* Ignore any unexpected incoming packet */
 140     setsockopt (fd, SOL_SOCKET, SO_RCVBUF, &(int){ 0 }, sizeof (int));
 141
 142
 143     vd->fmt     = fmt;
 144
 145     vd->pool    = Pool;
 146     vd->prepare = NULL;
 147     vd->display = Display;
 148     vd->control = Control;
 149     vd->manage  = NULL;
 150
 151     vout_display_DeleteWindow(vd, NULL);
 152
 153     return VLC_SUCCESS;
 154 }
 155
 156 static void Close(vlc_object_t *object)
 157 {
 158     vout_display_t *vd = (vout_display_t *)object;
 159     vout_display_sys_t *sys = vd->sys;
 160
 161     if (sys->pool)
 162         picture_pool_Release(sys->pool);
 163
 164     net_Close(sys->fd);
 165     free(sys);
 166 }
 167
 168 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
 169 {
 170     vout_display_sys_t *sys = vd->sys;
 171     if (!sys->pool)
 172         sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
 173     return sys->pool;
 174 }
 175
 176 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
 177 {
 178 #ifdef IOV_MAX
 179     const long iovmax = IOV_MAX;
 180 #else
 181     const long iovmax = sysconf(_SC_IOV_MAX);
 182 #endif
 183     vout_display_sys_t *sys = vd->sys;
 184     int result;
 185     VLC_UNUSED(subpicture);
 186
 187     char buffer[64];
 188     int header_len = snprintf(buffer, sizeof(buffer), "P6\n%d %d\n255\n",
 189                               vd->fmt.i_width, vd->fmt.i_height);
 190     /* TODO: support offset_{x,y,z}? (#FT:...) */
 191     /* Note the protocol doesn't include any picture order field. */
 192     /* (maybe add as comment?) */
 193
 194     int iovcnt = 1 + vd->fmt.i_height;
 195     if (unlikely(iovcnt > iovmax))
 196         return;
 197
 198     struct iovec iov[iovcnt];
 199     iov[0].iov_base = buffer;
 200     iov[0].iov_len = header_len;
 201
 202     uint8_t *src = picture->p->p_pixels;
 203     for (int i = 1; i < iovcnt; i++)
 204     {
 205         iov[i].iov_base = src;
 206         iov[i].iov_len = vd->fmt.i_width * 3;
 207         src += picture->p->i_pitch;
 208     }
 209
 210     struct msghdr hdr = {
 211         .msg_name = NULL,
 212         .msg_namelen = 0,
 213         .msg_iov = iov,
 214         .msg_iovlen = iovcnt,
 215         .msg_control = NULL,
 216         .msg_controllen = 0,
 217         .msg_flags = 0 };
 218
 219     result = sendmsg(sys->fd, &hdr, 0);
 220     if (result < 0)
 221         msg_Err(vd, "sendmsg: error %s in vout display flaschen", vlc_strerror_c(errno));
 222     else if (result < (int)(header_len + vd->fmt.i_width * vd->fmt.i_height * 3))
 223         msg_Err(vd, "sendmsg only sent %d bytes in vout display flaschen", result);
 224         /* we might want to drop some frames? */
 225
 226     picture_Release(picture);
 227 }
 228
 229 /**
 230  * Control for vout display
 231  */
 232 static int Control(vout_display_t *vd, int query, va_list args)
 233 {
 234     VLC_UNUSED(args);
 235
 236     switch (query) {
 237     case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
 238     case VOUT_DISPLAY_CHANGE_ZOOM:
 239     case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
 240     case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
 241     case VOUT_DISPLAY_CHANGE_FULLSCREEN:
 242         return VLC_EGENERIC;
 243
 244     case VOUT_DISPLAY_HIDE_MOUSE:
 245         /* not really working */
 246         return VLC_SUCCESS;
 247
 248     default:
 249         msg_Err(vd, "Unsupported query in vout display flaschen");
 250         return VLC_EGENERIC;
 251     }
 252 }