2025-10-11 01:35:43 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=11" / >
< meta name = "generator" content = "Doxygen 1.14.0" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > libaaruformat: src/compression/lzma.c File Reference< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< script type = "text/javascript" src = "clipboard.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" src = "cookie.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr id = "projectrow" >
< td id = "projectalign" >
< div id = "projectname" > libaaruformat< span id = "projectnumber" >   1.0< / span >
< / div >
< div id = "projectbrief" > Aaru Data Preservation Suite - Format Library< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search/",'.html');
< / script >
< script type = "text/javascript" >
$(function() { codefold.init(); });
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
$(function(){initNavTree('lzma_8c.html','',''); });
< / script >
< div id = "container" >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< div id = "MSearchResults" >
< div class = "SRPage" >
< div id = "SRIndex" >
< div id = "SRResults" > < / div >
< div class = "SRStatus" id = "Loading" > Loading...< / div >
< div class = "SRStatus" id = "Searching" > Searching...< / div >
< div class = "SRStatus" id = "NoMatches" > No Matches< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "header" >
< div class = "headertitle" > < div class = "title" > lzma.c File Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "textblock" > < code > #include < stddef.h> < / code > < br / >
< code > #include < stdint.h> < / code > < br / >
< code > #include " < a class = "el" href = "aaruformat_8h_source.html" > aaruformat.h< / a > " < / code > < br / >
< code > #include " ../../3rdparty/lzma-21.03beta/C/LzmaLib.h" < / code > < br / >
< / div >
< p > < a href = "lzma_8c_source.html" > Go to the source code of this file.< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 id = "header-func-members" class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:acd18071ca55541977bc3cf37a5e6815d" id = "r_acd18071ca55541977bc3cf37a5e6815d" > < td class = "memItemLeft" align = "right" valign = "top" > int32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#acd18071ca55541977bc3cf37a5e6815d" > aaruf_lzma_decode_buffer< / a > (uint8_t *dst_buffer, size_t *dst_size, const uint8_t *src_buffer, size_t *src_len, const uint8_t *props, const size_t props_size)< / td > < / tr >
< tr class = "memdesc:acd18071ca55541977bc3cf37a5e6815d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Decodes an LZMA-compressed buffer. < br / > < / td > < / tr >
< tr class = "memitem:a9378bc542698b1f5f8c90d3b3da167b0" id = "r_a9378bc542698b1f5f8c90d3b3da167b0" > < td class = "memItemLeft" align = "right" valign = "top" > int32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a9378bc542698b1f5f8c90d3b3da167b0" > aaruf_lzma_encode_buffer< / a > (uint8_t *dst_buffer, size_t *dst_size, const uint8_t *src_buffer, const size_t src_len, uint8_t *out_props, size_t *out_props_size, const int32_t level, const uint32_t dict_size, const int32_t lc, const int32_t lp, const int32_t pb, const int32_t fb, const int32_t num_threads)< / td > < / tr >
< tr class = "memdesc:a9378bc542698b1f5f8c90d3b3da167b0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Encodes a buffer using LZMA compression. < br / > < / td > < / tr >
< / table >
< a name = "doc-func-members" id = "doc-func-members" > < / a > < h2 id = "header-doc-func-members" class = "groupheader" > Function Documentation< / h2 >
< a id = "acd18071ca55541977bc3cf37a5e6815d" name = "acd18071ca55541977bc3cf37a5e6815d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#acd18071ca55541977bc3cf37a5e6815d" > ◆   < / a > < / span > aaruf_lzma_decode_buffer()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int32_t aaruf_lzma_decode_buffer < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > dst_buffer< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > dst_size< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint8_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > src_buffer< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > src_len< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint8_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > props< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const size_t< / td > < td class = "paramname" > < span class = "paramname" > < em > props_size< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Decodes an LZMA-compressed buffer. < / p >
< p > Decompresses data from the source buffer into the destination buffer using LZMA.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > dst_buffer< / td > < td > Pointer to the destination buffer. < / td > < / tr >
< tr > < td class = "paramname" > dst_size< / td > < td > Pointer to the size of the destination buffer; updated with the actual size. < / td > < / tr >
< tr > < td class = "paramname" > src_buffer< / td > < td > Pointer to the source (compressed) buffer. < / td > < / tr >
< tr > < td class = "paramname" > src_len< / td > < td > Pointer to the size of the source buffer; updated with the actual size read. < / td > < / tr >
< tr > < td class = "paramname" > props< / td > < td > Pointer to the LZMA properties. < / td > < / tr >
< tr > < td class = "paramname" > props_size< / td > < td > Size of the LZMA properties. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > 0 on success, or an error code on failure. < / dd > < / dl >
< p class = "definition" > Definition at line < a class = "el" href = "lzma_8c_source.html#l00039" > 39< / a > of file < a class = "el" href = "lzma_8c_source.html" > lzma.c< / a > .< / p >
< p class = "reference" > References < a class = "el" href = "decls_8h_source.html#l00045" > AARU_CALL< / a > , and < a class = "el" href = "decls_8h_source.html#l00054" > AARU_EXPORT< / a > .< / p >
2025-10-11 12:43:39 +01:00
< p class = "reference" > Referenced by < a class = "el" href = "read_8c_source.html#l00253" > aaruf_read_sector()< / a > , < a class = "el" href = "ddt__v2_8c_source.html#l00724" > decode_ddt_multi_level_v2()< / a > , < a class = "el" href = "data_8c_source.html#l00071" > process_data_block()< / a > , < a class = "el" href = "ddt__v1_8c_source.html#l00085" > process_ddt_v1()< / a > , and < a class = "el" href = "ddt__v2_8c_source.html#l00096" > process_ddt_v2()< / a > .< / p >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
< a id = "a9378bc542698b1f5f8c90d3b3da167b0" name = "a9378bc542698b1f5f8c90d3b3da167b0" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a9378bc542698b1f5f8c90d3b3da167b0" > ◆   < / a > < / span > aaruf_lzma_encode_buffer()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int32_t aaruf_lzma_encode_buffer < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > dst_buffer< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > dst_size< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint8_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > src_buffer< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const size_t< / td > < td class = "paramname" > < span class = "paramname" > < em > src_len< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > out_props< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t *< / td > < td class = "paramname" > < span class = "paramname" > < em > out_props_size< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const int32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > level< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const uint32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > dict_size< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const int32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > lc< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const int32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > lp< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const int32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > pb< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const int32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > fb< / em > < / span > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const int32_t< / td > < td class = "paramname" > < span class = "paramname" > < em > num_threads< / em > < / span >   )< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Encodes a buffer using LZMA compression. < / p >
< p > Compresses data from the source buffer into the destination buffer using LZMA.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > dst_buffer< / td > < td > Pointer to the destination buffer. < / td > < / tr >
< tr > < td class = "paramname" > dst_size< / td > < td > Pointer to the size of the destination buffer; updated with the actual size. < / td > < / tr >
< tr > < td class = "paramname" > src_buffer< / td > < td > Pointer to the source (uncompressed) buffer. < / td > < / tr >
< tr > < td class = "paramname" > src_len< / td > < td > Size of the source buffer. < / td > < / tr >
< tr > < td class = "paramname" > out_props< / td > < td > Pointer to the output LZMA properties. < / td > < / tr >
< tr > < td class = "paramname" > out_props_size< / td > < td > Pointer to the size of the output LZMA properties. < / td > < / tr >
< tr > < td class = "paramname" > level< / td > < td > Compression level. < / td > < / tr >
< tr > < td class = "paramname" > dict_size< / td > < td > Dictionary size. < / td > < / tr >
< tr > < td class = "paramname" > lc< / td > < td > LZMA literal context bits. < / td > < / tr >
< tr > < td class = "paramname" > lp< / td > < td > LZMA literal position bits. < / td > < / tr >
< tr > < td class = "paramname" > pb< / td > < td > LZMA position bits. < / td > < / tr >
< tr > < td class = "paramname" > fb< / td > < td > Number of fast bytes. < / td > < / tr >
< tr > < td class = "paramname" > num_threads< / td > < td > Number of threads to use. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > 0 on success, or an error code on failure. < / dd > < / dl >
< p class = "definition" > Definition at line < a class = "el" href = "lzma_8c_source.html#l00065" > 65< / a > of file < a class = "el" href = "lzma_8c_source.html" > lzma.c< / a > .< / p >
< p class = "reference" > References < a class = "el" href = "decls_8h_source.html#l00045" > AARU_CALL< / a > , and < a class = "el" href = "decls_8h_source.html#l00054" > AARU_EXPORT< / a > .< / p >
2025-10-11 12:43:39 +01:00
< p class = "reference" > Referenced by < a class = "el" href = "write_8c_source.html#l01393" > aaruf_close_current_block()< / a > , < a class = "el" href = "ddt__v2_8c_source.html#l01092" > set_ddt_multi_level_v2()< / a > , < a class = "el" href = "close_8c_source.html#l00077" > write_cached_secondary_ddt()< / a > , < a class = "el" href = "close_8c_source.html#l01808" > write_dvd_long_sector_blocks()< / a > , < a class = "el" href = "close_8c_source.html#l02245" > write_dvd_title_key_decrypted_block()< / a > , < a class = "el" href = "close_8c_source.html#l02409" > write_media_tags()< / a > , < a class = "el" href = "close_8c_source.html#l00850" > write_mode2_subheaders_block()< / a > , < a class = "el" href = "close_8c_source.html#l00966" > write_sector_prefix()< / a > , < a class = "el" href = "close_8c_source.html#l01206" > write_sector_prefix_ddt()< / a > , < a class = "el" href = "close_8c_source.html#l01508" > write_sector_subchannel()< / a > , < a class = "el" href = "close_8c_source.html#l01088" > write_sector_suffix()< / a > , < a class = "el" href = "close_8c_source.html#l01350" > write_sector_suffix_ddt()< / a > , and < a class = "el" href = "close_8c_source.html#l00369" > write_single_level_ddt()< / a > .< / p >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
< div id = "page-nav" class = "page-nav-panel" >
< div id = "page-nav-resize-handle" > < / div >
< div id = "page-nav-tree" >
< div id = "page-nav-contents" >
< / div > <!-- page - nav - contents -->
< / div > <!-- page - nav - tree -->
< / div > <!-- page - nav -->
< / div > <!-- container -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a href = "dir_68267d1309a1af8e8297ef4c3efbcdba.html" > src< / a > < / li > < li class = "navelem" > < a href = "dir_40ed6a89610fc2370cf3ffcd6469b940.html" > compression< / a > < / li > < li class = "navelem" > < a href = "lzma_8c.html" > lzma.c< / a > < / li >
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.14.0 < / li >
< / ul >
< / div >
< / body >
< / html >
