comparison indeo5.c @ 12024:fdafbcef52f5 libavcodec

Fix grammar errors in documentation
author mru
date Wed, 30 Jun 2010 15:38:06 +0000
parents 238cfd740f10
children 0885e7a93ed4
comparison
equal deleted inserted replaced
12023:c7455450364d 12024:fdafbcef52f5
78 IVIPicConfig pic_conf; 78 IVIPicConfig pic_conf;
79 } IVI5DecContext; 79 } IVI5DecContext;
80 80
81 81
82 /** 82 /**
83 * Decodes Indeo5 GOP (Group of pictures) header. 83 * Decode Indeo5 GOP (Group of pictures) header.
84 * This header is present in key frames only. 84 * This header is present in key frames only.
85 * It defines parameters for all frames in a GOP. 85 * It defines parameters for all frames in a GOP.
86 * 86 *
87 * @param ctx [in,out] ptr to the decoder context 87 * @param ctx [in,out] ptr to the decoder context
88 * @param avctx [in] ptr to the AVCodecContext 88 * @param avctx [in] ptr to the AVCodecContext
294 return 0; 294 return 0;
295 } 295 }
296 296
297 297
298 /** 298 /**
299 * Skips a header extension. 299 * Skip a header extension.
300 * 300 *
301 * @param gb [in,out] the GetBit context 301 * @param gb [in,out] the GetBit context
302 */ 302 */
303 static inline void skip_hdr_extension(GetBitContext *gb) 303 static inline void skip_hdr_extension(GetBitContext *gb)
304 { 304 {
310 } while(len); 310 } while(len);
311 } 311 }
312 312
313 313
314 /** 314 /**
315 * Decodes Indeo5 picture header. 315 * Decode Indeo5 picture header.
316 * 316 *
317 * @param ctx [in,out] ptr to the decoder context 317 * @param ctx [in,out] ptr to the decoder context
318 * @param avctx [in] ptr to the AVCodecContext 318 * @param avctx [in] ptr to the AVCodecContext
319 * @return result code: 0 = OK, -1 = error 319 * @return result code: 0 = OK, -1 = error
320 */ 320 */
362 return 0; 362 return 0;
363 } 363 }
364 364
365 365
366 /** 366 /**
367 * Decodes Indeo5 band header. 367 * Decode Indeo5 band header.
368 * 368 *
369 * @param ctx [in,out] ptr to the decoder context 369 * @param ctx [in,out] ptr to the decoder context
370 * @param band [in,out] ptr to the band descriptor 370 * @param band [in,out] ptr to the band descriptor
371 * @param avctx [in] ptr to the AVCodecContext 371 * @param avctx [in] ptr to the AVCodecContext
372 * @return result code: 0 = OK, -1 = error 372 * @return result code: 0 = OK, -1 = error
430 return 0; 430 return 0;
431 } 431 }
432 432
433 433
434 /** 434 /**
435 * Decodes info (block type, cbp, quant delta, motion vector) 435 * Decode info (block type, cbp, quant delta, motion vector)
436 * for all macroblocks in the current tile. 436 * for all macroblocks in the current tile.
437 * 437 *
438 * @param ctx [in,out] ptr to the decoder context 438 * @param ctx [in,out] ptr to the decoder context
439 * @param band [in,out] ptr to the band descriptor 439 * @param band [in,out] ptr to the band descriptor
440 * @param tile [in,out] ptr to the tile descriptor 440 * @param tile [in,out] ptr to the tile descriptor
555 return 0; 555 return 0;
556 } 556 }
557 557
558 558
559 /** 559 /**
560 * Decodes an Indeo5 band. 560 * Decode an Indeo5 band.
561 * 561 *
562 * @param ctx [in,out] ptr to the decoder context 562 * @param ctx [in,out] ptr to the decoder context
563 * @param band [in,out] ptr to the band descriptor 563 * @param band [in,out] ptr to the band descriptor
564 * @param avctx [in] ptr to the AVCodecContext 564 * @param avctx [in] ptr to the AVCodecContext
565 * @return result code: 0 = OK, -1 = error 565 * @return result code: 0 = OK, -1 = error
645 return result; 645 return result;
646 } 646 }
647 647
648 648
649 /** 649 /**
650 * Switches buffers. 650 * Switch buffers.
651 * 651 *
652 * @param ctx [in,out] ptr to the decoder context 652 * @param ctx [in,out] ptr to the decoder context
653 */ 653 */
654 static void switch_buffers(IVI5DecContext *ctx) 654 static void switch_buffers(IVI5DecContext *ctx)
655 { 655 {
688 } 688 }
689 } 689 }
690 690
691 691
692 /** 692 /**
693 * Initializes Indeo5 decoder. 693 * Initialize Indeo5 decoder.
694 */ 694 */
695 static av_cold int decode_init(AVCodecContext *avctx) 695 static av_cold int decode_init(AVCodecContext *avctx)
696 { 696 {
697 IVI5DecContext *ctx = avctx->priv_data; 697 IVI5DecContext *ctx = avctx->priv_data;
698 int result; 698 int result;
798 return buf_size; 798 return buf_size;
799 } 799 }
800 800
801 801
802 /** 802 /**
803 * Closes Indeo5 decoder and cleans up its context. 803 * Close Indeo5 decoder and clean up its context.
804 */ 804 */
805 static av_cold int decode_close(AVCodecContext *avctx) 805 static av_cold int decode_close(AVCodecContext *avctx)
806 { 806 {
807 IVI5DecContext *ctx = avctx->priv_data; 807 IVI5DecContext *ctx = avctx->priv_data;
808 808