package net

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc RegisterAIWorker (RegisterAIWorkerRequest, stream NotifyAIJob)

  lp_rpc.proto:20

  Called by the aiworker to register to an orchestrator. The orchestrator notifies registered aiworkers of jobs as they come in.

  message RegisterAIWorkerRequest

  lp_rpc.proto:408

  Sent by the aiworker to register itself to the orchestrator.

  • string secret = 1

    Shared secret for auth

  • optional Capabilities capabilities = 2

    AIWorker capabilities

  • repeated HardwareInformation hardware = 3

    AIWorker hardware info

  message NotifyAIJob

  lp_rpc.proto:430

  Sent by the orchestrator to the aiworker

  • optional AIJobData AIJobData = 1

    Configuration for the AI job

  • int64 taskId = 2

    ID for this particular AI task.

RPC calls implemented by the orchestrator

• rpc GetOrchestrator (OrchestratorRequest, OrchestratorInfo)

  lp_rpc.proto:10

  Called by the broadcaster to request transcoder info from an orchestrator.

  message OrchestratorRequest

  lp_rpc.proto:46

  This request is sent by the broadcaster in `GetTranscoder` to request information on which transcoder to use.

  • bytes address = 1

    Ethereum address of the broadcaster

  • bytes sig = 2

    Broadcaster's signature over its address

  • optional Capabilities capabilities = 3

    Features and constraints required by the broadcaster

  • bool ignoreCapacityCheck = 4

    Don't throw error in case of missing capacity, used for refreshing session when we don't need to check capacity

• rpc EndTranscodingSession (EndTranscodingSessionRequest, EndTranscodingSessionResponse)

  lp_rpc.proto:11

  message EndTranscodingSessionRequest

  lp_rpc.proto:37

  sent by Broadcaster to Orchestrator to terminate the transcoding session and free resources (used for verification sessions)

  • optional AuthToken auth_token = 1

    Data for transcoding authentication

  message EndTranscodingSessionResponse

  lp_rpc.proto:42

  (message has no fields)

• rpc Ping (PingPong, PingPong)

  lp_rpc.proto:13

  message PingPong

  lp_rpc.proto:30

  • bytes value = 1

    Implementation defined

• rpc QueueTicket (Ticket, QueueTicketRes)

  redeemer.proto:8

  message Ticket

  redeemer.proto:13

  • optional TicketParams ticket_params = 1

  • bytes sender = 2

  • optional TicketExpirationParams expiration_params = 3

  • optional TicketSenderParams sender_params = 4

  • bytes recipient_rand = 5

  message QueueTicketRes

  redeemer.proto:21

  (message has no fields)

• rpc MaxFloat (MaxFloatReq, MaxFloatUpdate)

  redeemer.proto:9

• rpc MonitorMaxFloat (MaxFloatReq, stream MaxFloatUpdate)

  redeemer.proto:10

• rpc RegisterTranscoder (RegisterRequest, stream NotifySegment)

  lp_rpc.proto:27

  Called by the transcoder to register to an orchestrator. The orchestrator notifies registered transcoders of segments as they come in.

  message RegisterRequest

  lp_rpc.proto:367

  Sent by the transcoder to register itself to the orchestrator.

  • string secret = 1

    Shared secret for auth

  • int64 capacity = 2

    Transcoder capacity

  • optional Capabilities capabilities = 3

    Transcoder capabilities

  message NotifySegment

  lp_rpc.proto:380

  Sent by the orchestrator to the transcoder

  • string url = 1

    URL of the segment to transcode.

  • optional SegData segData = 3

    Configuration for the transcoding job

  • int64 taskId = 16

    ID for this particular transcoding task.

  • string orchId = 18

    Orchestrator identifier for segment metadata

  • bytes profiles = 17

    Deprecated by fullProfiles. Set of presets to transcode into. Should be set to an invalid value to induce failures

Data included by the gateway when submitting a AI job.

Used in: NotifyAIJob

• string pipeline = 1

  pipeline to use for the job

• bytes requestData = 2

  AI job request data

Data for transcoding authentication that is included in the OrchestratorInfo message during discovery

Used in: EndTranscodingSessionRequest, OrchestratorInfo, SegData

• bytes token = 1

  Record used to authenticate for a transcode session Opaque to the receiver

• string session_id = 2

  ID of the transcode session that the token is authenticating for

• int64 expiration = 3

  Timestamp when the token expires

Used in: OrchestratorInfo, OrchestratorRequest, RegisterAIWorkerRequest, RegisterRequest, SegData

• repeated uint64 bitstring = 1

  Bit string of supported features - one bit per feature

• repeated uint64 mandatories = 2

  Bit string of features that are required to be supported

