Improve consistency and possibly enhance readability. Originally committed as revision 24842 to svn://svn.ffmpeg.org/ffmpeg/trunk
Showing the changes to libavfilter/avfilter.h (1 of 1 file). Show all
Unified · Split
| @@ -154,6 +154,7 @@ static inline void avfilter_copy_buffer_ref_props(AVFilterBufferRef *dst, AVFilt · 153 unmodified lines | |||
| 154 | 154 | ||
| 155 | /** | 155 | /** |
| 156 | * Add a new reference to a buffer. | 156 | * Add a new reference to a buffer. |
| 157 | * | ||
| 157 | * @param ref an existing reference to the buffer | 158 | * @param ref an existing reference to the buffer |
| 158 | * @param pmask a bitmask containing the allowable permissions in the new | 159 | * @param pmask a bitmask containing the allowable permissions in the new |
| 159 | * reference | 160 | * reference |
| @@ -165,6 +166,7 @@ AVFilterBufferRef *avfilter_ref_buffer(AVFilterBufferRef *ref, int pmask); · 5 unmodified lines | |||
| 165 | /** | 166 | /** |
| 166 | * Remove a reference to a buffer. If this is the last reference to the | 167 | * Remove a reference to a buffer. If this is the last reference to the |
| 167 | * buffer, the buffer itself is also automatically freed. | 168 | * buffer, the buffer itself is also automatically freed. |
| 169 | * | ||
| 168 | * @param ref reference to the buffer | 170 | * @param ref reference to the buffer |
| 169 | */ | 171 | */ |
| 170 | void avfilter_unref_buffer(AVFilterBufferRef *ref); | 172 | void avfilter_unref_buffer(AVFilterBufferRef *ref); |
| @@ -220,6 +222,7 @@ typedef struct AVFilterFormats { · 49 unmodified lines | |||
| 220 | /** | 222 | /** |
| 221 | * Create a list of supported formats. This is intended for use in | 223 | * Create a list of supported formats. This is intended for use in |
| 222 | * AVFilter->query_formats(). | 224 | * AVFilter->query_formats(). |
| 225 | * | ||
| 223 | * @param fmts list of media formats, terminated by -1 | 226 | * @param fmts list of media formats, terminated by -1 |
| 224 | * @return the format list, with no existing references | 227 | * @return the format list, with no existing references |
| 225 | */ | 228 | */ |
| @@ -599,6 +602,7 @@ struct AVFilterLink { · 373 unmodified lines | |||
| 599 | 602 | ||
| 600 | /** | 603 | /** |
| 601 | * Link two filters together. | 604 | * Link two filters together. |
| 605 | * | ||
| 602 | * @param src the source filter | 606 | * @param src the source filter |
| 603 | * @param srcpad index of the output pad on the source filter | 607 | * @param srcpad index of the output pad on the source filter |
| 604 | * @param dst the destination filter | 608 | * @param dst the destination filter |
| @@ -610,6 +614,7 @@ int avfilter_link(AVFilterContext *src, unsigned srcpad, · 5 unmodified lines | |||
| 610 | 614 | ||
| 611 | /** | 615 | /** |
| 612 | * Negotiate the media format, dimensions, etc of all inputs to a filter. | 616 | * Negotiate the media format, dimensions, etc of all inputs to a filter. |
| 617 | * | ||
| 613 | * @param filter the filter to negotiate the properties for its inputs | 618 | * @param filter the filter to negotiate the properties for its inputs |
| 614 | * @return zero on successful negotiation | 619 | * @return zero on successful negotiation |
| 615 | */ | 620 | */ |
| @@ -617,6 +622,7 @@ int avfilter_config_links(AVFilterContext *filter); · 1 unmodified line | |||
| 617 | 622 | ||
| 618 | /** | 623 | /** |
| 619 | * Request a picture buffer with a specific set of permissions. | 624 | * Request a picture buffer with a specific set of permissions. |
| 625 | * | ||
| 620 | * @param link the output link to the filter from which the buffer will | 626 | * @param link the output link to the filter from which the buffer will |
| 621 | * be requested | 627 | * be requested |
| 622 | * @param perms the required access permissions | 628 | * @param perms the required access permissions |
| @@ -647,6 +653,7 @@ AVFilterBufferRef *avfilter_get_audio_buffer(AVFilterLink *link, int perms, · 24 unmodified lines | |||
| 647 | 653 | ||
| 648 | /** | 654 | /** |
| 649 | * Request an input frame from the filter at the other end of the link. | 655 | * Request an input frame from the filter at the other end of the link. |
| 656 | * | ||
| 650 | * @param link the input link | 657 | * @param link the input link |
| 651 | * @return zero on success | 658 | * @return zero on success |
| 652 | */ | 659 | */ |
| @@ -654,6 +661,7 @@ int avfilter_request_frame(AVFilterLink *link); · 1 unmodified line | |||
| 654 | 661 | ||
| 655 | /** | 662 | /** |
| 656 | * Poll a frame from the filter chain. | 663 | * Poll a frame from the filter chain. |
| 664 | * | ||
| 657 | * @param link the input link | 665 | * @param link the input link |
| 658 | * @return the number of immediately available frames, a negative | 666 | * @return the number of immediately available frames, a negative |
| 659 | * number in case of error | 667 | * number in case of error |
| @@ -662,6 +670,7 @@ int avfilter_poll_frame(AVFilterLink *link); · 2 unmodified lines | |||
| 662 | 670 | ||
| 663 | /** | 671 | /** |
| 664 | * Notifie the next filter of the start of a frame. | 672 | * Notifie the next filter of the start of a frame. |
| 673 | * | ||
| 665 | * @param link the output link the frame will be sent over | 674 | * @param link the output link the frame will be sent over |
| 666 | * @param picref A reference to the frame about to be sent. The data for this | 675 | * @param picref A reference to the frame about to be sent. The data for this |
| 667 | * frame need only be valid once draw_slice() is called for that | 676 | * frame need only be valid once draw_slice() is called for that |
| @@ -672,6 +681,7 @@ void avfilter_start_frame(AVFilterLink *link, AVFilterBufferRef *picref); · 4 unmodified lines | |||
| 672 | 681 | ||
| 673 | /** | 682 | /** |
| 674 | * Notifie the next filter that the current frame has finished. | 683 | * Notifie the next filter that the current frame has finished. |
| 684 | * | ||
| 675 | * @param link the output link the frame was sent over | 685 | * @param link the output link the frame was sent over |
| 676 | */ | 686 | */ |
| 677 | void avfilter_end_frame(AVFilterLink *link); | 687 | void avfilter_end_frame(AVFilterLink *link); |
| @@ -714,6 +724,7 @@ void avfilter_uninit(void); · 36 unmodified lines | |||
| 714 | * avfilter_get_by_name later to lookup the AVFilter structure by name. A | 724 | * avfilter_get_by_name later to lookup the AVFilter structure by name. A |
| 715 | * filter can still by instantiated with avfilter_open even if it is not | 725 | * filter can still by instantiated with avfilter_open even if it is not |
| 716 | * registered. | 726 | * registered. |
| 727 | * | ||
| 717 | * @param filter the filter to register | 728 | * @param filter the filter to register |
| 718 | * @return 0 if the registration was succesfull, a negative value | 729 | * @return 0 if the registration was succesfull, a negative value |
| 719 | * otherwise | 730 | * otherwise |
| @@ -722,6 +733,7 @@ int avfilter_register(AVFilter *filter); · 2 unmodified lines | |||
| 722 | 733 | ||
| 723 | /** | 734 | /** |
| 724 | * Get a filter definition matching the given name. | 735 | * Get a filter definition matching the given name. |
| 736 | * | ||
| 725 | * @param name the filter name to find | 737 | * @param name the filter name to find |
| 726 | * @return the filter definition, if any matching one is registered. | 738 | * @return the filter definition, if any matching one is registered. |
| 727 | * NULL if none found. | 739 | * NULL if none found. |
| @@ -749,6 +761,7 @@ int avfilter_open(AVFilterContext **filter_ctx, AVFilter *filter, const char *in · 21 unmodified lines | |||
| 749 | 761 | ||
| 750 | /** | 762 | /** |
| 751 | * Initialize a filter. | 763 | * Initialize a filter. |
| 764 | * | ||
| 752 | * @param filter the filter to initialize | 765 | * @param filter the filter to initialize |
| 753 | * @param args A string of parameters to use when initializing the filter. | 766 | * @param args A string of parameters to use when initializing the filter. |
| 754 | * The format and meaning of this string varies by filter. | 767 | * The format and meaning of this string varies by filter. |
| @@ -760,12 +773,14 @@ int avfilter_init_filter(AVFilterContext *filter, const char *args, void *opaque · 5 unmodified lines | |||
| 760 | 773 | ||
| 761 | /** | 774 | /** |
| 762 | * Destroy a filter. | 775 | * Destroy a filter. |
| 776 | * | ||
| 763 | * @param filter the filter to destroy | 777 | * @param filter the filter to destroy |
| 764 | */ | 778 | */ |
| 765 | void avfilter_destroy(AVFilterContext *filter); | 779 | void avfilter_destroy(AVFilterContext *filter); |
| 766 | 780 | ||
| 767 | /** | 781 | /** |
| 768 | * Insert a filter in the middle of an existing link. | 782 | * Insert a filter in the middle of an existing link. |
| 783 | * | ||
| 769 | * @param link the link into which the filter should be inserted | 784 | * @param link the link into which the filter should be inserted |
| 770 | * @param filt the filter to be inserted | 785 | * @param filt the filter to be inserted |
| 771 | * @param in the input pad on the filter to connect | 786 | * @param in the input pad on the filter to connect |
| @@ -777,6 +792,7 @@ int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt, · 5 unmodified lines | |||
| 777 | 792 | ||
| 778 | /** | 793 | /** |
| 779 | * Insert a new pad. | 794 | * Insert a new pad. |
| 795 | * | ||
| 780 | * @param idx Insertion point. Pad is inserted at the end if this point | 796 | * @param idx Insertion point. Pad is inserted at the end if this point |
| 781 | * is beyond the end of the list of pads. | 797 | * is beyond the end of the list of pads. |
| 782 | * @param count Pointer to the number of pads in the list | 798 | * @param count Pointer to the number of pads in the list |