FFmpeg: RTSPState Struct Reference

some MS RTSP streams contain a URL in the SDP that we need to use for all subsequent RTSP requests, rather than the input URI; in other cases, this is a copy of AVFormatContext->filename.

URLContext * rtsp_hd_out

Additional output handle, used when input and output are done separately, eg for HTTP tunneling.

enum RTSPControlTransport control_transport

RTSP transport mode, such as plain or tunneled.

int nb_byes

uint8_t * recvbuf

Reusable buffer for receiving packets.

int lower_transport_mask

A mask with all requested transport methods.

uint64_t packets

The number of returned packets.

struct pollfd * p

Polling array for udp.

int get_parameter_supported

Whether the server supports the GET_PARAMETER method.

int initial_pause

Do not begin to play the stream immediately.

int rtp_muxer_flags

Option flags for the chained RTP muxer.

int accept_dynamic_rate

Whether the server accepts the x-Dynamic-Rate header.

int rtsp_flags

Various option flags for the RTSP muxer/demuxer.

int media_type_mask

Mask of all requested media types.

int rtp_port_min

Minimum and maximum local UDP ports.

int rtp_port_max

int initial_timeout

Timeout to wait for incoming connections.

int stimeout

timeout of socket i/o operations.

int reordering_queue_size

Size of RTP packet reordering queue.

int need_subscription

The following are used for Real stream selection.

enum AVDiscard * real_setup_cache

stream setup during the last frame read.

enum AVDiscard * real_setup

current stream setup.

char last_subscription [1024]

the last value of the "SET_PARAMETER Subscribe:" RTSP command.

AVFormatContext * asf_ctx

The following are used for RTP/ASF streams.

uint64_t asf_pb_pos

cache for position of the asf demuxer, since we load a new data packet in the bytecontext for each incoming RTSP packet.

struct MpegTSContext * ts

The following are used for parsing raw mpegts in udp.

int recvbuf_pos

int recvbuf_len

Detailed Description

Private data for the RTSP demuxer.

Todo:: Use AVIOContext instead of URLContext

Definition at line 217 of file rtsp.h.

Field Documentation

const AVClass* RTSPState::class

Class for private options.

Definition at line 218 of file rtsp.h.

URLContext* RTSPState::rtsp_hd

Definition at line 219 of file rtsp.h.

Referenced by ff_rtsp_tcp_read_packet(), read_line(), rtsp_listen(), rtsp_read_announce(), rtsp_send_reply(), and rtsp_write_packet().

int RTSPState::nb_rtsp_streams

number of items in the 'rtsp_streams' variable

Definition at line 222 of file rtsp.h.

Referenced by ff_rtsp_close_streams(), ff_rtsp_setup_output_streams(), ff_rtsp_tcp_read_packet(), ff_rtsp_undo_setup(), rtsp_read_packet(), rtsp_read_play(), rtsp_read_setup(), and rtsp_write_packet().

struct RTSPStream** RTSPState::rtsp_streams

streams in this session

Definition at line 224 of file rtsp.h.

Referenced by ff_rtsp_close_streams(), ff_rtsp_setup_output_streams(), ff_rtsp_tcp_read_packet(), ff_rtsp_undo_setup(), rtsp_read_play(), rtsp_read_setup(), and rtsp_write_packet().

enum RTSPClientState RTSPState::state

indicator of whether we are currently receiving data from the server.

Basically this isn't more than a simple cache of the last PLAY/PAUSE command sent to the server, to make sure we don't send 2x the same unexpectedly or commands in the wrong state.

Definition at line 230 of file rtsp.h.

Referenced by ff_rtsp_parse_streaming_commands(), ff_rtsp_tcp_read_packet(), parse_command_line(), rtsp_listen(), rtsp_read_packet(), rtsp_read_pause(), rtsp_read_play(), rtsp_read_record(), rtsp_read_seek(), rtsp_read_setup(), rtsp_write_packet(), and rtsp_write_record().

int64_t RTSPState::seek_timestamp

the seek value requested when calling av_seek_frame().

This value is subsequently used as part of the "Range" parameter when emitting the RTSP PLAY command. If we are currently playing, this command is called instantly. If we are currently paused, this command is called whenever we resume playback. Either way, the value is only used once, see rtsp_read_play() and rtsp_read_seek().

Definition at line 238 of file rtsp.h.

Referenced by rtsp_read_play(), and rtsp_read_seek().

int RTSPState::seq

RTSP command sequence number.

Definition at line 240 of file rtsp.h.

Referenced by ff_rtsp_parse_streaming_commands(), rtsp_read_announce(), rtsp_read_options(), rtsp_read_record(), rtsp_read_request(), and rtsp_read_setup().

char RTSPState::session_id[512]

copy of RTSPMessageHeader->session_id, i.e.

the server-provided session identifier that the client should re-transmit in each RTSP command

