Media Remoting: UMAs to track session events and measurements.

media/remoting/proto/remoting_rpc_message.proto

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 // Protocol buffer for Media Remoting.
 
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
 
@@ skipping 14 matching lines @@
   optional bool is_eos = 9;
 }
 
 // Utility proto data structure
 message Size {
   optional int32 width = 1;
   optional int32 height = 2;
 }
 
 message EncryptionScheme {
-  // Align with EncryptionScheme::CipherMode
+  // Proto version of EncryptionScheme::CipherMode.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum CipherMode {
     CIPHER_MODE_UNENCRYPTED = 0;
     CIPHER_MODE_AES_CTR = 1;
     CIPHER_MODE_AES_CBC = 2;
   }
 
   optional CipherMode mode = 1;
   optional uint32 encrypt_blocks = 2;
   optional uint32 skip_blocks = 3;
 }
 
 message AudioDecoderConfig {
-  // Should align with ::media::Codec
+  // Proto version of media::Codec.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum Codec {
     kUnknownAudioCodec = 0;
     kCodecAAC = 1;
     kCodecMP3 = 2;
     kCodecPCM = 3;
     kCodecVorbis = 4;
     kCodecFLAC = 5;
     kCodecAMR_NB = 6;
     kCodecAMR_WB = 7;
     kCodecPCM_MULAW = 8;
     kCodecGSM_MS = 9;
     kCodecPCM_S16BE = 10;
     kCodecPCM_S24BE = 11;
     kCodecOpus = 12;
     kCodecEAC3 = 13;
     kCodecPCM_ALAW = 14;
     kCodecALAC = 15;
     kCodecAC3 = 16;
   }
 
-  // Should align with ::media::SampleFormat
+  // Proto version of media::SampleFormat.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum SampleFormat {
     kUnknownSampleFormat = 0;
     kSampleFormatU8 = 1;
     kSampleFormatS16 = 2;
     kSampleFormatS32 = 3;
     kSampleFormatF32 = 4;
     kSampleFormatPlanarS16 = 5;
     kSampleFormatPlanarF32 = 6;
     kSampleFormatPlanarS32 = 7;
     kSampleFormatS24 = 8;
     kSampleFormatAc3 = 9;
     kSampleFormatEac3 = 10;
   };
 
-  // Should align with ::media::ChannelLayout
+  // Proto version of media::ChannelLayout.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum ChannelLayout {
     CHANNEL_LAYOUT_NONE = 0;
     CHANNEL_LAYOUT_UNSUPPORTED = 1;
     CHANNEL_LAYOUT_MONO = 2;
     CHANNEL_LAYOUT_STEREO = 3;
     CHANNEL_LAYOUT_2_1 = 4;
     CHANNEL_LAYOUT_SURROUND = 5;
     CHANNEL_LAYOUT_4_0 = 6;
     CHANNEL_LAYOUT_2_2 = 7;
     CHANNEL_LAYOUT_QUAD = 8;
@@ skipping 33 matching lines @@
 }
 
 message Rect {
   optional int32 x = 1;
   optional int32 y = 2;
   optional int32 width = 3;
   optional int32 height = 4;
 }
 
 message VideoDecoderConfig {
-  // Should align with ::media::VideoCodec
+  // Proto version of media::VideoCodec.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum Codec {
     kUnknownVideoCodec = 0;
     kCodecH264 = 1;
     kCodecVC1 = 2;
     kCodecMPEG2 = 3;
     kCodecMPEG4 = 4;
     kCodecTheora = 5;
     kCodecVP8 = 6;
     kCodecVP9 = 7;
     kCodecHEVC = 8;
   }
 
