Browse code

lavc: Mark fields that require av_opt_ptr()

Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

Michael Niedermayer authored on 2011/12/05 21:23:17
Showing 1 changed files
... ...
@@ -1256,6 +1256,8 @@ typedef struct AVFrame {
1256 1256
 
1257 1257
     /**
1258 1258
      * frame timestamp estimated using various heuristics, in stream time base
1259
+     * Code outside libavcodec should access this field using:
1260
+     *  av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1259 1261
      * - encoding: unused
1260 1262
      * - decoding: set by libavcodec, read by user.
1261 1263
      */
... ...
@@ -1263,6 +1265,8 @@ typedef struct AVFrame {
1263 1263
 
1264 1264
     /**
1265 1265
      * reordered pos from the last AVPacket that has been input into the decoder
1266
+     * Code outside libavcodec should access this field using:
1267
+     *  av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1266 1268
      * - encoding: unused
1267 1269
      * - decoding: Read by user.
1268 1270
      */
... ...
@@ -1270,6 +1274,8 @@ typedef struct AVFrame {
1270 1270
 
1271 1271
     /**
1272 1272
      * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1273
+     * Code outside libavcodec should access this field using:
1274
+     *  av_opt_ptr(avcodec_get_frame_class(), frame, "sample_aspect_ratio");
1273 1275
      * - encoding: unused
1274 1276
      * - decoding: Read by user.
1275 1277
      */
... ...
@@ -1277,6 +1283,8 @@ typedef struct AVFrame {
1277 1277
 
1278 1278
     /**
1279 1279
      * width and height of the video frame
1280
+     * Code outside libavcodec should access this field using:
1281
+     *  av_opt_ptr(avcodec_get_frame_class(), frame, "width");
1280 1282
      * - encoding: unused
1281 1283
      * - decoding: Read by user.
1282 1284
      */
... ...
@@ -1286,6 +1294,8 @@ typedef struct AVFrame {
1286 1286
      * format of the frame, -1 if unknown or unset
1287 1287
      * It should be cast to the corresponding enum (enum PixelFormat
1288 1288
      * for video, enum AVSampleFormat for audio)
1289
+     * Code outside libavcodec should access this field using:
1290
+     *  av_opt_ptr(avcodec_get_frame_class(), frame, "format");
1289 1291
      * - encoding: unused
1290 1292
      * - decoding: Read by user.
1291 1293
      */