source/libvpx/usage.dox - Issue 800493003: libvpx: Pull from upstream

Side by Side Diff: source/libvpx/usage.dox

Issue 800493003: libvpx: Pull from upstream (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/libvpx.git@master

Patch Set: Keep vp9_iht8x8_add_neon disabled because of http://llvm.org/bugs/show_bug.cgi?id=22178 Created 5 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

« no previous file with comments | « source/libvpx/test/vp9_encoder_parms_get_to_decoder.cc ('k') | source/libvpx/vp8/encoder/pickinter.c » ('j') | no next file with comments »

OLD	NEW
1 /*!\page usage Usage	1 /*!\page usage Usage

2	2

3 The vpx multi-format codec SDK provides a unified interface amongst its	3 The vpx multi-format codec SDK provides a unified interface amongst its

4 supported codecs. This abstraction allows applications using this SDK to	4 supported codecs. This abstraction allows applications using this SDK to

5 easily support multiple video formats with minimal code duplication or	5 easily support multiple video formats with minimal code duplication or

6 "special casing." This section describes the interface common to all codecs.	6 "special casing." This section describes the interface common to all codecs.

7 For codec-specific details, see the \ref codecs page.	7 For codec-specific details, see the \ref codecs page.

8	8

9 The following sections are common to all codecs:	9 The following sections are common to all codecs:

10 - \ref usage_types	10 - \ref usage_types

(...skipping 62 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
73 the ABI is versioned. The ABI version number must be passed at	73 the ABI is versioned. The ABI version number must be passed at

74 initialization time to ensure the application is using a header file that	74 initialization time to ensure the application is using a header file that

75 matches the library. The current ABI version number is stored in the	75 matches the library. The current ABI version number is stored in the

76 preprocessor macros #VPX_CODEC_ABI_VERSION, #VPX_ENCODER_ABI_VERSION, and	76 preprocessor macros #VPX_CODEC_ABI_VERSION, #VPX_ENCODER_ABI_VERSION, and

77 #VPX_DECODER_ABI_VERSION. For convenience, each initialization function has	77 #VPX_DECODER_ABI_VERSION. For convenience, each initialization function has

78 a wrapper macro that inserts the correct version number. These macros are	78 a wrapper macro that inserts the correct version number. These macros are

79 named like the initialization methods, but without the _ver suffix.	79 named like the initialization methods, but without the _ver suffix.

80	80

81	81

82 The available initialization methods are:	82 The available initialization methods are:

83 \if encoder - #vpx_codec_enc_init (calls vpx_codec_enc_init_ver()) \endif	83 \if encoder

84 \if multi-encoder - #vpx_codec_enc_init_multi (calls vpx_codec_enc_init_mult i_ver()) \endif	84 - #vpx_codec_enc_init (calls vpx_codec_enc_init_ver())

	85 - #vpx_codec_enc_init_multi (calls vpx_codec_enc_init_multi_ver())

	86 .

	87 \endif

85 \if decoder - #vpx_codec_dec_init (calls vpx_codec_dec_init_ver()) \endif	88 \if decoder - #vpx_codec_dec_init (calls vpx_codec_dec_init_ver()) \endif

86	89

87	90

88	91

89 \section usage_errors Error Handling	92 \section usage_errors Error Handling

90 Almost all codec functions return an error status of type #vpx_codec_err_t.	93 Almost all codec functions return an error status of type #vpx_codec_err_t.

91 The semantics of how each error condition should be processed is clearly	94 The semantics of how each error condition should be processed is clearly

92 defined in the definitions of each enumerated value. Error values can be	95 defined in the definitions of each enumerated value. Error values can be

93 converted into ASCII strings with the vpx_codec_error() and	96 converted into ASCII strings with the vpx_codec_error() and

94 vpx_codec_err_to_string() methods. The difference between these two methods is	97 vpx_codec_err_to_string() methods. The difference between these two methods is

(...skipping 29 matching lines...) Expand all Loading...
124 and the semantics of the call are preserved, as before.	127 and the semantics of the call are preserved, as before.

125	128

126 The special value <code>0</code> is reserved to represent an infinite	129 The special value <code>0</code> is reserved to represent an infinite

127 deadline. In this case, the codec will perform as much processing as	130 deadline. In this case, the codec will perform as much processing as

128 possible to yield the highest quality frame.	131 possible to yield the highest quality frame.

129	132

130 By convention, the value <code>1</code> is used to mean "return as fast as	133 By convention, the value <code>1</code> is used to mean "return as fast as

131 possible."	134 possible."

132	135

133 */	136 */

OLD	NEW