"

 COPYRIGHT (c) 1997 by eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libview2' }"

ImageReader subclass:#AVIReader

	instanceVariableNames:'riffReader frames nframes frameBuffer frameBufferSize imageBuffer

		redPalette greenPalette bluePalette flags frameDelay streamType

		depth compression colorTable numColors deltaMethod'

	classVariableNames:'MAXCOLORS UnsupportedFormatErrorSignal'

	poolDictionaries:''

	category:'Graphics-Images-Readers'

!

!AVIReader class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 by eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    This is not yet completed, untested and highly experimental.

    This reader read frames from an AVI file; however, only a tiny subset of AVI is supported.

    This is a very first attempt in reading AVI files;

    Its very experimental, preliminary and will certainly change.

    (will introduce a new class hierarchy based upon some MovieReader ...).

    When used like an imageReader, #fromFile: will return

    the very first frame and the rest as imageFrameSequence.

    Warning: 

        right now, the complete movie is read and huge

        amounts of memory are allocated.

        The interface will be changed to allow stream operation ...

    [author:]

        Claus Gittinger

    [see also:]

        ImageReader RIFFReader

"

!

examples

"

    |reader film view tNext|

    reader := AVIReader readFile:'/phys/exept/home/pd_stuff/movies/avi/drlair.avi'.      

    reader isNil ifTrue:[^ nil].

    film := reader images.

    view := StandardSystemView extent:(film first extent).

    view openAndWait.

    tNext := Time millisecondClockValue + (reader frameDelay).

    film do:[:frame |

        frame displayOn:view x:0 y:0.

        (Delay untilMilliseconds:tNext) wait.

        tNext := tNext + (reader frameDelay).

    ].

"

! !

!AVIReader class methodsFor:'class initialization'!

initialize

    MAXCOLORS := 256.

    UnsupportedFormatErrorSignal isNil ifTrue:[

        UnsupportedFormatErrorSignal := ErrorSignal newSignalMayProceed:true.

        UnsupportedFormatErrorSignal nameClass:self message:#unsupportedFormatErrorSignal.

    ].

    "

     AVIReader initialize

    "

    "Created: 4.4.1997 / 22:35:52 / cg"

    "Modified: 5.4.1997 / 14:37:08 / cg"

! !

!AVIReader class methodsFor:'testing'!

isValidImageFile:aFileName

    "return true, if aFileName contains an AVI-movie"

    ^ RIFFReader isRIFFFile:aFileName withType:'AVI'

    "

     AVIReader isValidImageFile:'bitmaps/magtape.xpm'                     

     AVIReader isValidImageFile:'/phys/exept/home/pd_stuff/movies/avi/drlair.avi'      

    "

    "Created: 4.4.1997 / 22:35:52 / cg"

    "Modified: 4.4.1997 / 23:15:39 / cg"

! !

!AVIReader methodsFor:'accessing'!

frameDelay

    "return the value of the instance variable 'frameDelay' (automatically generated)"

    ^ frameDelay

    "Created: 4.4.1997 / 22:35:52 / cg"

!

images

    "return a collection of all images as represented by myself"

    |image depth|

    depth := self bitsPerPixel.

    1 to:imageSequence size do:[:i |

        |frame|

        frame := imageSequence at:i.

        frame isImage ifFalse:[

            image := (Image implementorForDepth:depth) new.

            image 

                width:width 

                height:height

                photometric:photometric

                samplesPerPixel:samplesPerPixel

                bitsPerSample:bitsPerSample

                colorMap:colorMap

                bits:frame

                mask:mask.

            imageSequence at:i put:image.

        ].

    ].

    ^ imageSequence

    "Created: 4.4.1997 / 22:35:52 / cg"

    "Modified: 24.6.1997 / 15:57:17 / cg"

! !

!AVIReader methodsFor:'decoders'!

AVI_Decode_CRAM:data

"

/*

 * Routine to Decode an AVI CRAM chunk

 */

#define AVI_CRAM_C1(ip,clr,rdec) { \

 *ip++ = clr; *ip++ = clr; *ip++ = clr; *ip = clr; ip -= rdec; \

 *ip++ = clr; *ip++ = clr; *ip++ = clr; *ip = clr; ip -= rdec; \

 *ip++ = clr; *ip++ = clr; *ip++ = clr; *ip = clr; ip -= rdec; \

 *ip++ = clr; *ip++ = clr; *ip++ = clr; *ip = clr; }

