server

Documentation

Overview

Package server is the place we integrate the Livepeer node with the LPMS media server.

Index

• Constants
• Variables
• func CheckOrchestratorAvailability(orch Orchestrator) bool
• func GetOrchestratorInfo(ctx context.Context, bcast Broadcaster, orchestratorServer *url.URL) (*net.OrchestratorInfo, error)
• func RunTranscoder(n *core.LivepeerNode, orchAddr string, capacity int)
• func StartTranscodeServer(orch Orchestrator, bind string, mux *http.ServeMux, workDir string, ...)
• func SubmitSegment(sess *BroadcastSession, seg *stream.HLSSegment, nonce uint64) (*net.TranscodeData, error)
• type Balance
• type BalanceUpdate
• type BalanceUpdateStatus
• type BlockGetter
• type BroadcastConfig
  • func (cfg *BroadcastConfig) MaxPrice() *big.Rat
  • func (cfg *BroadcastConfig) SetMaxPrice(price *big.Rat)
• type BroadcastSession
• type BroadcastSessionsManager
  • func NewSessionManager(node *core.LivepeerNode, params *streamParameters, pl core.PlaylistManager) *BroadcastSessionsManager
• type Broadcaster
• type LivepeerServer
  • func NewLivepeerServer(rtmpAddr string, lpNode *core.LivepeerNode) *LivepeerServer
  • func (s *LivepeerServer) GetNodeStatus() *net.NodeStatus
  • func (s *LivepeerServer) HandlePush(w http.ResponseWriter, r *http.Request)
  • func (s *LivepeerServer) LastHLSStreamID() core.StreamID
  • func (s *LivepeerServer) LastManifestID() core.ManifestID
  • func (s *LivepeerServer) LatestPlaylist() core.PlaylistManager
  • func (s *LivepeerServer) StartCliWebserver(bindAddr string)
  • func (s *LivepeerServer) StartMediaServer(ctx context.Context, transcodingOptions string, httpAddr string) error
• type Orchestrator

Constants

const (
	// Staged indicates that the update has been created but the credit
	// has not been spent yet
	Staged = iota
	// CreditSpent indicates that the update's credit has been spent
	// but the debit has not been processed yet
	CreditSpent
	// ReceivedChange indicates that the update's credit has been spent
	// and a debit was processed such that there was "change" (net of credit/debit)
	ReceivedChange
)

const BroadcastRetry = 15 * time.Second

const GRPCConnectTimeout = 3 * time.Second

const GRPCTimeout = 8 * time.Second

const HLSBufferCap = uint(43200) //12 hrs assuming 1s segment

const HLSBufferWindow = uint(5)

const HLSWaitInterval = time.Second

const RefreshIntervalHttpPush = 1 * time.Minute

const SegLen = 2 * time.Second

const StreamKeyBytes = 6

Variables

var AuthWebhookURL string

var BroadcastCfg = &BroadcastConfig{}

var BroadcastJobVideoProfiles = []ffmpeg.VideoProfile{ffmpeg.P240p30fps4x3, ffmpeg.P360p30fps16x9}

var StreamPrefix = regexp.MustCompile(`^[ /]*(stream/)?|(live/)?`) // test carefully!

Match all leading spaces, slashes and optionally `stream/`

Functions

func CheckOrchestratorAvailability

func CheckOrchestratorAvailability(orch Orchestrator) bool

CheckOrchestratorAvailability - the broadcaster calls CheckOrchestratorAvailability which invokes Ping on the orchestrator

func GetOrchestratorInfo

func GetOrchestratorInfo(ctx context.Context, bcast Broadcaster, orchestratorServer *url.URL) (*net.OrchestratorInfo, error)

GetOrchestratorInfo - the broadcaster calls GetOrchestratorInfo which invokes GetOrchestrator on the orchestrator

func RunTranscoder

func RunTranscoder(n *core.LivepeerNode, orchAddr string, capacity int)

RunTranscoder is main routing of standalone transcoder Exiting it will terminate executable

func StartTranscodeServer

func StartTranscodeServer(orch Orchestrator, bind string, mux *http.ServeMux, workDir string, acceptRemoteTranscoders bool)

XXX do something about the implicit start of the http mux? this smells

func SubmitSegment

func SubmitSegment(sess *BroadcastSession, seg *stream.HLSSegment, nonce uint64) (*net.TranscodeData, error)

Types

type Balance

type Balance interface {
	Credit(amount *big.Rat)
	StageUpdate(minCredit *big.Rat, ev *big.Rat) (int, *big.Rat, *big.Rat)
}

Balance describes methods for a session's balance maintenance

type BalanceUpdate

