libs/ardour/broadcast_info.cc

   1 /*
   2  * Copyright (C) 2008-2015 Paul Davis <paul@linuxaudiosystems.com>
   3  * Copyright (C) 2009-2010 Carl Hetherington <carl@carlh.net>
   4  * Copyright (C) 2009-2012 David Robillard <d@drobilla.net>
   5  * Copyright (C) 2015-2017 Robin Gareus <robin@gareus.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include "ardour/broadcast_info.h"
  23 #include <iostream>
  24 #include <sstream>
  25 #include <iomanip>
  26 #include <vector>
  27
  28 #include <glibmm.h>
  29
  30 #include "ardour/revision.h"
  31 #include "ardour/session.h"
  32 #include "ardour/session_metadata.h"
  33
  34 using namespace PBD;
  35
  36 namespace ARDOUR
  37 {
  38
  39 static void
  40 snprintf_bounded_null_filled (char* target, size_t target_size, char const * fmt, ...)
  41 {
  42         std::vector<char> buf(target_size+1);
  43         va_list ap;
  44
  45         va_start (ap, fmt);
  46         vsnprintf (&buf[0], target_size+1, fmt, ap);
  47         va_end (ap);
  48
  49         memset (target, 0, target_size);
  50         memcpy (target, &buf[0], target_size);
  51
  52 }
  53
  54 BroadcastInfo::BroadcastInfo ()
  55 {
  56
  57 }
  58
  59 void
  60 BroadcastInfo::set_from_session (Session const & session, int64_t time_ref)
  61 {
  62         set_description (session.name());
  63         set_time_reference (time_ref);
  64         set_origination_time ();
  65         set_originator ();
  66         set_originator_ref_from_session (session);
  67 }
  68
  69 void
  70 BroadcastInfo::set_originator (std::string const & str)
  71 {
  72         _has_info = true;
  73
  74         if (!str.empty()) {
  75                 AudioGrapher::BroadcastInfo::set_originator (str);
  76                 return;
  77         }
  78
  79         snprintf_bounded_null_filled (info->originator, sizeof (info->originator), Glib::get_real_name().c_str());
  80 }
  81
  82 void
  83 BroadcastInfo::set_originator_ref_from_session (Session const & /*session*/)
  84 {
  85         _has_info = true;
  86
  87         /* random code is 9 digits */
  88
  89         int random_code = g_random_int() % 999999999;
  90
  91         /* Serial number is 12 chars */
  92
  93         std::ostringstream serial_number;
  94         serial_number << PROGRAM_NAME << revision;
  95
  96         std::string country = SessionMetadata::Metadata()->country().substr (0, 2).c_str(); // ISO 3166-1 2 digits
  97         if (country.empty ()) {
  98                 /* "ZZ" is reserved and may be user-assigned.
  99                  * EBU Tech 3279 chapter 4.2.4 recommends "ZZ" for unregistered organizations
 100                  */
 101                 country = "ZZ";
 102         }
 103
 104         /* https://tech.ebu.ch/docs/tech/tech3279.pdf */
 105         std::string organization = SessionMetadata::Metadata()->organization().substr (0, 3).c_str(); // EBU assigned Organisation code
 106         if (organization.empty ()) {
 107                 organization = "---";
 108         }
 109
 110         // TODO sanitize to allowed char set: tech3279.pdf chapter 1.6
 111         // allowed: A-Z 0-9 <space> .,-()/=
 112         // possible, but not recommended: !"%&*;<>
 113
 114         /* https://tech.ebu.ch/docs/r/r099.pdf
 115          * CC Country code: (2 characters) based on the ISO 3166-1 standard
 116          * OOO Organisation code: (3 characters) based on the EBU facility codes, Tech 3279
 117          * NNNNNNNNNNNN Serial number: (12 characters extracted from the recorder model and serial number) This should identify the machine’s type and serial number.
 118          * HHMMSS OriginationTime (6 characters,) from the <OriginationTime> field of the BWF.
 119          * RRRRRRRRR Random Number (9 characters 0-9) Generated locally by the recorder using some reasonably random algorithm.
 120          */
 121         snprintf_bounded_null_filled (info->originator_reference, sizeof (info->originator_reference), "%2s%3s%12s%02d%02d%02d%09d",
 122                         country.c_str (), organization.c_str(),
 123                         serial_number.str().substr (0, 12).c_str(),
 124                         _time.tm_hour,
 125                         _time.tm_min,
 126                         _time.tm_sec,
 127                         random_code);
 128
 129 }
 130
 131 } // namespace ARDOUR
 132