#define AVI_CRAM_C2(ip,flag,cA,cB,rdec) { \

  *ip++ =(flag&0x01)?(cB):(cA); *ip++ =(flag&0x02)?(cB):(cA); \

  *ip++ =(flag&0x04)?(cB):(cA); *ip   =(flag&0x08)?(cB):(cA); ip-=rdec; \

  *ip++ =(flag&0x10)?(cB):(cA); *ip++ =(flag&0x20)?(cB):(cA); \

  *ip++ =(flag&0x40)?(cB):(cA); *ip   =(flag&0x80)?(cB):(cA); }

#define AVI_CRAM_C4(ip,flag,cA0,cA1,cB0,cB1,rdec) { \

  *ip++ =(flag&0x01)?(cB0):(cA0); *ip++ =(flag&0x02)?(cB0):(cA0); \

  *ip++ =(flag&0x04)?(cB1):(cA1); *ip   =(flag&0x08)?(cB1):(cA1); ip-=rdec; \

  *ip++ =(flag&0x10)?(cB0):(cA0); *ip++ =(flag&0x20)?(cB0):(cA0); \

  *ip++ =(flag&0x40)?(cB1):(cA1); *ip   =(flag&0x80)?(cB1):(cA1); }

#define AVI_MIN_MAX_CHECK(x,y,min_x,max_x,min_y,max_y) { \

    if (x < min_x) min_x = x; if (y > max_y) max_y = y; \

    if (x > max_x) max_x = x; if (y < min_y) min_y = y; } 

#define AVI_BLOCK_INC(x,y,imagex) { x += 4; if (x>=imagex) { x=0; y -= 4; } }

#define AVI_GET_16(data,dptr) { data = *dptr++; data |= (*dptr++) << 8; }

#define AVI_CRAM_rgbC1(ip,r,g,b) { \

 *ip++=r; *ip++=g; *ip++=b; *ip++=r; *ip++=g; *ip++=b; \

 *ip++=r; *ip++=g; *ip++=b; *ip++=r; *ip++=g; *ip  =b; }

#define AVI_CRAM_rgbC2(ip,flag,rA,gA,bA,rB,gB,bB) { \

  if (flag&0x01) {*ip++=rB; *ip++=gB; *ip++=bB;} \

  else           {*ip++=rA; *ip++=gA; *ip++=bA;} \

  if (flag&0x02) {*ip++=rB; *ip++=gB; *ip++=bB;} \

  else           {*ip++=rA; *ip++=gA; *ip++=bA;} \

  if (flag&0x04) {*ip++=rB; *ip++=gB; *ip++=bB;} \

  else           {*ip++=rA; *ip++=gA; *ip++=bA;} \

  if (flag&0x08) {*ip++=rB; *ip++=gB; *ip  =bB;} \

  else           {*ip++=rA; *ip++=gA; *ip  =bA;}  }

#define AVI_CRAM_rgbC4(ip,flag,rA,gA,bA,rB,gB,bB) { \

  if (flag&0x01) {*ip++=rB; *ip++=gB; *ip++=bB;} \

  else           {*ip++=rA; *ip++=gA; *ip++=bA;} \

  if (flag&0x02) {*ip++=rB; *ip++=gB; *ip  =bB;} \

  else           {*ip++=rA; *ip++=gA; *ip  =bA;} }

#define AVI_Get_RGBColor(r,g,b,color) \

{ register ULONG _r,_g,_b; \

  _r = (color >> 10) & 0x1f; r = (_r << 3) | (_r >> 2); \

  _g = (color >>  5) & 0x1f; g = (_g << 3) | (_g >> 2); \

  _b =  color & 0x1f;        b = (_b << 3) | (_b >> 2); \

  if (xa_gamma_flag==TRUE) { r = xa_gamma_adj[r]>>8;    \

     g = xa_gamma_adj[g]>>8; b = xa_gamma_adj[b]>>8; } }

ULONG

AVI_Decode_CRAM(image,delta,dsize,chdr,map,map_flag,imagex,imagey,imaged,

                                                xs,ys,xe,ye,special,extra)

UBYTE *image;           /* Image Buffer. */

UBYTE *delta;           /* delta data. */

ULONG dsize;            /* delta size */

XA_CHDR *chdr;          /* color map info */

ULONG *map;             /* used if it's going to be remapped. */

ULONG map_flag;         /* whether or not to use remap_map info. */

ULONG imagex,imagey;    /* Size of image buffer. */

ULONG imaged;           /* Depth of Image. (IFF specific) */

ULONG *xs,*ys;          /* pos of changed area. */

ULONG *xe,*ye;          /* size of changed area. */

ULONG special;          /* Special Info. */