type BalanceUpdate struct {
	// ExistingCredit is the existing credit reserved for the update
	ExistingCredit *big.Rat

	// NewCredit is the new credit for the update provided by a payment
	NewCredit *big.Rat

	// NumTickets is the number of tickets in the payment for the update
	NumTickets int

	// Debit is the amount to debit for the update
	Debit *big.Rat

	// Status is the current status of the update
	Status BalanceUpdateStatus
}

BalanceUpdate describes an update to be performed on the balance of a session

type BalanceUpdateStatus

type BalanceUpdateStatus int

BalanceUpdateStatus indicates the current status of a balance update

type BlockGetter

type BlockGetter interface {
	// LastSeenBlock returns the last seen block number
	LastSeenBlock() (*big.Int, error)
}

BlockGetter is an interface which describes an object capable of getting blocks

type BroadcastConfig

type BroadcastConfig struct {
	// contains filtered or unexported fields
}

func (*BroadcastConfig) MaxPrice

func (cfg *BroadcastConfig) MaxPrice() *big.Rat

func (*BroadcastConfig) SetMaxPrice

func (cfg *BroadcastConfig) SetMaxPrice(price *big.Rat)

type BroadcastSession

type BroadcastSession struct {
	Broadcaster      Broadcaster
	ManifestID       core.ManifestID
	Profiles         []ffmpeg.VideoProfile
	OrchestratorInfo *net.OrchestratorInfo
	OrchestratorOS   drivers.OSSession
	BroadcasterOS    drivers.OSSession
	Sender           pm.Sender
	PMSessionID      string
	Balance          Balance
}

BroadcastSession - session-specific state for broadcasters

type BroadcastSessionsManager

type BroadcastSessionsManager struct {
	// contains filtered or unexported fields
}

func NewSessionManager

func NewSessionManager(node *core.LivepeerNode, params *streamParameters, pl core.PlaylistManager) *BroadcastSessionsManager

type Broadcaster

type Broadcaster interface {
	Address() ethcommon.Address
	Sign([]byte) ([]byte, error)
}

type LivepeerServer

type LivepeerServer struct {
	RTMPSegmenter         lpmscore.RTMPSegmenter
	LPMS                  *lpmscore.LPMS
	LivepeerNode          *core.LivepeerNode
	HTTPMux               *http.ServeMux
	ExposeCurrentManifest bool
	// contains filtered or unexported fields
}

func NewLivepeerServer

func NewLivepeerServer(rtmpAddr string, lpNode *core.LivepeerNode) *LivepeerServer

func (*LivepeerServer) GetNodeStatus

func (s *LivepeerServer) GetNodeStatus() *net.NodeStatus

func (*LivepeerServer) HandlePush

func (s *LivepeerServer) HandlePush(w http.ResponseWriter, r *http.Request)

func (*LivepeerServer) LastHLSStreamID

func (s *LivepeerServer) LastHLSStreamID() core.StreamID

func (*LivepeerServer) LastManifestID

func (s *LivepeerServer) LastManifestID() core.ManifestID

func (*LivepeerServer) LatestPlaylist

func (s *LivepeerServer) LatestPlaylist() core.PlaylistManager

Debug helpers

func (*LivepeerServer) StartCliWebserver

func (s *LivepeerServer) StartCliWebserver(bindAddr string)

StartCliWebserver starts web server for CLI blocks until exit

func (*LivepeerServer) StartMediaServer

func (s *LivepeerServer) StartMediaServer(ctx context.Context, transcodingOptions string, httpAddr string) error

StartMediaServer starts the LPMS server

type Orchestrator

type Orchestrator interface {
	ServiceURI() *url.URL
	Address() ethcommon.Address
	TranscoderSecret() string
	Sign([]byte) ([]byte, error)
	VerifySig(ethcommon.Address, string, []byte) bool
	CurrentBlock() *big.Int
	CheckCapacity(core.ManifestID) error
	TranscodeSeg(*core.SegTranscodingMetadata, *stream.HLSSegment) (*core.TranscodeResult, error)
	ServeTranscoder(stream net.Transcoder_RegisterTranscoderServer, capacity int)
	TranscoderResults(job int64, res *core.RemoteTranscoderResult)
	ProcessPayment(payment net.Payment, manifestID core.ManifestID) error
	TicketParams(sender ethcommon.Address) (*net.TicketParams, error)
	PriceInfo(sender ethcommon.Address) (*net.PriceInfo, error)
	SufficientBalance(addr ethcommon.Address, manifestID core.ManifestID) bool
	DebitFees(addr ethcommon.Address, manifestID core.ManifestID, price *net.PriceInfo, pixels int64)
}