• map<uint32, uint32> capacities = 3

  Capacity corresponding to each capability

• string version = 4

• optional Capabilities.Constraints constraints = 5

Non-binary capability constraints, such as supported ranges.

Used in: Constraints

• map<string, CapabilityConstraints.ModelConstraint> models = 1

Used in: CapabilityConstraints

• bool warm = 1

• uint32 capacity = 2

• string runnerVersion = 3

Non-binary constraints.

Used in: Capabilities

• string minVersion = 1

• map<uint32, CapabilityConstraints> PerCapability = 2

GPU information used by worker on network

Used in: HardwareInformation

• string id = 1

  unique id

• string name = 2

  gpu name

• uint32 major = 4

  compute version supported - major

• uint32 minor = 5

  compute version supported - minor

• int64 memory_free = 6

  GPU memory free

• int64 memory_total = 7

  GPU memory total

Hardware information for worker on network

Used in: OrchestratorInfo, RegisterAIWorkerRequest

• string pipeline = 1

  pipeline hardware supports

• string model_id = 2

  model_id hardware supports

• map<string, GPUComputeInfo> gpu_info = 3

  hardware for pipeline and model_id

Used as request type in: TicketRedeemer.MaxFloat, TicketRedeemer.MonitorMaxFloat

• bytes sender = 1

Used as response type in: TicketRedeemer.MaxFloat, TicketRedeemer.MonitorMaxFloat

• bytes max_float = 1

OSInfo needed to negotiate storages that will be used. It carries info needed to write to the storage.

Used in: OrchestratorInfo, SegData

• OSInfo.StorageType storageType = 1

  Storage type: direct, s3, ipfs.

• optional S3OSInfo s3info = 16

Used in: OSInfo

• DIRECT = 0

• S3 = 1

• GOOGLE = 2

The orchestrator sends this in response to `GetOrchestrator`, containing miscellaneous data related to the job.

Used as response type in: Orchestrator.GetOrchestrator

Used as field type in: PaymentResult, TranscodeResult

• string transcoder = 1

  URI of the transcoder to use for submitting segments.

• optional TicketParams ticket_params = 2

  Parameters for probabilistic micropayment tickets

• optional PriceInfo price_info = 3

  Price Info containing the price per pixel to transcode

• bytes address = 4

  ETH address that should sign transcoded results

• optional Capabilities capabilities = 5

  Features and constraints supported by the orchestrator

• optional AuthToken auth_token = 6

  Data for transcoding authentication

• repeated HardwareInformation hardware = 7

  Information on Orchestrator hardware

• repeated OSInfo storage = 32

  Orchestrator returns info about own input object storage, if it wants it to be used.

• repeated PriceInfo capabilities_prices = 33

  prices for capabilities

Payment for transcoding video segments A payment can constitute of multiple tickets A broadcaster might need to send multiple tickets to top up his credit with an Orchestrator

• optional TicketParams ticket_params = 1

  Probabilistic micropayment ticket parameters These remain the same even when sending multiple tickets

• bytes sender = 2

  ETH address of the sender

• optional TicketExpirationParams expiration_params = 3

  Ticket params for expiration related validation

• repeated TicketSenderParams ticket_sender_params = 4

• optional PriceInfo expected_price = 5

  O's last known price

Response that an orchestrator sends after processing a payment.

• optional OrchestratorInfo info = 16

  Used to notify a broadcaster of updated orchestrator information

PriceInfo conveys pricing info for transcoding services

Used in: OrchestratorInfo, Payment

• int64 pricePerUnit = 1

  price in wei

• int64 pixelsPerUnit = 2

  Pixels covered in the price Set price to 1 wei and pixelsPerUnit > 1 to have a smaller price granularity per pixel than 1 wei

• uint32 capability = 3

  Capability price is for

• string constraint = 4

  constraint price is for

Used in: OSInfo

• string host = 1

  Host to use to connect to S3

• string key = 2

  Key (prefix) to use when uploading the object.

• string policy = 3

  POST policy that S3 owner node creates to give write access to other node.

• string signature = 4

  Signature for POST policy.

• string credential = 5

  Needed for POST policy.

• string xAmzDate = 6

  Needed for POST policy.

Data included by the broadcaster when submitting a segment for transcoding.

Used in: NotifySegment

• bytes manifestId = 1

  Manifest ID this segment belongs to

• int64 seq = 2

  Sequence number of the segment to be transcoded

• bytes hash = 3

  Hash of the segment data to be transcoded

• bytes profiles = 4

  Transcoding profiles to use

• bytes sig = 5

  Broadcaster signature for the segment. Corresponds to: broadcaster.sign(manifestId | seqNo | dataHash | profiles)

