blob: 76dc213bf06d355dfd86a902445e940be30610d5 [file] [log] [blame]
John Koleszar0ea50ce2010-05-18 11:58:33 -04001/*! \page usage_decode Decoding
2
Yaowu Xuf883b422016-08-30 14:01:10 -07003 The aom_codec_decode() function is at the core of the decode loop. It
John Koleszar0ea50ce2010-05-18 11:58:33 -04004 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 DuBois47cc2552018-01-23 07:44:16 +00008 <code>user_priv</code> member may be set.
John Koleszar0ea50ce2010-05-18 11:58:33 -04009
10 \ref samples
11
12
John Koleszar0ea50ce2010-05-18 11:58:33 -040013 \section usage_frame_iter Frame Iterator Based Decoding
Wan-Teh Chang11ad74f2020-04-25 17:14:54 -070014 Decoded frames are made available to the application
Yaowu Xuf883b422016-08-30 14:01:10 -070015 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 Koleszar0ea50ce2010-05-18 11:58:33 -040018 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 Koleszar0ea50ce2010-05-18 11:58:33 -040022*/