intrax8: Move documentation from implementation to header file

This commit is contained in:
Vittorio Giovara 2016-02-20 01:34:18 -05:00
parent 2ade1cdafb
commit ad8aa8e6c6
2 changed files with 22 additions and 20 deletions

View File

@ -739,12 +739,6 @@ static void x8_init_block_index(MpegEncContext *s)
s->dest[2] += (s->mb_y & (~1)) * uvlinesize << 2; s->dest[2] += (s->mb_y & (~1)) * uvlinesize << 2;
} }
/**
* Initialize IntraX8 frame decoder.
* Requires valid MpegEncContext with valid s->mb_width before calling.
* @param w pointer to IntraX8Context
* @param s pointer to MpegEncContext of the parent codec
*/
av_cold void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s) av_cold void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s)
{ {
w->s = s; w->s = s;
@ -764,25 +758,11 @@ av_cold void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s)
ff_intrax8dsp_init(&w->dsp); ff_intrax8dsp_init(&w->dsp);
} }
/**
* Destroy IntraX8 frame structure.
* @param w pointer to IntraX8Context
*/
av_cold void ff_intrax8_common_end(IntraX8Context *w) av_cold void ff_intrax8_common_end(IntraX8Context *w)
{ {
av_freep(&w->prediction_table); av_freep(&w->prediction_table);
} }
/**
* Decode single IntraX8 frame.
* The parent codec must fill s->loopfilter and s->gb (bitstream).
* The parent codec must call ff_mpv_frame_start() before calling this function.
* The parent codec must call ff_mpv_frame_end() after calling this function.
* This function does not use ff_mpv_decode_mb().
* @param w pointer to IntraX8Context
* @param dquant doubled quantizer, it would be odd in case of VC-1 halfpq==1.
* @param quant_offset offset away from zero
*/
int ff_intrax8_decode_picture(IntraX8Context *const w, int dquant, int ff_intrax8_decode_picture(IntraX8Context *const w, int dquant,
int quant_offset) int quant_offset)
{ {

View File

@ -56,8 +56,30 @@ typedef struct IntraX8Context {
int est_run; int est_run;
} IntraX8Context; } IntraX8Context;
/**
* Initialize IntraX8 frame decoder.
* Requires valid MpegEncContext with valid s->mb_width before calling.
* @param w pointer to IntraX8Context
* @param s pointer to MpegEncContext of the parent codec
*/
void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s); void ff_intrax8_common_init(IntraX8Context *w, MpegEncContext *const s);
/**
* Destroy IntraX8 frame structure.
* @param w pointer to IntraX8Context
*/
void ff_intrax8_common_end(IntraX8Context *w); void ff_intrax8_common_end(IntraX8Context *w);
/**
* Decode single IntraX8 frame.
* The parent codec must fill s->loopfilter and s->gb (bitstream).
* The parent codec must call ff_mpv_frame_start() before calling this function.
* The parent codec must call ff_mpv_frame_end() after calling this function.
* This function does not use ff_mpv_decode_mb().
* @param w pointer to IntraX8Context
* @param dquant doubled quantizer, it would be odd in case of VC-1 halfpq==1.
* @param quant_offset offset away from zero
*/
int ff_intrax8_decode_picture(IntraX8Context *w, int quant, int halfpq); int ff_intrax8_decode_picture(IntraX8Context *w, int quant, int halfpq);
#endif /* AVCODEC_INTRAX8_H */ #endif /* AVCODEC_INTRAX8_H */