-  // Should align with ::media::VideoCodecProfile
+  // Proto version of media::VideoCodecProfile.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum Profile {
     VIDEO_CODEC_PROFILE_UNKNOWN = -1;
     H264PROFILE_BASELINE = 0;
     H264PROFILE_MAIN = 1;
     H264PROFILE_EXTENDED = 2;
     H264PROFILE_HIGH = 3;
     H264PROFILE_HIGH10PROFILE = 4;
     H264PROFILE_HIGH422PROFILE = 5;
     H264PROFILE_HIGH444PREDICTIVEPROFILE = 6;
     H264PROFILE_SCALABLEBASELINE = 7;
     H264PROFILE_SCALABLEHIGH = 8;
     H264PROFILE_STEREOHIGH = 9;
     H264PROFILE_MULTIVIEWHIGH = 10;
     VP8PROFILE_ANY = 11;
     VP9PROFILE_PROFILE0 = 12;
     VP9PROFILE_PROFILE1 = 13;
     VP9PROFILE_PROFILE2 = 14;
     VP9PROFILE_PROFILE3 = 15;
     HEVCPROFILE_MAIN = 16;
     HEVCPROFILE_MAIN10 = 17;
     HEVCPROFILE_MAIN_STILL_PICTURE = 18;
   };
 
-  // Should align with ::media::VideoPixelFormat
+  // Proto version of media::VideoPixelFormat.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum Format {
     PIXEL_FORMAT_UNKNOWN = 0;
     PIXEL_FORMAT_I420 = 1;
     PIXEL_FORMAT_YV12 = 2;
     PIXEL_FORMAT_YV16 = 3;
     PIXEL_FORMAT_YV12A = 4;
     PIXEL_FORMAT_YV24 = 5;
     PIXEL_FORMAT_NV12 = 6;
     PIXEL_FORMAT_NV21 = 7;
     PIXEL_FORMAT_UYVY = 8;
@@ skipping 11 matching lines @@
     PIXEL_FORMAT_YUV444P9 = 20;
     PIXEL_FORMAT_YUV444P10 = 21;
     PIXEL_FORMAT_YUV420P12 = 22;
     PIXEL_FORMAT_YUV422P12 = 23;
     PIXEL_FORMAT_YUV444P12 = 24;
     PIXEL_FORMAT_Y8 = 25;
     PIXEL_FORMAT_Y16 = 26;
     PIXEL_FORMAT_I422 = 27;
   };
 
-  // Should align with ::media::ColorSpace
+  // Proto version of media::ColorSpace.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum ColorSpace {
     COLOR_SPACE_UNSPECIFIED = 0;
     COLOR_SPACE_JPEG = 1;
     COLOR_SPACE_HD_REC709 = 2;
     COLOR_SPACE_SD_REC601 = 3;
   };
 
   optional Codec codec = 1;
   optional EncryptionScheme encryption_scheme = 2;
   optional Profile profile = 3;
@@ skipping 19 matching lines @@
 message PipelineStatistics {
   optional uint64 audio_bytes_decoded = 1;
   optional uint64 video_bytes_decoded = 2;
   optional uint32 video_frames_decoded = 3;
   optional uint32 video_frames_dropped = 4;
   optional int64 audio_memory_usage = 5;
   optional int64 video_memory_usage = 6;
 };
 
 message CdmKeyInformation {
-  // Align with ::media::CdmKeyInformation::KeyStatus
+  // Proto version of media::CdmKeyInformation::KeyStatus.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum KeyStatus {
     USABLE = 0;
     INTERNAL_ERROR = 1;
     EXPIRED = 2;
     OUTPUT_RESTRICTED = 3;
     OUTPUT_DOWNSCALED = 4;
     KEY_STATUS_PENDING = 5;
     RELEASED = 6;
   }
 
   optional bytes key_id = 1;
   optional KeyStatus status = 2;
   optional uint32 system_code = 3;
 }
 
-// Should align with ::media::CdmPromise::Exception
+// Proto version of media::CdmPromise::Exception.
+// NEVER change these numbers or re-use old ones; only add new ones.
 enum CdmException {
   NOT_SUPPORTED_ERROR = 0;
   INVALID_STATE_ERROR = 1;
   INVALID_ACCESS_ERROR = 2;
   QUOTA_EXCEEDED_ERROR = 3;
   UNKNOWN_ERROR = 4;
   CLIENT_ERROR = 5;
   OUTPUT_ERROR = 6;
 }
 
