Revision 8bfb108b libavformat/avformat.h

View differences:

libavformat/avformat.h
272 272
/**
273 273
 * Stream structure.
274 274
 * New fields can be added to the end with minor version bumps.
275
 * Removal, reordering and changes to existing fields require a Major
275
 * Removal, reordering and changes to existing fields require a major
276 276
 * version bump.
277
 * sizeof(AVStream) must not be used outside libav*
277
 * sizeof(AVStream) must not be used outside libav*.
278 278
 */
279 279
typedef struct AVStream {
280 280
    int index;    /**< stream index in AVFormatContext */
281 281
    int id;       /**< format specific stream id */
282 282
    AVCodecContext *codec; /**< codec context */
283 283
    /**
284
     * real base frame rate of the stream.
285
     * this is the lowest framerate with which all timestamps can be
284
     * Real base frame rate of the stream.
285
     * This is the lowest frame rate with which all timestamps can be
286 286
     * represented accurately (it is the least common multiple of all
287
     * framerates in the stream), Note, this value is just a guess!
288
     * for example if the timebase is 1/90000 and all frames have either
289
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1
287
     * frame rates in the stream), Note, this value is just a guess!
288
     * For example if the timebase is 1/90000 and all frames have either
289
     * approximately 3600 or 1800 timer ticks then r_frame_rate will be 50/1.
290 290
     */
291 291
    AVRational r_frame_rate;
292 292
    void *priv_data;
......
297 297
    struct AVFrac pts;
298 298

  
299 299
    /**
300
     * this is the fundamental unit of time (in seconds) in terms
301
     * of which frame timestamps are represented. for fixed-fps content,
302
     * timebase should be 1/framerate and timestamp increments should be
300
     * This is the fundamental unit of time (in seconds) in terms
301
     * of which frame timestamps are represented. For fixed-fps content,
302
     * timebase should be 1/frame rate and timestamp increments should be
303 303
     * identically 1.
304 304
     */
305 305
    AVRational time_base;
......
312 312
     * MN: dunno if that is the right place for it */
313 313
    float quality;
314 314
    /**
315
     * decoding: pts of the first frame of the stream, in stream time base.
316
     * only set this if you are absolutely 100% sure that the value you set
317
     * it to really is the pts of the first frame
315
     * Decoding: pts of the first frame of the stream, in stream time base.
316
     * Only set this if you are absolutely 100% sure that the value you set
317
     * it to really is the pts of the first frame.
318 318
     * This may be undefined (AV_NOPTS_VALUE).
319
     * @note the ASF header does NOT contain a correct start_time the ASF
320
     * demuxer must NOT set this
319
     * @note The ASF header does NOT contain a correct start_time the ASF
320
     * demuxer must NOT set this.
321 321
     */
322 322
    int64_t start_time;
323 323
    /**
324
     * decoding: duration of the stream, in stream time base.
324
     * Decoding: duration of the stream, in stream time base.
325 325
     * If a source file does not specify a duration, but does specify
326 326
     * a bitrate, this value will be estimates from bit rate and file size.
327 327
     */
......
351 351
#define AV_PROGRAM_RUNNING 1
352 352

  
353 353
/**
354
 *
355 354
 * New fields can be added to the end with minor version bumps.
356
 * Removal, reordering and changes to existing fields require a Major
355
 * Removal, reordering and changes to existing fields require a major
357 356
 * version bump.
358
 * sizeof(AVProgram) must not be used outside libav*
357
 * sizeof(AVProgram) must not be used outside libav*.
359 358
 */
360 359
typedef struct AVProgram {
361 360
    int            id;
......
375 374
/**
376 375
 * format I/O context.
377 376
 * New fields can be added to the end with minor version bumps.
378
 * Removal, reordering and changes to existing fields require a Major
377
 * Removal, reordering and changes to existing fields require a major
379 378
 * version bump.
380
 * sizeof(AVFormatContext) must not be used outside libav*
379
 * sizeof(AVFormatContext) must not be used outside libav*.
381 380
 */
382 381
typedef struct AVFormatContext {
383 382
    const AVClass *av_class; /**< set by av_alloc_format_context */

Also available in: Unified diff