John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 1 | /*! \page usage_decode Decoding |
| 2 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 3 | The aom_codec_decode() function is at the core of the decode loop. It |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 4 | processes packets of compressed data passed by the application, producing |
| 5 | decoded images. The decoder expects packets to comprise exactly one image |
| 6 | frame of data. Packets \ref MUST be passed in decode order. If the |
| 7 | application wishes to associate some data with the frame, the |
Sean DuBois | 47cc255 | 2018-01-23 07:44:16 +0000 | [diff] [blame] | 8 | <code>user_priv</code> member may be set. |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 9 | |
| 10 | \ref samples |
| 11 | |
| 12 | |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 13 | \section usage_frame_iter Frame Iterator Based Decoding |
Wan-Teh Chang | 11ad74f | 2020-04-25 17:14:54 -0700 | [diff] [blame] | 14 | Decoded frames are made available to the application |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 15 | through the aom_codec_get_frame() iterator. The application initializes the |
| 16 | iterator storage (of type #aom_codec_iter_t) to NULL, then calls |
| 17 | aom_codec_get_frame repeatedly until it returns NULL, indicating that all |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 18 | images have been returned. This process may result in zero, one, or many |
| 19 | frames that are ready for display, depending on the codec. |
| 20 | |
| 21 | |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 22 | */ |