src/api/: Use intended license header
[libquvi.git] / src / api / media_stream_choose_best.c
blob8a0f7d5da764a5453607660bb311316dc3e91f42
1 /* libquvi
2 * Copyright (C) 2012 Toni Gundogdu <legatvs@gmail.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 * 02110-1301 USA
20 /** @file media_stream_choose_best.c */
22 #include "config.h"
24 #include <glib.h>
26 #include "quvi.h"
27 /* -- */
28 #include "_quvi_s.h"
29 #include "_quvi_media_s.h"
31 /** @brief Selects the @ref m_stream that was determined to be of the "best quality"
32 @note
33 - Only useful when there are >1 media streams available, otherwise the
34 function falls back to the first available @ref m_stream (the
35 default)
36 - The @ref m_script determines the best quality @ref m_stream
37 @sa @ref parse_media
38 @ingroup mediaprop
40 void quvi_media_stream_choose_best(quvi_media_t handle)
42 _quvi_media_stream_t qms;
43 _quvi_media_t qm;
45 qm = (_quvi_media_t) handle;
47 /* If G_DISABLE_CHECKS is defined then the check is not performed. */
48 g_return_if_fail(handle != NULL);
50 quvi_media_stream_reset(qm);
52 while (quvi_media_stream_next(qm) == QUVI_TRUE)
54 qms = (_quvi_media_stream_t) qm->curr.stream->data;
55 g_assert(qms != NULL);
57 if (qms->flags.best == TRUE)
58 break;
62 * If nothing was flagged as such, let it fall through.
63 * Use whatever is the first.
67 /* vim: set ts=2 sw=2 tw=72 expandtab: */