• int32 duration = 6

  Duration of the segment to be transcoded, in milliseconds

• optional Capabilities capabilities = 7

  Capabilities used by this segment.

• optional AuthToken auth_token = 8

  Data for transcoding authentication

• bool calc_perceptual_hash = 10

  Calculate perceptual hash for this segment

• repeated OSInfo storage = 32

  Broadcaster's preferred storage medium(s) XXX should we include this in a sig somewhere until certs are authenticated?

• repeated VideoProfile fullProfiles = 33

  Transcoding profiles to use. Supersedes `profiles` field Deprecated by `fullProfiles2` but may still be used for mpegts formats

• repeated VideoProfile fullProfiles2 = 34

  Transcoding profiles to use. Supersedes `fullProfiles` field Deprecated by `fullProfiles3` but may still be used for integer FPS

• repeated VideoProfile fullProfiles3 = 35

  Transcoding profiles to use. Supersedes `fullProfiles2` field

• optional SegParameters segment_parameters = 37

  Transcoding parameters specific to this segment

• bool ForceSessionReinit = 38

  Force HW Session Reinit

Used in: SegData

• uint64 from = 1

  Start timestamp from which to start encoding Milliseconds, from start of the file

• uint64 to = 2

  Skip all frames after that timestamp Milliseconds, from start of the file

Ticket params for expiration related validation

Used in: Payment, Ticket, TicketParams

• int64 creation_round = 1

  Round during which tickets are created

• bytes creation_round_block_hash = 2

  Block hash associated with creation_round

Required parameters for probabilistic micropayment tickets

Used in: OrchestratorInfo, Payment, Ticket

• bytes recipient = 1

  ETH address of the recipient

• bytes face_value = 2

  Pay out (in Wei) to the recipient if the ticket wins

• bytes win_prob = 3

  Probability that the ticket wins

• bytes recipient_rand_hash = 4

  32 byte keccak-256 hash commitment to a random number provided by the recipient

• bytes seed = 5

  Value generated by recipient that the recipient can use to derive the random number corresponding to the recipient's hash commitment

• bytes expiration_block = 6

  Block number at which the current set of advertised TicketParams is no longer valid

• optional TicketExpirationParams expiration_params = 7

  Expected ticket expiration params

Sender Params (nonces and signatures)

Used in: Payment, Ticket

• uint32 sender_nonce = 1

  Monotonically increasing counter that makes the ticket unique relative to a particular hash commitment to a recipient's random number

• bytes sig = 2

  Sender signature over the ticket

A set of transcoded segments following the profiles specified in the job.

Used in: TranscodeResult

• repeated TranscodedSegmentData segments = 1

  Transcoded data, in the order specified in the job options

• bytes sig = 2

  Signature of the hash of the concatenated hashes

Response that a transcoder sends after transcoding a segment.

• int64 seq = 1

  Sequence number of the transcoded results.

• oneof result

  Result of transcoding can be an error, or successful with more info

  • string error = 2

  • TranscodeData data = 3

• optional OrchestratorInfo info = 16

  Used to notify a broadcaster of updated orchestrator information

Individual transcoded segment data.

Used in: TranscodeData

• string url = 1

  URL where the transcoded data can be downloaded from.

• int64 pixels = 2

  Amount of pixels processed (output pixels)

• string perceptual_hash_url = 3

  URL where the perceptual hash data can be downloaded from (can be empty)

Used in: SegData

• string name = 16

  Name of VideoProfile

• int32 width = 17

  Width of VideoProfile

• int32 height = 18

  Height of VideoProfile

• int32 bitrate = 19

  Bitrate of VideoProfile

• uint32 fps = 20

  FPS of VideoProfile

• VideoProfile.Format format = 21

• uint32 fpsDen = 22

  FPS Denominator of VideoProfile

• VideoProfile.Profile profile = 23

  Desired codec profile

• int32 gop = 24

  GOP interval

• VideoProfile.VideoCodec encoder = 25

  Encoder (video codec)

• int32 colorDepth = 26

• VideoProfile.ChromaSubsampling chromaFormat = 27

• uint32 quality = 28

Used in: VideoProfile

• CHROMA_420 = 0

• CHROMA_422 = 1

• CHROMA_444 = 2

Desired output format

Used in: VideoProfile

• MPEGTS = 0

• MP4 = 1

Used in: VideoProfile

• ENCODER_DEFAULT = 0

• H264_BASELINE = 1

• H264_MAIN = 2

• H264_HIGH = 3

• H264_CONSTRAINED_HIGH = 4

Used in: VideoProfile

• H264 = 0

• H265 = 1

• VP8 = 2

• VP9 = 3