Fixes comments from previous commmit
authorJean-Marc Valin <jmvalin@jmvalin.ca>
Mon, 27 May 2013 19:41:00 +0000 (15:41 -0400)
committerJean-Marc Valin <jmvalin@jmvalin.ca>
Mon, 27 May 2013 19:41:00 +0000 (15:41 -0400)
include/daala/codec.h
src/state.h

index d6c2ae2..4b78314 100644 (file)
@@ -131,21 +131,26 @@ const char *daala_version_string(void);
 
 struct od_img_plane {
   unsigned char *data;
-  unsigned char xdec; // The decimation factor in x direction. Pixesl are
-                      // reduced by a factor of 2^xdec so  0 is none, 1 is
-                      // decimated by a factor of 2. ( YUV420 will have xdec of 1
-                      // and ydec also of 1. YUV444 will have xdec and ydec set
-                      // to zero )x
+  /** The decimation factor in x direction. Pixesl are reduced by a factor of
+      2^xdec so  0 is none, 1 is decimated by a factor of 2. ( YUV420 will
+      have xdec of 1 and ydec also of 1. YUV444 will have xdec and ydec set to
+      zero ). */
+  unsigned char xdec;
   unsigned char ydec;
-  int xstride; // distance in memory between two pixels horizontally next to each other in (is always 1 in encoder) 
-  int ystride; // distance in memory between two pixels vertically next to each other  
+  /** Distance in memory between two pixels horizontally next to each other in
+      (is always 1 in encoder). */
+  int xstride;
+  /** Distance in memory between two pixels vertically next to each other. */
+  int ystride;
 };
 
 struct od_img {
-  od_img_plane planes[OD_NPLANES_MAX]; // typical 3 planes for Y, Cb, and
-                                        // Cr. Can have a 4th plane for alpha 
-  int nplanes; // number of planes (1 for greyscale, 3 for YCbCr, 4 for YCbCr+Alpha )
-  ogg_int32_t width; // width and height in pixels 
+  /** Typical 3 planes for Y, Cb, and  Cr. Can have a 4th plane for alpha */
+  od_img_plane planes[OD_NPLANES_MAX];
+  /** Number of planes (1 for greyscale, 3 for YCbCr, 4 for YCbCr+Alpha ) */
+  int nplanes;
+  /** Width and height in pixels */
+  ogg_int32_t width;
   ogg_int32_t height;
 };
 
@@ -160,7 +165,8 @@ struct daala_info {
   unsigned char version_sub;
   ogg_int32_t frame_width;
   ogg_int32_t frame_height;
-  ogg_int32_t pic_x; // pic_x,_y,_width,_height form a region of interest to encode 
+  /** pic_x,_y,_width,_height form a region of interest to encode */
+  ogg_int32_t pic_x;
   ogg_int32_t pic_y;
   ogg_int32_t pic_width;
   ogg_int32_t pic_height;
index 976cabc..390aa2e 100644 (file)
@@ -87,17 +87,23 @@ struct od_state{
   od_state_opt_vtbl   opt_vtbl;
   ogg_uint32_t        cpu_flags;
   od_img              input;
-  int                 ref_imgi[4]; // buffer for the 4 ref images 
-  od_img              ref_imgs[4]; // pointers to the ref images so one can
-                                   // move them around without coping them 
-  od_img              io_imgs[2]; // pointer to input and output image 
+  /** Buffer for the 4 ref images. */
+  int                 ref_imgi[4];
+  /** Pointers to the ref images so one can move them around without coping
+      them. */
+  od_img              ref_imgs[4];
+  /** Pointer to input and output image. */
+  od_img              io_imgs[2];
   unsigned char      *ref_line_buf[8];
   unsigned char      *ref_img_data;
-  ogg_int64_t         cur_time; // increments by 1 for each frame 
+  /** Increments by 1 for each frame. */
+  ogg_int64_t         cur_time;
   od_mv_grid_pt     **mv_grid;
   od_adapt_row_ctx    adapt_row[OD_NPLANES_MAX];
-  int                 nhmbs; // number of horizontal macro blocks 
-  int                 nvmbs; // number of vertical macro blocks 
+  /** number of horizontal macro blocks. */
+  int                 nhmbs;
+  /** number of vertical macro blocks. */
+  int                 nvmbs;
 #if defined(OD_DUMP_IMAGES)
   od_img              vis_img;
 #if defined(OD_ANIMATE)