1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17
18package android.filterpacks.base;
19
20import android.filterfw.core.Filter;
21import android.filterfw.core.FilterContext;
22import android.filterfw.core.Frame;
23import android.filterfw.core.FrameFormat;
24import android.filterfw.core.GenerateFieldPort;
25import android.filterfw.core.GenerateFinalPort;
26
27/**
28 * @hide
29 */
30public class FrameSource extends Filter {
31
32    @GenerateFinalPort(name = "format")
33    private FrameFormat mFormat;
34
35    @GenerateFieldPort(name = "frame", hasDefault = true)
36    private Frame mFrame = null;
37
38    @GenerateFieldPort(name = "repeatFrame", hasDefault = true)
39    private boolean mRepeatFrame = false;
40
41    public FrameSource(String name) {
42        super(name);
43    }
44
45    @Override
46    public void setupPorts() {
47        addOutputPort("frame", mFormat);
48    }
49
50    @Override
51    public void process(FilterContext context) {
52        if (mFrame != null) {
53            // Push output
54            pushOutput("frame", mFrame);
55        }
56
57        if (!mRepeatFrame) {
58            // Close output port as we are done here
59            closeOutputPort("frame");
60        }
61    }
62
63}
64