cram.h 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. /*
  2. Copyright (c) 2012-2013 Genome Research Ltd.
  3. Author: James Bonfield <jkb@sanger.ac.uk>
  4. Redistribution and use in source and binary forms, with or without
  5. modification, are permitted provided that the following conditions are met:
  6. 1. Redistributions of source code must retain the above copyright notice,
  7. this list of conditions and the following disclaimer.
  8. 2. Redistributions in binary form must reproduce the above copyright notice,
  9. this list of conditions and the following disclaimer in the documentation
  10. and/or other materials provided with the distribution.
  11. 3. Neither the names Genome Research Ltd and Wellcome Trust Sanger
  12. Institute nor the names of its contributors may be used to endorse or promote
  13. products derived from this software without specific prior written permission.
  14. THIS SOFTWARE IS PROVIDED BY GENOME RESEARCH LTD AND CONTRIBUTORS "AS IS" AND
  15. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17. DISCLAIMED. IN NO EVENT SHALL GENOME RESEARCH LTD OR CONTRIBUTORS BE LIABLE
  18. FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19. DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  20. SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  21. CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  22. OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24. */
  25. /*! \file
  26. * CRAM interface.
  27. *
  28. * Consider using the higher level scram_*() API for programs that wish to
  29. * be file format agnostic.
  30. *
  31. * This API should be used for CRAM specific code. The specifics of the
  32. * public API are implemented in cram_io.h, cram_encode.h and cram_decode.h
  33. * although these should not be included directly (use this file instead).
  34. */
  35. #ifdef __cplusplus
  36. extern "C" {
  37. #endif
  38. #ifdef SAMTOOLS
  39. # include "cram/cram_samtools.h"
  40. #endif
  41. #ifndef _CRAM_H_
  42. #define _CRAM_H_
  43. #include "cram/sam_header.h"
  44. #include "cram_structs.h"
  45. #include "cram_io.h"
  46. #include "cram_encode.h"
  47. #include "cram_decode.h"
  48. #include "cram_stats.h"
  49. #include "cram_codecs.h"
  50. #include "cram_index.h"
  51. #endif
  52. #ifdef __cplusplus
  53. }
  54. #endif