Update ABI/API compatibility reports after commit d6b8aed5612e6be6d3a4053867fbd2ae0cb...
[openjpeg.git] / abi-check / headers_diff / openjpeg / 2.3.0 / current / diff.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2     <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3     <head>
4     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5     <meta name="keywords" content="OpenJPEG, header, diff" />
6     <meta name="description" content="Diff for header files between 2.3.0 and current versions of openjpeg" />
7     <link rel="stylesheet" type="text/css" href="../../../../css/common.css" />
8     <link rel="stylesheet" type="text/css" href="../../../../css/headers_diff.css" />
9     
10     
11     <title>
12         OpenJPEG: headers diff between 2.3.0 and current versions
13     </title>
14     
15     </head>
16
17 <body>
18 <table width='100%' cellpadding='0' cellspacing='0'><tr><td><table cellpadding='0' cellspacing='0'><tr><td align='center'><h1 class='tool'><a title='Home: ABI tracker for OpenJPEG' href='../../../../timeline/openjpeg/index.html' class='tool'>ABI<br/>Tracker</a></h1></td><td width='30px;'></td><td><h1>(OpenJPEG)</h1></td></tr></table><hr/>
19 <br/>
20 <br/>
21 <h1>Headers diff: <span class='version'>2.3.0</span> vs <span class='version'>current</span></h1><br/><br/> 
22   <table class='diff_tbl' border="0" cellpadding="0" cellspacing="0"> 
23   <tr bgcolor="orange"><th></th><th>&nbsp;openjpeg.h (2.3.0)&nbsp;</th><th> </th><th>&nbsp;openjpeg.h (current)&nbsp;</th><th></th></tr> 
24       <tr><td class="lineno"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno"></td></tr>
25       <tr bgcolor="gray" ><td></td><th><a name="part-l1" /><small>skipping to change at</small><em> line 549</em></th><th> </th><th><a name="part-r1" /><small>skipping to change at</small><em> line 549</em></th><td></td></tr>
26       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_UINT32 DA_x0;</td><td> </td><td class="right">    OPJ_UINT32 DA_x0;</td><td class="lineno" valign="top"></td></tr>
27       <tr><td class="lineno" valign="top"></td><td class="left">    /** Decoding area right boundary */</td><td> </td><td class="right">    /** Decoding area right boundary */</td><td class="lineno" valign="top"></td></tr>
28       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_UINT32 DA_x1;</td><td> </td><td class="right">    OPJ_UINT32 DA_x1;</td><td class="lineno" valign="top"></td></tr>
29       <tr><td class="lineno" valign="top"></td><td class="left">    /** Decoding area up boundary */</td><td> </td><td class="right">    /** Decoding area up boundary */</td><td class="lineno" valign="top"></td></tr>
30       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_UINT32 DA_y0;</td><td> </td><td class="right">    OPJ_UINT32 DA_y0;</td><td class="lineno" valign="top"></td></tr>
31       <tr><td class="lineno" valign="top"></td><td class="left">    /** Decoding area bottom boundary */</td><td> </td><td class="right">    /** Decoding area bottom boundary */</td><td class="lineno" valign="top"></td></tr>
32       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_UINT32 DA_y1;</td><td> </td><td class="right">    OPJ_UINT32 DA_y1;</td><td class="lineno" valign="top"></td></tr>
33       <tr><td class="lineno" valign="top"></td><td class="left">    /** Verbose mode */</td><td> </td><td class="right">    /** Verbose mode */</td><td class="lineno" valign="top"></td></tr>
34       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_BOOL m_verbose;</td><td> </td><td class="right">    OPJ_BOOL m_verbose;</td><td class="lineno" valign="top"></td></tr>
35       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
36       <tr><td><a name="diff0001" /></td></tr>
37       <tr><td class="lineno" valign="top"></td><td class="lblock">    /** tile number o<span class="delete">t the decoded tile</span>*/</td><td> </td><td class="rblock">    /** tile number o<span class="insert">f the decoded tile </span>*/</td><td class="lineno" valign="top"></td></tr>
38       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_UINT32 tile_index;</td><td> </td><td class="right">    OPJ_UINT32 tile_index;</td><td class="lineno" valign="top"></td></tr>
39       <tr><td class="lineno" valign="top"></td><td class="left">    /** Nb of tile to decode */</td><td> </td><td class="right">    /** Nb of tile to decode */</td><td class="lineno" valign="top"></td></tr>
40       <tr><td class="lineno" valign="top"></td><td class="left">    OPJ_UINT32 nb_tile_to_decode;</td><td> </td><td class="right">    OPJ_UINT32 nb_tile_to_decode;</td><td class="lineno" valign="top"></td></tr>
41       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
42       <tr><td class="lineno" valign="top"></td><td class="left">    /*@}*/</td><td> </td><td class="right">    /*@}*/</td><td class="lineno" valign="top"></td></tr>
43       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
44       <tr><td class="lineno" valign="top"></td><td class="left">    /* UniPG&gt;&gt; */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */</td><td> </td><td class="right">    /* UniPG&gt;&gt; */ /* NOT YET USED IN THE V2 VERSION OF OPENJPEG */</td><td class="lineno" valign="top"></td></tr>
45       <tr><td class="lineno" valign="top"></td><td class="left">    /**@name JPWL decoding parameters */</td><td> </td><td class="right">    /**@name JPWL decoding parameters */</td><td class="lineno" valign="top"></td></tr>
46       <tr><td class="lineno" valign="top"></td><td class="left">    /*@{*/</td><td> </td><td class="right">    /*@{*/</td><td class="lineno" valign="top"></td></tr>
47       <tr><td class="lineno" valign="top"></td><td class="left">    /** activates the JPWL correction capabilities */</td><td> </td><td class="right">    /** activates the JPWL correction capabilities */</td><td class="lineno" valign="top"></td></tr>
48       <tr><td class="lineno"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno"></td></tr>
49       <tr bgcolor="gray" ><td></td><th><a name="part-l2" /><small>skipping to change at</small><em> line 1172</em></th><th> </th><th><a name="part-r2" /><small>skipping to change at</small><em> line 1172</em></th><td></td></tr>
50       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
51       <tr><td class="lineno" valign="top"></td><td class="left">/**</td><td> </td><td class="right">/**</td><td class="lineno" valign="top"></td></tr>
52       <tr><td class="lineno" valign="top"></td><td class="left"> * Sets the given function to be used as a skip function.</td><td> </td><td class="right"> * Sets the given function to be used as a skip function.</td><td class="lineno" valign="top"></td></tr>
53       <tr><td class="lineno" valign="top"></td><td class="left"> * @param       p_stream    the stream to modify</td><td> </td><td class="right"> * @param       p_stream    the stream to modify</td><td class="lineno" valign="top"></td></tr>
54       <tr><td class="lineno" valign="top"></td><td class="left"> * @param       p_function  the function to use a skip function.</td><td> </td><td class="right"> * @param       p_function  the function to use a skip function.</td><td class="lineno" valign="top"></td></tr>
55       <tr><td class="lineno" valign="top"></td><td class="left">*/</td><td> </td><td class="right">*/</td><td class="lineno" valign="top"></td></tr>
56       <tr><td class="lineno" valign="top"></td><td class="left">OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stre
57 am,</td><td> </td><td class="right">OPJ_API void OPJ_CALLCONV opj_stream_set_skip_function(opj_stream_t* p_stre
58 am,</td><td class="lineno" valign="top"></td></tr>
59       <tr><td class="lineno" valign="top"></td><td class="left">        opj_stream_skip_fn p_function);</td><td> </td><td class="right">        opj_stream_skip_fn p_function);</td><td class="lineno" valign="top"></td></tr>
60       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
61       <tr><td class="lineno" valign="top"></td><td class="left">/**</td><td> </td><td class="right">/**</td><td class="lineno" valign="top"></td></tr>
62       <tr><td><a name="diff0002" /></td></tr>
63       <tr><td class="lineno" valign="top"></td><td class="lblock"> * Sets the given function to be used as a seek function, the stream is the</td><td> </td><td class="rblock"> * Sets the given function to be used as a seek function, the stream is the</td><td class="lineno" valign="top"></td></tr>
64       <tr><td class="lineno" valign="top"></td><td class="lblock">n <span class="delete">seekable.</span></td><td> </td><td class="rblock">n <span class="insert">seekable,</span></td><td class="lineno" valign="top"></td></tr>
65       <tr><td class="lineno" valign="top"></td><td class="lblock"></td><td> </td><td class="rblock"><span class="insert"> * using SEEK_SET behavior.</span></td><td class="lineno" valign="top"></td></tr>
66       <tr><td class="lineno" valign="top"></td><td class="left"> * @param       p_stream    the stream to modify</td><td> </td><td class="right"> * @param       p_stream    the stream to modify</td><td class="lineno" valign="top"></td></tr>
67       <tr><td class="lineno" valign="top"></td><td class="left"> * @param       p_function  the function to use a skip function.</td><td> </td><td class="right"> * @param       p_function  the function to use a skip function.</td><td class="lineno" valign="top"></td></tr>
68       <tr><td class="lineno" valign="top"></td><td class="left">*/</td><td> </td><td class="right">*/</td><td class="lineno" valign="top"></td></tr>
69       <tr><td class="lineno" valign="top"></td><td class="left">OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stre
70 am,</td><td> </td><td class="right">OPJ_API void OPJ_CALLCONV opj_stream_set_seek_function(opj_stream_t* p_stre
71 am,</td><td class="lineno" valign="top"></td></tr>
72       <tr><td class="lineno" valign="top"></td><td class="left">        opj_stream_seek_fn p_function);</td><td> </td><td class="right">        opj_stream_seek_fn p_function);</td><td class="lineno" valign="top"></td></tr>
73       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
74       <tr><td class="lineno" valign="top"></td><td class="left">/**</td><td> </td><td class="right">/**</td><td class="lineno" valign="top"></td></tr>
75       <tr><td class="lineno" valign="top"></td><td class="left"> * Sets the given data to be used as a user data for the stream.</td><td> </td><td class="right"> * Sets the given data to be used as a user data for the stream.</td><td class="lineno" valign="top"></td></tr>
76       <tr><td class="lineno" valign="top"></td><td class="left"> * @param       p_stream    the stream to modify</td><td> </td><td class="right"> * @param       p_stream    the stream to modify</td><td class="lineno" valign="top"></td></tr>
77       <tr><td class="lineno" valign="top"></td><td class="left"> * @param       p_data      the data to set.</td><td> </td><td class="right"> * @param       p_data      the data to set.</td><td class="lineno" valign="top"></td></tr>
78       <tr><td class="lineno"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno"></td></tr>
79       <tr bgcolor="gray" ><td></td><th><a name="part-l3" /><small>skipping to change at</small><em> line 1306</em></th><th> </th><th><a name="part-r3" /><small>skipping to change at</small><em> line 1307</em></th><td></td></tr>
80       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
81       <tr><td class="lineno" valign="top"></td><td class="left">/**</td><td> </td><td class="right">/**</td><td class="lineno" valign="top"></td></tr>
82       <tr><td class="lineno" valign="top"></td><td class="left"> * Allocates worker threads for the compressor/decompressor.</td><td> </td><td class="right"> * Allocates worker threads for the compressor/decompressor.</td><td class="lineno" valign="top"></td></tr>
83       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
84       <tr><td class="lineno" valign="top"></td><td class="left"> * By default, only the main thread is used. If this function is not used,</td><td> </td><td class="right"> * By default, only the main thread is used. If this function is not used,</td><td class="lineno" valign="top"></td></tr>
85       <tr><td class="lineno" valign="top"></td><td class="left"> * but the OPJ_NUM_THREADS environment variable is set, its value will be</td><td> </td><td class="right"> * but the OPJ_NUM_THREADS environment variable is set, its value will be</td><td class="lineno" valign="top"></td></tr>
86       <tr><td class="lineno" valign="top"></td><td class="left"> * used to initialize the number of threads. The value can be either an int
87 eger</td><td> </td><td class="right"> * used to initialize the number of threads. The value can be either an int
88 eger</td><td class="lineno" valign="top"></td></tr>
89       <tr><td class="lineno" valign="top"></td><td class="left"> * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is ca
90 lled,</td><td> </td><td class="right"> * number, or "ALL_CPUS". If OPJ_NUM_THREADS is set and this function is ca
91 lled,</td><td class="lineno" valign="top"></td></tr>
92       <tr><td class="lineno" valign="top"></td><td class="left"> * this function will override the behaviour of the environment variable.</td><td> </td><td class="right"> * this function will override the behaviour of the environment variable.</td><td class="lineno" valign="top"></td></tr>
93       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
94       <tr><td><a name="diff0003" /></td></tr>
95       <tr><td class="lineno" valign="top"></td><td class="lblock"></td><td> </td><td class="rblock"> <span class="insert">* Currently this function must be called after opj_setup_decoder() and</span></td><td class="lineno" valign="top"></td></tr>
96       <tr><td class="lineno" valign="top"></td><td class="lblock"></td><td> </td><td class="rblock"><span class="insert"> * before opj_read_header().</span></td><td class="lineno" valign="top"></td></tr>
97       <tr><td class="lineno" valign="top"></td><td class="lblock"></td><td> </td><td class="rblock"><span class="insert"> *</span></td><td class="lineno" valign="top"></td></tr>
98       <tr><td class="lineno" valign="top"></td><td class="left"> * Note: currently only has effect on the decompressor.</td><td> </td><td class="right"> * Note: currently only has effect on the decompressor.</td><td class="lineno" valign="top"></td></tr>
99       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
100       <tr><td class="lineno" valign="top"></td><td class="left"> * @param p_codec       decompressor handler</td><td> </td><td class="right"> * @param p_codec       decompressor handler</td><td class="lineno" valign="top"></td></tr>
101       <tr><td class="lineno" valign="top"></td><td class="left"> * @param num_threads   number of threads.</td><td> </td><td class="right"> * @param num_threads   number of threads.</td><td class="lineno" valign="top"></td></tr>
102       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
103       <tr><td class="lineno" valign="top"></td><td class="left"> * @return OPJ_TRUE     if the decoder is correctly set</td><td> </td><td class="right"> * @return OPJ_TRUE     if the decoder is correctly set</td><td class="lineno" valign="top"></td></tr>
104       <tr><td class="lineno" valign="top"></td><td class="left"> */</td><td> </td><td class="right"> */</td><td class="lineno" valign="top"></td></tr>
105       <tr><td class="lineno" valign="top"></td><td class="left">OPJ_API OPJ_BOOL OPJ_CALLCONV opj_codec_set_threads(opj_codec_t *p_codec,</td><td> </td><td class="right">OPJ_API OPJ_BOOL OPJ_CALLCONV opj_codec_set_threads(opj_codec_t *p_codec,</td><td class="lineno" valign="top"></td></tr>
106       <tr><td class="lineno" valign="top"></td><td class="left">        int num_threads);</td><td> </td><td class="right">        int num_threads);</td><td class="lineno" valign="top"></td></tr>
107       <tr><td class="lineno" valign="top"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno" valign="top"></td></tr>
108       <tr><td class="lineno"></td><td class="left"></td><td> </td><td class="right"></td><td class="lineno"></td></tr>
109       <tr bgcolor="gray" ><td></td><th><a name="part-l4" /><small>skipping to change at</small><em> line 1373</em></th><th> </th><th><a name="part-r4" /><small>skipping to change at</small><em> line 1377</em></th><td></td></tr>
110       <tr><td class="lineno" valign="top"></td><td class="left"> * that is to say at the highest resolution level, even if requesting the i
111 mage at lower</td><td> </td><td class="right"> * that is to say at the highest resolution level, even if requesting the i
112 mage at lower</td><td class="lineno" valign="top"></td></tr>
113       <tr><td class="lineno" valign="top"></td><td class="left"> * resolution levels.</td><td> </td><td class="right"> * resolution levels.</td><td class="lineno" valign="top"></td></tr>
114       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
115       <tr><td class="lineno" valign="top"></td><td class="left"> * Generally opj_set_decode_area() should be followed by opj_decode(), and 
116 the</td><td> </td><td class="right"> * Generally opj_set_decode_area() should be followed by opj_decode(), and 
117 the</td><td class="lineno" valign="top"></td></tr>
118       <tr><td class="lineno" valign="top"></td><td class="left"> * codec cannot be re-used.</td><td> </td><td class="right"> * codec cannot be re-used.</td><td class="lineno" valign="top"></td></tr>
119       <tr><td class="lineno" valign="top"></td><td class="left"> * In the particular case of an image made of a single tile, several sequen
120 ces of</td><td> </td><td class="right"> * In the particular case of an image made of a single tile, several sequen
121 ces of</td><td class="lineno" valign="top"></td></tr>
122       <tr><td class="lineno" valign="top"></td><td class="left"> * calls to opoj_set_decode_area() and opj_decode() are allowed, and will b
123 ring</td><td> </td><td class="right"> * calls to opoj_set_decode_area() and opj_decode() are allowed, and will b
124 ring</td><td class="lineno" valign="top"></td></tr>
125       <tr><td class="lineno" valign="top"></td><td class="left"> * performance improvements when reading an image by chunks.</td><td> </td><td class="right"> * performance improvements when reading an image by chunks.</td><td class="lineno" valign="top"></td></tr>
126       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
127       <tr><td class="lineno" valign="top"></td><td class="left"> * @param   p_codec         the jpeg2000 codec.</td><td> </td><td class="right"> * @param   p_codec         the jpeg2000 codec.</td><td class="lineno" valign="top"></td></tr>
128       <tr><td><a name="diff0004" /></td></tr>
129       <tr><td class="lineno" valign="top"></td><td class="lblock"> * @param   p_image         the decoded image previously set<span class="delete">ted by opj_read
130 _he</span>ader</td><td> </td><td class="rblock"> * @param   p_image         the decoded image previously set<span class="insert"> by opj_read_he
131 </span>ader</td><td class="lineno" valign="top"></td></tr>
132       <tr><td class="lineno" valign="top"></td><td class="left"> * @param   p_start_x       the left position of the rectangle to decode (i
133 n image coordinates).</td><td> </td><td class="right"> * @param   p_start_x       the left position of the rectangle to decode (i
134 n image coordinates).</td><td class="lineno" valign="top"></td></tr>
135       <tr><td class="lineno" valign="top"></td><td class="left"> * @param   p_end_x         the right position of the rectangle to decode (
136 in image coordinates).</td><td> </td><td class="right"> * @param   p_end_x         the right position of the rectangle to decode (
137 in image coordinates).</td><td class="lineno" valign="top"></td></tr>
138       <tr><td class="lineno" valign="top"></td><td class="left"> * @param   p_start_y       the up position of the rectangle to decode (in 
139 image coordinates).</td><td> </td><td class="right"> * @param   p_start_y       the up position of the rectangle to decode (in 
140 image coordinates).</td><td class="lineno" valign="top"></td></tr>
141       <tr><td class="lineno" valign="top"></td><td class="left"> * @param   p_end_y         the bottom position of the rectangle to decode 
142 (in image coordinates).</td><td> </td><td class="right"> * @param   p_end_y         the bottom position of the rectangle to decode 
143 (in image coordinates).</td><td class="lineno" valign="top"></td></tr>
144       <tr><td class="lineno" valign="top"></td><td class="left"> *</td><td> </td><td class="right"> *</td><td class="lineno" valign="top"></td></tr>
145       <tr><td class="lineno" valign="top"></td><td class="left"> * @return  true            if the area could be set.</td><td> </td><td class="right"> * @return  true            if the area could be set.</td><td class="lineno" valign="top"></td></tr>
146       <tr><td class="lineno" valign="top"></td><td class="left"> */</td><td> </td><td class="right"> */</td><td class="lineno" valign="top"></td></tr>
147       <tr><td class="lineno" valign="top"></td><td class="left">OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(opj_codec_t *p_codec,</td><td> </td><td class="right">OPJ_API OPJ_BOOL OPJ_CALLCONV opj_set_decode_area(opj_codec_t *p_codec,</td><td class="lineno" valign="top"></td></tr>
148       <tr><td class="lineno" valign="top"></td><td class="left">        opj_image_t* p_image,</td><td> </td><td class="right">        opj_image_t* p_image,</td><td class="lineno" valign="top"></td></tr>
149       <tr><td class="lineno" valign="top"></td><td class="left">        OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,</td><td> </td><td class="right">        OPJ_INT32 p_start_x, OPJ_INT32 p_start_y,</td><td class="lineno" valign="top"></td></tr>
150
151      <tr><td></td><td class="left"></td><td> </td><td class="right"></td><td></td></tr>
152      <tr bgcolor="gray"><th colspan="5" align="center"><a name="end">&nbsp;End of changes. 4 change blocks.&nbsp;</a></th></tr>
153      <tr class="stats"><td></td><th><i>4 lines changed or deleted</i></th><th><i> </i></th><th><i>8 lines changed or added</i></th><td></td></tr>
154      <tr><td colspan="5" align="center" class="small"></td></tr>
155    </table>
156    <br/><div style='width:100%;' align='left' class='small'>This html diff was produced by rfcdiff 1.41.The latest version is available from <a href='http://tools.ietf.org/tools/rfcdiff/'>http://tools.ietf.org/tools/rfcdiff/</a></div>
157 </td></tr></table>
158 </body>
159 </html>