Internet Draft: The Audio/QCP Media Type and File Format    H. Garudadri
Document: draft-garudadri-qcp-00.txt                          R. Gellens
Expires: August 2003                                            Qualcomm
                                                        23 February 2003
    
    
                The Audio/QCP Media Type and File Format
    
    
Status of this Memo
    
    This document is an Internet-Draft and is in full conformance with
    all provisions of Section 10 of RFC2026.
    
    Internet-Drafts are working documents of the Internet Engineering
    Task Force (IETF), its areas, and its working groups.  Note that
    other groups may also distribute working documents as
    Internet-Drafts.
    
    Internet-Drafts are draft documents valid for a maximum of six
    months and may be updated, replaced, or obsoleted by other documents
    at any time.  It is inappropriate to use Internet- Drafts as
    reference material or to cite them other than as "work in progress."
    
    The list of current Internet-Drafts can be accessed at
    <http://www.ietf.org/ietf/1id-abstracts.txt>
    
    The list of Internet-Draft Shadow Directories can be accessed at
    <http://www.ietf.org/shadow.html>.
    
    
Copyright Notice
    
    Copyright (C) The Internet Society (2003).  All Rights Reserved.
    
    
Abstract
    
    RFC 2658 specifies the streaming format for QCELP 13K vocoder, but
    did not specify the storage format for QCELP 13K vocoder.  Many
    implementations have been using the qcp file format for exchanging
    QCELP 13K data and EVRC data. (For example, Eudora, QuickTime and
    CDMA 2000 handsets).  This document specifies the qcp fileformat and
    registers the audio/qcp MIME media type.  This format has parameters
    to support QCELP 13K and EVRC data.  Note that this is different
    from the EVRC storage format specified in
    draft-ietf-avt-evrc-smv-03.txt (for EVRC and SMV vocoders).





Garudadri                  [Page 1]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


    1.  Conventions Used in this Document . . . . . . . . . . . . . .  2
    2.  Introduction . . . . . . . . . . . . . . . . . . . . . . . .   2
    3.  QCP FILE FORMAT . . . . . . . . . . . . . . . . . . . . . . .  2
      3.1.  RIFF subchunks . . . . . . . . . . . . . . . . . . . . .   2
      3.2.  General view of qcp subchunks . . . . . . . . . . . . . .  3
      3.3.  Detailed view of qcp subchunks . . . . . . . . . . . . .   4
      3.4.  Optional Chunks . . . . . . . . . . . . . . . . . . . . .  6
    4.  READING A QCP FILE . . . . . . . . . . . . . . . . . . . . .   7
    5.  WRITING A QCP FILE  . . . . . . . . . . . . . . . . . . . . .  8
    6.  Registration of Media Type Audio/qcp . . . . . . . . . . . .   8
    7.  Security Considerations . . . . . . . . . . . . . . . . . . .  9
    8.  Acknowledgements . . . . . . . . . . . . . . . . . . . . . .   9
    9.  Normative References  . . . . . . . . . . . . . . . . . . . . 10
     10.  Authors Address  . . . . . . . . . . . . . . . . . . . . .  10
      Intellectual Property Statement . . . . . . . . . . . . . . . . 10
      Full Copyright Statement . . . . . . . . . . . . . . . . . . .  11
    
1.  Conventions Used in this Document
    
    The key words "REQUIRED", "MUST", "MUST NOT", "SHOULD", "SHOULD
    NOT", and "MAY" in this document are to be interpreted as described
    in "Key words for use in RFCs to Indicate Requirement Levels"
    [KEYWORDS].
    
2.  Introduction
    
    This document specifies a format for storage of [QCELP] 13K and
    [EVRC] vocoder packets in files which may residing on network
    elements (e.g., media servers, Mulimedia Messaging System (MMS)
    centers, etc.) and third-generation (3G) handsets or be transmitted
    via email or other mechanisms.  The vocoder packets read from a file
    may be streamed using [QCELP] or delivered to an [EVRC] or [QCELP]
    13K decoder.
    
