Blame doc/liboggz/html/oggz__comments_8h_source.html

Packit a38265
Packit a38265
<html xmlns="http://www.w3.org/1999/xhtml">
Packit a38265
<head>
Packit a38265
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Packit a38265
<title>liboggz: oggz_comments.h Source File</title>
Packit a38265
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Packit a38265
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
Packit a38265
</head>
Packit a38265
<body>
Packit a38265
Packit a38265
Packit a38265
  
Packit a38265
    
    Packit a38265
          
  • Main Page
  • Packit a38265
          
  • Modules
  • Packit a38265
          
  • Data Structures
  • Packit a38265
          
  • Files
  • Packit a38265
        
    Packit a38265
      
    Packit a38265
      
    Packit a38265
        
      Packit a38265
            
    • File List
    • Packit a38265
            
    • Globals
    • Packit a38265
          
      Packit a38265
        
      Packit a38265

      oggz_comments.h

      Go to the documentation of this file.
      00001 /*
      Packit a38265
      00002    Copyright (C) 2003 Commonwealth Scientific and Industrial Research
      Packit a38265
      00003    Organisation (CSIRO) Australia
      Packit a38265
      00004 
      Packit a38265
      00005    Redistribution and use in source and binary forms, with or without
      Packit a38265
      00006    modification, are permitted provided that the following conditions
      Packit a38265
      00007    are met:
      Packit a38265
      00008 
      Packit a38265
      00009    - Redistributions of source code must retain the above copyright
      Packit a38265
      00010    notice, this list of conditions and the following disclaimer.
      Packit a38265
      00011 
      Packit a38265
      00012    - Redistributions in binary form must reproduce the above copyright
      Packit a38265
      00013    notice, this list of conditions and the following disclaimer in the
      Packit a38265
      00014    documentation and/or other materials provided with the distribution.
      Packit a38265
      00015 
      Packit a38265
      00016    - Neither the name of CSIRO Australia nor the names of its
      Packit a38265
      00017    contributors may be used to endorse or promote products derived from
      Packit a38265
      00018    this software without specific prior written permission.
      Packit a38265
      00019 
      Packit a38265
      00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
      Packit a38265
      00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
      Packit a38265
      00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
      Packit a38265
      00023    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
      Packit a38265
      00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
      Packit a38265
      00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
      Packit a38265
      00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
      Packit a38265
      00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
      Packit a38265
      00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
      Packit a38265
      00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
      Packit a38265
      00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
      Packit a38265
      00031 */
      Packit a38265
      00032 
      Packit a38265
      00033 #ifndef __OGGZ_COMMENT_H__
      Packit a38265
      00034 #define __OGGZ_COMMENT_H__
      Packit a38265
      00035 
      Packit a38265
      00086 #include <oggz/oggz.h>
      Packit a38265
      00087 
      Packit a38265
      00091 typedef struct {
      Packit a38265
      00093   char * name;
      Packit a38265
      00094 
      Packit a38265
      00096   char * value;
      Packit a38265
      00097 } OggzComment;
      Packit a38265
      00098 
      Packit a38265
      00099 #ifdef __cplusplus
      Packit a38265
      00100 extern "C" {
      Packit a38265
      00101 #endif
      Packit a38265
      00102 
      Packit a38265
      00112 const char *
      Packit a38265
      00113 oggz_comment_get_vendor (OGGZ * oggz, long serialno);
      Packit a38265
      00114 
      Packit a38265
      00128 int
      Packit a38265
      00129 oggz_comment_set_vendor (OGGZ * oggz, long serialno,
      Packit a38265
      00130                          const char * vendor_string);
      Packit a38265
      00131 
      Packit a38265
      00140 const OggzComment *
      Packit a38265
      00141 oggz_comment_first (OGGZ * oggz, long serialno);
      Packit a38265
      00142 
      Packit a38265
      00153 const OggzComment *
      Packit a38265
      00154 oggz_comment_next (OGGZ * oggz, long serialno, const OggzComment * comment);
      Packit a38265
      00155 
      Packit a38265
      00167 const OggzComment *
      Packit a38265
      00168 oggz_comment_first_byname (OGGZ * oggz, long serialno, char * name);
      Packit a38265
      00169 
      Packit a38265
      00182 const OggzComment *
      Packit a38265
      00183 oggz_comment_next_byname (OGGZ * oggz, long serialno,
      Packit a38265
      00184                           const OggzComment * comment);
      Packit a38265
      00185 
      Packit a38265
      00196 int
      Packit a38265
      00197 oggz_comment_add (OGGZ * oggz, long serialno, OggzComment * comment);
      Packit a38265
      00198 
      Packit a38265
      00210 int
      Packit a38265
      00211 oggz_comment_add_byname (OGGZ * oggz, long serialno,
      Packit a38265
      00212                          const char * name, const char * value);
      Packit a38265
      00213 
      Packit a38265
      00226 int
      Packit a38265
      00227 oggz_comment_remove (OGGZ * oggz, long serialno, OggzComment * comment);
      Packit a38265
      00228 
      Packit a38265
      00240 int
      Packit a38265
      00241 oggz_comment_remove_byname (OGGZ * oggz, long serialno, char * name);
      Packit a38265
      00242 
      Packit a38265
      00265 ogg_packet *
      Packit a38265
      00266 oggz_comments_generate(OGGZ * oggz, long serialno,
      Packit a38265
      00267                        int FLAC_final_metadata_block);
      Packit a38265
      00268   
      Packit a38265
      00269 /*
      Packit a38265
      00270  * Copy comments between two streams.
      Packit a38265
      00271  * \param src A OGGZ* handle
      Packit a38265
      00272  * \param src_serialno Identify a logical bitstream within \a src
      Packit a38265
      00273  * \param dest A OGGZ* handle (created with OGGZ_WRITE)
      Packit a38265
      00274  * \param dest_serialno Identify a logical bitstream within \a dest
      Packit a38265
      00275  * \retval OGGZ_ERR_BAD \a oggz is not a valid OGGZ* handle
      Packit a38265
      00276  * \retval OGGZ_ERR_INVALID Operation not suitable for \a dest
      Packit a38265
      00277  */
      Packit a38265
      00278 int
      Packit a38265
      00279 oggz_comments_copy (OGGZ * src, long src_serialno,
      Packit a38265
      00280                     OGGZ * dest, long dest_serialno);
      Packit a38265
      00281 
      Packit a38265
      00287 void oggz_packet_destroy (ogg_packet *packet);
      Packit a38265
      00288 
      Packit a38265
      00289 #ifdef __cplusplus
      Packit a38265
      00290 }
      Packit a38265
      00291 #endif
      Packit a38265
      00292 
      Packit a38265
      00293 #endif /* __OGGZ_COMMENTS_H__ */
      Packit a38265
      Packit a38265

      <address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by 
      Packit a38265
      Packit a38265
      doxygen 1.6.3 </small></address>
      Packit a38265
      </body>
      Packit a38265
      </html>