-// Should align with ::media::ContentDecryptionModule::MessageType
+// Proto version of media::ContentDecryptionModule::MessageType.
+// NEVER change these numbers or re-use old ones; only add new ones.
 enum CdmMessageType {
   LICENSE_REQUEST = 0;
   LICENSE_RENEWAL = 1;
   LICENSE_RELEASE = 2;
 }
 
-// Should align with ::media::CdmSessionType
+// Proto version of media::CdmSessionType.
+// NEVER change these numbers or re-use old ones; only add new ones.
 enum CdmSessionType {
   TEMPORARY_SESSION = 0;
   PERSISTENT_LICENSE_SESSION = 1;
   PERSISTENT_RELEASE_MESSAGE_SESSION = 2;
 };
 
 message RendererInitialize {
   optional int32 client_handle = 1;
   optional int32 audio_demuxer_handle = 2;
   optional int32 video_demuxer_handle = 3;
@@ skipping 10 matching lines @@
   optional int32 cdm_id = 1;
   optional int32 callback_handle = 2;
 }
 
 message RendererClientOnTimeUpdate {
   optional int64 time_usec = 1;
   optional int64 max_time_usec = 2;
 }
 
 message RendererClientOnBufferingStateChange {
-  // Should align with ::media::BufferingState
+  // Proto version of media::BufferingState.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum State {
     BUFFERING_HAVE_NOTHING = 0;
     BUFFERING_HAVE_ENOUGH = 1;
   };
 
   optional State state = 1;
 }
 
 message DemuxerStreamReadUntil {
   optional int32 callback_handle = 1;
   optional uint32 count = 2;
 }
 
 message DemuxerStreamInitializeCallback {
   optional int32 type = 1;
   optional AudioDecoderConfig audio_decoder_config = 2;
   optional VideoDecoderConfig video_decoder_config = 3;
 }
 
 message DemuxerStreamReadUntilCallback {
-  // Should align with ::media::DemuxerStream::Status
+  // Proto version of media::DemuxerStream::Status.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum Status {
     kOk = 0;
     kAborted = 1;
     kConfigChanged = 2;
   };
 
   optional Status status = 1;
   optional uint32 count = 2;
   optional AudioDecoderConfig audio_decoder_config = 3;
   optional VideoDecoderConfig video_decoder_config = 4;
 }
 
 message CdmInitialize {
   optional string key_system = 1;
   optional string security_origin = 2;
   optional bool allow_distinctive_identifier = 3;
   optional bool allow_persistent_state = 4;
   optional bool use_hw_secure_codecs = 5;
   optional int32 callback_handle = 6;
 }
 
 message CdmSetServerCertificate {
   optional int32 callback_handle = 1;
   optional bytes certificate_data = 2;
 }
 
 message CdmCreateSessionAndGenerateRequest {
+  // Proto version of media::EmeInitDataType.
+  // NEVER change these numbers or re-use old ones; only add new ones.
   enum EmeInitDataType {
     UNKNOWN = 0;
     WEBM = 1;
     CENC = 2;
     KEYIDS = 3;
   };
 
   optional CdmSessionType session_type = 1;
   optional EmeInitDataType init_data_type = 2;
   optional int32 callback_handle = 3;
@@ skipping 202 matching lines @@
 
     // RPC_CDMC_ONSESSIONMESSAGE
     CdmClientOnSessionMessage cdmclient_onsessionmessage_rpc = 601;
     // RPC_CDMC_ONSESSIONKEYSCHANGE
     CdmClientOnSessionKeysChange cdmclient_onsessionkeychange_rpc = 602;
     // RPC_CDMC_ONSESSIONEXPIRATIONUPDATE
     CdmClientOnSessionExpirationUpdate cdmclient_onsessionexpirationupdate_rpc =
         603;
   };
 }