3.  QCP FILE FORMAT
    
    The QCP file format uses the RIFF (Resource Interchange File Format)
    specification.  It contains:
    o   RIFF chunk with the identifying code QLCM
        o   Chunks within the RIFF chunk:
                o    Three required chunks fmt, vrat, and data
                o    Four optional chunks labl, offs, cnfg, and text
    
    The RIFF (Resource Interchange File Format) specification is
    published in [TBD].
    





Garudadri                  [Page 2]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


3.1.  RIFF subchunks
    
    In this section, various RIFF subchunks are described.
    
    fmt:  This subchunk is of type "Format".  It defines which speech
    codec is being used.  Both QCELP 13K and EVRC are supported.  This
    is a required chunk.
    
    vrat:  This subchunk is of type "variable-rate".  It is used to
    determine whether the data chunk is comprised of variable-rate or
    fixed-rate packets, and to determine the size of the data chunk in
    numbers of packets.  This information can be used to determine the
    length of the data chunk in seconds without reading the whole file
    in the case of variable-rate packets.  This is a required chunk.
    
    data:  This subchunk contains the packetized speech data, generatd
    by the speech codec.  This is a required chunk.  Note:  The size of
    the data chunk MUST be word (16-bits) aligned.  If the data chunk
    happens to be of an odd size, then a zero pad byte MUST be added at
    the end to make it word aligned.
    
    labl:  This subchunk is of type "Label".  It is used for generic
    storage for applications use.  This is an optional chunk.
    
    Offs:  This subchunk contains byte offsets into data chunk in (t *
    100 ms) increments.  This is useful for fast-forward and rewind
    features for files containing variable rate packets.  This is an
    optional chunk.
    
    cnfg:  This is of type "File configuration".  It contains
    configuration information about the file that an application may
    need to know.  This is an optional chunk.
    
    text:  This subchunk is used to for any generic storage for
    applications use.  This is an optional chunk.
    
    All data is in little-endian format, and all structs are padding
    neutral, that is, they have no padding.  The chunks are word (16
    bits) aligned.
    
3.2.  General view of qcp subchunks
    

    <QLCM-form>
    RIFF( 'QLCM'
        <format chunk 'fmt'>                       // required
        [<variable rate chunk - 'vrat'>]           // required
        [<label chunk 'labl'>]                     // optional
        [<offsets in increments chunk - 'offs'>]   // optional


Garudadri                  [Page 3]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


        <codec packet data chunk - 'data'>         // required
        [<configuration chunk - 'cnfg'>]           // optional
        [<text chunk - 'text'>]                    //  optional
    )

    
