summaryrefslogtreecommitdiffstats
path: root/src/java/com/jogamp/common/nio/ByteBufferInputStream.java
blob: b74360fc08335b9b0600dfca1cf7051b65980e4d (plain)
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
/**
 * Copyright 2014 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */
package com.jogamp.common.nio;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.MappedByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.channels.FileChannel.MapMode;

/**
 * An {@link InputStream} implementation based on an underlying {@link ByteBuffer}
 * supporting {@link #markSupported() mark}.
 * <p>
 * May be utilized as well with a {@link MappedByteBuffer memory-mapped} {@link FileChannel#map(MapMode, long, long) FileChannel}
 * using a size &le; {@link Integer#MAX_VALUE}.<br>
 * This becomes efficient with files &ge; 10 MiB, depending on the platform
 * and whether the traditional method uses a {@link BufferedInputStream} supporting {@code mark} incl. it's buffer size.<br>
 * See test case {@code com.jogamp.common.nio.TestByteBufferInputStream}.
 * </p>
 * @since 2.3.0
 */
public class ByteBufferInputStream extends InputStream {
    private final ByteBuffer buf;
    private int mark;

    /**
     * Creates a new byte-buffer input stream.
     *
     * @param buf the underlying byte buffer.
     */
    public ByteBufferInputStream(final ByteBuffer buf) {
        this.buf = buf;
        this.mark = -1;
    }

    @Override
    public final int available() {
        return buf.remaining();
    }

    /**
     * <i>This implementation supports {@code mark}.</i>
     * <p>
     * {@inheritDoc}
     * </p>
     */
    @Override
    public final boolean markSupported() {
        return true;
    }

    /**
     * <i>This implementation supports {@code mark}.</i>
     * <p>
     * {@inheritDoc}
     * </p>
     * @see #markSupported()
     */
    @Override
    public final synchronized void mark(final int unused) {
        mark = buf.position();
    }

    /**
     * <i>This implementation supports {@code mark}.</i>
     * <p>
     * {@inheritDoc}
     * </p>
     * @see #markSupported()
     */
    @Override
    public final synchronized void reset() throws IOException {
        if ( mark == -1 ) {
            throw new IOException();
        }
        buf.position(mark);
    }

    @Override
    public final long skip(final long n) throws IOException {
        if( 0 > n ) {
            return 0;
        }
        final int s = (int) Math.min( buf.remaining(), n );
        buf.position(buf.position() + s);
        return s;
    }

    @Override
    public final int read() {
        if ( ! buf.hasRemaining() ) {
            return -1;
        }
        return buf.get() & 0xFF;
    }

    @Override
    public final int read(final byte[] b, final int off, final int len) {
        if (b == null) {
            throw new NullPointerException();
        } else if( off < 0 ||
                   len < 0 ||
                   off > b.length ||
                   off + len > b.length ||
                   off + len < 0
                 ) {
            throw new IndexOutOfBoundsException("offset "+off+", length "+len+", b.length "+b.length);
        } else if ( 0 == len ) {
            return 0;
        }
        final int totalRem = buf.remaining();
        if ( 0 == totalRem ) {
            return -1;
        }
        final int maxLen = Math.min(totalRem, len);
        if( buf.hasArray() ) {
            System.arraycopy(buf.array(), buf.arrayOffset() + buf.position(), b, off, maxLen);
            buf.position( buf.position() + maxLen );
        } else {
            buf.get(b, off, maxLen);
        }
        return maxLen;
    }

    // @Override
    public final int read(final ByteBuffer b, final int len) {
        if (b == null) {
            throw new NullPointerException();
        } else if (len < 0 || len > b.remaining()) {
            throw new IndexOutOfBoundsException("length "+len+", b "+b);
        } else if ( 0 == len ) {
            return 0;
        }
        final int remaining = buf.remaining();
        if ( 0 == remaining ) {
            return -1;
        }
        final int maxLen = Math.min(remaining, len);
        if( buf.hasArray() && b.hasArray() ) {
            System.arraycopy(buf.array(), buf.arrayOffset() + buf.position(), b.array(), b.arrayOffset() + b.position(), maxLen);
            buf.position( buf.position() + maxLen );
            b.position( b.position() + maxLen );
        } else if( maxLen == remaining ) {
            b.put(buf);
        } else {
            final int _limit = buf.limit();
            buf.limit(maxLen);
            try {
                b.put(buf);
            } finally {
                buf.limit(_limit);
            }
        }
        return maxLen;
    }

    public final ByteBuffer getBuffer() { return buf; }
}