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 /*XXX could be run time option */
  44 #define USE_FULL_LUT 1
  45
  46 #define SPARROW_PPM_DEBUG 1
  47
  48 #define TIMER_LOG_FILE "/tmp/timer.log"
  49
  50 #include "sparrowconfig.h"
  51 #include "dSFMT/dSFMT.h"
  52 #include "cv.h"
  53
  54 #ifndef UNUSED
  55 #define UNUSED __attribute__ ((unused))
  56 #else
  57 #warning UNUSED is set
  58 #endif
  59
  60 /* the common recommendation for function visibility is to default to 'hidden'
  61    and specifically mark the unhidden ('default') ones, but this might muck
  62    with gstreamer macros, some of which declare functions, and most sparrow
  63    functions are static anyway, so it is simpler to whitelist visibility.
  64
  65    http://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#index-fvisibility-2135
  66
  67    (actually, it seems like all functions are invisible or static, except the
  68    ones that gstreamer makes in macros).
  69  */
  70 #ifndef INVISIBLE
  71 #define INVISIBLE __attribute__ ((visibility("hidden")))
  72 #else
  73 #warning INVISIBLE is set
  74 #endif
  75
  76
  77 typedef guint32 pix_t;
  78 #define PIXSIZE (sizeof(pix_t))
  79
  80 #define SPARROW_N_IPL_IN 3
  81
  82 //#define FAKE_OTHER_PROJECTION 1
  83
  84
  85 #define LINE_PERIOD 32
  86 #define H_LINE_OFFSET (LINE_PERIOD / 2)
  87 #define V_LINE_OFFSET (LINE_PERIOD / 2)
  88
  89
  90 typedef enum {
  91   SPARROW_STATUS_QUO = 0,
  92   SPARROW_INIT,
  93   SPARROW_FIND_SELF,
  94   SPARROW_FIND_SCREEN,
  95   SPARROW_FIND_EDGES,
  96   SPARROW_PLAY,
  97
  98
  99   SPARROW_NEXT_STATE /*magical last state: alias for next in sequence */
 100 } sparrow_state;
 101
 102 typedef enum {
 103   SPARROW_WHITE = 0,
 104   SPARROW_GREEN,
 105   SPARROW_MAGENTA,
 106
 107   SPARROW_LAST_COLOUR
 108 } sparrow_colour;
 109
 110
 111 typedef struct sparrow_format_s {
 112   gint32 width;
 113   gint32 height;
 114   guint32 pixcount;
 115   guint32 size;
 116
 117   guint32 rshift;
 118   guint32 gshift;
 119   guint32 bshift;
 120   guint32 rbyte;
 121   guint32 gbyte;
 122   guint32 bbyte;
 123   guint32 rmask;
 124   guint32 gmask;
 125   guint32 bmask;
 126   guint32 colours[3];
 127 } sparrow_format;
 128
 129
 130 typedef enum sparrow_axis_s {
 131   SPARROW_HORIZONTAL,
 132   SPARROW_VERTICAL,
 133 } sparrow_axis_t;
 134
 135
 136 /* a mesh of these contains the mapping from input to output.
 137    stored in a fixed point notation.
 138 */
 139 #define SPARROW_FIXED_POINT 9
 140
 141 typedef struct sparrow_map_path_s {
 142   int dx;
 143   int dy;
 144   int n;
 145 }sparrow_map_path_t;
 146
 147
 148 typedef struct sparrow_map_row_s {
 149   int start;
 150   int end;
 151   int in_x;
 152   int in_y;
 153   sparrow_map_path_t *points;
 154 }sparrow_map_row_t;
 155
 156 typedef struct sparrow_map_s {
 157   sparrow_map_row_t *rows;
 158   void *point_mem;
 159 }sparrow_map_t;
 160
 161 typedef struct sparrow_map_lut_s{
 162   guint16 x;
 163   guint16 y;
 164 } sparrow_map_lut_t;
 165
 166 typedef struct sparrow_frame_s {
 167   gint32 offset;
 168   guint32 jpeg_size;
 169   guint8 summary[48];
 170   gint32 successors[8];
 171 } sparrow_frame_t;
 172
 173 typedef struct sparrow_shared_s {
 174   guint8 *jpeg_blob;
 175   guint32 blob_size;
 176   sparrow_frame_t *index;
 177   guint32 image_count;
 178 } sparrow_shared_t;
 179
 180
 181 typedef struct _GstSparrow GstSparrow;
 182 typedef struct _GstSparrowClass GstSparrowClass;
 183
 184 /**
 185  * GstSparrow:
 186  *
 187  * Opaque data structure.
 188  */
 189 struct _GstSparrow
 190 {
 191   GstVideoFilter videofilter;
 192   sparrow_shared_t *shared; /* images, shared between the vaious instances */
 193   sparrow_format in;
 194   sparrow_format out;
 195
 196   /*some calibration modes have big unwieldy structs that attach here */
 197   void *helper_struct;
 198
 199   /* properties / command line options */
 200   gboolean debug;
 201   gboolean use_timer;
 202   guint32 rng_seed;
 203
 204   /* misc */
 205   dsfmt_t *dsfmt;  /*rng*/
 206
 207   /*state */
 208   sparrow_state state;
 209   gint32 countdown; /*intra-state timing*/
 210
 211   guint8 *debug_frame;    /* for constructing debug images */
 212   GstBuffer *in_buffer;
 213
 214   guint32 colour;
 215   guint32 frame_count;
 216
 217   const char *reload;
 218   const char *save;
 219
 220   /*debug timer */
 221   struct timeval timer_start;
 222   struct timeval timer_stop;
 223   FILE * timer_log;
 224
 225   /*calibration results */
 226   guint32 lag;
 227   guint8 *screenmask;
 228   sparrow_map_t map;
 229   /*full sized LUT */
 230   sparrow_map_lut_t *map_lut;
 231   /*for jpeg decompression*/
 232   struct jpeg_decompress_struct *cinfo;
 233 };
 234
 235
 236 struct _GstSparrowClass
 237 {
 238   GstVideoFilterClass parent_class;
 239 };
 240
 241 GType gst_sparrow_get_type(void);
 242
 243
 244 GST_DEBUG_CATEGORY_EXTERN (sparrow_debug);
 245 #define GST_CAT_DEFAULT sparrow_debug
 246
 247 /* GstSparrow signals and args */
 248 enum
 249 {
 250   /* FILL ME */
 251   LAST_SIGNAL
 252 };
 253
 254 enum
 255 {
 256   PROP_0,
 257   PROP_DEBUG,
 258   PROP_TIMER,
 259   PROP_RNG_SEED,
 260   PROP_COLOUR,
 261   PROP_RELOAD,
 262   PROP_SAVE
 263 };
 264
 265 #define DEFAULT_PROP_CALIBRATE TRUE
 266 #define DEFAULT_PROP_DEBUG FALSE
 267 #define DEFAULT_PROP_TIMER FALSE
 268 #define DEFAULT_PROP_RNG_SEED -1
 269 #define DEFAULT_PROP_COLOUR SPARROW_GREEN
 270 #define DEFAULT_PROP_RELOAD ""
 271 #define DEFAULT_PROP_SAVE ""
 272
 273 #define QUOTE_(x) #x
 274 #define QUOTE(x) QUOTE_(x)
 275
 276 /*timing utility code */
 277 #define TIME_TRANSFORM 1
 278
 279 #define TIMER_START(sparrow) do{                        \
 280   if (sparrow->timer_log){                              \
 281     if ((sparrow)->timer_start.tv_sec){                 \
 282       GST_DEBUG("timer already running!\n");            \
 283     }                                                   \
 284     else {                                              \
 285       gettimeofday(&((sparrow)->timer_start), NULL);    \
 286     }                                                   \
 287   }                                                     \
 288   } while (0)
 289
 290 static inline void
 291 TIMER_STOP(GstSparrow *sparrow)
 292 {
 293   if (sparrow->timer_log){
 294     struct timeval *start = &(sparrow->timer_start);
 295     struct timeval *stop = &(sparrow->timer_stop);
 296     if (start->tv_sec == 0){
 297       GST_DEBUG("the timer isn't running!\n");
 298       return;
 299     }
 300     gettimeofday(stop, NULL);
 301     guint32 t = ((stop->tv_sec - start->tv_sec) * 1000000 +
 302         stop->tv_usec - start->tv_usec);
 303
 304 #if SPARROW_NOISY_DEBUG
 305     GST_DEBUG("took %u microseconds (%0.5f of a frame)\n",
 306         t, (double)t * (25.0 / 1000000.0));
 307 #endif
 308
 309     fprintf(sparrow->timer_log, "%d %6d\n", sparrow->state, t);
 310     fflush(sparrow->timer_log);
 311     start->tv_sec = 0; /* mark it as unused */
 312   }
 313 }
 314
 315 /* GST_DISABLE_GST_DEBUG is set in gstreamer compilation. If it is set, we
 316    need our own debug channel. */
 317 #ifdef GST_DISABLE_GST_DEBUG
 318
 319 #undef GST_DEBUG
 320
 321 static FILE *_sparrow_bloody_debug_flags = NULL;
 322 static void
 323 GST_DEBUG(const char *msg, ...){
 324   if (! _sparrow_bloody_debug_flags){
 325     _sparrow_bloody_debug_flags = fopen("/tmp/sparrow.log", "wb");
 326     if (! _sparrow_bloody_debug_flags){
 327       exit(1);
 328     }
 329   }
 330   va_list argp;
 331   va_start(argp, msg);
 332   vfprintf(_sparrow_bloody_debug_flags, msg, argp);
 333   va_end(argp);
 334   fflush(_sparrow_bloody_debug_flags);
 335 }
 336
 337 #define GST_ERROR        GST_DEBUG
 338 #define GST_WARNING      GST_DEBUG
 339 #define GST_INFO         GST_DEBUG
 340 #define GST_LOG          GST_DEBUG
 341 #define GST_FIXME        GST_DEBUG
 342
 343 #endif
 344 #define LOG_LINENO() GST_DEBUG("%-25s  line %4d \n", __func__, __LINE__ );
 345
 346
 347 G_END_DECLS
 348 #endif /* __GST_VIDEO_SPARROW_H__ */