165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/*
265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Copyright (C) 2011 The Android Open Source Project
365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn *
465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Licensed under the Apache License, Version 2.0 (the "License");
565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * you may not use this file except in compliance with the License.
665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * You may obtain a copy of the License at
765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn *
865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn *      http://www.apache.org/licenses/LICENSE-2.0
965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn *
1065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Unless required by applicable law or agreed to in writing, software
1165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * distributed under the License is distributed on an "AS IS" BASIS,
1265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * See the License for the specific language governing permissions and
1465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * limitations under the License.
1565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */
1665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
1765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
1865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpackage android.filterfw.core;
1965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
2065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/**
2165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @hide
2265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */
2365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpublic class StreamPort extends InputPort {
2465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
2565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    private Frame mFrame;
2665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    private boolean mPersistent;
2765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
2865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public StreamPort(Filter filter, String name) {
2965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        super(filter, name);
3065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
3165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
3265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
3365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public void clear() {
3465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        if (mFrame != null) {
3565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            mFrame.release();
3665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            mFrame = null;
3765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        }
3865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
3965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
4065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
4165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public void setFrame(Frame frame) {
4265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        assignFrame(frame, true);
4365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
4465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
4565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
4665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public void pushFrame(Frame frame) {
4765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        assignFrame(frame, false);
4865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
4965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
5065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    protected synchronized void assignFrame(Frame frame, boolean persistent) {
5165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        assertPortIsOpen();
5265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        checkFrameType(frame, persistent);
5365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
5465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        if (persistent) {
5565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            if (mFrame != null) {
5665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn                mFrame.release();
5765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            }
5865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        } else if (mFrame != null) {
5965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            throw new RuntimeException(
6065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn                "Attempting to push more than one frame on port: " + this + "!");
6165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        }
6265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        mFrame = frame.retain();
6365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        mFrame.markReadOnly();
6465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        mPersistent = persistent;
6565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
6665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
6765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
6865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public synchronized Frame pullFrame() {
6965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        // Make sure we have a frame
7065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        if (mFrame == null) {
7165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            throw new RuntimeException("No frame available to pull on port: " + this + "!");
7265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        }
7365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
7465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        // Return a retained result
7565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        Frame result = mFrame;
7665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        if (mPersistent) {
7765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            mFrame.retain();
7865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        } else {
7965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            mFrame = null;
8065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        }
8165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        return result;
8265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
8365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
8465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
8565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public synchronized boolean hasFrame() {
8665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        return mFrame != null;
8765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
8865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
8965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
9065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public String toString() {
9165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        return "input " + super.toString();
9265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
9365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn
9465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    @Override
9565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    public synchronized void transfer(FilterContext context) {
9665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        if (mFrame != null) {
9765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn            checkFrameManager(mFrame, context);
9865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn        }
9965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn    }
10065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn}
101