1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
|
/*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#include <klib/rc.h>
#include <klib/log.h>
#include <vdb/database.h>
#include <vdb/vdb-priv.h>
#include <kdb/manager.h>
#include <insdc/sra.h>
#include <insdc/insdc.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <assert.h>
#include <ctype.h>
#include "Globals.h"
#include <align/writer-sequence.h>
#include "sequence-writer.h"
/* MARK: Sequence Object */
Sequence *SequenceInit(Sequence *self, VDatabase *db) {
memset(self, 0, sizeof(*self));
self->db = db;
VDatabaseAddRef(db);
return self;
}
static rc_t getTable(Sequence *self, bool color)
{
int const options = (color ? ewseq_co_ColorSpace : 0)
| (G.hasTI ? ewseq_co_TI : 0)
| (G.globalMode == mode_Remap ? (ewseq_co_SaveRead | ewseq_co_KeepKey) : 0)
| ewseq_co_NoLabelData
| ewseq_co_SpotGroup;
if (self->tbl) return 0;
return TableWriterSeq_Make(&self->tbl, self->db,
options,
G.QualQuantizer);
}
static rc_t writeRecordX(Sequence *self,
SequenceRecord const *rec,
bool color,
bool isDup,
INSDC_SRA_platform_id platform
)
{
rc_t rc = 0;
uint8_t nreads = rec->numreads;
unsigned i;
unsigned seqLen;
int64_t dummyRowId;
uint8_t readInfo[4096];
void *h_readInfo = NULL;
INSDC_coord_zero *readStart = (void *)readInfo;
INSDC_coord_len *readLen;
uint8_t *alcnt;
INSDC_SRA_xread_type *readType;
INSDC_SRA_read_filter *readFilter;
bool *mask = NULL;
size_t const elemSize = sizeof(alcnt[0]) + sizeof(readType[0])
+ sizeof(readStart[0]) + sizeof(readLen[0])
+ sizeof(readFilter[0]);
TableWriterSeqData data;
assert(G.mode == mode_Archive);
for (i = seqLen = 0; i != nreads; ++i) {
seqLen += rec->readLen[i];
}
if (nreads * elemSize + G.keepMismatchQual * seqLen * sizeof(mask[0]) > sizeof(readInfo))
{
h_readInfo = malloc(nreads * elemSize + G.keepMismatchQual * seqLen * sizeof(mask[0]));
if (h_readInfo == NULL)
return RC(rcAlign, rcTable, rcWriting, rcMemory, rcExhausted);
readStart = h_readInfo;
}
readLen = (INSDC_coord_len *)&readStart[nreads];
alcnt = (uint8_t *)&readLen[nreads];
readType = (INSDC_SRA_xread_type *)&alcnt[nreads];
readFilter = (INSDC_SRA_read_filter *)&readType[nreads];
if (G.keepMismatchQual) {
mask = (bool *)&readFilter[nreads];
for (i = 0; i != seqLen; ++i) {
mask[i] = (rec->qual[i] & 0x80) != 0;
}
}
for (i = 0; i != nreads; ++i) {
int const count = rec->aligned[i] ? 1 : 0;
int const len = rec->readLen[i];
int const start = rec->readStart[i];
int const type = len == 0 ? SRA_READ_TYPE_TECHNICAL : SRA_READ_TYPE_BIOLOGICAL;
int const dir = len == 0 ? 0 : rec->orientation[i] ? SRA_READ_TYPE_REVERSE : SRA_READ_TYPE_FORWARD;
int const filter = isDup ? SRA_READ_FILTER_CRITERIA : rec->is_bad[i] ? SRA_READ_FILTER_REJECT : SRA_READ_FILTER_PASS;
alcnt[i] = count;
readLen[i] = len;
readStart[i] = start;
readType[i] = type | dir;
readFilter[i] = filter;
}
memset(&data, 0, sizeof(data));
data.sequence.buffer = rec->seq;
data.sequence.elements = seqLen;
data.quality.buffer = rec->qual;
data.quality.elements = seqLen;
if (G.keepMismatchQual) {
data.no_quantize_mask.buffer = mask;
data.no_quantize_mask.elements = seqLen;
}
data.alignment_count.buffer = alcnt;
data.alignment_count.elements = nreads;
data.nreads = nreads;
data.read_type.buffer = readType;
data.read_type.elements = nreads;
data.read_start.buffer = readStart;
data.read_start.elements = nreads;
data.read_len.buffer = readLen;
data.read_len.elements = nreads;
data.tmp_key_id = rec->keyId;
data.spot_group.buffer = rec->spotGroup;
data.spot_group.elements = rec->spotGroupLen;
data.cskey.buffer = rec->cskey;
data.cskey.elements = nreads;
data.read_filter.buffer = readFilter;
data.read_filter.elements = nreads;
data.platform.buffer = &platform;
data.platform.elements = 1;
data.ti.buffer = rec->ti;
data.ti.elements = nreads;
if (!G.no_real_output) {
rc = getTable(self, color);
if (rc == 0) {
rc = TableWriterSeq_Write(self->tbl, &data, &dummyRowId);
}
}
if (h_readInfo)
free(h_readInfo);
return rc;
}
static unsigned totalSequenceLength(SequenceRecord const *const rec)
{
unsigned const nreads = rec->numreads;
unsigned rslt = 0;
unsigned i;
for (i = 0; i < nreads; ++i)
rslt += rec->readLen[i];
return rslt;
}
static rc_t writeRecord2(Sequence *self,
SequenceRecord const *rec,
bool color,
bool isDup,
INSDC_SRA_platform_id platform
)
{
INSDC_SRA_xread_type readType[2];
INSDC_SRA_read_filter readFilter[2];
uint8_t alcnt[2];
rc_t rc = 0;
unsigned const nreads = rec->numreads;
unsigned const seqLen = totalSequenceLength(rec);
unsigned i;
bool fullyUnaligned = true;
TableWriterSeqData data;
assert(G.mode == mode_Archive);
for (i = 0; i != nreads; ++i) {
int const count = rec->aligned[i] ? 1 : 0;
int const len = rec->readLen[i];
int const type = len == 0 ? SRA_READ_TYPE_TECHNICAL : SRA_READ_TYPE_BIOLOGICAL;
int const dir = len == 0 ? 0 : rec->orientation[i] ? SRA_READ_TYPE_REVERSE : SRA_READ_TYPE_FORWARD;
int const filter = isDup ? SRA_READ_FILTER_CRITERIA : rec->is_bad[i] ? SRA_READ_FILTER_REJECT : SRA_READ_FILTER_PASS;
if (rec->aligned[i])
fullyUnaligned = false;
alcnt[i] = count;
readType[i] = type | dir;
readFilter[i] = filter;
}
memset(&data, 0, sizeof(data));
data.sequence.buffer = rec->seq;
data.sequence.elements = seqLen;
data.quality.buffer = rec->qual;
data.quality.elements = seqLen;
data.alignment_count.buffer = alcnt;
data.alignment_count.elements = nreads;
data.nreads = nreads;
data.read_type.buffer = readType;
data.read_type.elements = nreads;
data.read_start.buffer = rec->readStart;
data.read_start.elements = nreads;
data.read_len.buffer = rec->readLen;
data.read_len.elements = nreads;
data.tmp_key_id = rec->keyId;
data.spot_group.buffer = rec->spotGroup;
data.spot_group.elements = rec->spotGroupLen;
data.cskey.buffer = rec->cskey;
data.cskey.elements = nreads;
data.read_filter.buffer = readFilter;
data.read_filter.elements = nreads;
data.platform.buffer = &platform;
data.platform.elements = 1;
data.ti.buffer = rec->ti;
data.ti.elements = nreads;
if (fullyUnaligned && rec->linkageGroup && rec->linkageGroupLen > 0) {
data.linkageGroup.buffer = rec->linkageGroup;
data.linkageGroup.elements = rec->linkageGroupLen;
}
if (!G.no_real_output) {
rc = getTable(self, color);
if (rc == 0) {
int64_t dummyRowId;
rc = TableWriterSeq_Write(self->tbl, &data, &dummyRowId);
}
}
return rc;
}
rc_t SequenceWriteRecord(Sequence *self,
SequenceRecord const *rec,
bool color,
bool isDup,
INSDC_SRA_platform_id platform
)
{
if (rec->numreads <= 2 && !G.keepMismatchQual) {
return writeRecord2(self, rec, color, isDup, platform);
}
else {
return writeRecordX(self, rec, color, isDup, platform);
}
}
static rc_t ReadSequenceData(TableWriterSeqData *const data, VCursor const *const curs, int64_t const row, uint32_t const colId[])
{
int i;
memset(data, 0, sizeof(*data));
for (i = 0; i <= 8; ++i) {
uint32_t elem_bits = 0;
uint32_t row_len = 0;
uint32_t boff = 0;
void const *base = NULL;
rc_t const rc = VCursorCellDataDirect(curs, row, colId[i], &elem_bits, &base, &boff, &row_len);
if (rc == 0) {
TableWriterData *tdata = NULL;
switch (i) {
case 0:
assert(elem_bits == sizeof(data->tmp_key_id) * 8);
assert(row_len == 1);
memmove(&data->tmp_key_id, base, sizeof(data->tmp_key_id));
break;
case 1:
tdata = &data->sequence;
break;
case 2:
tdata = &data->quality;
break;
case 3:
tdata = &data->read_type;
break;
case 4:
tdata = &data->read_start;
break;
case 5:
tdata = &data->read_len;
break;
case 6:
tdata = &data->spot_group;
break;
case 7:
tdata = &data->read_filter;
break;
case 8:
tdata = &data->platform;
break;
default:
assert(!"reachable");
break;
}
if (tdata) {
tdata->buffer = base;
tdata->elements = row_len;
}
}
else
return rc;
}
return 0;
}
rc_t SequenceDoneWriting(Sequence *self)
{
if (G.mode == mode_Remap) {
/* copy the SEQUENCE table from the first output */
VDBManager *mgr = NULL;
rc_t rc;
getTable(self, false);
rc = VDatabaseOpenManagerUpdate(self->db, &mgr);
assert(rc == 0);
if (rc == 0) {
VDatabase const *db = NULL;
rc = VDBManagerOpenDBRead(mgr, &db, NULL, G.firstOut);
assert(rc == 0);
VDBManagerRelease(mgr);
if (rc == 0) {
VTable const *tbl = NULL;
rc = VDatabaseOpenTableRead(db, &tbl, "SEQUENCE");
assert(rc == 0);
VDatabaseRelease(db);
if (rc == 0) {
VCursor const *curs = NULL;
rc = VTableCreateCursorRead(tbl, &curs);
assert(rc == 0);
VTableRelease(tbl);
if (rc == 0) {
uint32_t colId[9];
rc = VCursorAddColumn(curs, &colId[0], "TMP_KEY_ID");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[1], "(INSDC:dna:text)READ");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[2], "QUALITY");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[3], "READ_TYPE");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[4], "READ_START");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[5], "READ_LEN");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[6], "SPOT_GROUP");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[7], "READ_FILTER");
assert(rc == 0);
rc = VCursorAddColumn(curs, &colId[8], "PLATFORM");
assert(rc == 0);
if (rc == 0) {
rc = VCursorOpen(curs);
assert(rc == 0);
if (rc == 0) {
int64_t first;
uint64_t count;
uint64_t row;
TableWriterSeqData data;
rc = VCursorIdRange(curs, colId[0], &first, &count);
assert(rc == 0);
for (row = 0; row < count; ++row) {
int64_t dummyRowId = 0;
rc = ReadSequenceData(&data, curs, row+first, colId);
assert(rc == 0);
if (rc) return rc;
data.nreads = data.read_start.elements;
rc = TableWriterSeq_Write(self->tbl, &data, &dummyRowId);
assert(rc == 0);
if (rc) return rc;
}
}
}
VCursorRelease(curs);
}
}
}
}
}
return TableWriterSeq_TmpKeyStart(self->tbl);
}
rc_t SequenceReadKey(const Sequence *cself, int64_t row, uint64_t *keyId)
{
return TableWriterSeq_TmpKey(cself->tbl, row, keyId);
}
rc_t SequenceUpdateAlignData(Sequence *self, int64_t rowId, unsigned nreads,
int64_t const primeId[/* nreads */],
uint8_t const algnCnt[/* nreads */])
{
TableWriterData data[2];
data[0].buffer = primeId; data[0].elements = nreads;
data[1].buffer = algnCnt; data[1].elements = nreads;
return TableWriterSeq_WriteAlignmentData(self->tbl, rowId, &data[0], &data[1]);
}
void SequenceWhack(Sequence *self, bool commit) {
uint64_t dummyRows;
if (self->tbl == NULL)
return;
(void)TableWriterSeq_Whack(self->tbl, commit, &dummyRows);
if (G.mode == mode_Remap) {
/* This only happens for the second and subsequent loads.
* Cleaning up the first load is handled by the bam-load itself
* when everything is done.
*/
VTable *tbl = NULL;
rc_t rc = VDatabaseOpenTableUpdate(self->db, &tbl, "SEQUENCE");
assert(rc == 0);
VTableDropColumn(tbl, "TMP_KEY_ID");
VTableDropColumn(tbl, "READ");
VTableRelease(tbl);
}
VDatabaseRelease(self->db);
}
|