void *extra;            /* extra info needed to decode delta */

{

  ULONG row_dec,exitflag,changed,block_cnt;

  ULONG code0,code1;

  LONG x,y,min_x,max_x,min_y,max_y;

  UBYTE *dptr;

  changed = 0;

  max_x = max_y = 0;    min_x = imagex; min_y = imagey;

  dptr = delta;

  row_dec = imagex + 3;

  x = 0;

  y = imagey - 1;

  exitflag = 0;

  block_cnt = ((imagex * imagey) >> 4) + 1;

  if (map_flag == TRUE)

  {

    if (x11_bytes_pixel == 4)

    {

      while(!!exitflag)

      {

        code0 =  *dptr++;       code1 =  *dptr++;       block_cnt--;

        if ( ((code1==0) && (code0==0) && !!block_cnt) || (y<0)) exitflag = 1;

        else

        {

          if ((code1 >= 0x84) && (code1 <= 0x87)) /* skip */

          { ULONG skip = ((code1 - 0x84) << 8) + code0;

            block_cnt -= (skip-1); while(skip--) AVI_BLOCK_INC(x,y,imagex);

          }

          else /* single block encoded */

          {

            if (code1 >= 0x90) /* 8 color quadrant encoding */

            { ULONG cA0,cA1,cB0,cB1;

              ULONG *i_ptr = (ULONG *)(image + ((y * imagex + x) << 2) );

              cB0 = (ULONG)map[*dptr++];  cA0 = (ULONG)map[*dptr++];

              cB1 = (ULONG)map[*dptr++];  cA1 = (ULONG)map[*dptr++];

              AVI_CRAM_C4(i_ptr,code0,cA0,cA1,cB0,cB1,row_dec); i_ptr -=row_dec;

              cB0 = (ULONG)map[*dptr++];  cA0 = (ULONG)map[*dptr++];

              cB1 = (ULONG)map[*dptr++];  cA1 = (ULONG)map[*dptr++];

              AVI_CRAM_C4(i_ptr,code1,cA0,cA1,cB0,cB1,row_dec);

            } else if (code1 < 0x80) /* 2 color encoding */

            { register ULONG clr_A,clr_B;

              ULONG *i_ptr = (ULONG *)(image + ((y * imagex + x) << 2) );

              clr_B = (ULONG)map[*dptr++];   clr_A = (ULONG)map[*dptr++];

              AVI_CRAM_C2(i_ptr,code0,clr_A,clr_B,row_dec); i_ptr -= row_dec;

              AVI_CRAM_C2(i_ptr,code1,clr_A,clr_B,row_dec);

            }

            else /* 1 color encoding */

            { ULONG clr = (ULONG)map[code0]; 

              ULONG *i_ptr = (ULONG *)(image + ((y * imagex + x) << 2) );

              AVI_CRAM_C1(i_ptr,clr,row_dec);

            }

            AVI_MIN_MAX_CHECK(x,y,min_x,max_x,min_y,max_y);

            changed = 1; AVI_BLOCK_INC(x,y,imagex);

          } /* end of single block */

        } /* end of not term code */

      } /* end of not while exit */

    } /* end of 4 bytes pixel */

    else if (x11_bytes_pixel == 2)

    {

      while(!!exitflag)

      {

        code0 =  *dptr++;       code1 =  *dptr++;       block_cnt--;

        if ( ((code1==0) && (code0==0) && !!block_cnt) || (y<0)) exitflag = 1;

        else

        {

          if ((code1 >= 0x84) && (code1 <= 0x87)) /* skip */

          { ULONG skip = ((code1 - 0x84) << 8) + code0;

            block_cnt -= (skip-1); while(skip--) AVI_BLOCK_INC(x,y,imagex);

          } else /* single block encoded */

          {

            if (code1 >= 0x90) /* 8 color quadrant encoding */

            {

              USHORT cA0,cA1,cB0,cB1;

              USHORT *i_ptr = (USHORT *)(image + ((y * imagex + x) << 1) );

              cB0 = map[*dptr++];  cA0 = map[*dptr++];

              cB1 = map[*dptr++];  cA1 = map[*dptr++];

              AVI_CRAM_C4(i_ptr,code0,cA0,cA1,cB0,cB1,row_dec); i_ptr -=row_dec;

              cB0 = map[*dptr++];  cA0 = map[*dptr++];

              cB1 = map[*dptr++];  cA1 = map[*dptr++];

              AVI_CRAM_C4(i_ptr,code1,cA0,cA1,cB0,cB1,row_dec);

            } /* end of 8 color quadrant encoding */

            else if (code1 < 0x80) /* 2 color encoding */

            { USHORT clr_A,clr_B;

              USHORT *i_ptr = (USHORT *)(image + ((y * imagex + x) << 1) );

              clr_B = (USHORT)map[*dptr++];   clr_A = (USHORT)map[*dptr++];

              AVI_CRAM_C2(i_ptr,code0,clr_A,clr_B,row_dec); i_ptr -= row_dec;

              AVI_CRAM_C2(i_ptr,code1,clr_A,clr_B,row_dec);

            } /* end of 2 color */

            else /* 1 color encoding */

            { USHORT clr = (USHORT)map[code0];

              USHORT *i_ptr = (USHORT *)(image + ((y * imagex + x) << 1) );

              AVI_CRAM_C1(i_ptr,clr,row_dec);

            }

            AVI_MIN_MAX_CHECK(x,y,min_x,max_x,min_y,max_y);

            changed = 1; AVI_BLOCK_INC(x,y,imagex);

          } /* end of single block */

        } /* end of not term code */

      } /* end of not while exit */

    } /* end of 2 bytes pixel */

    else /* (x11_bytes_pixel == 1) */

    {

      while(!!exitflag)

      {

        code0 =  *dptr++;       code1 =  *dptr++;       block_cnt--;

        if ( ((code1==0) && (code0==0) && !!block_cnt) || (y<0)) exitflag = 1;

        else

        {

          if ((code1 >= 0x84) && (code1 <= 0x87)) /* skip */

          { ULONG skip = ((code1 - 0x84) << 8) + code0;

            block_cnt -= (skip-1); while(skip--) AVI_BLOCK_INC(x,y,imagex);

          } else /* single block encoded */

          { 

            if (code1 >= 0x90) /* 8 color quadrant encoding */

            { UBYTE cA0,cA1,cB0,cB1;

              UBYTE *i_ptr = (UBYTE *)(image + y * imagex + x);

              cB0 = (UBYTE)map[*dptr++];  cA0 = (UBYTE)map[*dptr++];

              cB1 = (UBYTE)map[*dptr++];  cA1 = (UBYTE)map[*dptr++];

              AVI_CRAM_C4(i_ptr,code0,cA0,cA1,cB0,cB1,row_dec); i_ptr -=row_dec;

              cB0 = (UBYTE)map[*dptr++];  cA0 = (UBYTE)map[*dptr++];

              cB1 = (UBYTE)map[*dptr++];  cA1 = (UBYTE)map[*dptr++];

              AVI_CRAM_C4(i_ptr,code1,cA0,cA1,cB0,cB1,row_dec);

            } 

            else if (code1 < 0x80) /* 2 color encoding */

            { UBYTE clr_A,clr_B;

              UBYTE *i_ptr = (UBYTE *)(image + y * imagex + x);

              clr_B = (UBYTE)map[*dptr++];   clr_A = (UBYTE)map[*dptr++];

              AVI_CRAM_C2(i_ptr,code0,clr_A,clr_B,row_dec); i_ptr -= row_dec;

              AVI_CRAM_C2(i_ptr,code1,clr_A,clr_B,row_dec);

            }

            else /* 1 color encoding */

            { UBYTE clr = (UBYTE)map[code0];

              UBYTE *i_ptr = (UBYTE *)(image + y * imagex + x);

              AVI_CRAM_C1(i_ptr,clr,row_dec);

            }

            AVI_MIN_MAX_CHECK(x,y,min_x,max_x,min_y,max_y);

            changed = 1; AVI_BLOCK_INC(x,y,imagex);

          } /* end of single block */

        } /* end of not term code */

      } /* end of not while exit */

    } /* end of 1 bytes pixel */

  } /* end of map is TRUE */

  else

  {

      while(!!exitflag)

      {

        code0 =  *dptr++;       code1 =  *dptr++;       block_cnt--;

        if ( ((code1==0) && (code0==0) && !!block_cnt) || (y<0)) exitflag = 1;

        else

        {

          if ((code1 >= 0x84) && (code1 <= 0x87)) /* skip */

          { ULONG skip = ((code1 - 0x84) << 8) + code0;

            block_cnt -= (skip-1); while(skip--) AVI_BLOCK_INC(x,y,imagex);

          } else /* single block encoded */

          {

            if (code1 >= 0x90) /* 8 color quadrant encoding */

            {

              UBYTE cA0,cA1,cB0,cB1;

              UBYTE *i_ptr = (UBYTE *)(image + y * imagex + x);

              cB0 = (UBYTE)*dptr++;  cA0 = (UBYTE)*dptr++;

              cB1 = (UBYTE)*dptr++;  cA1 = (UBYTE)*dptr++;

              AVI_CRAM_C4(i_ptr,code0,cA0,cA1,cB0,cB1,row_dec); i_ptr -=row_dec;

              cB0 = (UBYTE)*dptr++;  cA0 = (UBYTE)*dptr++;

              cB1 = (UBYTE)*dptr++;  cA1 = (UBYTE)*dptr++;

              AVI_CRAM_C4(i_ptr,code1,cA0,cA1,cB0,cB1,row_dec);

            } 

            else if (code1 < 0x80) /* 2 color encoding */

            { UBYTE clr_A,clr_B;

              UBYTE *i_ptr = (UBYTE *)(image + y * imagex + x);

              clr_B = (UBYTE)*dptr++;   clr_A = (UBYTE)*dptr++;

              AVI_CRAM_C2(i_ptr,code0,clr_A,clr_B,row_dec); i_ptr -= row_dec;

              AVI_CRAM_C2(i_ptr,code1,clr_A,clr_B,row_dec);

            } /* end of 2 color */

            else /* 1 color encoding */

            {

              UBYTE clr = (UBYTE)code0;

              UBYTE *i_ptr = (UBYTE *)(image + y * imagex + x);

              AVI_CRAM_C1(i_ptr,clr,row_dec);

            }

            AVI_MIN_MAX_CHECK(x,y,min_x,max_x,min_y,max_y);

            changed = 1; AVI_BLOCK_INC(x,y,imagex);

          } /* end of single block */

        } /* end of not term code */

      } /* end of not while exit */

  }

  if (xa_optimize_flag == TRUE)

  {

    if (changed) { *xs=min_x; *ys=min_y - 3; *xe=max_x + 4; *ye=max_y + 1; }

    else  { *xs = *ys = *xe = *ye = 0; return(ACT_DLTA_NOP); }

  }

  else { *xs = *ys = 0; *xe = imagex; *ye = imagey; }

  if (map_flag) return(ACT_DLTA_MAPD);

  else return(ACT_DLTA_NORM);

}

