1 /*
2  * Copyright (C) 2014 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 package com.android.camera.one.v2.sharedimagereader.imagedistributor;
18 
19 import com.android.camera.async.BufferQueue;
20 import com.android.camera.async.BufferQueueController;
21 import com.android.camera.one.v2.camera2proxy.ImageProxy;
22 
23 import javax.annotation.ParametersAreNonnullByDefault;
24 
25 @ParametersAreNonnullByDefault
26 public interface ImageDistributor {
27     /**
28      * Begins routing new images with timestamps matching those found in
29      * inputTimestampQueue to outputStream.
30      * <p>
31      * The route is removed when either inputTimestampQueue is closed, or
32      * outputStream is closed.
33      * <p>
34      * If multiple routes request the same image, they will both receive a
35      * reference-counted "copy".
36      *
37      * @param inputTimestampQueue A queue containing timestamps of all images to
38      *            be routed to outputStream.
39      * @param outputStream The output queue in which to add images.
40      */
addRoute(BufferQueue<Long> inputTimestampQueue, BufferQueueController<ImageProxy> outputStream)41     void addRoute(BufferQueue<Long> inputTimestampQueue,
42             BufferQueueController<ImageProxy> outputStream);
43 }
44