oggz_comments.h

Go to the documentation of this file.

/*
   Copyright (C) 2003 Commonwealth Scientific and Industrial Research
   Organisation (CSIRO) Australia

   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:

   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

   - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

   - Neither the name of CSIRO Australia nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef __OGGZ_COMMENT_H__
#define __OGGZ_COMMENT_H__

#include <oggz/oggz.h>

typedef struct {
  char * name;

  char * value;
} OggzComment;

#ifdef __cplusplus
extern "C" {
#endif

const char *
oggz_comment_get_vendor (OGGZ * oggz, long serialno);

int
oggz_comment_set_vendor (OGGZ * oggz, long serialno,
                         const char * vendor_string);

const OggzComment *
oggz_comment_first (OGGZ * oggz, long serialno);

const OggzComment *
oggz_comment_next (OGGZ * oggz, long serialno, const OggzComment * comment);

const OggzComment *
oggz_comment_first_byname (OGGZ * oggz, long serialno, char * name);

const OggzComment *
oggz_comment_next_byname (OGGZ * oggz, long serialno,
                          const OggzComment * comment);

int
oggz_comment_add (OGGZ * oggz, long serialno, OggzComment * comment);

int
oggz_comment_add_byname (OGGZ * oggz, long serialno,
                         const char * name, const char * value);

int
oggz_comment_remove (OGGZ * oggz, long serialno, OggzComment * comment);

int
oggz_comment_remove_byname (OGGZ * oggz, long serialno, char * name);

ogg_packet *
oggz_comments_generate(OGGZ * oggz, long serialno,
                       int FLAC_final_metadata_block);
  
/*
 * Copy comments between two streams.
 * \param src A OGGZ* handle
 * \param src_serialno Identify a logical bitstream within \a src
 * \param dest A OGGZ* handle (created with OGGZ_WRITE)
 * \param dest_serialno Identify a logical bitstream within \a dest
 * \retval OGGZ_ERR_BAD \a oggz is not a valid OGGZ* handle
 * \retval OGGZ_ERR_INVALID Operation not suitable for \a dest
 */
int
oggz_comments_copy (OGGZ * src, long src_serialno,
                    OGGZ * dest, long dest_serialno);

void oggz_packet_destroy (ogg_packet *packet);

#ifdef __cplusplus
}
#endif

#endif /* __OGGZ_COMMENTS_H__ */