3.3.  Detailed view of qcp subchunks
    
    RIFF 'QLCM' {
        BYTE[4] id    = {'R', 'I', 'F', 'F'}
        UINT32 size   = size of RIFF chunk excluding id and size
        BYTE[4]       = {'Q', 'L', 'C', 'M'}
    
        <format chunk - 'fmt '>  {
            BYTE[4] id     = {'f', 'm', 't', ' '}
            UINT32 size    = size of 'fmt ' subchunk excluding id and
                             size
            BYTE mjv       = major version of this format (see note 1)
            BYTE mnv       = minor version of this format (see note 1)
            struct type_qpl_info {
                struct GUID {
                    UINT32    Data1;
                    UINT16    Data2;
                    UINT16    Data3;
                    BYTE      Data4[ 8 ];
                } = Id;                          // unique ID of this
                                                 //    codec
                UINT16    Version;               // version # of the
                                                 //    codec
                BYTE      Name[80];              // proper name of the
                                                 //    codec
                UINT16    avgBitsPerSec;         // avg bps of the
                                                 //    codec
                UINT16    bytesPerPacket;        // size of a packet in
                                                 //    bytes (max rate)
                                                 // including header
                                                 //    byte for that
                                                 //    packet
                UINT16    samplesPerBlock;       // size of a block in
                                                 //    samples
                                                 // encoder encodes one
                                                 //    block into one
                                                 //    packet
                                                 // decoder decodes one
                                                 //    packet into one
                                                 //    block
                UINT16    samplesPerSec;         // sps of input needed
                                                 //    for the encoder
                                                 // and output from the


Garudadri                  [Page 4]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


                                                 //    decoder
                UINT16    bitsPerSample;         // bits per sample of
                                                 //    the above
    
                // contains rate header format info
                struct type_qpl_variable_rate {
                    UINT32    numOfRates;         // # of rates
                    // high byte = rate, low byte = size of following
                    // packet
                    UINT16    bytesPerPacket[8]; 
                } = variableRate;
    
                UINT32    reserved[5];            // reserved
            } = codec info
        }
    
        <variable rate chunk - 'vrat'> {
            BYTE[4]   id         = {'v', 'r', 'a', 't'}
            UINT32    size       = size of 'vrat' subchunk excluding
                                   id and size
            UINT32    variableRate;
                // if ( == 0 ) packet data is fixed rate 
                // else if ( < 0xFFFF0000 ) variable rate
            UINT32    sizeInPackets;
                // the data chunk size in packets
        }
    
        [<label chunk - 'labl'>]
                // see Optional chunks
    
        [<offsets in increments chunk - 'offs'>]
                // see Optional chunks
    
        <codec packet data chunk - 'data'> {
            BYTE[4] id    = {'d', 'a', 't', 'a'}
            UINT32 size   = size of 'data' subchunk excluding id and
                            size
            BYTE[ ]       = actual packet data (see note 2)
        }
    
        [<configuration chunk - 'cnfg'>] // see Optional chunks
    
        [<text chunk - 'text'>]          // see Optional chunks
    }







