/**
* save predictors for later macroblocks and increase
* macroblock address
- * @returns 0 if end of frame is reached, 1 otherwise
+ * @return 0 if end of frame is reached, 1 otherwise
*/
int ff_cavs_next_mb(AVSContext *h) {
int i;
* @param consumed is the number of bytes used as input
* @param length is the length of the array
* @param dst_length is the number of decoded bytes FIXME here or a decode rbsp tailing?
- * @returns decoded bytes, might be src+1 if no escapes
+ * @return decoded bytes, might be src+1 if no escapes
*/
const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src, int *dst_length, int *consumed, int length);
/**
* decodes a macroblock
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
*/
int ff_h264_decode_mb_cavlc(H264Context *h);
/**
* decodes a CABAC coded macroblock
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
*/
int ff_h264_decode_mb_cabac(H264Context *h);
/**
*
- * @returns non zero if the loop filter can be skiped
+ * @return non zero if the loop filter can be skiped
*/
static int fill_filter_caches(H264Context *h, int mb_type){
MpegEncContext * const s = &h->s;
/**
* decodes a macroblock
- * @returns 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
+ * @return 0 if OK, AC_ERROR / DC_ERROR / MV_ERROR if an error is noticed
*/
int ff_h264_decode_mb_cabac(H264Context *h) {
MpegEncContext * const s = &h->s;
* @param dest the target buffer, dst+1 == src is allowed as a special case
* @param destsize the length of the dst array
* @param b2 the data which should be escaped
- * @returns pointer to current position in the output buffer or NULL if an error occurred
+ * @return pointer to current position in the output buffer or NULL if an error occurred
*/
static uint8_t *h264_write_nal_unit(int nal_ref_idc, int nal_unit_type, uint8_t *dest, int *destsize,
PutBitContext *b2)
/**
* gets the average motion vector for a GMC MB.
* @param n either 0 for the x component or 1 for y
- * @returns the average MV for a GMC MB
+ * @return the average MV for a GMC MB
*/
static inline int get_amv(MpegEncContext *s, int n){
int x, y, mb_v, sum, dx, dy, shift;
/**
* combines the (truncated) bitstream to a complete frame
- * @returns -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
+ * @return -1 if no complete frame could be created, AVERROR(ENOMEM) if there was a memory allocation error
*/
int ff_combine_frame(ParseContext *pc, int next, const uint8_t **buf, int *buf_size)
{
* @param block_num current block index
* @param block_size amount of entries we want to read from a table
* that has 1000 entries
- * @returns a (non-)random number in the [0, 1000 - block_size] range.
+ * @return a (non-)random number in the [0, 1000 - block_size] range.
*/
static int pRNG(int frame_cntr, int block_num, int block_size)
{
* does not modify the state of the bitreader; it
* only uses it to copy the current stream position
* @param s WMA Voice decoding context private data
- * @returns -1 if unsupported, 1 on not enough bits or 0 if OK.
+ * @return -1 if unsupported, 1 on not enough bits or 0 if OK.
*/
static int check_bits_for_superframe(GetBitContext *orig_gb,
WMAVoiceContext *s)
* decoder).
*
* @param s WMA Voice decoding context private data
- * @returns 1 if not enough bits were available, or 0 on success.
+ * @return 1 if not enough bits were available, or 0 on success.
*/
static int parse_packet_header(WMAVoiceContext *s)
{
* Load a single ASF packet into the demuxer.
* @param s demux context
* @param pb context to read data from
- * @returns 0 on success, <0 on error
+ * @return 0 on success, <0 on error
*/
static int ff_asf_get_packet(AVFormatContext *s, ByteIOContext *pb)
{
* @param s demux context
* @param pb context to read data from
* @param pkt pointer to store packet data into
- * @returns 0 if data was stored in pkt, <0 on error or 1 if more ASF
+ * @return 0 if data was stored in pkt, <0 on error or 1 if more ASF
* packets need to be loaded (through asf_get_packet())
*/
static int ff_asf_parse_packet(AVFormatContext *s, ByteIOContext *pb, AVPacket *pkt)
* @param ts target timestamp
* @param max_ts largest acceptable timestamp
* @param flags flags
- * @returns >=0 on success, error code otherwise
+ * @return >=0 on success, error code otherwise
*
* @NOTE This is part of the new seek API which is still under construction.
* Thus do not use this yet. It may change at any time, do not expect
/**
* Reads size bytes from ByteIOContext into buf.
- * @returns number of bytes read or AVERROR
+ * @return number of bytes read or AVERROR
*/
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
* Reads size bytes from ByteIOContext into buf.
* This reads at most 1 packet. If that is not enough fewer bytes will be
* returned.
- * @returns number of bytes read or AVERROR
+ * @return number of bytes read or AVERROR
*/
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
* Find the given startcode.
* @param code the startcode
* @param pos the start position of the search, or -1 if the current position
- * @returns the position of the startcode or -1 if not found
+ * @return the position of the startcode or -1 if not found
*/
static int64_t find_startcode(ByteIOContext *bc, uint64_t code, int64_t pos){
for(;;){
* @param st stream that this packet belongs to
* @param rst Real-specific stream information
* @param pkt location to store the packet data
- * @returns the number of samples left for subsequent calls to this same
+ * @return the number of samples left for subsequent calls to this same
* function, or 0 if all samples have been retrieved.
*/
int ff_rm_retrieve_cache (AVFormatContext *s, ByteIOContext *pb,
}
/**
- * @returns 0 on success, <0 on error, 1 if protocol is unavailable.
+ * @return 0 on success, <0 on error, 1 if protocol is unavailable.
*/
static int make_setup_request(AVFormatContext *s, const char *host, int port,
int lower_transport, const char *real_challenge)
* has been fully parsed. If no more data is available
* without parsing a reply, it will return an error.
*
- * @returns 1 if a data packets is ready to be received, -1 on error,
+ * @return 1 if a data packets is ready to be received, -1 on error,
* and 0 on success.
*/
int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply,
*
* @param s RTSP (de)muxer context
*
- * @returns 0 on success, < 0 on error. Cleans up all allocations done
+ * @return 0 on success, < 0 on error. Cleans up all allocations done
* within the function on error.
*/
int ff_rtsp_connect(AVFormatContext *s);
* Compares 2 timestamps each in its own timebases.
* The result of the function is undefined if one of the timestamps
* is outside the int64_t range when represented in the others timebase.
- * @returns -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position
+ * @return -1 if ts_a is before ts_b, 1 if ts_a is after ts_b or 0 if they represent the same position
*/
int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b);
OSDN Git Service
