src/audio_parser.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program 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
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 /** \file
  21  *
  22  * Parser functions for audio related objects.
  23  */
  24
  25 #ifndef AUDIO_PARSER_H
  26 #define AUDIO_PARSER_H
  27
  28 #include <glib.h>
  29
  30 #include <stdbool.h>
  31
  32 struct audio_format;
  33
  34 /**
  35  * Parses a string in the form "SAMPLE_RATE:BITS:CHANNELS" into an
  36  * #audio_format.
  37  *
  38  * @param dest the destination #audio_format struct
  39  * @param src the input string
  40  * @param mask if true, then "*" is allowed for any number of items
  41  * @param error_r location to store the error occuring, or NULL to
  42  * ignore errors
  43  * @return true on success
  44  */
  45 bool
  46 audio_format_parse(struct audio_format *dest, const char *src,
  47                    bool mask, GError **error_r);
  48
  49 #endif