Mercurial > libavcodec.hg
comparison libxvidff.c @ 12024:fdafbcef52f5 libavcodec
Fix grammar errors in documentation
| author | mru |
|---|---|
| date | Wed, 30 Jun 2010 15:38:06 +0000 |
| parents | 7dd2a45249a9 |
| children | e8a29b278ebf |
comparison
equal
deleted
inserted
replaced
| 12023:c7455450364d | 12024:fdafbcef52f5 |
|---|---|
| 73 int xvid_strip_vol_header(AVCodecContext *avctx, unsigned char *frame, unsigned int header_len, unsigned int frame_len); | 73 int xvid_strip_vol_header(AVCodecContext *avctx, unsigned char *frame, unsigned int header_len, unsigned int frame_len); |
| 74 int xvid_ff_2pass(void *ref, int opt, void *p1, void *p2); | 74 int xvid_ff_2pass(void *ref, int opt, void *p1, void *p2); |
| 75 void xvid_correct_framerate(AVCodecContext *avctx); | 75 void xvid_correct_framerate(AVCodecContext *avctx); |
| 76 | 76 |
| 77 /** | 77 /** |
| 78 * Creates the private context for the encoder. | 78 * Create the private context for the encoder. |
| 79 * All buffers are allocated, settings are loaded from the user, | 79 * All buffers are allocated, settings are loaded from the user, |
| 80 * and the encoder context created. | 80 * and the encoder context created. |
| 81 * | 81 * |
| 82 * @param avctx AVCodecContext pointer to context | 82 * @param avctx AVCodecContext pointer to context |
| 83 * @return Returns 0 on success, -1 on failure | 83 * @return Returns 0 on success, -1 on failure |
| 357 | 357 |
| 358 return 0; | 358 return 0; |
| 359 } | 359 } |
| 360 | 360 |
| 361 /** | 361 /** |
| 362 * Encodes a single frame. | 362 * Encode a single frame. |
| 363 * | 363 * |
| 364 * @param avctx AVCodecContext pointer to context | 364 * @param avctx AVCodecContext pointer to context |
| 365 * @param frame Pointer to encoded frame buffer | 365 * @param frame Pointer to encoded frame buffer |
| 366 * @param buf_size Size of encoded frame buffer | 366 * @param buf_size Size of encoded frame buffer |
| 367 * @param data Pointer to AVFrame of unencoded frame | 367 * @param data Pointer to AVFrame of unencoded frame |
| 467 return -1; | 467 return -1; |
| 468 } | 468 } |
| 469 } | 469 } |
| 470 | 470 |
| 471 /** | 471 /** |
| 472 * Destroys the private context for the encoder. | 472 * Destroy the private context for the encoder. |
| 473 * All buffers are freed, and the Xvid encoder context is destroyed. | 473 * All buffers are freed, and the Xvid encoder context is destroyed. |
| 474 * | 474 * |
| 475 * @param avctx AVCodecContext pointer to context | 475 * @param avctx AVCodecContext pointer to context |
| 476 * @return Returns 0, success guaranteed | 476 * @return Returns 0, success guaranteed |
| 477 */ | 477 */ |
| 607 * that allows us to pass data to the second pass in Xvid without a custom | 607 * that allows us to pass data to the second pass in Xvid without a custom |
| 608 * rate-control plugin. | 608 * rate-control plugin. |
| 609 */ | 609 */ |
| 610 | 610 |
| 611 /** | 611 /** |
| 612 * Initializes the two-pass plugin and context. | 612 * Initialize the two-pass plugin and context. |
| 613 * | 613 * |
| 614 * @param param Input construction parameter structure | 614 * @param param Input construction parameter structure |
| 615 * @param handle Private context handle | 615 * @param handle Private context handle |
| 616 * @return Returns XVID_ERR_xxxx on failure, or 0 on success. | 616 * @return Returns XVID_ERR_xxxx on failure, or 0 on success. |
| 617 */ | 617 */ |
| 638 *handle = x->context; | 638 *handle = x->context; |
| 639 return 0; | 639 return 0; |
| 640 } | 640 } |
| 641 | 641 |
| 642 /** | 642 /** |
| 643 * Destroys the two-pass plugin context. | 643 * Destroy the two-pass plugin context. |
| 644 * | 644 * |
| 645 * @param ref Context pointer for the plugin | 645 * @param ref Context pointer for the plugin |
| 646 * @param param Destrooy context | 646 * @param param Destrooy context |
| 647 * @return Returns 0, success guaranteed | 647 * @return Returns 0, success guaranteed |
| 648 */ | 648 */ |
| 654 ref->twopassbuffer[0] = 0; | 654 ref->twopassbuffer[0] = 0; |
| 655 return 0; | 655 return 0; |
| 656 } | 656 } |
| 657 | 657 |
| 658 /** | 658 /** |
| 659 * Enables fast encode mode during the first pass. | 659 * Enable fast encode mode during the first pass. |
| 660 * | 660 * |
| 661 * @param ref Context pointer for the plugin | 661 * @param ref Context pointer for the plugin |
| 662 * @param param Frame data | 662 * @param param Frame data |
| 663 * @return Returns 0, success guaranteed | 663 * @return Returns 0, success guaranteed |
| 664 */ | 664 */ |
| 697 | 697 |
| 698 return 0; | 698 return 0; |
| 699 } | 699 } |
| 700 | 700 |
| 701 /** | 701 /** |
| 702 * Captures statistic data and writes it during first pass. | 702 * Capture statistic data and write it during first pass. |
| 703 * | 703 * |
| 704 * @param ref Context pointer for the plugin | 704 * @param ref Context pointer for the plugin |
| 705 * @param param Statistic data | 705 * @param param Statistic data |
| 706 * @return Returns XVID_ERR_xxxx on failure, or 0 on success | 706 * @return Returns XVID_ERR_xxxx on failure, or 0 on success |
| 707 */ | 707 */ |
