Releases: samtools/samtools
1.23.1
Download the source code here: samtools-1.23.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Bug fixes:
-
This release bundles HTSlib 1.23.1, which includes many important bug fixes. Please see htslib/NEWS for details.
-
Fix incorrect variable expansion in seq_cache_populate.py (PR #2291. Thanks to Ruben Vorderman)
-
Don't try to write out empty strings in threaded consensus pileup mode. (PR #2305)
-
Wrap ctype.h functions to avoid array subscript warnings, and add casts to prevent sign extension where arrays are indexed with char values. (PR #2306)
-
Make
samtools cram-sizeexit cleanly instead of crashing if it reads an invalid CRAM header. (CVE-2026-31973) (PR #2313)
Build changes:
-
Reordered options for grep commands in tests so the input file is at the end. (PR #2311)
-
Limit memory used by samtools sort in tests. (PR #2312)
Download the source code here: samtools-1.23.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.22.2
Download the source code here: samtools-1.22.2.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Bug fixes:
-
This release bundles HTSlib 1.22.2, which includes many important bug fixes. Please see htslib/NEWS for details.
-
Prevent
samtools coveragefrom printing a coverage table on failure. (PR #2247, fixes #2242. Reported by Georges Kanaan) -
Remove deprecated line style commands from
plot-bamstats. (PR #2251, fixes #2243. Reported by Suhas Srinivasan) -
Check for file close errors in
samtools addreplacerg. (PR #2254. Thanks to Martin Pollard) -
Add missing sam_global_args_free calls to address memory leaks. (PR #2274)
-
Don't try to write out empty strings in threaded consensus pileup mode. (PR #2305)
-
Wrap ctype.h functions to avoid array subscript warnings, and add casts to prevent sign extension where arrays are indexed with char values. (PR #2306)
-
Make
samtools cram-sizeexit cleanly instead of crashing if it reads an invalid CRAM header. (CVE-2026-31973) (PR #2313)
Build changes:
-
Ensure test files are cleaned up. (PR #2241. Thanks to John Marshall)
-
Reordered options for grep commands in tests so the input file is at the end. (PR #2311)
Download the source code here: samtools-1.22.2.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.21.1
Download the source code here: samtools-1.21.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Bug fixes:
-
This release bundles HTSlib 1.21.1, which includes many important bug fixes. Please see htslib/NEWS for details.
-
Fix use-after-free bug in
samtools mpileup -adue to reference sequences being discarded too early. This could happen when the-aoption was used, and all the alignments for one of the references started at the same position. This caused mpileup to try to load the next reference before it had finished writing data for the previous one out. (CVE-2026-31972) (PR #2229, fixes #2227. Reported by Pouya Kheradpour) -
Fix
samtools fastq -ito force CRAM aux tag decoding. (PR #2155, fixes #2154. Reported by Alex Leonard) -
Improve
plot-bamstatsquality plots. (PR #2143 combined with PR #2116. Thanks to James Gilbert) -
Fix depth counts when overlap removal is enabled. (PR #2171, fixes #2170. Reported by Yangqi Su)
-
Protect against merging CRAM files with different headers. (PR#2220, fixes #2218. Reported by Kevin Lewis)
-
Prevent
samtools coveragefrom printing a coverage table on failure. (PR #2247, fixes #2242. Reported by Georges Kanaan) -
Remove deprecated line style commands from
plot-bamstats. (PR #2251, fixes #2243. Reported by Suhas Srinivasan) -
Check for file close errors in
samtools addreplacerg. (PR #2254. Thanks to Martin Pollard) -
Add missing
sam_global_args_freecalls to address memory leaks. (PR #2274) -
Wrap ctype.h functions to avoid array subscript warnings, and add casts to prevent sign extension where arrays are indexed with char values. (PR #2306)
-
Make
samtools cram-sizeexit cleanly instead of crashing if it reads an invalid CRAM header. (CVE-2026-31973) (PR #2313)
Build changes: -
Fix broken tests due to MSYS2 changes. Due to changes in how MSYS2 perl reported the identity of the OS it was built for, our tests were failing to adapt to the Windows style file locations. (PR #2196)
-
Added settings to limit memory used by
samtools sortwhen running tests. (PR #2226) -
Ensure test files are cleaned up. (PR #2241. Thanks to John Marshall)
-
Reordered options for grep commands in tests so the input file is at the end. (PR #2311)
Download the source code here: samtools-1.21.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.23
Download the source code here: samtools-1.23.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
New work and changes:
-
New reference stats in
samtools stats. First line in RFS section gives the total sequence count, count of regions, average GC, min, max, average and total counts. Second line onwards gives regions, lengths, GC and unknown base count. (PR #2224, implements #2139. Requested by Filipe G. Vieira) -
New, faster Python version of
seq_cache_populateto create and update REF_CACHE. (PR #2231. Thanks to Ruben Vorderman) -
Add a minimum depth (
--min-depth) option tosamtools coverage. (PR #2235, implements #1563. Requested by Charles Foster) -
Add an option to exclude reads (
--exclude-no-read-group) that have no read group fromsamtools viewwhen the-r(or-R) options are used. (PR #2271, fixes #2265. Reported by Matt Sexton) -
Add UMI support to
samtools fastqandsamtools import. See samtools/htslib#1960. (PR #2270, fixes #2259 amd #2262. Requested by Poshi) -
Optionally trim soft clips from reads in
samtools fastqoutput. (PR #2233, fixes #1275. Requested by Torsten Seemann) -
If sam file is sorted by tag,
samtools splitwill output data sequentially to avoid having simultaneous open files. (PR #2281, fixes #2276. Requested by Clint Valentine)
Documentation:
-
In the command help output add a link to the global options in the samtools.1 page on the HTSlib site. (PR #2258, addresses #2236. Reported by Chris Saunders)
-
Add a support section to README.md. This mentions the GitHub issue tracker and an email address for security issues. (PR #2267)
Bug fixes:
-
Prevent
samtools coveragefrom printing a coverage table on failure. (PR #2247, fixes #2242. Reported by Georges Kanaan) -
Remove deprecated line style commands from plot-bamstats. (PR #2251, fixes #2243. Reported by Suhas Srinivasan)
-
Add missing
sam_global_args_free()calls to address (harmless) memory leaks. (PR #2274) -
Fix
samtools consensuscrash when used with threads and iterators. See also samtools/htslib#1959 (PR #2269)
Non user-visible changes and build improvements:
-
Ignore and testclean test/stat/*.fa.fai (PR #2241. Thanks to John Marshall)
-
Remove use of C variables starting in
_from bam_consensus.c. (PR #2250, fixes #2248. Reported by Ghanji125) -
Add Replace
RGcheck exit and add some comments to bam_addrprg.c. (PR #2254. Thanks to Martin Pollard)
Download the source code here: samtools-1.23.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.22.1
Download the source code here: samtools-1.22.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Bug fixes:
-
SECURITY: Fix use-after-free bug in
samtools mpileup -adue to reference sequences being discarded too early. This could happen when the-aoption was used, and all the alignments for one of the references started at the same position. This caused mpileup to try to load the next reference before it had finished writing data for the previous one out. (PR #2229, fixes #2227. Reported by Pouya Kheradpour) -
This release bundles htslib-1.22.1 and htscodecs v1.6.4. Fixes a possible buffer overflow on some invalid CRAM inputs; and a failure when trying to save data with very long alignment records with sequence '*' as CRAM version 3.1.
See the HTSlib and htscodecs NEWS files for details.
Documentation:
- Clarify that
-@starts additional threads insamtools indexhelp, and fix formatting issues in thesamtools resetmanual page. (PR #2225)
Build changes:
- Added settings to limit memory used by
samtools sortwhen running tests. (PR #2226)
Download the source code here: samtools-1.22.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.22
Download the source code here: samtools-1.22.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Note this release changes the default output CRAM version from 3.0 to 3.1. HTSlib and SAMtools have been able to read CRAM 3.1 since version 1.12, however other tools may not yet be able to cope. We know Noodles reads CRAM3.1 and htsjdk has a draft implementation, but not yet released.
HTSlib has options for modifying the output formats, which are exposed in SAMtools. When specifying an output format you can explicitly change the version via e.g. samtools view -O cram,version=3.0 ....
Further documentation on this change can be found at https://www.htslib.org/benchmarks/CRAM.html
HTSlib no longer fetches CRAM reference data from EBI's server by default. Your organisation may wish to set up local infrastructure to supply reference sequences, e.g., using the new ref-cache tool included in this HTSlib release. See the REF_CACHE and REF_PATH environment variables documented in https://www.htslib.org/doc/reference_seqs.html and the SAMtools manpage for details.
New work and changes:
-
New
samtools checksumcommand. This checksums sequence, name, quality and barcode tags in an order and orientation agnostic manner, to facilitate validation of no data loss between raw fastq (or unmapped crams) through alignment, duplication marking, sorting, and other processing operations to get to the final aligned bam/cram. (PR #2122) -
Extend
samtools sort -Mto distinguish between mapped and unmapped files. (PR #2110, fixes #2105. Reported by Armin Töpfer) -
Allow the
samtools sort"merging from..." message to be silenced. Setting the verbosity to 0 or 1 will now silence this message. (PR #2197, resolves #2185. Requested by Alex Predeus) -
Add
--save-countsoption tosamtools view. Adds an option to store counts of records processed, accepted and rejected by filtering to a file. (PR #2120, resolves #2038. Requested by Chang Y) -
samtools fastaandfastqcan now make faidx/fqidx indexes while writing using the--write-indexoption. (PR #2125, resolves #2118. Requested by Filipe G. Vieira) -
Add a warning for
samtools fastqon coordinate sorted data. (PR #2176, fixes #2169 and #2161. Reported by wook2014) -
samtools tviewadd-ito hide inserts. (PR #2123. Thanks to Benjamin Bræstrup Sayoc) -
Show optional headers with
samtools bedcov -H. (PR #2140, fixes #2126. Reported by biounix) -
samtools consensusnow supports proper multi-threading. Previously this was restricted to decompression only, but it should now scale better. (PR #2174, supersedes PR #2141) -
Add
samtools consensus -T ref.fafunctionality. This reports the reference value if a consensus value cannot be calculated. (PR #2153, fixes an additional request in #1915) -
In
samtools consensus, do not use consensus N for "*" (absent) calls that are masked due to insufficient depth. (PR #2204, fixes #2167. Reported by sanschiffre) -
Improve
plot-bamstatsquality plots. (PR #2143 combined with PR #2116 (thanks to James Gilbert)) -
Make
reheader -huse /tmp and honour TMPDIR. (PR #2168, related to #2165. Reported by Zhang Yuanfeng) -
Set sort order header tag to unsorted when ordering is lost during
samtools merge. (PR #2173, fixes #2159. Reported by Filipe G. Vieira) -
Protect against merging CRAM files with different headers. (PR #2220, fixes #2218. Reported by Kevin Lewis)
-
samtools statsbug-fix to checksum calculation for quality values. This corrects the checksums but in turn makes the calculated value different to that reported by previous samtools versions. (PR #2193, fixes #2187) -
Clarification for
samtools statswhen used on files with different sort orders. (PR #2198, fixes #2177. Reported by Filipe G. Vieira) -
In
samtools stats, dovetailed (completely overlapping) read pairs are now always counted as inward-oriented. Previously they could have been inwards or outwards depending on read ordering. (PR #2216, resolves #2210. Requested by Pontus Hüer)
Documentation:
-
Correct the example for 1:1
samtools consensuscoords. (PR #2113, fixes #2111. Reported by schorlton-bugseq) -
Documents the fastq format options used in SAMtools and HTSlib. (PR #2123, fixes #2121)
-
Remove mention of threads from
samtools catman page. (PR #2162, fixes #2160. Reported by Brandon Pickett) -
Update
samtools mergeman page to include--template-coordinate. (PR #2164. Thanks to Nils Homer) -
Revised CRAM reference sequence documentation in the samtools man page. (PR #2178)
-
Added fish shell completion and renamed completion for bash shell. These files can be copied to appropriate directories by the user. For full functionality it requires Python3.5+ and installed samtools manpages. (PR #2203. Thanks to LunarEclipse363)
-
Fix URL printed by the
seq_cache_populate.plscript. (PR #2222. Thanks to Charles Plessy)
Bug fixes: -
samtools consensuspreviously could give different results for BAM and CRAM files with the same content. This was because MD/NM tag generation was disabled in CRAM, but thedecode_md=0option did nothing with BAM. Note with--no-adj-MQboth BAM and CRAM gave identical results. Now use--input-fmt-option decode_md=0to get the old CRAM behaviour. Otherwise, both BAM and CRAM will be utilising MD/NM to locally modify mapping quality. (PR #2156) -
samtools consensuswithout-apreviously still padded with leading Ns in some cases. It now consistently removes both leading and trailing Ns. Use "-a" if you want all reference bases displayed. (Part of PR #2174 above) -
Change how
markduplooks for single reads. Due to changes tofixmatein 1.21markdupno longer recognised single reads that would have normally have been part of a pair. (PR #2117, fixes #2117. Reported by Kristy Horan) -
Fix
samtools mergecrash on BAM files with malformed headers. (PR #2128, fixes #2127. Reported by Frostb1te) -
Fix
faidx --write-indexinvalid free. (PR #2147, fixes 2142. Reported by Alex Leonard) -
Fix
samtools fastq -ito force CRAM aux tag decoding. (PR #2155, fixes #2155. Reported by Alex Leonard)
Non user-visible changes and build improvements: -
Improve htslib#PRnum support for Cirrus-CI and GitHub Actions. (PR #2115)
-
Fix broken tests due to MSYS2 changes. Due to changes in how MSYS2 perl reported the identity of the OS it was built for, our tests were failing to adapt to the Windows style file locations. (PR #2196)
-
Upgrade to
_XOPEN_SOURCE=700, to match HTSlib. Also replaceusleep()withnanosleep(). (PR #2221)
Download the source code here: samtools-1.22.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.21
Download the source code here: samtools-1.21.tar.bz2.
Notice:
- This is the last SAMtools / HTSlib release where CRAM 3.0 will be the default CRAM version. From the next we will change to CRAM 3.1 unless the version is explicitly specified, for example using
samtools view -O cram,version=3.0.
New work and changes:
-
samtools resetnow removes a set of predefined auxtags, as these tags are no longer valid after the reset operation. This behaviour can be overridden if desired. (PR #2034, fixes #2011. Reported by Felix Lenner) -
samtools resetnow also removes duplicate flags. (PR #2047. Reported by Kevin Lewis) -
Region and section/part filtering added to CRAM
samtools cat. Region filtering permitssamtools catto produce new CRAMs that only cover a specified region. (PR #2035) -
Added a report of the number of alignments for each primer to
samtools ampliconclip. (PR #2039, PR #2101, feature request #2033. Thanks to Brad Langhorst) -
Make
ampliconclipprimer counts output deterministic. (PR #2081) -
samtools fixmateno longer removes thePAIREDflag from reads that have no mate. This is done on the understanding that thePAIREDflag is a sequencing technology indicator not a feature of alignment. This is a change to previousfixmatebehaviour. (PR #2056, fixes #2052. Reported by John Wiedenhoeft) -
Added bgzf compressed FASTA output to
samtools faidx. (PR #2067, fixes #2055. Requested by Filipe G Vieira) -
Optimise
samtools depthhistogram incrementing code. (PR #2078) -
In
samtools mergezero pad unique suffix IDs. (PR #2087, fixes #2086. Thanks to Chris Wright) -
samtools idxstatsnow accepts the-Xoption, making it easier to specify the location of the index file. (PR #2093, feature request #2071. Requested by Samuel Chen) -
Improved documentation for the mpileup
--adjust-MQoption. (PR #2098. Requested by Georg Langebrake)
Bug fixes:
-
Avoid
tviewbuffer overflow for positions with >= 14 digits. (PR #2032. Thanks to John Marshall. Reported on bioconda/bioconda-recipes#47137 by jmunoz94) -
Added file name and error message to 'error closing output file' error in
samtools sort. (PR #2050, fixes #2049. Thanks to Joshua C Randall). -
Fixed hard clip trimming issue in
ampliconclipwhere right-hand side qualities were being removed from left-hand side trims. (PR #2053, fixes #2048. Reported by Duda5) -
Fixed a bug in
samtools merge --template-coordinatewhere the wrong heap was being tested. (PR #2062. Thanks to Nils Homer. Reported on ng-core/fastquorum#52 by David Mas-Ponte) -
Do not look at chr
*for unmapped-placed reads withsamtools view --fetch-pairs. This was causing a significant slowdown when--fetch-pairswas being used. (PR #2070, fixes #2059. Reported by acorvelo) -
Fixed bug which could cause
samtools view -Lto give incomplete output when the BED file contained nested target locations. (PR #2107, fixes #2104. Reported by geertvandeweyer) -
Enable
samtools coverageto handle alignments that do not have quality score data. This was causing memory access problems. (PR #2083, fixes #2076. Reported by Matthew Colpus) -
Fix undefined behaviour in
samtools fastqwith emptyQUAL. (PR #2084) -
In
plot-bamstatsfixed read-length plot for data with limited variations in length. Lack of data was causing gnuplot problems. (PR #2085, fixes #2068. Reported by mariyeta) -
Fixed an accidental fall-through that caused
samtools split -pto also enable--no-PG. (PR #2101) -
Fixed an overflow that caused
samtools consensus -m simpleto give incorrect output when the input coverage exceeded several million reads deep. (PR #2099, fixes #2095. Reported by Dylan Lawrence)
Non user-visible changes and build improvements:
-
Work around address sanitizer going missing from the Cirrus CI ubuntu clang compiler by moving the address sanitizer build to gcc. Fix warnings from the new clang compiler. (PR #2043)
-
Windows based CI has been migrated from AppVeyor to GitHub Actions. (PR #2072, PR #2108)
-
Turn on more warning options in Cirrus-CI builds, ensure everything builds with
-Werror, and add undefined behaviour checks to the address sanitizer test. (PR #2101, PR #2103, PR #2109) -
Tidy up Makefile dependencies and untracked test files. (PR #2106. Thanks to John Marshall)
Download the source code here: samtools-1.21.tar.bz2. (The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
1.20
Download the source code here: samtools-1.20.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
New work and changes:
-
Added a
--max-depthoption tobedcov, for more control over the depth limit used when calculating the pileup. Previously this limit was set at 64000; now it is set to over 2 billion, so effectively all bases will be counted. (PR #1970, fixes #1950. Reported by ellisjj) -
Added
mpileup --output-extra RLENto display the unclipped read length. (PR #1971, feature request #1959. Requested by Feng Tian) -
Improved checking of symbolic flag names (e.g.
UNMAP) passed to samtools. (PR #1981, fixes #1977. Reported by Ilya Shlyakhter) -
The
samtools consensus --min-depthoption now works for the Bayesian mode as well as the simple one. (PR #1989, feature request #1982. Requested by Gautier Richard) -
It's now possible to use the
samtools fastq-d tag:valoption multiple times, allowing matches on more than one tag/value. It also gets a-Doption which allows the values to be listed in a file. (PR #1993, feature request #1958. Requested by Tristan Lefebure) -
Added
samtools fixmate-Moption to sanity check base modification (ML,MM,MN) tags, and where necessary adjust modification data on hard-clipped records. (PR #1990) -
Made
mpileuprun faster. (PR #1995) -
samtools importnow adds a@PGheader to the files it makes. As with other sub-commands, this can be disabled by using--no-PG. (PR #2008. Requested by Steven Leonard) -
The
samtools split-doption to split by tag value now works on tags with integer values. (PR #2005, feature request #1956. Requested by Alex Leonard) -
Adjusted
samtools sort -n(by name) so that primary reads are always sorted before secondary / supplementary. (PR #2012, feature request #2010. Requested by Stijn van Dongen) -
Added
samtools bedcov-Hoption to print column headers in the output. (PR #2025. Thanks to Dr. K. D. Murray)
Documentation:
-
Added a note that BAQ is applied before filtering and overlap removal during mpileup processing. (PR #1988, fixes #1985. Reported by Joseph Galasso)
-
Added 3.1 to the list of supported CRAM versions in the samtools manual page. (PR #2009. Thanks to Andrew Thrasher)
-
Made assorted improvements to ampliconclip, flagstat and markdup manual pages. (PR #2014)
Bug Fixes:
-
Security fix: Fixed double free that could occur if bed file indexing failed due to running out of memory. This bug first appeared in version 1.19.1. (PR #2026)
-
Corrected error message printed when faidx fails to load the fai index. (PR #1987. Thanks to Nick Moore)
-
Fixed bug introduced in release 1.4 that caused incorrect reference bases to be printed by
samtools mpileup -a -f ref.fain the zero-depth regions at the end of each reference. (PR #2019, fixes #2018. Reported by Joe Georgeson) -
Fixed a samtools view usage crash on MinGW when given invalid options. (PR #2030, fixes #2029. Reported by Divon Lan)
Non user-visible changes and build improvements:
1.19.2
Download the source code here: samtools-1.19.2.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Bug Fixes:
1.19.1
Download the source code here: samtools-1.19.1.tar.bz2.(The "Source code" downloads are generated by GitHub and are incomplete as they don't bundle HTSlib and are missing some generated files.)
Bug Fixes:
-
Fixed a possible array bounds violation when looking up regions in a BED file (e.g. using
samtools view -L). This could lead to crashes or the return of incomplete results if the BED file contained a large number of entries all referencing low positions on a chromosome. (PR #1962, fixes #1961. Reported by geertvandeweyer) -
Fixed a crash in samtools stats that occurred when trying to clean up after it was unable to open a CRAM reference file. (PR #1957, fixes crash reported in samtools/htslib#1723. Reported by Alex Leonard)
Documentation: -
Fixed inverted logic in the
samtools consensus --show-delmanual page description. (PR #1955, fixes #1951. Reported by Mikhail Schelkunov) -
Added a description of the MPC section to the
samtools statsmanual page. (PR #1963, fixes #1954. Reported by litun-fkby)