Class: LZ4::Decoder

Inherits:
Object
  • Object
show all
Defined in:
ext/frameapi.c

Instance Method Summary collapse

Constructor Details

#initialize(inport) ⇒ self

inport

An I/O (liked) object for data read from LZ4 Frame.

This object need .read method.



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
 
# File 'ext/frameapi.c', line 442

static VALUE
fdec_init(int argc, VALUE argv[], VALUE dec)
{
    struct decoder *p = getdecoder(dec);
    VALUE inport;
    //VALUE readblocksize;
    rb_scan_args(argc, argv, "1", &inport);
    LZ4F_errorCode_t err = LZ4F_createDecompressionContext(&p->decoder, LZ4F_VERSION);
    aux_lz4f_check_error(err);
    p->inport = inport;
    p->readbuf = rb_str_buf_new(0);
    char *readp;
    size_t readsize;
    size_t zero = 0;
    size_t s = 4; /* magic number size of lz4 frame */
    int i;
    for (i = 0; i < 2; i ++) {
        /*
         * first step: check magic number
         * second step: check frame information
         */
        aux_read(inport, s, p->readbuf);
        aux_str_getmem(p->readbuf, &readp, &readsize);
        if (!readp || readsize < s) {
            rb_raise(extlz4_eError,
                     "unexpected EOF (read error) - #<%s:%p>",
                     rb_obj_classname(inport), (const void *)inport);
        }
        s = LZ4F_decompress(p->decoder, NULL, &zero, readp, &readsize, NULL);
        aux_lz4f_check_error(s);
    }
    p->status = s;
    s = LZ4F_getFrameInfo(p->decoder, &p->info, NULL, &zero);
    aux_lz4f_check_error(s);
    p->outbuf = rb_str_tmp_new(1 << (8 + p->info.blockSizeID * 2));
    rb_str_set_len(p->outbuf, 0);

    return dec;
}

Instance Method Details

#close ⇒ Object Also known as: finish 



663
664
665
666
667
668
669
670
 
# File 'ext/frameapi.c', line 663

static VALUE
fdec_close(VALUE dec)
{
    struct decoder *p = getdecoder(dec);
    p->status = 0;
    // TODO: destroy decoder
    return dec;
}

#eof ⇒ Object Also known as: eof? 



672
673
674
675
676
677
678
679
680
681
 
# File 'ext/frameapi.c', line 672

static VALUE
fdec_eof(VALUE dec)
{
    struct decoder *p = getdecoder(dec);
    if (p->status == 0) {
        return Qtrue;
    } else {
        return Qfalse;
    }
}

#getbyte ⇒ Integer | nil

Read one byte code integer.

Returns:

  • (Integer | nil) 


649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'ext/frameapi.c', line 649

static VALUE
fdec_getbyte(VALUE dec)
{
    struct decoder *p = getdecoder(dec);

    char ch;
    size_t s = fdec_read_decode(dec, p, &ch, 1);
    if (s > 0) {
        return INT2FIX(ch);
    } else {
        return Qnil;
    }
}

#getc ⇒ String | nil

Read one byte character.

Returns:

  • (String | nil) 


624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'ext/frameapi.c', line 624

static VALUE
fdec_getc(VALUE dec)
{
    struct decoder *p = getdecoder(dec);

    if (p->status == 0) {
        return Qnil;
    }

    char ch;
    size_t s = fdec_read_decode(dec, p, &ch, 1);
    if (s > 0) {
        VALUE v = rb_str_new(&ch, 1);
        return v;
    } else {
        return Qnil;
    }
}

#inport ⇒ Object 



683
684
685
686
687
 
# File 'ext/frameapi.c', line 683

static VALUE
fdec_inport(VALUE dec)
{
    return getdecoder(dec)->inport;
}

#inspect ⇒ Object 



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'ext/frameapi.c', line 713

static VALUE
fdec_inspect(VALUE dec)
{
    struct decoder *p = getdecoderp(dec);
    if (p) {
        return rb_sprintf("#<%s:%p inport=#<%s:%p>, blocksize=%d, blocklink=%s, checksum=%s>",
                rb_obj_classname(dec), (void *)dec,
                rb_obj_classname(p->inport), (void *)p->inport,
                fdec_blocksize(p),
                aux_frame_blocklink(&p->info) ? "true" : "false",
                aux_frame_checksum(&p->info) ? "true" : "false");
    } else {
        return rb_sprintf("#<%s:%p **INVALID REFERENCE**>",
                rb_obj_classname(dec), (void *)dec);
    }
}

#prefs_blocklink ⇒ Object 



701
702
703
704
705
 
# File 'ext/frameapi.c', line 701

static VALUE
fdec_prefs_blocklink(VALUE dec)
{
    return aux_frame_blocklink(&getdecoder(dec)->info) ? Qtrue : Qfalse;
}

#prefs_blocksize ⇒ Object 



695
696
697
698
699
 
# File 'ext/frameapi.c', line 695

static VALUE
fdec_prefs_blocksize(VALUE dec)
{
    return INT2NUM(fdec_blocksize(getdecoder(dec)));
}

#prefs_checksum ⇒ Object 



707
708
709
710
711
 
# File 'ext/frameapi.c', line 707

static VALUE
fdec_prefs_checksum(VALUE dec)
{
    return aux_frame_checksum(&getdecoder(dec)->info) ? Qtrue : Qfalse;
}

#read ⇒ String #read(size) ⇒ String #read(size, buffer) ⇒ Object

Overloads:

  • #read ⇒ String

    Returns:

    • (String)
  • #read(size) ⇒ String

    Returns:

    • (String) 


578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'ext/frameapi.c', line 578

static VALUE
fdec_read(int argc, VALUE argv[], VALUE dec)
{
    struct decoder *p = getdecoder(dec);
    size_t size;
    VALUE dest;
    fdec_read_args(argc, argv, &size, &dest);
    if (size == 0) {
        return dest;
    }

    if (p->status == 0) {
        return Qnil;
    }

    if ((ssize_t)size > 0) {
        char *destp = RSTRING_PTR(dest);
        size_t destsize = size;
        destsize = fdec_read_decode(dec, p, destp, destsize);
        rb_str_set_len(dest, destsize);
    } else {
        const size_t tmpsize = 4 * 1024 * 1024;
        VALUE tmpbuf = rb_str_tmp_new(tmpsize);
        char *tmp = RSTRING_PTR(tmpbuf);
        size_t s;
        rb_str_set_len(dest, 0);
        while ((s = fdec_read_decode(dec, p, tmp, tmpsize)) > 0) {
            rb_str_buf_cat(dest, tmp, s);
        }
        rb_str_resize(tmpbuf, 0);
    }


    if (RSTRING_LEN(dest) > 0) {
        return dest;
    } else {
        return Qnil;
    }
}