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_lut_s{
 149   guint16 x;
 150   guint16 y;
 151 } sparrow_map_lut_t;
 152
 153 typedef struct sparrow_frame_s {
 154   gint32 offset;
 155   guint32 jpeg_size;
 156   guint8 summary[48];
 157   gint32 successors[8];
 158 } sparrow_frame_t;
 159
 160 typedef struct sparrow_shared_s {
 161   guint8 *jpeg_blob;
 162   guint32 blob_size;
 163   sparrow_frame_t *index;
 164   guint32 image_count;
 165 } sparrow_shared_t;
 166
 167
 168 typedef struct _GstSparrow GstSparrow;
 169 typedef struct _GstSparrowClass GstSparrowClass;
 170
 171 /**
 172  * GstSparrow:
 173  *
 174  * Opaque data structure.
 175  */
 176 struct _GstSparrow
 177 {
 178   GstVideoFilter videofilter;
 179   sparrow_shared_t *shared; /* images, shared between the vaious instances */
 180   sparrow_format in;
 181   sparrow_format out;
 182
 183   /*some calibration modes have big unwieldy structs that attach here */
 184   void *helper_struct;
 185
 186   /* properties / command line options */
 187   gboolean debug;
 188   gboolean use_timer;
 189   guint32 rng_seed;
 190
 191   /* misc */
 192   dsfmt_t *dsfmt;  /*rng*/
 193
 194   /*state */
 195   sparrow_state state;
 196   gint32 countdown; /*intra-state timing*/
 197
 198   guint8 *debug_frame;    /* for constructing debug images */
 199   GstBuffer *in_buffer;
 200
 201   guint32 colour;
 202   guint32 frame_count;
 203
 204   const char *reload;
 205   const char *save;
 206
 207   /*debug timer */
 208   struct timeval timer_start;
 209   struct timeval timer_stop;
 210   FILE * timer_log;
 211
 212   /*calibration results */
 213   guint32 lag;
 214   guint8 *screenmask;
 215   /*full sized LUT */
 216   sparrow_map_lut_t *map_lut;
 217   /*for jpeg decompression*/
 218   struct jpeg_decompress_struct *cinfo;
 219 };
 220
 221
 222 struct _GstSparrowClass
 223 {
 224   GstVideoFilterClass parent_class;
 225 };
 226
 227 GType gst_sparrow_get_type(void);
 228
 229
 230 GST_DEBUG_CATEGORY_EXTERN (sparrow_debug);
 231 #define GST_CAT_DEFAULT sparrow_debug
 232
 233 /* GstSparrow signals and args */
 234 enum
 235 {
 236   /* FILL ME */
 237   LAST_SIGNAL
 238 };
 239
 240 enum
 241 {
 242   PROP_0,
 243   PROP_DEBUG,
 244   PROP_TIMER,
 245   PROP_RNG_SEED,
 246   PROP_COLOUR,
 247   PROP_RELOAD,
 248   PROP_SAVE
 249 };
 250
 251 #define DEFAULT_PROP_CALIBRATE TRUE
 252 #define DEFAULT_PROP_DEBUG FALSE
 253 #define DEFAULT_PROP_TIMER FALSE
 254 #define DEFAULT_PROP_RNG_SEED -1
 255 #define DEFAULT_PROP_COLOUR SPARROW_GREEN
 256 #define DEFAULT_PROP_RELOAD ""
 257 #define DEFAULT_PROP_SAVE ""
 258
 259 #define QUOTE_(x) #x
 260 #define QUOTE(x) QUOTE_(x)
 261
 262 /*timing utility code */
 263 #define TIME_TRANSFORM 1
 264
 265 #define TIMER_START(sparrow) do{                        \
 266   if (sparrow->timer_log){                              \
 267     if ((sparrow)->timer_start.tv_sec){                 \
 268       GST_DEBUG("timer already running!\n");            \
 269     }                                                   \
 270     else {                                              \
 271       gettimeofday(&((sparrow)->timer_start), NULL);    \
 272     }                                                   \
 273   }                                                     \
 274   } while (0)
 275
 276 static inline void
 277 TIMER_STOP(GstSparrow *sparrow)
 278 {
 279   if (sparrow->timer_log){
 280     struct timeval *start = &(sparrow->timer_start);
 281     struct timeval *stop = &(sparrow->timer_stop);
 282     if (start->tv_sec == 0){
 283       GST_DEBUG("the timer isn't running!\n");
 284       return;
 285     }
 286     gettimeofday(stop, NULL);
 287     guint32 t = ((stop->tv_sec - start->tv_sec) * 1000000 +
 288         stop->tv_usec - start->tv_usec);
 289
 290 #if SPARROW_NOISY_DEBUG
 291     GST_DEBUG("took %u microseconds (%0.5f of a frame)\n",
 292         t, (double)t * (25.0 / 1000000.0));
 293 #endif
 294
 295     fprintf(sparrow->timer_log, "%d %6d\n", sparrow->state, t);
 296     fflush(sparrow->timer_log);
 297     start->tv_sec = 0; /* mark it as unused */
 298   }
 299 }
 300
 301 /* GST_DISABLE_GST_DEBUG is set in gstreamer compilation. If it is set, we
 302    need our own debug channel. */
 303 #ifdef GST_DISABLE_GST_DEBUG
 304
 305 #undef GST_DEBUG
 306
 307 static FILE *_sparrow_bloody_debug_flags = NULL;
 308 static void
 309 GST_DEBUG(const char *msg, ...){
 310   if (! _sparrow_bloody_debug_flags){
 311     _sparrow_bloody_debug_flags = fopen("/tmp/sparrow.log", "wb");
 312     if (! _sparrow_bloody_debug_flags){
 313       exit(1);
 314     }
 315   }
 316   va_list argp;
 317   va_start(argp, msg);
 318   vfprintf(_sparrow_bloody_debug_flags, msg, argp);
 319   va_end(argp);
 320   fflush(_sparrow_bloody_debug_flags);
 321 }
 322
 323 #define GST_ERROR        GST_DEBUG
 324 #define GST_WARNING      GST_DEBUG
 325 #define GST_INFO         GST_DEBUG
 326 #define GST_LOG          GST_DEBUG
 327 #define GST_FIXME        GST_DEBUG
 328
 329 #endif
 330 #define LOG_LINENO() GST_DEBUG("%-25s  line %4d \n", __func__, __LINE__ );
 331
 332
 333 G_END_DECLS
 334 #endif /* __GST_VIDEO_SPARROW_H__ */