src/jlibrtp/RTCPAVPFIntf.java
changeset 13 e684f11070d5
equal deleted inserted replaced
12:c9ff263c29ad 13:e684f11070d5
       
     1 /**
       
     2  * Java RTP Library (jlibrtp)
       
     3  * Copyright (C) 2006 Arne Kepp
       
     4  * 
       
     5  * This library is free software; you can redistribute it and/or
       
     6  * modify it under the terms of the GNU Lesser General Public
       
     7  * License as published by the Free Software Foundation; either
       
     8  * version 2.1 of the License, or (at your option) any later version.
       
     9  *
       
    10  * This library is distributed in the hope that it will be useful,
       
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       
    13  * Lesser General Public License for more details.
       
    14  * 
       
    15  * You should have received a copy of the GNU Lesser General Public
       
    16  * License along with this library; if not, write to the Free Software
       
    17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
       
    18  */
       
    19 
       
    20 package jlibrtp;
       
    21 
       
    22 
       
    23 /**
       
    24  * This is the callback interface for the AVPF profile (RFC 4585)
       
    25  * 
       
    26  * It is optional, you do not have to register it.
       
    27  * 
       
    28  * If there are specific events you wish to ignore,
       
    29  * you can simply implement empty functions.
       
    30  * 
       
    31  * These are all syncrhonous, make sure to return quickly
       
    32  * or do the handling in a new thread.
       
    33  * 
       
    34  * @author Arne Kepp
       
    35  */
       
    36 public interface RTCPAVPFIntf {	
       
    37 	
       
    38 	/**
       
    39 	 * This function is called when a 
       
    40 	 * Picture Loss Indication (PLI, FMT = 1) is received
       
    41 	 * 
       
    42 	 * @param ssrcPacketSender the SSRC of the participant reporting loss of picture
       
    43 	 */
       
    44 	public void PSFBPktPictureLossReceived(
       
    45 			long ssrcPacketSender);
       
    46 	
       
    47 	/**
       
    48 	 * This function is called when a
       
    49 	 * Slice Loss Indication (SLI, FMT=2) is received
       
    50 	 * 
       
    51 	 * @param ssrcPacketSender the SSRC of the participant reporting loss of slice(s)
       
    52 	 * @param sliceFirst macroblock address of first macroblock
       
    53 	 * @param sliceNumber number of lost macroblocks, in scan order
       
    54 	 * @param slicePictureId the six least significant bits of the picture identifier 
       
    55 	 */
       
    56 	public void PSFBPktSliceLossIndic(
       
    57 			long ssrcPacketSender,
       
    58 			int[] sliceFirst, int[] sliceNumber, int[] slicePictureId);
       
    59 	
       
    60 	/**
       
    61 	 * This function is called when a
       
    62 	 * Reference Picture Selection Indication (RPSI, FMT=3) is received
       
    63 	 * 
       
    64 	 * @param ssrcPacketSender the SSRC of the participant reporting the selection
       
    65 	 * @param rpsiPayloadType the RTP payload type related to the RPSI bit string
       
    66 	 * @param rpsiBitString the RPSI information as natively defined by the video codec
       
    67 	 * @param rpsiPaddingBits the number of padding bits at the end of the string
       
    68 	 */
       
    69 	public void PSFBPktRefPictureSelIndic(
       
    70 			long ssrcPacketSender,
       
    71 			int rpsiPayloadType, byte[] rpsiBitString, int rpsiPaddingBits);
       
    72 	
       
    73 	/**
       
    74 	 * This function is called when a 
       
    75 	 * Transport Layer Feedback Messages is received
       
    76 	 * 
       
    77 	 * @param ssrcPacketSender
       
    78 	 * @param alfBitString
       
    79 	 */
       
    80 	public void PSFBPktAppLayerFBReceived(
       
    81 			long ssrcPacketSender,
       
    82 			byte[] alfBitString);
       
    83 
       
    84 	/**
       
    85 	 * This function is called when a 
       
    86 	 * Transport Layer Feedback Messages is received
       
    87 	 * 
       
    88 	 * @param ssrcPacketSender 
       
    89 	 * @param FMT 1: NACK, 0,2-30: unassigned, 31: reserved
       
    90 	 * @param packetID the RTP sequence number of the lost packet
       
    91 	 * @param bitmaskLostPackets the bitmask of following lost packets
       
    92 	 */
       
    93 	public void RTPFBPktReceived(
       
    94 			long ssrcPacketSender,
       
    95 			int FMT, int[] packetID, int[] bitmaskLostPackets);
       
    96 }