"

    'AVI_Decode_CRAM' infoPrint.

    "

     AVIReader fromFile:'/home2/pd_stuff/movies/avi/hangldm.avi'      

    "

    "Created: 5.4.1997 / 16:06:10 / cg"

    "Modified: 11.4.1997 / 14:03:32 / cg"

! !

!AVIReader methodsFor:'helpers'!

alignHeightTo:multiple

    "make height a multiple of the argument"

    height := multiple * ((height + multiple - 1) // multiple).

    "Modified: 5.4.1997 / 14:47:36 / cg"

!

alignTo:multiple

    "make width & height a multiple of the argument"

    width := multiple * ((width + multiple - 1) // multiple).

    height := multiple * ((height + multiple - 1) // multiple).

    "Created: 5.4.1997 / 14:47:54 / cg"

!

alignWidthTo:multiple

    "make height a multiple of the argument"

    width := multiple * ((width + multiple - 1) // multiple).

    "Created: 5.4.1997 / 14:47:16 / cg"

    "Modified: 5.4.1997 / 14:47:41 / cg"

! !

!AVIReader methodsFor:'private-reading'!

getChunk_ISBJ:chunkSize

    "process (ignore) a ISBJ chunk"

    'getChunk_ISBJ -> ' infoPrint.

    self skipChunk:chunkSize

    "Created: 5.4.1997 / 15:19:17 / cg"

!

getChunk_auds:chunkSize

    "process an auds chunk"

    |format channels rate av_bps align size|

    'getChunk_auds' infoPrint.

    format      := inStream nextShortMSB:false.

    channels    := inStream nextShortMSB:false.

    rate        := inStream nextLongMSB:false.

    av_bps      := inStream nextLongMSB:false.

    align       := inStream nextShortMSB:false.

    size        := inStream nextShortMSB:false.

    inStream skip:(chunkSize - 16).

    "

     AVIReader fromFile:'/home2/pd_stuff/movies/avi/hangldm.avi'      

    "

    "Created: 5.4.1997 / 00:01:15 / cg"

    "Modified: 5.4.1997 / 14:34:36 / cg"

!

getChunk_auds_wb:chunkSize

    "process (ignore for now) an auds chunk"

    'getChunk_auds_wb -> ' infoPrint.

    self skipChunk:chunkSize

    "

     AVIReader fromFile:'/home2/pd_stuff/movies/avi/hangldm.avi'      

    "