Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(264)

Side by Side Diff: media/mojo/interfaces/remoting_common.mojom

Issue 2951523002: Media Remoting: Add mojo interfaces between browser and extension. (Closed)
Patch Set: Rebased. Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright 2016 The Chromium Authors. All rights reserved. 1 // Copyright 2017 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 module media.mojom; 5 module media.mojom;
6 6
7 interface RemoterFactory {
8 // Create a new Remoter associated with the given RemotingSource and bind it
9 // to the given interface request. The RemotingSource will be notified when
10 // the Remoter becomes available for use (or becomes unavailable).
11 Create(RemotingSource source, Remoter& remoter);
12 };
13
14 // Interface used by the source to control when media bitstream data is read
15 // from a data pipe and then sent to the remote endpoint. There is one
16 // RemotingDataStreamSender per data pipe.
17 interface RemotingDataStreamSender {
18 // Consumes |size| bytes of data from the data pipe, which is a chunk of the
19 // next frame's data payload starting at the given byte |offset|.
20 // |total_payload_size| indicates the size of the entire data payload for the
21 // frame. Before this is called, |size| bytes of data must have been written
22 // into the data pipe.
23 //
24 // Normally, a frame's entire data payload can be pushed through the data pipe
25 // in one chunk. However, there can be situations where the size of the
26 // payload exceeds the capacity of the data pipe; and so this API supports
27 // feeding the frame data through the pipe in multiple chunks.
28 ConsumeDataChunk(uint32 offset, uint32 size, uint32 total_payload_size);
29
30 // Enqueues another frame for transmission to the remote endpoint. Before this
31 // is called, ConsumeDataChunk() must have been called one or more times to
32 // provide all of the frame's data.
33 SendFrame();
34
35 // Cancel the transmission of all in-flight data to the remote, up to and
36 // including the last SendFrame() call; and also discard any data chunks
37 // that were consumed from the data pipe for the next frame. This is used to
38 // optimize seeking, when it is known that any in-flight data is no longer
39 // needed by the remote. There is no guarantee as to how much of the in-flight
40 // data will actually reach the remote before the cancellation takes effect.
41 CancelInFlightData();
42 };
43
44 enum RemotingStopReason { 7 enum RemotingStopReason {
45 ROUTE_TERMINATED, // User-initiated disconnect, etc. 8 ROUTE_TERMINATED, // User-initiated disconnect, etc.
46 LOCAL_PLAYBACK, // Media switched back to local playback. 9 LOCAL_PLAYBACK, // Media switched back to local playback.
47 SOURCE_GONE, // RemotingSource has been destroyed. 10 SOURCE_GONE, // RemotingSource has been destroyed.
48 MESSAGE_SEND_FAILED, // Failed to send a message to the sink. 11 MESSAGE_SEND_FAILED, // Failed to send a message to the sink.
49 DATA_SEND_FAILED, // Failed to consume from a data pipe or send to the sink. 12 DATA_SEND_FAILED, // Failed to consume from a data pipe or send to the sink.
50 UNEXPECTED_FAILURE, // Unexpected failure or inconsistent state encountered. 13 UNEXPECTED_FAILURE, // Unexpected failure or inconsistent state encountered.
51 }; 14 SERVICE_GONE, // Mirror service disconnected.
52
53 // Interface used by the source to start/stop remoting and send data to the
54 // sink.
55 interface Remoter {
56 // Start a remoting session (once the sink has been reported to be available;
57 // see RemotingSource). Either RemotingSource.OnStarted() or OnStartFailed()
58 // will be called to indicate success or failure. Once OnStarted() has been
59 // invoked, the source may then make calls to SendMessageToSink() and expect
60 // messages from the remote via RemotingSource.OnMessageFromSink().
61 Start();
62
63 // Start remoting the media data streams. This is called after Start() to
64 // provide data pipes from which the audio/video bitstream data is consumed
65 // and then transported to the remote device. RemotingDataStreamSenders are
66 // used by the source to control when data should be consumed from the data
67 // pipes and sent. One or both pipes (and their corresponding
68 // RemotingDataStreamSender interface requests) must be provided.
69 StartDataStreams(handle<data_pipe_consumer>? audio_pipe,
70 handle<data_pipe_consumer>? video_pipe,
71 RemotingDataStreamSender&? audio_sender,
72 RemotingDataStreamSender&? video_sender);
73
74 // Stop remoting media. Messages in both directions will be dropped after this
75 // point as well as any pending or in-transit media bitstream data.
76 Stop(RemotingStopReason reason);
77
78 // Send |message| to the sink. |message| is a serialized protobuf from
79 // src/media/remoting/proto.
80 SendMessageToSink(array<uint8> message);
81 };
82
83 enum RemotingSinkCapabilities {
84 NONE,
85 RENDERING_ONLY,
86 CONTENT_DECRYPTION_AND_RENDERING,
87 }; 15 };
88 16
89 enum RemotingStartFailReason { 17 enum RemotingStartFailReason {
90 CANNOT_START_MULTIPLE, // Remoting was already active. 18 CANNOT_START_MULTIPLE, // Remoting was already active.
91 ROUTE_TERMINATED, // User-initated disconnect while starting remoting. 19 ROUTE_TERMINATED, // User-initated disconnect while starting remoting.
20 SERVICE_NOT_CONNECTED, // Mirror service was not connected.
92 }; 21 };
93 22
94 // Interface used for sending notifications back to the local source's control 23 enum RemotingSinkFeatures {
95 // logic, and to pass messages from the sink back to the local media pipeline. 24 RENDERING,
96 interface RemotingSource { 25 CONTENT_DECRYPTION,
97 // Notify the source that the sink is now available to start remoting. It is 26 };
98 // up to the source's control logic to decide whether/when to start remoting.
99 //
100 // TODO(miu): In a later change, pass detailed information about the sink's
101 // capabilities (e.g., codec support, DRM keysystem support, etc.).
102 OnSinkAvailable(RemotingSinkCapabilities capabilities);
103 27
104 // Notify the source that the sink is no longer available for remoting. This 28 enum RemotingSinkAudioCapabilities {
105 // may happen, for example, because the sink has been shut down, or because 29 CODEC_BASELINE_SET,
106 // another source has started remoting. 30 CODEC_AAC,
107 OnSinkGone(); 31 CODEC_OPUS,
32 };
108 33
109 // One of these is called after the source attempts to start remoting. If 34 enum RemotingSinkVideoCapabilities {
110 // OnStarted() is called, messages may begin flowing; and this will continue 35 SUPPORT_4K,
111 // until OnStopped() is called. On the other hand, if OnStartFailed() is 36 CODEC_BASELINE_SET,
112 // called, then no messages are being passed between source and sink and 37 CODEC_H264,
113 // remoting is not taking place. 38 CODEC_VP8,
114 OnStarted(); 39 CODEC_VP9,
115 OnStartFailed(RemotingStartFailReason reason); 40 CODEC_HEVC,
41 };
116 42
117 // Pass a |message| from the sink back to the source. The |message| consists 43 struct SinkCapabilities {
118 // of a serialized protobuf from src/media/remoting/proto. This will only be 44 array<RemotingSinkFeatures> features;
119 // called after OnStarted() and before OnStopped(). 45 array<RemotingSinkAudioCapabilities> audio;
120 OnMessageFromSink(array<uint8> message); 46 array<RemotingSinkVideoCapabilities> video;
121
122 // Notify the source that remoting has terminated. This may or may not be in
123 // response to a Remoter.Stop() call, as other events (possibly external) may
124 // have caused remoting to end.
125 OnStopped(RemotingStopReason reason);
126 }; 47 };
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698