Definition at line 244 of file rtsp.h.

Referenced by check_sessionid(), rtsp_read_packet(), rtsp_read_record(), rtsp_read_request(), and rtsp_read_setup().

int RTSPState::timeout

copy of RTSPMessageHeader->timeout, i.e.

the time (in seconds) that the server will go without traffic on the RTSP/TCP line before it closes the connection.

Definition at line 249 of file rtsp.h.

Referenced by rtsp_read_packet().

int64_t RTSPState::last_cmd_time

timestamp of the last RTSP command that we sent to the RTSP server.

This is used to calculate when to send dummy commands to keep the connection alive, in conjunction with timeout.

Definition at line 254 of file rtsp.h.

Referenced by rtsp_read_packet().

enum RTSPTransport RTSPState::transport

the negotiated data/packet transport protocol; e.g.

RTP or RDT

Definition at line 257 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), ff_rtsp_tcp_read_packet(), ff_rtsp_undo_setup(), and rtsp_read_play().

enum RTSPLowerTransport RTSPState::lower_transport

the negotiated network layer transport protocol; e.g.

TCP or UDP uni-/multicast

Definition at line 261 of file rtsp.h.

Referenced by ff_rtsp_open_transport_ctx(), ff_rtsp_undo_setup(), rtsp_read_packet(), rtsp_read_setup(), and rtsp_write_packet().

enum RTSPServerType RTSPState::server_type

brand of server that we're talking to; e.g.

WMS, REAL or other. Detected based on the value of RTSPMessageHeader->server or the presence of RTSPMessageHeader->real_challenge

Definition at line 266 of file rtsp.h.

Referenced by ff_rtsp_setup_input_streams(), rtsp_read_packet(), rtsp_read_pause(), and rtsp_read_play().

char RTSPState::real_challenge[64]

the "RealChallenge1:" field from the server

Definition at line 269 of file rtsp.h.

Referenced by resetup_tcp().

char RTSPState::auth[128]

plaintext authorization line (username:password)

Definition at line 272 of file rtsp.h.

HTTPAuthState RTSPState::auth_state

authentication state

Definition at line 275 of file rtsp.h.

Referenced by rtsp_read_packet().

char RTSPState::last_reply[2048]

The last reply of the server to a RTSP command.

Definition at line 278 of file rtsp.h.

void* RTSPState::cur_transport_priv

RTSPStream->transport_priv of the last stream that we read a packet from.

Definition at line 282 of file rtsp.h.

int RTSPState::need_subscription

The following are used for Real stream selection.

whether we need to send a "SET_PARAMETER Subscribe:" command

Definition at line 287 of file rtsp.h.

Referenced by rtsp_read_packet(), rtsp_read_pause(), and rtsp_read_play().

enum AVDiscard* RTSPState::real_setup_cache

stream setup during the last frame read.

This is used to detect if we need to subscribe or unsubscribe to any new streams.

Definition at line 291 of file rtsp.h.

Referenced by rtsp_read_close(), rtsp_read_header(), and rtsp_read_packet().

enum AVDiscard* RTSPState::real_setup

current stream setup.

This is a temporary buffer used to compare current setup to previous frame setup.

Definition at line 295 of file rtsp.h.

Referenced by rtsp_read_close(), rtsp_read_header(), and rtsp_read_packet().

char RTSPState::last_subscription[1024]

the last value of the "SET_PARAMETER Subscribe:" RTSP command.

this is used to send the same "Unsubscribe:" if stream setup changed, before sending a new "Subscribe:" command.

Definition at line 300 of file rtsp.h.

Referenced by rtsp_read_packet().

AVFormatContext* RTSPState::asf_ctx

The following are used for RTP/ASF streams.

ASF demuxer context for the embedded ASF stream from WMS servers

Definition at line 306 of file rtsp.h.

Referenced by asfrtp_parse_packet(), asfrtp_parse_sdp_line(), ff_rtsp_close_streams(), and ff_wms_parse_sdp_a_line().

uint64_t RTSPState::asf_pb_pos

cache for position of the asf demuxer, since we load a new data packet in the bytecontext for each incoming RTSP packet.

Definition at line 310 of file rtsp.h.

Referenced by asfrtp_parse_packet(), and ff_wms_parse_sdp_a_line().

char RTSPState::control_uri[1024]

some MS RTSP streams contain a URL in the SDP that we need to use for all subsequent RTSP requests, rather than the input URI; in other cases, this is a copy of AVFormatContext->filename.

Definition at line 316 of file rtsp.h.

Referenced by ff_rtsp_setup_input_streams(), ff_rtsp_setup_output_streams(), parse_command_line(), rtsp_listen(), rtsp_read_close(), rtsp_read_packet(), rtsp_read_pause(), rtsp_read_play(), rtsp_write_close(), and rtsp_write_record().