summaryrefslogtreecommitdiff
path: root/base/src/main/java/com/smartdevicelink/proxy/interfaces/IVideoStreamListener.java
blob: f645b0d55f7614fd764db5da0034ac93c6a54a4d (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
/*
 * Copyright (c) 2017, Xevo Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the copyright holder nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER 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.
 */

package com.smartdevicelink.proxy.interfaces;

import java.nio.ByteBuffer;

/**
 * A listener that receives video streaming data from app.
 */
public interface IVideoStreamListener {

	/**
	 * Sends a chunk of data which represents a frame to SDL Core.
	 * <p>
	 * The format of the chunk should align with MediaCodec's "Compressed Buffer" format, i.e. it
	 * should contain a single video frame, and it should start and end on frame boundaries.
	 * Please refer to https://developer.android.com/reference/android/media/MediaCodec.html
	 * Also, for H.264 codec case the stream must be in byte-stream format (also known as Annex-B
	 * format). This isn't explained in the document above, but MediaCodec does output in this
	 * format.
	 * <p>
	 * In short, you can just provide MediaCodec's data outputs to this method without tweaking
	 * any data.
	 * <p>
	 * Note: this method must not be called after SdlProxyBase.endVideoStream() is called.
	 *
	 * @param data               Byte array containing a video frame
	 * @param offset             Starting offset in 'data'
	 * @param length             Length of the data
	 * @param presentationTimeUs Presentation timestamp (PTS) of this frame, in microseconds.
	 *                           It must be greater than the previous timestamp.
	 *                           Specify -1 if unknown.
	 * @throws ArrayIndexOutOfBoundsException When offset does not satisfy
	 *                                        {@code 0 <= offset && offset <= data.length}
	 *                                        or length does not satisfy
	 *                                        {@code 0 < length && offset + length <= data.length}
	 */
	void sendFrame(byte[] data, int offset, int length, long presentationTimeUs)
			throws ArrayIndexOutOfBoundsException;

	/**
	 * Sends chunks of data which represent a frame to SDL Core.
	 * <p>
	 * The format of the chunk should align with MediaCodec's "Compressed Buffer" format, i.e. it
	 * should contain a single video frame, and it should start and end on frame boundaries.
	 * Please refer to https://developer.android.com/reference/android/media/MediaCodec.html
	 * Also, for H.264 codec case the stream must be in byte-stream format (also known as Annex-B
	 * format). This isn't explained in the document above, but MediaCodec does output in this
	 * format.
	 * <p>
	 * In short, you can just provide MediaCodec's data outputs to this method without tweaking
	 * any data.
	 * <p>
	 * Note: this method must not be called after SdlProxyBase.endVideoStream() is called.
	 *
	 * @param data               Data chunk to send. Its position will be updated upon return.
	 * @param presentationTimeUs Presentation timestamp (PTS) of this frame, in microseconds.
	 *                           It must be greater than the previous timestamp.
	 *                           Specify -1 if unknown.
	 */
	void sendFrame(ByteBuffer data, long presentationTimeUs);
}