gstsparrow.h

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  * Copyright (C) <2003> David Schleef <ds@schleef.org>
   4  * Copyright (C) <2003> Arwed v. Merkatz <v.merkatz@gmx.net>
   5  * Copyright (C) <2006> Mark Nauwelaerts <manauw@skynet.be>
   6  * Copyright (C) <2010> Douglas Bagnall <douglas@halo.gen.nz>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library 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 GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24
  25 #ifndef __GST_VIDEO_SPARROW_H__
  26 #define __GST_VIDEO_SPARROW_H__
  27
  28 #include <gst/video/gstvideofilter.h>
  29 #include <sys/time.h>
  30
  31 G_BEGIN_DECLS
  32 #define GST_TYPE_SPARROW \
  33   (gst_sparrow_get_type())
  34 #define GST_SPARROW(obj) \
  35   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_SPARROW,GstSparrow))
  36 #define GST_SPARROW_CLASS(klass) \
  37   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_SPARROW,GstSparrowClass))
  38 #define GST_IS_SPARROW(obj) \
  39   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_SPARROW))
  40 #define GST_IS_SPARROW_CLASS(klass) \
  41   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_SPARROW))
  42
  43
  44
  45
  46 #define SPARROW_PPM_DEBUG 1
  47 #define USE_SPARSE_MAP 1
  48
  49 #define TIMER_LOG_FILE "/tmp/timer.log"
  50
  51 #include "sparrowconfig.h"
  52 #include "dSFMT/dSFMT.h"
  53 #include "cv.h"
  54
  55 #ifndef UNUSED
  56 #define UNUSED __attribute__ ((unused))
  57 #else
  58 #warning UNUSED is set
  59 #endif
  60
  61 /* the common recommendation for function visibility is to default to 'hidden'
  62    and specifically mark the unhidden ('default') ones, but this might muck
  63    with gstreamer macros, some of which declare functions, and most sparrow
  64    functions are static anyway, so it is simpler to whitelist visibility.
  65
  66    http://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#index-fvisibility-2135
  67
  68    (actually, it seems like all functions are invisible or static, except the
  69    ones that gstreamer makes in macros).
  70  */
  71 #ifndef INVISIBLE
  72 #define INVISIBLE __attribute__ ((visibility("hidden")))
  73 #else
  74 #warning INVISIBLE is set
  75 #endif
  76
  77
  78 typedef guint32 pix_t;
  79 #define PIXSIZE (sizeof(pix_t))
  80
  81 #define SPARROW_N_IPL_IN 3
  82
  83 #define FAKE_OTHER_PROJECTION 1
  84
  85
  86 #define LINE_PERIOD 16
  87 #define H_LINE_OFFSET (LINE_PERIOD / 2)
  88 #define V_LINE_OFFSET (LINE_PERIOD / 2)
  89
  90
  91 typedef enum {
  92   SPARROW_STATUS_QUO = 0,
  93   SPARROW_INIT,
  94   SPARROW_FIND_SELF,
  95   SPARROW_FIND_SCREEN,
  96   SPARROW_FIND_EDGES,
  97   SPARROW_PLAY,
  98
  99
 100   SPARROW_NEXT_STATE /*magical last state: alias for next in sequence */
 101 } sparrow_state;
 102
 103 typedef enum {
 104   SPARROW_WHITE = 0,
 105   SPARROW_GREEN,
 106   SPARROW_MAGENTA,
 107
 108   SPARROW_LAST_COLOUR
 109 } sparrow_colour;
 110
 111
 112 typedef struct sparrow_format_s {
 113   gint32 width;
 114   gint32 height;
 115   guint32 pixcount;
 116   guint32 size;
 117
 118   guint32 rshift;
 119   guint32 gshift;
 120   guint32 bshift;
 121   guint32 rmask;
 122   guint32 gmask;
 123   guint32 bmask;
 124   guint32 colours[3];
 125 } sparrow_format;
 126
 127
 128 typedef enum sparrow_axis_s {
 129   SPARROW_HORIZONTAL,
 130   SPARROW_VERTICAL,
 131 } sparrow_axis_t;
 132
 133
 134 /* a mesh of these contains the mapping from input to output.
 135    stored in a fixed point notation.
 136 */
 137 #define SPARROW_FIXED_POINT 8
 138
 139 typedef struct sparrow_map_path_s {
 140   int dx;
 141   int dy;
 142   int n;
 143 }sparrow_map_path_t;
 144
 145
 146 typedef struct sparrow_map_row_s {
 147   int start;
 148   int end;
 149   int in_x;
 150   int in_y;
 151   sparrow_map_path_t *points;
 152 }sparrow_map_row_t;
 153
 154 typedef struct sparrow_map_s {
 155   sparrow_map_row_t *rows;
 156   void *point_mem;
 157 }sparrow_map_t;
 158
 159 typedef struct sparrow_map_lut_s{
 160   guint16 x;
 161   guint16 y;
 162 } sparrow_map_lut_t;
 163
 164
 165 typedef struct _GstSparrow GstSparrow;
 166 typedef struct _GstSparrowClass GstSparrowClass;
 167
 168 /**
 169  * GstSparrow:
 170  *
 171  * Opaque data structure.
 172  */
 173 struct _GstSparrow
 174 {
 175   GstVideoFilter videofilter;
 176
 177   sparrow_format in;
 178   sparrow_format out;
 179
 180   /*some calibration modes have big unwieldy structs that attach here */
 181   void *helper_struct;
 182
 183   /* properties / command line options */
 184   gboolean debug;
 185   gboolean use_timer;
 186   gint calibrate_flag;  /*whether to calibrate */
 187   guint32 rng_seed;
 188
 189   /* misc */
 190   dsfmt_t *dsfmt;  /*rng*/
 191
 192   /*state */
 193   sparrow_state state;
 194   gint32 countdown; /*intra-state timing*/
 195
 196   /*buffer pointers for previous frames */
 197   guint8 *in_frame;
 198   guint8 *prev_frame;
 199   guint8 *work_frame;
 200   guint8 *debug_frame;
 201
 202   GstBuffer *in_buffer;
 203   GstBuffer *prev_buffer;
 204   /*don't need work_buffer */
 205
 206   guint32 colour;
 207   guint32 frame_count;
 208
 209   const char *reload;
 210   const char *save;
 211
 212   /*debug timer */
 213   struct timeval timer_start;
 214   struct timeval timer_stop;
 215   FILE * timer_log;
 216
 217   /*calibration results */
 218   guint32 lag;
 219   guint8 *screenmask;
 220   sparrow_map_t map;
 221   /*full sized LUT */
 222   sparrow_map_lut_t *map_lut;
 223 };
 224
 225
 226 struct _GstSparrowClass
 227 {
 228   GstVideoFilterClass parent_class;
 229 };
 230
 231 GType gst_sparrow_get_type(void);
 232
 233
 234 GST_DEBUG_CATEGORY_EXTERN (sparrow_debug);
 235 #define GST_CAT_DEFAULT sparrow_debug
 236
 237 /* GstSparrow signals and args */
 238 enum
 239 {
 240   /* FILL ME */
 241   LAST_SIGNAL
 242 };
 243
 244 enum
 245 {
 246   PROP_0,
 247   PROP_CALIBRATE,
 248   PROP_DEBUG,
 249   PROP_TIMER,
 250   PROP_RNG_SEED,
 251   PROP_COLOUR,
 252   PROP_RELOAD,
 253   PROP_SAVE
 254 };
 255
 256 #define DEFAULT_PROP_CALIBRATE TRUE
 257 #define DEFAULT_PROP_DEBUG FALSE
 258 #define DEFAULT_PROP_TIMER FALSE
 259 #define DEFAULT_PROP_RNG_SEED -1
 260 #define DEFAULT_PROP_COLOUR SPARROW_GREEN
 261 #define DEFAULT_PROP_RELOAD ""
 262 #define DEFAULT_PROP_SAVE ""
 263
 264 #define QUOTE_(x) #x
 265 #define QUOTE(x) QUOTE_(x)
 266
 267 /*timing utility code */
 268 #define TIME_TRANSFORM 1
 269
 270 #define TIMER_START(sparrow) do{                        \
 271   if (sparrow->timer_log){                              \
 272     if ((sparrow)->timer_start.tv_sec){                 \
 273       GST_DEBUG("timer already running!\n");            \
 274     }                                                   \
 275     else {                                              \
 276       gettimeofday(&((sparrow)->timer_start), NULL);    \
 277     }                                                   \
 278   }                                                     \
 279   } while (0)
 280
 281 static inline void
 282 TIMER_STOP(GstSparrow *sparrow)
 283 {
 284   if (sparrow->timer_log){
 285     struct timeval *start = &(sparrow->timer_start);
 286     struct timeval *stop = &(sparrow->timer_stop);
 287     if (start->tv_sec == 0){
 288       GST_DEBUG("the timer isn't running!\n");
 289       return;
 290     }
 291     gettimeofday(stop, NULL);
 292     guint32 t = ((stop->tv_sec - start->tv_sec) * 1000000 +
 293         stop->tv_usec - start->tv_usec);
 294
 295 #if SPARROW_NOISY_DEBUG
 296     GST_DEBUG("took %u microseconds (%0.5f of a frame)\n",
 297         t, (double)t * (25.0 / 1000000.0));
 298 #endif
 299
 300     fprintf(sparrow->timer_log, "%d %6d\n", sparrow->state, t);
 301     fflush(sparrow->timer_log);
 302     start->tv_sec = 0; /* mark it as unused */
 303   }
 304 }
 305
 306 /* GST_DISABLE_GST_DEBUG is set in gstreamer compilation. If it is set, we
 307    need our own debug channel. */
 308 #ifdef GST_DISABLE_GST_DEBUG
 309
 310 #undef GST_DEBUG
 311
 312 static FILE *_sparrow_bloody_debug_flags = NULL;
 313 static void
 314 GST_DEBUG(const char *msg, ...){
 315   if (! _sparrow_bloody_debug_flags){
 316     _sparrow_bloody_debug_flags = fopen("/tmp/sparrow.log", "wb");
 317     if (! _sparrow_bloody_debug_flags){
 318       exit(1);
 319     }
 320   }
 321   va_list argp;
 322   va_start(argp, msg);
 323   vfprintf(_sparrow_bloody_debug_flags, msg, argp);
 324   va_end(argp);
 325   fflush(_sparrow_bloody_debug_flags);
 326 }
 327
 328 #define GST_ERROR        GST_DEBUG
 329 #define GST_WARNING      GST_DEBUG
 330 #define GST_INFO         GST_DEBUG
 331 #define GST_LOG          GST_DEBUG
 332 #define GST_FIXME        GST_DEBUG
 333
 334 #endif
 335 #define LOG_LINENO() GST_DEBUG("%-25s  line %4d \n", __func__, __LINE__ );
 336
 337
 338 G_END_DECLS
 339 #endif /* __GST_VIDEO_SPARROW_H__ */