Garudadri                  [Page 5]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


    Note 1:  The current format version is (major = 1, minor = 0)
    
    Note 2: 
    If ( variableRate of 'vrat' == 0 OR 'vrat' doesn't exist ) then
        BYTE[bytesPerPacket] = packet1
        BYTE[bytesPerPacket] = packet2
                *
                *
                *
    else if ( variableRate of 'vrat' < 0xFFFF0000 ) then
        packet1 {
            BYTE = rate
            BYTE[ LOBYTE(variableRate.bytesPerPacket[n]) ] where
                n = index to bytesPerPacket
            array that contains the rate in the high byte of
                bytesPerPacket.
        }
        packet2 {
            BYTE  = rate
            BYTE[ LOBYTE(variableRate.bytesPerPacket[n]) ] where
                n = index to bytesPerPacket
            array that contains the rate in the high byte of
                bytesPerPacket.
        }
                *
                *
                *
    
    Note 3:  The fmt chunk MUST appear before the data chunk.
    
    
3.4.  Optional Chunks
    
    Positioning of the optional chunks is as follows:
    
    o    The position of the labl chunk MUST follow the vrat chunk.
    
    o    The offs chunk MAY be positioned anywhere after the lablvrat
    chunk.
    
    o    The cnfg and text chunks MAY appear anywhere.
    
    o    The optional chunks cannot be subchunks of other chunks.
    
    <label chunk - 'labl'> {
        BYTE[4]  id        = {'l', 'a', 'b', 'l'}
        UINT32   size      = size of 'labl' subchunk excluding id and
                             size
        BYTE[48]           = generic storage for applications' use;


Garudadri                  [Page 6]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


    }
    
    <offsets in increments chunk - 'offs'> {
        BYTE[4]   id                     = {'o', 'f', 'f', 's'}
        UINT32    size                   = size of 'offs' subchunk
                                           excluding id and size
        UINT32    stepSize;
            // in 100ms increments, i.e., stepSize of 10 means 1 second
        UINT32    numOfOffsets;          // number of offsets
        UINT32    Offsets[numOfOffsets]; // actual array of offsets 
    }
    Note:  Step size MUST be in increments of 100 ms.
    
    <configuration chunk - 'cnfg'> {
        BYTE[4] id      = {'c', 'n', 'f', 'g'}
        UINT32  size    = size of 'cnfg' subchunk excluding id and
                          size
        UINT16  config  = bitmapped configuration word
    }
    
    <text chunk - 'text'> {
        BYTE[4] id      = {'t', 'e', 'x', 't'}
        UINT32  size    = size of 'text' subchunk excluding id and size
        BYTE[ ]         = Any length of a zero-terminated text string
    }
    
4.  READING A QCP FILE
    
    The following parameters in format chunk (fmt ) MUST be checked to
    successfully read QCP files:
    
    Version numbers MUST match.  Currently, mjv = 1 and mnv = 0 are
    defined.  If the version numbers do not match, the file MUST be
    rejected.
    
    The codec identifier that is found in the Id member of the
    type_qpl_info
    
    struct MUST be one of the following three IDs for playback on the
    QCELP 13K and EVRC vocoders.
    
    QCELP 13K Vocoder ID = {5E7F6D41-B115-11D0-BA91-00805FB4B97E}
    
    QCELP 13K Vocoder ID = {5E7F6D42-B115-11D0-BA91-00805FB4B97E}
    






Garudadri                  [Page 7]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


    EVRC Vocoder ID = {E689D48D-9076-46b5-91EF-736A5100CEB4}
    
    For a codec with one of the above two IDs for the QCELP 13K vocoder,
    the version member (Id) of the type_qpl_info struct MUST be 1.  If
    it is not, the file MUST be rejected.
    
    For a codec with the EVRC Vocoder ID, the version member (Id) of
    type_qpl_info struct MUST be 1.  If it is not, the file MUST be
    rejected.
    
    
5.  WRITING A QCP FILE
    
    The following requirements MUST be met for the successful creation
    of QCP files:
    
    In the fmt chunk, the version MUST be mjv = 1 or mnv = 0.
    
    The codec identifier that is found in the Id member of the
    type_qpl_info struct MUST be one of the following three IDs for
    playback on the QCELP 13K or EVRC vocoders:
    
    QCELP 13K Vocoder ID = {5E7F6D41-B115-11D0-BA91-00805FB4B97E} --
    this is the recommended identifier for the QCELP 13K vocoder
    
    QCELP 13K Vocoder ID = {5E7F6D42-B115-11D0-BA91-00805FB4B97E}
    
    EVRC Vocoder ID = {E689D48D-9076-46b5-91EF-736A5100CEB4}
    
    For a codec with the IDs listed above for the QCELP 13K vocoder, the
    version member (Id) of type_qpl_info struct MUST be either 1.
    
    For a codec with the EVRC Vocoder ID, the version member (Id) of
    type_qpl_info struct MUST be 1.
    
    The header byte MUST be included for each of the packets in the data
    chunk, whether the packets are variable-rate or fixed-rate.
    
    
6.  Registration of Media Type Audio/qcp
    
    Media Type Name:           audio

    Media Subtype Name:        qcp

    Required Parameter:        vocoder=QCELP-13k
                               vocoder=EVRC

    Optional parameters:       none


Garudadri                  [Page 8]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


    The 'vocoder' parameter is required.  It MUST be present and set to
    one of two possible values:  QCELP-13K or EVRC.  Case is not
    significant.
    
    Encoding considerations:
            The storage format specified in this document may be used
    with any transport mechanism.
    
        Security considerations:
            See Section 7 "Security Considerations" of this document.
    
    Public specification:       this document

   Additional information:      no
    
        Magic number: none
        File extensions: qcp, QCP
        Macintosh file type code: none
        Object identifier or OID: none
    
        Intended usage:
            COMMON.  This file format is already in wide use in Internet
    email user agents, multimedia authoring and playing software, and
    CDMA2000 handsets.
    
        Person & email address to contact for further information:
            Harinath Garudadri hgarudad@qualcomm.com
    
        Author/Change controller:
            Harinath Garudadri hgarudad@qualcomm.com to be determined
    
    
7.  Security Considerations
    
        This document specifies a file format only, not a streaming
    protocol payload format nor a transfer method.  As such, it
    introduces no security risks aside from those associated with any
    audio codec or media file format (for example, denial of service by
    transmitting a file larger than the receiver can handle).  Note that
    those security concerns must be understood before using the file
    format specified here.
    
    
8.  Acknowledgements
    






Garudadri                  [Page 9]                  Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


        The authors would like to acknowledge that the qcp fileformat
    was originally developed by others within Qualcomm.  The authors
    would like to thank Chuck Han and Livingstone Song for their
    contributions leading to this specification.
    
    
9.  Normative References
    
        [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate
    Requirement Levels", RFC 2119, Harvard University, March 1997.
    
        [QCELP] TIA/EIA/IS-733.  TR45:  High Rate Speech Service Option
    for Wideband Spread Spectrum Communications Systems.  Available from
    Global Engineering +1 800 854 7179 or +1 303 792 2181.  May also be
    ordered online at http://www.eia.org/eng/.
    
        [EVRC] TIA/EIA/IS-127, "Enhanced Variable Rate Codec, Speech
    Service Option 3 for Wideband Spread Spectrum Digital Systems",
    January 1997.
    
        [PureVoice] McKay, "RTP Payload Format for PureVoice(tm) Audio",
    RFC2658, Qualcomm, August 1999.
    
        [SMV-EVRC] "RTP Payload Format for Enhanced Variable Rate Codecs
    (EVRC) and Selectable Mode Vocoders (SMV)", Li,
    draft-ietf-avt-evrc-smv-03.txt
    
    
10.  Authors Address
    
    Harinath Garudadri
    hgarudad@qualcomm.com
    QUALCOMM Incorporated
    5775 Morehouse Drive
    San Diego, CA  92121
    USA

    Randall Gellens
    randy@qualcomm.com
    QUALCOMM Incorporated
    5775 Morehouse Drive
    San Diego, CA  92121
    USA
    
    






Garudadri                 [Page 10]                 Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


Intellectual Property Statement
    
        The IETF takes no position regarding the validity or scope of
    any intellectual property or other rights that might be claimed to
    pertain to the implementation or use of the technology described in
    this document or the extent to which any license under such rights
    might or might not be available; neither does it represent that it
    has made any effort to identify any such rights.  Information on the
    IETF's procedures with respect to rights in standards-track and
    standards-related documentation can be found in BCP-11.  Copies of
    claims of rights made available for publication and any assurances
    of licenses to be made available, or the result of an attempt made
    to obtain a general license or permission for the use of such
    proprietary rights by implementors or users of this specification
    can be obtained from the IETF Secretariat.
    
        The IETF invites any interested party to bring to its attention
    any copyrights, patents or patent applications, or other proprietary
    rights which may cover technology that may be required to practice
    this standard.  Please address the information to the IETF Executive
    Director.
    
    
Full Copyright Statement
    
        Copyright (C) The Internet Society 2003.  All Rights Reserved.
    
        This document and translations of it may be copied and furnished
    to others, and derivative works that comment on or otherwise explain
    it or assist in its implementation may be prepared, copied,
    published and distributed, in whole or in part, without restriction
    of any kind, provided that the above copyright notice and this
    paragraph are included on all such copies and derivative works.
    However, this document itself may not be modified in any way, such
    as by removing the copyright notice or references to the Internet
    Society or other Internet organizations, except as needed for the
    purpose of developing Internet standards in which case the
    procedures for copyrights defined in the Internet Standards process
    must be followed, or as required to translate it into languages
    other than English.
    
        The limited permissions granted above are perpetual and will not
    be revoked by the Internet Society or its successors or assigns.
    







Garudadri                 [Page 11]                 Expires August 2003

Internet Draft  The Audio/QCP Media Type and File Format  February 2003


        This document and the information contained herein is provided
    on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
    ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
    INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
    INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
    WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
    
    











































Garudadri                 [Page 12]                 Expires August 2003