How to Retrieve the Frames from an Image

This topic demonstrates how to decode a multi-frame image and retrieve each frame for processing.

To retrieve the frames of an image

1. Create an IWICImagingFactory to create Windows Imaging Component (WIC) objects.

   // Create WIC factory
   hr = CoCreateInstance(
       CLSID_WICImagingFactory,
       NULL,
       CLSCTX_INPROC_SERVER,
       IID_PPV_ARGS(&m_pIWICFactory)
       );
   

2. Use the CreateDecoderFromFilename method to create an IWICBitmapDecoder from an image file.

   HRESULT hr = S_OK;
   
   IWICBitmapDecoder *pIDecoder = NULL;
   IWICBitmapFrameDecode *pIDecoderFrame  = NULL;
   UINT nFrameCount = 0;
   UINT uiWidth, uiHeight;
   
   // Create decoder for an image.
   hr = m_pIWICFactory->CreateDecoderFromFilename(
      L"creek.tiff",                  // Image to be decoded
      NULL,                           // Do not prefer a particular vendor
      GENERIC_READ,                   // Desired read access to the file
      WICDecodeMetadataCacheOnDemand, // Cache metadata when needed
      &pIDecoder                      // Pointer to the decoder
      );
   

3. Retrieve the number of frames in the images.

   // Retrieve the frame count of the image.
   if (SUCCEEDED(hr))
   {
      hr = pIDecoder->GetFrameCount(&nFrameCount);
   }
   

4. Process each frame by obtaining an IWICBitmapFrameDecode for each frame in the image.

   // Process each frame in the image.
   for (UINT i=0; i < nFrameCount; i++)
   {
      // Retrieve the next bitmap frame.
      if (SUCCEEDED(hr))
      {
         hr = pIDecoder->GetFrame(i, &pIDecoderFrame);
      }
   
      // Retrieve the size of the bitmap frame.
      if (SUCCEEDED(hr))
      {
         hr = pIDecoderFrame->GetSize(&uiWidth, &uiHeight);
      }
   
      // Additional frame processing.
      // ...
   
      SafeRelease(&pIDecoderFrame);
   }
   

See Also

Programming Guide

Reference

Samples